Package com.google.cloud.aiplatform.v1

Enum StudySpec.Algorithm

  • All Implemented Interfaces:
    com.google.protobuf.Internal.EnumLite, com.google.protobuf.ProtocolMessageEnum, Serializable, Comparable<StudySpec.Algorithm>
    Enclosing class:
    StudySpec
    public static enum StudySpec.Algorithm
extends Enum<StudySpec.Algorithm>
implements com.google.protobuf.ProtocolMessageEnum
     The available search algorithms for the Study.
    Protobuf enum google.cloud.aiplatform.v1.StudySpec.Algorithm

    • Enum Constant Detail

      • ALGORITHM_UNSPECIFIED

        public static final StudySpec.Algorithm ALGORITHM_UNSPECIFIED
         The default algorithm used by Vertex AI for [hyperparameter
 tuning](https://cloud.google.com/vertex-ai/docs/training/hyperparameter-tuning-overview)
 and [Vertex AI Vizier](https://cloud.google.com/vertex-ai/docs/vizier).
        ALGORITHM_UNSPECIFIED = 0;

      • GRID_SEARCH

        public static final StudySpec.Algorithm GRID_SEARCH
         Simple grid search within the feasible space. To use grid search,
 all parameters must be `INTEGER`, `CATEGORICAL`, or `DISCRETE`.
        GRID_SEARCH = 2;

      • RANDOM_SEARCH

        public static final StudySpec.Algorithm RANDOM_SEARCH
         Simple random search within the feasible space.
        RANDOM_SEARCH = 3;

    • Field Detail

      • ALGORITHM_UNSPECIFIED_VALUE

        public static final int ALGORITHM_UNSPECIFIED_VALUE
         The default algorithm used by Vertex AI for [hyperparameter
 tuning](https://cloud.google.com/vertex-ai/docs/training/hyperparameter-tuning-overview)
 and [Vertex AI Vizier](https://cloud.google.com/vertex-ai/docs/vizier).
        ALGORITHM_UNSPECIFIED = 0;
        See Also:
        Constant Field Values

      • GRID_SEARCH_VALUE

        public static final int GRID_SEARCH_VALUE
         Simple grid search within the feasible space. To use grid search,
 all parameters must be `INTEGER`, `CATEGORICAL`, or `DISCRETE`.
        GRID_SEARCH = 2;
        See Also:
        Constant Field Values

      • RANDOM_SEARCH_VALUE

        public static final int RANDOM_SEARCH_VALUE
         Simple random search within the feasible space.
        RANDOM_SEARCH = 3;
        See Also:
        Constant Field Values

    • Method Detail

      • values

        public static StudySpec.Algorithm[] 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.Algorithm c : StudySpec.Algorithm.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.Algorithm 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.Algorithm 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.Algorithm forNumber​(int value)
        Parameters:
        value - The numeric wire value of the corresponding enum entry.
        Returns:
        The enum associated with the given numeric wire value.

      • internalGetValueMap

        public static com.google.protobuf.Internal.EnumLiteMap<StudySpec.Algorithm> internalGetValueMap()

      • 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.Algorithm 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