@@ -81,45 +81,38 @@ ffmpeg -f lavfi -i \
8181
8282## Installing TorchCodec
8383
84- We'll be providing wheels in the coming days so that you can just install
85- torchcodec using ` pip ` . For now, you can just build from source. You will need
86- the following dependencies:
87-
88- - A C++ compiler+linker. This is typically available on a baseline Linux
89- installation already.
90- - cmake
91- - pkg-config
92- - FFmpeg
93- - PyTorch nightly
94-
95- Start by installing PyTorch following the [ official
84+ Note: if you're on MacOS, you'll need to [ build from source] ( ./CONTRIBUTING.md ) .
85+ Instructions below assume you're on Linux.
86+
87+ First install the latest stable version of PyTorch following the [ official
9688instructions] ( https://pytorch.org/get-started/locally/ ) .
9789
98- Then, the easiest way to install the rest of the dependencies is to run :
90+ Then:
9991
10092``` bash
101- conda install cmake pkg-config ffmpeg -c conda-forge
93+ pip install torchcodec
10294```
103-
104- To clone and install the repo, run:
95+ You will also need FFmpeg installed on your system, and TorchCodec decoding
96+ capabilities are determined by your underlying FFmpeg installation. There are
97+ different options to install FFmpeg e.g.:
10598
10699``` bash
107- git clone git@github.com:pytorch/torchcodec.git
108- # Or, using https instead of ssh: git clone https://github.com/pytorch/torchcodec.git
109- cd torchcodec
110-
111- pip install -e " .[dev]" --no-build-isolation -vv
100+ conda install ffmpeg
101+ # or
102+ conda install ffmpeg -c conda-forge
112103```
113104
105+ Your Linux distribution probably comes with FFmpeg pre-installed as well.
114106TorchCodec supports all major FFmpeg version in [ 4, 7] .
115107
108+
116109## Planned future work
117110
118111We are actively working on the following features:
119112
120- - Ship wheels for Linux, so that Linux users can ` pip install torchcodec ` .
121113- [ Ship wheels for MacOS] ( https://github.com/pytorch/torchcodec/issues/111 ) , so
122- that MacOS users can ` pip install torchcodec ` .
114+ that MacOS users can ` pip install torchcodec ` . For now this is only supported
115+ on Linux, but MacOS users can [ build from source] ( ./CONTRIBUTING.md ) .
123116- [ GPU decoding] ( https://github.com/pytorch/torchcodec/pull/58 )
124117- [ Audio decoding] ( https://github.com/pytorch/torchcodec/issues/85 )
125118
0 commit comments