- 3.52.0 (latest)
- 3.50.0
- 3.49.0
- 3.48.0
- 3.47.0
- 3.46.0
- 3.45.0
- 3.44.0
- 3.43.0
- 3.42.0
- 3.41.0
- 3.40.0
- 3.38.0
- 3.37.0
- 3.36.0
- 3.35.0
- 3.34.0
- 3.33.0
- 3.32.0
- 3.31.0
- 3.30.0
- 3.29.0
- 3.28.0
- 3.25.0
- 3.24.0
- 3.23.0
- 3.22.0
- 3.21.0
- 3.20.0
- 3.19.0
- 3.18.0
- 3.17.0
- 3.16.0
- 3.15.0
- 3.14.0
- 3.13.0
- 3.12.0
- 3.11.0
- 3.10.0
- 3.9.0
- 3.8.0
- 3.7.0
- 3.6.0
- 3.5.0
- 3.4.2
- 3.3.0
- 3.2.0
- 3.0.0
- 2.9.8
- 2.8.9
- 2.7.4
- 2.5.3
- 2.4.0
public static interface StudySpec.StudyStoppingConfigOrBuilder extends MessageOrBuilderImplements
MessageOrBuilderMethods
getMaxDurationNoProgress()
public abstract 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. |
getMaxDurationNoProgressOrBuilder()
public abstract 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 | |
|---|---|
| Type | Description |
DurationOrBuilder | |
getMaxNumTrials()
public abstract 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. |
getMaxNumTrialsNoProgress()
public abstract 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. |
getMaxNumTrialsNoProgressOrBuilder()
public abstract 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 | |
|---|---|
| Type | Description |
Int32ValueOrBuilder | |
getMaxNumTrialsOrBuilder()
public abstract Int32ValueOrBuilder getMaxNumTrialsOrBuilder()If there are more than this many trials, stop the study.
.google.protobuf.Int32Value max_num_trials = 5;
| Returns | |
|---|---|
| Type | Description |
Int32ValueOrBuilder | |
getMaximumRuntimeConstraint()
public abstract StudyTimeConstraint getMaximumRuntimeConstraint()If the specified time or duration has passed, stop the study.
.google.cloud.aiplatform.v1.StudyTimeConstraint maximum_runtime_constraint = 3;
| Returns | |
|---|---|
| Type | Description |
StudyTimeConstraint | The maximumRuntimeConstraint. |
getMaximumRuntimeConstraintOrBuilder()
public abstract StudyTimeConstraintOrBuilder getMaximumRuntimeConstraintOrBuilder()If the specified time or duration has passed, stop the study.
.google.cloud.aiplatform.v1.StudyTimeConstraint maximum_runtime_constraint = 3;
| Returns | |
|---|---|
| Type | Description |
StudyTimeConstraintOrBuilder | |
getMinNumTrials()
public abstract 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. |
getMinNumTrialsOrBuilder()
public abstract Int32ValueOrBuilder getMinNumTrialsOrBuilder()If there are fewer than this many COMPLETED trials, do not stop the study.
.google.protobuf.Int32Value min_num_trials = 4;
| Returns | |
|---|---|
| Type | Description |
Int32ValueOrBuilder | |
getMinimumRuntimeConstraint()
public abstract 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 | |
|---|---|
| Type | Description |
StudyTimeConstraint | The minimumRuntimeConstraint. |
getMinimumRuntimeConstraintOrBuilder()
public abstract 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 | |
|---|---|
| Type | Description |
StudyTimeConstraintOrBuilder | |
getShouldStopAsap()
public abstract 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. |
getShouldStopAsapOrBuilder()
public abstract 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 | |
|---|---|
| Type | Description |
BoolValueOrBuilder | |
hasMaxDurationNoProgress()
public abstract 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. |
hasMaxNumTrials()
public abstract 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. |
hasMaxNumTrialsNoProgress()
public abstract 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. |
hasMaximumRuntimeConstraint()
public abstract 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. |
hasMinNumTrials()
public abstract 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. |
hasMinimumRuntimeConstraint()
public abstract 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. |
hasShouldStopAsap()
public abstract 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. |