View a markdown version of this page

AWS::SageMaker::TrainingJob AlgorithmSpecification - AWS CloudFormation
SyntaxProperties

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::TrainingJob AlgorithmSpecification

Specifies the training algorithm to use in a CreateTrainingJob request.

Important

SageMaker uses its own SageMaker account credentials to pull and access built-in algorithms so built-in algorithms are universally accessible across all AWS accounts. As a result, built-in algorithms have standard, unrestricted access. You cannot restrict built-in algorithms using IAM roles. Use custom algorithms if you require specific access controls.

For more information about algorithms provided by SageMaker, see Algorithms. For information about using your own algorithms, see Using Your Own Algorithms with Amazon SageMaker.

Syntax

To declare this entity in your CloudFormation template, use the following syntax:

JSON

{
  "AlgorithmName" : String,
  "ContainerArguments" : [ String, ... ],
  "ContainerEntrypoint" : [ String, ... ],
  "EnableSageMakerMetricsTimeSeries" : Boolean,
  "MetricDefinitions" : [ MetricDefinition, ... ],
  "TrainingImage" : String,
  "TrainingImageConfig" : TrainingImageConfig,
  "TrainingInputMode" : String
}

Properties

AlgorithmName

The name of the algorithm resource to use for the training job. This must be an algorithm resource that you created or subscribe to on AWS Marketplace.

Note

You must specify either the algorithm name to the AlgorithmName parameter or the image URI of the algorithm container to the TrainingImage parameter.

Note that the AlgorithmName parameter is mutually exclusive with the TrainingImage parameter. If you specify a value for the AlgorithmName parameter, you can't specify a value for TrainingImage, and vice versa.

If you specify values for both parameters, the training job might break; if you don't specify any value for both parameters, the training job might raise a null error.

Required: No

Type: String

Pattern: (arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:[a-z\-]*\/)?([a-zA-Z0-9]([a-zA-Z0-9-]){0,62})(?<!-)$

Minimum: 1

Maximum: 170

Update requires: Replacement

ContainerArguments

The arguments for a container used to run a training job. See How Amazon SageMaker Runs Your Training Image for additional information.

Required: No

Type: Array of String

Maximum: 256 | 100

Update requires: Replacement

ContainerEntrypoint

The entrypoint script for a Docker container used to run a training job. This script takes precedence over the default train processing instructions. See How Amazon SageMaker Runs Your Training Image for more information.

Required: No

Type: Array of String

Maximum: 256 | 100

Update requires: Replacement

EnableSageMakerMetricsTimeSeries

To generate and save time-series metrics during training, set to true. The default is false and time-series metrics aren't generated except in the following cases:

Required: No

Type: Boolean

Update requires: Replacement

MetricDefinitions

A list of metric definition objects. Each object specifies the metric name and regular expressions used to parse algorithm logs. SageMaker publishes each metric to Amazon CloudWatch.

Required: No

Type: Array of MetricDefinition

Maximum: 40

Update requires: Replacement

TrainingImage

The registry path of the Docker image that contains the training algorithm. For information about docker registry paths for SageMaker built-in algorithms, see Docker Registry Paths and Example Code in the Amazon SageMaker developer guide. SageMaker supports both registry/repository[:tag] and registry/repository[@digest] image path formats. For more information about using your custom training container, see Using Your Own Algorithms with Amazon SageMaker.

Note

You must specify either the algorithm name to the AlgorithmName parameter or the image URI of the algorithm container to the TrainingImage parameter.

For more information, see the note in the AlgorithmName parameter description.

Required: No

Type: String

Pattern: .*

Maximum: 255

Update requires: Replacement

TrainingImageConfig

The configuration to use an image from a private Docker registry for a training job.

Required: No

Type: TrainingImageConfig

Update requires: Replacement

TrainingInputMode

Property description not available.

Required: Yes

Type: String

Allowed values: Pipe | File | FastFile

Update requires: Replacement