Cloud AI Platform v1 API - Class EvaluatedAnnotation (2.13.0) 

public sealed class EvaluatedAnnotation : IMessage<EvaluatedAnnotation>, IEquatable<EvaluatedAnnotation>, IDeepCloneable<EvaluatedAnnotation>, IBufferMessage, IMessage

Reference documentation and code samples for the Cloud AI Platform v1 API class EvaluatedAnnotation.

True positive, false positive, or false negative.

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

Inheritance

object > EvaluatedAnnotation

Namespace

GoogleCloudGoogle.Cloud.AIPlatformV1

Assembly

Google.Cloud.AIPlatform.V1.dll

Constructors

EvaluatedAnnotation()

public EvaluatedAnnotation()

EvaluatedAnnotation(EvaluatedAnnotation)

public EvaluatedAnnotation(EvaluatedAnnotation other)
Parameter
NameDescription
otherEvaluatedAnnotation

Properties

DataItemPayload

public Value DataItemPayload { get; set; }

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

Property Value
TypeDescription
Value

ErrorAnalysisAnnotations

public RepeatedField<ErrorAnalysisAnnotation> ErrorAnalysisAnnotations { get; }

Annotations of model error analysis results.

Property Value
TypeDescription
RepeatedFieldErrorAnalysisAnnotation

EvaluatedDataItemViewId

public string EvaluatedDataItemViewId { get; set; }

Output only. ID of the EvaluatedDataItemView under the same ancestor ModelEvaluation. The EvaluatedDataItemView consists of all ground truths and predictions on [data_item_payload][google.cloud.aiplatform.v1.EvaluatedAnnotation.data_item_payload].

Can be passed in [GetEvaluatedDataItemView's][ModelService.GetEvaluatedDataItemView][] [id][GetEvaluatedDataItemViewRequest.id].

Property Value
TypeDescription
string

Explanations

public RepeatedField<EvaluatedAnnotationExplanation> Explanations { get; }

Explanations of [predictions][google.cloud.aiplatform.v1.EvaluatedAnnotation.predictions]. Each element of the explanations indicates the explanation for one explanation Method.

The attributions list in the [EvaluatedAnnotationExplanation.explanation][google.cloud.aiplatform.v1.EvaluatedAnnotationExplanation.explanation] object corresponds to the [predictions][google.cloud.aiplatform.v1.EvaluatedAnnotation.predictions] list. For example, the second element in the attributions list explains the second element in the predictions list.

Property Value
TypeDescription
RepeatedFieldEvaluatedAnnotationExplanation

GroundTruths

public RepeatedField<Value> GroundTruths { get; }

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][google.cloud.aiplatform.v1.EvaluatedAnnotation.predictions].

For false positive, there are zero or more ground truth annotations that are similar to the only prediction in [predictions][google.cloud.aiplatform.v1.EvaluatedAnnotation.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][google.cloud.aiplatform.v1.ModelEvaluation.annotation_schema_uri]

Property Value
TypeDescription
RepeatedFieldValue

Predictions

public RepeatedField<Value> Predictions { get; }

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][google.cloud.aiplatform.v1.EvaluatedAnnotation.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][EvaluatedAnnotation.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][google.cloud.aiplatform.v1.EvaluatedAnnotation.ground_truths] but not enough for a match.

The schema of the prediction is stored in [ModelEvaluation.annotation_schema_uri][google.cloud.aiplatform.v1.ModelEvaluation.annotation_schema_uri]

Property Value
TypeDescription
RepeatedFieldValue

Type

public EvaluatedAnnotation.Types.EvaluatedAnnotationType Type { get; set; }

Output only. Type of the EvaluatedAnnotation.

Property Value
TypeDescription
EvaluatedAnnotationTypesEvaluatedAnnotationType