Class StudySpec.MedianAutomatedStoppingSpec (3.56.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.v1.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
Type Description
int

Static Methods

getDefaultInstance()

public static StudySpec.MedianAutomatedStoppingSpec getDefaultInstance()
Returns
Type Description
StudySpec.MedianAutomatedStoppingSpec

getDescriptor()

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

newBuilder()

public static StudySpec.MedianAutomatedStoppingSpec.Builder newBuilder()
Returns
Type Description
StudySpec.MedianAutomatedStoppingSpec.Builder

newBuilder(StudySpec.MedianAutomatedStoppingSpec prototype)

public static StudySpec.MedianAutomatedStoppingSpec.Builder newBuilder(StudySpec.MedianAutomatedStoppingSpec prototype)
Parameter
Name Description
prototype StudySpec.MedianAutomatedStoppingSpec
Returns
Type Description
StudySpec.MedianAutomatedStoppingSpec.Builder

parseDelimitedFrom(InputStream input)

public static StudySpec.MedianAutomatedStoppingSpec parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
StudySpec.MedianAutomatedStoppingSpec
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static StudySpec.MedianAutomatedStoppingSpec parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
StudySpec.MedianAutomatedStoppingSpec
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static StudySpec.MedianAutomatedStoppingSpec parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
StudySpec.MedianAutomatedStoppingSpec
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static StudySpec.MedianAutomatedStoppingSpec parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
StudySpec.MedianAutomatedStoppingSpec
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static StudySpec.MedianAutomatedStoppingSpec parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
StudySpec.MedianAutomatedStoppingSpec
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static StudySpec.MedianAutomatedStoppingSpec parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
StudySpec.MedianAutomatedStoppingSpec
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static StudySpec.MedianAutomatedStoppingSpec parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
StudySpec.MedianAutomatedStoppingSpec
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static StudySpec.MedianAutomatedStoppingSpec parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
StudySpec.MedianAutomatedStoppingSpec
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static StudySpec.MedianAutomatedStoppingSpec parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
StudySpec.MedianAutomatedStoppingSpec
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static StudySpec.MedianAutomatedStoppingSpec parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
StudySpec.MedianAutomatedStoppingSpec
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static StudySpec.MedianAutomatedStoppingSpec parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
StudySpec.MedianAutomatedStoppingSpec
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static StudySpec.MedianAutomatedStoppingSpec parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
StudySpec.MedianAutomatedStoppingSpec
Exceptions
Type Description
InvalidProtocolBufferException

parser()

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

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

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

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
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
Type Description
boolean

The useElapsedDuration.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public StudySpec.MedianAutomatedStoppingSpec.Builder newBuilderForType()
Returns
Type Description
StudySpec.MedianAutomatedStoppingSpec.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected StudySpec.MedianAutomatedStoppingSpec.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
StudySpec.MedianAutomatedStoppingSpec.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public StudySpec.MedianAutomatedStoppingSpec.Builder toBuilder()
Returns
Type Description
StudySpec.MedianAutomatedStoppingSpec.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException