Google Cloud Ai Platform V1 Client - Class ModelEvaluationSlice (1.0.0)

Reference documentation and code samples for the Google Cloud Ai Platform V1 Client class ModelEvaluationSlice.

A collection of metrics calculated by comparing Model's predictions on a slice of the test data against ground truth annotations.

Generated from protobuf message google.cloud.aiplatform.v1.ModelEvaluationSlice

Namespace

Google \ Cloud \ AIPlatform \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ name string

Output only. The resource name of the ModelEvaluationSlice.

↳ slice Google\Cloud\AIPlatform\V1\ModelEvaluationSlice\Slice

Output only. The slice of the test data that is used to evaluate the Model.

↳ metrics_schema_uri string

Output only. Points to a YAML file stored on Google Cloud Storage describing the metrics of this ModelEvaluationSlice. The schema is defined as an OpenAPI 3.0.2 Schema Object.

↳ metrics Google\Protobuf\Value

Output only. Sliced 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 ModelEvaluationSlice was created.

↳ model_explanation Google\Cloud\AIPlatform\V1\ModelExplanation

Output only. 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 tabular Models.

getName

Output only. The resource name of the ModelEvaluationSlice.

Returns
Type Description
string

setName

Output only. The resource name of the ModelEvaluationSlice.

Parameter
Name Description
var string
Returns
Type Description
$this

getSlice

Output only. The slice of the test data that is used to evaluate the Model.

Returns
Type Description
Google\Cloud\AIPlatform\V1\ModelEvaluationSlice\Slice|null

hasSlice

clearSlice

setSlice

Output only. The slice of the test data that is used to evaluate the Model.

Parameter
Name Description
var Google\Cloud\AIPlatform\V1\ModelEvaluationSlice\Slice
Returns
Type Description
$this

getMetricsSchemaUri

Output only. Points to a YAML file stored on Google Cloud Storage describing the metrics of this ModelEvaluationSlice. The schema is defined as an OpenAPI 3.0.2 Schema Object.

Returns
Type Description
string

setMetricsSchemaUri

Output only. Points to a YAML file stored on Google Cloud Storage describing the metrics of this ModelEvaluationSlice. The schema is defined as an OpenAPI 3.0.2 Schema Object.

Parameter
Name Description
var string
Returns
Type Description
$this

getMetrics

Output only. Sliced evaluation metrics of the Model. The schema of the metrics is stored in metrics_schema_uri

Returns
Type Description
Google\Protobuf\Value|null

hasMetrics

clearMetrics

setMetrics

Output only. Sliced evaluation metrics of the Model. The schema of the metrics is stored in metrics_schema_uri

Parameter
Name Description
var Google\Protobuf\Value
Returns
Type Description
$this

getCreateTime

Output only. Timestamp when this ModelEvaluationSlice was created.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasCreateTime

clearCreateTime

setCreateTime

Output only. Timestamp when this ModelEvaluationSlice was created.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getModelExplanation

Output only. 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 tabular Models.

Returns
Type Description
Google\Cloud\AIPlatform\V1\ModelExplanation|null

hasModelExplanation

clearModelExplanation

setModelExplanation

Output only. 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 tabular Models.

Parameter
Name Description
var Google\Cloud\AIPlatform\V1\ModelExplanation
Returns
Type Description
$this