Enum StudySpec.ObservationNoise

  • All Implemented Interfaces:
    com.google.protobuf.Internal.EnumLite, com.google.protobuf.ProtocolMessageEnum, Serializable, Comparable<StudySpec.ObservationNoise>
    Enclosing class:
    StudySpec

    public static enum StudySpec.ObservationNoise
    extends Enum<StudySpec.ObservationNoise>
    implements com.google.protobuf.ProtocolMessageEnum
     Describes the noise level of the repeated observations.
    
     "Noisy" means that the repeated observations with the same Trial parameters
     may lead to different metric evaluations.
     
    Protobuf enum google.cloud.aiplatform.v1.StudySpec.ObservationNoise
    • Enum Constant Detail

      • OBSERVATION_NOISE_UNSPECIFIED

        public static final StudySpec.ObservationNoise OBSERVATION_NOISE_UNSPECIFIED
         The default noise level chosen by Vertex AI.
         
        OBSERVATION_NOISE_UNSPECIFIED = 0;
      • LOW

        public static final StudySpec.ObservationNoise LOW
         Vertex AI assumes that the objective function is (nearly)
         perfectly reproducible, and will never repeat the same Trial
         parameters.
         
        LOW = 1;
      • HIGH

        public static final StudySpec.ObservationNoise HIGH
         Vertex AI will estimate the amount of noise in metric
         evaluations, it may repeat the same Trial parameters more than once.
         
        HIGH = 2;
    • Field Detail

      • OBSERVATION_NOISE_UNSPECIFIED_VALUE

        public static final int OBSERVATION_NOISE_UNSPECIFIED_VALUE
         The default noise level chosen by Vertex AI.
         
        OBSERVATION_NOISE_UNSPECIFIED = 0;
        See Also:
        Constant Field Values
      • LOW_VALUE

        public static final int LOW_VALUE
         Vertex AI assumes that the objective function is (nearly)
         perfectly reproducible, and will never repeat the same Trial
         parameters.
         
        LOW = 1;
        See Also:
        Constant Field Values
      • HIGH_VALUE

        public static final int HIGH_VALUE
         Vertex AI will estimate the amount of noise in metric
         evaluations, it may repeat the same Trial parameters more than once.
         
        HIGH = 2;
        See Also:
        Constant Field Values
    • Method Detail

      • values

        public static StudySpec.ObservationNoise[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
        for (StudySpec.ObservationNoise c : StudySpec.ObservationNoise.values())
            System.out.println(c);
        
        Returns:
        an array containing the constants of this enum type, in the order they are declared
      • valueOf

        public static StudySpec.ObservationNoise valueOf​(String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
        Parameters:
        name - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        IllegalArgumentException - if this enum type has no constant with the specified name
        NullPointerException - if the argument is null
      • getNumber

        public final int getNumber()
        Specified by:
        getNumber in interface com.google.protobuf.Internal.EnumLite
        Specified by:
        getNumber in interface com.google.protobuf.ProtocolMessageEnum
      • valueOf

        @Deprecated
        public static StudySpec.ObservationNoise valueOf​(int value)
        Deprecated.
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
        Parameters:
        value - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        IllegalArgumentException - if this enum type has no constant with the specified name
        NullPointerException - if the argument is null
      • forNumber

        public static StudySpec.ObservationNoise forNumber​(int value)
        Parameters:
        value - The numeric wire value of the corresponding enum entry.
        Returns:
        The enum associated with the given numeric wire value.
      • getValueDescriptor

        public final com.google.protobuf.Descriptors.EnumValueDescriptor getValueDescriptor()
        Specified by:
        getValueDescriptor in interface com.google.protobuf.ProtocolMessageEnum
      • getDescriptorForType

        public final com.google.protobuf.Descriptors.EnumDescriptor getDescriptorForType()
        Specified by:
        getDescriptorForType in interface com.google.protobuf.ProtocolMessageEnum
      • getDescriptor

        public static final com.google.protobuf.Descriptors.EnumDescriptor getDescriptor()
      • valueOf

        public static StudySpec.ObservationNoise valueOf​(com.google.protobuf.Descriptors.EnumValueDescriptor desc)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
        Parameters:
        desc - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        IllegalArgumentException - if this enum type has no constant with the specified name
        NullPointerException - if the argument is null