Class ModelEvaluation (1.74.0)

ModelEvaluation(
    evaluation_name: str,
    model_id: typing.Optional[str] = None,
    project: typing.Optional[str] = None,
    location: typing.Optional[str] = None,
    credentials: typing.Optional[google.auth.credentials.Credentials] = None,
)

Retrieves the ModelEvaluation resource and instantiates its representation.

Parameters
Name	Description
`evaluation_name`	`str` Required. A fully-qualified model evaluation resource name or evaluation ID. Example: "projects/123/locations/us-central1/models/456/evaluations/789" or "789". If passing only the evaluation ID, model_id must be provided.
`model_id`	`str` Optional. The ID of the model to retrieve this evaluation from. If passing only the evaluation ID as evaluation_name, model_id must be provided.
`project`	`str` Optional project to retrieve model evaluation from. If not set, project set in aiplatform.init will be used.
`location`	`str` Optional location to retrieve model evaluation from. If not set, location set in aiplatform.init will be used.

Properties

create_time

Time this resource was created.

display_name

Display name of this resource.

encryption_spec

Customer-managed encryption key options for this Vertex AI resource.

If this is set, then all resources created by this Vertex AI resource will be encrypted with the provided encryption key.

gca_resource

The underlying resource proto representation.

labels

User-defined labels containing metadata about this resource.

Read more about labels at https://goo.gl/xmQnxf

metrics

Gets the evaluation metrics from the Model Evaluation.

Exceptions
Type	Description
`ValueError`	If the Model Evaluation doesn't have metrics.

name

Name of this resource.

resource_name

Full qualified resource name.

update_time

Time this resource was last updated.

Methods

delete

delete()

Deletes this Vertex AI resource. WARNING: This deletion is permanent.

Parameter
Name	Description
`sync`	`bool` Whether to execute this deletion synchronously. If False, this method will be executed in concurrent Future and any downstream object will be immediately returned and synced when the Future has completed.

list

list(
    model: str,
    filter: typing.Optional[str] = None,
    order_by: typing.Optional[str] = None,
    enable_simple_view: bool = False,
    project: typing.Optional[str] = None,
    location: typing.Optional[str] = None,
    credentials: typing.Optional[google.auth.credentials.Credentials] = None,
) -> typing.List[
    google.cloud.aiplatform.model_evaluation.model_evaluation.ModelEvaluation
]

List all ModelEvaluation resources on the provided model.

Example Usage:

aiplatform.ModelEvaluation.list( model="projects/123/locations/us-central1/models/456", )

aiplatform.Model.list( model="projects/123/locations/us-central1/models/456", order_by="create_time desc, display_name" )

Parameters
Name	Description
`model`	`str` Required. The resource name of the model to list evaluations for. For example: "projects/123/locations/us-central1/models/456".
`filter`	`str` Optional. An expression for filtering the results of the request. For field names both snake_case and camelCase are supported.
`order_by`	`str` Optional. A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: `display_name`, `create_time`, `update_time`
`project`	`str` Optional. Project to retrieve list from. If not set, project set in aiplatform.init will be used.
`location`	`str` Optional. Location to retrieve list from. If not set, location set in aiplatform.init will be used.
`credentials`	`auth_credentials.Credentials` Optional. Custom credentials to use to retrieve list. Overrides credentials set in aiplatform.init.
`parent`	`str` Optional. The parent resource name if any to retrieve list from.

to_dict

to_dict() -> typing.Dict[str, typing.Any]

Returns the resource proto as a dictionary.

wait

wait()

Helper method that blocks until all futures are complete.