Class StudySpec (3.36.0)

public final class StudySpec extends GeneratedMessageV3 implements StudySpecOrBuilder

Represents specification of a Study.

Protobuf type google.cloud.aiplatform.v1.StudySpec

Implements

StudySpecOrBuilder

Static Fields

ALGORITHM_FIELD_NUMBER

public static final int ALGORITHM_FIELD_NUMBER
Field Value
TypeDescription
int

CONVEX_AUTOMATED_STOPPING_SPEC_FIELD_NUMBER

public static final int CONVEX_AUTOMATED_STOPPING_SPEC_FIELD_NUMBER
Field Value
TypeDescription
int

DECAY_CURVE_STOPPING_SPEC_FIELD_NUMBER

public static final int DECAY_CURVE_STOPPING_SPEC_FIELD_NUMBER
Field Value
TypeDescription
int

MEASUREMENT_SELECTION_TYPE_FIELD_NUMBER

public static final int MEASUREMENT_SELECTION_TYPE_FIELD_NUMBER
Field Value
TypeDescription
int

MEDIAN_AUTOMATED_STOPPING_SPEC_FIELD_NUMBER

public static final int MEDIAN_AUTOMATED_STOPPING_SPEC_FIELD_NUMBER
Field Value
TypeDescription
int

METRICS_FIELD_NUMBER

public static final int METRICS_FIELD_NUMBER
Field Value
TypeDescription
int

OBSERVATION_NOISE_FIELD_NUMBER

public static final int OBSERVATION_NOISE_FIELD_NUMBER
Field Value
TypeDescription
int

PARAMETERS_FIELD_NUMBER

public static final int PARAMETERS_FIELD_NUMBER
Field Value
TypeDescription
int

STUDY_STOPPING_CONFIG_FIELD_NUMBER

public static final int STUDY_STOPPING_CONFIG_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static StudySpec getDefaultInstance()
Returns
TypeDescription
StudySpec

getDescriptor()

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

newBuilder()

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

