- 0.55.0 (latest)
- 0.54.0
- 0.53.0
- 0.52.0
- 0.51.0
- 0.50.0
- 0.49.0
- 0.48.0
- 0.47.0
- 0.46.0
- 0.45.0
- 0.44.0
- 0.43.0
- 0.42.0
- 0.41.0
- 0.40.0
- 0.39.0
- 0.38.0
- 0.37.0
- 0.36.0
- 0.35.0
- 0.34.0
- 0.33.0
- 0.32.0
- 0.31.0
- 0.30.0
- 0.29.0
- 0.28.0
- 0.27.0
- 0.26.0
- 0.25.0
- 0.24.0
- 0.23.0
- 0.22.0
- 0.21.0
- 0.20.0
- 0.19.0
- 0.18.0
- 0.17.0
- 0.16.0
- 0.15.0
- 0.14.0
- 0.13.0
- 0.12.0
- 0.11.0
- 0.10.0
- 0.9.1
- 0.8.0
- 0.7.0
- 0.6.0
- 0.5.0
- 0.4.0
- 0.3.0
- 0.2.0
- 0.1.0
Reference documentation and code samples for the Vertex AI V1 API class Google::Cloud::AIPlatform::V1::StudySpec::StudyStoppingConfig.
The configuration (stopping conditions) for automated stopping of a Study. Conditions include trial budgets, time budgets, and convergence detection.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#max_duration_no_progress
def max_duration_no_progress() -> ::Google::Protobuf::Duration
-
(::Google::Protobuf::Duration) — If the objective value has not improved for this much time, stop the
study.
WARNING: Effective only for single-objective studies.
#max_duration_no_progress=
def max_duration_no_progress=(value) -> ::Google::Protobuf::Duration
-
value (::Google::Protobuf::Duration) — If the objective value has not improved for this much time, stop the
study.
WARNING: Effective only for single-objective studies.
-
(::Google::Protobuf::Duration) — If the objective value has not improved for this much time, stop the
study.
WARNING: Effective only for single-objective studies.
#max_num_trials
def max_num_trials() -> ::Google::Protobuf::Int32Value
- (::Google::Protobuf::Int32Value) — If there are more than this many trials, stop the study.
#max_num_trials=
def max_num_trials=(value) -> ::Google::Protobuf::Int32Value
- value (::Google::Protobuf::Int32Value) — If there are more than this many trials, stop the study.
- (::Google::Protobuf::Int32Value) — If there are more than this many trials, stop the study.
#max_num_trials_no_progress
def max_num_trials_no_progress() -> ::Google::Protobuf::Int32Value
-
(::Google::Protobuf::Int32Value) — If the objective value has not improved for this many consecutive
trials, stop the study.
WARNING: Effective only for single-objective studies.
#max_num_trials_no_progress=
def max_num_trials_no_progress=(value) -> ::Google::Protobuf::Int32Value
-
value (::Google::Protobuf::Int32Value) — If the objective value has not improved for this many consecutive
trials, stop the study.
WARNING: Effective only for single-objective studies.
-
(::Google::Protobuf::Int32Value) — If the objective value has not improved for this many consecutive
trials, stop the study.
WARNING: Effective only for single-objective studies.
#maximum_runtime_constraint
def maximum_runtime_constraint() -> ::Google::Cloud::AIPlatform::V1::StudyTimeConstraint
- (::Google::Cloud::AIPlatform::V1::StudyTimeConstraint) — If the specified time or duration has passed, stop the study.
#maximum_runtime_constraint=
def maximum_runtime_constraint=(value) -> ::Google::Cloud::AIPlatform::V1::StudyTimeConstraint
- value (::Google::Cloud::AIPlatform::V1::StudyTimeConstraint) — If the specified time or duration has passed, stop the study.
- (::Google::Cloud::AIPlatform::V1::StudyTimeConstraint) — If the specified time or duration has passed, stop the study.
#min_num_trials
def min_num_trials() -> ::Google::Protobuf::Int32Value
- (::Google::Protobuf::Int32Value) — If there are fewer than this many COMPLETED trials, do not stop the study.
#min_num_trials=
def min_num_trials=(value) -> ::Google::Protobuf::Int32Value
- value (::Google::Protobuf::Int32Value) — If there are fewer than this many COMPLETED trials, do not stop the study.
- (::Google::Protobuf::Int32Value) — If there are fewer than this many COMPLETED trials, do not stop the study.
#minimum_runtime_constraint
def minimum_runtime_constraint() -> ::Google::Cloud::AIPlatform::V1::StudyTimeConstraint
-
(::Google::Cloud::AIPlatform::V1::StudyTimeConstraint) — Each "stopping rule" in this proto specifies an "if" condition. Before
Vizier would generate a new suggestion, it first checks each specified
stopping rule, from top to bottom in this list.
Note that the first few rules (e.g. minimum_runtime_constraint,
min_num_trials) will prevent other stopping rules from being evaluated
until they are met. For example, setting
min_num_trials=5
andalways_stop_after= 1 hour
means that the Study will ONLY stop after it has 5 COMPLETED trials, even if more than an hour has passed since its creation. It follows the first applicable rule (whose "if" condition is satisfied) to make a stopping decision. If none of the specified rules are applicable, then Vizier decides that the study should not stop. If Vizier decides that the study should stop, the study enters STOPPING state (or STOPPING_ASAP if should_stop_asap = true). IMPORTANT: The automatic study state transition happens precisely as described above; that is, deleting trials or updating StudyConfig NEVER automatically moves the study state back to ACTIVE. If you want to resume a Study that was stopped, 1) change the stopping conditions if necessary, 2) activate the study, and then 3) ask for suggestions. If the specified time or duration has not passed, do not stop the study.
#minimum_runtime_constraint=
def minimum_runtime_constraint=(value) -> ::Google::Cloud::AIPlatform::V1::StudyTimeConstraint
-
value (::Google::Cloud::AIPlatform::V1::StudyTimeConstraint) — Each "stopping rule" in this proto specifies an "if" condition. Before
Vizier would generate a new suggestion, it first checks each specified
stopping rule, from top to bottom in this list.
Note that the first few rules (e.g. minimum_runtime_constraint,
min_num_trials) will prevent other stopping rules from being evaluated
until they are met. For example, setting
min_num_trials=5
andalways_stop_after= 1 hour
means that the Study will ONLY stop after it has 5 COMPLETED trials, even if more than an hour has passed since its creation. It follows the first applicable rule (whose "if" condition is satisfied) to make a stopping decision. If none of the specified rules are applicable, then Vizier decides that the study should not stop. If Vizier decides that the study should stop, the study enters STOPPING state (or STOPPING_ASAP if should_stop_asap = true). IMPORTANT: The automatic study state transition happens precisely as described above; that is, deleting trials or updating StudyConfig NEVER automatically moves the study state back to ACTIVE. If you want to resume a Study that was stopped, 1) change the stopping conditions if necessary, 2) activate the study, and then 3) ask for suggestions. If the specified time or duration has not passed, do not stop the study.
-
(::Google::Cloud::AIPlatform::V1::StudyTimeConstraint) — Each "stopping rule" in this proto specifies an "if" condition. Before
Vizier would generate a new suggestion, it first checks each specified
stopping rule, from top to bottom in this list.
Note that the first few rules (e.g. minimum_runtime_constraint,
min_num_trials) will prevent other stopping rules from being evaluated
until they are met. For example, setting
min_num_trials=5
andalways_stop_after= 1 hour
means that the Study will ONLY stop after it has 5 COMPLETED trials, even if more than an hour has passed since its creation. It follows the first applicable rule (whose "if" condition is satisfied) to make a stopping decision. If none of the specified rules are applicable, then Vizier decides that the study should not stop. If Vizier decides that the study should stop, the study enters STOPPING state (or STOPPING_ASAP if should_stop_asap = true). IMPORTANT: The automatic study state transition happens precisely as described above; that is, deleting trials or updating StudyConfig NEVER automatically moves the study state back to ACTIVE. If you want to resume a Study that was stopped, 1) change the stopping conditions if necessary, 2) activate the study, and then 3) ask for suggestions. If the specified time or duration has not passed, do not stop the study.
#should_stop_asap
def should_stop_asap() -> ::Google::Protobuf::BoolValue
-
(::Google::Protobuf::BoolValue) — 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).
#should_stop_asap=
def should_stop_asap=(value) -> ::Google::Protobuf::BoolValue
-
value (::Google::Protobuf::BoolValue) — 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).
-
(::Google::Protobuf::BoolValue) — 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).