Class StudySpec.MedianAutomatedStoppingSpec (3.8.0)

public static final class StudySpec.MedianAutomatedStoppingSpec extends GeneratedMessageV3 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

Inheritance

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

Static Fields

USE_ELAPSED_DURATION_FIELD_NUMBER

public static final int USE_ELAPSED_DURATION_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

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

getDescriptor()

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

newBuilder()

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

newBuilder(StudySpec.MedianAutomatedStoppingSpec prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getDefaultInstanceForType()

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

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
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.

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.MedianAutomatedStoppingSpec.Builder newBuilderForType()
Returns
TypeDescription
StudySpec.MedianAutomatedStoppingSpec.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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