Class StudySpec.Builder (3.14.0)

public static final class StudySpec.Builder extends GeneratedMessageV3.Builder<StudySpec.Builder> implements StudySpecOrBuilder

Represents specification of a Study.

Protobuf type google.cloud.aiplatform.v1beta1.StudySpec

Implements

StudySpecOrBuilder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
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.v1beta1.StudySpec.MetricSpec metrics = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
NameDescription
valuesIterable<? extends com.google.cloud.aiplatform.v1beta1.StudySpec.MetricSpec>
Returns
TypeDescription
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.v1beta1.StudySpec.ParameterSpec parameters = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
NameDescription
valuesIterable<? extends com.google.cloud.aiplatform.v1beta1.StudySpec.ParameterSpec>
Returns
TypeDescription
StudySpec.Builder

addMetrics(StudySpec.MetricSpec value)

public StudySpec.Builder addMetrics(StudySpec.MetricSpec value)

Required. Metric specs for the Study.

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

Parameter
NameDescription
valueStudySpec.MetricSpec
Returns
TypeDescription
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.v1beta1.StudySpec.MetricSpec metrics = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
NameDescription
builderForValueStudySpec.MetricSpec.Builder
Returns
TypeDescription
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.v1beta1.StudySpec.MetricSpec metrics = 1 [(.google.api.field_behavior) = REQUIRED];

Parameters
NameDescription
indexint
valueStudySpec.MetricSpec
Returns
TypeDescription
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.v1beta1.StudySpec.MetricSpec metrics = 1 [(.google.api.field_behavior) = REQUIRED];

Parameters
NameDescription
indexint
builderForValueStudySpec.MetricSpec.Builder
Returns
TypeDescription
StudySpec.Builder

addMetricsBuilder()

public StudySpec.MetricSpec.Builder addMetricsBuilder()

Required. Metric specs for the Study.

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

Returns
TypeDescription
StudySpec.MetricSpec.Builder

addMetricsBuilder(int index)

public StudySpec.MetricSpec.Builder addMetricsBuilder(int index)

Required. Metric specs for the Study.

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

Parameter
NameDescription
indexint
Returns
TypeDescription
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.v1beta1.StudySpec.ParameterSpec parameters = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
NameDescription
valueStudySpec.ParameterSpec
Returns
TypeDescription
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.v1beta1.StudySpec.ParameterSpec parameters = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
NameDescription
builderForValueStudySpec.ParameterSpec.Builder
Returns
TypeDescription
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.v1beta1.StudySpec.ParameterSpec parameters = 2 [(.google.api.field_behavior) = REQUIRED];

Parameters
NameDescription
indexint
valueStudySpec.ParameterSpec
Returns
TypeDescription
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.v1beta1.StudySpec.ParameterSpec parameters = 2 [(.google.api.field_behavior) = REQUIRED];

Parameters
NameDescription
indexint
builderForValueStudySpec.ParameterSpec.Builder
Returns
TypeDescription
StudySpec.Builder

addParametersBuilder()

public StudySpec.ParameterSpec.Builder addParametersBuilder()

Required. The set of parameters to tune.

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

Returns
TypeDescription
StudySpec.ParameterSpec.Builder

addParametersBuilder(int index)

public StudySpec.ParameterSpec.Builder addParametersBuilder(int index)

Required. The set of parameters to tune.

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

Parameter
NameDescription
indexint
Returns
TypeDescription
StudySpec.ParameterSpec.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public StudySpec.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
StudySpec.Builder
Overrides

build()

public StudySpec build()
Returns
TypeDescription
StudySpec

buildPartial()

public StudySpec buildPartial()
Returns
TypeDescription
StudySpec

clear()

public StudySpec.Builder clear()
Returns
TypeDescription
StudySpec.Builder
Overrides

clearAlgorithm()

public StudySpec.Builder clearAlgorithm()

The search algorithm specified for the Study.

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

Returns
TypeDescription
StudySpec.Builder

This builder for chaining.

clearAutomatedStoppingSpec()

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

clearConvexAutomatedStoppingSpec()

public StudySpec.Builder clearConvexAutomatedStoppingSpec()

The automated early stopping spec using convex stopping rule.

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

Returns
TypeDescription
StudySpec.Builder

clearConvexStopConfig()

public StudySpec.Builder clearConvexStopConfig()

Deprecated. The automated early stopping using convex stopping rule.

.google.cloud.aiplatform.v1beta1.StudySpec.ConvexStopConfig convex_stop_config = 8 [deprecated = true];

