From ff4f1bb4218aeaec45a0546521df8d18b8f94191 Mon Sep 17 00:00:00 2001 From: Matt Tancik Date: Wed, 13 Jul 2022 11:11:15 -0700 Subject: [PATCH] Update documentation --- docs/index.rst | 15 +++------------ docs/models/index.rst | 13 +++++++++++++ docs/models/nerf.md | 25 +++++++++++++++++++++++-- docs/notebooks/index.rst | 2 ++ docs/tutorials/quickstart.md | 8 +------- 5 files changed, 42 insertions(+), 21 deletions(-) create mode 100644 docs/models/index.rst diff --git a/docs/index.rst b/docs/index.rst index 83ac11da5..d6661250d 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -31,19 +31,10 @@ Contents .. toctree:: :hidden: - :caption: Models - - NeRF - Mip-NeRF - Mip-NeRF 360 - Instan-NGP - NeRF-W - Semantic NeRF - -.. toctree:: - :hidden: - :caption: Component Guides + :caption: Guides + + models/index.rst notebooks/index .. toctree:: diff --git a/docs/models/index.rst b/docs/models/index.rst new file mode 100644 index 000000000..52c4a608e --- /dev/null +++ b/docs/models/index.rst @@ -0,0 +1,13 @@ +.. _models: + +Models +======== + +.. toctree:: + + NeRF + Mip-NeRF + Mip-NeRF 360 + Instan-NGP + NeRF-W + Semantic NeRF diff --git a/docs/models/nerf.md b/docs/models/nerf.md index 1176225c9..3b927c133 100644 --- a/docs/models/nerf.md +++ b/docs/models/nerf.md @@ -7,8 +7,29 @@ Paper Website ``` -### Running Model +### Running the Model ```bash python scripts/run_train.py --config-name=graph_vanilla_nerf.yaml -``` \ No newline at end of file +``` + +## Method + +### Overview + +### Field Representation + +#### Positional Encoding + +### Rendering + +#### Hierarchical Sampling + +## Benchmarks + +##### Blender Synthetic +| Implementation | Mic | Ficus | Chair | Hotdog | Materials | Drums | Ship | Lego | Average | +|-----------------------------------------------------------------------------------|:---------:|-----------|:---------:|-----------|-----------|-----------|-----------|-----------|-----------| +| pyRad | 34.28 | **30.63** | **36.16** | 36.49 | 28.36 | **25.44** | 28.69 | **33.67** | **31.71** | +| [TF NeRF](https://github.com/bmild/nerf) | 32.91 | 30.13 | 33.00 | 36.18 | 29.62 | 25.01 | 28.65 | 32.54 | 31.04 | +| [JaxNeRF](https://github.com/google-research/google-research/tree/master/jaxnerf) | **34.53** | 30.43 | 34.08 | **36.92** | **29.91** | 25.03 | **29.36** | 33.28 | 31.69 | \ No newline at end of file diff --git a/docs/notebooks/index.rst b/docs/notebooks/index.rst index 79341f3e4..9a00ca98b 100644 --- a/docs/notebooks/index.rst +++ b/docs/notebooks/index.rst @@ -1,5 +1,7 @@ .. _notebooks: +Components +========== .. toctree:: :maxdepth: 0 diff --git a/docs/tutorials/quickstart.md b/docs/tutorials/quickstart.md index 18cfaa9cc..5904d5482 100644 --- a/docs/tutorials/quickstart.md +++ b/docs/tutorials/quickstart.md @@ -1,4 +1,4 @@ -# Quickstart guide +# Quickstart ```{include} ../../README.md :relative-docs: docs/ @@ -7,10 +7,4 @@ :end-before: 6. In-depth ``` -These quickstart steps will help you get started with training and testing the default vanilla nerf on the classic blender lego scene. - - -Please follow instructions 1-5 in our [Github Quickstart](https://github.com/plenoptix/pyrad#quickstart) for info on how to install, setup training, and visualize inference all with pyRad. - - For more complex changes (e.g. running with your own data/ setting up a new NeRF graph, please continue to the next page. \ No newline at end of file