Package com.google.cloud.aiplatform.v1

Interface StudySpec.StudyStoppingConfigOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
StudySpec.StudyStoppingConfig, StudySpec.StudyStoppingConfig.Builder
Enclosing class:
StudySpec
public static interface StudySpec.StudyStoppingConfigOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    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.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.
    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.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Method Details

    • hasShouldStopAsap

      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:
      Whether the shouldStopAsap field is set.

    • getShouldStopAsap

      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;
      Returns:
      The shouldStopAsap.

    • getShouldStopAsapOrBuilder

      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;

    • hasMinimumRuntimeConstraint

      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:
      Whether the minimumRuntimeConstraint field is set.

    • getMinimumRuntimeConstraint

      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:
      The minimumRuntimeConstraint.

    • getMinimumRuntimeConstraintOrBuilder

      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;

    • hasMaximumRuntimeConstraint

      boolean hasMaximumRuntimeConstraint()
       If the specified time or duration has passed, stop the study.
      .google.cloud.aiplatform.v1.StudyTimeConstraint maximum_runtime_constraint = 3;
      Returns:
      Whether the maximumRuntimeConstraint field is set.

    • getMaximumRuntimeConstraint

      StudyTimeConstraint getMaximumRuntimeConstraint()
       If the specified time or duration has passed, stop the study.
      .google.cloud.aiplatform.v1.StudyTimeConstraint maximum_runtime_constraint = 3;
      Returns:
      The maximumRuntimeConstraint.

    • getMaximumRuntimeConstraintOrBuilder

      StudyTimeConstraintOrBuilder getMaximumRuntimeConstraintOrBuilder()
       If the specified time or duration has passed, stop the study.
      .google.cloud.aiplatform.v1.StudyTimeConstraint maximum_runtime_constraint = 3;

    • hasMinNumTrials

      boolean hasMinNumTrials()
       If there are fewer than this many COMPLETED trials, do not stop the
 study.
      .google.protobuf.Int32Value min_num_trials = 4;
      Returns:
      Whether the minNumTrials field is set.

    • getMinNumTrials

      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;
      Returns:
      The minNumTrials.

    • getMinNumTrialsOrBuilder

      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;

    • hasMaxNumTrials

      boolean hasMaxNumTrials()
       If there are more than this many trials, stop the study.
      .google.protobuf.Int32Value max_num_trials = 5;
      Returns:
      Whether the maxNumTrials field is set.

    • getMaxNumTrials

      com.google.protobuf.Int32Value getMaxNumTrials()
       If there are more than this many trials, stop the study.
      .google.protobuf.Int32Value max_num_trials = 5;
      Returns:
      The maxNumTrials.

    • getMaxNumTrialsOrBuilder

      com.google.protobuf.Int32ValueOrBuilder getMaxNumTrialsOrBuilder()
       If there are more than this many trials, stop the study.
      .google.protobuf.Int32Value max_num_trials = 5;

    • hasMaxNumTrialsNoProgress

      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:
      Whether the maxNumTrialsNoProgress field is set.

    • getMaxNumTrialsNoProgress

      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;
      Returns:
      The maxNumTrialsNoProgress.

    • getMaxNumTrialsNoProgressOrBuilder

      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;

    • hasMaxDurationNoProgress

      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:
      Whether the maxDurationNoProgress field is set.

    • getMaxDurationNoProgress

      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;
      Returns:
      The maxDurationNoProgress.

    • getMaxDurationNoProgressOrBuilder

      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;