Some or all of the information on this page might not apply to Cloud de Confiance by S3NS. See Differences from Google Cloud for more details.

Class ModelEvaluation (1.17.1)

ModelEvaluation(
    evaluation_name: str,
    model_id: Optional[str] = None,
    project: Optional[str] = None,
    location: Optional[str] = None,
    credentials: 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.

Inheritance

builtins.object > google.cloud.aiplatform.base.VertexAiResourceNoun > builtins.object > google.cloud.aiplatform.base.FutureManager > google.cloud.aiplatform.base.VertexAiResourceNounWithFutureManager > ModelEvaluation

Properties

metrics

Gets the evaluation metrics from the Model Evaluation.

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.