Skip to content

Commit 7414904

Browse files
bottlerfacebook-github-bot
authored andcommitted
Installation updates for next release.
Summary: We've made some build updates. Reviewed By: jcjohnson Differential Revision: D23244111 fbshipit-source-id: dba6e5dc3a9d7dcb2b62094f7f7b8b5abca190d9
1 parent 46c0e83 commit 7414904

File tree

1 file changed

+14
-7
lines changed

1 file changed

+14
-7
lines changed

INSTALL.md

+14-7
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,9 @@
88
The core library is written in PyTorch. Several components have underlying implementation in CUDA for improved performance. A subset of these components have CPU implementations in C++/Pytorch. It is advised to use PyTorch3D with GPU support in order to use all the features.
99

1010
- Linux or macOS or Windows
11-
- Python 3.6
12-
- PyTorch 1.4 or 1.5
13-
- torchvision that matches the PyTorch installation. You can install them together at pytorch.org to make sure of this.
11+
- Python 3.6, 3.7 or 3.8
12+
- PyTorch 1.4, 1.5.0, 1.5.1 or 1.6.0
13+
- torchvision that matches the PyTorch installation. You can install them together as explained at pytorch.org to make sure of this.
1414
- gcc & g++ ≥ 4.9
1515
- [fvcore](https://github.com/facebookresearch/fvcore)
1616
- If CUDA is to be used, use at least version 9.2.
@@ -19,7 +19,7 @@ These can be installed by running:
1919
```
2020
conda create -n pytorch3d python=3.8
2121
conda activate pytorch3d
22-
conda install -c pytorch pytorch torchvision cudatoolkit=10.2
22+
conda install -c pytorch pytorch=1.6.0 torchvision cudatoolkit=10.2
2323
conda install -c conda-forge -c fvcore fvcore
2424
```
2525

@@ -42,7 +42,7 @@ conda install jupyter
4242
pip install scikit-image matplotlib imageio
4343
4444
# Tests/Linting
45-
pip install black isort flake8 flake8-bugbear flake8-comprehensions
45+
pip install black 'isort<5' flake8 flake8-bugbear flake8-comprehensions
4646
```
4747

4848
## Installing prebuilt binaries for PyTorch3D
@@ -60,21 +60,28 @@ Or, to install a nightly (non-official, alpha) build:
6060
# Anaconda Cloud
6161
conda install pytorch3d -c pytorch3d-nightly
6262
```
63-
### 2. Install without CUDA support from PyPI, on Linux and Mac
63+
### 2. Install from PyPI, on Linux and Mac
64+
This works with pytorch 1.6.0 only.
6465
```
6566
pip install pytorch3d
6667
```
68+
On Linux this has support for CUDA 10.1. On Mac this is CPU-only.
6769

6870
## Building / installing from source.
69-
CUDA support will be included if CUDA is enabled or if the environment variable
71+
CUDA support will be included if CUDA is available in pytorch or if the environment variable
7072
`FORCE_CUDA` is set to `1`.
7173

7274
### 1. Install from GitHub
7375
```
7476
pip install 'git+https://github.com/facebookresearch/pytorch3d.git'
7577
```
78+
To install using the code of the released version instead of from the main branch, use the following instead.
79+
```
80+
pip install 'git+https://github.com/facebookresearch/pytorch3d.git@stable'
81+
```
7682

7783
**Install from Github on macOS:**
84+
Some environment variables should be provided, like this.
7885
```
7986
MACOSX_DEPLOYMENT_TARGET=10.14 CC=clang CXX=clang++ pip install 'git+https://github.com/facebookresearch/pytorch3d.git'
8087
```

0 commit comments

Comments
 (0)