Skip to content

Commit b88babd

Browse files
committed
doc: add link to container dependencies in using PyTorch topic
1 parent c52e893 commit b88babd

File tree

2 files changed

+3
-92
lines changed

2 files changed

+3
-92
lines changed

doc/using_mxnet.rst

Lines changed: 0 additions & 91 deletions
Original file line numberDiff line numberDiff line change
@@ -797,97 +797,6 @@ The following are optional arguments. When you create an ``MXNet`` object, you c
797797
}
798798
}
799799
800-
**************************
801-
SageMaker MXNet Containers
802-
**************************
803-
804-
=======
805-
806-
Required arguments
807-
==================
808-
809-
The following are required arguments to the ``MXNet`` constructor. When you create an MXNet object, you must include these in the constructor, either positionally or as keyword arguments.
810-
811-
- ``entry_point`` Path (absolute or relative) to the Python file which
812-
should be executed as the entry point to training.
813-
- ``role`` An AWS IAM role (either name or full ARN). The Amazon
814-
SageMaker training jobs and APIs that create Amazon SageMaker
815-
endpoints use this role to access training data and model artifacts.
816-
After the endpoint is created, the inference code might use the IAM
817-
role, if accessing AWS resource.
818-
- ``train_instance_count`` Number of Amazon EC2 instances to use for
819-
training.
820-
- ``train_instance_type`` Type of EC2 instance to use for training, for
821-
example, 'ml.c4.xlarge'.
822-
823-
Optional arguments
824-
==================
825-
826-
The following are optional arguments. When you create an ``MXNet`` object, you can specify these as keyword arguments.
827-
828-
- ``source_dir`` Path (absolute or relative) to a directory with any
829-
other training source code dependencies including the entry point
830-
file. Structure within this directory will be preserved when training
831-
on SageMaker.
832-
- ``dependencies (list[str])`` A list of paths to directories (absolute or relative) with
833-
any additional libraries that will be exported to the container (default: ``[]``).
834-
The library folders will be copied to SageMaker in the same folder where the entrypoint is copied.
835-
If the ``source_dir`` points to S3, code will be uploaded and the S3 location will be used
836-
instead. For example, the following call
837-
838-
>>> MXNet(entry_point='train.py', dependencies=['my/libs/common', 'virtual-env'])
839-
840-
results in the following inside the container:
841-
842-
.. code::
843-
844-
opt/ml/code
845-
├── train.py
846-
├── common
847-
└── virtual-env
848-
849-
- ``hyperparameters`` Hyperparameters that will be used for training.
850-
Will be made accessible as a dict[str, str] to the training code on
851-
SageMaker. For convenience, accepts other types besides str, but
852-
str() will be called on keys and values to convert them before
853-
training.
854-
- ``py_version`` Python version you want to use for executing your
855-
model training code. Valid values: 'py2' and 'py3'.
856-
- ``train_volume_size`` Size in GB of the EBS volume to use for storing
857-
input data during training. Must be large enough to store training
858-
data if input_mode='File' is used (which is the default).
859-
- ``train_max_run`` Timeout in seconds for training, after which Amazon
860-
SageMaker terminates the job regardless of its current status.
861-
- ``input_mode`` The input mode that the algorithm supports. Valid
862-
modes: 'File' - Amazon SageMaker copies the training dataset from the
863-
S3 location to a directory in the Docker container. 'Pipe' - Amazon
864-
SageMaker streams data directly from S3 to the container via a Unix
865-
named pipe.
866-
- ``output_path`` Location where you want the training result (model artifacts and optional output files) saved.
867-
This should be an S3 location unless you're using Local Mode, which also supports local output paths.
868-
If not specified, results are stored to a default S3 bucket.
869-
- ``output_kms_key`` Optional KMS key ID to optionally encrypt training
870-
output with.
871-
- ``job_name`` Name to assign for the training job that the fit()
872-
method launches. If not specified, the estimator generates a default
873-
job name, based on the training image name and current timestamp
874-
- ``image_name`` An alternative docker image to use for training and
875-
serving. If specified, the estimator will use this image for training and
876-
hosting, instead of selecting the appropriate SageMaker official image based on
877-
framework_version and py_version. Refer to: `SageMaker MXNet Docker Containers
878-
<#sagemaker-mxnet-docker-containers>`_ for details on what the Official images support
879-
and where to find the source code to build your custom image.
880-
- ``distributions`` For versions 1.3 and above only.
881-
Specifies information for how to run distributed training.
882-
To launch a parameter server during training, set this argument to:
883-
884-
.. code::
885-
886-
{
887-
'parameter_server': {
888-
'enabled': True
889-
}
890-
}
891800
892801
**************************
893802
SageMaker MXNet Containers

doc/using_pytorch.rst

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -658,4 +658,6 @@ The following are optional arguments. When you create a ``PyTorch`` object, you
658658
SageMaker PyTorch Docker containers
659659
***********************************
660660

661-
For information about SageMaker PyTorch containers, see `the SageMaker PyTorch containers repository <https://github.com/aws/sagemaker-pytorch-containers>`_.
661+
For information about SageMaker PyTorch containers, see `the SageMaker PyTorch containers repository <https://github.com/aws/sagemaker-pytorch-containers>`_.
662+
663+
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>`_.

0 commit comments

Comments
 (0)