@@ -11,55 +11,33 @@ across multiple GPUs with minimal code changes. The library's API can be accesse
11
11
12
12
See the following sections to learn more about the SageMaker model parallel library APIs.
13
13
14
- Use with the SageMaker Python SDK
15
- =================================
16
-
17
- Walk through the following pages to learn about the library's APIs
18
- to configure and enable distributed model parallelism
19
- through an Amazon SageMaker estimator.
20
-
21
14
.. toctree ::
22
- :maxdepth: 1
15
+ :maxdepth: 3
23
16
17
+ smp_versions/latest
24
18
smd_model_parallel_general
25
19
26
- Use the Library's API to Adapt Training Scripts
27
- ===============================================
28
-
29
- The library provides Common APIs that you can use across frameworks,
30
- as well as framework-specific APIs for TensorFlow and PyTorch.
31
-
32
- Select the latest or one of the previous versions of the API documentation
33
- depending on which version of the library you need to use.
34
- To use the library, reference the
35
- **Common API ** documentation alongside the framework specific API documentation.
36
-
37
- .. toctree ::
38
- :maxdepth: 2
39
-
40
- smp_versions/latest.rst
41
-
42
- To find archived API documentation for the previous versions of the library,
43
- see the following link:
44
-
45
- .. toctree ::
46
- :maxdepth: 1
47
-
48
- smp_versions/archives.rst
49
-
50
- It is recommended to use this documentation alongside `SageMaker Distributed Model Parallel
51
- <http://docs.aws.amazon.com/sagemaker/latest/dg/model-parallel.html> `__ in the Amazon SageMaker
52
- developer guide. This developer guide documentation includes:
53
20
54
- - An overview of model parallelism and the library
55
- `core features <https://docs.aws.amazon.com/sagemaker/latest/dg/model-parallel-core-features.html >`__
56
- - Instructions on how to modify `TensorFlow
57
- <https://docs.aws.amazon.com/sagemaker/latest/dg/model-parallel-customize-training-script.html#model-parallel-customize-training-script-tf> `__
58
- and `PyTorch
59
- <https://docs.aws.amazon.com/sagemaker/latest/dg/model-parallel-customize-training-script.html#model-parallel-customize-training-script-pt> `__
60
- training scripts
61
- - `Configuration tips and pitfalls
62
- <https://docs.aws.amazon.com/sagemaker/latest/dg/model-parallel-customize-tips-pitfalls.html> `__
21
+ .. tip ::
22
+
23
+ We recommended using this API documentation with the conceptual guide at
24
+ `SageMaker's Distributed Model Parallel
25
+ <http://docs.aws.amazon.com/sagemaker/latest/dg/model-parallel.html> `_
26
+ in the *Amazon SageMaker developer guide *. This developer guide documentation includes:
27
+
28
+ - An overview of model parallelism, and the library's
29
+ `core features <https://docs.aws.amazon.com/sagemaker/latest/dg/model-parallel-core-features.html >`_,
30
+ and `extended features for PyTorch <https://docs.aws.amazon.com/sagemaker/latest/dg/model-parallel-extended-features-pytorch.html >`_.
31
+ - Instructions on how to modify `TensorFlow
32
+ <https://docs.aws.amazon.com/sagemaker/latest/dg/model-parallel-customize-training-script-tf.html> `_
33
+ and `PyTorch
34
+ <https://docs.aws.amazon.com/sagemaker/latest/dg/model-parallel-customize-training-script-pt.html> `_
35
+ training scripts.
36
+ - Instructions on how to `run a distributed training job using the SageMaker Python SDK
37
+ and the SageMaker model parallel library
38
+ <https://docs.aws.amazon.com/sagemaker/latest/dg/model-parallel-sm-sdk.html> `_.
39
+ - `Configuration tips and pitfalls
40
+ <https://docs.aws.amazon.com/sagemaker/latest/dg/model-parallel-customize-tips-pitfalls.html> `_.
63
41
64
42
65
43
.. important ::
0 commit comments