diff --git a/README.md b/README.md index 761ddd1d1..7a478a84f 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# Radiance +# Radiance :bulb: # Quickstart @@ -60,15 +60,15 @@ The NeRF graph definitions can be found in `nerf/graph/`. Each implementation of * Fields (`nerf/fields/`): composed of field modules (`nerf/field_modules/`) and represents the radiance field of the NeRF. * Misc. Modules (`nerf/misc_modules`- TODO(maybe move to misc_modules? better organization)): any remaining module in the NeRF (e.g. renderers, samplers, losses, and metrics). -To implement any pre-existing NeRF that we have not yet implemented under `nerf/graph/`, create a new graph structure by using provided modules or any new module you define. Then create an associated config with the appropriate parameters defined, with `__target__` pointing to your NeRF class. Then run training as described above. +To implement any pre-existing NeRF that we have not yet implemented under `nerf/graph/`, create a new graph structure by using provided modules or any new module you define. Then create an associated config making sure `__target__` points to your NeRF class (see [here](./configs/README.md) for more info on how to create the config). Then run training as described above. # Feature Documentation -## 1. [Hydra config structure](./configs/README.md) -## 2. [Logging, debugging utilities](./radiance/utils/README.md) -## 3. [Benchmarking, other tooling](./scripts/README.md) +### 1. [Hydra config structure](./configs/README.md) +### 2. [Logging, debugging utilities](./radiance/utils/README.md) +### 3. [Benchmarking, other tooling](./scripts/README.md) -## 4. Running other repos with our data +### 4. Running other repos with our data ``` # nerf-pytorch @@ -81,21 +81,21 @@ conda activate jaxnerf python -m jaxnerf.train --data_dir=/path/to/radiance/data/blender/chair --train_dir=/path/to/radiance/outputs/blender_chair_jaxnerf --config=/path/to/radiance/external/jaxnerf/configs/demo --render_every 100 ``` -## 5. Speeding up the code - +### 5. Speeding up the code Documentation for running the code with CUDA. +Please see https://github.com/NVlabs/tiny-cuda-nn for how to install tiny-cuda-nn. ``` -This is how to install tiny-cuda-nn. -# https://github.com/NVlabs/tiny-cuda-nn pip install git+https://github.com/NVlabs/tiny-cuda-nn/#subdirectory=bindings/torch +``` To run instant-ngp with tcnn, you can do the following. This is with the fox dataset. +``` python scripts/run_train.py --config-name=instant_ngp_tcnn.yaml data/dataset=instant_ngp_fox ``` -## 6. Setting up Jupyter +### 6. Setting up Jupyter ``` python -m jupyter lab build