Skip to content

Commit a633a5b

Browse files
authored
Update README with instructions on Customize and building the images (#124)
*Issue #, if available:* *Description of changes:* By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.
1 parent f095f0e commit a633a5b

File tree

1 file changed

+25
-0
lines changed

1 file changed

+25
-0
lines changed

README.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,31 @@
22

33
AWS Neuron Deep Learning Containers (DLCs) are a set of Docker images for training and serving models on AWS Trainium and Inferentia instances using AWS Neuron SDK. For more documentation, please refer to [Neuron Containers Overview](https://awsdocs-neuron.readthedocs-hosted.com/en/latest/containers/index.html).
44

5+
## Building and Customizing Dockerfiles
6+
7+
### Prerequisites
8+
9+
To build the Dockerfiles successfully, ensure the files under the `common/` directory is in the same parent folder as the Dockerfile. The common directory contains shared scripts and configuration files required by all container builds.
10+
11+
### Building a Container
12+
13+
To build a specific container, navigate to the repository root and use Docker build with the appropriate context:
14+
15+
```bash
16+
# Example: Build PyTorch 2.7.0 inference container
17+
docker build -f docker/pytorch/inference/2.7.0/Dockerfile.neuronx -t my-neuron-container .
18+
```
19+
20+
### Customizing Containers
21+
22+
You can customize the containers by:
23+
24+
1. **Modifying existing Dockerfiles**: Edit the Dockerfile to add additional packages or configurations
25+
2. **Creating derived images**: Use the pre-built containers as base images for your custom requirements
26+
3. **Adding custom scripts**: Place additional scripts and reference them in your Dockerfile
27+
28+
For detailed customization examples and best practices, refer to the [Neuron DLC Customization Guide](https://awsdocs-neuron.readthedocs-hosted.com/en/latest/containers/dlc-then-customize-devflow.html#containers-dlc-then-customize-devflow).
29+
530
## Containers
631

732
### pytorch-inference-neuron

0 commit comments

Comments
 (0)