Skip to content

Commit 0134e10

Browse files
committed
Fix bug in README and add information about multiprocessed dataloading
Signed-off-by: Towaki Takikawa <tovacinni@gmail.com>
1 parent ba51e3f commit 0134e10

File tree

1 file changed

+13
-12
lines changed

1 file changed

+13
-12
lines changed

README.md

Lines changed: 13 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -108,16 +108,6 @@ in the main wisp directory. You should now be able to run some examples!
108108

109109
## Training & Rendering with Wisp
110110

111-
### Using `wisp` in headless mode
112-
113-
To disable interactive mode, and run wisp without loading the graphics api, set the env variable:
114-
```
115-
WISP_HEADLESS=1
116-
```
117-
118-
Toggling this flag is useful for debugging on machines without a display.
119-
This is also needed if you opt to avoid installing the interactive renderer requirements.
120-
121111
### Training NGLOD-NeRF from multiview RGB-D data
122112

123113
You will first need to download some sample data to run NGLOD-NeRF.
@@ -126,11 +116,13 @@ to download a cool Lego V8 engine from the [RTMV dataset](http://www.cs.umd.edu/
126116

127117
Once you have downloaded and extracted the data somewhere, you can train a NeRF using [NGLOD](https://nv-tlabs.github.io/nglod/) with:
128118
```
129-
python3 app/main.py --config configs/nglod_nerf.yaml --dataset-path /path/to/V8
119+
python3 app/main.py --config configs/nglod_nerf.yaml --dataset-path /path/to/V8 --dataset-num-workers 4
130120
```
131121
This will generate logs inside `_results/logs/runs/test-nglod-nerf` in which you can find the trained
132122
checkpoint, and `EXR` images of validation outputs. We highly recommend that you install
133123
[tev](https://github.com/Tom94/tev) as the default application to open EXRs.
124+
Note that the `--dataset-num-workers` argument is used here to control the multiprocessing used to load
125+
ground truth images. To disable the multiprocessing, you can pass in `--dataset-num-workers -1`.
134126

135127
To view the logs with TensorBoard:
136128
```
@@ -149,14 +141,23 @@ for the options that are already passed in.
149141

150142
To run the training task interactively using the renderer engine, run:
151143
```
152-
WISP_HEADLESS=1 python3 app/main_interactive.py --config configs/nglod_nerf_interactive.yaml --dataset-path /path/to/V8
144+
WISP_HEADLESS=0 python3 app/main_interactive.py --config configs/nglod_nerf_interactive.yaml --dataset-path /path/to/V8 --dataset-num-workers 4
153145
```
154146

155147
Every config file that we ship has a `*_interactive.yaml` counterpart that can be used for better settings
156148
(in terms of user experience)
157149
for the interactive training app. The later examples we show can all be run interactively with
158150
`WISP_HEADLESS=1 python3 app/main_interactive.py` and the corresponding configs.
159151

152+
### Using `wisp` in headless mode
153+
154+
To disable interactive mode, and run wisp _without_ loading the graphics API, set the env variable:
155+
```
156+
WISP_HEADLESS=1
157+
```
158+
Toggling this flag is useful for debugging on machines without a display.
159+
This is also needed if you opt to avoid installing the interactive renderer requirements.
160+
160161
### Training NGLOD-SDF from meshes
161162

162163
We also support training neural SDFs from meshes.

0 commit comments

Comments
 (0)