mirror of
https://github.com/zebrajr/pytorch.git
synced 2025-12-07 12:21:27 +01:00
62a90c227f
Summary: **Overview:** This removes the preceding `_` from `_Join`, `_Joinable`, and `_JoinHook` in preparation for adding the generic join context manager tutorial (see [here](https://github.com/pytorch/tutorials/pull/1610)). This also adds a docs page, which can be linked from the tutorial. [Here](https://github.com/pytorch/pytorch/files/6919475/render.pdf) is a render of the docs page. Pull Request resolved: https://github.com/pytorch/pytorch/pull/62605 Test Plan: `DistributedDataParallel.join()`: ``` touch /tmp/barrier && TEMP_DIR="/tmp" BACKEND="nccl" WORLD_SIZE="2" gpurun python test/distributed/test_distributed_fork.py -- TestDistBackendWithFork.test_ddp_uneven_inputs TestDistBackendWithFork.test_ddp_uneven_inputs_stop_iteration_sync_bn TestDistBackendWithFork.test_ddp_grad_div_uneven_inputs TestDistBackendWithFork.test_ddp_uneven_input_join_disable TestDistBackendWithFork.test_ddp_uneven_input_exception ``` `ZeroRedundancyOptimizer`: ``` gpurun4 python test/distributed/optim/test_zero_redundancy_optimizer.py ``` NOTE: DDP overlap tests are failing due to a landing race. See https://github.com/pytorch/pytorch/pull/62592. Once the fix is landed, I will rebase, and tests should be passing. `Join`: ``` gpurun4 python test/distributed/algorithms/test_join.py ``` Reviewed By: mrshenli Differential Revision: D30055544 Pulled By: andwgu fbshipit-source-id: a5ce1f1d9f1904de3bdd4edd0b31b0a612d87026
123 lines
3.2 KiB
ReStructuredText
123 lines
3.2 KiB
ReStructuredText
.. 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.
|
|
|
|
:github_url: https://github.com/pytorch/pytorch
|
|
|
|
PyTorch documentation
|
|
===================================
|
|
|
|
PyTorch is an optimized tensor library for deep learning using GPUs and CPUs.
|
|
|
|
Features described in this documentation are classified by release status:
|
|
|
|
*Stable:* These features will be maintained long-term and there should generally
|
|
be no major performance limitations or gaps in documentation.
|
|
We also expect to maintain backwards compatibility (although
|
|
breaking changes can happen and notice will be given one release ahead
|
|
of time).
|
|
|
|
*Beta:* These features are tagged as Beta because the API may change based on
|
|
user feedback, because the performance needs to improve, or because
|
|
coverage across operators is not yet complete. For Beta features, we are
|
|
committing to seeing the feature through to the Stable classification.
|
|
We are not, however, committing to backwards compatibility.
|
|
|
|
*Prototype:* These features are typically not available as part of
|
|
binary distributions like PyPI or Conda, except sometimes behind run-time
|
|
flags, and are at an early stage for feedback and testing.
|
|
|
|
|
|
.. toctree::
|
|
:glob:
|
|
:maxdepth: 1
|
|
:caption: Notes
|
|
|
|
notes/*
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
:caption: Language Bindings
|
|
|
|
cpp_index
|
|
Javadoc <https://pytorch.org/javadoc/>
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
:caption: Python API
|
|
|
|
torch
|
|
nn
|
|
nn.functional
|
|
tensors
|
|
tensor_attributes
|
|
tensor_view
|
|
torch.autograd <autograd>
|
|
cuda
|
|
torch.cuda.amp <amp>
|
|
torch.backends <backends>
|
|
torch.distributed <distributed>
|
|
torch.distributed.algorithms.join <distributed.algorithms.join>
|
|
torch.distributed.elastic <distributed.elastic>
|
|
torch.distributed.optim <distributed.optim>
|
|
torch.distributions <distributions>
|
|
torch.fft <fft>
|
|
futures
|
|
fx
|
|
torch.hub <hub>
|
|
torch.jit <jit>
|
|
torch.linalg <linalg>
|
|
torch.special <special>
|
|
torch.overrides
|
|
torch.package <package>
|
|
profiler
|
|
nn.init
|
|
onnx
|
|
optim
|
|
complex_numbers
|
|
ddp_comm_hooks
|
|
pipeline
|
|
quantization
|
|
rpc
|
|
torch.random <random>
|
|
sparse
|
|
storage
|
|
torch.testing <testing>
|
|
torch.utils.benchmark <benchmark_utils>
|
|
torch.utils.bottleneck <bottleneck>
|
|
torch.utils.checkpoint <checkpoint>
|
|
torch.utils.cpp_extension <cpp_extension>
|
|
torch.utils.data <data>
|
|
torch.utils.dlpack <dlpack>
|
|
torch.utils.mobile_optimizer <mobile_optimizer>
|
|
torch.utils.model_zoo <model_zoo>
|
|
torch.utils.tensorboard <tensorboard>
|
|
type_info
|
|
named_tensor
|
|
name_inference
|
|
torch.__config__ <__config__>
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
:caption: Libraries
|
|
|
|
torchaudio <https://pytorch.org/audio/stable>
|
|
torchtext <https://pytorch.org/text/stable>
|
|
torchvision <https://pytorch.org/vision/stable>
|
|
TorchServe <https://pytorch.org/serve>
|
|
PyTorch on XLA Devices <http://pytorch.org/xla/>
|
|
|
|
.. toctree::
|
|
:glob:
|
|
:maxdepth: 1
|
|
:caption: Community
|
|
|
|
community/*
|
|
|
|
Indices and tables
|
|
==================
|
|
|
|
* :ref:`genindex`
|
|
* :ref:`modindex`
|