public final class StudySpec extends GeneratedMessageV3 implements StudySpecOrBuilder
Represents specification of a Study.
Protobuf type google.cloud.aiplatform.v1beta1.StudySpec
Static Fields
public static final int ALGORITHM_FIELD_NUMBER
Field Value
public static final int CONVEX_AUTOMATED_STOPPING_SPEC_FIELD_NUMBER
Field Value
public static final int CONVEX_STOP_CONFIG_FIELD_NUMBER
Field Value
public static final int DECAY_CURVE_STOPPING_SPEC_FIELD_NUMBER
Field Value
public static final int MEASUREMENT_SELECTION_TYPE_FIELD_NUMBER
Field Value
public static final int MEDIAN_AUTOMATED_STOPPING_SPEC_FIELD_NUMBER
Field Value
public static final int METRICS_FIELD_NUMBER
Field Value
public static final int OBSERVATION_NOISE_FIELD_NUMBER
Field Value
public static final int PARAMETERS_FIELD_NUMBER
Field Value
Static Methods
public static StudySpec getDefaultInstance()
Returns
public static final Descriptors.Descriptor getDescriptor()
Returns
public static StudySpec.Builder newBuilder()
Returns
public static StudySpec.Builder newBuilder(StudySpec prototype)
Parameter
Returns
public static StudySpec parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static StudySpec parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static StudySpec parseFrom(byte[] data)
Parameter
Name | Description |
data | byte[]
|
Returns
Exceptions
public static StudySpec parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static StudySpec parseFrom(ByteString data)
Parameter
Returns
Exceptions
public static StudySpec parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static StudySpec parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static StudySpec parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static StudySpec parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static StudySpec parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static StudySpec parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
public static StudySpec parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static Parser<StudySpec> parser()
Returns
Methods
public boolean equals(Object obj)
Parameter
Returns
Overrides
public StudySpec.Algorithm getAlgorithm()
The search algorithm specified for the Study.
.google.cloud.aiplatform.v1beta1.StudySpec.Algorithm algorithm = 3;
Returns
public int getAlgorithmValue()
The search algorithm specified for the Study.
.google.cloud.aiplatform.v1beta1.StudySpec.Algorithm algorithm = 3;
Returns
Type | Description |
int | The enum numeric value on the wire for algorithm.
|
public StudySpec.AutomatedStoppingSpecCase getAutomatedStoppingSpecCase()
Returns
public StudySpec.ConvexAutomatedStoppingSpec getConvexAutomatedStoppingSpec()
The automated early stopping spec using convex stopping rule.
.google.cloud.aiplatform.v1beta1.StudySpec.ConvexAutomatedStoppingSpec convex_automated_stopping_spec = 9;
Returns
public StudySpec.ConvexAutomatedStoppingSpecOrBuilder getConvexAutomatedStoppingSpecOrBuilder()
The automated early stopping spec using convex stopping rule.
.google.cloud.aiplatform.v1beta1.StudySpec.ConvexAutomatedStoppingSpec convex_automated_stopping_spec = 9;
Returns
public StudySpec.ConvexStopConfig getConvexStopConfig()
Deprecated. google.cloud.aiplatform.v1beta1.StudySpec.convex_stop_config is deprecated. See
google/cloud/aiplatform/v1beta1/study.proto;l=553
Deprecated.
The automated early stopping using convex stopping rule.
.google.cloud.aiplatform.v1beta1.StudySpec.ConvexStopConfig convex_stop_config = 8 [deprecated = true];
Returns
public StudySpec.ConvexStopConfigOrBuilder getConvexStopConfigOrBuilder()
Deprecated.
The automated early stopping using convex stopping rule.
.google.cloud.aiplatform.v1beta1.StudySpec.ConvexStopConfig convex_stop_config = 8 [deprecated = true];
Returns
public StudySpec.DecayCurveAutomatedStoppingSpec getDecayCurveStoppingSpec()
The automated early stopping spec using decay curve rule.
.google.cloud.aiplatform.v1beta1.StudySpec.DecayCurveAutomatedStoppingSpec decay_curve_stopping_spec = 4;
Returns
public StudySpec.DecayCurveAutomatedStoppingSpecOrBuilder getDecayCurveStoppingSpecOrBuilder()
The automated early stopping spec using decay curve rule.
.google.cloud.aiplatform.v1beta1.StudySpec.DecayCurveAutomatedStoppingSpec decay_curve_stopping_spec = 4;
Returns
public StudySpec getDefaultInstanceForType()
Returns
public StudySpec.MeasurementSelectionType getMeasurementSelectionType()
Describe which measurement selection type will be used
.google.cloud.aiplatform.v1beta1.StudySpec.MeasurementSelectionType measurement_selection_type = 7;
Returns
public int getMeasurementSelectionTypeValue()
Describe which measurement selection type will be used
.google.cloud.aiplatform.v1beta1.StudySpec.MeasurementSelectionType measurement_selection_type = 7;
Returns
Type | Description |
int | The enum numeric value on the wire for measurementSelectionType.
|
public StudySpec.MedianAutomatedStoppingSpec getMedianAutomatedStoppingSpec()
The automated early stopping spec using median rule.
.google.cloud.aiplatform.v1beta1.StudySpec.MedianAutomatedStoppingSpec median_automated_stopping_spec = 5;
Returns
public StudySpec.MedianAutomatedStoppingSpecOrBuilder getMedianAutomatedStoppingSpecOrBuilder()
The automated early stopping spec using median rule.
.google.cloud.aiplatform.v1beta1.StudySpec.MedianAutomatedStoppingSpec median_automated_stopping_spec = 5;
Returns
public StudySpec.MetricSpec getMetrics(int index)
Required. Metric specs for the Study.
repeated .google.cloud.aiplatform.v1beta1.StudySpec.MetricSpec metrics = 1 [(.google.api.field_behavior) = REQUIRED];
Parameter
Returns
public int getMetricsCount()
Required. Metric specs for the Study.
repeated .google.cloud.aiplatform.v1beta1.StudySpec.MetricSpec metrics = 1 [(.google.api.field_behavior) = REQUIRED];
Returns
public List<StudySpec.MetricSpec> getMetricsList()
Required. Metric specs for the Study.
repeated .google.cloud.aiplatform.v1beta1.StudySpec.MetricSpec metrics = 1 [(.google.api.field_behavior) = REQUIRED];
Returns
public StudySpec.MetricSpecOrBuilder getMetricsOrBuilder(int index)
Required. Metric specs for the Study.
repeated .google.cloud.aiplatform.v1beta1.StudySpec.MetricSpec metrics = 1 [(.google.api.field_behavior) = REQUIRED];
Parameter
Returns
public List<? extends StudySpec.MetricSpecOrBuilder> getMetricsOrBuilderList()
Required. Metric specs for the Study.
repeated .google.cloud.aiplatform.v1beta1.StudySpec.MetricSpec metrics = 1 [(.google.api.field_behavior) = REQUIRED];
Returns
Type | Description |
List<? extends com.google.cloud.aiplatform.v1beta1.StudySpec.MetricSpecOrBuilder> | |
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.v1beta1.StudySpec.ObservationNoise observation_noise = 6;
Returns
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.v1beta1.StudySpec.ObservationNoise observation_noise = 6;
Returns
Type | Description |
int | The enum numeric value on the wire for observationNoise.
|
public StudySpec.ParameterSpec getParameters(int index)
Required. The set of parameters to tune.
repeated .google.cloud.aiplatform.v1beta1.StudySpec.ParameterSpec parameters = 2 [(.google.api.field_behavior) = REQUIRED];
Parameter
Returns
public int getParametersCount()
Required. The set of parameters to tune.
repeated .google.cloud.aiplatform.v1beta1.StudySpec.ParameterSpec parameters = 2 [(.google.api.field_behavior) = REQUIRED];
Returns
public List<StudySpec.ParameterSpec> getParametersList()
Required. The set of parameters to tune.
repeated .google.cloud.aiplatform.v1beta1.StudySpec.ParameterSpec parameters = 2 [(.google.api.field_behavior) = REQUIRED];
Returns
public StudySpec.ParameterSpecOrBuilder getParametersOrBuilder(int index)
Required. The set of parameters to tune.
repeated .google.cloud.aiplatform.v1beta1.StudySpec.ParameterSpec parameters = 2 [(.google.api.field_behavior) = REQUIRED];
Parameter
Returns
public List<? extends StudySpec.ParameterSpecOrBuilder> getParametersOrBuilderList()
Required. The set of parameters to tune.
repeated .google.cloud.aiplatform.v1beta1.StudySpec.ParameterSpec parameters = 2 [(.google.api.field_behavior) = REQUIRED];
Returns
Type | Description |
List<? extends com.google.cloud.aiplatform.v1beta1.StudySpec.ParameterSpecOrBuilder> | |
public Parser<StudySpec> getParserForType()
Returns
Overrides
public int getSerializedSize()
Returns
Overrides
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
public boolean hasConvexAutomatedStoppingSpec()
The automated early stopping spec using convex stopping rule.
.google.cloud.aiplatform.v1beta1.StudySpec.ConvexAutomatedStoppingSpec convex_automated_stopping_spec = 9;
Returns
Type | Description |
boolean | Whether the convexAutomatedStoppingSpec field is set.
|
public boolean hasConvexStopConfig()
Deprecated. google.cloud.aiplatform.v1beta1.StudySpec.convex_stop_config is deprecated. See
google/cloud/aiplatform/v1beta1/study.proto;l=553
Deprecated.
The automated early stopping using convex stopping rule.
.google.cloud.aiplatform.v1beta1.StudySpec.ConvexStopConfig convex_stop_config = 8 [deprecated = true];
Returns
Type | Description |
boolean | Whether the convexStopConfig field is set.
|
public boolean hasDecayCurveStoppingSpec()
The automated early stopping spec using decay curve rule.
.google.cloud.aiplatform.v1beta1.StudySpec.DecayCurveAutomatedStoppingSpec decay_curve_stopping_spec = 4;
Returns
Type | Description |
boolean | Whether the decayCurveStoppingSpec field is set.
|
public boolean hasMedianAutomatedStoppingSpec()
The automated early stopping spec using median rule.
.google.cloud.aiplatform.v1beta1.StudySpec.MedianAutomatedStoppingSpec median_automated_stopping_spec = 5;
Returns
Type | Description |
boolean | Whether the medianAutomatedStoppingSpec field is set.
|
Returns
Overrides
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
public final boolean isInitialized()
Returns
Overrides
public StudySpec.Builder newBuilderForType()
Returns
protected StudySpec.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
public StudySpec.Builder toBuilder()
Returns
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions