- 1.71.0 (latest)
- 1.70.0
- 1.69.0
- 1.68.0
- 1.67.1
- 1.66.0
- 1.65.0
- 1.63.0
- 1.62.0
- 1.60.0
- 1.59.0
- 1.58.0
- 1.57.0
- 1.56.0
- 1.55.0
- 1.54.1
- 1.53.0
- 1.52.0
- 1.51.0
- 1.50.0
- 1.49.0
- 1.48.0
- 1.47.0
- 1.46.0
- 1.45.0
- 1.44.0
- 1.43.0
- 1.39.0
- 1.38.1
- 1.37.0
- 1.36.4
- 1.35.0
- 1.34.0
- 1.33.1
- 1.32.0
- 1.31.1
- 1.30.1
- 1.29.0
- 1.28.1
- 1.27.1
- 1.26.1
- 1.25.0
- 1.24.1
- 1.23.0
- 1.22.1
- 1.21.0
- 1.20.0
- 1.19.1
- 1.18.3
- 1.17.1
- 1.16.1
- 1.15.1
- 1.14.0
- 1.13.1
- 1.12.1
- 1.11.0
- 1.10.0
- 1.9.0
- 1.8.1
- 1.7.1
- 1.6.2
- 1.5.0
- 1.4.3
- 1.3.0
- 1.2.0
- 1.1.1
- 1.0.1
- 0.9.0
- 0.8.0
- 0.7.1
- 0.6.0
- 0.5.1
- 0.4.0
- 0.3.1
Experiment(
experiment_name: str,
*,
project: typing.Optional[str] = None,
location: typing.Optional[str] = None,
credentials: typing.Optional[google.auth.credentials.Credentials] = None
)
Represents a Vertex AI Experiment resource.
Properties
backing_tensorboard_resource_name
The Tensorboard resource associated with this Experiment if there is one.
dashboard_url
Cloud console URL for this resource.
name
The name of this experiment.
resource_name
The Metadata context resource name of this experiment.
Methods
Experiment
Experiment(
experiment_name: str,
*,
project: typing.Optional[str] = None,
location: typing.Optional[str] = None,
credentials: typing.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: |
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: typing.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: typing.Optional[str] = None,
project: typing.Optional[str] = None,
location: typing.Optional[str] = None,
credentials: typing.Optional[google.auth.credentials.Credentials] = None
) -> google.cloud.aiplatform.metadata.experiment_resources.Experiment
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
get(
experiment_name: str,
*,
project: typing.Optional[str] = None,
location: typing.Optional[str] = None,
credentials: typing.Optional[google.auth.credentials.Credentials] = None
) -> typing.Optional[google.cloud.aiplatform.metadata.experiment_resources.Experiment]
Gets experiment if one exists with this experiment_name in Vertex AI Experiments.
Parameters | |
---|---|
Name | Description |
experiment_name |
str
Required. The name of this experiment. |
project |
str
Optional. Project used to retrieve this resource. Overrides project set in aiplatform.init. |
location |
str
Optional. Location used to retrieve this resource. Overrides location set in aiplatform.init. |
credentials |
auth_credentials.Credentials
Optional. Custom credentials used to retrieve this resource. Overrides credentials set in aiplatform.init. |
get_backing_tensorboard_resource
get_backing_tensorboard_resource() -> (
typing.Optional[
google.cloud.aiplatform.tensorboard.tensorboard_resource.Tensorboard
]
)
Get the backing tensorboard for this experiment if one exists.
my_experiment = aiplatform.Experiment('my-experiment')
tb = my_experiment.get_backing_tensorboard_resource()
get_data_frame
get_data_frame(*, include_time_series: bool = True) -> pd.DataFrame
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()
Parameter | |
---|---|
Name | Description |
include_time_series |
bool
Optional. Whether or not to include time series metrics in df. Default is True. Setting to False will largely improve execution time and reduce quota contributing calls. Recommended when time series metrics are not needed or number of runs in Experiment is large. For time series metrics consider querying a specific run using get_time_series_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: typing.Optional[str] = None,
project: typing.Optional[str] = None,
location: typing.Optional[str] = None,
credentials: typing.Optional[google.auth.credentials.Credentials] = None
) -> google.cloud.aiplatform.metadata.experiment_resources.Experiment
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: typing.Optional[str] = None,
location: typing.Optional[str] = None,
credentials: typing.Optional[google.auth.credentials.Credentials] = None
) -> typing.List[google.cloud.aiplatform.metadata.experiment_resources.Experiment]
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. |