Google Cloud Ai Platform V1 Client - Class TensorboardExperiment (0.11.1)

Version 0.11.1

• 1.13.1 (latest)
• 1.13.0
• 1.12.0
• 1.11.0
• 1.10.0
• 1.9.0
• 1.8.0
• 1.7.0
• 1.6.0
• 1.5.0
• 1.4.0
• 1.3.0
• 1.2.0
• 1.1.0
• 1.0.0
• 0.39.0
• 0.38.0
• 0.37.1
• 0.32.0
• 0.31.0
• 0.30.0
• 0.29.0
• 0.28.0
• 0.27.0
• 0.26.2
• 0.25.0
• 0.24.0
• 0.23.0
• 0.22.0
• 0.21.0
• 0.20.0
• 0.19.0
• 0.18.0
• 0.17.0
• 0.16.0
• 0.15.0
• 0.13.0
• 0.12.0
• 0.11.1
• 0.10.0

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

A TensorboardExperiment is a group of TensorboardRuns, that are typically the results of a training job run, in a Tensorboard.

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

Methods

__construct

Constructor.

Parameters
Name	Description
data	array Optional. Data for populating the Message object.
↳ name	string Output only. Name of the TensorboardExperiment. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}
↳ display_name	string User provided name of this TensorboardExperiment.
↳ description	string Description of this TensorboardExperiment.
↳ create_time	Google\Protobuf\Timestamp Output only. Timestamp when this TensorboardExperiment was created.
↳ update_time	Google\Protobuf\Timestamp Output only. Timestamp when this TensorboardExperiment was last updated.
↳ labels	array|Google\Protobuf\Internal\MapField The labels with user-defined metadata to organize your Datasets. 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 Dataset (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. Following system labels exist for each Dataset: * "aiplatform.googleapis.com/dataset_metadata_schema": - output only, its value is the metadata_schema's title.
↳ etag	string Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
↳ source	string Immutable. Source of the TensorboardExperiment. Example: a custom training job.

getName

Output only. Name of the TensorboardExperiment.

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

Returns
Type	Description
string

setName

Output only. Name of the TensorboardExperiment.

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

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getDisplayName

User provided name of this TensorboardExperiment.

Returns
Type	Description
string

setDisplayName

User provided name of this TensorboardExperiment.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getDescription

Description of this TensorboardExperiment.

Returns
Type	Description
string

setDescription

Description of this TensorboardExperiment.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getCreateTime

Output only. Timestamp when this TensorboardExperiment was created.

Returns
Type	Description
Google\Protobuf\Timestamp|null

hasCreateTime

clearCreateTime

setCreateTime

Output only. Timestamp when this TensorboardExperiment was created.

Parameter
Name	Description
var	Google\Protobuf\Timestamp

Returns
Type	Description
$this

getUpdateTime

Output only. Timestamp when this TensorboardExperiment was last updated.

Returns
Type	Description
Google\Protobuf\Timestamp|null

hasUpdateTime

clearUpdateTime

setUpdateTime

Output only. Timestamp when this TensorboardExperiment was last updated.

Parameter
Name	Description
var	Google\Protobuf\Timestamp

Returns
Type	Description
$this

getLabels

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

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 Dataset (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. Following system labels exist for each Dataset:

• "aiplatform.googleapis.com/dataset_metadata_schema":
  • output only, its value is the metadata_schema's title.

Returns
Type	Description
Google\Protobuf\Internal\MapField

setLabels

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

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 Dataset (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. Following system labels exist for each Dataset:

• "aiplatform.googleapis.com/dataset_metadata_schema":
  • output only, its value is the metadata_schema's title.

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

Returns
Type	Description
$this

getEtag

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

Returns
Type	Description
string

setEtag

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

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getSource

Immutable. Source of the TensorboardExperiment. Example: a custom training job.

Returns
Type	Description
string

setSource

Immutable. Source of the TensorboardExperiment. Example: a custom training job.

Parameter
Name	Description
var	string

Returns
Type	Description
$this