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

Class ContinuousParameterRange

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

A list of continuous hyperparameters to tune.

See Also:

  • Method Details

    • name

      public final String name()

      The name of the continuous hyperparameter to tune.

      Returns:
      The name of the continuous hyperparameter to tune.

    • minValue

      public final String minValue()

      The minimum value for the hyperparameter. The tuning job uses floating-point values between this value and MaxValuefor tuning.

      Returns:
      The minimum value for the hyperparameter. The tuning job uses floating-point values between this value and MaxValuefor tuning.

    • maxValue

      public final String maxValue()

      The maximum value for the hyperparameter. The tuning job uses floating-point values between MinValue value and this value for tuning.

      Returns:
      The maximum value for the hyperparameter. The tuning job uses floating-point values between MinValue value and this value for tuning.

    • scalingType

      public final HyperParameterScalingType scalingType()

      The scale that hyperparameter tuning uses to search the hyperparameter range. For information about choosing a hyperparameter scale, see Hyperparameter Scaling. One of the following values:

      Auto

      SageMaker hyperparameter tuning chooses the best scale for the hyperparameter.

      Linear

      Hyperparameter tuning searches the values in the hyperparameter range by using a linear scale.

      Logarithmic

      Hyperparameter tuning searches the values in the hyperparameter range by using a logarithmic scale.

      Logarithmic scaling works only for ranges that have only values greater than 0.

      ReverseLogarithmic

      Hyperparameter tuning searches the values in the hyperparameter range by using a reverse logarithmic scale.

      Reverse logarithmic scaling works only for ranges that are entirely within the range 0<=x<1.0.

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

      Returns:
      The scale that hyperparameter tuning uses to search the hyperparameter range. For information about choosing a hyperparameter scale, see Hyperparameter Scaling. One of the following values:

      Auto

      SageMaker hyperparameter tuning chooses the best scale for the hyperparameter.

      Linear

      Hyperparameter tuning searches the values in the hyperparameter range by using a linear scale.

      Logarithmic

      Hyperparameter tuning searches the values in the hyperparameter range by using a logarithmic scale.

      Logarithmic scaling works only for ranges that have only values greater than 0.

      ReverseLogarithmic

      Hyperparameter tuning searches the values in the hyperparameter range by using a reverse logarithmic scale.

      Reverse logarithmic scaling works only for ranges that are entirely within the range 0<=x<1.0.

      See Also:

    • scalingTypeAsString

      public final String scalingTypeAsString()

      The scale that hyperparameter tuning uses to search the hyperparameter range. For information about choosing a hyperparameter scale, see Hyperparameter Scaling. One of the following values:

      Auto

      SageMaker hyperparameter tuning chooses the best scale for the hyperparameter.

      Linear

      Hyperparameter tuning searches the values in the hyperparameter range by using a linear scale.

      Logarithmic

      Hyperparameter tuning searches the values in the hyperparameter range by using a logarithmic scale.

      Logarithmic scaling works only for ranges that have only values greater than 0.

      ReverseLogarithmic

      Hyperparameter tuning searches the values in the hyperparameter range by using a reverse logarithmic scale.

      Reverse logarithmic scaling works only for ranges that are entirely within the range 0<=x<1.0.

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

      Returns:
      The scale that hyperparameter tuning uses to search the hyperparameter range. For information about choosing a hyperparameter scale, see Hyperparameter Scaling. One of the following values:

      Auto

      SageMaker hyperparameter tuning chooses the best scale for the hyperparameter.

      Linear

      Hyperparameter tuning searches the values in the hyperparameter range by using a linear scale.

      Logarithmic

      Hyperparameter tuning searches the values in the hyperparameter range by using a logarithmic scale.

      Logarithmic scaling works only for ranges that have only values greater than 0.

      ReverseLogarithmic

      Hyperparameter tuning searches the values in the hyperparameter range by using a reverse logarithmic scale.

      Reverse logarithmic scaling works only for ranges that are entirely within the range 0<=x<1.0.

      See Also:

    • toBuilder

      public ContinuousParameterRange.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<ContinuousParameterRange.Builder,ContinuousParameterRange>
      Returns:
      a builder for type T

    • builder

      public static ContinuousParameterRange.Builder builder()

    • serializableBuilderClass

      public static Class<? extends ContinuousParameterRange.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.