software.amazon.awssdk.services.sagemaker.model

Class TrainingJobDefinition

java.lang.Object

software.amazon.awssdk.services.sagemaker.model.TrainingJobDefinition

All Implemented Interfaces:

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

@Generated(value="software.amazon.awssdk:codegen")
public final class TrainingJobDefinition
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<TrainingJobDefinition.Builder,TrainingJobDefinition>

Defines the input needed to run a training job using the algorithm.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	TrainingJobDefinition.Builder

Method Summary

Modifier and Type	Method and Description
static TrainingJobDefinition.Builder	builder()
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Map<String,String>	hyperParameters() The hyperparameters used for the training job.
List<Channel>	inputDataConfig() An array of Channel objects, each of which specifies an input source.
OutputDataConfig	outputDataConfig() the path to the S3 bucket where you want to store model artifacts.
ResourceConfig	resourceConfig() The resources, including the ML compute instances and ML storage volumes, to use for model training.
List<SdkField<?>>	sdkFields()
static Class<? extends TrainingJobDefinition.Builder>	serializableBuilderClass()
StoppingCondition	stoppingCondition() Sets a duration for training.
TrainingJobDefinition.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()
TrainingInputMode	trainingInputMode() The input mode used by the algorithm for the training job.
String	trainingInputModeAsString() The input mode used by the algorithm for the training job.

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

trainingInputMode

public TrainingInputMode trainingInputMode()

The input mode used by the algorithm for the training job. For the input modes that Amazon SageMaker algorithms support, see Algorithms.

If an algorithm supports the File input mode, Amazon SageMaker downloads the training data from S3 to the provisioned ML storage Volume, and mounts the directory to docker volume for training container. If an algorithm supports the Pipe input mode, Amazon SageMaker streams data directly from S3 to the container.

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 input mode used by the algorithm for the training job. For the input modes that Amazon SageMaker algorithms support, see Algorithms.

If an algorithm supports the File input mode, Amazon SageMaker downloads the training data from S3 to the provisioned ML storage Volume, and mounts the directory to docker volume for training container. If an algorithm supports the Pipe input mode, Amazon SageMaker streams data directly from S3 to the container.

See Also:

TrainingInputMode

trainingInputModeAsString

public String trainingInputModeAsString()

The input mode used by the algorithm for the training job. For the input modes that Amazon SageMaker algorithms support, see Algorithms.

If an algorithm supports the File input mode, Amazon SageMaker downloads the training data from S3 to the provisioned ML storage Volume, and mounts the directory to docker volume for training container. If an algorithm supports the Pipe input mode, Amazon SageMaker streams data directly from S3 to the container.

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 input mode used by the algorithm for the training job. For the input modes that Amazon SageMaker algorithms support, see Algorithms.

If an algorithm supports the File input mode, Amazon SageMaker downloads the training data from S3 to the provisioned ML storage Volume, and mounts the directory to docker volume for training container. If an algorithm supports the Pipe input mode, Amazon SageMaker streams data directly from S3 to the container.

See Also:

TrainingInputMode

hyperParameters

public Map<String,String> hyperParameters()

The hyperparameters used for the training job.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

The hyperparameters used for the training job.

inputDataConfig

public List<Channel> inputDataConfig()

An array of Channel objects, each of which specifies an input source.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

An array of Channel objects, each of which specifies an input source.

outputDataConfig

public OutputDataConfig outputDataConfig()

the path to the S3 bucket where you want to store model artifacts. Amazon SageMaker creates subfolders for the artifacts.

Returns:

the path to the S3 bucket where you want to store model artifacts. Amazon SageMaker creates subfolders for the artifacts.

resourceConfig

public ResourceConfig resourceConfig()

The resources, including the ML compute instances and ML storage volumes, to use for model training.

Returns:

The resources, including the ML compute instances and ML storage volumes, to use for model training.

stoppingCondition

public StoppingCondition stoppingCondition()

Sets a duration for training. Use this parameter to cap model training costs.

To stop a job, Amazon SageMaker sends the algorithm the SIGTERM signal, which delays job termination for 120 seconds. Algorithms might use this 120-second window to save the model artifacts.

Returns:

Sets a duration for training. Use this parameter to cap model training costs.

To stop a job, Amazon SageMaker sends the algorithm the SIGTERM signal, which delays job termination for 120 seconds. Algorithms might use this 120-second window to save the model artifacts.

toBuilder

public TrainingJobDefinition.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<TrainingJobDefinition.Builder,TrainingJobDefinition>

Returns:

a builder for type T

builder

public static TrainingJobDefinition.Builder builder()

serializableBuilderClass

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