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

Remove mentions of 2.4 in docs and error messages #361

Merged
merged 1 commit into from
Nov 12, 2024

Conversation

NicolasHug
Copy link
Member

Closes #235

This PR also:

  • adds a compatibility table to show which version of torchcodec is compatible with which version of torch
  • removes the installation instructions we have in the docs. Instead, the docs now link to the README which is the single source of truth. With the upcoming CUDA installation instructions, I think duplicating the instructions in 2 separate locations (and formats!) becomes unmaintainable. The users still get the installation instructions when browsing the docs, it just sends them to the README
  • Some minor drive-by (see comments below)

@facebook-github-bot facebook-github-bot added the CLA Signed This label is managed by the Meta Open Source bot. label Nov 12, 2024
2. The PyTorch version ({torch.__version__}) is not compatible with
this version of TorchCodec. Refer to the version compatibility
table:
https://github.com/pytorch/torchcodec?tab=readme-ov-file#installing-torchcodec.
Copy link
Member Author

Choose a reason for hiding this comment

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

Sadly it's impossible to tell users which version of torchcodec they're using, because the torchcodec module isn't fully initialized at this point. There's also no point telling them "you can figure it out by doing python -c 'import torchcodec; print(torchcodec.__version__)'" because it is precisely the import torchcodec` part that is triggering the RuntimeError of the above message.

- [Ship wheels for MacOS](https://github.com/pytorch/torchcodec/issues/111), so
that MacOS users can `pip install torchcodec`. For now this is only supported
on Linux, but MacOS users can [build from source](./CONTRIBUTING.md).
- [GPU decoding](https://github.com/pytorch/torchcodec/pull/58)
Copy link
Member Author

Choose a reason for hiding this comment

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

Drive-by

@NicolasHug NicolasHug merged commit b43fadb into pytorch:main Nov 12, 2024
44 of 47 checks passed
Comment on lines +124 to +128
| `torchcodec` | `torch` | Python |
| ------------------ | ------------------ | ------------------- |
| `main` / `nightly` | `main` / `nightly` | `>=3.9`, `<=3.12` |
| not yet supported | `2.5` | `>=3.9`, `<=3.12` |
| `0.0.3` | `2.4` | `>=3.8`, `<=3.12` |
Copy link
Contributor

Choose a reason for hiding this comment

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

Do we want to have a torchcodec with cuda column here too?

Copy link
Member Author

Choose a reason for hiding this comment

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

Not sure if I understand correctly. The CPU and CUDA version of torchcodec should have the same expected pytorch version?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CLA Signed This label is managed by the Meta Open Source bot.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Don't hard-code references to pytorch 2.4 in docs and error messages
4 participants