Class HyperParameterAlgorithmSpecification

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

Specifies which training algorithm to use for training jobs that a hyperparameter tuning job launches and the metrics to monitor.

See Also:

  • Method Details

    • trainingImage

      public final String trainingImage()

      The registry path of the Docker image that contains the training algorithm. For information about Docker registry paths for built-in algorithms, see Algorithms Provided by Amazon SageMaker: Common Parameters. SageMaker supports both registry/repository[:tag] and registry/repository[@digest] image path formats. For more information, see Using Your Own Algorithms with Amazon SageMaker.

      Returns:
      The registry path of the Docker image that contains the training algorithm. For information about Docker registry paths for built-in algorithms, see Algorithms Provided by Amazon SageMaker: Common Parameters. SageMaker supports both registry/repository[:tag] and registry/repository[@digest] image path formats. For more information, see Using Your Own Algorithms with Amazon SageMaker.

    • trainingInputMode

      public final TrainingInputMode trainingInputMode()
      Returns the value of the TrainingInputMode property for this object.

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

      Returns:
      The value of the TrainingInputMode property for this object.
      See Also:

    • trainingInputModeAsString

      public final String trainingInputModeAsString()
      Returns the value of the TrainingInputMode property for this object.

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

      Returns:
      The value of the TrainingInputMode property for this object.
      See Also:

    • algorithmName

      public final String algorithmName()

      The name of the resource algorithm to use for the hyperparameter tuning job. If you specify a value for this parameter, do not specify a value for TrainingImage.

      Returns:
      The name of the resource algorithm to use for the hyperparameter tuning job. If you specify a value for this parameter, do not specify a value for TrainingImage.

    • hasMetricDefinitions

      public final boolean hasMetricDefinitions()
      For responses, this returns true if the service returned a value for the MetricDefinitions 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.

    • metricDefinitions

      public final List<MetricDefinition> metricDefinitions()

      An array of MetricDefinition objects that specify the metrics that the algorithm emits.

      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 hasMetricDefinitions() method.

      Returns:
      An array of MetricDefinition objects that specify the metrics that the algorithm emits.

    • toBuilder

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

    • builder

      public static HyperParameterAlgorithmSpecification.Builder builder()

    • serializableBuilderClass

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