Class: Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1TensorboardRun

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/aiplatform_v1beta1/classes.rb,
lib/google/apis/aiplatform_v1beta1/representations.rb,
lib/google/apis/aiplatform_v1beta1/representations.rb

Overview

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudAiplatformV1beta1TensorboardRun

Returns a new instance of GoogleCloudAiplatformV1beta1TensorboardRun.



64736
64737
64738
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 64736

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#create_time ⇒ String

Output only. Timestamp when this TensorboardRun was created. Corresponds to the JSON property createTime

Returns:

  • (String) 


64689
64690
64691
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 64689

def create_time
  @create_time
end

#description ⇒ String

Description of this TensorboardRun. Corresponds to the JSON property description

Returns:

  • (String) 


64694
64695
64696
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 64694

def description
  @description
end

#display_name ⇒ String

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

Returns:

  • (String) 


64700
64701
64702
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 64700

def display_name
  @display_name
end

#etag ⇒ String

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

Returns:

  • (String) 


64706
64707
64708
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 64706

def etag
  @etag
end

#labels ⇒ Hash<String,String>

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. Corresponds to the JSON property labels

Returns:

  • (Hash<String,String>) 


64723
64724
64725
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 64723

def labels
  @labels
end

#name ⇒ String

Output only. Name of the TensorboardRun. Format: projects/project/locations/ location/tensorboards/tensorboard/experiments/experiment/runs/run` Corresponds to the JSON propertyname`

Returns:

  • (String) 


64729
64730
64731
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 64729

def name
  @name
end

#update_time ⇒ String

Output only. Timestamp when this TensorboardRun was last updated. Corresponds to the JSON property updateTime

Returns:

  • (String) 


64734
64735
64736
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 64734

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



64741
64742
64743
64744
64745
64746
64747
64748
64749
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 64741

def update!(**args)
  @create_time = args[:create_time] if args.key?(:create_time)
  @description = args[:description] if args.key?(:description)
  @display_name = args[:display_name] if args.key?(:display_name)
  @etag = args[:etag] if args.key?(:etag)
  @labels = args[:labels] if args.key?(:labels)
  @name = args[:name] if args.key?(:name)
  @update_time = args[:update_time] if args.key?(:update_time)
end