- 3.48.0 (latest)
- 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 static final class StudySpec.Builder extends GeneratedMessageV3.Builder<StudySpec.Builder> implements StudySpecOrBuilder
Represents specification of a Study.
Protobuf type google.cloud.aiplatform.v1.StudySpec
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > StudySpec.BuilderImplements
StudySpecOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns | |
---|---|
Type | Description |
Descriptor |
Methods
addAllMetrics(Iterable<? extends StudySpec.MetricSpec> values)
public StudySpec.Builder addAllMetrics(Iterable<? extends StudySpec.MetricSpec> values)
Required. Metric specs for the Study.
repeated .google.cloud.aiplatform.v1.StudySpec.MetricSpec metrics = 1 [(.google.api.field_behavior) = REQUIRED];
Parameter | |
---|---|
Name | Description |
values | Iterable<? extends com.google.cloud.aiplatform.v1.StudySpec.MetricSpec> |
Returns | |
---|---|
Type | Description |
StudySpec.Builder |
addAllParameters(Iterable<? extends StudySpec.ParameterSpec> values)
public StudySpec.Builder addAllParameters(Iterable<? extends StudySpec.ParameterSpec> values)
Required. The set of parameters to tune.
repeated .google.cloud.aiplatform.v1.StudySpec.ParameterSpec parameters = 2 [(.google.api.field_behavior) = REQUIRED];
Parameter | |
---|---|
Name | Description |
values | Iterable<? extends com.google.cloud.aiplatform.v1.StudySpec.ParameterSpec> |
Returns | |
---|---|
Type | Description |
StudySpec.Builder |
addMetrics(StudySpec.MetricSpec value)
public StudySpec.Builder addMetrics(StudySpec.MetricSpec value)
Required. Metric specs for the Study.
repeated .google.cloud.aiplatform.v1.StudySpec.MetricSpec metrics = 1 [(.google.api.field_behavior) = REQUIRED];
Parameter | |
---|---|
Name | Description |
value | StudySpec.MetricSpec |
Returns | |
---|---|
Type | Description |
StudySpec.Builder |
addMetrics(StudySpec.MetricSpec.Builder builderForValue)
public StudySpec.Builder addMetrics(StudySpec.MetricSpec.Builder builderForValue)
Required. Metric specs for the Study.
repeated .google.cloud.aiplatform.v1.StudySpec.MetricSpec metrics = 1 [(.google.api.field_behavior) = REQUIRED];
Parameter | |
---|---|
Name | Description |
builderForValue | StudySpec.MetricSpec.Builder |
Returns | |
---|---|
Type | Description |
StudySpec.Builder |
addMetrics(int index, StudySpec.MetricSpec value)
public StudySpec.Builder addMetrics(int index, StudySpec.MetricSpec value)
Required. Metric specs for the Study.
repeated .google.cloud.aiplatform.v1.StudySpec.MetricSpec metrics = 1 [(.google.api.field_behavior) = REQUIRED];
Parameters | |
---|---|
Name | Description |
index | int |
value | StudySpec.MetricSpec |
Returns | |
---|---|
Type | Description |
StudySpec.Builder |
addMetrics(int index, StudySpec.MetricSpec.Builder builderForValue)
public StudySpec.Builder addMetrics(int index, StudySpec.MetricSpec.Builder builderForValue)
Required. Metric specs for the Study.
repeated .google.cloud.aiplatform.v1.StudySpec.MetricSpec metrics = 1 [(.google.api.field_behavior) = REQUIRED];
Parameters | |
---|---|
Name | Description |
index | int |
builderForValue | StudySpec.MetricSpec.Builder |
Returns | |
---|---|
Type | Description |
StudySpec.Builder |
addMetricsBuilder()
public StudySpec.MetricSpec.Builder addMetricsBuilder()
Required. Metric specs for the Study.
repeated .google.cloud.aiplatform.v1.StudySpec.MetricSpec metrics = 1 [(.google.api.field_behavior) = REQUIRED];
Returns | |
---|---|
Type | Description |
StudySpec.MetricSpec.Builder |
addMetricsBuilder(int index)
public StudySpec.MetricSpec.Builder addMetricsBuilder(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 |
Returns | |
---|---|
Type | Description |
StudySpec.MetricSpec.Builder |
addParameters(StudySpec.ParameterSpec value)
public StudySpec.Builder addParameters(StudySpec.ParameterSpec value)
Required. The set of parameters to tune.
repeated .google.cloud.aiplatform.v1.StudySpec.ParameterSpec parameters = 2 [(.google.api.field_behavior) = REQUIRED];
Parameter | |
---|---|
Name | Description |
value | StudySpec.ParameterSpec |
Returns | |
---|---|
Type | Description |
StudySpec.Builder |
addParameters(StudySpec.ParameterSpec.Builder builderForValue)
public StudySpec.Builder addParameters(StudySpec.ParameterSpec.Builder builderForValue)
Required. The set of parameters to tune.
repeated .google.cloud.aiplatform.v1.StudySpec.ParameterSpec parameters = 2 [(.google.api.field_behavior) = REQUIRED];
Parameter | |
---|---|
Name | Description |
builderForValue | StudySpec.ParameterSpec.Builder |
Returns | |
---|---|
Type | Description |
StudySpec.Builder |
addParameters(int index, StudySpec.ParameterSpec value)
public StudySpec.Builder addParameters(int index, StudySpec.ParameterSpec value)
Required. The set of parameters to tune.
repeated .google.cloud.aiplatform.v1.StudySpec.ParameterSpec parameters = 2 [(.google.api.field_behavior) = REQUIRED];
Parameters | |
---|---|
Name | Description |
index | int |
value | StudySpec.ParameterSpec |
Returns | |
---|---|
Type | Description |
StudySpec.Builder |
addParameters(int index, StudySpec.ParameterSpec.Builder builderForValue)
public StudySpec.Builder addParameters(int index, StudySpec.ParameterSpec.Builder builderForValue)
Required. The set of parameters to tune.
repeated .google.cloud.aiplatform.v1.StudySpec.ParameterSpec parameters = 2 [(.google.api.field_behavior) = REQUIRED];
Parameters | |
---|---|
Name | Description |
index | int |
builderForValue | StudySpec.ParameterSpec.Builder |
Returns | |
---|---|
Type | Description |
StudySpec.Builder |
addParametersBuilder()
public StudySpec.ParameterSpec.Builder addParametersBuilder()
Required. The set of parameters to tune.
repeated .google.cloud.aiplatform.v1.StudySpec.ParameterSpec parameters = 2 [(.google.api.field_behavior) = REQUIRED];
Returns | |
---|---|
Type | Description |
StudySpec.ParameterSpec.Builder |
addParametersBuilder(int index)
public StudySpec.ParameterSpec.Builder addParametersBuilder(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 |
Returns | |
---|---|
Type | Description |
StudySpec.ParameterSpec.Builder |
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public StudySpec.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters | |
---|---|
Name | Description |
field | FieldDescriptor |
value | Object |
Returns | |
---|---|
Type | Description |
StudySpec.Builder |
build()
public StudySpec build()
Returns | |
---|---|
Type | Description |
StudySpec |
buildPartial()
public StudySpec buildPartial()
Returns | |
---|---|
Type | Description |
StudySpec |
clear()
public StudySpec.Builder clear()
Returns | |
---|---|
Type | Description |
StudySpec.Builder |
clearAlgorithm()
public StudySpec.Builder clearAlgorithm()
The search algorithm specified for the Study.
.google.cloud.aiplatform.v1.StudySpec.Algorithm algorithm = 3;
Returns | |
---|---|
Type | Description |
StudySpec.Builder | This builder for chaining. |
clearAutomatedStoppingSpec()
public StudySpec.Builder clearAutomatedStoppingSpec()
Returns | |
---|---|
Type | Description |
StudySpec.Builder |
clearConvexAutomatedStoppingSpec()
public StudySpec.Builder clearConvexAutomatedStoppingSpec()
The automated early stopping spec using convex stopping rule.
.google.cloud.aiplatform.v1.StudySpec.ConvexAutomatedStoppingSpec convex_automated_stopping_spec = 9;
Returns | |
---|---|
Type | Description |
StudySpec.Builder |
clearDecayCurveStoppingSpec()
public StudySpec.Builder clearDecayCurveStoppingSpec()
The automated early stopping spec using decay curve rule.
.google.cloud.aiplatform.v1.StudySpec.DecayCurveAutomatedStoppingSpec decay_curve_stopping_spec = 4;
Returns | |
---|---|
Type | Description |
StudySpec.Builder |
clearField(Descriptors.FieldDescriptor field)
public StudySpec.Builder clearField(Descriptors.FieldDescriptor field)
Parameter | |
---|---|
Name | Description |
field | FieldDescriptor |
Returns | |
---|---|
Type | Description |
StudySpec.Builder |
clearMeasurementSelectionType()
public StudySpec.Builder clearMeasurementSelectionType()
Describe which measurement selection type will be used
.google.cloud.aiplatform.v1.StudySpec.MeasurementSelectionType measurement_selection_type = 7;
Returns | |
---|---|
Type | Description |
StudySpec.Builder | This builder for chaining. |
clearMedianAutomatedStoppingSpec()
public StudySpec.Builder clearMedianAutomatedStoppingSpec()
The automated early stopping spec using median rule.
.google.cloud.aiplatform.v1.StudySpec.MedianAutomatedStoppingSpec median_automated_stopping_spec = 5;
Returns | |
---|---|
Type | Description |
StudySpec.Builder |
clearMetrics()
public StudySpec.Builder clearMetrics()
Required. Metric specs for the Study.
repeated .google.cloud.aiplatform.v1.StudySpec.MetricSpec metrics = 1 [(.google.api.field_behavior) = REQUIRED];
Returns | |
---|---|
Type | Description |
StudySpec.Builder |
clearObservationNoise()
public StudySpec.Builder clearObservationNoise()
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 |
StudySpec.Builder | This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public StudySpec.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter | |
---|---|
Name | Description |
oneof | OneofDescriptor |
Returns | |
---|---|
Type | Description |
StudySpec.Builder |
clearParameters()
public StudySpec.Builder clearParameters()
Required. The set of parameters to tune.
repeated .google.cloud.aiplatform.v1.StudySpec.ParameterSpec parameters = 2 [(.google.api.field_behavior) = REQUIRED];
Returns | |
---|---|
Type | Description |
StudySpec.Builder |
clearStudyStoppingConfig()
public StudySpec.Builder clearStudyStoppingConfig()
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 |
StudySpec.Builder |
clone()
public StudySpec.Builder clone()
Returns | |
---|---|
Type | Description |
StudySpec.Builder |
getAlgorithm()
public StudySpec.Algorithm getAlgorithm()
The search algorithm specified for the Study.
.google.cloud.aiplatform.v1.StudySpec.Algorithm algorithm = 3;
Returns | |
---|---|
Type | Description |
StudySpec.Algorithm | The algorithm. |
getAlgorithmValue()
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. |
getAutomatedStoppingSpecCase()
public StudySpec.AutomatedStoppingSpecCase getAutomatedStoppingSpecCase()
Returns | |
---|---|
Type | Description |
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 | |
---|---|
Type | Description |
StudySpec.ConvexAutomatedStoppingSpec | The convexAutomatedStoppingSpec. |
getConvexAutomatedStoppingSpecBuilder()
public StudySpec.ConvexAutomatedStoppingSpec.Builder getConvexAutomatedStoppingSpecBuilder()
The automated early stopping spec using convex stopping rule.
.google.cloud.aiplatform.v1.StudySpec.ConvexAutomatedStoppingSpec convex_automated_stopping_spec = 9;
Returns | |
---|---|
Type | Description |
StudySpec.ConvexAutomatedStoppingSpec.Builder |
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 | |
---|---|
Type | Description |
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 | |
---|---|
Type | Description |
StudySpec.DecayCurveAutomatedStoppingSpec | The decayCurveStoppingSpec. |
getDecayCurveStoppingSpecBuilder()
public StudySpec.DecayCurveAutomatedStoppingSpec.Builder getDecayCurveStoppingSpecBuilder()
The automated early stopping spec using decay curve rule.
.google.cloud.aiplatform.v1.StudySpec.DecayCurveAutomatedStoppingSpec decay_curve_stopping_spec = 4;
Returns | |
---|---|
Type | Description |
StudySpec.DecayCurveAutomatedStoppingSpec.Builder |
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 | |
---|---|
Type | Description |
StudySpec.DecayCurveAutomatedStoppingSpecOrBuilder |
getDefaultInstanceForType()
public StudySpec getDefaultInstanceForType()
Returns | |
---|---|
Type | Description |
StudySpec |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
Returns | |
---|---|
Type | Description |
Descriptor |
getMeasurementSelectionType()
public StudySpec.MeasurementSelectionType getMeasurementSelectionType()
Describe which measurement selection type will be used
.google.cloud.aiplatform.v1.StudySpec.MeasurementSelectionType measurement_selection_type = 7;
Returns | |
---|---|
Type | Description |
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 | |
---|---|
Type | Description |
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 | |
---|---|
Type | Description |
StudySpec.MedianAutomatedStoppingSpec | The medianAutomatedStoppingSpec. |
getMedianAutomatedStoppingSpecBuilder()
public StudySpec.MedianAutomatedStoppingSpec.Builder getMedianAutomatedStoppingSpecBuilder()
The automated early stopping spec using median rule.
.google.cloud.aiplatform.v1.StudySpec.MedianAutomatedStoppingSpec median_automated_stopping_spec = 5;
Returns | |
---|---|
Type | Description |
StudySpec.MedianAutomatedStoppingSpec.Builder |
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 | |
---|---|
Type | Description |
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 | |
---|---|
Name | Description |
index | int |
Returns | |
---|---|
Type | Description |
StudySpec.MetricSpec |
getMetricsBuilder(int index)
public StudySpec.MetricSpec.Builder getMetricsBuilder(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 |
Returns | |
---|---|
Type | Description |
StudySpec.MetricSpec.Builder |
getMetricsBuilderList()
public List<StudySpec.MetricSpec.Builder> getMetricsBuilderList()
Required. Metric specs for the Study.
repeated .google.cloud.aiplatform.v1.StudySpec.MetricSpec metrics = 1 [(.google.api.field_behavior) = REQUIRED];
Returns | |
---|---|
Type | Description |
List<Builder> |
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 | |
---|---|
Type | Description |
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 | |
---|---|
Type | Description |
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 | |
---|---|
Name | Description |
index | int |
Returns | |
---|---|
Type | Description |
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 | |
---|---|
Type | Description |
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 | |
---|---|
Type | Description |
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 | |
---|---|
Type | Description |
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 | |
---|---|
Name | Description |
index | int |
Returns | |
---|---|
Type | Description |
StudySpec.ParameterSpec |
getParametersBuilder(int index)
public StudySpec.ParameterSpec.Builder getParametersBuilder(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 |
Returns | |
---|---|
Type | Description |
StudySpec.ParameterSpec.Builder |
getParametersBuilderList()
public List<StudySpec.ParameterSpec.Builder> getParametersBuilderList()
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<Builder> |
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 | |
---|---|
Type | Description |
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 | |
---|---|
Type | Description |
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 | |
---|---|
Name | Description |
index | int |
Returns | |
---|---|
Type | Description |
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 | |
---|---|
Type | Description |
List<? extends com.google.cloud.aiplatform.v1.StudySpec.ParameterSpecOrBuilder> |
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 | |
---|---|
Type | Description |
StudySpec.StudyStoppingConfig | The studyStoppingConfig. |
getStudyStoppingConfigBuilder()
public StudySpec.StudyStoppingConfig.Builder getStudyStoppingConfigBuilder()
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 |
StudySpec.StudyStoppingConfig.Builder |
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 | |
---|---|
Type | Description |
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 | |
---|---|
Type | Description |
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 | |
---|---|
Type | Description |
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 | |
---|---|
Type | Description |
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 | |
---|---|
Type | Description |
boolean | Whether the studyStoppingConfig field is set. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns | |
---|---|
Type | Description |
FieldAccessorTable |
isInitialized()
public final boolean isInitialized()
Returns | |
---|---|
Type | Description |
boolean |
mergeConvexAutomatedStoppingSpec(StudySpec.ConvexAutomatedStoppingSpec value)
public StudySpec.Builder mergeConvexAutomatedStoppingSpec(StudySpec.ConvexAutomatedStoppingSpec value)
The automated early stopping spec using convex stopping rule.
.google.cloud.aiplatform.v1.StudySpec.ConvexAutomatedStoppingSpec convex_automated_stopping_spec = 9;
Parameter | |
---|---|
Name | Description |
value | StudySpec.ConvexAutomatedStoppingSpec |
Returns | |
---|---|
Type | Description |
StudySpec.Builder |
mergeDecayCurveStoppingSpec(StudySpec.DecayCurveAutomatedStoppingSpec value)
public StudySpec.Builder mergeDecayCurveStoppingSpec(StudySpec.DecayCurveAutomatedStoppingSpec value)
The automated early stopping spec using decay curve rule.
.google.cloud.aiplatform.v1.StudySpec.DecayCurveAutomatedStoppingSpec decay_curve_stopping_spec = 4;
Parameter | |
---|---|
Name | Description |
value | StudySpec.DecayCurveAutomatedStoppingSpec |
Returns | |
---|---|
Type | Description |
StudySpec.Builder |
mergeFrom(StudySpec other)
public StudySpec.Builder mergeFrom(StudySpec other)
Parameter | |
---|---|
Name | Description |
other | StudySpec |
Returns | |
---|---|
Type | Description |
StudySpec.Builder |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public StudySpec.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input | CodedInputStream |
extensionRegistry | ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
StudySpec.Builder |
Exceptions | |
---|---|
Type | Description |
IOException |
mergeFrom(Message other)
public StudySpec.Builder mergeFrom(Message other)
Parameter | |
---|---|
Name | Description |
other | Message |
Returns | |
---|---|
Type | Description |
StudySpec.Builder |
mergeMedianAutomatedStoppingSpec(StudySpec.MedianAutomatedStoppingSpec value)
public StudySpec.Builder mergeMedianAutomatedStoppingSpec(StudySpec.MedianAutomatedStoppingSpec value)
The automated early stopping spec using median rule.
.google.cloud.aiplatform.v1.StudySpec.MedianAutomatedStoppingSpec median_automated_stopping_spec = 5;
Parameter | |
---|---|
Name | Description |
value | StudySpec.MedianAutomatedStoppingSpec |
Returns | |
---|---|
Type | Description |
StudySpec.Builder |
mergeStudyStoppingConfig(StudySpec.StudyStoppingConfig value)
public StudySpec.Builder mergeStudyStoppingConfig(StudySpec.StudyStoppingConfig value)
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;
Parameter | |
---|---|
Name | Description |
value | StudySpec.StudyStoppingConfig |
Returns | |
---|---|
Type | Description |
StudySpec.Builder |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final StudySpec.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter | |
---|---|
Name | Description |
unknownFields | UnknownFieldSet |
Returns | |
---|---|
Type | Description |
StudySpec.Builder |
removeMetrics(int index)
public StudySpec.Builder removeMetrics(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 |
Returns | |
---|---|
Type | Description |
StudySpec.Builder |
removeParameters(int index)
public StudySpec.Builder removeParameters(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 |
Returns | |
---|---|
Type | Description |
StudySpec.Builder |
setAlgorithm(StudySpec.Algorithm value)
public StudySpec.Builder setAlgorithm(StudySpec.Algorithm value)
The search algorithm specified for the Study.
.google.cloud.aiplatform.v1.StudySpec.Algorithm algorithm = 3;
Parameter | |
---|---|
Name | Description |
value | StudySpec.Algorithm The algorithm to set. |
Returns | |
---|---|
Type | Description |
StudySpec.Builder | This builder for chaining. |
setAlgorithmValue(int value)
public StudySpec.Builder setAlgorithmValue(int value)
The search algorithm specified for the Study.
.google.cloud.aiplatform.v1.StudySpec.Algorithm algorithm = 3;
Parameter | |
---|---|
Name | Description |
value | int The enum numeric value on the wire for algorithm to set. |
Returns | |
---|---|
Type | Description |
StudySpec.Builder | This builder for chaining. |
setConvexAutomatedStoppingSpec(StudySpec.ConvexAutomatedStoppingSpec value)
public StudySpec.Builder setConvexAutomatedStoppingSpec(StudySpec.ConvexAutomatedStoppingSpec value)
The automated early stopping spec using convex stopping rule.
.google.cloud.aiplatform.v1.StudySpec.ConvexAutomatedStoppingSpec convex_automated_stopping_spec = 9;
Parameter | |
---|---|
Name | Description |
value | StudySpec.ConvexAutomatedStoppingSpec |
Returns | |
---|---|
Type | Description |
StudySpec.Builder |
setConvexAutomatedStoppingSpec(StudySpec.ConvexAutomatedStoppingSpec.Builder builderForValue)
public StudySpec.Builder setConvexAutomatedStoppingSpec(StudySpec.ConvexAutomatedStoppingSpec.Builder builderForValue)
The automated early stopping spec using convex stopping rule.
.google.cloud.aiplatform.v1.StudySpec.ConvexAutomatedStoppingSpec convex_automated_stopping_spec = 9;
Parameter | |
---|---|
Name | Description |
builderForValue | StudySpec.ConvexAutomatedStoppingSpec.Builder |
Returns | |
---|---|
Type | Description |
StudySpec.Builder |
setDecayCurveStoppingSpec(StudySpec.DecayCurveAutomatedStoppingSpec value)
public StudySpec.Builder setDecayCurveStoppingSpec(StudySpec.DecayCurveAutomatedStoppingSpec value)
The automated early stopping spec using decay curve rule.
.google.cloud.aiplatform.v1.StudySpec.DecayCurveAutomatedStoppingSpec decay_curve_stopping_spec = 4;
Parameter | |
---|---|
Name | Description |
value | StudySpec.DecayCurveAutomatedStoppingSpec |
Returns | |
---|---|
Type | Description |
StudySpec.Builder |
setDecayCurveStoppingSpec(StudySpec.DecayCurveAutomatedStoppingSpec.Builder builderForValue)
public StudySpec.Builder setDecayCurveStoppingSpec(StudySpec.DecayCurveAutomatedStoppingSpec.Builder builderForValue)
The automated early stopping spec using decay curve rule.
.google.cloud.aiplatform.v1.StudySpec.DecayCurveAutomatedStoppingSpec decay_curve_stopping_spec = 4;
Parameter | |
---|---|
Name | Description |
builderForValue | StudySpec.DecayCurveAutomatedStoppingSpec.Builder |
Returns | |
---|---|
Type | Description |
StudySpec.Builder |
setField(Descriptors.FieldDescriptor field, Object value)
public StudySpec.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters | |
---|---|
Name | Description |
field | FieldDescriptor |
value | Object |
Returns | |
---|---|
Type | Description |
StudySpec.Builder |
setMeasurementSelectionType(StudySpec.MeasurementSelectionType value)
public StudySpec.Builder setMeasurementSelectionType(StudySpec.MeasurementSelectionType value)
Describe which measurement selection type will be used
.google.cloud.aiplatform.v1.StudySpec.MeasurementSelectionType measurement_selection_type = 7;
Parameter | |
---|---|
Name | Description |
value | StudySpec.MeasurementSelectionType The measurementSelectionType to set. |
Returns | |
---|---|
Type | Description |
StudySpec.Builder | This builder for chaining. |
setMeasurementSelectionTypeValue(int value)
public StudySpec.Builder setMeasurementSelectionTypeValue(int value)
Describe which measurement selection type will be used
.google.cloud.aiplatform.v1.StudySpec.MeasurementSelectionType measurement_selection_type = 7;
Parameter | |
---|---|
Name | Description |
value | int The enum numeric value on the wire for measurementSelectionType to set. |
Returns | |
---|---|
Type | Description |
StudySpec.Builder | This builder for chaining. |
setMedianAutomatedStoppingSpec(StudySpec.MedianAutomatedStoppingSpec value)
public StudySpec.Builder setMedianAutomatedStoppingSpec(StudySpec.MedianAutomatedStoppingSpec value)
The automated early stopping spec using median rule.
.google.cloud.aiplatform.v1.StudySpec.MedianAutomatedStoppingSpec median_automated_stopping_spec = 5;
Parameter | |
---|---|
Name | Description |
value | StudySpec.MedianAutomatedStoppingSpec |
Returns | |
---|---|
Type | Description |
StudySpec.Builder |
setMedianAutomatedStoppingSpec(StudySpec.MedianAutomatedStoppingSpec.Builder builderForValue)
public StudySpec.Builder setMedianAutomatedStoppingSpec(StudySpec.MedianAutomatedStoppingSpec.Builder builderForValue)
The automated early stopping spec using median rule.
.google.cloud.aiplatform.v1.StudySpec.MedianAutomatedStoppingSpec median_automated_stopping_spec = 5;
Parameter | |
---|---|
Name | Description |
builderForValue | StudySpec.MedianAutomatedStoppingSpec.Builder |
Returns | |
---|---|
Type | Description |
StudySpec.Builder |
setMetrics(int index, StudySpec.MetricSpec value)
public StudySpec.Builder setMetrics(int index, StudySpec.MetricSpec value)
Required. Metric specs for the Study.
repeated .google.cloud.aiplatform.v1.StudySpec.MetricSpec metrics = 1 [(.google.api.field_behavior) = REQUIRED];
Parameters | |
---|---|
Name | Description |
index | int |
value | StudySpec.MetricSpec |
Returns | |
---|---|
Type | Description |
StudySpec.Builder |
setMetrics(int index, StudySpec.MetricSpec.Builder builderForValue)
public StudySpec.Builder setMetrics(int index, StudySpec.MetricSpec.Builder builderForValue)
Required. Metric specs for the Study.
repeated .google.cloud.aiplatform.v1.StudySpec.MetricSpec metrics = 1 [(.google.api.field_behavior) = REQUIRED];
Parameters | |
---|---|
Name | Description |
index | int |
builderForValue | StudySpec.MetricSpec.Builder |
Returns | |
---|---|
Type | Description |
StudySpec.Builder |
setObservationNoise(StudySpec.ObservationNoise value)
public StudySpec.Builder setObservationNoise(StudySpec.ObservationNoise value)
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;
Parameter | |
---|---|
Name | Description |
value | StudySpec.ObservationNoise The observationNoise to set. |
Returns | |
---|---|
Type | Description |
StudySpec.Builder | This builder for chaining. |
setObservationNoiseValue(int value)
public StudySpec.Builder setObservationNoiseValue(int value)
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;
Parameter | |
---|---|
Name | Description |
value | int The enum numeric value on the wire for observationNoise to set. |
Returns | |
---|---|
Type | Description |
StudySpec.Builder | This builder for chaining. |
setParameters(int index, StudySpec.ParameterSpec value)
public StudySpec.Builder setParameters(int index, StudySpec.ParameterSpec value)
Required. The set of parameters to tune.
repeated .google.cloud.aiplatform.v1.StudySpec.ParameterSpec parameters = 2 [(.google.api.field_behavior) = REQUIRED];
Parameters | |
---|---|
Name | Description |
index | int |
value | StudySpec.ParameterSpec |
Returns | |
---|---|
Type | Description |
StudySpec.Builder |
setParameters(int index, StudySpec.ParameterSpec.Builder builderForValue)
public StudySpec.Builder setParameters(int index, StudySpec.ParameterSpec.Builder builderForValue)
Required. The set of parameters to tune.
repeated .google.cloud.aiplatform.v1.StudySpec.ParameterSpec parameters = 2 [(.google.api.field_behavior) = REQUIRED];
Parameters | |
---|---|
Name | Description |
index | int |
builderForValue | StudySpec.ParameterSpec.Builder |
Returns | |
---|---|
Type | Description |
StudySpec.Builder |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public StudySpec.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters | |
---|---|
Name | Description |
field | FieldDescriptor |
index | int |
value | Object |
Returns | |
---|---|
Type | Description |
StudySpec.Builder |
setStudyStoppingConfig(StudySpec.StudyStoppingConfig value)
public StudySpec.Builder setStudyStoppingConfig(StudySpec.StudyStoppingConfig value)
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;
Parameter | |
---|---|
Name | Description |
value | StudySpec.StudyStoppingConfig |
Returns | |
---|---|
Type | Description |
StudySpec.Builder |
setStudyStoppingConfig(StudySpec.StudyStoppingConfig.Builder builderForValue)
public StudySpec.Builder setStudyStoppingConfig(StudySpec.StudyStoppingConfig.Builder builderForValue)
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;
Parameter | |
---|---|
Name | Description |
builderForValue | StudySpec.StudyStoppingConfig.Builder |
Returns | |
---|---|
Type | Description |
StudySpec.Builder |
setUnknownFields(UnknownFieldSet unknownFields)
public final StudySpec.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter | |
---|---|
Name | Description |
unknownFields | UnknownFieldSet |
Returns | |
---|---|
Type | Description |
StudySpec.Builder |