• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1.. PyTorch documentation master file, created by
2   sphinx-quickstart on Fri Dec 23 13:31:47 2016.
3   You can adapt this file completely to your liking, but it should at least
4   contain the root `toctree` directive.
5
6:github_url: https://github.com/pytorch/pytorch
7
8PyTorch documentation
9===================================
10
11PyTorch is an optimized tensor library for deep learning using GPUs and CPUs.
12
13Features described in this documentation are classified by release status:
14
15  *Stable:*  These features will be maintained long-term and there should generally
16  be no major performance limitations or gaps in documentation.
17  We also expect to maintain backwards compatibility (although
18  breaking changes can happen and notice will be given one release ahead
19  of time).
20
21  *Beta:*  These features are tagged as Beta because the API may change based on
22  user feedback, because the performance needs to improve, or because
23  coverage across operators is not yet complete. For Beta features, we are
24  committing to seeing the feature through to the Stable classification.
25  We are not, however, committing to backwards compatibility.
26
27  *Prototype:*  These features are typically not available as part of
28  binary distributions like PyPI or Conda, except sometimes behind run-time
29  flags, and are at an early stage for feedback and testing.
30
31.. toctree::
32   :glob:
33   :maxdepth: 1
34   :caption: Community
35
36   community/*
37
38.. toctree::
39   :glob:
40   :maxdepth: 1
41   :caption: Developer Notes
42
43   notes/*
44
45.. toctree::
46   :maxdepth: 1
47   :caption: Language Bindings
48
49   cpp_index
50   Javadoc <https://pytorch.org/javadoc/>
51   torch::deploy <deploy>
52
53.. toctree::
54   :glob:
55   :maxdepth: 2
56   :caption: Python API
57
58   torch
59   nn
60   nn.functional
61   tensors
62   tensor_attributes
63   tensor_view
64   torch.amp <amp>
65   torch.autograd <autograd>
66   torch.library <library>
67   cpu
68   cuda
69   torch.cuda.memory <torch_cuda_memory>
70   mps
71   xpu
72   mtia
73   meta
74   torch.backends <backends>
75   torch.export <export>
76   torch.distributed <distributed>
77   torch.distributed.tensor <distributed.tensor>
78   torch.distributed.algorithms.join <distributed.algorithms.join>
79   torch.distributed.elastic <distributed.elastic>
80   torch.distributed.fsdp <fsdp>
81   torch.distributed.tensor.parallel <distributed.tensor.parallel>
82   torch.distributed.optim <distributed.optim>
83   torch.distributed.pipelining <distributed.pipelining>
84   torch.distributed.checkpoint <distributed.checkpoint>
85   torch.distributions <distributions>
86   torch.compiler <torch.compiler>
87   torch.fft <fft>
88   torch.func <func>
89   futures
90   fx
91   fx.experimental
92   torch.hub <hub>
93   torch.jit <jit>
94   torch.linalg <linalg>
95   torch.monitor <monitor>
96   torch.signal <signal>
97   torch.special <special>
98   torch.overrides
99   torch.package <package>
100   profiler
101   nn.init
102   nn.attention
103   onnx
104   optim
105   complex_numbers
106   ddp_comm_hooks
107   quantization
108   rpc
109   torch.random <random>
110   masked
111   torch.nested <nested>
112   size
113   sparse
114   storage
115   torch.testing <testing>
116   torch.utils <utils>
117   torch.utils.benchmark <benchmark_utils>
118   torch.utils.bottleneck <bottleneck>
119   torch.utils.checkpoint <checkpoint>
120   torch.utils.cpp_extension <cpp_extension>
121   torch.utils.data <data>
122   torch.utils.deterministic <deterministic>
123   torch.utils.jit <jit_utils>
124   torch.utils.dlpack <dlpack>
125   torch.utils.mobile_optimizer <mobile_optimizer>
126   torch.utils.model_zoo <model_zoo>
127   torch.utils.tensorboard <tensorboard>
128   torch.utils.module_tracker <module_tracker>
129   type_info
130   named_tensor
131   name_inference
132   torch.__config__ <config_mod>
133   torch.__future__ <future_mod>
134   logging
135   torch_environment_variables
136
137.. toctree::
138   :maxdepth: 1
139   :caption: Libraries
140
141   torchaudio <https://pytorch.org/audio/stable>
142   TorchData <https://pytorch.org/data>
143   TorchRec <https://pytorch.org/torchrec>
144   TorchServe <https://pytorch.org/serve>
145   torchtext <https://pytorch.org/text/stable>
146   torchvision <https://pytorch.org/vision/stable>
147   PyTorch on XLA Devices <https://pytorch.org/xla/>
148
149Indices and tables
150==================
151
152* :ref:`genindex`
153* :ref:`modindex`
154