Package software.amazon.awssdk.services.forecast.model

Class HyperParameterTuningJobConfig

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

Configuration information for a hyperparameter tuning job. You specify this object in the CreatePredictor request.

A hyperparameter is a parameter that governs the model training process. You set hyperparameters before training starts, unlike model parameters, which are determined during training. The values of the hyperparameters effect which values are chosen for the model parameters.

In a hyperparameter tuning job, Amazon Forecast chooses the set of hyperparameter values that optimize a specified metric. Forecast accomplishes this by running many training jobs over a range of hyperparameter values. The optimum set of values depends on the algorithm, the training data, and the specified metric objective.

See Also:

  • Method Details

    • parameterRanges

      public final ParameterRanges parameterRanges()

      Specifies the ranges of valid values for the hyperparameters.

      Returns:
      Specifies the ranges of valid values for the hyperparameters.

    • toBuilder

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

    • builder

      public static HyperParameterTuningJobConfig.Builder builder()

    • serializableBuilderClass

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