Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
65 changes: 43 additions & 22 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,11 @@ Features described in this documentation are classified by release status:

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

Package References
------------------

.. toctree::
:maxdepth: 2
:maxdepth: 1
:caption: Package Reference

torchaudio
Expand All @@ -42,29 +45,33 @@ The :mod:`torchaudio` package consists of I/O, popular datasets and common audio
utils
prototype

Getting Started
---------------

.. toctree::
:maxdepth: 2
:caption: Tutorials
:maxdepth: 1
:caption: Getting Started

tutorials/speech_recognition_pipeline_tutorial
tutorials/forced_alignment_tutorial
tutorials/tacotron2_pipeline_tutorial
tutorials/audio_io_tutorial
tutorials/audio_resampling_tutorial
tutorials/audio_data_augmentation_tutorial
tutorials/audio_feature_extractions_tutorial
tutorials/audio_feature_augmentation_tutorial
tutorials/audio_datasets_tutorial

Advanced Usages
---------------

.. toctree::
:maxdepth: 1
:caption: PyTorch Libraries

PyTorch <https://pytorch.org/docs>
torchaudio <https://pytorch.org/audio>
torchtext <https://pytorch.org/text>
torchvision <https://pytorch.org/vision>
TorchElastic <https://pytorch.org/elastic/>
TorchServe <https://pytorch.org/serve>
PyTorch on XLA Devices <http://pytorch.org/xla/>
:caption: Advanced Usages

tutorials/speech_recognition_pipeline_tutorial
tutorials/forced_alignment_tutorial
tutorials/tacotron2_pipeline_tutorial

Citing torchaudio
~~~~~~~~~~~~~~~~~
-----------------

If you find torchaudio useful, please cite the following paper:

Expand All @@ -81,13 +88,27 @@ In BibTeX format:

@article{yang2021torchaudio,
title={TorchAudio: Building Blocks for Audio and Speech Processing},
author={Yao-Yuan Yang and Moto Hira and Zhaoheng Ni and Anjali Chourdia and Artyom Astafurov
and Caroline Chen and Ching-Feng Yeh and Christian Puhrsch and David Pollack and
Dmitriy Genzel and Donny Greenberg and Edward Z. Yang and Jason Lian and Jay
Mahadeokar and Jeff Hwang and Ji Chen and Peter Goldsborough and Prabhat Roy and
Sean Narenthiran and Shinji Watanabe and Soumith Chintala and Vincent
Quenneville-Bélair and Yangyang Shi},
author={Yao-Yuan Yang and Moto Hira and Zhaoheng Ni and
Anjali Chourdia and Artyom Astafurov and Caroline Chen and
Ching-Feng Yeh and Christian Puhrsch and David Pollack and
Dmitriy Genzel and Donny Greenberg and Edward Z. Yang and
Jason Lian and Jay Mahadeokar and Jeff Hwang and Ji Chen and
Peter Goldsborough and Prabhat Roy and Sean Narenthiran and
Shinji Watanabe and Soumith Chintala and
Vincent Quenneville-Bélair and Yangyang Shi},
journal={arXiv preprint arXiv:2110.15018},
year={2021}
}

.. toctree::
:maxdepth: 1
:caption: PyTorch Libraries
:hidden:

PyTorch <https://pytorch.org/docs>
torchaudio <https://pytorch.org/audio>
torchtext <https://pytorch.org/text>
torchvision <https://pytorch.org/vision>
TorchElastic <https://pytorch.org/elastic/>
TorchServe <https://pytorch.org/serve>
PyTorch on XLA Devices <http://pytorch.org/xla/>
Loading