Class ContinuousParameterRange

    • Method Detail

      • 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:
        HyperParameterScalingType
      • 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:
        HyperParameterScalingType
      • hashCode

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

        public final boolean equals​(Object obj)
        Overrides:
        equals in class Object
      • 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)