StudySpec_StudyStoppingConfig class final

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

Inheritance
  • Object
  • ProtoMessage
  • StudySpec_StudyStoppingConfig

Constructors

StudySpec_StudyStoppingConfig({BoolValue? shouldStopAsap, StudyTimeConstraint? minimumRuntimeConstraint, StudyTimeConstraint? maximumRuntimeConstraint, Int32Value? minNumTrials, Int32Value? maxNumTrials, Int32Value? maxNumTrialsNoProgress, Duration? maxDurationNoProgress})
StudySpec_StudyStoppingConfig.fromJson(Object? j)
factory

Properties

hashCode → int
The hash code for this object.
no setterinherited
maxDurationNoProgress → Duration?
If the objective value has not improved for this much time, stop the study.
final
maximumRuntimeConstraint → StudyTimeConstraint?
If the specified time or duration has passed, stop the study.
final
maxNumTrials → Int32Value?
If there are more than this many trials, stop the study.
final
maxNumTrialsNoProgress → Int32Value?
If the objective value has not improved for this many consecutive trials, stop the study.
final
minimumRuntimeConstraint → 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.
final
minNumTrials → Int32Value?
If there are fewer than this many COMPLETED trials, do not stop the study.
final
qualifiedName → String
The fully qualified name of this message, i.e., google.protobuf.Duration or google.rpc.ErrorInfo.
finalinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
shouldStopAsap → BoolValue?
If true, a Study enters STOPPING_ASAP whenever it would normally enters STOPPING state.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toJson() → Object
override
toString() → String
A string representation of this object.
override

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Constants

fullyQualifiedName → const String