Skip to content

Remove io tutorials #3983

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Jul 28, 2025
Merged

Remove io tutorials #3983

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
c709c9a
Remove io tutorials
Jul 18, 2025
a2fa862
Remove effector tutorial
Jul 18, 2025
563a77f
Remove accelerated encoding/ decoding tutorials
Jul 18, 2025
d1a5984
Remove tutorial references from docs
Jul 18, 2025
b68b2c5
Merge branch 'main' into remove_io_tutorials
NicolasHug Jul 28, 2025
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
67 changes: 1 addition & 66 deletions docs/source/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,15 +50,6 @@ model implementations and application components.
:caption: API Tutorials
:hidden:

tutorials/audio_io_tutorial
tutorials/streamreader_basic_tutorial
tutorials/streamreader_advanced_tutorial
tutorials/streamwriter_basic_tutorial
tutorials/streamwriter_advanced
tutorials/nvdec_tutorial
tutorials/nvenc_tutorial

tutorials/effector_tutorial
tutorials/audio_resampling_tutorial
tutorials/audio_data_augmentation_tutorial
tutorials/audio_feature_extractions_tutorial
Expand Down Expand Up @@ -180,13 +171,6 @@ Tutorials
:link: tutorials/device_avsr.html
:tags: I/O,Pipelines,RNNT

.. customcarditem::
:header: Loading waveform Tensors from files and saving them
:card_description: Learn how to query/load audio files and save waveform tensors to files, using <code>torchaudio.info</code>, <code>torchaudio.load</code> and <code>torchaudio.save</code> functions.
:image: https://download.pytorch.org/torchaudio/tutorial-assets/thumbnails/audio_io_tutorial.png
:link: tutorials/audio_io_tutorial.html
:tags: I/O

.. customcarditem::
:header: CTC Forced Alignment API
:card_description: Learn how to use TorchAudio's CTC forced alignment API (<code>torchaudio.functional.forced_align</code>).
Expand All @@ -201,55 +185,6 @@ Tutorials
:link: tutorials/forced_alignment_for_multilingual_data_tutorial.html
:tags: Forced-Alignment

.. customcarditem::
:header: Streaming media decoding with StreamReader
:card_description: Learn how to load audio/video to Tensors using <code>torchaudio.io.StreamReader</code> class.
:image: https://download.pytorch.org/torchaudio/tutorial-assets/thumbnails/streamreader_basic_tutorial.png
:link: tutorials/streamreader_basic_tutorial.html
:tags: I/O,StreamReader

.. customcarditem::
:header: Device input, synthetic audio/video, and filtering with StreamReader
:card_description: Learn how to load media from hardware devices, generate synthetic audio/video, and apply filters to them with <code>torchaudio.io.StreamReader</code>.
:image: https://download.pytorch.org/torchaudio/tutorial-assets/thumbnails/streamreader_advanced_tutorial.gif
:link: tutorials/streamreader_advanced_tutorial.html
:tags: I/O,StreamReader

.. customcarditem::
:header: Streaming media encoding with StreamWriter
:card_description: Learn how to save audio/video with <code>torchaudio.io.StreamWriter</code>.
:image: https://download.pytorch.org/torchaudio/tutorial-assets/thumbnails/streamwriter_basic_tutorial.gif
:link: tutorials/streamwriter_basic_tutorial.html
:tags: I/O,StreamWriter

.. customcarditem::
:header: Playing media with StreamWriter
:card_description: Learn how to play audio/video with <code>torchaudio.io.StreamWriter</code>.
:image: https://download.pytorch.org/torchaudio/tutorial-assets/thumbnails/streamwriter_advanced.gif
:link: tutorials/streamwriter_advanced.html
:tags: I/O,StreamWriter

.. customcarditem::
:header: Hardware accelerated video decoding with NVDEC
:card_description: Learn how to use HW video decoder.
:image: https://download.pytorch.org/torchaudio/tutorial-assets/thumbnails/hw_acceleration_tutorial.png
:link: tutorials/nvdec_tutorial.html
:tags: I/O,StreamReader

.. customcarditem::
:header: Hardware accelerated video encoding with NVENC
:card_description: Learn how to use HW video encoder.
:image: https://download.pytorch.org/torchaudio/tutorial-assets/thumbnails/hw_acceleration_tutorial.png
:link: tutorials/nvenc_tutorial.html
:tags: I/O,StreamWriter

.. customcarditem::
:header: Apply effects and codecs to waveform
:card_description: Learn how to apply effects and codecs to waveform using <code>torchaudio.io.AudioEffector</code>.
:image: https://download.pytorch.org/torchaudio/tutorial-assets/thumbnails/effector_tutorial.png
:link: tutorials/effector_tutorial.html
:tags: Preprocessing

.. customcarditem::
:header: Audio resampling with bandlimited sinc interpolation
:card_description: Learn how to resample audio tensor with <code>torchaudio.functional.resample</code> and <code>torchaudio.transforms.Resample</code>.
Expand Down Expand Up @@ -399,7 +334,7 @@ In BibTeX format:
.. code-block:: bibtex

@misc{hwang2023torchaudio,
title={TorchAudio 2.1: Advancing speech recognition, self-supervised learning, and audio processing components for PyTorch},
title={TorchAudio 2.1: Advancing speech recognition, self-supervised learning, and audio processing components for PyTorch},
author={Jeff Hwang and Moto Hira and Caroline Chen and Xiaohui Zhang and Zhaoheng Ni and Guangzhi Sun and Pingchuan Ma and Ruizhe Huang and Vineel Pratap and Yuekai Zhang and Anurag Kumar and Chin-Yun Yu and Chuang Zhu and Chunxi Liu and Jacob Kahn and Mirco Ravanelli and Peng Sun and Shinji Watanabe and Yangyang Shi and Yumeng Tao and Robin Scheibler and Samuele Cornell and Sean Kim and Stavros Petridis},
year={2023},
eprint={2310.17864},
Expand Down
Loading
Loading