Skip to content

Commit f9e6f7f

Browse files
committed
clean up available_iamges.md
Signed-off-by: sirutBuasai <sirutbuasai27@outlook.com>
1 parent 088808f commit f9e6f7f

File tree

6 files changed

+41
-139
lines changed

6 files changed

+41
-139
lines changed

docs/.nav.yml

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,6 @@ nav:
22
- Home: index.md
33
- Getting Started:
44
- get_started/index.md
5-
- Installation: get_started/installation.md
6-
- Quick Start: get_started/quickstart.md
75
- Tutorials: tutorials
86
- Reference:
97
- Available Images: reference/available_images.md

docs/get_started/index.md

Lines changed: 39 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,46 @@ Get up and running with AWS Deep Learning Containers quickly.
88
- Docker installed on your local machine
99
- AWS CLI configured with your credentials
1010

11-
## Guides
11+
## Pulling Images
1212

13-
- [Installation](installation.md) - Set up your environment and pull your first container
14-
- [Quick Start](quickstart.md) - Run your first training or inference job
13+
Learn how to authenticate and pull AWS Deep Learning Container images.
14+
15+
### Authentication
16+
17+
```bash
18+
aws ecr get-login-password --region <region> | docker login --username AWS --password-stdin <account_id>.dkr.ecr.<region>.amazonaws.com
19+
```
20+
21+
Then pull images:
22+
23+
```bash
24+
docker pull <account_id>.dkr.ecr.<region>.amazonaws.com/<repository>:<tag>
25+
```
26+
27+
### Image URL Format
28+
29+
To form your container image URL, use the following format:
30+
31+
```
32+
<account_id>.dkr.ecr.<region>.amazonaws.com/<repository>:<tag>
33+
```
34+
35+
Where:
36+
37+
- `<account_id>`: Find the account ID for your region in the [Region Availability](../reference/available_images.md#region-availability) table
38+
- `<region>`: Your AWS region (e.g., `us-east-1`, `us-west-2`, `eu-west-1`)
39+
- `<repository>`: The framework repository name (e.g., `pytorch-training`, `tensorflow-inference`)
40+
- `<tag>`: The image tag from the [Available Images](../reference/available_images.md) tables
41+
42+
### Example
43+
44+
```bash
45+
# Authenticate
46+
aws ecr get-login-password --region us-west-2 | docker login --username AWS --password-stdin 763104351884.dkr.ecr.us-west-2.amazonaws.com
47+
48+
# Pull PyTorch training image
49+
docker pull 763104351884.dkr.ecr.us-west-2.amazonaws.com/pytorch-training:2.9.0-gpu-py312-cu130-ubuntu22.04-sagemaker
50+
```
1551

1652
## Next Steps
1753

docs/get_started/installation.md

Lines changed: 0 additions & 44 deletions
This file was deleted.

docs/get_started/quickstart.md

Lines changed: 0 additions & 42 deletions
This file was deleted.

docs/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ hide:
3838

3939
### 🎓 Hands-on Workshop
4040

41-
- 🚀 **[LLM Deployment on EKS Workshop](https://catalog.us-east-1.prod.workshops.aws/workshops/c22b50fb-64b1-4e18-8d0f-ce990f87eed3/en-US)** - Deploy and optimize LLMs on Amazon EKS using vLLM Deep Learning Containers. | [Sample Code](https://github.com/aws-samples/sample-vllm-on-eks-with-dlc)
41+
- 🚀 **[LLM Deployment on EKS Workshop](https://catalog.us-east-1.prod.workshops.aws/workshops/c22b50fb-64b1-4e18-8d0f-ce990f87eed3/en-US)** - Deploy and optimize LLMs on Amazon EKS using vLLM Deep Learning Containers. For more information, see [Sample Code](https://github.com/aws-samples/sample-vllm-on-eks-with-dlc)
4242

4343
---
4444

Lines changed: 1 addition & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,4 @@
1-
# Available Deep Learning Containers Images
2-
3-
Replace `<repository-name>` and `<image-tag>` based on your desired container.
4-
5-
## Getting Started
6-
7-
Once you've selected your desired Deep Learning Containers image, continue with one of the following:
8-
9-
- [Amazon EC2 Tutorials](https://docs.aws.amazon.com/deep-learning-containers/latest/devguide/deep-learning-containers-ec2.html)
10-
- [Amazon ECS Tutorials](https://docs.aws.amazon.com/deep-learning-containers/latest/devguide/deep-learning-containers-ecs.html)
11-
- [Amazon EKS Tutorials](https://docs.aws.amazon.com/deep-learning-containers/latest/devguide/deep-learning-containers-eks.html)
12-
- [HuggingFace on AWS](https://huggingface.co/docs/sagemaker/en/index)
13-
- [Security in AWS Deep Learning Containers](https://docs.aws.amazon.com/deep-learning-containers/latest/devguide/security.html)
14-
- [Release Notes](https://docs.aws.amazon.com/deep-learning-containers/latest/devguide/dlc-release-notes.html)
1+
# Available Images
152

163
## Region Availability
174

@@ -53,37 +40,4 @@ Once you've selected your desired Deep Learning Containers image, continue with
5340
| China (Beijing) | cn-north-1 ||| `727897471807.dkr.ecr.cn-north-1.amazonaws.com.cn/<repository-name>:<image-tag>` |
5441
| China (Ningxia) | cn-northwest-1 ||| `727897471807.dkr.ecr.cn-northwest-1.amazonaws.com.cn/<repository-name>:<image-tag>` |
5542

56-
## Authentication
57-
58-
```bash
59-
aws ecr get-login-password --region us-east-1 | docker login --username AWS --password-stdin 763104351884.dkr.ecr.us-east-1.amazonaws.com
60-
```
61-
62-
Then pull images:
63-
64-
```bash
65-
docker pull <name of container image>
66-
```
67-
68-
## Image Tag Guide
69-
70-
To form your container image URL, use the following format:
71-
72-
```
73-
<account_id>.dkr.ecr.<region>.amazonaws.com/<repository>:<tag>
74-
```
75-
76-
Where:
77-
78-
- `<account_id>`: Find the account ID for your region in the Region Availability table above
79-
- `<region>`: Your AWS region (e.g., `us-east-1`, `us-west-2`, `eu-west-1`)
80-
- `<repository>`: The framework repository name (e.g., `pytorch-training`, `base`, `vllm`, `sglang`)
81-
- `<tag>`: The image tag from the tables below
82-
83-
Example:
84-
85-
```
86-
763104351884.dkr.ecr.us-west-2.amazonaws.com/pytorch-training:2.9.0-gpu-py312-cu130-ubuntu22.04-sagemaker
87-
```
88-
8943
---

0 commit comments

Comments
 (0)