- 1.35.0 (latest)
- 1.34.0
- 1.33.0
- 1.32.1
- 1.31.0
- 1.30.0
- 1.26.0
- 1.23.0
- 1.22.0
- 1.21.0
- 1.20.0
- 1.19.0
- 1.18.0
- 1.17.0
- 1.16.0
- 1.15.0
- 1.14.0
- 1.13.1
- 1.12.0
- 1.11.0
- 1.10.0
- 1.9.0
- 1.8.0
- 1.7.0
- 1.6.0
- 1.5.0
- 1.4.0
- 1.3.0
- 1.2.0
- 1.1.0
- 1.0.0
- 0.39.0
- 0.38.0
- 0.37.1
- 0.32.0
- 0.31.0
- 0.30.0
- 0.29.0
- 0.28.0
- 0.27.0
- 0.26.2
- 0.25.0
- 0.24.0
- 0.23.0
- 0.22.0
- 0.21.0
- 0.20.0
- 0.19.0
- 0.18.0
- 0.17.0
- 0.16.0
- 0.15.0
- 0.13.0
- 0.12.0
- 0.11.1
- 0.10.0
Reference documentation and code samples for the Google Cloud Ai Platform V1 Client class ModelEvaluation.
A collection of metrics calculated by comparing Model's predictions on all of the test data against annotations from the test data.
Generated from protobuf message google.cloud.aiplatform.v1.ModelEvaluation
Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ name
string
Output only. The resource name of the ModelEvaluation.
↳ display_name
string
The display name of the ModelEvaluation.
↳ metrics_schema_uri
string
Points to a YAML file stored on Google Cloud Storage describing the metrics of this ModelEvaluation. The schema is defined as an OpenAPI 3.0.2 Schema Object .
↳ metrics
Google\Protobuf\Value
Evaluation metrics of the Model. The schema of the metrics is stored in metrics_schema_uri
↳ create_time
Google\Protobuf\Timestamp
Output only. Timestamp when this ModelEvaluation was created.
↳ slice_dimensions
array
All possible dimensions
of ModelEvaluationSlices. The dimensions can be used as the filter of the ModelService.ListModelEvaluationSlices
request, in the form of slice.dimension = <dimension>
.
↳ data_item_schema_uri
string
Points to a YAML file stored on Google Cloud Storage describing EvaluatedDataItemView.data_item_payload and 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.
↳ annotation_schema_uri
string
Points to a YAML file stored on Google Cloud Storage describing EvaluatedDataItemView.predictions , EvaluatedDataItemView.ground_truths , EvaluatedAnnotation.predictions , and 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.
↳ model_explanation
Google\Cloud\AIPlatform\V1\ModelExplanation
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.
↳ explanation_specs
array< Google\Cloud\AIPlatform\V1\ModelEvaluation\ModelEvaluationExplanationSpec
>
Describes the values of ExplanationSpec that are used for explaining the predicted values on the evaluated data.
↳ metadata
Google\Protobuf\Value
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".
getName
Output only. The resource name of the ModelEvaluation.
Generated from protobuf field string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
string
setName
Output only. The resource name of the ModelEvaluation.
Generated from protobuf field string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
var
string
$this
getDisplayName
The display name of the ModelEvaluation.
Generated from protobuf field string display_name = 10;
string
setDisplayName
The display name of the ModelEvaluation.
Generated from protobuf field string display_name = 10;
var
string
$this
getMetricsSchemaUri
Points to a YAML file stored on Google Cloud Storage describing the metrics of this ModelEvaluation. The schema is defined as an OpenAPI 3.0.2 Schema Object .
Generated from protobuf field string metrics_schema_uri = 2;
string
setMetricsSchemaUri
Points to a YAML file stored on Google Cloud Storage describing the metrics of this ModelEvaluation. The schema is defined as an OpenAPI 3.0.2 Schema Object .
Generated from protobuf field string metrics_schema_uri = 2;
var
string
$this
getMetrics
Evaluation metrics of the Model. The schema of the metrics is stored in metrics_schema_uri
Generated from protobuf field .google.protobuf.Value metrics = 3;
Google\Protobuf\Value|null
hasMetrics
clearMetrics
setMetrics
Evaluation metrics of the Model. The schema of the metrics is stored in metrics_schema_uri
Generated from protobuf field .google.protobuf.Value metrics = 3;
var
Google\Protobuf\Value
$this
getCreateTime
Output only. Timestamp when this ModelEvaluation was created.
Generated from protobuf field .google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
Google\Protobuf\Timestamp|null
hasCreateTime
clearCreateTime
setCreateTime
Output only. Timestamp when this ModelEvaluation was created.
Generated from protobuf field .google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
var
Google\Protobuf\Timestamp
$this
getSliceDimensions
All possible dimensions
of
ModelEvaluationSlices. The dimensions can be used as the filter of the ModelService.ListModelEvaluationSlices
request, in the form of slice.dimension = <dimension>
.
Generated from protobuf field repeated string slice_dimensions = 5;
Google\Protobuf\Internal\RepeatedField
setSliceDimensions
All possible dimensions
of
ModelEvaluationSlices. The dimensions can be used as the filter of the ModelService.ListModelEvaluationSlices
request, in the form of slice.dimension = <dimension>
.
Generated from protobuf field repeated string slice_dimensions = 5;
var
string[]
$this
getDataItemSchemaUri
Points to a YAML file stored on Google Cloud Storage describing EvaluatedDataItemView.data_item_payload and 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.
Generated from protobuf field string data_item_schema_uri = 6;
string
setDataItemSchemaUri
Points to a YAML file stored on Google Cloud Storage describing EvaluatedDataItemView.data_item_payload and 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.
Generated from protobuf field string data_item_schema_uri = 6;
var
string
$this
getAnnotationSchemaUri
Points to a YAML file stored on Google Cloud Storage describing EvaluatedDataItemView.predictions , EvaluatedDataItemView.ground_truths , EvaluatedAnnotation.predictions , and 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.
Generated from protobuf field string annotation_schema_uri = 7;
string
setAnnotationSchemaUri
Points to a YAML file stored on Google Cloud Storage describing EvaluatedDataItemView.predictions , EvaluatedDataItemView.ground_truths , EvaluatedAnnotation.predictions , and 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.
Generated from protobuf field string annotation_schema_uri = 7;
var
string
$this
getModelExplanation
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.
Generated from protobuf field .google.cloud.aiplatform.v1.ModelExplanation model_explanation = 8;
hasModelExplanation
clearModelExplanation
setModelExplanation
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.
Generated from protobuf field .google.cloud.aiplatform.v1.ModelExplanation model_explanation = 8;
$this
getExplanationSpecs
Describes the values of ExplanationSpec that are used for explaining the predicted values on the evaluated data.
Generated from protobuf field repeated .google.cloud.aiplatform.v1.ModelEvaluation.ModelEvaluationExplanationSpec explanation_specs = 9;
Google\Protobuf\Internal\RepeatedField
setExplanationSpecs
Describes the values of ExplanationSpec that are used for explaining the predicted values on the evaluated data.
Generated from protobuf field repeated .google.cloud.aiplatform.v1.ModelEvaluation.ModelEvaluationExplanationSpec explanation_specs = 9;
$this
getMetadata
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".
Generated from protobuf field .google.protobuf.Value metadata = 11;
Google\Protobuf\Value|null
hasMetadata
clearMetadata
setMetadata
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".
Generated from protobuf field .google.protobuf.Value metadata = 11;
var
Google\Protobuf\Value
$this
