Vertex AI V1 API - Class Google::Cloud::AIPlatform::V1::TensorboardExperiment (v0.44.0)

Reference documentation and code samples for the Vertex AI V1 API class Google::Cloud::AIPlatform::V1::TensorboardExperiment.

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

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#create_time

def create_time() -> ::Google::Protobuf::Timestamp
Returns

#description

def description() -> ::String
Returns
  • (::String) — Description of this TensorboardExperiment.

#description=

def description=(value) -> ::String
Parameter
  • value (::String) — Description of this TensorboardExperiment.
Returns
  • (::String) — Description of this TensorboardExperiment.

#display_name

def display_name() -> ::String
Returns
  • (::String) — User provided name of this TensorboardExperiment.

#display_name=

def display_name=(value) -> ::String
Parameter
  • value (::String) — User provided name of this TensorboardExperiment.
Returns
  • (::String) — User provided name of this TensorboardExperiment.

#etag

def etag() -> ::String
Returns
  • (::String) — Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.

#etag=

def etag=(value) -> ::String
Parameter
  • value (::String) — Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
Returns
  • (::String) — Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.

#labels

def labels() -> ::Google::Protobuf::Map{::String => ::String}
Returns
  • (::Google::Protobuf::Map{::String => ::String}) —

    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][google.cloud.aiplatform.v1.Dataset.metadata_schema_uri] title.

#labels=

def labels=(value) -> ::Google::Protobuf::Map{::String => ::String}
Parameter
  • value (::Google::Protobuf::Map{::String => ::String}) —

    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][google.cloud.aiplatform.v1.Dataset.metadata_schema_uri] title.
Returns
  • (::Google::Protobuf::Map{::String => ::String}) —

    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][google.cloud.aiplatform.v1.Dataset.metadata_schema_uri] title.

#name

def name() -> ::String
Returns
  • (::String) — Output only. Name of the TensorboardExperiment. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}

#source

def source() -> ::String
Returns
  • (::String) — Immutable. Source of the TensorboardExperiment. Example: a custom training job.

#source=

def source=(value) -> ::String
Parameter
  • value (::String) — Immutable. Source of the TensorboardExperiment. Example: a custom training job.
Returns
  • (::String) — Immutable. Source of the TensorboardExperiment. Example: a custom training job.

#update_time

def update_time() -> ::Google::Protobuf::Timestamp
Returns