Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
SPDX-License-Identifier: CC-BY-SA-4.0

TrainingJobDefinition

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

HyperParameters The hyperparameters used for the training job.
Type: String to string map
Key Length Constraints: Maximum length of 256.
Key Pattern: .*
Value Length Constraints: Maximum length of 256.
Value Pattern: .*
Required: No

InputDataConfig An array of Channel objects, each of which specifies an input source.
Type: Array of Channel objects
Array Members: Minimum number of 1 item. Maximum number of 20 items.
Required: Yes

OutputDataConfig the path to the S3 bucket where you want to store model artifacts. Amazon SageMaker creates subfolders for the artifacts.
Type: OutputDataConfig object
Required: Yes

ResourceConfig The resources, including the ML compute instances and ML storage volumes, to use for model training.
Type: ResourceConfig object
Required: Yes

StoppingCondition Specifies a limit to how long a model training job can run. When the job reaches the time limit, Amazon SageMaker ends the training job. Use this API 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 can use this 120-second window to save the model artifacts.
Type: StoppingCondition object
Required: Yes

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.
Type: String
Valid Values:Pipe | File
Required: Yes

For more information about using this API in one of the language-specific AWS SDKs, see the following: + AWS SDK for C++ + AWS SDK for Go + AWS SDK for Go - Pilot + AWS SDK for Java + AWS SDK for Ruby V2