public static final class StudySpec.StudyStoppingConfig extends GeneratedMessageV3 implements StudySpec.StudyStoppingConfigOrBuilder
The configuration (stopping conditions) for automated stopping of a Study.
Conditions include trial budgets, time budgets, and convergence detection.
Protobuf type google.cloud.aiplatform.v1.StudySpec.StudyStoppingConfig
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
public static final int MAXIMUM_RUNTIME_CONSTRAINT_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int MAX_DURATION_NO_PROGRESS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int MAX_NUM_TRIALS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int MAX_NUM_TRIALS_NO_PROGRESS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int MINIMUM_RUNTIME_CONSTRAINT_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int MIN_NUM_TRIALS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int SHOULD_STOP_ASAP_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
public static StudySpec.StudyStoppingConfig getDefaultInstance()
public static final Descriptors.Descriptor getDescriptor()
public static StudySpec.StudyStoppingConfig.Builder newBuilder()
public static StudySpec.StudyStoppingConfig.Builder newBuilder(StudySpec.StudyStoppingConfig prototype)
public static StudySpec.StudyStoppingConfig parseDelimitedFrom(InputStream input)
public static StudySpec.StudyStoppingConfig parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static StudySpec.StudyStoppingConfig parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
public static StudySpec.StudyStoppingConfig parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static StudySpec.StudyStoppingConfig parseFrom(ByteString data)
public static StudySpec.StudyStoppingConfig parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static StudySpec.StudyStoppingConfig parseFrom(CodedInputStream input)
public static StudySpec.StudyStoppingConfig parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static StudySpec.StudyStoppingConfig parseFrom(InputStream input)
public static StudySpec.StudyStoppingConfig parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static StudySpec.StudyStoppingConfig parseFrom(ByteBuffer data)
public static StudySpec.StudyStoppingConfig parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Parser<StudySpec.StudyStoppingConfig> parser()
Methods
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
public StudySpec.StudyStoppingConfig getDefaultInstanceForType()
public Duration getMaxDurationNoProgress()
If the objective value has not improved for this much time, stop the
study.
WARNING: Effective only for single-objective studies.
.google.protobuf.Duration max_duration_no_progress = 7;
| Returns |
| Type |
Description |
Duration |
The maxDurationNoProgress.
|
public DurationOrBuilder getMaxDurationNoProgressOrBuilder()
If the objective value has not improved for this much time, stop the
study.
WARNING: Effective only for single-objective studies.
.google.protobuf.Duration max_duration_no_progress = 7;
public Int32Value getMaxNumTrials()
If there are more than this many trials, stop the study.
.google.protobuf.Int32Value max_num_trials = 5;
| Returns |
| Type |
Description |
Int32Value |
The maxNumTrials.
|
public Int32Value getMaxNumTrialsNoProgress()
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 max_num_trials_no_progress = 6;
| Returns |
| Type |
Description |
Int32Value |
The maxNumTrialsNoProgress.
|
public Int32ValueOrBuilder getMaxNumTrialsNoProgressOrBuilder()
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 max_num_trials_no_progress = 6;
public Int32ValueOrBuilder getMaxNumTrialsOrBuilder()
If there are more than this many trials, stop the study.
.google.protobuf.Int32Value max_num_trials = 5;
public StudyTimeConstraint getMaximumRuntimeConstraint()
If the specified time or duration has passed, stop the study.
.google.cloud.aiplatform.v1.StudyTimeConstraint maximum_runtime_constraint = 3;
public StudyTimeConstraintOrBuilder getMaximumRuntimeConstraintOrBuilder()
If the specified time or duration has passed, stop the study.
.google.cloud.aiplatform.v1.StudyTimeConstraint maximum_runtime_constraint = 3;
public Int32Value getMinNumTrials()
If there are fewer than this many COMPLETED trials, do not stop the
study.
.google.protobuf.Int32Value min_num_trials = 4;
| Returns |
| Type |
Description |
Int32Value |
The minNumTrials.
|
public Int32ValueOrBuilder getMinNumTrialsOrBuilder()
If there are fewer than this many COMPLETED trials, do not stop the
study.
.google.protobuf.Int32Value min_num_trials = 4;
public StudyTimeConstraint getMinimumRuntimeConstraint()
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.
.google.cloud.aiplatform.v1.StudyTimeConstraint minimum_runtime_constraint = 2;
public StudyTimeConstraintOrBuilder getMinimumRuntimeConstraintOrBuilder()
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.
.google.cloud.aiplatform.v1.StudyTimeConstraint minimum_runtime_constraint = 2;
public Parser<StudySpec.StudyStoppingConfig> getParserForType()
Overrides
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
public BoolValue getShouldStopAsap()
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 should_stop_asap = 1;
| Returns |
| Type |
Description |
BoolValue |
The shouldStopAsap.
|
public BoolValueOrBuilder getShouldStopAsapOrBuilder()
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 should_stop_asap = 1;
public boolean hasMaxDurationNoProgress()
If the objective value has not improved for this much time, stop the
study.
WARNING: Effective only for single-objective studies.
.google.protobuf.Duration max_duration_no_progress = 7;
| Returns |
| Type |
Description |
boolean |
Whether the maxDurationNoProgress field is set.
|
public boolean hasMaxNumTrials()
If there are more than this many trials, stop the study.
.google.protobuf.Int32Value max_num_trials = 5;
| Returns |
| Type |
Description |
boolean |
Whether the maxNumTrials field is set.
|
public boolean hasMaxNumTrialsNoProgress()
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 max_num_trials_no_progress = 6;
| Returns |
| Type |
Description |
boolean |
Whether the maxNumTrialsNoProgress field is set.
|
public boolean hasMaximumRuntimeConstraint()
If the specified time or duration has passed, stop the study.
.google.cloud.aiplatform.v1.StudyTimeConstraint maximum_runtime_constraint = 3;
| Returns |
| Type |
Description |
boolean |
Whether the maximumRuntimeConstraint field is set.
|
public boolean hasMinNumTrials()
If there are fewer than this many COMPLETED trials, do not stop the
study.
.google.protobuf.Int32Value min_num_trials = 4;
| Returns |
| Type |
Description |
boolean |
Whether the minNumTrials field is set.
|
public boolean hasMinimumRuntimeConstraint()
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.
.google.cloud.aiplatform.v1.StudyTimeConstraint minimum_runtime_constraint = 2;
| Returns |
| Type |
Description |
boolean |
Whether the minimumRuntimeConstraint field is set.
|
public boolean hasShouldStopAsap()
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 should_stop_asap = 1;
| Returns |
| Type |
Description |
boolean |
Whether the shouldStopAsap field is set.
|
| Returns |
| Type |
Description |
int |
|
Overrides
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
public final boolean isInitialized()
Overrides
public StudySpec.StudyStoppingConfig.Builder newBuilderForType()
protected StudySpec.StudyStoppingConfig.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
public StudySpec.StudyStoppingConfig.Builder toBuilder()
public void writeTo(CodedOutputStream output)
Overrides