Returns
TypeDescription
StudySpec.Builder

clearDecayCurveStoppingSpec()

public StudySpec.Builder clearDecayCurveStoppingSpec()

The automated early stopping spec using decay curve rule.

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

Returns
TypeDescription
StudySpec.Builder

clearField(Descriptors.FieldDescriptor field)

public StudySpec.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
StudySpec.Builder
Overrides

clearMeasurementSelectionType()

public StudySpec.Builder clearMeasurementSelectionType()

Describe which measurement selection type will be used

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

Returns
TypeDescription
StudySpec.Builder

This builder for chaining.

clearMedianAutomatedStoppingSpec()

public StudySpec.Builder clearMedianAutomatedStoppingSpec()

The automated early stopping spec using median rule.

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

Returns
TypeDescription
StudySpec.Builder

clearMetrics()

public StudySpec.Builder clearMetrics()

Required. Metric specs for the Study.

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

Returns
TypeDescription
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.v1beta1.StudySpec.ObservationNoise observation_noise = 6;

Returns
TypeDescription
StudySpec.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public StudySpec.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
StudySpec.Builder
Overrides

clearParameters()

public StudySpec.Builder clearParameters()

Required. The set of parameters to tune.

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

Returns
TypeDescription
StudySpec.Builder

clearTransferLearningConfig()

public StudySpec.Builder clearTransferLearningConfig()

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
TypeDescription
StudySpec.Builder

clone()

public StudySpec.Builder clone()
Returns
TypeDescription
StudySpec.Builder
Overrides

getAlgorithm()

public StudySpec.Algorithm getAlgorithm()

The search algorithm specified for the Study.

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

Returns
TypeDescription
StudySpec.Algorithm

The algorithm.

getAlgorithmValue()

public int getAlgorithmValue()

The search algorithm specified for the Study.

.google.cloud.aiplatform.v1beta1.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.v1beta1.StudySpec.ConvexAutomatedStoppingSpec convex_automated_stopping_spec = 9;

Returns
TypeDescription
StudySpec.ConvexAutomatedStoppingSpec

The convexAutomatedStoppingSpec.

getConvexAutomatedStoppingSpecBuilder()

public StudySpec.ConvexAutomatedStoppingSpec.Builder getConvexAutomatedStoppingSpecBuilder()

The automated early stopping spec using convex stopping rule.

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

Returns
TypeDescription
StudySpec.ConvexAutomatedStoppingSpec.Builder

getConvexAutomatedStoppingSpecOrBuilder()

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
TypeDescription
StudySpec.ConvexAutomatedStoppingSpecOrBuilder

getConvexStopConfig() (deprecated)

public StudySpec.ConvexStopConfig getConvexStopConfig()

Deprecated. google.cloud.aiplatform.v1beta1.StudySpec.convex_stop_config is deprecated. See google/cloud/aiplatform/v1beta1/study.proto;l=607

Deprecated. The automated early stopping using convex stopping rule.

.google.cloud.aiplatform.v1beta1.StudySpec.ConvexStopConfig convex_stop_config = 8 [deprecated = true];

Returns
TypeDescription
StudySpec.ConvexStopConfig

The convexStopConfig.

getConvexStopConfigBuilder()

public StudySpec.ConvexStopConfig.Builder getConvexStopConfigBuilder()

Deprecated. The automated early stopping using convex stopping rule.

.google.cloud.aiplatform.v1beta1.StudySpec.ConvexStopConfig convex_stop_config = 8 [deprecated = true];

Returns
TypeDescription
StudySpec.ConvexStopConfig.Builder

getConvexStopConfigOrBuilder()

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
TypeDescription
StudySpec.ConvexStopConfigOrBuilder

getDecayCurveStoppingSpec()

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
TypeDescription
StudySpec.DecayCurveAutomatedStoppingSpec

The decayCurveStoppingSpec.

getDecayCurveStoppingSpecBuilder()

public StudySpec.DecayCurveAutomatedStoppingSpec.Builder getDecayCurveStoppingSpecBuilder()

The automated early stopping spec using decay curve rule.

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

Returns
TypeDescription
StudySpec.DecayCurveAutomatedStoppingSpec.Builder

getDecayCurveStoppingSpecOrBuilder()

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
TypeDescription
StudySpec.DecayCurveAutomatedStoppingSpecOrBuilder

getDefaultInstanceForType()

