- 3.56.0 (latest)
- 3.55.0
- 3.54.0
- 3.53.0
- 3.52.0
- 3.50.0
- 3.49.0
- 3.48.0
- 3.47.0
- 3.46.0
- 3.45.0
- 3.44.0
- 3.43.0
- 3.42.0
- 3.41.0
- 3.40.0
- 3.38.0
- 3.37.0
- 3.36.0
- 3.35.0
- 3.34.0
- 3.33.0
- 3.32.0
- 3.31.0
- 3.30.0
- 3.29.0
- 3.28.0
- 3.25.0
- 3.24.0
- 3.23.0
- 3.22.0
- 3.21.0
- 3.20.0
- 3.19.0
- 3.18.0
- 3.17.0
- 3.16.0
- 3.15.0
- 3.14.0
- 3.13.0
- 3.12.0
- 3.11.0
- 3.10.0
- 3.9.0
- 3.8.0
- 3.7.0
- 3.6.0
- 3.5.0
- 3.4.2
- 3.3.0
- 3.2.0
- 3.0.0
- 2.9.8
- 2.8.9
- 2.7.4
- 2.5.3
- 2.4.0
public interface StudySpecOrBuilder extends MessageOrBuilderImplements
MessageOrBuilderMethods
getAlgorithm()
public abstract StudySpec.Algorithm getAlgorithm()The search algorithm specified for the Study.
.google.cloud.aiplatform.v1beta1.StudySpec.Algorithm algorithm = 3;
| Returns | |
|---|---|
| Type | Description |
StudySpec.Algorithm |
The algorithm. |
getAlgorithmValue()
public abstract 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. |
getAutomatedStoppingSpecCase()
public abstract StudySpec.AutomatedStoppingSpecCase getAutomatedStoppingSpecCase()| Returns | |
|---|---|
| Type | Description |
StudySpec.AutomatedStoppingSpecCase |
|
getConvexAutomatedStoppingSpec()
public abstract StudySpec.ConvexAutomatedStoppingSpec getConvexAutomatedStoppingSpec()The automated early stopping spec using convex stopping rule.
.google.cloud.aiplatform.v1beta1.StudySpec.ConvexAutomatedStoppingSpec convex_automated_stopping_spec = 9;
| Returns | |
|---|---|
| Type | Description |
StudySpec.ConvexAutomatedStoppingSpec |
The convexAutomatedStoppingSpec. |
getConvexAutomatedStoppingSpecOrBuilder()
public abstract StudySpec.ConvexAutomatedStoppingSpecOrBuilder getConvexAutomatedStoppingSpecOrBuilder()The automated early stopping spec using convex stopping rule.
.google.cloud.aiplatform.v1beta1.StudySpec.ConvexAutomatedStoppingSpec convex_automated_stopping_spec = 9;
| Returns | |
|---|---|
| Type | Description |
StudySpec.ConvexAutomatedStoppingSpecOrBuilder |
|
getConvexStopConfig() (deprecated)
public abstract StudySpec.ConvexStopConfig getConvexStopConfig()Deprecated. google.cloud.aiplatform.v1beta1.StudySpec.convex_stop_config is deprecated. See google/cloud/aiplatform/v1beta1/study.proto;l=693
Deprecated. The automated early stopping using convex stopping rule.
.google.cloud.aiplatform.v1beta1.StudySpec.ConvexStopConfig convex_stop_config = 8 [deprecated = true];
| Returns | |
|---|---|
| Type | Description |
StudySpec.ConvexStopConfig |
The convexStopConfig. |
getConvexStopConfigOrBuilder() (deprecated)
public abstract 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 | |
|---|---|
| Type | Description |
StudySpec.ConvexStopConfigOrBuilder |
|
getDecayCurveStoppingSpec()
public abstract StudySpec.DecayCurveAutomatedStoppingSpec getDecayCurveStoppingSpec()The automated early stopping spec using decay curve rule.
.google.cloud.aiplatform.v1beta1.StudySpec.DecayCurveAutomatedStoppingSpec decay_curve_stopping_spec = 4;
| Returns | |
|---|---|
| Type | Description |
StudySpec.DecayCurveAutomatedStoppingSpec |
The decayCurveStoppingSpec. |
getDecayCurveStoppingSpecOrBuilder()
public abstract StudySpec.DecayCurveAutomatedStoppingSpecOrBuilder getDecayCurveStoppingSpecOrBuilder()The automated early stopping spec using decay curve rule.
.google.cloud.aiplatform.v1beta1.StudySpec.DecayCurveAutomatedStoppingSpec decay_curve_stopping_spec = 4;
| Returns | |
|---|---|
| Type | Description |
StudySpec.DecayCurveAutomatedStoppingSpecOrBuilder |
|
getMeasurementSelectionType()
public abstract StudySpec.MeasurementSelectionType getMeasurementSelectionType()Describe which measurement selection type will be used
.google.cloud.aiplatform.v1beta1.StudySpec.MeasurementSelectionType measurement_selection_type = 7;
| Returns | |
|---|---|
| Type | Description |
StudySpec.MeasurementSelectionType |
The measurementSelectionType. |
getMeasurementSelectionTypeValue()
public abstract 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. |
getMedianAutomatedStoppingSpec()
public abstract StudySpec.MedianAutomatedStoppingSpec getMedianAutomatedStoppingSpec()The automated early stopping spec using median rule.
.google.cloud.aiplatform.v1beta1.StudySpec.MedianAutomatedStoppingSpec median_automated_stopping_spec = 5;
| Returns | |
|---|---|
| Type | Description |
StudySpec.MedianAutomatedStoppingSpec |
The medianAutomatedStoppingSpec. |
getMedianAutomatedStoppingSpecOrBuilder()
public abstract StudySpec.MedianAutomatedStoppingSpecOrBuilder getMedianAutomatedStoppingSpecOrBuilder()The automated early stopping spec using median rule.
.google.cloud.aiplatform.v1beta1.StudySpec.MedianAutomatedStoppingSpec median_automated_stopping_spec = 5;
| Returns | |
|---|---|
| Type | Description |
StudySpec.MedianAutomatedStoppingSpecOrBuilder |
|
getMetrics(int index)
public abstract 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 | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
StudySpec.MetricSpec |
|
getMetricsCount()
public abstract int getMetricsCount()Required. Metric specs for the Study.
repeated .google.cloud.aiplatform.v1beta1.StudySpec.MetricSpec metrics = 1 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
int |
|
getMetricsList()
public abstract 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 | |
|---|---|
| Type | Description |
List<MetricSpec> |
|
getMetricsOrBuilder(int index)
public abstract 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 | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
StudySpec.MetricSpecOrBuilder |
|
getMetricsOrBuilderList()
public abstract 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> |
|
getObservationNoise()
public abstract 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 | |
|---|---|
| Type | Description |
StudySpec.ObservationNoise |
The observationNoise. |
getObservationNoiseValue()
public abstract 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. |
getParameters(int index)
public abstract 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 | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
StudySpec.ParameterSpec |
|
getParametersCount()
public abstract int getParametersCount()Required. The set of parameters to tune.
repeated .google.cloud.aiplatform.v1beta1.StudySpec.ParameterSpec parameters = 2 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
int |
|
getParametersList()
public abstract 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 | |
|---|---|
| Type | Description |
List<ParameterSpec> |
|
getParametersOrBuilder(int index)
public abstract 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 | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
StudySpec.ParameterSpecOrBuilder |
|
getParametersOrBuilderList()
public abstract 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> |
|
getStudyStoppingConfig()
public abstract StudySpec.StudyStoppingConfig getStudyStoppingConfig()Conditions for automated stopping of a Study. Enable automated stopping by configuring at least one condition.
optional .google.cloud.aiplatform.v1beta1.StudySpec.StudyStoppingConfig study_stopping_config = 11;
| Returns | |
|---|---|
| Type | Description |
StudySpec.StudyStoppingConfig |
The studyStoppingConfig. |
getStudyStoppingConfigOrBuilder()
public abstract StudySpec.StudyStoppingConfigOrBuilder getStudyStoppingConfigOrBuilder()Conditions for automated stopping of a Study. Enable automated stopping by configuring at least one condition.
optional .google.cloud.aiplatform.v1beta1.StudySpec.StudyStoppingConfig study_stopping_config = 11;
| Returns | |
|---|---|
| Type | Description |
StudySpec.StudyStoppingConfigOrBuilder |
|
getTransferLearningConfig()
public abstract StudySpec.TransferLearningConfig getTransferLearningConfig()The configuration info/options for transfer learning. Currently supported for Vertex AI Vizier service, not HyperParameterTuningJob
.google.cloud.aiplatform.v1beta1.StudySpec.TransferLearningConfig transfer_learning_config = 10;
| Returns | |
|---|---|
| Type | Description |
StudySpec.TransferLearningConfig |
The transferLearningConfig. |
getTransferLearningConfigOrBuilder()
public abstract StudySpec.TransferLearningConfigOrBuilder getTransferLearningConfigOrBuilder()The configuration info/options for transfer learning. Currently supported for Vertex AI Vizier service, not HyperParameterTuningJob
.google.cloud.aiplatform.v1beta1.StudySpec.TransferLearningConfig transfer_learning_config = 10;
| Returns | |
|---|---|
| Type | Description |
StudySpec.TransferLearningConfigOrBuilder |
|
hasConvexAutomatedStoppingSpec()
public abstract 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. |
hasConvexStopConfig() (deprecated)
public abstract boolean hasConvexStopConfig()Deprecated. google.cloud.aiplatform.v1beta1.StudySpec.convex_stop_config is deprecated. See google/cloud/aiplatform/v1beta1/study.proto;l=693
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. |
hasDecayCurveStoppingSpec()
public abstract 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. |
hasMedianAutomatedStoppingSpec()
public abstract 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. |
hasStudyStoppingConfig()
public abstract boolean hasStudyStoppingConfig()Conditions for automated stopping of a Study. Enable automated stopping by configuring at least one condition.
optional .google.cloud.aiplatform.v1beta1.StudySpec.StudyStoppingConfig study_stopping_config = 11;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the studyStoppingConfig field is set. |
hasTransferLearningConfig()
public abstract boolean hasTransferLearningConfig()The configuration info/options for transfer learning. Currently supported for Vertex AI Vizier service, not HyperParameterTuningJob
.google.cloud.aiplatform.v1beta1.StudySpec.TransferLearningConfig transfer_learning_config = 10;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the transferLearningConfig field is set. |