Class TrainingSpecification

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

Defines how the algorithm is used for a training job.

See Also:

  • Method Details

    • trainingImage

      public final String trainingImage()

      The Amazon ECR registry path of the Docker image that contains the training algorithm.

      Returns:
      The Amazon ECR registry path of the Docker image that contains the training algorithm.

    • trainingImageDigest

      public final String trainingImageDigest()

      An MD5 hash of the training algorithm that identifies the Docker image used for training.

      Returns:
      An MD5 hash of the training algorithm that identifies the Docker image used for training.

    • hasSupportedHyperParameters

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

    • supportedHyperParameters

      public final List<HyperParameterSpecification> supportedHyperParameters()

      A list of the HyperParameterSpecification objects, that define the supported hyperparameters. This is required if the algorithm supports automatic model tuning.>

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

      Returns:
      A list of the HyperParameterSpecification objects, that define the supported hyperparameters. This is required if the algorithm supports automatic model tuning.>

    • supportedTrainingInstanceTypes

      public final List<TrainingInstanceType> supportedTrainingInstanceTypes()

      A list of the instance types that this algorithm can use for training.

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

      Returns:
      A list of the instance types that this algorithm can use for training.

    • hasSupportedTrainingInstanceTypes

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

    • supportedTrainingInstanceTypesAsStrings

      public final List<String> supportedTrainingInstanceTypesAsStrings()

      A list of the instance types that this algorithm can use for training.

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

      Returns:
      A list of the instance types that this algorithm can use for training.

    • supportsDistributedTraining

      public final Boolean supportsDistributedTraining()

      Indicates whether the algorithm supports distributed training. If set to false, buyers can't request more than one instance during training.

      Returns:
      Indicates whether the algorithm supports distributed training. If set to false, buyers can't request more than one instance during training.

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

      A list of MetricDefinition objects, which are used for parsing metrics generated by the algorithm.

      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:
      A list of MetricDefinition objects, which are used for parsing metrics generated by the algorithm.

    • hasTrainingChannels

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

    • trainingChannels

      public final List<ChannelSpecification> trainingChannels()

      A list of ChannelSpecification objects, which specify the input sources to be used by the algorithm.

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

      Returns:
      A list of ChannelSpecification objects, which specify the input sources to be used by the algorithm.

    • hasSupportedTuningJobObjectiveMetrics

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

    • supportedTuningJobObjectiveMetrics

      public final List<HyperParameterTuningJobObjective> supportedTuningJobObjectiveMetrics()

      A list of the metrics that the algorithm emits that can be used as the objective metric in a hyperparameter 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 hasSupportedTuningJobObjectiveMetrics() method.

      Returns:
      A list of the metrics that the algorithm emits that can be used as the objective metric in a hyperparameter tuning job.

    • additionalS3DataSource

      public final AdditionalS3DataSource additionalS3DataSource()

      The additional data source used during the training job.

      Returns:
      The additional data source used during the training job.

    • toBuilder

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

    • builder

      public static TrainingSpecification.Builder builder()

    • serializableBuilderClass

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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.