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.



10444
10445
10446
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 10444

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) 


10351
10352
10353
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 10351

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) 


10357
10358
10359
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 10357

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:



10363
10364
10365
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 10363

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) 


10370
10371
10372
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 10370

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:



10380
10381
10382
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 10380

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


10389
10390
10391
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 10389

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) 


10396
10397
10398
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 10396

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) 


10401
10402
10403
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 10401

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) 


10406
10407
10408
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 10406

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) 


10411
10412
10413
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 10411

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) 


10417
10418
10419
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 10417

def start_time
  @start_time
end

#state ⇒ String

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

Returns:

  • (String) 


10422
10423
10424
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 10422

def state
  @state
end

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

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

Returns:



10427
10428
10429
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 10427

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:



10432
10433
10434
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 10432

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:



10437
10438
10439
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 10437

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) 


10442
10443
10444
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 10442

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



10449
10450
10451
10452
10453
10454
10455
10456
10457
10458
10459
10460
10461
10462
10463
10464
10465
10466
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 10449

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