From 2871977c20e38e66a11cb6985ddd272b6eebd845 Mon Sep 17 00:00:00 2001 From: Scott Schneider Date: Tue, 24 Sep 2024 11:47:57 -0700 Subject: [PATCH] Update install instructions to explicitly mention PyTorch 2.4 --- README.md | 35 ++++++++++++++-------------- docs/source/install_instructions.rst | 30 ++++++++++++------------ 2 files changed, 32 insertions(+), 33 deletions(-) diff --git a/README.md b/README.md index 183120598..66c82a154 100644 --- a/README.md +++ b/README.md @@ -95,29 +95,28 @@ ffmpeg -f lavfi -i \ ## Installing TorchCodec Note: if you're on MacOS, you'll need to [build from source](./CONTRIBUTING.md). -Instructions below assume you're on Linux. +The instructions below assume you're on Linux. -First install the latest stable version of PyTorch following the [official -instructions](https://pytorch.org/get-started/locally/). + 1. Install the latest stable version of PyTorch following the + [official instructions](https://pytorch.org/get-started/locally/). TorchCodec + requires [PyTorch 2.4](https://pytorch.org/docs/2.4/). -Then: + 2. Install FFmpeg, if it's not already installed. Your Linux distribution probably + comes with FFmpeg pre-installed. TorchCodec supports all major FFmpeg versions + in [4, 7]. -```bash -pip install torchcodec -``` -You will also need FFmpeg installed on your system, and TorchCodec decoding -capabilities are determined by your underlying FFmpeg installation. There are -different options to install FFmpeg e.g.: - -```bash -conda install ffmpeg -# or -conda install ffmpeg -c conda-forge -``` + If FFmpeg is not already installed, or you need a later version, install it with: -Your Linux distribution probably comes with FFmpeg pre-installed as well. -TorchCodec supports all major FFmpeg version in [4, 7]. + ```bash + conda install ffmpeg + # or + conda install ffmpeg -c conda-forge + ``` + 3. Install TorchCodec: + ```bash + pip install torchcodec + ``` ## Planned future work diff --git a/docs/source/install_instructions.rst b/docs/source/install_instructions.rst index 41919be98..1242c24ba 100644 --- a/docs/source/install_instructions.rst +++ b/docs/source/install_instructions.rst @@ -5,27 +5,27 @@ Installation Instructions TorchCodec is only available on Linux for now. We plan to support other platforms in the future. -Installing torchcodec should be as simple as: +There are three steps to installing TorchCodec: -.. code:: bash +1. Install the latest stable version of PyTorch following the + `official instructions `_. TorchCodec + requires `PyTorch 2.4 `_. - pip install torchcodec +2. Install FFmpeg, if it's not already installed. Your Linux distribution probably + comes with FFmpeg pre-installed. TorchCodec supports all major FFmpeg versions + in [4, 7]. If FFmpeg is not already installed, or you need a later version, install + it with: -You will need a working PyTorch installation, which you can install following -the `official instructions `_. + .. code:: bash -You will also need FFmpeg installed on your system, and TorchCodec decoding -capabilities are determined by your underlying FFmpeg installation. There are -different options to install FFmpeg e.g.: + conda install ffmpeg + # or + conda install ffmpeg -c conda-forge +3. Install TorchCodec: -.. code:: bash + .. code:: bash - conda install ffmpeg - # or - conda install ffmpeg -c conda-forge - -Your Linux distribution probably comes with FFmpeg pre-installed as well. -TorchCodec supports all major FFmpeg version in [4, 7]. + pip install torchcodec Note that installation instructions may slightly change over time. The most up-to-date instructions should be available from the `README