Class StudySpec.StudyStoppingConfig.Builder (3.35.0)

public static final class StudySpec.StudyStoppingConfig.Builder extends GeneratedMessageV3.Builder<StudySpec.StudyStoppingConfig.Builder> 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 Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public StudySpec.StudyStoppingConfig.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
StudySpec.StudyStoppingConfig.Builder
Overrides

build()

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

buildPartial()

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

clear()

public StudySpec.StudyStoppingConfig.Builder clear()
Returns
TypeDescription
StudySpec.StudyStoppingConfig.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public StudySpec.StudyStoppingConfig.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
StudySpec.StudyStoppingConfig.Builder
Overrides

clearMaxDurationNoProgress()

public StudySpec.StudyStoppingConfig.Builder clearMaxDurationNoProgress()

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
StudySpec.StudyStoppingConfig.Builder

clearMaxNumTrials()

public StudySpec.StudyStoppingConfig.Builder clearMaxNumTrials()

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

.google.protobuf.Int32Value max_num_trials = 5;

Returns
TypeDescription
StudySpec.StudyStoppingConfig.Builder

clearMaxNumTrialsNoProgress()

public StudySpec.StudyStoppingConfig.Builder clearMaxNumTrialsNoProgress()

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
StudySpec.StudyStoppingConfig.Builder

clearMaximumRuntimeConstraint()

public StudySpec.StudyStoppingConfig.Builder clearMaximumRuntimeConstraint()

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

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

Returns
TypeDescription
StudySpec.StudyStoppingConfig.Builder

clearMinNumTrials()

public StudySpec.StudyStoppingConfig.Builder clearMinNumTrials()

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

.google.protobuf.Int32Value min_num_trials = 4;

Returns
TypeDescription
StudySpec.StudyStoppingConfig.Builder

clearMinimumRuntimeConstraint()

public StudySpec.StudyStoppingConfig.Builder clearMinimumRuntimeConstraint()

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
StudySpec.StudyStoppingConfig.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

public StudySpec.StudyStoppingConfig.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
StudySpec.StudyStoppingConfig.Builder
Overrides

clearShouldStopAsap()

public StudySpec.StudyStoppingConfig.Builder clearShouldStopAsap()

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
StudySpec.StudyStoppingConfig.Builder

clone()

public StudySpec.StudyStoppingConfig.Builder clone()
Returns
TypeDescription
StudySpec.StudyStoppingConfig.Builder
Overrides

getDefaultInstanceForType()

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

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

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.

getMaxDurationNoProgressBuilder()

public Duration.Builder getMaxDurationNoProgressBuilder()

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
Builder

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.

getMaxNumTrialsBuilder()

public Int32Value.Builder getMaxNumTrialsBuilder()

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

.google.protobuf.Int32Value max_num_trials = 5;

Returns
TypeDescription
Builder

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.

getMaxNumTrialsNoProgressBuilder()

public Int32Value.Builder getMaxNumTrialsNoProgressBuilder()

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
Builder

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.

getMaximumRuntimeConstraintBuilder()

public StudyTimeConstraint.Builder getMaximumRuntimeConstraintBuilder()

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

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

Returns
TypeDescription
StudyTimeConstraint.Builder

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.

getMinNumTrialsBuilder()

public Int32Value.Builder getMinNumTrialsBuilder()

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

.google.protobuf.Int32Value min_num_trials = 4;

Returns
TypeDescription
Builder

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.

getMinimumRuntimeConstraintBuilder()

public StudyTimeConstraint.Builder getMinimumRuntimeConstraintBuilder()

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.Builder

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

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.

getShouldStopAsapBuilder()

public BoolValue.Builder getShouldStopAsapBuilder()

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
Builder

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.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(StudySpec.StudyStoppingConfig other)

