Class: Google::Apis::AiplatformV1::GoogleCloudAiplatformV1HyperparameterTuningJob

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

Represents a HyperparameterTuningJob. A HyperparameterTuningJob has a Study specification and multiple CustomJobs with identical CustomJob specification.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudAiplatformV1HyperparameterTuningJob

Returns a new instance of GoogleCloudAiplatformV1HyperparameterTuningJob.



10273
10274
10275
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 10273

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

Instance Attribute Details

#create_time ⇒ String

Output only. Time when the HyperparameterTuningJob was created. Corresponds to the JSON property createTime

Returns:

  • (String) 


10180
10181
10182
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 10180

def create_time
  @create_time
end

#display_name ⇒ String

Required. The display name of the HyperparameterTuningJob. The name can be up to 128 characters long and can consist of any UTF-8 characters. Corresponds to the JSON property displayName

Returns:

  • (String) 


10186
10187
10188
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 10186

def display_name
  @display_name
end

#encryption_spec ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1EncryptionSpec

Represents a customer-managed encryption key spec that can be applied to a top- level resource. Corresponds to the JSON property encryptionSpec

Returns:



10192
10193
10194
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 10192

def encryption_spec
  @encryption_spec
end

#end_time ⇒ String

Output only. Time when the HyperparameterTuningJob entered any of the following states: JOB_STATE_SUCCEEDED, JOB_STATE_FAILED, JOB_STATE_CANCELLED. Corresponds to the JSON property endTime

Returns:

  • (String) 


10199
10200
10201
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 10199

def end_time
  @end_time
end

#error ⇒ Google::Apis::AiplatformV1::GoogleRpcStatus

The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. Each Status message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide. Corresponds to the JSON property error

Returns:



10209
10210
10211
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 10209

def error
  @error
end

#labels ⇒ Hash<String,String>

The labels with user-defined metadata to organize HyperparameterTuningJobs. 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. See https://goo.gl/xmQnxf for more information and examples of labels. Corresponds to the JSON property labels

Returns:

  • (Hash<String,String>) 


10218
10219
10220
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 10218

def labels
  @labels
end

#max_failed_trial_count ⇒ Fixnum

The number of failed Trials that need to be seen before failing the HyperparameterTuningJob. If set to 0, Vertex AI decides how many Trials must fail before the whole job fails. Corresponds to the JSON property maxFailedTrialCount

Returns:

  • (Fixnum) 


10225
10226
10227
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 10225

def max_failed_trial_count
  @max_failed_trial_count
end

#max_trial_count ⇒ Fixnum

Required. The desired total number of Trials. Corresponds to the JSON property maxTrialCount

Returns:

  • (Fixnum) 


10230
10231
10232
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 10230

def max_trial_count
  @max_trial_count
end

#name ⇒ String

Output only. Resource name of the HyperparameterTuningJob. Corresponds to the JSON property name

Returns:

  • (String) 


10235
10236
10237
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 10235

def name
  @name
end

#parallel_trial_count ⇒ Fixnum

Required. The desired number of Trials to run in parallel. Corresponds to the JSON property parallelTrialCount

Returns:

  • (Fixnum) 


10240
10241
10242
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 10240

def parallel_trial_count
  @parallel_trial_count
end

#start_time ⇒ String

Output only. Time when the HyperparameterTuningJob for the first time entered the JOB_STATE_RUNNING state. Corresponds to the JSON property startTime

Returns:

  • (String) 


10246
10247
10248
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 10246

def start_time
  @start_time
end

#state ⇒ String

Output only. The detailed state of the job. Corresponds to the JSON property state

Returns:

  • (String) 


10251
10252
10253
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 10251

def state
  @state
end

#study_spec ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1StudySpec

Represents specification of a Study. Corresponds to the JSON property studySpec

Returns:



10256
10257
10258
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 10256

def study_spec
  @study_spec
end

#trial_job_spec ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1CustomJobSpec

Represents the spec of a CustomJob. Corresponds to the JSON property trialJobSpec

Returns:



10261
10262
10263
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 10261

def trial_job_spec
  @trial_job_spec
end

#trials ⇒ Array<Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Trial>

Output only. Trials of the HyperparameterTuningJob. Corresponds to the JSON property trials

Returns:



10266
10267
10268
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 10266

def trials
  @trials
end

#update_time ⇒ String

Output only. Time when the HyperparameterTuningJob was most recently updated. Corresponds to the JSON property updateTime

Returns:

  • (String) 


10271
10272
10273
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 10271

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



10278
10279
10280
10281
10282
10283
10284
10285
10286
10287
10288
10289
10290
10291
10292
10293
10294
10295
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 10278

def update!(**args)
  @create_time = args[:create_time] if args.key?(:create_time)
  @display_name = args[:display_name] if args.key?(:display_name)
  @encryption_spec = args[:encryption_spec] if args.key?(:encryption_spec)
  @end_time = args[:end_time] if args.key?(:end_time)
  @error = args[:error] if args.key?(:error)
  @labels = args[:labels] if args.key?(:labels)
  @max_failed_trial_count = args[:max_failed_trial_count] if args.key?(:max_failed_trial_count)
  @max_trial_count = args[:max_trial_count] if args.key?(:max_trial_count)
  @name = args[:name] if args.key?(:name)
  @parallel_trial_count = args[:parallel_trial_count] if args.key?(:parallel_trial_count)
  @start_time = args[:start_time] if args.key?(:start_time)
  @state = args[:state] if args.key?(:state)
  @study_spec = args[:study_spec] if args.key?(:study_spec)
  @trial_job_spec = args[:trial_job_spec] if args.key?(:trial_job_spec)
  @trials = args[:trials] if args.key?(:trials)
  @update_time = args[:update_time] if args.key?(:update_time)
end