Class StudySpec

  • All Implemented Interfaces:
    StudySpecOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

    public final class StudySpec
    extends com.google.protobuf.GeneratedMessageV3
    implements StudySpecOrBuilder
     Represents specification of a Study.
     
    Protobuf type google.cloud.aiplatform.v1.StudySpec
    See Also:
    Serialized Form
    • Field Detail

      • DECAY_CURVE_STOPPING_SPEC_FIELD_NUMBER

        public static final int DECAY_CURVE_STOPPING_SPEC_FIELD_NUMBER
        See Also:
        Constant Field Values
      • MEDIAN_AUTOMATED_STOPPING_SPEC_FIELD_NUMBER

        public static final int MEDIAN_AUTOMATED_STOPPING_SPEC_FIELD_NUMBER
        See Also:
        Constant Field Values
      • CONVEX_AUTOMATED_STOPPING_SPEC_FIELD_NUMBER

        public static final int CONVEX_AUTOMATED_STOPPING_SPEC_FIELD_NUMBER
        See Also:
        Constant Field Values
      • PARAMETERS_FIELD_NUMBER

        public static final int PARAMETERS_FIELD_NUMBER
        See Also:
        Constant Field Values
      • OBSERVATION_NOISE_FIELD_NUMBER

        public static final int OBSERVATION_NOISE_FIELD_NUMBER
        See Also:
        Constant Field Values
      • MEASUREMENT_SELECTION_TYPE_FIELD_NUMBER

        public static final int MEASUREMENT_SELECTION_TYPE_FIELD_NUMBER
        See Also:
        Constant Field Values
    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3
      • getDescriptor

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

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3
      • 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.
      • 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.
      • 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.
      • 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
      • 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
      • 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
      • 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.
      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3
      • 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.GeneratedMessageV3
        Throws:
        IOException
      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3
      • 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​(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
      • 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.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3
      • 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.GeneratedMessageV3
      • getDefaultInstanceForType

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