Class StudySpec.StudyStoppingConfig (3.32.0)

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

Static Fields

MAXIMUM_RUNTIME_CONSTRAINT_FIELD_NUMBER

public static final int MAXIMUM_RUNTIME_CONSTRAINT_FIELD_NUMBER
Field Value
TypeDescription
int

MAX_DURATION_NO_PROGRESS_FIELD_NUMBER

public static final int MAX_DURATION_NO_PROGRESS_FIELD_NUMBER
Field Value
TypeDescription
int

MAX_NUM_TRIALS_FIELD_NUMBER

public static final int MAX_NUM_TRIALS_FIELD_NUMBER
Field Value
TypeDescription
int

MAX_NUM_TRIALS_NO_PROGRESS_FIELD_NUMBER

public static final int MAX_NUM_TRIALS_NO_PROGRESS_FIELD_NUMBER
Field Value
TypeDescription
int

MINIMUM_RUNTIME_CONSTRAINT_FIELD_NUMBER

public static final int MINIMUM_RUNTIME_CONSTRAINT_FIELD_NUMBER
Field Value
TypeDescription
int

MIN_NUM_TRIALS_FIELD_NUMBER

public static final int MIN_NUM_TRIALS_FIELD_NUMBER
Field Value
TypeDescription
int

SHOULD_STOP_ASAP_FIELD_NUMBER

public static final int SHOULD_STOP_ASAP_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static StudySpec.StudyStoppingConfig getDefaultInstance()
Returns
TypeDescription
StudySpec.StudyStoppingConfig

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static StudySpec.StudyStoppingConfig.Builder newBuilder()
Returns
TypeDescription
StudySpec.StudyStoppingConfig.Builder

newBuilder(StudySpec.StudyStoppingConfig prototype)

public static StudySpec.StudyStoppingConfig.Builder newBuilder(StudySpec.StudyStoppingConfig prototype)
Parameter
NameDescription
prototypeStudySpec.StudyStoppingConfig
Returns
TypeDescription
StudySpec.StudyStoppingConfig.Builder

parseDelimitedFrom(InputStream input)

public static StudySpec.StudyStoppingConfig parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
StudySpec.StudyStoppingConfig
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static StudySpec.StudyStoppingConfig parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
StudySpec.StudyStoppingConfig
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static StudySpec.StudyStoppingConfig parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
StudySpec.StudyStoppingConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static StudySpec.StudyStoppingConfig parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
StudySpec.StudyStoppingConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static StudySpec.StudyStoppingConfig parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
StudySpec.StudyStoppingConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static StudySpec.StudyStoppingConfig parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
StudySpec.StudyStoppingConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static StudySpec.StudyStoppingConfig parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
StudySpec.StudyStoppingConfig
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static StudySpec.StudyStoppingConfig parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
StudySpec.StudyStoppingConfig
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static StudySpec.StudyStoppingConfig parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
StudySpec.StudyStoppingConfig
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static StudySpec.StudyStoppingConfig parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
StudySpec.StudyStoppingConfig
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static StudySpec.StudyStoppingConfig parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
StudySpec.StudyStoppingConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static StudySpec.StudyStoppingConfig parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
StudySpec.StudyStoppingConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<StudySpec.StudyStoppingConfig> parser()
Returns
TypeDescription
Parser<StudyStoppingConfig>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public StudySpec.StudyStoppingConfig getDefaultInstanceForType()
Returns
TypeDescription
StudySpec.StudyStoppingConfig

getMaxDurationNoProgress()

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
TypeDescription
Duration

The maxDurationNoProgress.

getMaxDurationNoProgressOrBuilder()

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;

Returns
TypeDescription
DurationOrBuilder

getMaxNumTrials()

public Int32Value getMaxNumTrials()

If there are more than this many trials, stop the study.

.google.protobuf.Int32Value max_num_trials = 5;

Returns
TypeDescription
Int32Value

