public static final class StudySpec.StudyStoppingConfig extends com.google.protobuf.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| Modifier and Type | Class and Description |
|---|---|
static class |
StudySpec.StudyStoppingConfig.Builder
The configuration (stopping conditions) for automated stopping of a Study.
|
com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter| Modifier and Type | Field and Description |
|---|---|
static int |
MAX_DURATION_NO_PROGRESS_FIELD_NUMBER |
static int |
MAX_NUM_TRIALS_FIELD_NUMBER |
static int |
MAX_NUM_TRIALS_NO_PROGRESS_FIELD_NUMBER |
static int |
MAXIMUM_RUNTIME_CONSTRAINT_FIELD_NUMBER |
static int |
MIN_NUM_TRIALS_FIELD_NUMBER |
static int |
MINIMUM_RUNTIME_CONSTRAINT_FIELD_NUMBER |
static int |
SHOULD_STOP_ASAP_FIELD_NUMBER |
| Modifier and Type | Method and Description |
|---|---|
boolean |
equals(Object obj) |
static StudySpec.StudyStoppingConfig |
getDefaultInstance() |
StudySpec.StudyStoppingConfig |
getDefaultInstanceForType() |
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
com.google.protobuf.Duration |
getMaxDurationNoProgress()
If the objective value has not improved for this much time, stop the
study.
|
com.google.protobuf.DurationOrBuilder |
getMaxDurationNoProgressOrBuilder()
If the objective value has not improved for this much time, stop the
study.
|
StudyTimeConstraint |
getMaximumRuntimeConstraint()
If the specified time or duration has passed, stop the study.
|
StudyTimeConstraintOrBuilder |
getMaximumRuntimeConstraintOrBuilder()
If the specified time or duration has passed, stop the study.
|
com.google.protobuf.Int32Value |
getMaxNumTrials()
If there are more than this many trials, stop the study.
|
com.google.protobuf.Int32Value |
getMaxNumTrialsNoProgress()
If the objective value has not improved for this many consecutive
trials, stop the study.
|
com.google.protobuf.Int32ValueOrBuilder |
getMaxNumTrialsNoProgressOrBuilder()
If the objective value has not improved for this many consecutive
trials, stop the study.
|
com.google.protobuf.Int32ValueOrBuilder |
getMaxNumTrialsOrBuilder()
If there are more than this many trials, stop the study.
|
StudyTimeConstraint |
getMinimumRuntimeConstraint()
Each "stopping rule" in this proto specifies an "if" condition.
|
StudyTimeConstraintOrBuilder |
getMinimumRuntimeConstraintOrBuilder()
Each "stopping rule" in this proto specifies an "if" condition.
|
com.google.protobuf.Int32Value |
getMinNumTrials()
If there are fewer than this many COMPLETED trials, do not stop the
study.
|
com.google.protobuf.Int32ValueOrBuilder |
getMinNumTrialsOrBuilder()
If there are fewer than this many COMPLETED trials, do not stop the
study.
|
com.google.protobuf.Parser<StudySpec.StudyStoppingConfig> |
getParserForType() |
int |
getSerializedSize() |
com.google.protobuf.BoolValue |
getShouldStopAsap()
If true, a Study enters STOPPING_ASAP whenever it would normally enters
STOPPING state.
|
com.google.protobuf.BoolValueOrBuilder |
getShouldStopAsapOrBuilder()
If true, a Study enters STOPPING_ASAP whenever it would normally enters
STOPPING state.
|
int |
hashCode() |
boolean |
hasMaxDurationNoProgress()
If the objective value has not improved for this much time, stop the
study.
|
boolean |
hasMaximumRuntimeConstraint()
If the specified time or duration has passed, stop the study.
|
boolean |
hasMaxNumTrials()
If there are more than this many trials, stop the study.
|
boolean |
hasMaxNumTrialsNoProgress()
If the objective value has not improved for this many consecutive
trials, stop the study.
|
boolean |
hasMinimumRuntimeConstraint()
Each "stopping rule" in this proto specifies an "if" condition.
|
boolean |
hasMinNumTrials()
If there are fewer than this many COMPLETED trials, do not stop the
study.
|
boolean |
hasShouldStopAsap()
If true, a Study enters STOPPING_ASAP whenever it would normally enters
STOPPING state.
|
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
boolean |
isInitialized() |
static StudySpec.StudyStoppingConfig.Builder |
newBuilder() |
static StudySpec.StudyStoppingConfig.Builder |
newBuilder(StudySpec.StudyStoppingConfig prototype) |
StudySpec.StudyStoppingConfig.Builder |
newBuilderForType() |
protected StudySpec.StudyStoppingConfig.Builder |
newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) |
protected Object |
newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused) |
static StudySpec.StudyStoppingConfig |
parseDelimitedFrom(InputStream input) |
static StudySpec.StudyStoppingConfig |
parseDelimitedFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static StudySpec.StudyStoppingConfig |
parseFrom(byte[] data) |
static StudySpec.StudyStoppingConfig |
parseFrom(byte[] data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static StudySpec.StudyStoppingConfig |
parseFrom(ByteBuffer data) |
static StudySpec.StudyStoppingConfig |
parseFrom(ByteBuffer data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static StudySpec.StudyStoppingConfig |
parseFrom(com.google.protobuf.ByteString data) |
static StudySpec.StudyStoppingConfig |
parseFrom(com.google.protobuf.ByteString data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static StudySpec.StudyStoppingConfig |
parseFrom(com.google.protobuf.CodedInputStream input) |
static StudySpec.StudyStoppingConfig |
parseFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static StudySpec.StudyStoppingConfig |
parseFrom(InputStream input) |
static StudySpec.StudyStoppingConfig |
parseFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static com.google.protobuf.Parser<StudySpec.StudyStoppingConfig> |
parser() |
StudySpec.StudyStoppingConfig.Builder |
toBuilder() |
void |
writeTo(com.google.protobuf.CodedOutputStream output) |
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTagfindInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toStringaddAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeToclone, finalize, getClass, notify, notifyAll, wait, wait, waitpublic static final int SHOULD_STOP_ASAP_FIELD_NUMBER
public static final int MINIMUM_RUNTIME_CONSTRAINT_FIELD_NUMBER
public static final int MAXIMUM_RUNTIME_CONSTRAINT_FIELD_NUMBER
public static final int MIN_NUM_TRIALS_FIELD_NUMBER
public static final int MAX_NUM_TRIALS_FIELD_NUMBER
public static final int MAX_NUM_TRIALS_NO_PROGRESS_FIELD_NUMBER
public static final int MAX_DURATION_NO_PROGRESS_FIELD_NUMBER
protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
newInstance in class com.google.protobuf.GeneratedMessageV3public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3public 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;hasShouldStopAsap in interface StudySpec.StudyStoppingConfigOrBuilderpublic com.google.protobuf.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;getShouldStopAsap in interface StudySpec.StudyStoppingConfigOrBuilderpublic com.google.protobuf.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;getShouldStopAsapOrBuilder in interface StudySpec.StudyStoppingConfigOrBuilderpublic 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;hasMinimumRuntimeConstraint in interface StudySpec.StudyStoppingConfigOrBuilderpublic 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;getMinimumRuntimeConstraint in interface StudySpec.StudyStoppingConfigOrBuilderpublic 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;getMinimumRuntimeConstraintOrBuilder in interface StudySpec.StudyStoppingConfigOrBuilderpublic boolean hasMaximumRuntimeConstraint()
If the specified time or duration has passed, stop the study.
.google.cloud.aiplatform.v1.StudyTimeConstraint maximum_runtime_constraint = 3;hasMaximumRuntimeConstraint in interface StudySpec.StudyStoppingConfigOrBuilderpublic StudyTimeConstraint getMaximumRuntimeConstraint()
If the specified time or duration has passed, stop the study.
.google.cloud.aiplatform.v1.StudyTimeConstraint maximum_runtime_constraint = 3;getMaximumRuntimeConstraint in interface StudySpec.StudyStoppingConfigOrBuilderpublic StudyTimeConstraintOrBuilder getMaximumRuntimeConstraintOrBuilder()
If the specified time or duration has passed, stop the study.
.google.cloud.aiplatform.v1.StudyTimeConstraint maximum_runtime_constraint = 3;getMaximumRuntimeConstraintOrBuilder in interface StudySpec.StudyStoppingConfigOrBuilderpublic boolean hasMinNumTrials()
If there are fewer than this many COMPLETED trials, do not stop the study.
.google.protobuf.Int32Value min_num_trials = 4;hasMinNumTrials in interface StudySpec.StudyStoppingConfigOrBuilderpublic com.google.protobuf.Int32Value getMinNumTrials()
If there are fewer than this many COMPLETED trials, do not stop the study.
.google.protobuf.Int32Value min_num_trials = 4;getMinNumTrials in interface StudySpec.StudyStoppingConfigOrBuilderpublic com.google.protobuf.Int32ValueOrBuilder getMinNumTrialsOrBuilder()
If there are fewer than this many COMPLETED trials, do not stop the study.
.google.protobuf.Int32Value min_num_trials = 4;getMinNumTrialsOrBuilder in interface StudySpec.StudyStoppingConfigOrBuilderpublic boolean hasMaxNumTrials()
If there are more than this many trials, stop the study.
.google.protobuf.Int32Value max_num_trials = 5;hasMaxNumTrials in interface StudySpec.StudyStoppingConfigOrBuilderpublic com.google.protobuf.Int32Value getMaxNumTrials()
If there are more than this many trials, stop the study.
.google.protobuf.Int32Value max_num_trials = 5;getMaxNumTrials in interface StudySpec.StudyStoppingConfigOrBuilderpublic com.google.protobuf.Int32ValueOrBuilder getMaxNumTrialsOrBuilder()
If there are more than this many trials, stop the study.
.google.protobuf.Int32Value max_num_trials = 5;getMaxNumTrialsOrBuilder in interface StudySpec.StudyStoppingConfigOrBuilderpublic 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;hasMaxNumTrialsNoProgress in interface StudySpec.StudyStoppingConfigOrBuilderpublic com.google.protobuf.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;getMaxNumTrialsNoProgress in interface StudySpec.StudyStoppingConfigOrBuilderpublic com.google.protobuf.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;getMaxNumTrialsNoProgressOrBuilder in interface StudySpec.StudyStoppingConfigOrBuilderpublic 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;hasMaxDurationNoProgress in interface StudySpec.StudyStoppingConfigOrBuilderpublic com.google.protobuf.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;getMaxDurationNoProgress in interface StudySpec.StudyStoppingConfigOrBuilderpublic com.google.protobuf.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;getMaxDurationNoProgressOrBuilder in interface StudySpec.StudyStoppingConfigOrBuilderpublic final boolean isInitialized()
isInitialized in interface com.google.protobuf.MessageLiteOrBuilderisInitialized in class com.google.protobuf.GeneratedMessageV3public void writeTo(com.google.protobuf.CodedOutputStream output)
throws IOException
writeTo in interface com.google.protobuf.MessageLitewriteTo in class com.google.protobuf.GeneratedMessageV3IOExceptionpublic int getSerializedSize()
getSerializedSize in interface com.google.protobuf.MessageLitegetSerializedSize in class com.google.protobuf.GeneratedMessageV3public boolean equals(Object obj)
equals in interface com.google.protobuf.Messageequals in class com.google.protobuf.AbstractMessagepublic int hashCode()
hashCode in interface com.google.protobuf.MessagehashCode in class com.google.protobuf.AbstractMessagepublic static StudySpec.StudyStoppingConfig parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static StudySpec.StudyStoppingConfig parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static StudySpec.StudyStoppingConfig parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static StudySpec.StudyStoppingConfig parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static StudySpec.StudyStoppingConfig parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static StudySpec.StudyStoppingConfig parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static StudySpec.StudyStoppingConfig parseFrom(InputStream input) throws IOException
IOExceptionpublic static StudySpec.StudyStoppingConfig parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static StudySpec.StudyStoppingConfig parseDelimitedFrom(InputStream input) throws IOException
IOExceptionpublic static StudySpec.StudyStoppingConfig parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static StudySpec.StudyStoppingConfig parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
IOExceptionpublic static StudySpec.StudyStoppingConfig parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic StudySpec.StudyStoppingConfig.Builder newBuilderForType()
newBuilderForType in interface com.google.protobuf.MessagenewBuilderForType in interface com.google.protobuf.MessageLitepublic static StudySpec.StudyStoppingConfig.Builder newBuilder()
public static StudySpec.StudyStoppingConfig.Builder newBuilder(StudySpec.StudyStoppingConfig prototype)
public StudySpec.StudyStoppingConfig.Builder toBuilder()
toBuilder in interface com.google.protobuf.MessagetoBuilder in interface com.google.protobuf.MessageLiteprotected StudySpec.StudyStoppingConfig.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
newBuilderForType in class com.google.protobuf.GeneratedMessageV3public static StudySpec.StudyStoppingConfig getDefaultInstance()
public static com.google.protobuf.Parser<StudySpec.StudyStoppingConfig> parser()
public com.google.protobuf.Parser<StudySpec.StudyStoppingConfig> getParserForType()
getParserForType in interface com.google.protobuf.MessagegetParserForType in interface com.google.protobuf.MessageLitegetParserForType in class com.google.protobuf.GeneratedMessageV3public StudySpec.StudyStoppingConfig getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilderCopyright © 2025 Google LLC. All rights reserved.