Skip to content

Commit 4a02eff

Browse files
authored
Update install instructions to explicitly mention PyTorch 2.4 (#223)
1 parent 91c8103 commit 4a02eff

File tree

2 files changed

+32
-33
lines changed

2 files changed

+32
-33
lines changed

README.md

Lines changed: 17 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -95,29 +95,28 @@ ffmpeg -f lavfi -i \
9595
## Installing TorchCodec
9696

9797
Note: if you're on MacOS, you'll need to [build from source](./CONTRIBUTING.md).
98-
Instructions below assume you're on Linux.
98+
The instructions below assume you're on Linux.
9999

100-
First install the latest stable version of PyTorch following the [official
101-
instructions](https://pytorch.org/get-started/locally/).
100+
1. Install the latest stable version of PyTorch following the
101+
[official instructions](https://pytorch.org/get-started/locally/). TorchCodec
102+
requires [PyTorch 2.4](https://pytorch.org/docs/2.4/).
102103

103-
Then:
104+
2. Install FFmpeg, if it's not already installed. Your Linux distribution probably
105+
comes with FFmpeg pre-installed. TorchCodec supports all major FFmpeg versions
106+
in [4, 7].
104107

105-
```bash
106-
pip install torchcodec
107-
```
108-
You will also need FFmpeg installed on your system, and TorchCodec decoding
109-
capabilities are determined by your underlying FFmpeg installation. There are
110-
different options to install FFmpeg e.g.:
111-
112-
```bash
113-
conda install ffmpeg
114-
# or
115-
conda install ffmpeg -c conda-forge
116-
```
108+
If FFmpeg is not already installed, or you need a later version, install it with:
117109

118-
Your Linux distribution probably comes with FFmpeg pre-installed as well.
119-
TorchCodec supports all major FFmpeg version in [4, 7].
110+
```bash
111+
conda install ffmpeg
112+
# or
113+
conda install ffmpeg -c conda-forge
114+
```
115+
3. Install TorchCodec:
120116

117+
```bash
118+
pip install torchcodec
119+
```
121120

122121
## Planned future work
123122

docs/source/install_instructions.rst

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -5,27 +5,27 @@ Installation Instructions
55
TorchCodec is only available on Linux for now. We plan to support other
66
platforms in the future.
77

8-
Installing torchcodec should be as simple as:
8+
There are three steps to installing TorchCodec:
99

10-
.. code:: bash
10+
1. Install the latest stable version of PyTorch following the
11+
`official instructions <https://pytorch.org/get-started/locally/>`_. TorchCodec
12+
requires `PyTorch 2.4 <https://pytorch.org/docs/2.4/>`_.
1113

12-
pip install torchcodec
14+
2. Install FFmpeg, if it's not already installed. Your Linux distribution probably
15+
comes with FFmpeg pre-installed. TorchCodec supports all major FFmpeg versions
16+
in [4, 7]. If FFmpeg is not already installed, or you need a later version, install
17+
it with:
1318

14-
You will need a working PyTorch installation, which you can install following
15-
the `official instructions <https://pytorch.org/get-started/locally/>`_.
19+
.. code:: bash
1620
17-
You will also need FFmpeg installed on your system, and TorchCodec decoding
18-
capabilities are determined by your underlying FFmpeg installation. There are
19-
different options to install FFmpeg e.g.:
21+
conda install ffmpeg
22+
# or
23+
conda install ffmpeg -c conda-forge
24+
3. Install TorchCodec:
2025

21-
.. code:: bash
26+
.. code:: bash
2227
23-
conda install ffmpeg
24-
# or
25-
conda install ffmpeg -c conda-forge
26-
27-
Your Linux distribution probably comes with FFmpeg pre-installed as well.
28-
TorchCodec supports all major FFmpeg version in [4, 7].
28+
pip install torchcodec
2929
3030
Note that installation instructions may slightly change over time. The most
3131
up-to-date instructions should be available from the `README

0 commit comments

Comments
 (0)