Skip to content

Commit 02d4c61

Browse files
authoredJan 21, 2023
Update README to reflect new buildspec location (aws#2635)
1 parent 17d4bfe commit 02d4c61

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed
 

‎README.md

+8-8
Original file line numberDiff line numberDiff line change
@@ -71,20 +71,20 @@ For the purposes of testing in your personal account, the following managed perm
7171

7272
The paths to the dockerfiles follow a specific pattern e.g., mxnet/training/docker/\<version>/\<python_version>/Dockerfile.<processor>
7373

74-
These paths are specified by the buildspec.yml residing in mxnet/buildspec.yml i.e. \<framework>/buildspec.yml.
74+
These paths are specified by the buildspec.yml residing in mxnet/training/buildspec.yml i.e. \<framework>/<training|inference>/buildspec.yml.
7575
If you want to build the dockerfile for a particular version, or introduce a new version of the framework, re-create the
7676
folder structure as per above and modify the buildspec.yml file to specify the version of the dockerfile you want to build.
7777

7878
1. To build all the dockerfiles specified in the buildspec.yml locally, use the command
7979
```shell script
80-
python src/main.py --buildspec mxnet/buildspec.yml --framework mxnet
80+
python src/main.py --buildspec mxnet/training/buildspec.yml --framework mxnet
8181
```
8282
The above step should take a while to complete the first time you run it since it will have to download all base layers
8383
and create intermediate layers for the first time.
8484
Subsequent runs should be much faster.
8585
2. If you would instead like to build only a single image
8686
```shell script
87-
python src/main.py --buildspec mxnet/buildspec.yml \
87+
python src/main.py --buildspec mxnet/training/buildspec.yml \
8888
--framework mxnet \
8989
--image_types training \
9090
--device_types cpu \
@@ -98,7 +98,7 @@ folder structure as per above and modify the buildspec.yml file to specify the v
9898
```
9999
4. For example, to build all gpu, training containers, you could use the following command
100100
```shell script
101-
python src/main.py --buildspec mxnet/buildspec.yml \
101+
python src/main.py --buildspec mxnet/training/buildspec.yml \
102102
--framework mxnet \
103103
--image_types training \
104104
--device_types gpu \
@@ -107,9 +107,9 @@ folder structure as per above and modify the buildspec.yml file to specify the v
107107

108108
### Upgrading the framework version
109109
1. Suppose, if there is a new framework version for MXNet (version 1.7.0) then this would need to be changed in the
110-
buildspec.yml file for MXNet.
110+
buildspec.yml file for MXNet training.
111111
```yaml
112-
# mxnet/buildspec.yml
112+
# mxnet/training/buildspec.yml
113113
1 account_id: &ACCOUNT_ID <set-$ACCOUNT_ID-in-environment>
114114
2 region: &REGION <set-$REGION-in-environment>
115115
3 framework: &FRAMEWORK mxnet
@@ -119,7 +119,7 @@ buildspec.yml file for MXNet.
119119
2. The dockerfile for this should exist at mxnet/docker/1.7.0/py3/Dockerfile.gpu. This path is dictated by the
120120
docker_file key for each repository.
121121
```yaml
122-
# mxnet/buildspec.yml
122+
# mxnet/training/buildspec.yml
123123
41 images:
124124
42 BuildMXNetCPUTrainPy3DockerImage:
125125
43 <<: *TRAINING_REPOSITORY
@@ -137,7 +137,7 @@ docker_file key for each repository.
137137
then README-context.rst needs to first be copied into the build context. You can do this by adding the artifact in
138138
the framework buildspec file under the context key:
139139
```yaml
140-
# mxnet/buildspec.yml
140+
# mxnet/training/buildspec.yml
141141
19 context:
142142
20 README.xyz: *<---- Object name (Can be anything)*
143143
21 source: README-context.rst *<--- Path for the file to be copied*

0 commit comments

Comments
 (0)
Please sign in to comment.