Package com.google.cloud.aiplatform.v1

Class StudySpec.StudyStoppingConfig

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.aiplatform.v1.StudySpec.StudyStoppingConfig
All Implemented Interfaces:
StudySpec.StudyStoppingConfigOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
Enclosing class:
StudySpec
public static final class StudySpec.StudyStoppingConfig extends com.google.protobuf.GeneratedMessage 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
See Also:

  • Field Details

    • SHOULD_STOP_ASAP_FIELD_NUMBER

      public static final int SHOULD_STOP_ASAP_FIELD_NUMBER
      See Also:

    • MINIMUM_RUNTIME_CONSTRAINT_FIELD_NUMBER

      public static final int MINIMUM_RUNTIME_CONSTRAINT_FIELD_NUMBER
      See Also:

    • MAXIMUM_RUNTIME_CONSTRAINT_FIELD_NUMBER

      public static final int MAXIMUM_RUNTIME_CONSTRAINT_FIELD_NUMBER
      See Also:

    • MIN_NUM_TRIALS_FIELD_NUMBER

      public static final int MIN_NUM_TRIALS_FIELD_NUMBER
      See Also:

    • MAX_NUM_TRIALS_FIELD_NUMBER

      public static final int MAX_NUM_TRIALS_FIELD_NUMBER
      See Also:

    • MAX_NUM_TRIALS_NO_PROGRESS_FIELD_NUMBER

      public static final int MAX_NUM_TRIALS_NO_PROGRESS_FIELD_NUMBER
      See Also:

    • MAX_DURATION_NO_PROGRESS_FIELD_NUMBER

      public static final int MAX_DURATION_NO_PROGRESS_FIELD_NUMBER
      See Also:

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • 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;
      Specified by:
      hasShouldStopAsap in interface StudySpec.StudyStoppingConfigOrBuilder
      Returns:
      Whether the shouldStopAsap field is set.

    • getShouldStopAsap

      public 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;
      Specified by:
      getShouldStopAsap in interface StudySpec.StudyStoppingConfigOrBuilder
      Returns:
      The shouldStopAsap.

    • getShouldStopAsapOrBuilder

      public 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;
      Specified by:
      getShouldStopAsapOrBuilder in interface StudySpec.StudyStoppingConfigOrBuilder

    • 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;
      Specified by:
      hasMinimumRuntimeConstraint in interface StudySpec.StudyStoppingConfigOrBuilder
      Returns:
      Whether the minimumRuntimeConstraint field is set.

    • 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;
      Specified by:
      getMinimumRuntimeConstraint in interface StudySpec.StudyStoppingConfigOrBuilder
      Returns:
      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;
      Specified by:
      getMinimumRuntimeConstraintOrBuilder in interface StudySpec.StudyStoppingConfigOrBuilder

    • hasMaximumRuntimeConstraint

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

    • getMaximumRuntimeConstraint

      public StudyTimeConstraint getMaximumRuntimeConstraint()
       If the specified time or duration has passed, stop the study.
      .google.cloud.aiplatform.v1.StudyTimeConstraint maximum_runtime_constraint = 3;
      Specified by:
      getMaximumRuntimeConstraint in interface StudySpec.StudyStoppingConfigOrBuilder
      Returns:
      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;
      Specified by:
      getMaximumRuntimeConstraintOrBuilder in interface StudySpec.StudyStoppingConfigOrBuilder

    • 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;
      Specified by:
      hasMinNumTrials in interface StudySpec.StudyStoppingConfigOrBuilder
      Returns:
      Whether the minNumTrials field is set.

    • getMinNumTrials

      public 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;
      Specified by:
      getMinNumTrials in interface StudySpec.StudyStoppingConfigOrBuilder
      Returns:
      The minNumTrials.

    • getMinNumTrialsOrBuilder

      public 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;
      Specified by:
      getMinNumTrialsOrBuilder in interface StudySpec.StudyStoppingConfigOrBuilder

    • hasMaxNumTrials

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

    • getMaxNumTrials

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

    • getMaxNumTrialsOrBuilder

      public com.google.protobuf.Int32ValueOrBuilder getMaxNumTrialsOrBuilder()
       If there are more than this many trials, stop the study.
      .google.protobuf.Int32Value max_num_trials = 5;
      Specified by:
      getMaxNumTrialsOrBuilder in interface StudySpec.StudyStoppingConfigOrBuilder

    • 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;
      Specified by:
      hasMaxNumTrialsNoProgress in interface StudySpec.StudyStoppingConfigOrBuilder
      Returns:
      Whether the maxNumTrialsNoProgress field is set.

    • getMaxNumTrialsNoProgress

      public 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;
      Specified by:
      getMaxNumTrialsNoProgress in interface StudySpec.StudyStoppingConfigOrBuilder
      Returns:
      The maxNumTrialsNoProgress.

    • getMaxNumTrialsNoProgressOrBuilder

      public 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;
      Specified by:
      getMaxNumTrialsNoProgressOrBuilder in interface StudySpec.StudyStoppingConfigOrBuilder

    • 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;
      Specified by:
      hasMaxDurationNoProgress in interface StudySpec.StudyStoppingConfigOrBuilder
      Returns:
      Whether the maxDurationNoProgress field is set.

    • getMaxDurationNoProgress

      public 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;
      Specified by:
      getMaxDurationNoProgress in interface StudySpec.StudyStoppingConfigOrBuilder
      Returns:
      The maxDurationNoProgress.

    • getMaxDurationNoProgressOrBuilder

      public 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;
      Specified by:
      getMaxDurationNoProgressOrBuilder in interface StudySpec.StudyStoppingConfigOrBuilder

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static StudySpec.StudyStoppingConfig parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static StudySpec.StudyStoppingConfig parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static StudySpec.StudyStoppingConfig parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static StudySpec.StudyStoppingConfig parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static StudySpec.StudyStoppingConfig parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static StudySpec.StudyStoppingConfig parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static StudySpec.StudyStoppingConfig parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static StudySpec.StudyStoppingConfig parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static StudySpec.StudyStoppingConfig parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static StudySpec.StudyStoppingConfig parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static StudySpec.StudyStoppingConfig parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static StudySpec.StudyStoppingConfig parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public StudySpec.StudyStoppingConfig.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static StudySpec.StudyStoppingConfig.Builder newBuilder()

    • newBuilder

      public static StudySpec.StudyStoppingConfig.Builder newBuilder(StudySpec.StudyStoppingConfig prototype)

    • toBuilder

      public StudySpec.StudyStoppingConfig.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected StudySpec.StudyStoppingConfig.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static StudySpec.StudyStoppingConfig getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<StudySpec.StudyStoppingConfig> parser()

    • getParserForType

      public com.google.protobuf.Parser<StudySpec.StudyStoppingConfig> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage

    • getDefaultInstanceForType

      public StudySpec.StudyStoppingConfig getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder