Misc cleanups

Author: samanklesaria

docs/source/torchaudio.rst

@@ -4,12 +4,11 @@ torchaudio
 .. currentmodule:: torchaudio
 
 .. warning::
-    Starting with version 2.8, we are refactoring TorchAudio to transition it
-    into a maintenance phase. As a result:
+    Starting with version 2.9, we have transitioned TorchAudio into a maintenance phase. As a result:
 
-    - Most APIs listed below are deprecated in 2.8 and will be removed in 2.9.
+    - APIs deprecated in version 2.8 have been removed in 2.9.
     - The decoding and encoding capabilities of PyTorch for both audio and video
-      are being consolidated into TorchCodec. For convenience, we provide
+      have been consolidated into TorchCodec. For convenience, we provide
       :func:`~torchaudio.load_with_torchcodec` as a replacement for
       :func:`~torchaudio.load` and :func:`~torchaudio.save_with_torchcodec` as a
       replacement for :func:`~torchaudio.save`, but we recommend that you port
@@ -34,75 +33,3 @@ it easy to handle audio data.
    save
    save_with_torchcodec
    list_audio_backends
-
-.. _backend:
-
-Backend and Dispatcher
-----------------------
-
-Decoding and encoding media is highly elaborated process. Therefore, TorchAudio
-relies on third party libraries to perform these operations. These third party
-libraries are called ``backend``, and currently TorchAudio integrates the
-following libraries.
-
-Please refer to `Installation <./installation.html>`__ for how to enable backends.
-
-Conventionally, TorchAudio has had its I/O backend set globally at runtime
-based on availability. However, this approach does not allow applications to
-use different backends, and it is not well-suited for large codebases.
-
-For these reasons, in v2.0, we introduced a dispatcher, a new mechanism to allow
-users to choose a backend for each function call.
-
-When dispatcher mode is enabled, all the I/O functions accept extra keyward argument
-``backend``, which specifies the desired backend. If the specified
-backend is not available, the function call will fail.
-
-If a backend is not explicitly chosen, the functions will select a backend to use given order of precedence and library availability.
-
-The following table summarizes the backends.
-
-.. list-table::
-   :header-rows: 1
-   :widths: 8 12 25 60
-
-   * - Priority
-     - Backend
-     - Supported OS
-     - Note
-   * - 1
-     - FFmpeg
-     - Linux, macOS, Windows
-
-       This backend Supports various protocols, such as HTTPS and MP4, and file-like objects.
-   * - 3
-     - SoundFile
-     - Linux, macOS, Windows
-     - Please refer to `the official document <https://pysoundfile.readthedocs.io/>`__ for the supported codecs.
-
-       This backend supports file-like objects.
-
-.. _dispatcher_migration:
-
-Dispatcher Migration
-~~~~~~~~~~~~~~~~~~~~
-
-We are migrating the I/O functions to use the dispatcher mechanism, and this
-incurs multiple changes, some of which involve backward-compatibility-breaking
-changes, and require users to change their function call.
-
-The (planned) changes are as follows. For up-to-date information,
-please refer to https://github.com/pytorch/audio/issues/2950
-
-* In 2.0, audio I/O backend dispatcher was introduced.
-  Users can opt-in to using dispatcher by setting the environment variable
-  ``TORCHAUDIO_USE_BACKEND_DISPATCHER=1``.
-* In 2.1, the disptcher became the default mechanism for I/O.
-* In 2.2, the legacy global backend mechanism is removed.
-  Utility functions :py:func:`get_audio_backend` and :py:func:`set_audio_backend`
-  became no-op.
-
-Furthermore, we removed file-like object support from libsox backend, as this
-is better supported by FFmpeg backend and makes the build process simpler.
-Therefore, beginning with 2.1, FFmpeg and Soundfile are the sole backends that support
-file-like objects.

docs/source/utils.rst

@@ -2,10 +2,6 @@
 
 This example demonstarates how you can use torchaudio's I/O features and models to run speech recognition in C++ application.
 
-**NOTE**
-This example uses `"sox_io"` backend for loading audio, which does not work on Windows. To make it work on
-Windows, you need to replace the part of loading audio and converting it to Tensor object.
-
 ## 1. Create a transcription pipeline TorchScript file
 
 We will create a TorchScript that performs the following processes;

examples/libtorchaudio/speech_recognition/README.md

@@ -50,9 +50,7 @@ build:
 test:
   imports:
     - torchaudio
-    - torchaudio.io
     - torchaudio.datasets
-    - torchaudio.sox_effects
     - torchaudio.transforms
 
   source_files:

packaging/torchaudio/meta.yaml

@@ -21,10 +21,8 @@ Some useful pytest commands:
 pytest test --collect-only
 # Run all the test suites
 pytest test
-# Run tests on sox_effects module
-pytest test/torchaudio_unittest/sox_effect
 # use -k to apply filter
-pytest test/torchaudio_unittest/sox_io_backend -k load  # only runs tests where their names contain load
+pytest test/torchaudio_unittest/test_load_save_torchcodec.py -k load  # only runs tests where their names contain load
 # Some other useful options;
 # Stop on the first failure -x
 # Run failure fast --ff
@@ -67,8 +65,6 @@ The following test modules are defined for corresponding `torchaudio` module/fun
 - [`torchaudio.functional`](./functional)
 - [`torchaudio.transforms`](./transforms/transforms_test.py)
 - [`torchaudio.compliance.kaldi`](./compliance_kaldi_test.py)
-- [`torchaudio.kaldi_io`](./kaldi_io_test.py)
-- [`torchaudio.sox_effects`](./sox_effect)
 - [`torchaudio.backend`](./backend)
 
 ### Test modules that do not fall into the above categories
@@ -79,6 +75,9 @@ The following test modules are defined for corresponding `torchaudio` module/fun
 - [assets](./assets): Contain sample audio files.
 - [assets/kaldi](./assets/kaldi): Contains Kaldi format matrix files used in [./test_compliance_kaldi.py](./test_compliance_kaldi.py).
 - [compliance](./compliance): Scripts used to generate above Kaldi matrix files.
+- [assets/kaldi_expected_results](./assets/kaldi_expected_results): Contains outputs from Kaldi to compare against torchaudio functionality in [./compliance/kaldi](./compliance/kaldi).
+- [assets/librosa_expected_results](./assets/librosa_expected_results): Contains outputs from Librosa to compare against torchaudio functionality.
+- [assets/sox_expected_results](./assets/sox_expected_results): Contains outputs from Sox to compare against torchaudio functionality.
 
 ### Waveforms for Testing Purposes