Class StudySpec.ConvexStopConfig (3.3.0)

public static final class StudySpec.ConvexStopConfig extends GeneratedMessageV3 implements StudySpec.ConvexStopConfigOrBuilder

Configuration for ConvexStopPolicy.

Protobuf type google.cloud.aiplatform.v1beta1.StudySpec.ConvexStopConfig

Static Fields

AUTOREGRESSIVE_ORDER_FIELD_NUMBER

public static final int AUTOREGRESSIVE_ORDER_FIELD_NUMBER
Field Value
TypeDescription
int

LEARNING_RATE_PARAMETER_NAME_FIELD_NUMBER

public static final int LEARNING_RATE_PARAMETER_NAME_FIELD_NUMBER
Field Value
TypeDescription
int

MAX_NUM_STEPS_FIELD_NUMBER

public static final int MAX_NUM_STEPS_FIELD_NUMBER
Field Value
TypeDescription
int

MIN_NUM_STEPS_FIELD_NUMBER

public static final int MIN_NUM_STEPS_FIELD_NUMBER
Field Value
TypeDescription
int

USE_SECONDS_FIELD_NUMBER

public static final int USE_SECONDS_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static StudySpec.ConvexStopConfig getDefaultInstance()
Returns
TypeDescription
StudySpec.ConvexStopConfig

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static StudySpec.ConvexStopConfig.Builder newBuilder()
Returns
TypeDescription
StudySpec.ConvexStopConfig.Builder

newBuilder(StudySpec.ConvexStopConfig prototype)

public static StudySpec.ConvexStopConfig.Builder newBuilder(StudySpec.ConvexStopConfig prototype)
Parameter
NameDescription
prototypeStudySpec.ConvexStopConfig
Returns
TypeDescription
StudySpec.ConvexStopConfig.Builder

parseDelimitedFrom(InputStream input)

public static StudySpec.ConvexStopConfig parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
StudySpec.ConvexStopConfig
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static StudySpec.ConvexStopConfig parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
StudySpec.ConvexStopConfig
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static StudySpec.ConvexStopConfig parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
StudySpec.ConvexStopConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static StudySpec.ConvexStopConfig parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
StudySpec.ConvexStopConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static StudySpec.ConvexStopConfig parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
StudySpec.ConvexStopConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static StudySpec.ConvexStopConfig parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
StudySpec.ConvexStopConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static StudySpec.ConvexStopConfig parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
StudySpec.ConvexStopConfig
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static StudySpec.ConvexStopConfig parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
StudySpec.ConvexStopConfig
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static StudySpec.ConvexStopConfig parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
StudySpec.ConvexStopConfig
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static StudySpec.ConvexStopConfig parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
StudySpec.ConvexStopConfig
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static StudySpec.ConvexStopConfig parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
StudySpec.ConvexStopConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static StudySpec.ConvexStopConfig parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
StudySpec.ConvexStopConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<StudySpec.ConvexStopConfig> parser()
Returns
TypeDescription
Parser<ConvexStopConfig>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getAutoregressiveOrder()

public long getAutoregressiveOrder()

The number of Trial measurements used in autoregressive model for value prediction. A trial won't be considered early stopping if has fewer measurement points.

int64 autoregressive_order = 3;

Returns
TypeDescription
long

The autoregressiveOrder.

getDefaultInstanceForType()

public StudySpec.ConvexStopConfig getDefaultInstanceForType()
Returns
TypeDescription
StudySpec.ConvexStopConfig

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
TypeDescription
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
TypeDescription
ByteString

The bytes for learningRateParameterName.

getMaxNumSteps()

public long getMaxNumSteps()

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. When use_steps is false, this field is set to the maximum elapsed seconds.

int64 max_num_steps = 1;

Returns
TypeDescription
long

The maxNumSteps.

getMinNumSteps()

public long getMinNumSteps()

Minimum number of steps for a trial to complete. Trials which do not have a measurement with num_steps > min_num_steps 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_num_steps is set to be one-tenth of the max_num_steps. When use_steps is false, this field is set to the minimum elapsed seconds.

int64 min_num_steps = 2;

Returns
TypeDescription
long

The minNumSteps.

getParserForType()

public Parser<StudySpec.ConvexStopConfig> getParserForType()
Returns
TypeDescription
Parser<ConvexStopConfig>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
Overrides

getUseSeconds()

public boolean getUseSeconds()

This bool determines whether or not the rule is applied based on elapsed_secs or steps. If use_seconds

false, the early stopping decision is made according to the predicted objective values according to the target steps. If use_seconds

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_seconds = 5;

Returns
TypeDescription
boolean

The useSeconds.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public StudySpec.ConvexStopConfig.Builder newBuilderForType()
Returns
TypeDescription
StudySpec.ConvexStopConfig.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected StudySpec.ConvexStopConfig.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
StudySpec.ConvexStopConfig.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public StudySpec.ConvexStopConfig.Builder toBuilder()
Returns
TypeDescription
StudySpec.ConvexStopConfig.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides Exceptions
TypeDescription
IOException