Class StudySpec.MedianAutomatedStoppingSpec.Builder (3.34.0)

public static final class StudySpec.MedianAutomatedStoppingSpec.Builder extends GeneratedMessageV3.Builder<StudySpec.MedianAutomatedStoppingSpec.Builder> implements StudySpec.MedianAutomatedStoppingSpecOrBuilder

The median automated stopping rule stops a pending Trial if the Trial's best objective_value is strictly below the median 'performance' of all completed Trials reported up to the Trial's last measurement. Currently, 'performance' refers to the running average of the objective values reported by the Trial in each measurement.

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

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public StudySpec.MedianAutomatedStoppingSpec.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
StudySpec.MedianAutomatedStoppingSpec.Builder
Overrides

build()

public StudySpec.MedianAutomatedStoppingSpec build()
Returns
TypeDescription
StudySpec.MedianAutomatedStoppingSpec

buildPartial()

public StudySpec.MedianAutomatedStoppingSpec buildPartial()
Returns
TypeDescription
StudySpec.MedianAutomatedStoppingSpec

clear()

public StudySpec.MedianAutomatedStoppingSpec.Builder clear()
Returns
TypeDescription
StudySpec.MedianAutomatedStoppingSpec.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public StudySpec.MedianAutomatedStoppingSpec.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
StudySpec.MedianAutomatedStoppingSpec.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public StudySpec.MedianAutomatedStoppingSpec.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
StudySpec.MedianAutomatedStoppingSpec.Builder
Overrides

clearUseElapsedDuration()

public StudySpec.MedianAutomatedStoppingSpec.Builder clearUseElapsedDuration()

True if median automated stopping rule applies on Measurement.elapsed_duration. It means that elapsed_duration field of latest measurement of current Trial is used to compute median objective value for each completed Trials.

bool use_elapsed_duration = 1;

Returns
TypeDescription
StudySpec.MedianAutomatedStoppingSpec.Builder

This builder for chaining.

clone()

public StudySpec.MedianAutomatedStoppingSpec.Builder clone()
Returns
TypeDescription
StudySpec.MedianAutomatedStoppingSpec.Builder
Overrides

getDefaultInstanceForType()

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

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getUseElapsedDuration()

public boolean getUseElapsedDuration()

True if median automated stopping rule applies on Measurement.elapsed_duration. It means that elapsed_duration field of latest measurement of current Trial is used to compute median objective value for each completed Trials.

bool use_elapsed_duration = 1;

Returns
TypeDescription
boolean

The useElapsedDuration.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(StudySpec.MedianAutomatedStoppingSpec other)

public StudySpec.MedianAutomatedStoppingSpec.Builder mergeFrom(StudySpec.MedianAutomatedStoppingSpec other)
Parameter
NameDescription
otherStudySpec.MedianAutomatedStoppingSpec
Returns
TypeDescription
StudySpec.MedianAutomatedStoppingSpec.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public StudySpec.MedianAutomatedStoppingSpec.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
StudySpec.MedianAutomatedStoppingSpec.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public StudySpec.MedianAutomatedStoppingSpec.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
StudySpec.MedianAutomatedStoppingSpec.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final StudySpec.MedianAutomatedStoppingSpec.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
StudySpec.MedianAutomatedStoppingSpec.Builder
Overrides

setField(Descriptors.FieldDescriptor field, Object value)

public StudySpec.MedianAutomatedStoppingSpec.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
StudySpec.MedianAutomatedStoppingSpec.Builder
Overrides

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

public StudySpec.MedianAutomatedStoppingSpec.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
StudySpec.MedianAutomatedStoppingSpec.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final StudySpec.MedianAutomatedStoppingSpec.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
StudySpec.MedianAutomatedStoppingSpec.Builder
Overrides

setUseElapsedDuration(boolean value)

public StudySpec.MedianAutomatedStoppingSpec.Builder setUseElapsedDuration(boolean value)

True if median automated stopping rule applies on Measurement.elapsed_duration. It means that elapsed_duration field of latest measurement of current Trial is used to compute median objective value for each completed Trials.

bool use_elapsed_duration = 1;

Parameter
NameDescription
valueboolean

The useElapsedDuration to set.

Returns
TypeDescription
StudySpec.MedianAutomatedStoppingSpec.Builder

This builder for chaining.