Class StudySpec.DecayCurveAutomatedStoppingSpec.Builder (3.45.0)

public static final class StudySpec.DecayCurveAutomatedStoppingSpec.Builder extends GeneratedMessageV3.Builder<StudySpec.DecayCurveAutomatedStoppingSpec.Builder> implements StudySpec.DecayCurveAutomatedStoppingSpecOrBuilder

The decay curve automated stopping rule builds a Gaussian Process Regressor to predict the final objective value of a Trial based on the already completed Trials and the intermediate measurements of the current Trial. Early stopping is requested for the current Trial if there is very low probability to exceed the optimal value found so far.

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

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public StudySpec.DecayCurveAutomatedStoppingSpec.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
StudySpec.DecayCurveAutomatedStoppingSpec.Builder
Overrides

build()

public StudySpec.DecayCurveAutomatedStoppingSpec build()
Returns
Type Description
StudySpec.DecayCurveAutomatedStoppingSpec

buildPartial()

public StudySpec.DecayCurveAutomatedStoppingSpec buildPartial()
Returns
Type Description
StudySpec.DecayCurveAutomatedStoppingSpec

clear()

public StudySpec.DecayCurveAutomatedStoppingSpec.Builder clear()
Returns
Type Description
StudySpec.DecayCurveAutomatedStoppingSpec.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public StudySpec.DecayCurveAutomatedStoppingSpec.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
StudySpec.DecayCurveAutomatedStoppingSpec.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public StudySpec.DecayCurveAutomatedStoppingSpec.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
StudySpec.DecayCurveAutomatedStoppingSpec.Builder
Overrides

clearUseElapsedDuration()

public StudySpec.DecayCurveAutomatedStoppingSpec.Builder clearUseElapsedDuration()

True if Measurement.elapsed_duration is used as the x-axis of each Trials Decay Curve. Otherwise, Measurement.step_count will be used as the x-axis.

bool use_elapsed_duration = 1;

Returns
Type Description
StudySpec.DecayCurveAutomatedStoppingSpec.Builder

This builder for chaining.

clone()

public StudySpec.DecayCurveAutomatedStoppingSpec.Builder clone()
Returns
Type Description
StudySpec.DecayCurveAutomatedStoppingSpec.Builder
Overrides

getDefaultInstanceForType()

public StudySpec.DecayCurveAutomatedStoppingSpec getDefaultInstanceForType()
Returns
Type Description
StudySpec.DecayCurveAutomatedStoppingSpec

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getUseElapsedDuration()

public boolean getUseElapsedDuration()

True if Measurement.elapsed_duration is used as the x-axis of each Trials Decay Curve. Otherwise, Measurement.step_count will be used as the x-axis.

bool use_elapsed_duration = 1;

Returns
Type Description
boolean

The useElapsedDuration.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(StudySpec.DecayCurveAutomatedStoppingSpec other)

public StudySpec.DecayCurveAutomatedStoppingSpec.Builder mergeFrom(StudySpec.DecayCurveAutomatedStoppingSpec other)
Parameter
Name Description
other StudySpec.DecayCurveAutomatedStoppingSpec
Returns
Type Description
StudySpec.DecayCurveAutomatedStoppingSpec.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public StudySpec.DecayCurveAutomatedStoppingSpec.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
StudySpec.DecayCurveAutomatedStoppingSpec.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public StudySpec.DecayCurveAutomatedStoppingSpec.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
StudySpec.DecayCurveAutomatedStoppingSpec.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final StudySpec.DecayCurveAutomatedStoppingSpec.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
StudySpec.DecayCurveAutomatedStoppingSpec.Builder
Overrides

setField(Descriptors.FieldDescriptor field, Object value)

public StudySpec.DecayCurveAutomatedStoppingSpec.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
StudySpec.DecayCurveAutomatedStoppingSpec.Builder
Overrides

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public StudySpec.DecayCurveAutomatedStoppingSpec.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
StudySpec.DecayCurveAutomatedStoppingSpec.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final StudySpec.DecayCurveAutomatedStoppingSpec.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
StudySpec.DecayCurveAutomatedStoppingSpec.Builder
Overrides

setUseElapsedDuration(boolean value)

public StudySpec.DecayCurveAutomatedStoppingSpec.Builder setUseElapsedDuration(boolean value)

True if Measurement.elapsed_duration is used as the x-axis of each Trials Decay Curve. Otherwise, Measurement.step_count will be used as the x-axis.

bool use_elapsed_duration = 1;

Parameter
Name Description
value boolean

The useElapsedDuration to set.

Returns
Type Description
StudySpec.DecayCurveAutomatedStoppingSpec.Builder

This builder for chaining.