- 3.56.0 (latest)
- 3.55.0
- 3.54.0
- 3.53.0
- 3.52.0
- 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 final class StudySpec.ConvexAutomatedStoppingSpec.Builder extends GeneratedMessageV3.Builder<StudySpec.ConvexAutomatedStoppingSpec.Builder> implements StudySpec.ConvexAutomatedStoppingSpecOrBuilderConfiguration 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
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > StudySpec.ConvexAutomatedStoppingSpec.BuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public StudySpec.ConvexAutomatedStoppingSpec.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
StudySpec.ConvexAutomatedStoppingSpec.Builder |
|
build()
public StudySpec.ConvexAutomatedStoppingSpec build()| Returns | |
|---|---|
| Type | Description |
StudySpec.ConvexAutomatedStoppingSpec |
|
buildPartial()
public StudySpec.ConvexAutomatedStoppingSpec buildPartial()| Returns | |
|---|---|
| Type | Description |
StudySpec.ConvexAutomatedStoppingSpec |
|
clear()
public StudySpec.ConvexAutomatedStoppingSpec.Builder clear()| Returns | |
|---|---|
| Type | Description |
StudySpec.ConvexAutomatedStoppingSpec.Builder |
|
clearField(Descriptors.FieldDescriptor field)
public StudySpec.ConvexAutomatedStoppingSpec.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
StudySpec.ConvexAutomatedStoppingSpec.Builder |
|
clearLearningRateParameterName()
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;
| Returns | |
|---|---|
| Type | Description |
StudySpec.ConvexAutomatedStoppingSpec.Builder |
This builder for chaining. |
clearMaxStepCount()
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;
| Returns | |
|---|---|
| Type | Description |
StudySpec.ConvexAutomatedStoppingSpec.Builder |
This builder for chaining. |
clearMinMeasurementCount()
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;
| Returns | |
|---|---|
| Type | Description |
StudySpec.ConvexAutomatedStoppingSpec.Builder |
This builder for chaining. |
clearMinStepCount()
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;
| Returns | |
|---|---|
| Type | Description |
StudySpec.ConvexAutomatedStoppingSpec.Builder |
This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public StudySpec.ConvexAutomatedStoppingSpec.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof |
OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
StudySpec.ConvexAutomatedStoppingSpec.Builder |
|
clearUpdateAllStoppedTrials()
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;
| Returns | |
|---|---|
| Type | Description |
StudySpec.ConvexAutomatedStoppingSpec.Builder |
This builder for chaining. |
clearUseElapsedDuration()
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;
| Returns | |
|---|---|
| Type | Description |
StudySpec.ConvexAutomatedStoppingSpec.Builder |
This builder for chaining. |
clone()
public StudySpec.ConvexAutomatedStoppingSpec.Builder clone()| Returns | |
|---|---|
| Type | Description |
StudySpec.ConvexAutomatedStoppingSpec.Builder |
|
getDefaultInstanceForType()
public StudySpec.ConvexAutomatedStoppingSpec getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
StudySpec.ConvexAutomatedStoppingSpec |
|
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
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;
| Returns | |
|---|---|
| Type | Description |
String |
The learningRateParameterName. |
getLearningRateParameterNameBytes()
public 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;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for learningRateParameterName. |
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;
| Returns | |
|---|---|
| Type | Description |
long |
The maxStepCount. |
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;
| Returns | |
|---|---|
| Type | Description |
long |
The minMeasurementCount. |
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;
| Returns | |
|---|---|
| Type | Description |
long |
The minStepCount. |
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;
| Returns | |
|---|---|
| Type | Description |
boolean |
The updateAllStoppedTrials. |
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;
| Returns | |
|---|---|
| Type | Description |
boolean |
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;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the updateAllStoppedTrials field is set. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeFrom(StudySpec.ConvexAutomatedStoppingSpec other)
public StudySpec.ConvexAutomatedStoppingSpec.Builder mergeFrom(StudySpec.ConvexAutomatedStoppingSpec other)| Parameter | |
|---|---|
| Name | Description |
other |
StudySpec.ConvexAutomatedStoppingSpec |
| Returns | |
|---|---|
| Type | Description |
StudySpec.ConvexAutomatedStoppingSpec.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public StudySpec.ConvexAutomatedStoppingSpec.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
StudySpec.ConvexAutomatedStoppingSpec.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public StudySpec.ConvexAutomatedStoppingSpec.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
StudySpec.ConvexAutomatedStoppingSpec.Builder |
|
mergeUnknownFields(UnknownFieldSet unknownFields)
public final StudySpec.ConvexAutomatedStoppingSpec.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
StudySpec.ConvexAutomatedStoppingSpec.Builder |
|
setField(Descriptors.FieldDescriptor field, Object value)
public StudySpec.ConvexAutomatedStoppingSpec.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
StudySpec.ConvexAutomatedStoppingSpec.Builder |
|
setLearningRateParameterName(String value)
public 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;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe learningRateParameterName to set. |
| Returns | |
|---|---|
| Type | Description |
StudySpec.ConvexAutomatedStoppingSpec.Builder |
This builder for chaining. |
setLearningRateParameterNameBytes(ByteString value)
public StudySpec.ConvexAutomatedStoppingSpec.Builder setLearningRateParameterNameBytes(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;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for learningRateParameterName to set. |
| Returns | |
|---|---|
| Type | Description |
StudySpec.ConvexAutomatedStoppingSpec.Builder |
This builder for chaining. |
setMaxStepCount(long value)
public 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;
| Parameter | |
|---|---|
| Name | Description |
value |
longThe maxStepCount to set. |
| Returns | |
|---|---|
| Type | Description |
StudySpec.ConvexAutomatedStoppingSpec.Builder |
This builder for chaining. |
setMinMeasurementCount(long value)
public 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;
| Parameter | |
|---|---|
| Name | Description |
value |
longThe minMeasurementCount to set. |
| Returns | |
|---|---|
| Type | Description |
StudySpec.ConvexAutomatedStoppingSpec.Builder |
This builder for chaining. |
setMinStepCount(long value)
public 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;
| Parameter | |
|---|---|
| Name | Description |
value |
longThe minStepCount to set. |
| Returns | |
|---|---|
| Type | Description |
StudySpec.ConvexAutomatedStoppingSpec.Builder |
This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public StudySpec.ConvexAutomatedStoppingSpec.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
StudySpec.ConvexAutomatedStoppingSpec.Builder |
|
setUnknownFields(UnknownFieldSet unknownFields)
public final StudySpec.ConvexAutomatedStoppingSpec.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
StudySpec.ConvexAutomatedStoppingSpec.Builder |
|
setUpdateAllStoppedTrials(boolean value)
public 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;
| Parameter | |
|---|---|
| Name | Description |
value |
booleanThe updateAllStoppedTrials to set. |
| Returns | |
|---|---|
| Type | Description |
StudySpec.ConvexAutomatedStoppingSpec.Builder |
This builder for chaining. |
setUseElapsedDuration(boolean value)
public 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;
| Parameter | |
|---|---|
| Name | Description |
value |
booleanThe useElapsedDuration to set. |
| Returns | |
|---|---|
| Type | Description |
StudySpec.ConvexAutomatedStoppingSpec.Builder |
This builder for chaining. |