Google Cloud Ai Platform V1 Client - Class TensorboardRun (0.12.0)

Reference documentation and code samples for the Google Cloud Ai Platform V1 Client class TensorboardRun.

TensorboardRun maps to a specific execution of a training job with a given set of hyperparameter values, model definition, dataset, etc

Generated from protobuf message google.cloud.aiplatform.v1.TensorboardRun

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ name`	`string` Output only. Name of the TensorboardRun. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}`
`↳ display_name`	`string` Required. User provided name of this TensorboardRun. This value must be unique among all TensorboardRuns belonging to the same parent TensorboardExperiment.
`↳ description`	`string` Description of this TensorboardRun.
`↳ create_time`	`Google\Protobuf\Timestamp` Output only. Timestamp when this TensorboardRun was created.
`↳ update_time`	`Google\Protobuf\Timestamp` Output only. Timestamp when this TensorboardRun was last updated.
`↳ labels`	`array\|Google\Protobuf\Internal\MapField` The labels with user-defined metadata to organize your TensorboardRuns. This field will be used to filter and visualize Runs in the Tensorboard UI. For example, a Vertex AI training job can set a label aiplatform.googleapis.com/training_job_id=xxxxx to all the runs created within that job. An end user can set a label experiment_id=xxxxx for all the runs produced in a Jupyter notebook. These runs can be grouped by a label value and visualized together in the Tensorboard UI. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one TensorboardRun (System labels are excluded). See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with "aiplatform.googleapis.com/" and are immutable.
`↳ etag`	`string` Used to perform a consistent read-modify-write updates. If not set, a blind "overwrite" update happens.

getName

Output only. Name of the TensorboardRun.

Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}

Returns
Type	Description
`string`

setName

Output only. Name of the TensorboardRun.

Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getDisplayName

Required. User provided name of this TensorboardRun.

This value must be unique among all TensorboardRuns belonging to the same parent TensorboardExperiment.

Returns
Type	Description
`string`

setDisplayName

Required. User provided name of this TensorboardRun.

This value must be unique among all TensorboardRuns belonging to the same parent TensorboardExperiment.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getDescription

Description of this TensorboardRun.

Returns
Type	Description
`string`

setDescription

Description of this TensorboardRun.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getCreateTime

Output only. Timestamp when this TensorboardRun was created.

Returns
Type	Description
`Google\Protobuf\Timestamp\|null`

hasCreateTime

clearCreateTime

setCreateTime

Output only. Timestamp when this TensorboardRun was created.

Parameter
Name	Description
`var`	`Google\Protobuf\Timestamp`

Returns
Type	Description
`$this`

getUpdateTime

Output only. Timestamp when this TensorboardRun was last updated.

Returns
Type	Description
`Google\Protobuf\Timestamp\|null`

hasUpdateTime

clearUpdateTime

setUpdateTime

Output only. Timestamp when this TensorboardRun was last updated.

Parameter
Name	Description
`var`	`Google\Protobuf\Timestamp`

Returns
Type	Description
`$this`

getLabels

The labels with user-defined metadata to organize your TensorboardRuns.

This field will be used to filter and visualize Runs in the Tensorboard UI. For example, a Vertex AI training job can set a label aiplatform.googleapis.com/training_job_id=xxxxx to all the runs created within that job. An end user can set a label experiment_id=xxxxx for all the runs produced in a Jupyter notebook. These runs can be grouped by a label value and visualized together in the Tensorboard UI. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one TensorboardRun (System labels are excluded). See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with "aiplatform.googleapis.com/" and are immutable.

Returns
Type	Description
`Google\Protobuf\Internal\MapField`

setLabels

The labels with user-defined metadata to organize your TensorboardRuns.

Parameter
Name	Description
`var`	`array\|Google\Protobuf\Internal\MapField`

Returns
Type	Description
`$this`

getEtag

Used to perform a consistent read-modify-write updates. If not set, a blind "overwrite" update happens.

Returns
Type	Description
`string`

setEtag

Used to perform a consistent read-modify-write updates. If not set, a blind "overwrite" update happens.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`