Skip to content

Commit a0df39c

Browse files
vincentqbbrianjo
andauthored
Update index.rst (#968) (#971)
Adds introductory context and links to the PyTorch Libraries to audio docs. Co-authored-by: Brian Johnson <brianjo@fb.com>
1 parent 09a6c44 commit a0df39c

File tree

1 file changed

+35
-0
lines changed

1 file changed

+35
-0
lines changed

docs/source/index.rst

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,27 @@
11
torchaudio
22
==========
3+
This library is part of the `PyTorch
4+
<http://pytorch.org/>`_ project. PyTorch is an open source
5+
machine learning framework.
6+
7+
Features described in this documentation are classified by release status:
8+
9+
*Stable:* These features will be maintained long-term and there should generally
10+
be no major performance limitations or gaps in documentation.
11+
We also expect to maintain backwards compatibility (although
12+
breaking changes can happen and notice will be given one release ahead
13+
of time).
14+
15+
*Beta:* Features are tagged as Beta because the API may change based on
16+
user feedback, because the performance needs to improve, or because
17+
coverage across operators is not yet complete. For Beta features, we are
18+
committing to seeing the feature through to the Stable classification.
19+
We are not, however, committing to backwards compatibility.
20+
21+
*Prototype:* These features are typically not available as part of
22+
binary distributions like PyPI or Conda, except sometimes behind run-time
23+
flags, and are at an early stage for feedback and testing.
24+
325

426
The :mod:`torchaudio` package consists of I/O, popular datasets and common audio transformations.
527

@@ -17,3 +39,16 @@ The :mod:`torchaudio` package consists of I/O, popular datasets and common audio
1739
compliance.kaldi
1840
kaldi_io
1941
utils
42+
43+
44+
.. toctree::
45+
:maxdepth: 1
46+
:caption: PyTorch Libraries
47+
48+
PyTorch <https://pytorch.org/docs>
49+
torchaudio <https://pytorch.org/audio>
50+
torchtext <https://pytorch.org/text>
51+
torchvision <https://pytorch.org/vision>
52+
TorchElastic <https://pytorch.org/elastic/>
53+
TorchServe <https://pytorch.org/serve>
54+
PyTorch on XLA Devices <http://pytorch.org/xla/>

0 commit comments

Comments
 (0)