public final class StudySpec extends GeneratedMessageV3 implements StudySpecOrBuilder
Represents specification of a Study.
Protobuf type google.cloud.aiplatform.v1.StudySpec
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
public static final int ALGORITHM_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int CONVEX_AUTOMATED_STOPPING_SPEC_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int DECAY_CURVE_STOPPING_SPEC_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int MEASUREMENT_SELECTION_TYPE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int MEDIAN_AUTOMATED_STOPPING_SPEC_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int METRICS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int OBSERVATION_NOISE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int PARAMETERS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int STUDY_STOPPING_CONFIG_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
public static StudySpec getDefaultInstance()
public static final Descriptors.Descriptor getDescriptor()
public static StudySpec.Builder newBuilder()
public static StudySpec.Builder newBuilder(StudySpec prototype)
| Parameter |
| Name |
Description |
prototype |
StudySpec
|
public static StudySpec parseDelimitedFrom(InputStream input)
public static StudySpec parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static StudySpec parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
public static StudySpec parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static StudySpec parseFrom(ByteString data)
public static StudySpec parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static StudySpec parseFrom(CodedInputStream input)
public static StudySpec parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static StudySpec parseFrom(InputStream input)
public static StudySpec parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static StudySpec parseFrom(ByteBuffer data)
public static StudySpec parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Parser<StudySpec> parser()
Methods
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
public StudySpec.Algorithm getAlgorithm()
The search algorithm specified for the Study.
.google.cloud.aiplatform.v1.StudySpec.Algorithm algorithm = 3;
public int getAlgorithmValue()
The search algorithm specified for the Study.
.google.cloud.aiplatform.v1.StudySpec.Algorithm algorithm = 3;
| Returns |
| Type |
Description |
int |
The enum numeric value on the wire for algorithm.
|
public StudySpec.AutomatedStoppingSpecCase getAutomatedStoppingSpecCase()
public StudySpec.ConvexAutomatedStoppingSpec getConvexAutomatedStoppingSpec()
The automated early stopping spec using convex stopping rule.
.google.cloud.aiplatform.v1.StudySpec.ConvexAutomatedStoppingSpec convex_automated_stopping_spec = 9;
public StudySpec.ConvexAutomatedStoppingSpecOrBuilder getConvexAutomatedStoppingSpecOrBuilder()
The automated early stopping spec using convex stopping rule.
.google.cloud.aiplatform.v1.StudySpec.ConvexAutomatedStoppingSpec convex_automated_stopping_spec = 9;
public StudySpec.DecayCurveAutomatedStoppingSpec getDecayCurveStoppingSpec()
The automated early stopping spec using decay curve rule.
.google.cloud.aiplatform.v1.StudySpec.DecayCurveAutomatedStoppingSpec decay_curve_stopping_spec = 4;
public StudySpec.DecayCurveAutomatedStoppingSpecOrBuilder getDecayCurveStoppingSpecOrBuilder()
The automated early stopping spec using decay curve rule.
.google.cloud.aiplatform.v1.StudySpec.DecayCurveAutomatedStoppingSpec decay_curve_stopping_spec = 4;
public StudySpec getDefaultInstanceForType()
public StudySpec.MeasurementSelectionType getMeasurementSelectionType()
Describe which measurement selection type will be used
.google.cloud.aiplatform.v1.StudySpec.MeasurementSelectionType measurement_selection_type = 7;
public int getMeasurementSelectionTypeValue()
Describe which measurement selection type will be used
.google.cloud.aiplatform.v1.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.v1.StudySpec.MedianAutomatedStoppingSpec median_automated_stopping_spec = 5;
public StudySpec.MedianAutomatedStoppingSpecOrBuilder getMedianAutomatedStoppingSpecOrBuilder()
The automated early stopping spec using median rule.
.google.cloud.aiplatform.v1.StudySpec.MedianAutomatedStoppingSpec median_automated_stopping_spec = 5;
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 |
| Name |
Description |
index |
int
|
public int getMetricsCount()
Required. Metric specs for the Study.
repeated .google.cloud.aiplatform.v1.StudySpec.MetricSpec metrics = 1 [(.google.api.field_behavior) = REQUIRED];
| Returns |
| Type |
Description |
int |
|
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];
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 |
| Name |
Description |
index |
int
|
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 |
| Type |
Description |
List<? extends com.google.cloud.aiplatform.v1.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.v1.StudySpec.ObservationNoise observation_noise = 6;
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 |
| 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.v1.StudySpec.ParameterSpec parameters = 2 [(.google.api.field_behavior) = REQUIRED];
| Parameter |
| Name |
Description |
index |
int
|
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 |
| Type |
Description |
int |
|
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];
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 |
| Name |
Description |
index |
int
|
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 |
| Type |
Description |
List<? extends com.google.cloud.aiplatform.v1.StudySpec.ParameterSpecOrBuilder> |
|
public Parser<StudySpec> getParserForType()
Overrides
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
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;
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;
public boolean hasConvexAutomatedStoppingSpec()
The automated early stopping spec using convex stopping rule.
.google.cloud.aiplatform.v1.StudySpec.ConvexAutomatedStoppingSpec convex_automated_stopping_spec = 9;
| Returns |
| Type |
Description |
boolean |
Whether the convexAutomatedStoppingSpec field is set.
|
public boolean hasDecayCurveStoppingSpec()
The automated early stopping spec using decay curve rule.
.google.cloud.aiplatform.v1.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.v1.StudySpec.MedianAutomatedStoppingSpec median_automated_stopping_spec = 5;
| Returns |
| Type |
Description |
boolean |
Whether the medianAutomatedStoppingSpec field is set.
|
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 |
| Type |
Description |
boolean |
Whether the studyStoppingConfig field is set.
|
| Returns |
| Type |
Description |
int |
|
Overrides
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
public final boolean isInitialized()
Overrides
public StudySpec.Builder newBuilderForType()
protected StudySpec.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
public StudySpec.Builder toBuilder()
public void writeTo(CodedOutputStream output)
Overrides
