Skip to content

Commit 1aeaf3c

Browse files
committed
docs(env): update cuda install inside yaml file.
1 parent d7186ba commit 1aeaf3c

File tree

3 files changed

+11
-20
lines changed

3 files changed

+11
-20
lines changed

README.md

Lines changed: 7 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -62,6 +62,8 @@ There are two ways to install the codebase: directly on your [local machine](#en
6262

6363
### Environment Setup
6464

65+
We use conda to manage the environment, you can install it follow [here](assets/README.md#system). Then create the base environment with the following command [5~15 minutes]:
66+
6567
```bash
6668
git clone --recursive https://github.com/KTH-RPL/OpenSceneFlow.git
6769
cd OpenSceneFlow && mamba env create -f environment.yaml
@@ -70,14 +72,6 @@ cd OpenSceneFlow && mamba env create -f environment.yaml
7072
# export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:/home/kin/mambaforge/lib
7173
```
7274

73-
CUDA package (we already install nvcc compiler inside conda env), the compile time is around 1-5 minutes:
74-
```bash
75-
mamba activate opensf
76-
# CUDA already install in python environment. I also tested others version like 11.3, 11.4, 11.7, 11.8 all works
77-
cd assets/cuda/mmcv && python ./setup.py install && cd ../../..
78-
cd assets/cuda/chamfer3D && python ./setup.py install && cd ../../..
79-
```
80-
8175
### Docker (Recommended for Isolation)
8276

8377
You always can choose [Docker](https://en.wikipedia.org/wiki/Docker_(software)) which isolated environment and free yourself from installation. Pull the pre-built Docker image or build manually.
@@ -115,8 +109,11 @@ Once extracted, you can directly use this dataset to run the [training script](#
115109

116110
## 2. Quick Start
117111

118-
Don't forget to active Python environment before running the code.
119-
If you want to use [wandb](wandb.ai), replace all `entity="kth-rpl",` to your own entity otherwise tensorboard will be used locally.
112+
Some tips before running the code:
113+
* Don't forget to active Python environment before running the code.
114+
* If you want to use [wandb](wandb.ai), replace all `entity="kth-rpl",` to your own entity otherwise tensorboard will be used locally.
115+
* Set correct data path by passing the config, e.g. `train_data=/home/kin/data/av2/h5py/demo/train val_data=/home/kin/data/av2/h5py/demo/val`.
116+
120117
And free yourself from trainning, you can download the pretrained weight from [HuggingFace](https://huggingface.co/kin-zhang/OpenSceneFlow) and we provided the detail `wget` command in each model section.
121118

122119
```bash

assets/README.md

Lines changed: 1 addition & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -65,22 +65,14 @@ bash Miniforge3-$(uname)-$(uname -m).sh
6565

6666
### Environment
6767

68-
Create base env: [~5 mins]
68+
Create base env: [5~15 minutes based on your network speed and cpu]
6969

7070
```bash
7171
git clone https://github.com/KTH-RPL/OpenSceneFlow.git
7272
cd OpenSceneFlow
7373
mamba env create -f assets/environment.yml
7474
```
7575

76-
CUDA package (nvcc compiler already installed through conda), the compile time is around 1-5 minutes:
77-
```bash
78-
mamba activate opensf
79-
cd assets/cuda/mmcv && python ./setup.py install && cd ../../..
80-
cd assets/cuda/chamfer3D && python ./setup.py install && cd ../../..
81-
```
82-
83-
8476
Checking important packages in our environment now:
8577
```bash
8678
mamba activate opensf

environment.yaml

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,8 @@ dependencies:
3030
- pathtools
3131
- rerun-sdk
3232
- pip:
33+
- assets/cuda/chamfer3D
34+
- assets/cuda/mmcv
3335
- open3d==0.18.0
3436
- dztimer
3537
- av2==0.2.1
@@ -46,4 +48,4 @@ dependencies:
4648
# open3d==0.18.0: because 0.17.0 have bug on set the view json file
4749
# dufomap==1.0.0: in case later updating may not compatible with the code.
4850
# spconv-cu117==2.3.6: avoid error: KeyError: ((16, 8, 8), float, float)
49-
# torch-scatter==2.1.2: in case later updating may not compatible with the code.
51+
# torch-scatter==2.1.2: in case later updating may not compatible with the code.

0 commit comments

Comments
 (0)