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.



30258
30259
30260
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 30258

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) 


30210
30211
30212
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 30210

def create_time
  @create_time
end

#description ⇒ String

Description of this TensorboardExperiment. Corresponds to the JSON property description

Returns:

  • (String) 


30215
30216
30217
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 30215

def description
  @description
end

#display_name ⇒ String

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

Returns:

  • (String) 


30220
30221
30222
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 30220

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) 


30226
30227
30228
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 30226

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>) 


30240
30241
30242
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 30240

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) 


30246
30247
30248
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 30246

def name
  @name
end

#source ⇒ String

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

Returns:

  • (String) 


30251
30252
30253
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 30251

def source
  @source
end

#update_time ⇒ String

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

Returns:

  • (String) 


30256
30257
30258
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 30256

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



30263
30264
30265
30266
30267
30268
30269
30270
30271
30272
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 30263

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