software.amazon.awssdk.services.sagemaker.model

Enum TrainingInputMode

java.lang.Object

java.lang.Enum<TrainingInputMode>

software.amazon.awssdk.services.sagemaker.model.TrainingInputMode

All Implemented Interfaces:

Serializable, Comparable<TrainingInputMode>

@Generated(value="software.amazon.awssdk:codegen")
public enum TrainingInputMode
extends Enum<TrainingInputMode>

The training input mode that the algorithm supports. For more information about input modes, see Algorithms.

Pipe mode

If an algorithm supports Pipe mode, Amazon SageMaker streams data directly from Amazon S3 to the container.

File mode

If an algorithm supports File mode, SageMaker downloads the training data from S3 to the provisioned ML storage volume, and mounts the directory to the Docker volume for the training container.

You must provision the ML storage volume with sufficient capacity to accommodate the data downloaded from S3. In addition to the training data, the ML storage volume also stores the output model. The algorithm container uses the ML storage volume to also store intermediate information, if any.

For distributed algorithms, training data is distributed uniformly. Your training duration is predictable if the input data objects sizes are approximately the same. SageMaker does not split the files any further for model training. If the object sizes are skewed, training won't be optimal as the data distribution is also skewed when one host in a training cluster is overloaded, thus becoming a bottleneck in training.

FastFile mode

If an algorithm supports FastFile mode, SageMaker streams data directly from S3 to the container with no code changes, and provides file system access to the data. Users can author their training script to interact with these files as if they were stored on disk.

FastFile mode works best when the data is read sequentially. Augmented manifest files aren't supported. The startup time is lower when there are fewer files in the S3 bucket provided.

Enum Constant Summary

Enum Constants

Enum Constant and Description
FAST_FILE
FILE
PIPE
UNKNOWN_TO_SDK_VERSION

Method Summary

Modifier and Type	Method and Description
static TrainingInputMode	fromValue(String value) Use this in place of valueOf to convert the raw string returned by the service into the enum value.
static Set<TrainingInputMode>	knownValues() Use this in place of values() to return a Set of all values known to the SDK.
String	toString()
static TrainingInputMode	valueOf(String name) Returns the enum constant of this type with the specified name.
static TrainingInputMode[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

PIPE

public static final TrainingInputMode PIPE

FILE

public static final TrainingInputMode FILE

FAST_FILE

public static final TrainingInputMode FAST_FILE

UNKNOWN_TO_SDK_VERSION

public static final TrainingInputMode UNKNOWN_TO_SDK_VERSION

Method Detail

values

public static TrainingInputMode[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (TrainingInputMode c : TrainingInputMode.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static TrainingInputMode valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

toString

public String toString()

Overrides:

toString in class Enum<TrainingInputMode>

fromValue

public static TrainingInputMode fromValue(String value)

Use this in place of valueOf to convert the raw string returned by the service into the enum value.

Parameters:

value - real value

Returns:

TrainingInputMode corresponding to the value

knownValues

public static Set<TrainingInputMode> knownValues()

Use this in place of values() to return a Set of all values known to the SDK. This will return all known enum values except UNKNOWN_TO_SDK_VERSION.

Returns:

a Set of known TrainingInputModes