Google Cloud Ai Platform V1 Client - Class TensorboardExperiment (0.30.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

Namespace

Google \ Cloud \ AIPlatform \ V1

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 TensorboardExperiment. Label keys and values cannot be 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. The 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

hasCreateTime

clearCreateTime

setCreateTime

Output only. Timestamp when this TensorboardExperiment was created.

Parameter
Name
Description
Returns
Type
Description
$this

getUpdateTime

Output only. Timestamp when this TensorboardExperiment was last updated.

Returns
Type
Description

hasUpdateTime

clearUpdateTime

setUpdateTime

Output only. Timestamp when this TensorboardExperiment was last updated.

Parameter
Name
Description
Returns
Type
Description
$this

getLabels

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

Label keys and values cannot be 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. The 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

setLabels

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

Label keys and values cannot be 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. The 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
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
Design a Mobile Site
View Site in Mobile | Classic
Share by: