Docker Registry Paths and Example Code - ECR Paths
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

Docker Registry Paths and Example Code

The following topics list the Docker registry path and other parameters for each of the Amazon SageMaker AI provided algorithms and Deep Learning Containers (DLC). For more information, see Use Pre-built SageMaker Docker images.

Use the path as follows:

  • To create a training job (create_training_job), specify the Docker registry path (TrainingImage) and the training input mode (TrainingInputMode) for the training image. You create a training job to train a model using a specific dataset.

  • To create a model (create_model), specify the Docker registry path (Image) for the inference image (PrimaryContainer Image). SageMaker AI launches machine learning compute instances that are based on the endpoint configuration and deploys the model, which includes the artifacts (the result of model training).

  • To create a model monitor, select the Amazon Region, then select Model Monitor (algorithm). For more information, see Amazon SageMaker AI Model Monitor prebuilt container.

Note

Pre-built container images are owned by SageMaker AI, and in some cases include proprietary code. Capabilities such as training and processing jobs, batch transform, and real-time inference use service-owned credentials to pull and run images on managed SageMaker AI instances. Because customer credentials aren't used, any Amazon IAM policies (including service control policies and resource control policies) that deny Amazon ECR permissions don't prevent the use of pre-built images.

Note

For the registry path, use the :1 version tag to ensure that you are using a stable version of the algorithm/DLC. You can reliably host a model trained using an image with the :1 tag on an inference image that has the :1 tag. Using the :latest tag in the registry path provides you with the most up-to-date version of the algorithm/DLC, but might cause problems with backward compatibility. Avoid using the :latest tag for production purposes.

Important

When you retrieve the SageMaker AI XGBoost image URI, do not use :latest or :1 for the image URI tag. You must specify one of the Supported versions to choose the SageMaker AI-managed XGBoost container with the native XGBoost package version that you want to use. To find the package version migrated into the SageMaker AI XGBoost containers, choose your Amazon Web Services Region then navigate to the XGBoost (algorithm) section.

To find the registry path, choose the Amazon Region, then choose the algorithm or DLC.

Topics