Class Experiment (1.20.0)

Experiment(
    experiment_name: str,
    *,
    project: Optional[str] = None,
    location: Optional[str] = None,
    credentials: Optional[google.auth.credentials.Credentials] = None
)

Represents a Vertex AI Experiment resource.

Inheritance

builtins.object > Experiment

Properties

name

The name of this experiment.

resource_name

The Metadata context resource name of this experiment.

Methods

Experiment

Experiment(
    experiment_name: str,
    *,
    project: Optional[str] = None,
    location: Optional[str] = None,
    credentials: Optional[google.auth.credentials.Credentials] = None
)

my_experiment = aiplatform.Experiment('my-experiment')

Parameters

Name	Description
experiment_name	`str` Required. The name or resource name of this experiment. Resource name is of the format: `projects/123/locations/us-central1/metadataStores/default/contexts/my-experiment`
project	`str` Optional. Project where this experiment is located. Overrides project set in aiplatform.init.
location	`str` Optional. Location where this experiment is located. Overrides location set in aiplatform.init.
credentials	`auth_credentials.Credentials` Optional. Custom credentials used to retrieve this experiment. Overrides credentials set in aiplatform.init.

assign_backing_tensorboard

assign_backing_tensorboard(
    tensorboard: Union[
        google.cloud.aiplatform.tensorboard.tensorboard_resource.Tensorboard, str
    ]
)

Assigns tensorboard as backing tensorboard to support time series metrics logging.

tb = aiplatform.Tensorboard('tensorboard-resource-id')
my_experiment = aiplatform.Experiment('my-experiment')
my_experiment.assign_backing_tensorboard(tb)

Parameter

Name	Description
tensorboard	`Union[aiplatform.Tensorboard, str]` Required. Tensorboard resource or resource name to associate to this experiment.

Exceptions

Type	Description
ValueError	If this experiment already has a previously set backing tensorboard resource.
ValueError	If Tensorboard is not in same project and location as this experiment.

create

create(
    experiment_name: str,
    *,
    description: Optional[str] = None,
    project: Optional[str] = None,
    location: Optional[str] = None,
    credentials: Optional[google.auth.credentials.Credentials] = None
)

Creates a new experiment in Vertex AI Experiments.

my_experiment = aiplatform.Experiment.create('my-experiment', description='my description')

Parameters

Name	Description
experiment_name	`str` Required. The name of this experiment.
description	`str` Optional. Describes this experiment's purpose.
project	`str` Optional. Project where this experiment will be created. Overrides project set in aiplatform.init.
location	`str` Optional. Location where this experiment will be created. Overrides location set in aiplatform.init.
credentials	`auth_credentials.Credentials` Optional. Custom credentials used to create this experiment. Overrides credentials set in aiplatform.init.

delete

delete(*, delete_backing_tensorboard_runs: bool = False)

Deletes this experiment all the experiment runs under this experiment

Does not delete Pipeline runs, Artifacts, or Executions associated to this experiment or experiment runs in this experiment.

my_experiment = aiplatform.Experiment('my-experiment')
my_experiment.delete(delete_backing_tensorboard_runs=True)

Parameter

Name	Description
delete_backing_tensorboard_runs	`bool` Optional. If True will also delete the Tensorboard Runs associated to the experiment runs under this experiment that we used to store time series metrics.

get_backing_tensorboard_resource

get_backing_tensorboard_resource()

Get the backing tensorboard for this experiment in one exists.

my_experiment = aiplatform.Experiment('my-experiment')
tb = my_experiment.get_backing_tensorboard_resource()

get_data_frame

get_data_frame()

Get parameters, metrics, and time series metrics of all runs in this experiment as Dataframe.

my_experiment = aiplatform.Experiment('my-experiment')
df = my_experiment.get_data_frame()

Exceptions

Type	Description
ImportError	If pandas is not installed.

Returns

Type	Description
pd.DataFrame	Pandas Dataframe of Experiment Runs.

get_or_create

get_or_create(
    experiment_name: str,
    *,
    description: Optional[str] = None,
    project: Optional[str] = None,
    location: Optional[str] = None,
    credentials: Optional[google.auth.credentials.Credentials] = None
)

Gets experiment if one exists with this experiment_name in Vertex AI Experiments.

Otherwise creates this experiment.

my_experiment = aiplatform.Experiment.get_or_create('my-experiment', description='my description')

Parameters

Name	Description
experiment_name	`str` Required. The name of this experiment.
description	`str` Optional. Describes this experiment's purpose.
project	`str` Optional. Project where this experiment will be retrieved from or created. Overrides project set in aiplatform.init.
location	`str` Optional. Location where this experiment will be retrieved from or created. Overrides location set in aiplatform.init.
credentials	`auth_credentials.Credentials` Optional. Custom credentials used to retrieve or create this experiment. Overrides credentials set in aiplatform.init.

list

list(
    *,
    project: Optional[str] = None,
    location: Optional[str] = None,
    credentials: Optional[google.auth.credentials.Credentials] = None
)

List all Vertex AI Experiments in the given project.

my_experiments = aiplatform.Experiment.list()

Parameters

Name	Description
project	`str` Optional. Project to list these experiments from. Overrides project set in aiplatform.init.
location	`str` Optional. Location to list these experiments from. Overrides location set in aiplatform.init.
credentials	`auth_credentials.Credentials` Optional. Custom credentials to list these experiments. Overrides credentials set in aiplatform.init.