public StudySpec.StudyStoppingConfig.Builder mergeFrom(StudySpec.StudyStoppingConfig other)
Parameter
NameDescription
otherStudySpec.StudyStoppingConfig
Returns
TypeDescription
StudySpec.StudyStoppingConfig.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public StudySpec.StudyStoppingConfig.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
StudySpec.StudyStoppingConfig.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public StudySpec.StudyStoppingConfig.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
StudySpec.StudyStoppingConfig.Builder
Overrides

mergeMaxDurationNoProgress(Duration value)

public StudySpec.StudyStoppingConfig.Builder mergeMaxDurationNoProgress(Duration value)

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;

Parameter
NameDescription
valueDuration
Returns
TypeDescription
StudySpec.StudyStoppingConfig.Builder

mergeMaxNumTrials(Int32Value value)

public StudySpec.StudyStoppingConfig.Builder mergeMaxNumTrials(Int32Value value)

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

.google.protobuf.Int32Value max_num_trials = 5;

Parameter
NameDescription
valueInt32Value
Returns
TypeDescription
StudySpec.StudyStoppingConfig.Builder

mergeMaxNumTrialsNoProgress(Int32Value value)

public StudySpec.StudyStoppingConfig.Builder mergeMaxNumTrialsNoProgress(Int32Value value)

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;

Parameter
NameDescription
valueInt32Value
Returns
TypeDescription
StudySpec.StudyStoppingConfig.Builder

mergeMaximumRuntimeConstraint(StudyTimeConstraint value)

public StudySpec.StudyStoppingConfig.Builder mergeMaximumRuntimeConstraint(StudyTimeConstraint value)

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

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

Parameter
NameDescription
valueStudyTimeConstraint
Returns
TypeDescription
StudySpec.StudyStoppingConfig.Builder

mergeMinNumTrials(Int32Value value)

public StudySpec.StudyStoppingConfig.Builder mergeMinNumTrials(Int32Value value)

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

.google.protobuf.Int32Value min_num_trials = 4;

Parameter
NameDescription
valueInt32Value
Returns
TypeDescription
StudySpec.StudyStoppingConfig.Builder

mergeMinimumRuntimeConstraint(StudyTimeConstraint value)

public StudySpec.StudyStoppingConfig.Builder mergeMinimumRuntimeConstraint(StudyTimeConstraint value)

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;

Parameter
NameDescription
valueStudyTimeConstraint
Returns
TypeDescription
StudySpec.StudyStoppingConfig.Builder

mergeShouldStopAsap(BoolValue value)

public StudySpec.StudyStoppingConfig.Builder mergeShouldStopAsap(BoolValue value)

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;

Parameter
NameDescription
valueBoolValue
Returns
TypeDescription
StudySpec.StudyStoppingConfig.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final StudySpec.StudyStoppingConfig.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
StudySpec.StudyStoppingConfig.Builder
Overrides

setField(Descriptors.FieldDescriptor field, Object value)

public StudySpec.StudyStoppingConfig.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
StudySpec.StudyStoppingConfig.Builder
Overrides

setMaxDurationNoProgress(Duration value)

public StudySpec.StudyStoppingConfig.Builder setMaxDurationNoProgress(Duration value)

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;

Parameter
NameDescription
valueDuration
Returns
TypeDescription
StudySpec.StudyStoppingConfig.Builder

setMaxDurationNoProgress(Duration.Builder builderForValue)

public StudySpec.StudyStoppingConfig.Builder setMaxDurationNoProgress(Duration.Builder builderForValue)

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;

Parameter
NameDescription
builderForValueBuilder
Returns
TypeDescription
StudySpec.StudyStoppingConfig.Builder

setMaxNumTrials(Int32Value value)

public StudySpec.StudyStoppingConfig.Builder setMaxNumTrials(Int32Value value)

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

.google.protobuf.Int32Value max_num_trials = 5;

Parameter
NameDescription
valueInt32Value
Returns
TypeDescription
StudySpec.StudyStoppingConfig.Builder

setMaxNumTrials(Int32Value.Builder builderForValue)

public StudySpec.StudyStoppingConfig.Builder setMaxNumTrials(Int32Value.Builder builderForValue)

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