public StudySpec getDefaultInstanceForType()
Returns
TypeDescription
StudySpec

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getMeasurementSelectionType()

public StudySpec.MeasurementSelectionType getMeasurementSelectionType()

Describe which measurement selection type will be used

.google.cloud.aiplatform.v1beta1.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.v1beta1.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.v1beta1.StudySpec.MedianAutomatedStoppingSpec median_automated_stopping_spec = 5;

Returns
TypeDescription
StudySpec.MedianAutomatedStoppingSpec

The medianAutomatedStoppingSpec.

getMedianAutomatedStoppingSpecBuilder()

public StudySpec.MedianAutomatedStoppingSpec.Builder getMedianAutomatedStoppingSpecBuilder()

The automated early stopping spec using median rule.

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

Returns
TypeDescription
StudySpec.MedianAutomatedStoppingSpec.Builder

getMedianAutomatedStoppingSpecOrBuilder()

public StudySpec.MedianAutomatedStoppingSpecOrBuilder getMedianAutomatedStoppingSpecOrBuilder()

The automated early stopping spec using median rule.

.google.cloud.aiplatform.v1beta1.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.v1beta1.StudySpec.MetricSpec metrics = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
NameDescription
indexint
Returns
TypeDescription
StudySpec.MetricSpec

getMetricsBuilder(int index)

public StudySpec.MetricSpec.Builder getMetricsBuilder(int index)

Required. Metric specs for the Study.

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

Parameter
NameDescription
indexint
Returns
TypeDescription
StudySpec.MetricSpec.Builder

getMetricsBuilderList()

public List<StudySpec.MetricSpec.Builder> getMetricsBuilderList()

Required. Metric specs for the Study.

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

Returns
TypeDescription
List<Builder>

getMetricsCount()

public int getMetricsCount()

Required. Metric specs for the Study.

repeated .google.cloud.aiplatform.v1beta1.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.v1beta1.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.v1beta1.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.v1beta1.StudySpec.MetricSpec metrics = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
List<? extends com.google.cloud.aiplatform.v1beta1.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.v1beta1.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.v1beta1.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.v1beta1.StudySpec.ParameterSpec parameters = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
NameDescription
indexint
Returns
TypeDescription
StudySpec.ParameterSpec

getParametersBuilder(int index)

public StudySpec.ParameterSpec.Builder getParametersBuilder(int index)

Required. The set of parameters to tune.

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

Parameter
NameDescription
indexint
Returns
TypeDescription
StudySpec.ParameterSpec.Builder

getParametersBuilderList()

public List<StudySpec.ParameterSpec.Builder> getParametersBuilderList()

Required. The set of parameters to tune.

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

Returns
TypeDescription
List<Builder>

getParametersCount()

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
TypeDescription
int

getParametersList()

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
TypeDescription
List<ParameterSpec>

getParametersOrBuilder(int index)

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
NameDescription
indexint
Returns
TypeDescription
StudySpec.ParameterSpecOrBuilder

getParametersOrBuilderList()

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
TypeDescription
List<? extends com.google.cloud.aiplatform.v1beta1.StudySpec.ParameterSpecOrBuilder>

getTransferLearningConfig()

public 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
TypeDescription
StudySpec.TransferLearningConfig

The transferLearningConfig.

getTransferLearningConfigBuilder()

public StudySpec.TransferLearningConfig.Builder getTransferLearningConfigBuilder()

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
TypeDescription
StudySpec.TransferLearningConfig.Builder

getTransferLearningConfigOrBuilder()

public 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
TypeDescription
StudySpec.TransferLearningConfigOrBuilder

hasConvexAutomatedStoppingSpec()

public boolean hasConvexAutomatedStoppingSpec()

The automated early stopping spec using convex stopping rule.

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

Returns
TypeDescription
boolean

Whether the convexAutomatedStoppingSpec field is set.

hasConvexStopConfig() (deprecated)

public boolean hasConvexStopConfig()

Deprecated. google.cloud.aiplatform.v1beta1.StudySpec.convex_stop_config is deprecated. See google/cloud/aiplatform/v1beta1/study.proto;l=607

Deprecated. The automated early stopping using convex stopping rule.

.google.cloud.aiplatform.v1beta1.StudySpec.ConvexStopConfig convex_stop_config = 8 [deprecated = true];

Returns
TypeDescription
boolean

Whether the convexStopConfig field is set.

hasDecayCurveStoppingSpec()

public boolean hasDecayCurveStoppingSpec()

The automated early stopping spec using decay curve rule.

