Class: Google::Apis::AiplatformV1::GoogleCloudAiplatformV1TensorboardExperiment

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

Overview

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudAiplatformV1TensorboardExperiment

Returns a new instance of GoogleCloudAiplatformV1TensorboardExperiment.



36689
36690
36691
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 36689

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

Instance Attribute Details

#create_time ⇒ String

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

Returns:

  • (String) 


36641
36642
36643
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 36641

def create_time
  @create_time
end

#description ⇒ String

Description of this TensorboardExperiment. Corresponds to the JSON property description

Returns:

  • (String) 


36646
36647
36648
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 36646

def description
  @description
end

#display_name ⇒ String

User provided name of this TensorboardExperiment. Corresponds to the JSON property displayName

Returns:

  • (String) 


36651
36652
36653
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 36651

def display_name
  @display_name
end

#etag ⇒ String

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

Returns:

  • (String) 


36657
36658
36659
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 36657

def etag
  @etag
end

#labels ⇒ Hash<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 title. Corresponds to the JSON property labels

Returns:

  • (Hash<String,String>) 


36671
36672
36673
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 36671

def labels
  @labels
end

#name ⇒ String

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

Returns:

  • (String) 


36677
36678
36679
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 36677

def name
  @name
end

#source ⇒ String

Immutable. Source of the TensorboardExperiment. Example: a custom training job. Corresponds to the JSON property source

Returns:

  • (String) 


36682
36683
36684
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 36682

def source
  @source
end

#update_time ⇒ String

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

Returns:

  • (String) 


36687
36688
36689
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 36687

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



36694
36695
36696
36697
36698
36699
36700
36701
36702
36703
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 36694

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)
  @source = args[:source] if args.key?(:source)
  @update_time = args[:update_time] if args.key?(:update_time)
end