public static final class StudySpec.ConvexAutomatedStoppingSpec.Builder extends com.google.protobuf.GeneratedMessageV3.Builder<StudySpec.ConvexAutomatedStoppingSpec.Builder> 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.v1beta1.StudySpec.ConvexAutomatedStoppingSpec| Modifier and Type | Method and Description |
|---|---|
StudySpec.ConvexAutomatedStoppingSpec.Builder |
addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
Object value) |
StudySpec.ConvexAutomatedStoppingSpec |
build() |
StudySpec.ConvexAutomatedStoppingSpec |
buildPartial() |
StudySpec.ConvexAutomatedStoppingSpec.Builder |
clear() |
StudySpec.ConvexAutomatedStoppingSpec.Builder |
clearField(com.google.protobuf.Descriptors.FieldDescriptor field) |
StudySpec.ConvexAutomatedStoppingSpec.Builder |
clearLearningRateParameterName()
The hyper-parameter name used in the tuning job that stands for learning
rate.
|
StudySpec.ConvexAutomatedStoppingSpec.Builder |
clearMaxStepCount()
Steps used in predicting the final objective for early stopped trials.
|
StudySpec.ConvexAutomatedStoppingSpec.Builder |
clearMinMeasurementCount()
The minimal number of measurements in a Trial.
|
StudySpec.ConvexAutomatedStoppingSpec.Builder |
clearMinStepCount()
Minimum number of steps for a trial to complete.
|
StudySpec.ConvexAutomatedStoppingSpec.Builder |
clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof) |
StudySpec.ConvexAutomatedStoppingSpec.Builder |
clearUpdateAllStoppedTrials()
ConvexAutomatedStoppingSpec by default only updates the trials that needs
to be early stopped using a newly trained auto-regressive model.
|
StudySpec.ConvexAutomatedStoppingSpec.Builder |
clearUseElapsedDuration()
This bool determines whether or not the rule is applied based on
elapsed_secs or steps.
|
StudySpec.ConvexAutomatedStoppingSpec.Builder |
clone() |
StudySpec.ConvexAutomatedStoppingSpec |
getDefaultInstanceForType() |
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
com.google.protobuf.Descriptors.Descriptor |
getDescriptorForType() |
String |
getLearningRateParameterName()
The hyper-parameter name used in the tuning job that stands for learning
rate.
|
com.google.protobuf.ByteString |
getLearningRateParameterNameBytes()
The hyper-parameter name used in the tuning job that stands for learning
rate.
|
long |
getMaxStepCount()
Steps used in predicting the final objective for early stopped trials.
|
long |
getMinMeasurementCount()
The minimal number of measurements in a Trial.
|
long |
getMinStepCount()
Minimum number of steps for a trial to complete.
|
boolean |
getUpdateAllStoppedTrials()
ConvexAutomatedStoppingSpec by default only updates the trials that needs
to be early stopped using a newly trained auto-regressive model.
|
boolean |
getUseElapsedDuration()
This bool determines whether or not the rule is applied based on
elapsed_secs or steps.
|
boolean |
hasUpdateAllStoppedTrials()
ConvexAutomatedStoppingSpec by default only updates the trials that needs
to be early stopped using a newly trained auto-regressive model.
|
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
boolean |
isInitialized() |
StudySpec.ConvexAutomatedStoppingSpec.Builder |
mergeFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
StudySpec.ConvexAutomatedStoppingSpec.Builder |
mergeFrom(com.google.protobuf.Message other) |
StudySpec.ConvexAutomatedStoppingSpec.Builder |
mergeFrom(StudySpec.ConvexAutomatedStoppingSpec other) |
StudySpec.ConvexAutomatedStoppingSpec.Builder |
mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) |
StudySpec.ConvexAutomatedStoppingSpec.Builder |
setField(com.google.protobuf.Descriptors.FieldDescriptor field,
Object value) |
StudySpec.ConvexAutomatedStoppingSpec.Builder |
setLearningRateParameterName(String value)
The hyper-parameter name used in the tuning job that stands for learning
rate.
|
StudySpec.ConvexAutomatedStoppingSpec.Builder |
setLearningRateParameterNameBytes(com.google.protobuf.ByteString value)
The hyper-parameter name used in the tuning job that stands for learning
rate.
|
StudySpec.ConvexAutomatedStoppingSpec.Builder |
setMaxStepCount(long value)
Steps used in predicting the final objective for early stopped trials.
|
StudySpec.ConvexAutomatedStoppingSpec.Builder |
setMinMeasurementCount(long value)
The minimal number of measurements in a Trial.
|
StudySpec.ConvexAutomatedStoppingSpec.Builder |
setMinStepCount(long value)
Minimum number of steps for a trial to complete.
|
StudySpec.ConvexAutomatedStoppingSpec.Builder |
setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
int index,
Object value) |
StudySpec.ConvexAutomatedStoppingSpec.Builder |
setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) |
StudySpec.ConvexAutomatedStoppingSpec.Builder |
setUpdateAllStoppedTrials(boolean value)
ConvexAutomatedStoppingSpec by default only updates the trials that needs
to be early stopped using a newly trained auto-regressive model.
|
StudySpec.ConvexAutomatedStoppingSpec.Builder |
setUseElapsedDuration(boolean value)
This bool determines whether or not the rule is applied based on
elapsed_secs or steps.
|
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toStringaddAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, newUninitializedMessageExceptionequals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitpublic static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<StudySpec.ConvexAutomatedStoppingSpec.Builder>public StudySpec.ConvexAutomatedStoppingSpec.Builder clear()
clear in interface com.google.protobuf.Message.Builderclear in interface com.google.protobuf.MessageLite.Builderclear in class com.google.protobuf.GeneratedMessageV3.Builder<StudySpec.ConvexAutomatedStoppingSpec.Builder>public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
getDescriptorForType in interface com.google.protobuf.Message.BuildergetDescriptorForType in interface com.google.protobuf.MessageOrBuildergetDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<StudySpec.ConvexAutomatedStoppingSpec.Builder>public StudySpec.ConvexAutomatedStoppingSpec getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilderpublic StudySpec.ConvexAutomatedStoppingSpec build()
build in interface com.google.protobuf.Message.Builderbuild in interface com.google.protobuf.MessageLite.Builderpublic StudySpec.ConvexAutomatedStoppingSpec buildPartial()
buildPartial in interface com.google.protobuf.Message.BuilderbuildPartial in interface com.google.protobuf.MessageLite.Builderpublic StudySpec.ConvexAutomatedStoppingSpec.Builder clone()
clone in interface com.google.protobuf.Message.Builderclone in interface com.google.protobuf.MessageLite.Builderclone in class com.google.protobuf.GeneratedMessageV3.Builder<StudySpec.ConvexAutomatedStoppingSpec.Builder>public StudySpec.ConvexAutomatedStoppingSpec.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
setField in interface com.google.protobuf.Message.BuildersetField in class com.google.protobuf.GeneratedMessageV3.Builder<StudySpec.ConvexAutomatedStoppingSpec.Builder>public StudySpec.ConvexAutomatedStoppingSpec.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
clearField in interface com.google.protobuf.Message.BuilderclearField in class com.google.protobuf.GeneratedMessageV3.Builder<StudySpec.ConvexAutomatedStoppingSpec.Builder>public StudySpec.ConvexAutomatedStoppingSpec.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
clearOneof in interface com.google.protobuf.Message.BuilderclearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<StudySpec.ConvexAutomatedStoppingSpec.Builder>public StudySpec.ConvexAutomatedStoppingSpec.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
setRepeatedField in interface com.google.protobuf.Message.BuildersetRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<StudySpec.ConvexAutomatedStoppingSpec.Builder>public StudySpec.ConvexAutomatedStoppingSpec.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
addRepeatedField in interface com.google.protobuf.Message.BuilderaddRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<StudySpec.ConvexAutomatedStoppingSpec.Builder>public StudySpec.ConvexAutomatedStoppingSpec.Builder mergeFrom(com.google.protobuf.Message other)
mergeFrom in interface com.google.protobuf.Message.BuildermergeFrom in class com.google.protobuf.AbstractMessage.Builder<StudySpec.ConvexAutomatedStoppingSpec.Builder>public StudySpec.ConvexAutomatedStoppingSpec.Builder mergeFrom(StudySpec.ConvexAutomatedStoppingSpec other)
public final boolean isInitialized()
isInitialized in interface com.google.protobuf.MessageLiteOrBuilderisInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<StudySpec.ConvexAutomatedStoppingSpec.Builder>public StudySpec.ConvexAutomatedStoppingSpec.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
mergeFrom in interface com.google.protobuf.Message.BuildermergeFrom in interface com.google.protobuf.MessageLite.BuildermergeFrom in class com.google.protobuf.AbstractMessage.Builder<StudySpec.ConvexAutomatedStoppingSpec.Builder>IOExceptionpublic 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;getMaxStepCount in interface StudySpec.ConvexAutomatedStoppingSpecOrBuilderpublic StudySpec.ConvexAutomatedStoppingSpec.Builder setMaxStepCount(long value)
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;value - The maxStepCount to set.public StudySpec.ConvexAutomatedStoppingSpec.Builder clearMaxStepCount()
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;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;getMinStepCount in interface StudySpec.ConvexAutomatedStoppingSpecOrBuilderpublic StudySpec.ConvexAutomatedStoppingSpec.Builder setMinStepCount(long value)
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;value - The minStepCount to set.public StudySpec.ConvexAutomatedStoppingSpec.Builder clearMinStepCount()
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;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;getMinMeasurementCount in interface StudySpec.ConvexAutomatedStoppingSpecOrBuilderpublic StudySpec.ConvexAutomatedStoppingSpec.Builder setMinMeasurementCount(long value)
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;value - The minMeasurementCount to set.public StudySpec.ConvexAutomatedStoppingSpec.Builder clearMinMeasurementCount()
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;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;getLearningRateParameterName in interface StudySpec.ConvexAutomatedStoppingSpecOrBuilderpublic 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;getLearningRateParameterNameBytes in interface StudySpec.ConvexAutomatedStoppingSpecOrBuilderpublic StudySpec.ConvexAutomatedStoppingSpec.Builder setLearningRateParameterName(String value)
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;value - The learningRateParameterName to set.public StudySpec.ConvexAutomatedStoppingSpec.Builder clearLearningRateParameterName()
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;public StudySpec.ConvexAutomatedStoppingSpec.Builder setLearningRateParameterNameBytes(com.google.protobuf.ByteString value)
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;value - The bytes for learningRateParameterName to set.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;getUseElapsedDuration in interface StudySpec.ConvexAutomatedStoppingSpecOrBuilderpublic StudySpec.ConvexAutomatedStoppingSpec.Builder setUseElapsedDuration(boolean value)
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;value - The useElapsedDuration to set.public StudySpec.ConvexAutomatedStoppingSpec.Builder clearUseElapsedDuration()
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;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;hasUpdateAllStoppedTrials in interface StudySpec.ConvexAutomatedStoppingSpecOrBuilderpublic 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;getUpdateAllStoppedTrials in interface StudySpec.ConvexAutomatedStoppingSpecOrBuilderpublic StudySpec.ConvexAutomatedStoppingSpec.Builder setUpdateAllStoppedTrials(boolean value)
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;value - The updateAllStoppedTrials to set.public StudySpec.ConvexAutomatedStoppingSpec.Builder clearUpdateAllStoppedTrials()
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;public final StudySpec.ConvexAutomatedStoppingSpec.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
setUnknownFields in interface com.google.protobuf.Message.BuildersetUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<StudySpec.ConvexAutomatedStoppingSpec.Builder>public final StudySpec.ConvexAutomatedStoppingSpec.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
mergeUnknownFields in interface com.google.protobuf.Message.BuildermergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<StudySpec.ConvexAutomatedStoppingSpec.Builder>Copyright © 2024 Google LLC. All rights reserved.