- 1.63.0 (latest)
- 1.62.0
- 1.60.0
- 1.59.0
- 1.58.0
- 1.57.0
- 1.56.0
- 1.55.0
- 1.54.1
- 1.53.0
- 1.52.0
- 1.51.0
- 1.50.0
- 1.49.0
- 1.48.0
- 1.47.0
- 1.46.0
- 1.45.0
- 1.44.0
- 1.43.0
- 1.39.0
- 1.38.1
- 1.37.0
- 1.36.4
- 1.35.0
- 1.34.0
- 1.33.1
- 1.32.0
- 1.31.1
- 1.30.1
- 1.29.0
- 1.28.1
- 1.27.1
- 1.26.1
- 1.25.0
- 1.24.1
- 1.23.0
- 1.22.1
- 1.21.0
- 1.20.0
- 1.19.1
- 1.18.3
- 1.17.1
- 1.16.1
- 1.15.1
- 1.14.0
- 1.13.1
- 1.12.1
- 1.11.0
- 1.10.0
- 1.9.0
- 1.8.1
- 1.7.1
- 1.6.2
- 1.5.0
- 1.4.3
- 1.3.0
- 1.2.0
- 1.1.1
- 1.0.1
- 0.9.0
- 0.8.0
- 0.7.1
- 0.6.0
- 0.5.1
- 0.4.0
- 0.3.1
StudyStoppingConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The configuration (stopping conditions) for automated stopping of a Study. Conditions include trial budgets, time budgets, and convergence detection.
Attributes |
|
---|---|
Name | Description |
should_stop_asap |
google.protobuf.wrappers_pb2.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). |
minimum_runtime_constraint |
google.cloud.aiplatform_v1beta1.types.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 and
always_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.
|
maximum_runtime_constraint |
google.cloud.aiplatform_v1beta1.types.StudyTimeConstraint
If the specified time or duration has passed, stop the study. |
min_num_trials |
google.protobuf.wrappers_pb2.Int32Value
If there are fewer than this many COMPLETED trials, do not stop the study. |
max_num_trials |
google.protobuf.wrappers_pb2.Int32Value
If there are more than this many trials, stop the study. |
max_num_trials_no_progress |
google.protobuf.wrappers_pb2.Int32Value
If the objective value has not improved for this many consecutive trials, stop the study. WARNING: Effective only for single-objective studies. |
max_duration_no_progress |
google.protobuf.duration_pb2.Duration
If the objective value has not improved for this much time, stop the study. WARNING: Effective only for single-objective studies. |
Methods
StudyStoppingConfig
StudyStoppingConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The configuration (stopping conditions) for automated stopping of a Study. Conditions include trial budgets, time budgets, and convergence detection.