-
Notifications
You must be signed in to change notification settings - Fork 20
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
14399d6
commit 2641ddf
Showing
1 changed file
with
54 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,54 @@ | ||
TorchCodec | ||
========== | ||
|
||
Welcome to TorchCodec! | ||
|
||
TODO: Write a decent readme. For now I'm just writing basic info for OSS | ||
development. | ||
|
||
|
||
Installing from source | ||
---------------------- | ||
|
||
Use a conda or virtual environment. | ||
|
||
Install torch nightly, e.g.: | ||
|
||
```bash | ||
pip install --pre torch --index-url https://download.pytorch.org/whl/nightly/cpu | ||
``` | ||
|
||
For more options, e.g. if you need CUDA or prefer using `conda`, refer to the | ||
[official page](https://pytorch.org/get-started/locally/). | ||
|
||
```bash | ||
BUILD_AGAINST_ALL_FFMPEG_FROM_S3=1 pip install -e ".[dev]" --no-build-isolation -vvv | ||
``` | ||
|
||
If you prefer building against an installed version of FFmpeg you can ommit the | ||
`BUILD_AGAINST_ALL_FFMPEG_FROM_S3=1` part. Make sure `pkg-config` is installed | ||
and able to find your FFmpeg installation. The easiest way to do this is to | ||
install both from conda: | ||
|
||
```bash | ||
conda install ffmpeg pkg-config -c conda-forge | ||
BUILD_AGAINST_ALL_FFMPEG_FROM_S3=1 | ||
``` | ||
|
||
Building the docs | ||
----------------- | ||
|
||
First install from source, then install the doc dependencies: | ||
|
||
```bash | ||
cd docs | ||
pip install -r requirements.txt | ||
``` | ||
|
||
Then, still from within the `docs` directory: | ||
|
||
```bash | ||
make html | ||
``` | ||
|
||
Run `make clean` from time to time if you encounter issues. |