Skip to content
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

Update README around version compatibility matrix #2293

Closed
wants to merge 2 commits into from
Closed

Update README around version compatibility matrix #2293

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
122568a
Update README around version compatibility matrix
mthrok Mar 25, 2022
963e8c0
Update README.md
mthrok Mar 25, 2022
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
19 changes: 14 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,10 +31,16 @@ Dependencies

The following are the corresponding ``torchaudio`` versions and supported Python versions.

| | ``torch`` | ``torchaudio`` | ``python`` |
| ----------- | ------------------------ | ------------------------ | ------------------------------- |
| Development | ``master`` / ``nightly`` | ``main`` / ``nightly`` | ``>=3.7``, ``<=3.9`` |
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

is this meant to convey that each pair in the cross of torch (master branch, nightly build) and torchaudio (main branch, nightly build) is compatible?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I guess so but I'd say it's a not precise, and the master/main part does not make much sense. There are no pre-built binaries correspond to master/main branch.

The pair of PyTorch nightly build and torchaudio nightly build makes sense. So I think there are two information mixed up here. One is that torchaudio nightly build has to use pytorch nightly build (and their Python version). The other is that torchaudio main branch is meant to be built with PyTorch master branch.

| Latest versioned release | ``1.11.0`` | ``0.11.0`` | ``>=3.7``, ``<=3.9`` |
| LTS | ``1.8.2`` | ``0.8.2`` | ``>=3.6``, ``<=3.9`` |

<details><summary>Previous versions</summary>

| ``torch`` | ``torchaudio`` | ``python`` |
| ------------------------ | ------------------------ | ------------------------------- |
| ``master`` / ``nightly`` | ``main`` / ``nightly`` | ``>=3.7``, ``<=3.9`` |
| ``1.11.0`` | ``0.11.0`` | ``>=3.7``, ``<=3.9`` |
| ``1.10.0`` | ``0.10.0`` | ``>=3.6``, ``<=3.9`` |
| ``1.9.1`` | ``0.9.1`` | ``>=3.6``, ``<=3.9`` |
| ``1.9.0`` | ``0.9.0`` | ``>=3.6``, ``<=3.9`` |
Expand All @@ -46,18 +52,21 @@ The following are the corresponding ``torchaudio`` versions and supported Python
| ``1.5.0`` | ``0.5.0`` | ``>=3.5``, ``<=3.8`` |
| ``1.4.0`` | ``0.4.0`` | ``==2.7``, ``>=3.5``, ``<=3.8`` |

</details>

Installation
------------

### Binary Distributions (stable and nightly)
### Binary Distributions

`torchaudio` has binary distributions for PyPI (`pip`) and Anaconda (`conda`).

Starting `0.10`, torchaudio has CPU-only and CUDA-enabled binary distributions, each of which requires a matching PyTorch version.

Please refer to https://pytorch.org/get-started/locally/ for the details.

**Note** Starting `0.10`, torchaudio has CPU-only and CUDA-enabled binary distributions, each of which requires a matching PyTorch version.

**Note** <ins>LTS versions are distributed through a different channel than the other versioned releases. Please refer to the above page for details.</ins>

### From Source

On non-Windows platforms, the build process builds libsox and codecs that torchaudio need to link to. It will fetch and build libmad, lame, flac, vorbis, opus, and libsox before building extension. This process requires `cmake` and `pkg-config`. libsox-based features can be disabled with `BUILD_SOX=0`.
Expand Down