.google.cloud.aiplatform.v1beta1.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.v1beta1.StudySpec.MedianAutomatedStoppingSpec median_automated_stopping_spec = 5;

Returns
TypeDescription
boolean

Whether the medianAutomatedStoppingSpec field is set.

hasTransferLearningConfig()

public 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
TypeDescription
boolean

Whether the transferLearningConfig field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeConvexAutomatedStoppingSpec(StudySpec.ConvexAutomatedStoppingSpec value)

public StudySpec.Builder mergeConvexAutomatedStoppingSpec(StudySpec.ConvexAutomatedStoppingSpec value)

The automated early stopping spec using convex stopping rule.

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

Parameter
NameDescription
valueStudySpec.ConvexAutomatedStoppingSpec
Returns
TypeDescription
StudySpec.Builder

mergeConvexStopConfig(StudySpec.ConvexStopConfig value)

public StudySpec.Builder mergeConvexStopConfig(StudySpec.ConvexStopConfig value)

Deprecated. The automated early stopping using convex stopping rule.

.google.cloud.aiplatform.v1beta1.StudySpec.ConvexStopConfig convex_stop_config = 8 [deprecated = true];

Parameter
NameDescription
valueStudySpec.ConvexStopConfig
Returns
TypeDescription
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.v1beta1.StudySpec.DecayCurveAutomatedStoppingSpec decay_curve_stopping_spec = 4;

Parameter
NameDescription
valueStudySpec.DecayCurveAutomatedStoppingSpec
Returns
TypeDescription
StudySpec.Builder

mergeFrom(StudySpec other)

public StudySpec.Builder mergeFrom(StudySpec other)
Parameter
NameDescription
otherStudySpec
Returns
TypeDescription
StudySpec.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public StudySpec.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
StudySpec.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public StudySpec.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
StudySpec.Builder
Overrides

mergeMedianAutomatedStoppingSpec(StudySpec.MedianAutomatedStoppingSpec value)

public StudySpec.Builder mergeMedianAutomatedStoppingSpec(StudySpec.MedianAutomatedStoppingSpec value)

The automated early stopping spec using median rule.

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

Parameter
NameDescription
valueStudySpec.MedianAutomatedStoppingSpec
Returns
TypeDescription
StudySpec.Builder

mergeTransferLearningConfig(StudySpec.TransferLearningConfig value)

public StudySpec.Builder mergeTransferLearningConfig(StudySpec.TransferLearningConfig value)

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;

Parameter
NameDescription
valueStudySpec.TransferLearningConfig
Returns
TypeDescription
StudySpec.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final StudySpec.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
StudySpec.Builder
Overrides

removeMetrics(int index)

public StudySpec.Builder removeMetrics(int index)

Required. Metric specs for the Study.

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

Parameter
NameDescription
indexint
Returns
TypeDescription
StudySpec.Builder

removeParameters(int index)

public StudySpec.Builder removeParameters(int index)

Required. The set of parameters to tune.

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

Parameter
NameDescription
indexint
Returns
TypeDescription
StudySpec.Builder

setAlgorithm(StudySpec.Algorithm value)

public StudySpec.Builder setAlgorithm(StudySpec.Algorithm value)

The search algorithm specified for the Study.

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

Parameter
NameDescription
valueStudySpec.Algorithm

The algorithm to set.

Returns
TypeDescription
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.v1beta1.StudySpec.Algorithm algorithm = 3;

Parameter
NameDescription
valueint

The enum numeric value on the wire for algorithm to set.

Returns
TypeDescription
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.v1beta1.StudySpec.ConvexAutomatedStoppingSpec convex_automated_stopping_spec = 9;

Parameter
NameDescription
valueStudySpec.ConvexAutomatedStoppingSpec
Returns
TypeDescription
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.v1beta1.StudySpec.ConvexAutomatedStoppingSpec convex_automated_stopping_spec = 9;

Parameter
NameDescription
builderForValueStudySpec.ConvexAutomatedStoppingSpec.Builder
Returns
TypeDescription
StudySpec.Builder

setConvexStopConfig(StudySpec.ConvexStopConfig value)

public StudySpec.Builder setConvexStopConfig(StudySpec.ConvexStopConfig value)

Deprecated. The automated early stopping using convex stopping rule.

.google.cloud.aiplatform.v1beta1.StudySpec.ConvexStopConfig convex_stop_config = 8 [deprecated = true];

