Skip to content

fix typo and improve clarity on installing packages via "requirements.txt" #1215

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jan 8, 2020
Merged

fix typo and improve clarity on installing packages via "requirements.txt" #1215

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4b4d4ba
fix typo
Jan 8, 2020
346998c
Without specifying "source_dir" and put ``requirements.txt`` in that …
Jan 8, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 4 additions & 5 deletions doc/using_pytorch.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -125,8 +125,7 @@ Using third-party libraries
When running your training script on SageMaker, it will have access to some pre-installed third-party libraries including ``torch``, ``torchvisopm``, and ``numpy``.
For more information on the runtime environment, including specific package versions, see `SageMaker PyTorch Docker containers <#id4>`__.

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.
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.
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.
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.


Expand Down Expand Up @@ -524,7 +523,7 @@ The PyTorchModel constructor takes the following arguments:
which should be executed as the entry point to model hosting.
- ``source_dir:`` Optional. Path (absolute or relative) to a
directory with any other training source code dependencies including
tne entry point file. Structure within this directory will be
the entry point file. Structure within this directory will be
preserved when training on SageMaker.
- ``enable_cloudwatch_metrics:`` Optional. If true, training
and hosting containers will generate Cloudwatch metrics under the
Expand Down Expand Up @@ -655,9 +654,9 @@ The following are optional arguments. When you create a ``PyTorch`` object, you
and where to find the source code to build your custom image.

***********************************
SageMaker PyTorch Docker Containers
SageMaker PyTorch Docker Containers
***********************************

For information about SageMaker PyTorch containers, see `the SageMaker PyTorch containers repository <https://github.com/aws/sagemaker-pytorch-container>`_.

For information about SageMaker PyTorch container dependencies, see `SageMaker PyTorch Containers <https://github.com/aws/sagemaker-python-sdk/tree/master/src/sagemaker/pytorch#sagemaker-pytorch-docker-containers>`_.
For information about SageMaker PyTorch container dependencies, see `SageMaker PyTorch Containers <https://github.com/aws/sagemaker-python-sdk/tree/master/src/sagemaker/pytorch#sagemaker-pytorch-docker-containers>`_.