Skip to content

Commit 70caf76

Browse files
NicolasHugNicolasHug
authored
Update deprecation wording, add warnings to main pages (#3955)
1 parent 8353ffb commit 70caf76

38 files changed

+326
-26
lines changed

‎README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,8 @@ torchaudio: an audio library for PyTorch
1010
> [!NOTE]
1111
> **We are in the process of refactoring TorchAudio and transitioning it into a
1212
> maintenance phase. This process will include removing some user-facing
13-
> features. Our main goals are to reduce redundancies with the rest of the
13+
> features: those features are deprecated from TorchAudio 2.8 and will be removed in 2.9.
14+
> Our main goals are to reduce redundancies with the rest of the
1415
> PyTorch ecosystem, make it easier to maintain, and create a version of
1516
> TorchAudio that is more tightly scoped to its strengths: processing audio
1617
> data for ML. Please see

‎docs/source/index.rst

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,17 @@ Torchaudio is a library for audio and signal processing with PyTorch.
77
It provides I/O, signal and data processing functions, datasets,
88
model implementations and application components.
99

10+
.. note::
11+
Starting with version 2.8, we are refactoring TorchAudio to transition it
12+
into a maintenance phase. As a result:
13+
14+
- Some APIs are deprecated in 2.8 and will be removed in 2.9.
15+
- The decoding and encoding capabilities of PyTorch for both audio and video
16+
are being consolidated into TorchCodec.
17+
18+
Please see https://github.com/pytorch/audio/issues/3902 for more information.
19+
20+
1021
..
1122
Generate Table Of Contents (left navigation bar)
1223
NOTE: If you are adding tutorials, add entries to toctree and customcarditem below

‎docs/source/io.rst

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,16 @@
33
torchaudio.io
44
=============
55

6+
.. warning::
7+
Starting with version 2.8, we are refactoring TorchAudio to transition it
8+
into a maintenance phase. As a result:
9+
10+
- The ``torchaudio.io`` module is deprecated in 2.8 and will be removed in 2.9.
11+
- The decoding and encoding capabilities of PyTorch for both audio and video
12+
are being consolidated into TorchCodec.
13+
14+
Please see https://github.com/pytorch/audio/issues/3902 for more information.
15+
616
.. currentmodule:: torchaudio.io
717

818
.. autosummary::

‎docs/source/kaldi_io.rst

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,11 @@ torchaudio.kaldi_io
88
99
.. currentmodule:: torchaudio.kaldi_io
1010

11+
.. warning::
12+
Starting with version 2.8, we are refactoring TorchAudio to transition it
13+
into a maintenance phase. As a result, the ``kaldi_io`` module is
14+
deprecated in 2.8 and will be removed in 2.9.
15+
1116
To use this module, the dependency kaldi_io_ needs to be installed.
1217
This is a light wrapper around ``kaldi_io`` that returns :class:`torch.Tensor`.
1318

‎docs/source/libtorio.rst

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,16 @@
11
libtorio
22
========
33

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

815
.. toctree::
916
libtorio.stream_reader

‎docs/source/libtorio.stream_reader.rst

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,13 @@
1+
12
.. warning::
2-
TorchAudio's C++ API is a prototype feature.
3-
API/ABI backward compatibility is not guaranteed.
3+
Starting with version 2.8, we are refactoring TorchAudio to transition it
4+
into a maintenance phase. As a result:
5+
6+
- ``torio`` is deprecated in 2.8 and will be removed in 2.9.
7+
- The decoding and encoding capabilities of PyTorch for both audio and video
8+
are being consolidated into TorchCodec.
9+
10+
Please see https://github.com/pytorch/audio/issues/3902 for more information.
411

512

613
.. note::

‎docs/source/libtorio.stream_writer.rst

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,13 @@
1+
12
.. warning::
2-
TorchAudio's C++ API is prototype feature.
3-
API/ABI backward compatibility is not guaranteed.
3+
Starting with version 2.8, we are refactoring TorchAudio to transition it
4+
into a maintenance phase. As a result:
5+
6+
- ``torio`` is deprecated in 2.8 and will be removed in 2.9.
7+
- The decoding and encoding capabilities of PyTorch for both audio and video
8+
are being consolidated into TorchCodec.
49

10+
Please see https://github.com/pytorch/audio/issues/3902 for more information.
511

612
.. note::
713
The top-level namespace has been changed from ``torchaudio`` to ``torio``.

‎docs/source/prototype.datasets.rst

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,11 @@ torchaudio.prototype.datasets
55

66
.. currentmodule:: torchaudio.prototype.datasets
77

8+
.. warning::
9+
Starting with version 2.8, we are refactoring TorchAudio to transition it
10+
into a maintenance phase. As a result, the ``prototype`` module is
11+
deprecated in 2.8 and will be removed in 2.9.
12+
813
.. autosummary::
914
:toctree: generated
1015
:nosignatures:

‎docs/source/prototype.functional.rst

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,11 @@ torchaudio.prototype.functional
44
.. py:module:: torchaudio.prototype.functional
55
.. currentmodule:: torchaudio.prototype.functional
66

7+
.. warning::
8+
Starting with version 2.8, we are refactoring TorchAudio to transition it
9+
into a maintenance phase. As a result, the ``prototype`` module is
10+
deprecated in 2.8 and will be removed in 2.9.
11+
712
Utility
813
~~~~~~~
914

‎docs/source/prototype.models.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,10 @@ torchaudio.prototype.models
44
.. py:module:: torchaudio.prototype.models
55
.. currentmodule:: torchaudio.prototype.models
66

7+
.. warning::
8+
Starting with version 2.8, we are refactoring TorchAudio to transition it
9+
into a maintenance phase. As a result, the ``prototype`` module is
10+
deprecated in 2.8 and will be removed in 2.9.
711

812
The ``torchaudio.prototype.models`` subpackage contains definitions of models for addressing common audio tasks.
913

‎docs/source/prototype.pipelines.rst

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,11 @@ torchaudio.prototype.pipelines
55
.. py:module:: torchaudio.prototype.pipelines
66
.. currentmodule:: torchaudio.prototype.pipelines
77

8+
.. warning::
9+
Starting with version 2.8, we are refactoring TorchAudio to transition it
10+
into a maintenance phase. As a result, the ``prototype`` module is
11+
deprecated in 2.8 and will be removed in 2.9.
12+
813
The pipelines subpackage contains APIs to models with pretrained weights and relevant utilities.
914

1015
RNN-T Streaming/Non-Streaming ASR

‎docs/source/prototype.rst

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,9 @@ torchaudio.prototype
22
====================
33

44
.. warning::
5-
As TorchAudio is no longer being actively developed, this functionality will no longer be supported.
6-
See https://github.com/pytorch/audio/issues/3902 for more details.
5+
Starting with version 2.8, we are refactoring TorchAudio to transition it
6+
into a maintenance phase. As a result, the ``prototype`` module is
7+
deprecated in 2.8 and will be removed in 2.9.
78

89
``torchaudio.prototype`` provides prototype features;
910
they are at an early stage for feedback and testing.

‎docs/source/prototype.transforms.rst

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,11 @@ torchaudio.prototype.transforms
55

66
.. currentmodule:: torchaudio.prototype.transforms
77

8+
.. warning::
9+
Starting with version 2.8, we are refactoring TorchAudio to transition it
10+
into a maintenance phase. As a result, the ``prototype`` module is
11+
deprecated in 2.8 and will be removed in 2.9.
12+
813
.. autosummary::
914
:toctree: generated
1015
:nosignatures:

‎docs/source/sox_effects.rst

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,11 @@ torchaudio.sox_effects
55

66
.. currentmodule:: torchaudio.sox_effects
77

8+
.. warning::
9+
Starting with version 2.8, we are refactoring TorchAudio to transition it
10+
into a maintenance phase. As a result, the ``sox_effect`` module is
11+
deprecated in 2.8 and will be removed in 2.9.
12+
813
Applying effects
914
----------------
1015

‎docs/source/torchaudio.rst

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,16 @@ torchaudio
33

44
.. currentmodule:: torchaudio
55

6+
.. warning::
7+
Starting with version 2.8, we are refactoring TorchAudio to transition it
8+
into a maintenance phase. As a result:
9+
10+
- The APIs listed below are deprecated in 2.8 and will be removed in 2.9.
11+
- The decoding and encoding capabilities of PyTorch for both audio and video
12+
are being consolidated into TorchCodec.
13+
14+
Please see https://github.com/pytorch/audio/issues/3902 for more information.
15+
616
I/O
717
---
818

‎docs/source/torio.io.rst

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,16 @@ torio.io
55

66
.. currentmodule:: torio.io
77

8+
.. warning::
9+
Starting with version 2.8, we are refactoring TorchAudio to transition it
10+
into a maintenance phase. As a result:
11+
12+
- ``torio`` is deprecated in 2.8 and will be removed in 2.9.
13+
- The decoding and encoding capabilities of PyTorch for both audio and video
14+
are being consolidated into TorchCodec.
15+
16+
Please see https://github.com/pytorch/audio/issues/3902 for more information.
17+
818
.. autosummary::
919
:toctree: generated
1020
:nosignatures:

‎docs/source/torio.rst

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,16 @@ torio
55

66
.. currentmodule:: torio.io
77

8+
.. warning::
9+
Starting with version 2.8, we are refactoring TorchAudio to transition it
10+
into a maintenance phase. As a result:
11+
12+
- ``torio`` is deprecated in 2.8 and will be removed in 2.9.
13+
- The decoding and encoding capabilities of PyTorch for both audio and video
14+
are being consolidated into TorchCodec.
15+
16+
Please see https://github.com/pytorch/audio/issues/3902 for more information.
17+
818
``torio`` is an alternative top-level module for I/O features. It is the extraction of the core implementation of I/O feature of ``torchaudio``.
919

1020
If you want to use the multimedia processing features, but do not want to depend on the entire ``torchaudio`` package, you can use ``torio``.

‎docs/source/torio.utils.rst

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,16 @@ torio.utils
55

66
``torio.utils`` module contains utility functions to query and configure the global state of third party libraries.
77

8+
.. warning::
9+
Starting with version 2.8, we are refactoring TorchAudio to transition it
10+
into a maintenance phase. As a result:
11+
12+
- ``torio`` is deprecated in 2.8 and will be removed in 2.9.
13+
- The decoding and encoding capabilities of PyTorch for both audio and video
14+
are being consolidated into TorchCodec.
15+
16+
Please see https://github.com/pytorch/audio/issues/3902 for more information.
17+
818
.. currentmodule:: torio.utils
919

1020
.. autosummary::

‎docs/source/utils.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,14 @@ torchaudio.utils
55

66
``torchaudio.utils`` module contains utility functions to configure the global state of third party libraries.
77

8+
.. warning::
9+
Starting with version 2.8, we are refactoring TorchAudio to transition it
10+
into a maintenance phase. As a result:
11+
- ``sox_utils`` and `ffmpeg_utils`` are deprecated in 2.8 and will be removed in 2.9.
12+
- The decoding and encoding capabilities of PyTorch for both audio and video
13+
are being consolidated into TorchCodec.
14+
Please see https://github.com/pytorch/audio/issues/3902 for more information.
15+
816
.. currentmodule:: torchaudio.utils
917

1018
.. autosummary::

‎examples/tutorials/additive_synthesis_tutorial.py

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,16 @@
55
66
**Author**: `Moto Hira <moto@meta.com>`__
77
8+
.. warning::
9+
Starting with version 2.8, we are refactoring TorchAudio to transition it
10+
into a maintenance phase. As a result:
11+
12+
- The APIs described in this tutorial are deprecated in 2.8 and will be removed in 2.9.
13+
- The decoding and encoding capabilities of PyTorch for both audio and video
14+
are being consolidated into TorchCodec.
15+
16+
Please see https://github.com/pytorch/audio/issues/3902 for more information.
17+
818
This tutorial is the continuation of
919
`Oscillator and ADSR Envelope <./oscillator_tutorial.html>`__.
1020

‎examples/tutorials/asr_inference_with_cuda_ctc_decoder_tutorial.py

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,16 @@
44
55
**Author**: `Yuekai Zhang <yuekaiz@nvidia.com>`__
66
7+
.. warning::
8+
Starting with version 2.8, we are refactoring TorchAudio to transition it
9+
into a maintenance phase. As a result:
10+
11+
- The APIs described in this tutorial are deprecated in 2.8 and will be removed in 2.9.
12+
- The decoding and encoding capabilities of PyTorch for both audio and video
13+
are being consolidated into TorchCodec.
14+
15+
Please see https://github.com/pytorch/audio/issues/3902 for more information.
16+
717
This tutorial shows how to perform speech recognition inference using a
818
CUDA-based CTC beam search decoder.
919
We demonstrate this on a pretrained

‎examples/tutorials/audio_io_tutorial.py

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,14 @@
99
load them into PyTorch Tensors and save PyTorch Tensors.
1010
1111
.. warning::
12-
IO functionality within TorchAudio has been superseded by `AudioDecoder` from the TorchCodec library.
13-
See https://github.com/pytorch/audio/issues/3902 for more details.`.
12+
Starting with version 2.8, we are refactoring TorchAudio to transition it
13+
into a maintenance phase. As a result:
14+
15+
- The APIs described in this tutorial are deprecated in 2.8 and will be removed in 2.9.
16+
- The decoding and encoding capabilities of PyTorch for both audio and video
17+
are being consolidated into TorchCodec.
18+
19+
Please see https://github.com/pytorch/audio/issues/3902 for more information.
1420
1521
"""
1622

‎examples/tutorials/ctc_forced_alignment_api_tutorial.py

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,14 @@
55
**Author**: `Xiaohui Zhang <xiaohuizhang@meta.com>`__, `Moto Hira <moto@meta.com>`__
66
77
.. warning::
8-
As TorchAudio is no longer being actively developed, this functionality will no longer be supported.
9-
See https://github.com/pytorch/audio/issues/3902 for more details.
8+
Starting with version 2.8, we are refactoring TorchAudio to transition it
9+
into a maintenance phase. As a result:
10+
11+
- The APIs described in this tutorial are deprecated in 2.8 and will be removed in 2.9.
12+
- The decoding and encoding capabilities of PyTorch for both audio and video
13+
are being consolidated into TorchCodec.
14+
15+
Please see https://github.com/pytorch/audio/issues/3902 for more information.
1016
1117
The forced alignment is a process to align transcript with speech.
1218
This tutorial shows how to align transcripts to speech using

‎examples/tutorials/effector_tutorial.py

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,14 @@
55
**Author**: `Moto Hira <moto@meta.com>`__
66
77
.. warning::
8-
As TorchAudio is no longer being actively developed, this functionality will no longer be supported.
9-
See https://github.com/pytorch/audio/issues/3902 for more details.
8+
Starting with version 2.8, we are refactoring TorchAudio to transition it
9+
into a maintenance phase. As a result:
10+
11+
- The APIs described in this tutorial are deprecated in 2.8 and will be removed in 2.9.
12+
- The decoding and encoding capabilities of PyTorch for both audio and video
13+
are being consolidated into TorchCodec.
14+
15+
Please see https://github.com/pytorch/audio/issues/3902 for more information.
1016
1117
This tutorial shows how to use :py:class:`torchaudio.io.AudioEffector` to
1218
apply various effects and codecs to waveform tensor.

‎examples/tutorials/filter_design_tutorial.py

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,16 @@
44
55
**Author**: `Moto Hira <moto@meta.com>`__
66
7+
.. warning::
8+
Starting with version 2.8, we are refactoring TorchAudio to transition it
9+
into a maintenance phase. As a result:
10+
11+
- The APIs described in this tutorial are deprecated in 2.8 and will be removed in 2.9.
12+
- The decoding and encoding capabilities of PyTorch for both audio and video
13+
are being consolidated into TorchCodec.
14+
15+
Please see https://github.com/pytorch/audio/issues/3902 for more information.
16+
717
This tutorial shows how to create basic digital filters
818
(impulse responses) and their properties.
919

‎examples/tutorials/forced_alignment_for_multilingual_data_tutorial.py

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,16 @@
44
55
**Authors**: `Xiaohui Zhang <xiaohuizhang@meta.com>`__, `Moto Hira <moto@meta.com>`__.
66
7+
.. warning::
8+
Starting with version 2.8, we are refactoring TorchAudio to transition it
9+
into a maintenance phase. As a result:
10+
11+
- The APIs described in this tutorial are deprecated in 2.8 and will be removed in 2.9.
12+
- The decoding and encoding capabilities of PyTorch for both audio and video
13+
are being consolidated into TorchCodec.
14+
15+
Please see https://github.com/pytorch/audio/issues/3902 for more information.
16+
717
This tutorial shows how to align transcript to speech for non-English languages.
818
919
The process of aligning non-English (normalized) transcript is identical to aligning

0 commit comments

Comments
 (0)