index.rst 1.27 KB
Newer Older
Christian Sarofeen's avatar
Christian Sarofeen committed
1
2
3
4
5
.. PyTorch documentation master file, created by
   sphinx-quickstart on Fri Dec 23 13:31:47 2016.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

6
:github_url: https://github.com/nvidia/apex
Christian Sarofeen's avatar
Christian Sarofeen committed
7

8
Apex (A PyTorch Extension)
Christian Sarofeen's avatar
Christian Sarofeen committed
9
10
===================================

11
12
This site contains the API documentation for Apex (https://github.com/nvidia/apex),
a Pytorch extension with NVIDIA-maintained utilities to streamline mixed precision and distributed training.  Some of the code here will be included in upstream Pytorch eventually. The intention of Apex is to make up-to-date utilities available to users as quickly as possible.
Christian Sarofeen's avatar
Christian Sarofeen committed
13

Michael Carilli's avatar
Michael Carilli committed
14
Installation instructions can be found here:  https://github.com/NVIDIA/apex#quick-start.
15

16
17
18
19
20
.. toctree::
   :maxdepth: 1
   :caption: AMP:  Automatic Mixed Precision

   amp
Christian Sarofeen's avatar
Christian Sarofeen committed
21

22
23
24
25
26
27
.. toctree::
   :maxdepth: 1
   :caption: Distributed Training

   parallel

28
29
30
31
32
33
.. toctree::
   :maxdepth: 1
   :caption: Fused Optimizers

   optimizers

Michael Carilli's avatar
Michael Carilli committed
34
35
36
37
38
39
.. toctree::
   :maxdepth: 1
   :caption: Fused Layer Norm

   layernorm

Michael Carilli's avatar
Michael Carilli committed
40
41
42
43
44
45
.. toctree::
   :maxdepth: 1
   :caption: Deprecated mixed precision utilities

   fp16_utils

46
47
..   reparameterization
..   RNN
Christian Sarofeen's avatar
Christian Sarofeen committed
48
49
50
51
52
53
   
Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`