Struct EvaluatedAnnotation

#[non_exhaustive]
pub struct EvaluatedAnnotation {
    pub type: EvaluatedAnnotationType,
    pub predictions: Vec<Value>,
    pub ground_truths: Vec<Value>,
    pub data_item_payload: Option<Value>,
    pub evaluated_data_item_view_id: String,
    pub explanations: Vec<EvaluatedAnnotationExplanation>,
    pub error_analysis_annotations: Vec<ErrorAnalysisAnnotation>,
    /* private fields */
}

True positive, false positive, or false negative.

EvaluatedAnnotation is only available under ModelEvaluationSlice with slice of annotationSpec dimension.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

type: EvaluatedAnnotationType

Output only. Type of the EvaluatedAnnotation.

predictions: Vec<Value>

Output only. The model predicted annotations.

For true positive, there is one and only one prediction, which matches the only one ground truth annotation in ground_truths.

For false positive, there is one and only one prediction, which doesn’t match any ground truth annotation of the corresponding data_item_view_id.

For false negative, there are zero or more predictions which are similar to the only ground truth annotation in ground_truths but not enough for a match.

The schema of the prediction is stored in ModelEvaluation.annotation_schema_uri

ground_truths: Vec<Value>

Output only. The ground truth Annotations, i.e. the Annotations that exist in the test data the Model is evaluated on.

For true positive, there is one and only one ground truth annotation, which matches the only prediction in predictions.

For false positive, there are zero or more ground truth annotations that are similar to the only prediction in predictions, but not enough for a match.

For false negative, there is one and only one ground truth annotation, which doesn’t match any predictions created by the model.

The schema of the ground truth is stored in ModelEvaluation.annotation_schema_uri

data_item_payload: Option<Value>

Output only. The data item payload that the Model predicted this EvaluatedAnnotation on.

evaluated_data_item_view_id: String

Output only. ID of the EvaluatedDataItemView under the same ancestor ModelEvaluation. The EvaluatedDataItemView consists of all ground truths and predictions on data_item_payload.

explanations: Vec<EvaluatedAnnotationExplanation>

Explanations of predictions. Each element of the explanations indicates the explanation for one explanation Method.

The attributions list in the EvaluatedAnnotationExplanation.explanation object corresponds to the predictions list. For example, the second element in the attributions list explains the second element in the predictions list.

error_analysis_annotations: Vec<ErrorAnalysisAnnotation>

Annotations of model error analysis results.

Implementations

impl EvaluatedAnnotation

pub fn new() -> Self

pub fn set_type<T: Into<EvaluatedAnnotationType>>(self, v: T) -> Self

Sets the value of r#type.

pub fn set_predictions<T, V>(self, v: T) -> Self

where T: IntoIterator<Item = V>, V: Into<Value>,

Sets the value of predictions.

pub fn set_ground_truths<T, V>(self, v: T) -> Self

where T: IntoIterator<Item = V>, V: Into<Value>,

Sets the value of ground_truths.

pub fn set_data_item_payload<T: Into<Option<Value>>>(self, v: T) -> Self

Sets the value of data_item_payload.

pub fn set_evaluated_data_item_view_id<T: Into<String>>(self, v: T) -> Self

Sets the value of evaluated_data_item_view_id.

pub fn set_explanations<T, V>(self, v: T) -> Self

where T: IntoIterator<Item = V>, V: Into<EvaluatedAnnotationExplanation>,

Sets the value of explanations.

pub fn set_error_analysis_annotations<T, V>(self, v: T) -> Self

where T: IntoIterator<Item = V>, V: Into<ErrorAnalysisAnnotation>,

Sets the value of error_analysis_annotations.

Trait Implementations

impl Clone for EvaluatedAnnotation

fn clone(&self) -> EvaluatedAnnotation

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for EvaluatedAnnotation

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for EvaluatedAnnotation

fn default() -> EvaluatedAnnotation

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for EvaluatedAnnotation

where EvaluatedAnnotation: Default,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Message for EvaluatedAnnotation

fn typename() -> &'static str

The typename of this message.

impl PartialEq for EvaluatedAnnotation

fn eq(&self, other: &EvaluatedAnnotation) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for EvaluatedAnnotation

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for EvaluatedAnnotation