Skip to content

Add torchcodec installation instructions #4104

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Sep 10, 2025
Merged

Add torchcodec installation instructions #4104

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions src/torchaudio/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,7 @@ def load(
https://docs.pytorch.org/torchcodec/stable/generated/torchcodec.decoders.AudioDecoder.
Because of the reliance on Torchcodec, the parameters ``normalize``, ``buffer_size``, and
``backend`` are ignored and accepted only for backwards compatibility.
To install torchcodec, follow the instructions at https://github.com/pytorch/torchcodec#installing-torchcodec.


Args:
Expand Down Expand Up @@ -118,6 +119,7 @@ def save(
Because of the reliance on Torchcodec, the parameters ``format``, ``encoding``,
``bits_per_sample``, ``buffer_size``, and ``backend``, are ignored and accepted only for
backwards compatibility.
To install torchcodec, follow the instructions at https://github.com/pytorch/torchcodec#installing-torchcodec.

Args:
uri (path-like object):
Expand Down
2 changes: 2 additions & 0 deletions src/torchaudio/_torchcodec.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ def load_with_torchcodec(
:func:`~torchaudio.load_with_torchcodec`. Note that some parameters of
:func:`~torchaudio.load`, like ``normalize``, ``buffer_size``, and
``backend``, are ignored by :func:`~torchaudio.load_with_torchcodec`.
To install torchcodec, follow the instructions at https://github.com/pytorch/torchcodec#installing-torchcodec.


Args:
Expand Down Expand Up @@ -180,6 +181,7 @@ def save_with_torchcodec(
:func:`~torchaudio.save`, like ``format``, ``encoding``,
``bits_per_sample``, ``buffer_size``, and ``backend``, are ignored by
are ignored by :func:`~torchaudio.save_with_torchcodec`.
To install torchcodec, follow the instructions at https://github.com/pytorch/torchcodec#installing-torchcodec.

This function provides a TorchCodec-based alternative to torchaudio.save
with the same API. TorchCodec's AudioEncoder provides efficient encoding
Expand Down
Loading