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:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface TrainingSpecification.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`AdditionalS3DataSource`	`additionalS3DataSource()`	The additional data source used during the training job.
`static TrainingSpecification.Builder`	`builder()`
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasMetricDefinitions()`	For responses, this returns true if the service returned a value for the MetricDefinitions property.
`boolean`	`hasSupportedHyperParameters()`	For responses, this returns true if the service returned a value for the SupportedHyperParameters property.
`boolean`	`hasSupportedTrainingInstanceTypes()`	For responses, this returns true if the service returned a value for the SupportedTrainingInstanceTypes property.
`boolean`	`hasSupportedTuningJobObjectiveMetrics()`	For responses, this returns true if the service returned a value for the SupportedTuningJobObjectiveMetrics property.
`boolean`	`hasTrainingChannels()`	For responses, this returns true if the service returned a value for the TrainingChannels property.
`List<MetricDefinition>`	`metricDefinitions()`	A list of `MetricDefinition` objects, which are used for parsing metrics generated by the algorithm.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends TrainingSpecification.Builder>`	`serializableBuilderClass()`
`List<HyperParameterSpecification>`	`supportedHyperParameters()`	A list of the `HyperParameterSpecification` objects, that define the supported hyperparameters.
`List<TrainingInstanceType>`	`supportedTrainingInstanceTypes()`	A list of the instance types that this algorithm can use for training.
`List<String>`	`supportedTrainingInstanceTypesAsStrings()`	A list of the instance types that this algorithm can use for training.
`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.
`Boolean`	`supportsDistributedTraining()`	Indicates whether the algorithm supports distributed training.
`TrainingSpecification.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.
`List<ChannelSpecification>`	`trainingChannels()`	A list of `ChannelSpecification` objects, which specify the input sources to be used by the algorithm.
`String`	`trainingImage()`	The Amazon ECR registry path of the Docker image that contains the training algorithm.
`String`	`trainingImageDigest()`	An MD5 hash of the training algorithm that identifies the Docker image used for training.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - 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()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<TrainingSpecification.Builder,TrainingSpecification>
  - 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)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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
  - sdkFieldNameToField
```
public final Map<String,SdkField<?>> sdkFieldNameToField()
```
    Specified by:
    
    sdkFieldNameToField in interface SdkPojo

Class TrainingSpecification

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

trainingImage

trainingImageDigest

hasSupportedHyperParameters

supportedHyperParameters

supportedTrainingInstanceTypes

hasSupportedTrainingInstanceTypes

supportedTrainingInstanceTypesAsStrings

supportsDistributedTraining

hasMetricDefinitions

metricDefinitions

hasTrainingChannels

trainingChannels

hasSupportedTuningJobObjectiveMetrics

supportedTuningJobObjectiveMetrics

additionalS3DataSource

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField