Skip to content

Commit 627d7ed

Browse files
eslesar-awslaurenyu
authored andcommitted
doc: add third-party libraries sections to using_chainer and using_pytorch topics (#725)
1 parent 248fe67 commit 627d7ed

File tree

3 files changed

+27
-16
lines changed

3 files changed

+27
-16
lines changed

doc/using_chainer.rst

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -99,6 +99,16 @@ inadvertently run your training code at the wrong point in execution.
9999

100100
For more on training environment variables, please visit https://github.com/aws/sagemaker-containers.
101101

102+
Using third-party libraries
103+
^^^^^^^^^^^^^^^^^^^^^^^^^^^
104+
105+
When running your training script on SageMaker, it will have access to some pre-installed third-party libraries including ``chainer``, ``numpy``, and ``cupy``.
106+
For more information on the runtime environment, including specific package versions, see `SageMaker Chainer Docker containers <#sagemaker-chainer-docker-containers>`__.
107+
108+
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.
109+
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.
110+
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.
111+
102112
Running a Chainer training script in SageMaker
103113
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
104114

doc/using_mxnet.rst

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -293,9 +293,12 @@ Lastly, if you were relying on the container launching a parameter server for us
293293
Using third-party libraries
294294
^^^^^^^^^^^^^^^^^^^^^^^^^^^
295295

296-
When running your training script on SageMaker, it will have access to some pre-installed third-party libraries including ``mxnet``, ``numpy``, ``onnx``, and ``keras-mxnet``. For more information on the runtime environment, including specific package versions, see `SageMaker MXNet Containers <#sagemaker-mxnet-containers>`__.
296+
When running your training script on SageMaker, it will have access to some pre-installed third-party libraries including ``mxnet``, ``numpy``, ``onnx``, and ``keras-mxnet``.
297+
For more information on the runtime environment, including specific package versions, see `SageMaker MXNet Containers <#sagemaker-mxnet-containers>`__.
297298

298-
If there are other packages you want to use with your script, you can include a `requirements.txt <https://pip.pypa.io/en/stable/user_guide/#requirements-files>`__ file in the same directory as your training script to install other dependencies at runtime.
299+
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.
300+
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.
301+
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.
299302

300303
Running an MXNet training script in SageMaker
301304
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

doc/using_pytorch.rst

Lines changed: 12 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22
Using PyTorch with the SageMaker Python SDK
33
===========================================
44

5+
.. contents::
6+
57
With PyTorch Estimators and Models, you can train and host PyTorch models on Amazon SageMaker.
68

79
Supported versions of PyTorch: ``0.4.0``, ``1.0.0``.
@@ -10,20 +12,6 @@ We recommend that you use the latest supported version, because that's where we
1012

1113
You can visit the PyTorch repository at https://github.com/pytorch/pytorch.
1214

13-
Table of Contents
14-
-----------------
15-
16-
1. `Training with PyTorch <#training-with-pytorch>`__
17-
2. `PyTorch Estimators <#pytorch-estimators>`__
18-
3. `Distributed PyTorch Training <#distributed-pytorch-training>`__
19-
4. `Saving models <#saving-models>`__
20-
5. `Deploying PyTorch Models <#deploying-pytorch-models>`__
21-
6. `SageMaker PyTorch Model Server <#sagemaker-pytorch-model-server>`__
22-
7. `Working with Existing Model Data and Training Jobs <#working-with-existing-model-data-and-training-jobs>`__
23-
8. `PyTorch Training Examples <#pytorch-training-examples>`__
24-
9. `SageMaker PyTorch Docker Containers <#sagemaker-pytorch-docker-containers>`__
25-
26-
2715
Training with PyTorch
2816
------------------------
2917

@@ -122,6 +110,16 @@ when instantiating PyTorch Estimator.
122110

123111
For more on training environment variables, please visit `SageMaker Containers <https://github.com/aws/sagemaker-containers>`_.
124112

113+
Using third-party libraries
114+
~~~~~~~~~~~~~~~~~~~~~~~~~~~
115+
116+
When running your training script on SageMaker, it will have access to some pre-installed third-party libraries including ``torch``, ``torchvisopm``, and ``numpy``.
117+
For more information on the runtime environment, including specific package versions, see `SageMaker PyTorch Docker containers <#sagemaker-pytorch-docker-containers>`__.
118+
119+
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.
120+
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.
121+
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.
122+
125123
Running a PyTorch training script in SageMaker
126124
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
127125

0 commit comments

Comments
 (0)