The maxNumTrials.

getMaxNumTrialsNoProgress()

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
TypeDescription
Int32Value

The maxNumTrialsNoProgress.

getMaxNumTrialsNoProgressOrBuilder()

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;

Returns
TypeDescription
Int32ValueOrBuilder

getMaxNumTrialsOrBuilder()

public Int32ValueOrBuilder getMaxNumTrialsOrBuilder()

If there are more than this many trials, stop the study.

.google.protobuf.Int32Value max_num_trials = 5;

Returns
TypeDescription
Int32ValueOrBuilder

getMaximumRuntimeConstraint()

public StudyTimeConstraint getMaximumRuntimeConstraint()

If the specified time or duration has passed, stop the study.

.google.cloud.aiplatform.v1.StudyTimeConstraint maximum_runtime_constraint = 3;

Returns
TypeDescription
StudyTimeConstraint

The maximumRuntimeConstraint.

getMaximumRuntimeConstraintOrBuilder()

public StudyTimeConstraintOrBuilder getMaximumRuntimeConstraintOrBuilder()

If the specified time or duration has passed, stop the study.

.google.cloud.aiplatform.v1.StudyTimeConstraint maximum_runtime_constraint = 3;

Returns
TypeDescription
StudyTimeConstraintOrBuilder

getMinNumTrials()

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
TypeDescription
Int32Value

The minNumTrials.

getMinNumTrialsOrBuilder()

public Int32ValueOrBuilder getMinNumTrialsOrBuilder()

If there are fewer than this many COMPLETED trials, do not stop the study.

.google.protobuf.Int32Value min_num_trials = 4;

Returns
TypeDescription
Int32ValueOrBuilder

getMinimumRuntimeConstraint()

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;

Returns
TypeDescription
StudyTimeConstraint

The minimumRuntimeConstraint.

getMinimumRuntimeConstraintOrBuilder()

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;

Returns
TypeDescription
StudyTimeConstraintOrBuilder

getParserForType()

public Parser<StudySpec.StudyStoppingConfig> getParserForType()
Returns
TypeDescription
Parser<StudyStoppingConfig>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getShouldStopAsap()

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
TypeDescription
BoolValue

The shouldStopAsap.

getShouldStopAsapOrBuilder()

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;

Returns
TypeDescription
BoolValueOrBuilder

hasMaxDurationNoProgress()

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
TypeDescription
boolean

Whether the maxDurationNoProgress field is set.

hasMaxNumTrials()

public boolean hasMaxNumTrials()

If there are more than this many trials, stop the study.

.google.protobuf.Int32Value max_num_trials = 5;

Returns
TypeDescription
boolean

Whether the maxNumTrials field is set.

hasMaxNumTrialsNoProgress()

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
TypeDescription
boolean

Whether the maxNumTrialsNoProgress field is set.

hasMaximumRuntimeConstraint()

public boolean hasMaximumRuntimeConstraint()

If the specified time or duration has passed, stop the study.

.google.cloud.aiplatform.v1.StudyTimeConstraint maximum_runtime_constraint = 3;

Returns
TypeDescription
boolean

Whether the maximumRuntimeConstraint field is set.

hasMinNumTrials()

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
TypeDescription
boolean

Whether the minNumTrials field is set.

hasMinimumRuntimeConstraint()

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
TypeDescription
boolean

Whether the minimumRuntimeConstraint field is set.

hasShouldStopAsap()

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
TypeDescription
boolean

Whether the shouldStopAsap field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public StudySpec.StudyStoppingConfig.Builder newBuilderForType()
Returns
TypeDescription
StudySpec.StudyStoppingConfig.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected StudySpec.StudyStoppingConfig.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
StudySpec.StudyStoppingConfig.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public StudySpec.StudyStoppingConfig.Builder toBuilder()
Returns
TypeDescription
StudySpec.StudyStoppingConfig.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException