Skip to content

Commit 212efcc

Browse files
committed
Remove missing reference warnings when building docs
1 parent 7d4c0bf commit 212efcc

File tree

9 files changed

+8
-225
lines changed

9 files changed

+8
-225
lines changed

README.md

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -27,9 +27,6 @@ processing library. The benefits of PyTorch can be seen in torchaudio through
2727
having all the computations be through PyTorch operations which makes it easy
2828
to use and feel like a natural extension.
2929

30-
- [Support audio I/O (Load files, Save files)](http://pytorch.org/audio/main/)
31-
- Load a variety of audio formats, such as `wav`, `mp3`, `ogg`, `flac`, `opus`, `sphere`, into a torch Tensor using SoX
32-
- [Kaldi (ark/scp)](http://pytorch.org/audio/main/kaldi_io.html)
3330
- [Dataloaders for common audio datasets](http://pytorch.org/audio/main/datasets.html)
3431
- Audio and speech processing functions
3532
- [forced_align](https://pytorch.org/audio/main/generated/torchaudio.functional.forced_align.html)
@@ -70,7 +67,7 @@ If you find this package useful, please cite as:
7067

7168
```bibtex
7269
@misc{hwang2023torchaudio,
73-
title={TorchAudio 2.1: Advancing speech recognition, self-supervised learning, and audio processing components for PyTorch},
70+
title={TorchAudio 2.1: Advancing speech recognition, self-supervised learning, and audio processing components for PyTorch},
7471
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},
7572
year={2023},
7673
eprint={2310.17864},

docs/source/compliance.kaldi.rst

Lines changed: 0 additions & 20 deletions
This file was deleted.

docs/source/index.rst

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,6 @@ model implementations and application components.
6767
models
6868
models.decoder
6969
pipelines
70-
utils
7170

7271
.. toctree::
7372
:maxdepth: 1

docs/source/torchaudio.rst

Lines changed: 3 additions & 78 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,11 @@ torchaudio
44
.. currentmodule:: torchaudio
55

66
.. warning::
7-
Starting with version 2.8, we are refactoring TorchAudio to transition it
8-
into a maintenance phase. As a result:
7+
Starting with version 2.9, we have transitioned TorchAudio into a maintenance phase. As a result:
98

10-
- Most APIs listed below are deprecated in 2.8 and will be removed in 2.9.
9+
- APIs deprecated in version 2.8 have been removed in 2.9.
1110
- The decoding and encoding capabilities of PyTorch for both audio and video
12-
are being consolidated into TorchCodec. For convenience, we provide
11+
have been consolidated into TorchCodec. For convenience, we provide
1312
:func:`~torchaudio.load_with_torchcodec` as a replacement for
1413
:func:`~torchaudio.load` and :func:`~torchaudio.save_with_torchcodec` as a
1514
replacement for :func:`~torchaudio.save`, but we recommend that you port
@@ -28,81 +27,7 @@ it easy to handle audio data.
2827
:nosignatures:
2928
:template: autosummary/io.rst
3029

31-
info
3230
load
3331
load_with_torchcodec
3432
save
3533
save_with_torchcodec
36-
37-
.. _backend:
38-
39-
Backend and Dispatcher
40-
----------------------
41-
42-
Decoding and encoding media is highly elaborated process. Therefore, TorchAudio
43-
relies on third party libraries to perform these operations. These third party
44-
libraries are called ``backend``, and currently TorchAudio integrates the
45-
following libraries.
46-
47-
Please refer to `Installation <./installation.html>`__ for how to enable backends.
48-
49-
Conventionally, TorchAudio has had its I/O backend set globally at runtime
50-
based on availability. However, this approach does not allow applications to
51-
use different backends, and it is not well-suited for large codebases.
52-
53-
For these reasons, in v2.0, we introduced a dispatcher, a new mechanism to allow
54-
users to choose a backend for each function call.
55-
56-
When dispatcher mode is enabled, all the I/O functions accept extra keyward argument
57-
``backend``, which specifies the desired backend. If the specified
58-
backend is not available, the function call will fail.
59-
60-
If a backend is not explicitly chosen, the functions will select a backend to use given order of precedence and library availability.
61-
62-
The following table summarizes the backends.
63-
64-
.. list-table::
65-
:header-rows: 1
66-
:widths: 8 12 25 60
67-
68-
* - Priority
69-
- Backend
70-
- Supported OS
71-
- Note
72-
* - 1
73-
- FFmpeg
74-
- Linux, macOS, Windows
75-
- Note
76-
77-
This backend Supports various protocols, such as HTTPS and MP4, and file-like objects.
78-
* - 3
79-
- SoundFile
80-
- Linux, macOS, Windows
81-
- Please refer to `the official document <https://pysoundfile.readthedocs.io/>`__ for the supported codecs.
82-
83-
This backend supports file-like objects.
84-
85-
.. _dispatcher_migration:
86-
87-
Dispatcher Migration
88-
~~~~~~~~~~~~~~~~~~~~
89-
90-
We are migrating the I/O functions to use the dispatcher mechanism, and this
91-
incurs multiple changes, some of which involve backward-compatibility-breaking
92-
changes, and require users to change their function call.
93-
94-
The (planned) changes are as follows. For up-to-date information,
95-
please refer to https://github.com/pytorch/audio/issues/2950
96-
97-
* In 2.0, audio I/O backend dispatcher was introduced.
98-
Users can opt-in to using dispatcher by setting the environment variable
99-
``TORCHAUDIO_USE_BACKEND_DISPATCHER=1``.
100-
* In 2.1, the disptcher became the default mechanism for I/O.
101-
* In 2.2, the legacy global backend mechanism is removed.
102-
Utility functions :py:func:`get_audio_backend` and :py:func:`set_audio_backend`
103-
became no-op.
104-
105-
Furthermore, we removed file-like object support from libsox backend, as this
106-
is better supported by FFmpeg backend and makes the build process simpler.
107-
Therefore, beginning with 2.1, FFmpeg and Soundfile are the sole backends that support
108-
file-like objects.

docs/source/utils.rst

Lines changed: 0 additions & 23 deletions
This file was deleted.

examples/libtorchaudio/speech_recognition/README.md

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,6 @@
22

33
This example demonstarates how you can use torchaudio's I/O features and models to run speech recognition in C++ application.
44

5-
**NOTE**
6-
This example uses `"sox_io"` backend for loading audio, which does not work on Windows. To make it work on
7-
Windows, you need to replace the part of loading audio and converting it to Tensor object.
8-
95
## 1. Create a transcription pipeline TorchScript file
106

117
We will create a TorchScript that performs the following processes;

packaging/torchaudio/meta.yaml

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -50,9 +50,7 @@ build:
5050
test:
5151
imports:
5252
- torchaudio
53-
- torchaudio.io
5453
- torchaudio.datasets
55-
- torchaudio.sox_effects
5654
- torchaudio.transforms
5755

5856
source_files:

test/torchaudio_unittest/README.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -15,10 +15,8 @@ Some useful pytest commands:
1515
pytest test --collect-only
1616
# Run all the test suites
1717
pytest test
18-
# Run tests on sox_effects module
19-
pytest test/torchaudio_unittest/sox_effect
2018
# use -k to apply filter
21-
pytest test/torchaudio_unittest/sox_io_backend -k load # only runs tests where their names contain load
19+
pytest test/torchaudio_unittest/test_load_save_torchcodec.py -k load # only runs tests where their names contain load
2220
# Some other useful options;
2321
# Stop on the first failure -x
2422
# Run failure fast --ff
@@ -61,8 +59,6 @@ The following test modules are defined for corresponding `torchaudio` module/fun
6159
- [`torchaudio.functional`](./functional)
6260
- [`torchaudio.transforms`](./transforms/transforms_test.py)
6361
- [`torchaudio.compliance.kaldi`](./compliance_kaldi_test.py)
64-
- [`torchaudio.kaldi_io`](./kaldi_io_test.py)
65-
- [`torchaudio.sox_effects`](./sox_effect)
6662
- [`torchaudio.backend`](./backend)
6763

6864
### Test modules that do not fall into the above categories
@@ -73,6 +69,9 @@ The following test modules are defined for corresponding `torchaudio` module/fun
7369
- [assets](./assets): Contain sample audio files.
7470
- [assets/kaldi](./assets/kaldi): Contains Kaldi format matrix files used in [./test_compliance_kaldi.py](./test_compliance_kaldi.py).
7571
- [compliance](./compliance): Scripts used to generate above Kaldi matrix files.
72+
- [assets/kaldi_expected_results](./assets/kaldi_expected_results): Contains outputs from Kaldi to compare against torchaudio functionality in [./compliance/kaldi](./compliance/kaldi).
73+
- [assets/librosa_expected_results](./assets/librosa_expected_results): Contains outputs from Librosa to compare against torchaudio functionality.
74+
- [assets/sox_expected_results](./assets/sox_expected_results): Contains outputs from Sox to compare against torchaudio functionality.
7675

7776
### Waveforms for Testing Purposes
7877

test/torchaudio_unittest/assets/sox_effect_test_args.jsonl

Lines changed: 0 additions & 88 deletions
This file was deleted.

0 commit comments

Comments
 (0)