File: torchaudio.rst

package info (click to toggle)
pytorch-audio 2.9.1-1
  • links: PTS, VCS
  • area: main
  • in suites: experimental
  • size: 108,884 kB
  • sloc: python: 44,403; cpp: 3,384; sh: 126; makefile: 32
file content (33 lines) | stat: -rw-r--r-- 1,058 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
torchaudio
==========

.. currentmodule:: torchaudio

.. warning::
    Starting with version 2.9, we have transitioned TorchAudio into a maintenance phase. As a result:

    - APIs deprecated in version 2.8 have been removed in 2.9.
    - The decoding and encoding capabilities of PyTorch for both audio and video
      have been consolidated into TorchCodec. For convenience,
      :func:`~torchaudio.load` and :func:`~torchaudio.save` are now aliases to
      :func:`~torchaudio.load_with_torchcodec` and :func:`~torchaudio.save_with_torchcodec`
      respectively, which call the appropriate functions from TorchCodec.
      That said, we recommend that you port your code to native torchcodec APIs.

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

I/O
---

``torchaudio`` top-level module provides the following functions that make
it easy to handle audio data.

.. autosummary::
   :toctree: generated
   :nosignatures:
   :template: autosummary/io.rst

   load
   load_with_torchcodec
   save
   save_with_torchcodec