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.



11796
11797
11798
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 11796

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) 


11703
11704
11705
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 11703

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) 


11709
11710
11711
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 11709

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:



11715
11716
11717
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 11715

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) 


11722
11723
11724
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 11722

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:



11732
11733
11734
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 11732

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


11741
11742
11743
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 11741

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) 


11748
11749
11750
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 11748

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) 


11753
11754
11755
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 11753

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) 


11758
11759
11760
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 11758

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) 


11763
11764
11765
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 11763

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) 


11769
11770
11771
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 11769

def start_time
  @start_time
end

#state ⇒ String

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

Returns:

  • (String) 


11774
11775
11776
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 11774

def state
  @state
end

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

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

Returns:



11779
11780
11781
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 11779

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:



11784
11785
11786
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 11784

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:



11789
11790
11791
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 11789

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) 


11794
11795
11796
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 11794

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



11801
11802
11803
11804
11805
11806
11807
11808
11809
11810
11811
11812
11813
11814
11815
11816
11817
11818
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 11801

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