Parameter
NameDescription
valueStudySpec.ConvexStopConfig
Returns
TypeDescription
StudySpec.Builder

setConvexStopConfig(StudySpec.ConvexStopConfig.Builder builderForValue)

public StudySpec.Builder setConvexStopConfig(StudySpec.ConvexStopConfig.Builder builderForValue)

Deprecated. The automated early stopping using convex stopping rule.

.google.cloud.aiplatform.v1beta1.StudySpec.ConvexStopConfig convex_stop_config = 8 [deprecated = true];

Parameter
NameDescription
builderForValueStudySpec.ConvexStopConfig.Builder
Returns
TypeDescription
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.v1beta1.StudySpec.DecayCurveAutomatedStoppingSpec decay_curve_stopping_spec = 4;

Parameter
NameDescription
valueStudySpec.DecayCurveAutomatedStoppingSpec
Returns
TypeDescription
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.v1beta1.StudySpec.DecayCurveAutomatedStoppingSpec decay_curve_stopping_spec = 4;

Parameter
NameDescription
builderForValueStudySpec.DecayCurveAutomatedStoppingSpec.Builder
Returns
TypeDescription
StudySpec.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public StudySpec.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
StudySpec.Builder
Overrides

setMeasurementSelectionType(StudySpec.MeasurementSelectionType value)

public StudySpec.Builder setMeasurementSelectionType(StudySpec.MeasurementSelectionType value)

Describe which measurement selection type will be used

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

Parameter
NameDescription
valueStudySpec.MeasurementSelectionType

The measurementSelectionType to set.

Returns
TypeDescription
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.v1beta1.StudySpec.MeasurementSelectionType measurement_selection_type = 7;

Parameter
NameDescription
valueint

The enum numeric value on the wire for measurementSelectionType to set.

Returns
TypeDescription
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.v1beta1.StudySpec.MedianAutomatedStoppingSpec median_automated_stopping_spec = 5;

Parameter
NameDescription
valueStudySpec.MedianAutomatedStoppingSpec
Returns
TypeDescription
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.v1beta1.StudySpec.MedianAutomatedStoppingSpec median_automated_stopping_spec = 5;

Parameter
NameDescription
builderForValueStudySpec.MedianAutomatedStoppingSpec.Builder
Returns
TypeDescription
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.v1beta1.StudySpec.MetricSpec metrics = 1 [(.google.api.field_behavior) = REQUIRED];

Parameters
NameDescription
indexint
valueStudySpec.MetricSpec
Returns
TypeDescription
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.v1beta1.StudySpec.MetricSpec metrics = 1 [(.google.api.field_behavior) = REQUIRED];

Parameters
NameDescription
indexint
builderForValueStudySpec.MetricSpec.Builder
Returns
TypeDescription
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.v1beta1.StudySpec.ObservationNoise observation_noise = 6;

Parameter
NameDescription
valueStudySpec.ObservationNoise

The observationNoise to set.

Returns
TypeDescription
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.v1beta1.StudySpec.ObservationNoise observation_noise = 6;

Parameter
NameDescription
valueint

The enum numeric value on the wire for observationNoise to set.

Returns
TypeDescription
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.v1beta1.StudySpec.ParameterSpec parameters = 2 [(.google.api.field_behavior) = REQUIRED];

Parameters
NameDescription
indexint
valueStudySpec.ParameterSpec
Returns
TypeDescription
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.v1beta1.StudySpec.ParameterSpec parameters = 2 [(.google.api.field_behavior) = REQUIRED];

Parameters
NameDescription
indexint
builderForValueStudySpec.ParameterSpec.Builder
Returns
TypeDescription
StudySpec.Builder

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public StudySpec.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
StudySpec.Builder
Overrides

setTransferLearningConfig(StudySpec.TransferLearningConfig value)

public StudySpec.Builder setTransferLearningConfig(StudySpec.TransferLearningConfig value)

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;

Parameter
NameDescription
valueStudySpec.TransferLearningConfig
Returns
TypeDescription
StudySpec.Builder

setTransferLearningConfig(StudySpec.TransferLearningConfig.Builder builderForValue)

public StudySpec.Builder setTransferLearningConfig(StudySpec.TransferLearningConfig.Builder builderForValue)

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;

Parameter
NameDescription
builderForValueStudySpec.TransferLearningConfig.Builder
Returns
TypeDescription
StudySpec.Builder

setUnknownFields(UnknownFieldSet unknownFields)

public final StudySpec.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
StudySpec.Builder
Overrides