Class StudySpec.ConvexAutomatedStoppingSpec (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 extends GeneratedMessageV3 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

Inheritance

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

Implements

StudySpec.ConvexAutomatedStoppingSpecOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashBoolean(boolean)

AbstractMessage.hashCode()

AbstractMessage.hashEnum(Internal.EnumLite)

AbstractMessage.hashEnumList(List<? extends Internal.EnumLite>)

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.hashLong(long)

AbstractMessage.toString()

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

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

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<V>serializeBooleanMapTo(CodedOutputStream,MapField<Boolean,V>,MapEntry<Boolean,V>,int)

GeneratedMessageV3.<V>serializeIntegerMapTo(CodedOutputStream,MapField<Integer,V>,MapEntry<Integer,V>,int)

GeneratedMessageV3.<V>serializeLongMapTo(CodedOutputStream,MapField<Long,V>,MapEntry<Long,V>,int)

GeneratedMessageV3.<V>serializeStringMapTo(CodedOutputStream,MapField<String,V>,MapEntry<String,V>,int)

GeneratedMessageV3.canUseUnsafe()

GeneratedMessageV3.computeStringSize(int,Object)

GeneratedMessageV3.computeStringSizeNoTag(Object)

GeneratedMessageV3.emptyBooleanList()

GeneratedMessageV3.emptyDoubleList()

GeneratedMessageV3.emptyFloatList()

GeneratedMessageV3.emptyIntList()

GeneratedMessageV3.emptyLongList()

GeneratedMessageV3.getAllFields()

GeneratedMessageV3.getDescriptorForType()

GeneratedMessageV3.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.getParserForType()

GeneratedMessageV3.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.getSerializedSize()

GeneratedMessageV3.getUnknownFields()

GeneratedMessageV3.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.internalGetFieldAccessorTable()

GeneratedMessageV3.internalGetMapField(int)

GeneratedMessageV3.isInitialized()

GeneratedMessageV3.isStringEmpty(Object)

GeneratedMessageV3.makeExtensionsImmutable()

GeneratedMessageV3.mergeFromAndMakeImmutableInternal(CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.mutableCopy(Internal.BooleanList)

GeneratedMessageV3.mutableCopy(Internal.DoubleList)

GeneratedMessageV3.mutableCopy(Internal.FloatList)

GeneratedMessageV3.mutableCopy(Internal.IntList)

GeneratedMessageV3.mutableCopy(Internal.LongList)

GeneratedMessageV3.newBooleanList()

GeneratedMessageV3.newBuilderForType(AbstractMessage.BuilderParent)

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent)

GeneratedMessageV3.newDoubleList()

GeneratedMessageV3.newFloatList()

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter)

GeneratedMessageV3.newIntList()

GeneratedMessageV3.newLongList()