newBuilder(StudySpec prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getAlgorithm()

public StudySpec.Algorithm getAlgorithm()

The search algorithm specified for the Study.

.google.cloud.aiplatform.v1.StudySpec.Algorithm algorithm = 3;

Returns
TypeDescription
StudySpec.Algorithm

The algorithm.

getAlgorithmValue()

public int getAlgorithmValue()

The search algorithm specified for the Study.

.google.cloud.aiplatform.v1.StudySpec.Algorithm algorithm = 3;

Returns
TypeDescription
int

The enum numeric value on the wire for algorithm.

getAutomatedStoppingSpecCase()

public StudySpec.AutomatedStoppingSpecCase getAutomatedStoppingSpecCase()
Returns
TypeDescription
StudySpec.AutomatedStoppingSpecCase

getConvexAutomatedStoppingSpec()

public StudySpec.ConvexAutomatedStoppingSpec getConvexAutomatedStoppingSpec()

The automated early stopping spec using convex stopping rule.

.google.cloud.aiplatform.v1.StudySpec.ConvexAutomatedStoppingSpec convex_automated_stopping_spec = 9;

Returns
TypeDescription
StudySpec.ConvexAutomatedStoppingSpec

The convexAutomatedStoppingSpec.

getConvexAutomatedStoppingSpecOrBuilder()

public StudySpec.ConvexAutomatedStoppingSpecOrBuilder getConvexAutomatedStoppingSpecOrBuilder()

The automated early stopping spec using convex stopping rule.

.google.cloud.aiplatform.v1.StudySpec.ConvexAutomatedStoppingSpec convex_automated_stopping_spec = 9;

Returns
TypeDescription
StudySpec.ConvexAutomatedStoppingSpecOrBuilder

getDecayCurveStoppingSpec()

public StudySpec.DecayCurveAutomatedStoppingSpec getDecayCurveStoppingSpec()

The automated early stopping spec using decay curve rule.

.google.cloud.aiplatform.v1.StudySpec.DecayCurveAutomatedStoppingSpec decay_curve_stopping_spec = 4;

Returns
TypeDescription
StudySpec.DecayCurveAutomatedStoppingSpec

The decayCurveStoppingSpec.

getDecayCurveStoppingSpecOrBuilder()

public StudySpec.DecayCurveAutomatedStoppingSpecOrBuilder getDecayCurveStoppingSpecOrBuilder()

The automated early stopping spec using decay curve rule.

.google.cloud.aiplatform.v1.StudySpec.DecayCurveAutomatedStoppingSpec decay_curve_stopping_spec = 4;

Returns
TypeDescription
StudySpec.DecayCurveAutomatedStoppingSpecOrBuilder

getDefaultInstanceForType()

public StudySpec getDefaultInstanceForType()
Returns
TypeDescription
StudySpec

getMeasurementSelectionType()

public StudySpec.MeasurementSelectionType getMeasurementSelectionType()

Describe which measurement selection type will be used

.google.cloud.aiplatform.v1.StudySpec.MeasurementSelectionType measurement_selection_type = 7;

Returns
TypeDescription
StudySpec.MeasurementSelectionType

The measurementSelectionType.

getMeasurementSelectionTypeValue()

public int getMeasurementSelectionTypeValue()

Describe which measurement selection type will be used

.google.cloud.aiplatform.v1.StudySpec.MeasurementSelectionType measurement_selection_type = 7;

Returns
TypeDescription
int

The enum numeric value on the wire for measurementSelectionType.

getMedianAutomatedStoppingSpec()

public StudySpec.MedianAutomatedStoppingSpec getMedianAutomatedStoppingSpec()

The automated early stopping spec using median rule.

.google.cloud.aiplatform.v1.StudySpec.MedianAutomatedStoppingSpec median_automated_stopping_spec = 5;

Returns
TypeDescription
StudySpec.MedianAutomatedStoppingSpec

The medianAutomatedStoppingSpec.

getMedianAutomatedStoppingSpecOrBuilder()

public StudySpec.MedianAutomatedStoppingSpecOrBuilder getMedianAutomatedStoppingSpecOrBuilder()

The automated early stopping spec using median rule.

.google.cloud.aiplatform.v1.StudySpec.MedianAutomatedStoppingSpec median_automated_stopping_spec = 5;

Returns
TypeDescription
StudySpec.MedianAutomatedStoppingSpecOrBuilder

getMetrics(int index)

public StudySpec.MetricSpec getMetrics(int index)

Required. Metric specs for the Study.

repeated .google.cloud.aiplatform.v1.StudySpec.MetricSpec metrics = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
NameDescription
indexint
Returns
TypeDescription
StudySpec.MetricSpec

getMetricsCount()

public int getMetricsCount()

Required. Metric specs for the Study.

repeated .google.cloud.aiplatform.v1.StudySpec.MetricSpec metrics = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
int

getMetricsList()

public List<StudySpec.MetricSpec> getMetricsList()

Required. Metric specs for the Study.

repeated .google.cloud.aiplatform.v1.StudySpec.MetricSpec metrics = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
List<MetricSpec>

getMetricsOrBuilder(int index)

public StudySpec.MetricSpecOrBuilder getMetricsOrBuilder(int index)

Required. Metric specs for the Study.

repeated .google.cloud.aiplatform.v1.StudySpec.MetricSpec metrics = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
NameDescription
indexint
Returns
TypeDescription
StudySpec.MetricSpecOrBuilder

getMetricsOrBuilderList()

public List<? extends StudySpec.MetricSpecOrBuilder> getMetricsOrBuilderList()

Required. Metric specs for the Study.

repeated .google.cloud.aiplatform.v1.StudySpec.MetricSpec metrics = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
List<? extends com.google.cloud.aiplatform.v1.StudySpec.MetricSpecOrBuilder>

getObservationNoise()

public StudySpec.ObservationNoise getObservationNoise()

The observation noise level of the study. Currently only supported by the Vertex AI Vizier service. Not supported by HyperparameterTuningJob or TrainingPipeline.

.google.cloud.aiplatform.v1.StudySpec.ObservationNoise observation_noise = 6;

Returns
TypeDescription
StudySpec.ObservationNoise

The observationNoise.

getObservationNoiseValue()

public int getObservationNoiseValue()

The observation noise level of the study. Currently only supported by the Vertex AI Vizier service. Not supported by HyperparameterTuningJob or TrainingPipeline.

.google.cloud.aiplatform.v1.StudySpec.ObservationNoise observation_noise = 6;

Returns
TypeDescription
int

The enum numeric value on the wire for observationNoise.

getParameters(int index)

public StudySpec.ParameterSpec getParameters(int index)

Required. The set of parameters to tune.

repeated .google.cloud.aiplatform.v1.StudySpec.ParameterSpec parameters = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
NameDescription
indexint
Returns
TypeDescription
StudySpec.ParameterSpec

getParametersCount()

public int getParametersCount()

Required. The set of parameters to tune.

repeated .google.cloud.aiplatform.v1.StudySpec.ParameterSpec parameters = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
int

getParametersList()

public List<StudySpec.ParameterSpec> getParametersList()

Required. The set of parameters to tune.

repeated .google.cloud.aiplatform.v1.StudySpec.ParameterSpec parameters = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
List<ParameterSpec>

getParametersOrBuilder(int index)

public StudySpec.ParameterSpecOrBuilder getParametersOrBuilder(int index)

Required. The set of parameters to tune.

repeated .google.cloud.aiplatform.v1.StudySpec.ParameterSpec parameters = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
NameDescription
indexint
Returns
TypeDescription
StudySpec.ParameterSpecOrBuilder

getParametersOrBuilderList()

public List<? extends StudySpec.ParameterSpecOrBuilder> getParametersOrBuilderList()

Required. The set of parameters to tune.

repeated .google.cloud.aiplatform.v1.StudySpec.ParameterSpec parameters = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
List<? extends com.google.cloud.aiplatform.v1.StudySpec.ParameterSpecOrBuilder>

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getStudyStoppingConfig()

public StudySpec.StudyStoppingConfig getStudyStoppingConfig()

Conditions for automated stopping of a Study. Enable automated stopping by configuring at least one condition.

optional .google.cloud.aiplatform.v1.StudySpec.StudyStoppingConfig study_stopping_config = 11;

Returns
TypeDescription
StudySpec.StudyStoppingConfig

The studyStoppingConfig.

getStudyStoppingConfigOrBuilder()

public StudySpec.StudyStoppingConfigOrBuilder getStudyStoppingConfigOrBuilder()

Conditions for automated stopping of a Study. Enable automated stopping by configuring at least one condition.

optional .google.cloud.aiplatform.v1.StudySpec.StudyStoppingConfig study_stopping_config = 11;

Returns
TypeDescription
StudySpec.StudyStoppingConfigOrBuilder

hasConvexAutomatedStoppingSpec()

public boolean hasConvexAutomatedStoppingSpec()

The automated early stopping spec using convex stopping rule.

.google.cloud.aiplatform.v1.StudySpec.ConvexAutomatedStoppingSpec convex_automated_stopping_spec = 9;

Returns
TypeDescription
boolean

Whether the convexAutomatedStoppingSpec field is set.

hasDecayCurveStoppingSpec()

public boolean hasDecayCurveStoppingSpec()

The automated early stopping spec using decay curve rule.

.google.cloud.aiplatform.v1.StudySpec.DecayCurveAutomatedStoppingSpec decay_curve_stopping_spec = 4;

Returns
TypeDescription
boolean

Whether the decayCurveStoppingSpec field is set.

hasMedianAutomatedStoppingSpec()

public boolean hasMedianAutomatedStoppingSpec()

The automated early stopping spec using median rule.

.google.cloud.aiplatform.v1.StudySpec.MedianAutomatedStoppingSpec median_automated_stopping_spec = 5;

Returns
TypeDescription
boolean

Whether the medianAutomatedStoppingSpec field is set.

hasStudyStoppingConfig()

public boolean hasStudyStoppingConfig()

Conditions for automated stopping of a Study. Enable automated stopping by configuring at least one condition.

optional .google.cloud.aiplatform.v1.StudySpec.StudyStoppingConfig study_stopping_config = 11;

Returns
TypeDescription
boolean

Whether the studyStoppingConfig field is set.

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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