Package com.google.cloud.aiplatform.v1beta1

Interface StudySpecOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    StudySpec, StudySpec.Builder
    public interface StudySpecOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Detail

      • hasDecayCurveStoppingSpec

        boolean hasDecayCurveStoppingSpec()
         The automated early stopping spec using decay curve rule.
        .google.cloud.aiplatform.v1beta1.StudySpec.DecayCurveAutomatedStoppingSpec decay_curve_stopping_spec = 4;
        Returns:
        Whether the decayCurveStoppingSpec field is set.

      • getDecayCurveStoppingSpec

        StudySpec.DecayCurveAutomatedStoppingSpec getDecayCurveStoppingSpec()
         The automated early stopping spec using decay curve rule.
        .google.cloud.aiplatform.v1beta1.StudySpec.DecayCurveAutomatedStoppingSpec decay_curve_stopping_spec = 4;
        Returns:
        The decayCurveStoppingSpec.

      • getDecayCurveStoppingSpecOrBuilder

        StudySpec.DecayCurveAutomatedStoppingSpecOrBuilder getDecayCurveStoppingSpecOrBuilder()
         The automated early stopping spec using decay curve rule.
        .google.cloud.aiplatform.v1beta1.StudySpec.DecayCurveAutomatedStoppingSpec decay_curve_stopping_spec = 4;

      • hasMedianAutomatedStoppingSpec

        boolean hasMedianAutomatedStoppingSpec()
         The automated early stopping spec using median rule.
        .google.cloud.aiplatform.v1beta1.StudySpec.MedianAutomatedStoppingSpec median_automated_stopping_spec = 5;
        Returns:
        Whether the medianAutomatedStoppingSpec field is set.

      • getMedianAutomatedStoppingSpec

        StudySpec.MedianAutomatedStoppingSpec getMedianAutomatedStoppingSpec()
         The automated early stopping spec using median rule.
        .google.cloud.aiplatform.v1beta1.StudySpec.MedianAutomatedStoppingSpec median_automated_stopping_spec = 5;
        Returns:
        The medianAutomatedStoppingSpec.

      • getMedianAutomatedStoppingSpecOrBuilder

        StudySpec.MedianAutomatedStoppingSpecOrBuilder getMedianAutomatedStoppingSpecOrBuilder()
         The automated early stopping spec using median rule.
        .google.cloud.aiplatform.v1beta1.StudySpec.MedianAutomatedStoppingSpec median_automated_stopping_spec = 5;

      • hasConvexStopConfig

        @Deprecated
boolean hasConvexStopConfig()
        Deprecated.
        google.cloud.aiplatform.v1beta1.StudySpec.convex_stop_config is deprecated. See google/cloud/aiplatform/v1beta1/study.proto;l=625
         Deprecated.
 The automated early stopping using convex stopping rule.
        .google.cloud.aiplatform.v1beta1.StudySpec.ConvexStopConfig convex_stop_config = 8 [deprecated = true];
        Returns:
        Whether the convexStopConfig field is set.

      • getConvexStopConfig

        @Deprecated
StudySpec.ConvexStopConfig getConvexStopConfig()
        Deprecated.
        google.cloud.aiplatform.v1beta1.StudySpec.convex_stop_config is deprecated. See google/cloud/aiplatform/v1beta1/study.proto;l=625
         Deprecated.
 The automated early stopping using convex stopping rule.
        .google.cloud.aiplatform.v1beta1.StudySpec.ConvexStopConfig convex_stop_config = 8 [deprecated = true];
        Returns:
        The convexStopConfig.

      • getConvexStopConfigOrBuilder

        @Deprecated
StudySpec.ConvexStopConfigOrBuilder getConvexStopConfigOrBuilder()
        Deprecated.
         Deprecated.
 The automated early stopping using convex stopping rule.
        .google.cloud.aiplatform.v1beta1.StudySpec.ConvexStopConfig convex_stop_config = 8 [deprecated = true];

      • hasConvexAutomatedStoppingSpec

        boolean hasConvexAutomatedStoppingSpec()
         The automated early stopping spec using convex stopping rule.
        .google.cloud.aiplatform.v1beta1.StudySpec.ConvexAutomatedStoppingSpec convex_automated_stopping_spec = 9;
        Returns:
        Whether the convexAutomatedStoppingSpec field is set.

      • getConvexAutomatedStoppingSpec

        StudySpec.ConvexAutomatedStoppingSpec getConvexAutomatedStoppingSpec()
         The automated early stopping spec using convex stopping rule.
        .google.cloud.aiplatform.v1beta1.StudySpec.ConvexAutomatedStoppingSpec convex_automated_stopping_spec = 9;
        Returns:
        The convexAutomatedStoppingSpec.

      • getConvexAutomatedStoppingSpecOrBuilder

        StudySpec.ConvexAutomatedStoppingSpecOrBuilder getConvexAutomatedStoppingSpecOrBuilder()
         The automated early stopping spec using convex stopping rule.
        .google.cloud.aiplatform.v1beta1.StudySpec.ConvexAutomatedStoppingSpec convex_automated_stopping_spec = 9;

      • getMetricsList

        List<StudySpec.MetricSpec> getMetricsList()
         Required. Metric specs for the Study.
        repeated .google.cloud.aiplatform.v1beta1.StudySpec.MetricSpec metrics = 1 [(.google.api.field_behavior) = REQUIRED];

      • getMetrics

        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];

      • getMetricsCount

        int getMetricsCount()
         Required. Metric specs for the Study.
        repeated .google.cloud.aiplatform.v1beta1.StudySpec.MetricSpec metrics = 1 [(.google.api.field_behavior) = REQUIRED];

      • getMetricsOrBuilderList

        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];

      • getMetricsOrBuilder

        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];

      • getParametersList

        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];

      • getParameters

        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];

      • getParametersCount

        int getParametersCount()
         Required. The set of parameters to tune.
        repeated .google.cloud.aiplatform.v1beta1.StudySpec.ParameterSpec parameters = 2 [(.google.api.field_behavior) = REQUIRED];

      • getParametersOrBuilderList

        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];

      • getParametersOrBuilder

        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];

      • getAlgorithmValue

        int getAlgorithmValue()
         The search algorithm specified for the Study.
        .google.cloud.aiplatform.v1beta1.StudySpec.Algorithm algorithm = 3;
        Returns:
        The enum numeric value on the wire for algorithm.

      • getAlgorithm

        StudySpec.Algorithm getAlgorithm()
         The search algorithm specified for the Study.
        .google.cloud.aiplatform.v1beta1.StudySpec.Algorithm algorithm = 3;
        Returns:
        The algorithm.

      • getObservationNoiseValue

        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:
        The enum numeric value on the wire for observationNoise.

      • getObservationNoise

        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:
        The observationNoise.

      • getMeasurementSelectionTypeValue

        int getMeasurementSelectionTypeValue()
         Describe which measurement selection type will be used
        .google.cloud.aiplatform.v1beta1.StudySpec.MeasurementSelectionType measurement_selection_type = 7;
        Returns:
        The enum numeric value on the wire for measurementSelectionType.

      • getMeasurementSelectionType

        StudySpec.MeasurementSelectionType getMeasurementSelectionType()
         Describe which measurement selection type will be used
        .google.cloud.aiplatform.v1beta1.StudySpec.MeasurementSelectionType measurement_selection_type = 7;
        Returns:
        The measurementSelectionType.

      • hasTransferLearningConfig

        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:
        Whether the transferLearningConfig field is set.

      • getTransferLearningConfig

        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:
        The transferLearningConfig.

      • getTransferLearningConfigOrBuilder

        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;