Class: Google::Apis::AiplatformV1::GoogleCloudAiplatformV1StudySpecStudyStoppingConfig

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

The configuration (stopping conditions) for automated stopping of a Study. Conditions include trial budgets, time budgets, and convergence detection.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudAiplatformV1StudySpecStudyStoppingConfig

Returns a new instance of GoogleCloudAiplatformV1StudySpecStudyStoppingConfig.



32845
32846
32847
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 32845

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

Instance Attribute Details

#max_duration_no_progress ⇒ String

If the objective value has not improved for this much time, stop the study. WARNING: Effective only for single-objective studies. Corresponds to the JSON property maxDurationNoProgress

Returns:

  • (String) 


32808
32809
32810
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 32808

def max_duration_no_progress
  @max_duration_no_progress
end

#max_num_trials ⇒ Fixnum

If there are more than this many trials, stop the study. Corresponds to the JSON property maxNumTrials

Returns:

  • (Fixnum) 


32813
32814
32815
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 32813

def max_num_trials
  @max_num_trials
end

#max_num_trials_no_progress ⇒ Fixnum

If the objective value has not improved for this many consecutive trials, stop the study. WARNING: Effective only for single-objective studies. Corresponds to the JSON property maxNumTrialsNoProgress

Returns:

  • (Fixnum) 


32819
32820
32821
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 32819

def max_num_trials_no_progress
  @max_num_trials_no_progress
end

#maximum_runtime_constraint ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1StudyTimeConstraint

Time-based Constraint for Study Corresponds to the JSON property maximumRuntimeConstraint

Returns:



32824
32825
32826
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 32824

def maximum_runtime_constraint
  @maximum_runtime_constraint
end

#min_num_trials ⇒ Fixnum

If there are fewer than this many COMPLETED trials, do not stop the study. Corresponds to the JSON property minNumTrials

Returns:

  • (Fixnum) 


32829
32830
32831
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 32829

def min_num_trials
  @min_num_trials
end

#minimum_runtime_constraint ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1StudyTimeConstraint

Time-based Constraint for Study Corresponds to the JSON property minimumRuntimeConstraint

Returns:



32834
32835
32836
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 32834

def minimum_runtime_constraint
  @minimum_runtime_constraint
end

#should_stop_asap ⇒ Boolean Also known as: should_stop_asap?

If true, a Study enters STOPPING_ASAP whenever it would normally enters STOPPING state. The bottom line is: set to true if you want to interrupt on- going evaluations of Trials as soon as the study stopping condition is met. ( Please see Study.State documentation for the source of truth). Corresponds to the JSON property shouldStopAsap

Returns:

  • (Boolean) 


32842
32843
32844
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 32842

def should_stop_asap
  @should_stop_asap
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



32850
32851
32852
32853
32854
32855
32856
32857
32858
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 32850

def update!(**args)
  @max_duration_no_progress = args[:max_duration_no_progress] if args.key?(:max_duration_no_progress)
  @max_num_trials = args[:max_num_trials] if args.key?(:max_num_trials)
  @max_num_trials_no_progress = args[:max_num_trials_no_progress] if args.key?(:max_num_trials_no_progress)
  @maximum_runtime_constraint = args[:maximum_runtime_constraint] if args.key?(:maximum_runtime_constraint)
  @min_num_trials = args[:min_num_trials] if args.key?(:min_num_trials)
  @minimum_runtime_constraint = args[:minimum_runtime_constraint] if args.key?(:minimum_runtime_constraint)
  @should_stop_asap = args[:should_stop_asap] if args.key?(:should_stop_asap)
end