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.
| Parameters | |
|---|---|
| Name | Description |
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 |
↳ 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];
| Returns | |
|---|---|
| Type | Description |
string | |
setName
Output only. The resource name of the ModelEvaluation.
Generated from protobuf field string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getDisplayName
The display name of the ModelEvaluation.
Generated from protobuf field string display_name = 10;
| Returns | |
|---|---|
| Type | Description |
string | |
setDisplayName
The display name of the ModelEvaluation.
Generated from protobuf field string display_name = 10;
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$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;
| Returns | |
|---|---|
| Type | Description |
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;
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$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;
| Returns | |
|---|---|
| Type | Description |
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;
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Value
|
| Returns | |
|---|---|
| Type | Description |
$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];
| Returns | |
|---|---|
| Type | Description |
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];
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$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;
| Returns | |
|---|---|
| Type | Description |
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;
| Parameter | |
|---|---|
| Name | Description |
var |
string[]
|
| Returns | |
|---|---|
| Type | Description |
$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;
| Returns | |
|---|---|
| Type | Description |
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;
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$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;
| Returns | |
|---|---|
| Type | Description |
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;
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$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;
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\AIPlatform\V1\ModelExplanation|null | |
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;
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\AIPlatform\V1\ModelExplanation
|
| Returns | |
|---|---|
| Type | Description |
$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;
| Returns | |
|---|---|
| Type | Description |
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;
| Parameter | |
|---|---|
| Name | Description |
var |
array<Google\Cloud\AIPlatform\V1\ModelEvaluation\ModelEvaluationExplanationSpec>
|
| Returns | |
|---|---|
| Type | Description |
$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;
| Returns | |
|---|---|
| Type | Description |
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;
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Value
|
| Returns | |
|---|---|
| Type | Description |
$this | |