Class: Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1HyperparameterTuningJob

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

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

Returns a new instance of GoogleCloudAiplatformV1beta1HyperparameterTuningJob.



7393
7394
7395
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 7393

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) 


7300
7301
7302
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 7300

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) 


7306
7307
7308
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 7306

def display_name
  @display_name
end

#encryption_spec ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1EncryptionSpec

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

Returns:



7312
7313
7314
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 7312

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) 


7319
7320
7321
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 7319

def end_time
  @end_time
end

#error ⇒ Google::Apis::AiplatformV1beta1::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:



7329
7330
7331
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 7329

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


7338
7339
7340
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 7338

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) 


7345
7346
7347
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 7345

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) 


7350
7351
7352
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 7350

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) 


7355
7356
7357
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 7355

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) 


7360
7361
7362
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 7360

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) 


7366
7367
7368
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 7366

def start_time
  @start_time
end

#state ⇒ String

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

Returns:

  • (String) 


7371
7372
7373
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 7371

def state
  @state
end

#study_spec ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1StudySpec

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

Returns:



7376
7377
7378
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 7376

def study_spec
  @study_spec
end

#trial_job_spec ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1CustomJobSpec

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

Returns:



7381
7382
7383
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 7381

def trial_job_spec
  @trial_job_spec
end

#trials ⇒ Array<Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Trial>

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

Returns:



7386
7387
7388
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 7386

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) 


7391
7392
7393
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 7391

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



7398
7399
7400
7401
7402
7403
7404
7405
7406
7407
7408
7409
7410
7411
7412
7413
7414
7415
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 7398

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