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.

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

Conversation

mthrok
Copy link
Collaborator

@mthrok mthrok commented Mar 25, 2022

Following the issue pytorch/text#1662, add more clarification on LTS.
Also tidy up a bit by moving older versions in to details.

cc @Nayef211


Screen Shot 2022-03-25 at 2 30 49 PM

1. move older versions to details
2. Add note about LTS being in a different channel than the regular one.
README.md Outdated Show resolved Hide resolved
@@ -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.

Co-authored-by: Caroline Chen <carolinechen@fb.com>
@facebook-github-bot
Copy link
Contributor

@mthrok has imported this pull request. If you are a Meta employee, you can view this diff on Phabricator.

@github-actions
Copy link

Hey @mthrok.
You merged this PR, but labels were not properly added. Please add a primary and secondary label (See https://github.com/pytorch/audio/blob/main/.github/process_commit.py)

@mthrok mthrok deleted the readme branch March 25, 2022 23:30
xiaohui-zhang pushed a commit to xiaohui-zhang/audio that referenced this pull request May 4, 2022
Summary:
Following the issue pytorch/text#1662, add more clarification on LTS.
Also tidy up a bit by moving older versions in to details.

cc Nayef211

 ---

<img width="794" alt="Screen Shot 2022-03-25 at 2 30 49 PM" src="https://user-images.githubusercontent.com/855818/160203327-acc5cbcb-ca86-43ee-b59f-48795b9e676c.png">

Pull Request resolved: pytorch#2293

Reviewed By: hwangjeff

Differential Revision: D35159211

Pulled By: mthrok

fbshipit-source-id: 18908c62440fc02773634c2700020fc407893dd3
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants