Cloud AI Platform v1 API - Class ModelEvaluation (2.13.0)

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

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

A collection of metrics calculated by comparing Model's predictions on all of the test data against annotations from the test data.

Inheritance

object > ModelEvaluation

Implements

IMessage ModelEvaluation, IEquatable ModelEvaluation, IDeepCloneable ModelEvaluation, IBufferMessage, IMessage

Inherited Members

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google CloudGoogle.Cloud.AIPlatformV1

Assembly

Google.Cloud.AIPlatform.V1.dll

Constructors

ModelEvaluation()

public ModelEvaluation()

ModelEvaluation(ModelEvaluation)

public ModelEvaluation(ModelEvaluation other)

Parameter
Name	Description
`other`	`ModelEvaluation`

Properties

AnnotationSchemaUri

public string AnnotationSchemaUri { get; set; }

Points to a YAML file stored on Google Cloud Storage describing [EvaluatedDataItemView.predictions][], [EvaluatedDataItemView.ground_truths][], [EvaluatedAnnotation.predictions][google.cloud.aiplatform.v1.EvaluatedAnnotation.predictions], and [EvaluatedAnnotation.ground_truths][google.cloud.aiplatform.v1.EvaluatedAnnotation.ground_truths]. The schema is defined as an OpenAPI 3.0.2 Schema Object.

This field is not populated if there are neither EvaluatedDataItemViews nor EvaluatedAnnotations under this ModelEvaluation.

Property Value
Type	Description
`string`

CreateTime

public Timestamp CreateTime { get; set; }

Output only. Timestamp when this ModelEvaluation was created.

Property Value
Type	Description
`Timestamp`

DataItemSchemaUri

public string DataItemSchemaUri { get; set; }

Points to a YAML file stored on Google Cloud Storage describing [EvaluatedDataItemView.data_item_payload][] and [EvaluatedAnnotation.data_item_payload][google.cloud.aiplatform.v1.EvaluatedAnnotation.data_item_payload]. The schema is defined as an OpenAPI 3.0.2 Schema Object.

This field is not populated if there are neither EvaluatedDataItemViews nor EvaluatedAnnotations under this ModelEvaluation.

Property Value
Type	Description
`string`

DisplayName

public string DisplayName { get; set; }

The display name of the ModelEvaluation.

Property Value
Type	Description
`string`

ExplanationSpecs

public RepeatedField<ModelEvaluation.Types.ModelEvaluationExplanationSpec> ExplanationSpecs { get; }

Describes the values of [ExplanationSpec][google.cloud.aiplatform.v1.ExplanationSpec] that are used for explaining the predicted values on the evaluated data.

Property Value
Type	Description
`RepeatedFieldModelEvaluationTypesModelEvaluationExplanationSpec`

Metadata

public Value Metadata { get; set; }

The metadata of the ModelEvaluation. For the ModelEvaluation uploaded from Managed Pipeline, metadata contains a structured value with keys of "pipeline_job_id", "evaluation_dataset_type", "evaluation_dataset_path".

Property Value
Type	Description
`Value`

Metrics

public Value Metrics { get; set; }

Evaluation metrics of the Model. The schema of the metrics is stored in [metrics_schema_uri][google.cloud.aiplatform.v1.ModelEvaluation.metrics_schema_uri]

Property Value
Type	Description
`Value`

MetricsSchemaUri

public string MetricsSchemaUri { get; set; }

Points to a YAML file stored on Google Cloud Storage describing the [metrics][google.cloud.aiplatform.v1.ModelEvaluation.metrics] of this ModelEvaluation. The schema is defined as an OpenAPI 3.0.2 Schema Object.

Property Value
Type	Description
`string`

ModelEvaluationName

public ModelEvaluationName ModelEvaluationName { get; set; }

ModelEvaluationName-typed view over the Name resource name property.

Property Value
Type	Description
`ModelEvaluationName`

ModelExplanation

public ModelExplanation ModelExplanation { get; set; }

Aggregated explanation metrics for the Model's prediction output over the data this ModelEvaluation uses. This field is populated only if the Model is evaluated with explanations, and only for AutoML tabular Models.

Property Value
Type	Description
`ModelExplanation`

Name

public string Name { get; set; }

Output only. The resource name of the ModelEvaluation.

Property Value
Type	Description
`string`

SliceDimensions

public RepeatedField<string> SliceDimensions { get; }

All possible [dimensions][ModelEvaluationSlice.slice.dimension] of ModelEvaluationSlices. The dimensions can be used as the filter of the [ModelService.ListModelEvaluationSlices][google.cloud.aiplatform.v1.ModelService.ListModelEvaluationSlices] request, in the form of slice.dimension = <dimension>.

Property Value
Type	Description
`RepeatedFieldstring`