[Release 2.8] Cherry-picks (#3956)

Co-authored-by: Nicolas Hug <[email protected]>
Co-authored-by: Sam Anklesaria <[email protected]>
Co-authored-by: Sam Anklesaria <[email protected]>
fix (#3952)

Author: NicolasHug

.github/workflows/build_docs.yml

@@ -91,7 +91,7 @@ jobs:
 
         echo "::endgroup::"
         echo "::group::Build documentation"
-        # export BUILD_GALLERY=true  # TODO put this back?
+        export BUILD_GALLERY=true
         (cd docs && make html)
 
         echo "::endgroup::"

README.md

@@ -10,7 +10,8 @@ torchaudio: an audio library for PyTorch
 > [!NOTE]
 > **We are in the process of refactoring TorchAudio and transitioning it into a
 >  maintenance phase. This process will include removing some user-facing
->  features. Our main goals are to reduce redundancies with the rest of the
+>  features: those features are deprecated from TorchAudio 2.8 and will be removed in 2.9.
+>  Our main goals are to reduce redundancies with the rest of the
 >  PyTorch ecosystem, make it easier to maintain, and create a version of
 >  TorchAudio that is more tightly scoped to its strengths: processing audio
 >  data for ML. Please see

docs/source/conf.py

@@ -49,7 +49,7 @@
     "sphinx.ext.coverage",
     "sphinx.ext.napoleon",
     "sphinx.ext.viewcode",
-    "sphinxcontrib.katex",
+    # "sphinxcontrib.katex",
     "sphinxcontrib.bibtex",
     "sphinx_gallery.gen_gallery",
     "nbsphinx",

docs/source/index.rst

@@ -7,6 +7,17 @@ Torchaudio is a library for audio and signal processing with PyTorch.
 It provides I/O, signal and data processing functions, datasets,
 model implementations and application components.
 
+.. note::
+    Starting with version 2.8, we are refactoring TorchAudio to transition it
+    into a maintenance phase. As a result:
+
+    - Some APIs are deprecated in 2.8 and will be removed in 2.9.
+    - The decoding and encoding capabilities of PyTorch for both audio and video
+      are being consolidated into TorchCodec.
+
+    Please see https://github.com/pytorch/audio/issues/3902 for more information.
+
+
 ..
    Generate Table Of Contents (left navigation bar)
    NOTE: If you are adding tutorials, add entries to toctree and customcarditem below

docs/source/io.rst

@@ -3,6 +3,16 @@
 torchaudio.io
 =============
 
+.. warning::
+    Starting with version 2.8, we are refactoring TorchAudio to transition it
+    into a maintenance phase. As a result:
+
+    - The ``torchaudio.io`` module is deprecated in 2.8 and will be removed in 2.9.
+    - The decoding and encoding capabilities of PyTorch for both audio and video
+      are being consolidated into TorchCodec.
+
+    Please see https://github.com/pytorch/audio/issues/3902 for more information.
+
 .. currentmodule:: torchaudio.io
 
 .. autosummary::

docs/source/kaldi_io.rst

@@ -8,6 +8,11 @@ torchaudio.kaldi_io
 
 .. currentmodule:: torchaudio.kaldi_io
 
+.. warning::
+    Starting with version 2.8, we are refactoring TorchAudio to transition it
+    into a maintenance phase. As a result, the ``kaldi_io`` module is
+    deprecated in 2.8 and will be removed in 2.9.
+
 To use this module, the dependency kaldi_io_ needs to be installed.
 This is a light wrapper around ``kaldi_io`` that returns :class:`torch.Tensor`.
 

docs/source/libtorio.rst

@@ -1,9 +1,16 @@
 libtorio
 ========
 
+
 .. warning::
-   TorchAudio's C++ API is a prototype feature.
-   API/ABI backward compatibility is not guaranteed.
+    Starting with version 2.8, we are refactoring TorchAudio to transition it
+    into a maintenance phase. As a result:
+
+    - ``torio`` is deprecated in 2.8 and will be removed in 2.9.
+    - The decoding and encoding capabilities of PyTorch for both audio and video
+      are being consolidated into TorchCodec.
+
+    Please see https://github.com/pytorch/audio/issues/3902 for more information.
 
 .. toctree::
    libtorio.stream_reader

docs/source/libtorio.stream_reader.rst

@@ -1,6 +1,13 @@
+
 .. warning::
-   TorchAudio's C++ API is a prototype feature.
-   API/ABI backward compatibility is not guaranteed.
+    Starting with version 2.8, we are refactoring TorchAudio to transition it
+    into a maintenance phase. As a result:
+
+    - ``torio`` is deprecated in 2.8 and will be removed in 2.9.
+    - The decoding and encoding capabilities of PyTorch for both audio and video
+      are being consolidated into TorchCodec.
+
+    Please see https://github.com/pytorch/audio/issues/3902 for more information.
 
 
 .. note::

docs/source/libtorio.stream_writer.rst

@@ -1,7 +1,13 @@
+
 .. warning::
-   TorchAudio's C++ API is prototype feature.
-   API/ABI backward compatibility is not guaranteed.
+    Starting with version 2.8, we are refactoring TorchAudio to transition it
+    into a maintenance phase. As a result:
+
+    - ``torio`` is deprecated in 2.8 and will be removed in 2.9.
+    - The decoding and encoding capabilities of PyTorch for both audio and video
+      are being consolidated into TorchCodec.
 
+    Please see https://github.com/pytorch/audio/issues/3902 for more information.
 
 .. note::
    The top-level namespace has been changed from ``torchaudio`` to ``torio``.

docs/source/prototype.datasets.rst

@@ -5,6 +5,11 @@ torchaudio.prototype.datasets
 
 .. currentmodule:: torchaudio.prototype.datasets
 
+.. warning::
+    Starting with version 2.8, we are refactoring TorchAudio to transition it
+    into a maintenance phase. As a result, the ``prototype`` module is
+    deprecated in 2.8 and will be removed in 2.9.
+
 .. autosummary::
     :toctree: generated
     :nosignatures: