Neuron DLAMI User Guide#
Neuron DLAMI Overview#
Neuron DLAMIs are an easy way to get started on Neuron SDK as they come pre-installed with Neuron SDK. Neuron currently supports 3 types of DLAMIs, multi-framework DLAMIs , single framework DLAMIs and base DLAMIs to easily get started on single Neuron instance. Below sections describe the supported Neuron DLAMIs, corresponding virtual environments and easy way to retrieve the DLAMI id using SSM parameters.
Neuron Multi Framework DLAMI#
Neuron Deep Learning AMI (DLAMI) is a multi-framework DLAMI that supports multiple Neuron framework/libraries. Each DLAMI is pre-installed with Neuron drivers and support all Neuron instance types. Each virtual environment that corresponds to a specific Neuron framework/library comes pre-installed with all the Neuron libraries including Neuron compiler and Neuron runtime needed for you to easily get started.
Note
Tensorflow-neuron 2.10 (inf1) released in SDK v2.20.2 is not compatible with the latest runtime in v2.21 SDK. Code that compiles will face runtime errors with the latest SDK 2.21.1 version.
Neuron team is aware of this issue and it will be fixed in the next minor release.
Please refer to this page for more information on the issue and a temporary work-around.
Multi Framework DLAMIs supported#
Operating System |
Neuron Instances Supported |
DLAMI Name |
|---|---|---|
Ubuntu 22.04 |
Inf2, Trn1, Trn1n, Trn2 |
Deep Learning AMI Neuron (Ubuntu 22.04) |
Amazon Linux 2023 |
Inf2, Trn1, Trn1n, Trn2 |
Deep Learning AMI Neuron (Amazon Linux 2023) |
Virtual Environments pre-installed#
Neuron Framework/Libraries supported |
Virtual Environment |
|---|---|
PyTorch 2.5 Torch NeuronX, NxD Core |
/opt/aws_neuronx_venv_pytorch_2_5 |
PyTorch 2.5 NxD Training, Torch NeuronX |
/opt/aws_neuronx_venv_pytorch_2_5_nxd_training |
PyTorch 2.5 NxD Inference, Torch NeuronX |
/opt/aws_neuronx_venv_pytorch_2_5_nxd_inference |
JAX 0.4 NeuronX |
/opt/aws_neuronx_venv_jax_0_4 |
Tensorflow 2.10 NeuronX |
/opt/aws_neuronx_venv_tensorflow_2_10 |
Transformers NeuronX (PyTorch 2.5) |
/opt/aws_neuronx_venv_pytorch_2_5_transformers |
Tensorflow 2.10 Neuron (Inf1) |
/opt/aws_neuron_venv_tensorflow_2_10_inf1 |
You can easily get started with the multi-framework DLAMI through AWS console by following this setup guide. If you are looking to use the Neuron DLAMI in your cloud automation flows, Neuron also supports SSM parameters to easily retrieve the latest DLAMI id.
Neuron Single Framework DLAMI#
Neuron supports single framework DLAMIs that correspond to a single framework version (ex:- TensorFlow 2.10). Each DLAMI is pre-installed with Neuron drivers and supports all Neuron instance types. Each virtual environment corresponding to a specific Neuron framework/library comes pre-installed with all the relevant Neuron libraries including Neuron compiler and Neuron run-time.
Single Framework DLAMIs supported#
Framework |
Operating System |
Neuron Instances Supported |
DLAMI Name |
|---|---|---|---|
Tensorflow 2.10 |
Ubuntu 22.04 |
Inf1, Inf2, Trn1, Trn1n, Trn2 |
Deep Learning AMI Neuron TensorFlow 2.10 (Ubuntu 22.04) |
Tensorflow 2.10 |
Ubuntu 20.04 |
Inf2, Trn1, Trn1n |
Deep Learning AMI Neuron TensorFlow 2.10 (Ubuntu 20.04) |
Virtual Environments pre-installed#
DLAMI Name |
Neuron Libraries supported |
Virtual Environment |
|---|---|---|
Deep Learning AMI Neuron TensorFlow 2.10 (Ubuntu 22.04) |
tensorflow-neuronx |
/opt/aws_neuronx_venv_tensorflow_2_10 |
Deep Learning AMI Neuron TensorFlow 2.10 (Ubuntu 20.04) |
tensorflow-neuronx |
/opt/aws_neuron_venv_tensorflow_2_10 |
Deep Learning AMI Neuron TensorFlow 2.10 (Ubuntu 22.04) |
tensorflow-neuron (Inf1) |
/opt/aws_neuron_venv_tensorflow_2_10_inf1 |
You can easily get started with the single framework DLAMI through AWS console by following one of the corresponding setup guides . If you are looking to use the Neuron DLAMI in your cloud automation flows , Neuron also supports SSM parameters to easily retrieve the latest DLAMI id.
Neuron Base DLAMI#
Neuron Base DLAMIs comes pre-installed with Neuron driver, EFA, and Neuron tools. Base DLAMIs might be relevant if you are extending the DLAMI for containerized applications.
Base DLAMIs supported#
Operating System |
Neuron Instances Supported |
DLAMI Name |
|---|---|---|
Ubuntu 22.04 |
Inf1, Inf2, Trn1, Trn1n |
Deep Learning Base Neuron AMI (Ubuntu 22.04) |
Ubuntu 20.04 |
Inf1, Inf2, Trn1, Trn1n |
Deep Learning Base Neuron AMI (Ubuntu 20.04) |
Using SSM parameters to find DLAMI id and trigger Cloud Automation flows#
Neuron DLAMIs support AWS SSM parameters to easily find the Neuron DLAMI id. Currently we only support finding the latest DLAMI id that corresponds to latest Neuron SDK release with SSM parameter support. In the future releases, we will add support for finding the DLAMI id using SSM parameters for a specific Neuron release.
Finding specific DLAMI image id with the latest neuron release#
You can find the DLAMI that supports latest Neuron SDK by using the SSM get-parameter.
aws ssm get-parameter \
--region us-east-1 \
--name <dlami-ssm-parameter-prefix>/latest/image_id \
--query "Parameter.Value" \
--output text
The SSM parameter prefix for each DLAMI can be seen below
SSM Parameter Prefix#
AMI Name |
SSM parameter Prefix |
|---|---|
Deep Learning AMI Neuron (Ubuntu 22.04) |
/aws/service/neuron/dlami/multi-framework/ubuntu-22.04 |
Deep Learning AMI Neuron (Amazon Linux 2023) |
/aws/service/neuron/dlami/multi-framework/amazon-linux-2023 |
Deep Learning AMI Neuron TensorFlow 2.10 (Ubuntu 22.04) |
/aws/service/neuron/dlami/tensorflow-2.10/ubuntu-22.04 |
Deep Learning AMI Neuron TensorFlow 2.10 (Ubuntu 20.04) |
/aws/service/neuron/dlami/tensorflow-2.10/ubuntu-20.04 |
Deep Learning Base Neuron AMI (Ubuntu 22.04) |
/aws/service/neuron/dlami/base/ubuntu-22.04 |
Deep Learning Base Neuron AMI (Ubuntu 20.04) |
/aws/service/neuron/dlami/base/ubuntu-20.04 |
For example to find the latest DLAMI id for Multi-Framework DLAMI (Ubuntu 22) you can use the following
aws ssm get-parameter \
--region us-east-1 \
--name /aws/service/neuron/dlami/multi-framework/ubuntu-22.04/latest/image_id \
--query "Parameter.Value" \
--output text
You can find all available parameters supported in Neuron DLAMis via CLI
aws ssm get-parameters-by-path \
--region us-east-1 \
--path /aws/service/neuron \
--recursive
You can also view the SSM parameters supported in Neuron through AWS parameter store by selecting the “Neuron” service.
Use SSM Parameter to launch instance directly via CLI#
You can use CLI to find the latest DLAMI id and also launch the instance simulataneuosly. Below code snippet shows an example of launching inf2 instance using multi-framework DLAMI
aws ec2 run-instances \
--region us-east-1 \
--image-id resolve:ssm:/aws/service/neuron/dlami/tensorflow-2.10/ubuntu-22.04/latest/image_id \
--count 1 \
--instance-type inf2.48xlarge \
--key-name <my-key-pair> \
--security-groups <my-security-group>
Use SSM alias in EC2 launch templates#
SSM Parameters can also be used directly in launch templates. So, you can update your Auto Scaling groups to use new AMI IDs without needing to create new launch templates or new versions of launch templates each time an AMI ID changes. Ref: https://docs.aws.amazon.com/autoscaling/ec2/userguide/using-systems-manager-parameters.html
Other Resources#
https://docs.aws.amazon.com/dlami/latest/devguide/what-is-dlami.html
https://docs.aws.amazon.com/dlami/latest/devguide/appendix-ami-release-notes.html
https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-parameter-store.html