|
1 |
| -<!-- TODO_BEFORE_RELEASE Add obvious link to docs and potentially a tag as |
2 |
| -well--> |
| 1 | +[**Installation**](#installing-torchcodec) | [**Simple Example**](#using-torchcodec) | [**Detailed Example**](https://pytorch.org/torchcodec/stable/generated_examples/) | [**Documentation**](https://pytorch.org/torchcodec) | [**Contributing**](CONTRIBUTING.md) | [**License**](#license) |
3 | 2 |
|
4 | 3 | # TorchCodec
|
5 | 4 |
|
6 | 5 | TorchCodec is a Python package with a goal to provide useful and fast APIs to
|
7 | 6 | decode video frames to PyTorch Tensors.
|
8 | 7 |
|
9 |
| -⚠️ TorchCodec is still in early development stage and we are actively seeking |
10 |
| -feedback. If you have any suggestions or issues, please let us know by [opening |
11 |
| -an issue](https://github.com/pytorch/torchcodec/issues/new/choose)! |
| 8 | +> [!NOTE] |
| 9 | +> ⚠️ TorchCodec is still in early development stage and some APIs may be updated |
| 10 | +> in future versions without a deprecation cycle, depending on user feedback. |
| 11 | +> If you have any suggestions or issues, please let us know by |
| 12 | +> [opening an issue](https://github.com/pytorch/torchcodec/issues/new/choose)! |
12 | 13 |
|
13 | 14 | ## Using TorchCodec
|
14 | 15 |
|
15 | 16 | Here's a condensed summary of what you can do with TorchCodec. For a more
|
16 | 17 | detailed example, [check out our
|
17 |
| -documentation](https://pytorch.org/torchcodec/main/generated_examples/)! |
| 18 | +documentation](https://pytorch.org/torchcodec/stable/generated_examples/)! |
18 | 19 |
|
19 | 20 | ```python
|
20 | 21 | from torchcodec.decoders import SimpleVideoDecoder
|
@@ -92,10 +93,9 @@ capabilities are determined by your underlying FFmpeg installation. There are
|
92 | 93 | different options to install FFmpeg e.g.:
|
93 | 94 |
|
94 | 95 | ```bash
|
95 |
| - |
96 |
| - conda install ffmpeg |
97 |
| - # or |
98 |
| - conda install ffmpeg -c conda-forge |
| 96 | +conda install ffmpeg |
| 97 | +# or |
| 98 | +conda install ffmpeg -c conda-forge |
99 | 99 | ```
|
100 | 100 |
|
101 | 101 | Your Linux distribution probably comes with FFmpeg pre-installed as well.
|
|
0 commit comments