This is the new CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the AWS CloudFormation User Guide.
AWS::SageMaker::HyperParameterTuningJob TrainingJobDefinition
Defines the input needed to run a training job using the algorithm.
Syntax
To declare this entity in your CloudFormation template, use the following syntax:
JSON
{ "AlgorithmSpecification" :AlgorithmSpecification, "CheckpointConfig" :CheckpointConfig, "DefinitionName" :String, "EnableInterContainerTrafficEncryption" :Boolean, "EnableManagedSpotTraining" :Boolean, "EnableNetworkIsolation" :Boolean, "Environment" :{, "HyperParameterRanges" :Key:Value, ...}ParameterRanges, "InputDataConfig" :[ InputDataConfigItems, ... ], "OutputDataConfig" :OutputDataConfig, "ResourceConfig" :ResourceConfig, "RetryStrategy" :RetryStrategy, "RoleArn" :String, "StaticHyperParameters" :{, "StoppingCondition" :Key:Value, ...}StoppingCondition, "TuningObjective" :TuningObjective, "VpcConfig" :VpcConfig}
YAML
AlgorithmSpecification:AlgorithmSpecificationCheckpointConfig:CheckpointConfigDefinitionName:StringEnableInterContainerTrafficEncryption:BooleanEnableManagedSpotTraining:BooleanEnableNetworkIsolation:BooleanEnvironment:HyperParameterRanges:Key:ValueParameterRangesInputDataConfig:- InputDataConfigItemsOutputDataConfig:OutputDataConfigResourceConfig:ResourceConfigRetryStrategy:RetryStrategyRoleArn:StringStaticHyperParameters:StoppingCondition:Key:ValueStoppingConditionTuningObjective:TuningObjectiveVpcConfig:VpcConfig
Properties
AlgorithmSpecificationProperty description not available.
Required: Yes
Type: AlgorithmSpecification
Update requires: Replacement
CheckpointConfigProperty description not available.
Required: No
Type: CheckpointConfig
Update requires: Replacement
DefinitionNameProperty description not available.
Required: No
Type: String
Pattern:
[a-zA-Z0-9](-*[a-zA-Z0-9]){0,63}Minimum:
1Maximum:
64Update requires: Replacement
EnableInterContainerTrafficEncryptionProperty description not available.
Required: No
Type: Boolean
Update requires: Replacement
EnableManagedSpotTrainingProperty description not available.
Required: No
Type: Boolean
Update requires: Replacement
EnableNetworkIsolationProperty description not available.
Required: No
Type: Boolean
Update requires: Replacement
EnvironmentProperty description not available.
Required: No
Type: Object of String
Pattern:
^[a-zA-Z_][a-zA-Z0-9_]*$Minimum:
0Maximum:
512Update requires: Replacement
HyperParameterRangesProperty description not available.
Required: No
Type: ParameterRanges
Update requires: Replacement
InputDataConfig-
An array of
Channelobjects, each of which specifies an input source.Required: No
Type: Array of InputDataConfigItems
Minimum:
1Maximum:
20Update requires: Replacement
OutputDataConfig-
the path to the S3 bucket where you want to store model artifacts. SageMaker creates subfolders for the artifacts.
Required: Yes
Type: OutputDataConfig
Update requires: Replacement
ResourceConfig-
The resources, including the ML compute instances and ML storage volumes, to use for model training.
Required: No
Type: ResourceConfig
Update requires: Replacement
RetryStrategyProperty description not available.
Required: No
Type: RetryStrategy
Update requires: Replacement
RoleArnProperty description not available.
Required: Yes
Type: String
Pattern:
^arn:aws[a-z\-]*:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+$Minimum:
20Maximum:
2048Update requires: Replacement
StaticHyperParametersProperty description not available.
Required: No
Type: Object of String
Pattern:
.*Minimum:
0Maximum:
2500Update requires: Replacement
StoppingCondition-
Specifies a limit to how long a model training job can run. It also specifies how long a managed Spot training job has to complete. When the job reaches the time limit, SageMaker ends the training job. Use this API to cap model training costs.
To stop a job, 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.
Required: Yes
Type: StoppingCondition
Update requires: Replacement
TuningObjectiveProperty description not available.
Required: No
Type: TuningObjective
Update requires: Replacement
VpcConfigProperty description not available.
Required: No
Type: VpcConfig
Update requires: Replacement
