Package com.google.cloud.aiplatform.v1

Class StudySpec.ConvexAutomatedStoppingSpec

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.aiplatform.v1.StudySpec.ConvexAutomatedStoppingSpec
All Implemented Interfaces:
StudySpec.ConvexAutomatedStoppingSpecOrBuilder, 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.ConvexAutomatedStoppingSpec extends com.google.protobuf.GeneratedMessage implements StudySpec.ConvexAutomatedStoppingSpecOrBuilder
 Configuration for ConvexAutomatedStoppingSpec.
 When there are enough completed trials (configured by
 min_measurement_count), for pending trials with enough measurements and
 steps, the policy first computes an overestimate of the objective value at
 max_num_steps according to the slope of the incomplete objective value
 curve. No prediction can be made if the curve is completely flat. If the
 overestimation is worse than the best objective value of the completed
 trials, this pending trial will be early-stopped, but a last measurement
 will be added to the pending trial with max_num_steps and predicted
 objective value from the autoregression model.
Protobuf type google.cloud.aiplatform.v1.StudySpec.ConvexAutomatedStoppingSpec
See Also:

  • Field Details

    • MAX_STEP_COUNT_FIELD_NUMBER

      public static final int MAX_STEP_COUNT_FIELD_NUMBER
      See Also:

    • MIN_STEP_COUNT_FIELD_NUMBER

      public static final int MIN_STEP_COUNT_FIELD_NUMBER
      See Also:

    • MIN_MEASUREMENT_COUNT_FIELD_NUMBER

      public static final int MIN_MEASUREMENT_COUNT_FIELD_NUMBER
      See Also:

    • LEARNING_RATE_PARAMETER_NAME_FIELD_NUMBER

      public static final int LEARNING_RATE_PARAMETER_NAME_FIELD_NUMBER
      See Also:

    • USE_ELAPSED_DURATION_FIELD_NUMBER

      public static final int USE_ELAPSED_DURATION_FIELD_NUMBER
      See Also:

    • UPDATE_ALL_STOPPED_TRIALS_FIELD_NUMBER

      public static final int UPDATE_ALL_STOPPED_TRIALS_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

    • getMaxStepCount

      public long getMaxStepCount()
       Steps used in predicting the final objective for early stopped trials. In
 general, it's set to be the same as the defined steps in training /
 tuning. If not defined, it will learn it from the completed trials. When
 use_steps is false, this field is set to the maximum elapsed seconds.
      int64 max_step_count = 1;
      Specified by:
      getMaxStepCount in interface StudySpec.ConvexAutomatedStoppingSpecOrBuilder
      Returns:
      The maxStepCount.

    • getMinStepCount

      public long getMinStepCount()
       Minimum number of steps for a trial to complete. Trials which do not have
 a measurement with step_count > min_step_count won't be considered for
 early stopping. It's ok to set it to 0, and a trial can be early stopped
 at any stage. By default, min_step_count is set to be one-tenth of the
 max_step_count.
 When use_elapsed_duration is true, this field is set to the minimum
 elapsed seconds.
      int64 min_step_count = 2;
      Specified by:
      getMinStepCount in interface StudySpec.ConvexAutomatedStoppingSpecOrBuilder
      Returns:
      The minStepCount.

    • getMinMeasurementCount

      public long getMinMeasurementCount()
       The minimal number of measurements in a Trial.  Early-stopping checks
 will not trigger if less than min_measurement_count+1 completed trials or
 pending trials with less than min_measurement_count measurements. If not
 defined, the default value is 5.
      int64 min_measurement_count = 3;
      Specified by:
      getMinMeasurementCount in interface StudySpec.ConvexAutomatedStoppingSpecOrBuilder
      Returns:
      The minMeasurementCount.

    • getLearningRateParameterName

      public String getLearningRateParameterName()
       The hyper-parameter name used in the tuning job that stands for learning
 rate. Leave it blank if learning rate is not in a parameter in tuning.
 The learning_rate is used to estimate the objective value of the ongoing
 trial.
      string learning_rate_parameter_name = 4;
      Specified by:
      getLearningRateParameterName in interface StudySpec.ConvexAutomatedStoppingSpecOrBuilder
      Returns:
      The learningRateParameterName.

    • getLearningRateParameterNameBytes

      public com.google.protobuf.ByteString getLearningRateParameterNameBytes()
       The hyper-parameter name used in the tuning job that stands for learning
 rate. Leave it blank if learning rate is not in a parameter in tuning.
 The learning_rate is used to estimate the objective value of the ongoing
 trial.
      string learning_rate_parameter_name = 4;
      Specified by:
      getLearningRateParameterNameBytes in interface StudySpec.ConvexAutomatedStoppingSpecOrBuilder
      Returns:
      The bytes for learningRateParameterName.

    • getUseElapsedDuration

      public boolean getUseElapsedDuration()
       This bool determines whether or not the rule is applied based on
 elapsed_secs or steps. If use_elapsed_duration==false, the early stopping
 decision is made according to the predicted objective values according to
 the target steps. If use_elapsed_duration==true, elapsed_secs is used
 instead of steps. Also, in this case, the parameters max_num_steps and
 min_num_steps are overloaded to contain max_elapsed_seconds and
 min_elapsed_seconds.
      bool use_elapsed_duration = 5;
      Specified by:
      getUseElapsedDuration in interface StudySpec.ConvexAutomatedStoppingSpecOrBuilder
      Returns:
      The useElapsedDuration.

    • hasUpdateAllStoppedTrials

      public boolean hasUpdateAllStoppedTrials()
       ConvexAutomatedStoppingSpec by default only updates the trials that needs
 to be early stopped using a newly trained auto-regressive model. When
 this flag is set to True, all stopped trials from the beginning are
 potentially updated in terms of their `final_measurement`. Also, note
 that the training logic of autoregressive models is different in this
 case. Enabling this option has shown better results and this may be the
 default option in the future.
      optional bool update_all_stopped_trials = 6;
      Specified by:
      hasUpdateAllStoppedTrials in interface StudySpec.ConvexAutomatedStoppingSpecOrBuilder
      Returns:
      Whether the updateAllStoppedTrials field is set.

    • getUpdateAllStoppedTrials

      public boolean getUpdateAllStoppedTrials()
       ConvexAutomatedStoppingSpec by default only updates the trials that needs
 to be early stopped using a newly trained auto-regressive model. When
 this flag is set to True, all stopped trials from the beginning are
 potentially updated in terms of their `final_measurement`. Also, note
 that the training logic of autoregressive models is different in this
 case. Enabling this option has shown better results and this may be the
 default option in the future.
      optional bool update_all_stopped_trials = 6;
      Specified by:
      getUpdateAllStoppedTrials in interface StudySpec.ConvexAutomatedStoppingSpecOrBuilder
      Returns:
      The updateAllStoppedTrials.

    • 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.ConvexAutomatedStoppingSpec parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

      public static StudySpec.ConvexAutomatedStoppingSpec 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.ConvexAutomatedStoppingSpec parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static StudySpec.ConvexAutomatedStoppingSpec.Builder newBuilder()

    • newBuilder

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

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static StudySpec.ConvexAutomatedStoppingSpec getDefaultInstance()

    • parser

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

    • getParserForType

      public com.google.protobuf.Parser<StudySpec.ConvexAutomatedStoppingSpec> 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.ConvexAutomatedStoppingSpec getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder