Class ExperimentRun (1.17.1)

ExperimentRun(
    run_name: str,
    experiment: Union[
        google.cloud.aiplatform.metadata.experiment_resources.Experiment, str
    ],
    *,
    project: Optional[str] = None,
    location: Optional[str] = None,
    credentials: Optional[google.auth.credentials.Credentials] = None
)

A Vertex AI Experiment run

Inheritance

builtins.object > abc.ABC > google.cloud.aiplatform.metadata.experiment_resources._ExperimentLoggable > ExperimentRun

Properties

credentials

The credentials used to access this experiment run.

location

The location that this experiment is located in.

name

This run's name used to identify this run within it's Experiment.

project

The project that this experiment run is located in.

resource_id

The resource ID of this experiment run's Metadata context.

The resource ID is the final part of the resource name: projects/{project}/locations/{location}/metadataStores/{metadatastore}/contexts/{resource ID}

resource_name

This run's Metadata context resource name.

In the format: projects/{project}/locations/{location}/metadataStores/{metadatastore}/contexts/{context}

state

The state of this run.

Methods

ExperimentRun

ExperimentRun(
    run_name: str,
    experiment: Union[
        google.cloud.aiplatform.metadata.experiment_resources.Experiment, str
    ],
    *,
    project: Optional[str] = None,
    location: Optional[str] = None,
    credentials: Optional[google.auth.credentials.Credentials] = None
)

my_run = aiplatform.ExperimentRun('my-run, experiment='my-experiment')

Parameters

Name	Description
run_name	`str` Required. The name of this run.
experiment	`Union[experiment_resources.Experiment, str]` Required. The name or instance of this experiment.
project	`str` Optional. Project where this experiment run is located. Overrides project set in aiplatform.init.
location	`str` Optional. Location where this experiment run is located. Overrides location set in aiplatform.init.
credentials	`auth_credentials.Credentials` Optional. Custom credentials used to retrieve this experiment run. 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 timeseries metrics logging for this run.

Parameter

Name	Description
tensorboard	`Union[aiplatform.Tensorboard, str]` Required. Tensorboard instance or resource name.

associate_execution

associate_execution(
    execution: google.cloud.aiplatform.metadata.execution.Execution,
)

Associate an execution to this experiment run.

Parameter

Name	Description
execution	`aiplatform.Execution` Execution to associate to this run.

create

create(run_name: str, *, experiment: Optional[Union[str, google.cloud.aiplatform.metadata.experiment_resources.Experiment]] = None, tensorboard: Optional[Union[google.cloud.aiplatform.tensorboard.tensorboard_resource.Tensorboard, str]] = None, state: google.cloud.aiplatform_v1.types.execution.Execution.State = <State.RUNNING: 2>, project: Optional[str] = None, location: Optional[str] = None, credentials: Optional[google.auth.credentials.Credentials] = None)

Creates a new experiment run in Vertex AI Experiments.

my_run = aiplatform.ExperimentRun.create('my-run', experiment='my-experiment')

Parameters

Name	Description
run_name	`str` Required. The name of this run.
experiment	`Union[aiplatform.Experiment, str]` Optional. The name or instance of the experiment to create this run under. If not provided, will default to the experiment set in `aiplatform.init`.
tensorboard	`Union[aiplatform.Tensorboard, str]` Optional. The resource name or instance of Vertex Tensorbaord to use as the backing Tensorboard for time series metric logging. If not provided, will default to the the backing tensorboard of parent experiment if set. Must be in same project and location as this experiment run.
state	`aiplatform.gapic.Execution.State` Optional. The state of this run. Defaults to RUNNING.
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_run: bool = False)

Deletes this experiment run.

Does not delete the executions, artifacts, or resources logged to this run.

Parameter

Name	Description
delete_backing_tensorboard_run	`bool` Optional. Whether to delete the backing tensorboard run that stores time series metrics for this run.

end_run

end_run(*, state: google.cloud.aiplatform_v1.types.execution.Execution.State = <State.COMPLETE: 3>)

Ends this experiment run and sets state to COMPLETE.

Parameter

Name	Description
state	`aiplatform.gapic.Execution.State` Optional. Override the state at the end of run. Defaults to COMPLETE.

get_artifacts

get_artifacts()

Get the list of artifacts associated to this run.

get_executions

get_executions()

Get the List of Executions associated to this run

get_logged_pipeline_jobs

get_logged_pipeline_jobs()

Get all PipelineJobs associated to this experiment run.

get_metrics

get_metrics()

Get the summary metrics logged to this run.

get_params

get_params()

Get the parameters logged to this run.

get_time_series_data_frame

get_time_series_data_frame()

Returns all time series in this Run as a DataFrame.

Returns

Type	Description
pd.DataFrame	Time series metrics in this Run as a Dataframe.

list

list(
    *,
    experiment: Optional[
        Union[str, google.cloud.aiplatform.metadata.experiment_resources.Experiment]
    ] = None,
    project: Optional[str] = None,
    location: Optional[str] = None,
    credentials: Optional[google.auth.credentials.Credentials] = None
)

List the experiment runs for a given aiplatform.Experiment.

my_runs = aiplatform.ExperimentRun.list(experiment='my-experiment')

Parameters

Name	Description
experiment	`Union[aiplatform.Experiment, str]` Optional. The experiment name or instance to list the experiment run from. If not provided, will use the experiment set in aiplatform.init.
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.

log

log(
    *, pipeline_job: Optional[google.cloud.aiplatform.pipeline_jobs.PipelineJob] = None
)

Log a Vertex Resource to this experiment run.

my_run = aiplatform.ExperimentRun('my-run', experiment='my-experiment')
my_job = aiplatform.PipelineJob(...)
my_job.submit()
my_run.log(my_job)

Parameter

Name	Description
pipeline_job	`aiplatform.PipelineJob` Optional. A Vertex PipelineJob.

log_metrics

log_metrics(metrics: Dict[str, Union[float, int, str]])

Log single or multiple Metrics with specified key and value pairs.

Metrics with the same key will be overwritten.

my_run = aiplatform.ExperimentRun('my-run', experiment='my-experiment')
my_run.log_metrics({'accuracy': 0.9, 'recall': 0.8})

Parameter

Name	Description
metrics	`Dict[str, Union[float, int, str]]` Required. Metrics key/value pairs.

Exceptions

Type	Description
TypeError	If keys are not str or values are not float, int, or str.

log_params

log_params(params: Dict[str, Union[float, int, str]])

Log single or multiple parameters with specified key value pairs.

Parameters with the same key will be overwritten.

my_run = aiplatform.ExperimentRun('my-run', experiment='my-experiment')
my_run.log_params({'learning_rate': 0.1, 'dropout_rate': 0.2})

Parameter

Name	Description
params	`Dict[str, Union[float, int, str]]` Required. Parameter key/value pairs.

Exceptions

Type	Description
TypeError	If key is not str or value is not float, int, str.

log_time_series_metrics

log_time_series_metrics(
    metrics: Dict[str, float],
    step: Optional[int] = None,
    wall_time: Optional[google.protobuf.timestamp_pb2.Timestamp] = None,
)

Logs time series metrics to backing TensorboardRun of this Experiment Run.

run.log_time_series_metrics({'accuracy': 0.9}, step=10)

Parameters

Name	Description
metrics	`Dict[str, Union[str, float]]` Required. Dictionary of where keys are metric names and values are metric values.
step	`int` Optional. Step index of this data point within the run. If not provided, the latest step amongst all time series metrics already logged will be used.
wall_time	`timestamp_pb2.Timestamp` Optional. Wall clock timestamp when this data point is generated by the end user. If not provided, this will be generated based on the value from time.time()

Exceptions

Type	Description
RuntimeError	If current experiment run doesn't have a backing Tensorboard resource.

update_state

update_state(state: google.cloud.aiplatform_v1.types.execution.Execution.State)

Update the state of this experiment run.

my_run = aiplatform.ExperimentRun('my-run', experiment='my-experiment')
my_run.update_state(state=aiplatform.gapic.Execution.State.COMPLETE)

Parameter

Name	Description
state	`aiplatform.gapic.Execution.State` State of this run.

Class ExperimentRun (1.17.1)Stay organized with collections Save and categorize content based on your preferences.

Inheritance

Properties

credentials

location

name

project

resource_id

resource_name

state

Methods

ExperimentRun

assign_backing_tensorboard

associate_execution

create

delete

end_run

get_artifacts

get_executions

get_logged_pipeline_jobs

get_metrics

get_params

get_time_series_data_frame

list

log

log_metrics

log_params

log_time_series_metrics

update_state

Class ExperimentRun (1.17.1)