Cloud AI Platform v1 API - Class TensorboardRun (2.5.0)

public sealed class TensorboardRun : IMessage<TensorboardRun>, IEquatable<TensorboardRun>, IDeepCloneable<TensorboardRun>, IBufferMessage, IMessage

Reference documentation and code samples for the Cloud AI Platform v1 API class TensorboardRun.

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

Inheritance

Object > TensorboardRun

Implements

IMessage<TensorboardRun>, IEquatable<TensorboardRun>, IDeepCloneable<TensorboardRun>, IBufferMessage, IMessage

Inherited Members

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Object.ToString()

Namespace

Google.Cloud.AIPlatform.V1

Assembly

Google.Cloud.AIPlatform.V1.dll

Constructors

TensorboardRun()

public TensorboardRun()

TensorboardRun(TensorboardRun)

public TensorboardRun(TensorboardRun other)

Parameter
Name	Description
`other`	`TensorboardRun`

Properties

CreateTime

public Timestamp CreateTime { get; set; }

Output only. Timestamp when this TensorboardRun was created.

Property Value
Type	Description
`Timestamp`

Description

public string Description { get; set; }

Description of this TensorboardRun.

Property Value
Type	Description
`String`

DisplayName

public string DisplayName { get; set; }

Required. User provided name of this TensorboardRun. This value must be unique among all TensorboardRuns belonging to the same parent TensorboardExperiment.

Property Value
Type	Description
`String`

Etag

public string Etag { get; set; }

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

Property Value
Type	Description
`String`

Labels

public MapField<string, string> Labels { get; }

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.

Property Value
Type	Description
`MapField<String, String>`

Name

public string Name { get; set; }

Output only. Name of the TensorboardRun. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}

Property Value
Type	Description
`String`

TensorboardRunName

public TensorboardRunName TensorboardRunName { get; set; }

TensorboardRunName-typed view over the Name resource name property.

Property Value
Type	Description
`TensorboardRunName`

UpdateTime

public Timestamp UpdateTime { get; set; }

Output only. Timestamp when this TensorboardRun was last updated.

Property Value
Type	Description
`Timestamp`