Package com.google.cloud.aiplatform.v1

Class StudySpec

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.aiplatform.v1.StudySpec
All Implemented Interfaces:
StudySpecOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class StudySpec extends com.google.protobuf.GeneratedMessage implements StudySpecOrBuilder
 Represents specification of a Study.
Protobuf type google.cloud.aiplatform.v1.StudySpec
See Also:

  • Field Details

    • DECAY_CURVE_STOPPING_SPEC_FIELD_NUMBER

      public static final int DECAY_CURVE_STOPPING_SPEC_FIELD_NUMBER
      See Also:

    • MEDIAN_AUTOMATED_STOPPING_SPEC_FIELD_NUMBER

      public static final int MEDIAN_AUTOMATED_STOPPING_SPEC_FIELD_NUMBER
      See Also:

    • CONVEX_AUTOMATED_STOPPING_SPEC_FIELD_NUMBER

      public static final int CONVEX_AUTOMATED_STOPPING_SPEC_FIELD_NUMBER
      See Also:

    • METRICS_FIELD_NUMBER

      public static final int METRICS_FIELD_NUMBER
      See Also:

    • PARAMETERS_FIELD_NUMBER

      public static final int PARAMETERS_FIELD_NUMBER
      See Also:

    • ALGORITHM_FIELD_NUMBER

      public static final int ALGORITHM_FIELD_NUMBER
      See Also:

    • OBSERVATION_NOISE_FIELD_NUMBER

      public static final int OBSERVATION_NOISE_FIELD_NUMBER
      See Also:

    • MEASUREMENT_SELECTION_TYPE_FIELD_NUMBER

      public static final int MEASUREMENT_SELECTION_TYPE_FIELD_NUMBER
      See Also:

    • STUDY_STOPPING_CONFIG_FIELD_NUMBER

      public static final int STUDY_STOPPING_CONFIG_FIELD_NUMBER
      See Also:

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • getAutomatedStoppingSpecCase

      public StudySpec.AutomatedStoppingSpecCase getAutomatedStoppingSpecCase()
      Specified by:
      getAutomatedStoppingSpecCase in interface StudySpecOrBuilder

    • hasDecayCurveStoppingSpec

      public boolean hasDecayCurveStoppingSpec()
       The automated early stopping spec using decay curve rule.
      .google.cloud.aiplatform.v1.StudySpec.DecayCurveAutomatedStoppingSpec decay_curve_stopping_spec = 4;
      Specified by:
      hasDecayCurveStoppingSpec in interface StudySpecOrBuilder
      Returns:
      Whether the decayCurveStoppingSpec field is set.

    • 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;
      Specified by:
      getDecayCurveStoppingSpec in interface StudySpecOrBuilder
      Returns:
      The decayCurveStoppingSpec.

    • 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;
      Specified by:
      getDecayCurveStoppingSpecOrBuilder in interface StudySpecOrBuilder

    • hasMedianAutomatedStoppingSpec

      public boolean hasMedianAutomatedStoppingSpec()
       The automated early stopping spec using median rule.
      .google.cloud.aiplatform.v1.StudySpec.MedianAutomatedStoppingSpec median_automated_stopping_spec = 5;
      Specified by:
      hasMedianAutomatedStoppingSpec in interface StudySpecOrBuilder
      Returns:
      Whether the medianAutomatedStoppingSpec field is set.

    • getMedianAutomatedStoppingSpec

      public StudySpec.MedianAutomatedStoppingSpec getMedianAutomatedStoppingSpec()
       The automated early stopping spec using median rule.
      .google.cloud.aiplatform.v1.StudySpec.MedianAutomatedStoppingSpec median_automated_stopping_spec = 5;
      Specified by:
      getMedianAutomatedStoppingSpec in interface StudySpecOrBuilder
      Returns:
      The medianAutomatedStoppingSpec.

    • getMedianAutomatedStoppingSpecOrBuilder

      public StudySpec.MedianAutomatedStoppingSpecOrBuilder getMedianAutomatedStoppingSpecOrBuilder()
       The automated early stopping spec using median rule.
      .google.cloud.aiplatform.v1.StudySpec.MedianAutomatedStoppingSpec median_automated_stopping_spec = 5;
      Specified by:
      getMedianAutomatedStoppingSpecOrBuilder in interface StudySpecOrBuilder

    • hasConvexAutomatedStoppingSpec

      public boolean hasConvexAutomatedStoppingSpec()
       The automated early stopping spec using convex stopping rule.
      .google.cloud.aiplatform.v1.StudySpec.ConvexAutomatedStoppingSpec convex_automated_stopping_spec = 9;
      Specified by:
      hasConvexAutomatedStoppingSpec in interface StudySpecOrBuilder
      Returns:
      Whether the convexAutomatedStoppingSpec field is set.

    • 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;
      Specified by:
      getConvexAutomatedStoppingSpec in interface StudySpecOrBuilder
      Returns:
      The convexAutomatedStoppingSpec.

    • 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;
      Specified by:
      getConvexAutomatedStoppingSpecOrBuilder in interface StudySpecOrBuilder

    • 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];
      Specified by:
      getMetricsList in interface StudySpecOrBuilder

    • 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];
      Specified by:
      getMetricsOrBuilderList in interface StudySpecOrBuilder

    • getMetricsCount

      public int getMetricsCount()
       Required. Metric specs for the Study.
      repeated .google.cloud.aiplatform.v1.StudySpec.MetricSpec metrics = 1 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getMetricsCount in interface StudySpecOrBuilder

    • getMetrics

      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];
      Specified by:
      getMetrics in interface StudySpecOrBuilder

    • getMetricsOrBuilder

      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];
      Specified by:
      getMetricsOrBuilder in interface StudySpecOrBuilder

    • 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];
      Specified by:
      getParametersList in interface StudySpecOrBuilder

    • 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];
      Specified by:
      getParametersOrBuilderList in interface StudySpecOrBuilder

    • 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];
      Specified by:
      getParametersCount in interface StudySpecOrBuilder

    • getParameters

      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];
      Specified by:
      getParameters in interface StudySpecOrBuilder

    • getParametersOrBuilder

      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];
      Specified by:
      getParametersOrBuilder in interface StudySpecOrBuilder

    • getAlgorithmValue

      public int getAlgorithmValue()
       The search algorithm specified for the Study.
      .google.cloud.aiplatform.v1.StudySpec.Algorithm algorithm = 3;
      Specified by:
      getAlgorithmValue in interface StudySpecOrBuilder
      Returns:
      The enum numeric value on the wire for algorithm.

    • getAlgorithm

      public StudySpec.Algorithm getAlgorithm()
       The search algorithm specified for the Study.
      .google.cloud.aiplatform.v1.StudySpec.Algorithm algorithm = 3;
      Specified by:
      getAlgorithm in interface StudySpecOrBuilder
      Returns:
      The algorithm.

    • 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;
      Specified by:
      getObservationNoiseValue in interface StudySpecOrBuilder
      Returns:
      The enum numeric value on the wire for observationNoise.

    • 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;
      Specified by:
      getObservationNoise in interface StudySpecOrBuilder
      Returns:
      The observationNoise.

    • getMeasurementSelectionTypeValue

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

    • getMeasurementSelectionType

      public StudySpec.MeasurementSelectionType getMeasurementSelectionType()
       Describe which measurement selection type will be used
      .google.cloud.aiplatform.v1.StudySpec.MeasurementSelectionType measurement_selection_type = 7;
      Specified by:
      getMeasurementSelectionType in interface StudySpecOrBuilder
      Returns:
      The measurementSelectionType.

    • 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;
      Specified by:
      hasStudyStoppingConfig in interface StudySpecOrBuilder
      Returns:
      Whether the studyStoppingConfig field is set.

    • 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;
      Specified by:
      getStudyStoppingConfig in interface StudySpecOrBuilder
      Returns:
      The studyStoppingConfig.

    • 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;
      Specified by:
      getStudyStoppingConfigOrBuilder in interface StudySpecOrBuilder

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static StudySpec parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static StudySpec parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static StudySpec parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static StudySpec parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static StudySpec parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static StudySpec parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static StudySpec parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static StudySpec parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static StudySpec parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static StudySpec parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static StudySpec parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static StudySpec parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public StudySpec.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static StudySpec.Builder newBuilder()

    • newBuilder

      public static StudySpec.Builder newBuilder(StudySpec prototype)

    • toBuilder

      public StudySpec.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected StudySpec.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static StudySpec getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<StudySpec> parser()

    • getParserForType

      public com.google.protobuf.Parser<StudySpec> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage

    • getDefaultInstanceForType

      public StudySpec getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder