Class StudySpec.ConvexAutomatedStoppingSpec.Builder (3.4.0)

Version 3.4.0

• 3.55.0 (latest)
• 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.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

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > StudySpec.ConvexAutomatedStoppingSpec.Builder

Implements

StudySpec.ConvexAutomatedStoppingSpecOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static 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

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearField(Descriptors.FieldDescriptor field)

public StudySpec.ConvexAutomatedStoppingSpec.Builder clearField(Descriptors.FieldDescriptor field)

Parameter

Name	Description
field	FieldDescriptor

Returns

Type	Description
StudySpec.ConvexAutomatedStoppingSpec.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

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

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

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

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getDefaultInstanceForType()

public StudySpec.ConvexAutomatedStoppingSpec getDefaultInstanceForType()

Returns

Type	Description
StudySpec.ConvexAutomatedStoppingSpec

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns

Type	Description
Descriptor

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

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.

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.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns

Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns

Type	Description
boolean

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

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

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeUnknownFields(UnknownFieldSet unknownFields)

public final StudySpec.ConvexAutomatedStoppingSpec.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter

Name	Description
unknownFields	UnknownFieldSet

Returns

Type	Description
StudySpec.ConvexAutomatedStoppingSpec.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

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

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

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	String The 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	ByteString The 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	long The 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	long The 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	long The 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

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setUnknownFields(UnknownFieldSet unknownFields)

public final StudySpec.ConvexAutomatedStoppingSpec.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter

Name	Description
unknownFields	UnknownFieldSet

Returns

Type	Description
StudySpec.ConvexAutomatedStoppingSpec.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)

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	boolean The useElapsedDuration to set.

Returns

Type	Description
StudySpec.ConvexAutomatedStoppingSpec.Builder	This builder for chaining.