Skip to content

Commit 3af9337

Browse files
NicolasHugfacebook-github-bot
authored andcommitted
Add top-level links in README.md (#121)
Summary: Add a bunch of relevant links at the very-top of the README. I think we'll need to merge this before we can check whether the links are properly working. Also made some minor README-related changes. Pull Request resolved: #121 Reviewed By: ahmadsharif1 Differential Revision: D60375936 Pulled By: NicolasHug fbshipit-source-id: 72bd52e97b13eaae7f98b179094929329a494398
1 parent 56ed669 commit 3af9337

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

README.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,21 @@
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)
32

43
# TorchCodec
54

65
TorchCodec is a Python package with a goal to provide useful and fast APIs to
76
decode video frames to PyTorch Tensors.
87

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)!
1213
1314
## Using TorchCodec
1415

1516
Here's a condensed summary of what you can do with TorchCodec. For a more
1617
detailed example, [check out our
17-
documentation](https://pytorch.org/torchcodec/main/generated_examples/)!
18+
documentation](https://pytorch.org/torchcodec/stable/generated_examples/)!
1819

1920
```python
2021
from torchcodec.decoders import SimpleVideoDecoder
@@ -92,10 +93,9 @@ capabilities are determined by your underlying FFmpeg installation. There are
9293
different options to install FFmpeg e.g.:
9394

9495
```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
9999
```
100100

101101
Your Linux distribution probably comes with FFmpeg pre-installed as well.

0 commit comments

Comments
 (0)