software.amazon.awssdk.services.sagemaker.model

Class TrainingSpecification

java.lang.Object

software.amazon.awssdk.services.sagemaker.model.TrainingSpecification

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<TrainingSpecification.Builder,TrainingSpecification>

@Generated(value="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 and Description
static interface	TrainingSpecification.Builder

Method Summary

Modifier and Type	Method and Description
static TrainingSpecification.Builder	builder()
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
List<MetricDefinition>	metricDefinitions() A list of MetricDefinition objects, which are used for parsing metrics generated by the algorithm.
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 alogorithm 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() Take this object and create a builder that contains all of the current property values of this object.
String	toString()
List<ChannelSpecification>	trainingChannels() A list of ChannelSpecification objects, which specify the input sources to be used by the algorithm.
String	trainingImage() The Amazon 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

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

trainingImage

public String trainingImage()

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

Returns:

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

trainingImageDigest

public 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.

supportedHyperParameters

public 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.

Returns:

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

supportedTrainingInstanceTypes

public 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.

Returns:

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

supportedTrainingInstanceTypesAsStrings

public 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.

Returns:

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

supportsDistributedTraining

public 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.

metricDefinitions

public 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.

Returns:

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

trainingChannels

public 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.

Returns:

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

supportedTuningJobObjectiveMetrics

public List<HyperParameterTuningJobObjective> supportedTuningJobObjectiveMetrics()

A list of the metrics that the alogorithm 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.

Returns:

A list of the metrics that the alogorithm emits that can be used as the objective metric in a hyperparameter tuning 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 int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

sdkFields

public 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.