Skip to content

Commit 2685e6b

Browse files
Add torchcodec installation instructions (#4104)
1 parent 0639492 commit 2685e6b

File tree

2 files changed

+4
-0
lines changed

2 files changed

+4
-0
lines changed

src/torchaudio/__init__.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,7 @@ def load(
3636
https://docs.pytorch.org/torchcodec/stable/generated/torchcodec.decoders.AudioDecoder.
3737
Because of the reliance on Torchcodec, the parameters ``normalize``, ``buffer_size``, and
3838
``backend`` are ignored and accepted only for backwards compatibility.
39+
To install torchcodec, follow the instructions at https://github.com/pytorch/torchcodec#installing-torchcodec.
3940
4041
4142
Args:
@@ -118,6 +119,7 @@ def save(
118119
Because of the reliance on Torchcodec, the parameters ``format``, ``encoding``,
119120
``bits_per_sample``, ``buffer_size``, and ``backend``, are ignored and accepted only for
120121
backwards compatibility.
122+
To install torchcodec, follow the instructions at https://github.com/pytorch/torchcodec#installing-torchcodec.
121123
122124
Args:
123125
uri (path-like object):

src/torchaudio/_torchcodec.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,7 @@ def load_with_torchcodec(
3030
:func:`~torchaudio.load_with_torchcodec`. Note that some parameters of
3131
:func:`~torchaudio.load`, like ``normalize``, ``buffer_size``, and
3232
``backend``, are ignored by :func:`~torchaudio.load_with_torchcodec`.
33+
To install torchcodec, follow the instructions at https://github.com/pytorch/torchcodec#installing-torchcodec.
3334
3435
3536
Args:
@@ -180,6 +181,7 @@ def save_with_torchcodec(
180181
:func:`~torchaudio.save`, like ``format``, ``encoding``,
181182
``bits_per_sample``, ``buffer_size``, and ``backend``, are ignored by
182183
are ignored by :func:`~torchaudio.save_with_torchcodec`.
184+
To install torchcodec, follow the instructions at https://github.com/pytorch/torchcodec#installing-torchcodec.
183185
184186
This function provides a TorchCodec-based alternative to torchaudio.save
185187
with the same API. TorchCodec's AudioEncoder provides efficient encoding

0 commit comments

Comments
 (0)