Package software.amazon.awssdk.services.sagemaker.model

Class HyperParameterSpecification

java.lang.Object
software.amazon.awssdk.services.sagemaker.model.HyperParameterSpecification
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<HyperParameterSpecification.Builder,HyperParameterSpecification>
@Generated("software.amazon.awssdk:codegen") public final class HyperParameterSpecification extends Object implements SdkPojo, Serializable, ToCopyableBuilder<HyperParameterSpecification.Builder,HyperParameterSpecification>

Defines a hyperparameter to be used by an algorithm.

See Also:

  • Method Details

    • name

      public final String name()

      The name of this hyperparameter. The name must be unique.

      Returns:
      The name of this hyperparameter. The name must be unique.

    • description

      public final String description()

      A brief description of the hyperparameter.

      Returns:
      A brief description of the hyperparameter.

    • type

      public final ParameterType type()

      The type of this hyperparameter. The valid types are Integer, Continuous, Categorical, and FreeText.

      If the service returns an enum value that is not available in the current SDK version, type will return ParameterType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

      Returns:
      The type of this hyperparameter. The valid types are Integer, Continuous, Categorical, and FreeText.
      See Also:

    • typeAsString

      public final String typeAsString()

      The type of this hyperparameter. The valid types are Integer, Continuous, Categorical, and FreeText.

      If the service returns an enum value that is not available in the current SDK version, type will return ParameterType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

      Returns:
      The type of this hyperparameter. The valid types are Integer, Continuous, Categorical, and FreeText.
      See Also:

    • range

      public final ParameterRange range()

      The allowed range for this hyperparameter.

      Returns:
      The allowed range for this hyperparameter.

    • isTunable

      public final Boolean isTunable()

      Indicates whether this hyperparameter is tunable in a hyperparameter tuning job.

      Returns:
      Indicates whether this hyperparameter is tunable in a hyperparameter tuning job.

    • isRequired

      public final Boolean isRequired()

      Indicates whether this hyperparameter is required.

      Returns:
      Indicates whether this hyperparameter is required.

    • defaultValue

      public final String defaultValue()

      The default value for this hyperparameter. If a default value is specified, a hyperparameter cannot be required.

      Returns:
      The default value for this hyperparameter. If a default value is specified, a hyperparameter cannot be required.

    • toBuilder

      public HyperParameterSpecification.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<HyperParameterSpecification.Builder,HyperParameterSpecification>
      Returns:
      a builder for type T

    • builder

      public static HyperParameterSpecification.Builder builder()

    • serializableBuilderClass

      public static Class<? extends HyperParameterSpecification.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.