.google.protobuf.Int32Value max_num_trials = 5;

Parameter
NameDescription
builderForValueBuilder
Returns
TypeDescription
StudySpec.StudyStoppingConfig.Builder

setMaxNumTrialsNoProgress(Int32Value value)

public StudySpec.StudyStoppingConfig.Builder setMaxNumTrialsNoProgress(Int32Value value)

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;

Parameter
NameDescription
valueInt32Value
Returns
TypeDescription
StudySpec.StudyStoppingConfig.Builder

setMaxNumTrialsNoProgress(Int32Value.Builder builderForValue)

public StudySpec.StudyStoppingConfig.Builder setMaxNumTrialsNoProgress(Int32Value.Builder builderForValue)

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;

Parameter
NameDescription
builderForValueBuilder
Returns
TypeDescription
StudySpec.StudyStoppingConfig.Builder

setMaximumRuntimeConstraint(StudyTimeConstraint value)

public StudySpec.StudyStoppingConfig.Builder setMaximumRuntimeConstraint(StudyTimeConstraint value)

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

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

Parameter
NameDescription
valueStudyTimeConstraint
Returns
TypeDescription
StudySpec.StudyStoppingConfig.Builder

setMaximumRuntimeConstraint(StudyTimeConstraint.Builder builderForValue)

public StudySpec.StudyStoppingConfig.Builder setMaximumRuntimeConstraint(StudyTimeConstraint.Builder builderForValue)

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

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

Parameter
NameDescription
builderForValueStudyTimeConstraint.Builder
Returns
TypeDescription
StudySpec.StudyStoppingConfig.Builder

setMinNumTrials(Int32Value value)

public StudySpec.StudyStoppingConfig.Builder setMinNumTrials(Int32Value value)

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

.google.protobuf.Int32Value min_num_trials = 4;

Parameter
NameDescription
valueInt32Value
Returns
TypeDescription
StudySpec.StudyStoppingConfig.Builder

setMinNumTrials(Int32Value.Builder builderForValue)

public StudySpec.StudyStoppingConfig.Builder setMinNumTrials(Int32Value.Builder builderForValue)

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

.google.protobuf.Int32Value min_num_trials = 4;

Parameter
NameDescription
builderForValueBuilder
Returns
TypeDescription
StudySpec.StudyStoppingConfig.Builder

setMinimumRuntimeConstraint(StudyTimeConstraint value)

public StudySpec.StudyStoppingConfig.Builder setMinimumRuntimeConstraint(StudyTimeConstraint value)

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;

Parameter
NameDescription
valueStudyTimeConstraint
Returns
TypeDescription
StudySpec.StudyStoppingConfig.Builder

setMinimumRuntimeConstraint(StudyTimeConstraint.Builder builderForValue)

public StudySpec.StudyStoppingConfig.Builder setMinimumRuntimeConstraint(StudyTimeConstraint.Builder builderForValue)

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;

Parameter
NameDescription
builderForValueStudyTimeConstraint.Builder
Returns
TypeDescription
StudySpec.StudyStoppingConfig.Builder

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public StudySpec.StudyStoppingConfig.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
StudySpec.StudyStoppingConfig.Builder
Overrides

setShouldStopAsap(BoolValue value)

public StudySpec.StudyStoppingConfig.Builder setShouldStopAsap(BoolValue value)

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;

Parameter
NameDescription
valueBoolValue
Returns
TypeDescription
StudySpec.StudyStoppingConfig.Builder

setShouldStopAsap(BoolValue.Builder builderForValue)

public StudySpec.StudyStoppingConfig.Builder setShouldStopAsap(BoolValue.Builder builderForValue)

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;

Parameter
NameDescription
builderForValueBuilder
Returns
TypeDescription
StudySpec.StudyStoppingConfig.Builder

setUnknownFields(UnknownFieldSet unknownFields)

public final StudySpec.StudyStoppingConfig.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
StudySpec.StudyStoppingConfig.Builder
Overrides