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

Class ParameterRanges

  • All Implemented Interfaces:
    Serializable, SdkPojo, ToCopyableBuilder<ParameterRanges.Builder,​ParameterRanges>
    @Generated("software.amazon.awssdk:codegen")
public final class ParameterRanges
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<ParameterRanges.Builder,​ParameterRanges>

    Specifies ranges of integer, continuous, and categorical hyperparameters that a hyperparameter tuning job searches. The hyperparameter tuning job launches training jobs with hyperparameter values within these ranges to find the combination of values that result in the training job with the best performance as measured by the objective metric of the hyperparameter tuning job.

    The maximum number of items specified for Array Members refers to the maximum number of hyperparameters for each range and also the maximum for the hyperparameter tuning job itself. That is, the sum of the number of hyperparameters for all the ranges can't exceed the maximum number specified.

    See Also:
    Serialized Form

    • Method Detail

      • hasIntegerParameterRanges

        public final boolean hasIntegerParameterRanges()
        For responses, this returns true if the service returned a value for the IntegerParameterRanges property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

      • integerParameterRanges

        public final List<IntegerParameterRange> integerParameterRanges()

        The array of IntegerParameterRange objects that specify ranges of integer hyperparameters that a hyperparameter tuning job searches.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasIntegerParameterRanges() method.

        Returns:
        The array of IntegerParameterRange objects that specify ranges of integer hyperparameters that a hyperparameter tuning job searches.

      • hasContinuousParameterRanges

        public final boolean hasContinuousParameterRanges()
        For responses, this returns true if the service returned a value for the ContinuousParameterRanges property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

      • continuousParameterRanges

        public final List<ContinuousParameterRange> continuousParameterRanges()

        The array of ContinuousParameterRange objects that specify ranges of continuous hyperparameters that a hyperparameter tuning job searches.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasContinuousParameterRanges() method.

        Returns:
        The array of ContinuousParameterRange objects that specify ranges of continuous hyperparameters that a hyperparameter tuning job searches.

      • hasCategoricalParameterRanges

        public final boolean hasCategoricalParameterRanges()
        For responses, this returns true if the service returned a value for the CategoricalParameterRanges property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

      • categoricalParameterRanges

        public final List<CategoricalParameterRange> categoricalParameterRanges()

        The array of CategoricalParameterRange objects that specify ranges of categorical hyperparameters that a hyperparameter tuning job searches.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasCategoricalParameterRanges() method.

        Returns:
        The array of CategoricalParameterRange objects that specify ranges of categorical hyperparameters that a hyperparameter tuning job searches.

      • hasAutoParameters

        public final boolean hasAutoParameters()
        For responses, this returns true if the service returned a value for the AutoParameters property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

      • autoParameters

        public final List<AutoParameter> autoParameters()

        A list containing hyperparameter names and example values to be used by Autotune to determine optimal ranges for your tuning job.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasAutoParameters() method.

        Returns:
        A list containing hyperparameter names and example values to be used by Autotune to determine optimal ranges for your tuning job.

      • 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)