Skip to content

Commit a32e4ce

Browse files
NicolasHugfacebook-github-bot
authored andcommitted
Revert "DOC: build from source for now (#133)" (#139)
Summary: This reverts commit 361968f. Pull Request resolved: #139 Reviewed By: scotts Differential Revision: D60587822 Pulled By: NicolasHug fbshipit-source-id: 8aacd8b8a6e1880dae06c55c659663586e7612ef
1 parent 361968f commit a32e4ce

File tree

2 files changed

+36
-41
lines changed

2 files changed

+36
-41
lines changed

README.md

+16-23
Original file line numberDiff line numberDiff line change
@@ -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
9688
instructions](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 [email protected]: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.
114106
TorchCodec supports all major FFmpeg version in [4, 7].
115107

108+
116109
## Planned future work
117110

118111
We 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

docs/source/install_instructions.rst

+20-18
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,32 @@
11
Installation Instructions
22
=========================
33

4-
We'll be providing wheels in the coming days so that you can just install
5-
torchcodec using ``pip``. For now, you can just build from source. You will need
6-
the following dependencies:
4+
.. note::
5+
TorchCodec is only available on Linux for now. We plan to support other
6+
platforms in the future.
77

8-
- A C++ compiler+linker. This is typically available on a baseline Linux
9-
installation already.
10-
- cmake
11-
- pkg-config
12-
- FFmpeg
13-
- PyTorch nightly
8+
Installing torchcodec should be as simple as:
149

15-
Start by installing PyTorch following the `official instructions
16-
<https://pytorch.org/get-started/locally/>`_.
10+
.. code:: bash
1711
18-
Then, the easiest way to install the rest of the dependencies is to run:
12+
pip install torchcodec
1913
20-
conda install cmake pkg-config ffmpeg -c conda-forge
14+
You will need a working PyTorch installation, which you can install following
15+
the `official instructions <https://pytorch.org/get-started/locally/>`_.
2116

22-
To clone and install the repo, run:
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.:
2320

24-
git clone [email protected]:pytorch/torchcodec.git
25-
# Or, using https instead of ssh: git clone https://github.com/pytorch/torchcodec.git
26-
cd torchcodec
21+
.. code:: bash
2722
28-
pip install -e ".[dev]" --no-build-isolation -vv
23+
conda install ffmpeg
24+
# or
25+
conda install ffmpeg -c conda-forge
2926
27+
Your Linux distribution probably comes with FFmpeg pre-installed as well.
3028
TorchCodec supports all major FFmpeg version in [4, 7].
29+
30+
Note that installation instructions may slightly change over time. The most
31+
up-to-date instructions should be available from the `README
32+
<https://github.com/pytorch/torchcodec?tab=readme-ov-file#installing-torchcodec>`_.

0 commit comments

Comments
 (0)