Skip to content

Commit ab48ee3

Browse files
authored
doc: clarify requirements.txt usage for Chainer, MXNet, and Scikit-learn (#1223)
This change is just a copy of #1215, which revised the PyTorch docs.
1 parent 926690e commit ab48ee3

File tree

4 files changed

+14
-7
lines changed

4 files changed

+14
-7
lines changed

doc/using_chainer.rst

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -116,7 +116,10 @@ When running your training script on SageMaker, it will have access to some pre-
116116
For more information on the runtime environment, including specific package versions, see `SageMaker Chainer Docker containers <#sagemaker-chainer-docker-containers>`__.
117117

118118
If there are other packages you want to use with your script, you can include a ``requirements.txt`` file in the same directory as your training script to install other dependencies at runtime.
119-
A ``requirements.txt`` file is a text file that contains a list of items that are installed by using ``pip install``. You can also specify the version of an item to install.
119+
Both ``requirements.txt`` and your training script should be put in the same folder.
120+
You must specify this folder in ``source_dir`` argument when creating a Chainer estimator.
121+
A ``requirements.txt`` file is a text file that contains a list of items that are installed by using ``pip install``.
122+
You can also specify the version of an item to install.
120123
For information about the format of a ``requirements.txt`` file, see `Requirements Files <https://pip.pypa.io/en/stable/user_guide/#requirements-files>`__ in the pip documentation.
121124

122125
Create an Estimator
@@ -637,4 +640,4 @@ SageMaker Chainer Docker containers
637640

638641
You can visit the SageMaker Chainer containers repository here: https://github.com/aws/sagemaker-chainer-container
639642

640-
For information about SageMaker Chainer Docker containers and their dependencies, see `SageMaker Chainer Docker containers <https://github.com/aws/sagemaker-python-sdk/tree/master/src/sagemaker/chainer#sagemaker-chainer-docker-containers>`_.
643+
For information about SageMaker Chainer Docker containers and their dependencies, see `SageMaker Chainer Docker containers <https://github.com/aws/sagemaker-python-sdk/tree/master/src/sagemaker/chainer#sagemaker-chainer-docker-containers>`_.

doc/using_mxnet.rst

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -310,7 +310,10 @@ When running your training script on SageMaker, it will have access to some pre-
310310
For more information on the runtime environment, including specific package versions, see `SageMaker MXNet Containers <#sagemaker-mxnet-containers>`__.
311311

312312
If there are other packages you want to use with your script, you can include a ``requirements.txt`` file in the same directory as your training script to install other dependencies at runtime.
313-
A ``requirements.txt`` file is a text file that contains a list of items that are installed by using ``pip install``. You can also specify the version of an item to install.
313+
Both ``requirements.txt`` and your training script should be put in the same folder.
314+
You must specify this folder in ``source_dir`` argument when creating an MXNet estimator.
315+
A ``requirements.txt`` file is a text file that contains a list of items that are installed by using ``pip install``.
316+
You can also specify the version of an item to install.
314317
For information about the format of a ``requirements.txt`` file, see `Requirements Files <https://pip.pypa.io/en/stable/user_guide/#requirements-files>`__ in the pip documentation.
315318

316319
Create an Estimator

doc/using_pytorch.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -125,7 +125,7 @@ Using third-party libraries
125125
When running your training script on SageMaker, it will have access to some pre-installed third-party libraries including ``torch``, ``torchvisopm``, and ``numpy``.
126126
For more information on the runtime environment, including specific package versions, see `SageMaker PyTorch Docker containers <#id4>`__.
127127

128-
If there are other packages you want to use with your script, you can include a ``requirements.txt`` file in the same directory as your training script to install other dependencies at runtime. Both ``requirements.txt`` and your training script should be put in the same folder. You must specify this folder in ``source_dir`` argument when creating PyTorch estimator. A ``requirements.txt`` file is a text file that contains a list of items that are installed by using ``pip install``. You can also specify the version of an item to install.
128+
If there are other packages you want to use with your script, you can include a ``requirements.txt`` file in the same directory as your training script to install other dependencies at runtime. Both ``requirements.txt`` and your training script should be put in the same folder. You must specify this folder in ``source_dir`` argument when creating a PyTorch estimator. A ``requirements.txt`` file is a text file that contains a list of items that are installed by using ``pip install``. You can also specify the version of an item to install.
129129
For information about the format of a ``requirements.txt`` file, see `Requirements Files <https://pip.pypa.io/en/stable/user_guide/#requirements-files>`__ in the pip documentation.
130130

131131

doc/using_sklearn.rst

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -114,11 +114,12 @@ When running your training script on SageMaker, it has access to some pre-instal
114114
For more information on the runtime environment, including specific package versions, see `SageMaker Scikit-learn Docker Container <https://github.com/aws/sagemaker-scikit-learn-container>`__.
115115

116116
If there are other packages you want to use with your script, you can include a ``requirements.txt`` file in the same directory as your training script to install other dependencies at runtime.
117-
A ``requirements.txt`` file is a text file that contains a list of items that are installed by using ``pip install``. You can also specify the version of an item to install.
117+
Both ``requirements.txt`` and your training script should be put in the same folder.
118+
You must specify this folder in ``source_dir`` argument when creating a Scikit-learn estimator.
119+
A ``requirements.txt`` file is a text file that contains a list of items that are installed by using ``pip install``.
120+
You can also specify the version of an item to install.
118121
For information about the format of a ``requirements.txt`` file, see `Requirements Files <https://pip.pypa.io/en/stable/user_guide/#requirements-files>`__ in the pip documentation.
119122

120-
121-
122123
Create an Estimator
123124
===================
124125

0 commit comments

Comments
 (0)