GeneratedMessageV3.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.parseUnknownFieldProto3(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.writeReplace()

GeneratedMessageV3.writeString(CodedOutputStream,int,Object)

GeneratedMessageV3.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessageV3.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Fields

LEARNING_RATE_PARAMETER_NAME_FIELD_NUMBER

public static final int LEARNING_RATE_PARAMETER_NAME_FIELD_NUMBER

Field Value

Type	Description
int

MAX_STEP_COUNT_FIELD_NUMBER

public static final int MAX_STEP_COUNT_FIELD_NUMBER

Field Value

Type	Description
int

MIN_MEASUREMENT_COUNT_FIELD_NUMBER

public static final int MIN_MEASUREMENT_COUNT_FIELD_NUMBER

Field Value

Type	Description
int

MIN_STEP_COUNT_FIELD_NUMBER

public static final int MIN_STEP_COUNT_FIELD_NUMBER

Field Value

Type	Description
int

USE_ELAPSED_DURATION_FIELD_NUMBER

public static final int USE_ELAPSED_DURATION_FIELD_NUMBER

Field Value

Type	Description
int

Static Methods

getDefaultInstance()

public static StudySpec.ConvexAutomatedStoppingSpec getDefaultInstance()

Returns

Type	Description
StudySpec.ConvexAutomatedStoppingSpec

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns

Type	Description
Descriptor

newBuilder()

public static StudySpec.ConvexAutomatedStoppingSpec.Builder newBuilder()

Returns

Type	Description
StudySpec.ConvexAutomatedStoppingSpec.Builder

newBuilder(StudySpec.ConvexAutomatedStoppingSpec prototype)

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

Parameter

Name	Description
prototype	StudySpec.ConvexAutomatedStoppingSpec

Returns

Type	Description
StudySpec.ConvexAutomatedStoppingSpec.Builder

parseDelimitedFrom(InputStream input)

public static StudySpec.ConvexAutomatedStoppingSpec parseDelimitedFrom(InputStream input)

Parameter

Name	Description
input	InputStream

Returns

Type	Description
StudySpec.ConvexAutomatedStoppingSpec

Exceptions

Type	Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static StudySpec.ConvexAutomatedStoppingSpec parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns

Type	Description
StudySpec.ConvexAutomatedStoppingSpec

Exceptions

Type	Description
IOException

parseFrom(byte[] data)

public static StudySpec.ConvexAutomatedStoppingSpec parseFrom(byte[] data)

Parameter

Name	Description
data	byte[]

Returns

Type	Description
StudySpec.ConvexAutomatedStoppingSpec

Exceptions

Type	Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static StudySpec.ConvexAutomatedStoppingSpec parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
data	byte[]
extensionRegistry	ExtensionRegistryLite

Returns

Type	Description
StudySpec.ConvexAutomatedStoppingSpec

Exceptions

Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static StudySpec.ConvexAutomatedStoppingSpec parseFrom(ByteString data)

Parameter

Name	Description
data	ByteString

Returns

Type	Description
StudySpec.ConvexAutomatedStoppingSpec

Exceptions

Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static StudySpec.ConvexAutomatedStoppingSpec parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
data	ByteString
extensionRegistry	ExtensionRegistryLite

Returns

Type	Description
StudySpec.ConvexAutomatedStoppingSpec

Exceptions

Type	Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static StudySpec.ConvexAutomatedStoppingSpec parseFrom(CodedInputStream input)

Parameter

Name	Description
input	CodedInputStream

Returns

Type	Description
StudySpec.ConvexAutomatedStoppingSpec

Exceptions

Type	Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static StudySpec.ConvexAutomatedStoppingSpec parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns

Type	Description
StudySpec.ConvexAutomatedStoppingSpec

Exceptions

Type	Description
IOException

parseFrom(InputStream input)

public static StudySpec.ConvexAutomatedStoppingSpec parseFrom(InputStream input)

Parameter

Name	Description
input	InputStream

Returns

Type	Description
StudySpec.ConvexAutomatedStoppingSpec

Exceptions

Type	Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static StudySpec.ConvexAutomatedStoppingSpec parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns

Type	Description
StudySpec.ConvexAutomatedStoppingSpec

Exceptions

Type	Description
IOException

parseFrom(ByteBuffer data)

public static StudySpec.ConvexAutomatedStoppingSpec parseFrom(ByteBuffer data)

Parameter

Name	Description
data	ByteBuffer

Returns

Type	Description
StudySpec.ConvexAutomatedStoppingSpec

Exceptions

Type	Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static StudySpec.ConvexAutomatedStoppingSpec parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
data	ByteBuffer
extensionRegistry	ExtensionRegistryLite

Returns

Type	Description
StudySpec.ConvexAutomatedStoppingSpec

Exceptions

Type	Description
InvalidProtocolBufferException

parser()

public static Parser<StudySpec.ConvexAutomatedStoppingSpec> parser()

Returns

Type	Description
Parser<ConvexAutomatedStoppingSpec>

Methods

equals(Object obj)

public boolean equals(Object obj)

Parameter

Name	Description
obj	Object

Returns

Type	Description
boolean

Overrides

AbstractMessage.equals(Object other)

getDefaultInstanceForType()

public StudySpec.ConvexAutomatedStoppingSpec getDefaultInstanceForType()

Returns

Type	Description
StudySpec.ConvexAutomatedStoppingSpec

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.

getParserForType()

public Parser<StudySpec.ConvexAutomatedStoppingSpec> getParserForType()

Returns

Type	Description
Parser<ConvexAutomatedStoppingSpec>

Overrides

GeneratedMessageV3.getParserForType()

getSerializedSize()

public int getSerializedSize()

Returns

Type	Description
int

Overrides

GeneratedMessageV3.getSerializedSize()

getUnknownFields()

public final UnknownFieldSet getUnknownFields()

Returns

Type	Description
UnknownFieldSet

Overrides

GeneratedMessageV3.getUnknownFields()

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.

hashCode()

public int hashCode()

Returns

Type	Description
int

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns

Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns

Type	Description
boolean

Overrides

GeneratedMessageV3.isInitialized()

newBuilderForType()

public StudySpec.ConvexAutomatedStoppingSpec.Builder newBuilderForType()

Returns

Type	Description
StudySpec.ConvexAutomatedStoppingSpec.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected StudySpec.ConvexAutomatedStoppingSpec.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Parameter

Name	Description
parent	BuilderParent

Returns

Type	Description
StudySpec.ConvexAutomatedStoppingSpec.Builder

Overrides

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent parent)

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Parameter

Name	Description
unused	UnusedPrivateParameter

Returns

Type	Description
Object

Overrides

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

toBuilder()

public StudySpec.ConvexAutomatedStoppingSpec.Builder toBuilder()

Returns

Type	Description
StudySpec.ConvexAutomatedStoppingSpec.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter

Name	Description
output	CodedOutputStream

Overrides

GeneratedMessageV3.writeTo(CodedOutputStream output)

Exceptions

Type	Description
IOException