Reformatting and Update Tests (#46)

* more organized version

* add copyrights

* proper versioning

* proper versioning

* cleanup project; read version from pyproject

* read version from pyproject

* update weblink

* cleanup nerfacc file structure

* propoer test contraction

* proper test for intersection

* proper tests for pack, grid, and intersection

* proper testing for rendering

* bug fix

* proper testing for marching

* run check reformat

* add hints on nvcc not found

* add doc to readme

* resume github check

* update readthedocs env

* rm tool.setuptools.packages.find

.readthedocs.yaml

@@ -14,5 +14,8 @@ python:
     # Equivalent to 'pip install .'
     - method: pip
       path: .
-    # Equivalent to 'pip install -r docs/requirements.txt'
-    - requirements: docs/requirements.txt
+    # Equivalent to 'pip install .[docs]'
+    - method: pip
+      path: .
+      extra_requirements:
+        - docs
\ No newline at end of file

README.md

-# nerfacc
+# NerfAcc
 [![Core Tests.](https://github.com/KAIR-BAIR/nerfacc/actions/workflows/code_checks.yml/badge.svg)](https://github.com/KAIR-BAIR/nerfacc/actions/workflows/code_checks.yml)
 [![Documentation Status](https://readthedocs.com/projects/plenoptix-nerfacc/badge/?version=latest)](https://plenoptix-nerfacc.readthedocs-hosted.com/en/latest/?badge=latest)
 
+https://www.nerfacc.com/
 
 This is a **tiny** toolbox  for **accelerating** NeRF training & rendering using PyTorch CUDA extensions. Plug-and-play for most of the NeRFs!
 
+## Installation
+
+```
+pip install nerfacc
+```
+
 ## Examples: 
 
 ``` bash
-# Instant-NGP Nerf
+# Instant-NGP NeRF in 4.5 minutes.
+# See results at here: https://www.nerfacc.com/en/latest/examples/ngp.html
 python examples/train_ngp_nerf.py --train_split trainval --scene lego
 ```
 
 ``` bash
-# Vanilla MLP Nerf
+# Vanilla MLP NeRF in 1 hour.
+# See results at here: https://www.nerfacc.com/en/latest/examples/vanilla.html
 python examples/train_mlp_nerf.py --train_split train --scene lego
 ```
 
 ```bash
-# MLP Nerf on Dynamic objects (D-Nerf)
+# T-NeRF for Dynamic objects in 1 hour.
+# See results at here: https://www.nerfacc.com/en/latest/examples/dnerf.html
 python examples/train_mlp_dnerf.py --train_split train --scene lego
 ```
 
 ```bash
-# NGP on MipNeRF360 unbounded scene
+# Unbounded scene in 1 hour.
+# See results at here: https://www.nerfacc.com/en/latest/examples/unbounded.html
 python examples/train_ngp_nerf.py --train_split train --scene garden --auto_aabb --unbounded --cone_angle=0.004
 ```

docs/requirements.txt

-sphinx==4.5.0
-sphinx-copybutton==0.5.0
-sphinx-design==0.2.0
-pytorch_sphinx_theme @ git+https://github.com/liruilong940607/pytorch_sphinx_theme.git#egg=pytorch_sphinx_theme
-sphinx_copybutton
\ No newline at end of file

docs/source/conf.py

-# Configuration file for the Sphinx documentation builder.
-
 import pytorch_sphinx_theme
 
+from nerfacc import __version__
+
 # -- Project information
 
 project = "nerfacc"
 copyright = "2022, Ruilong"
 author = "Ruilong"
 
-release = "0.1.4"
-version = "0.1.4"
+release = __version__
 
 # -- General configuration
 

examples/datasets/dnerf_synthetic.py

+"""
+Copyright (c) 2022 Ruilong Li, UC Berkeley.
+"""
+
 import json
 import os
 

examples/datasets/nerf_360_v2.py

+"""
+Copyright (c) 2022 Ruilong Li, UC Berkeley.
+"""
+
 import collections
 import os
 import sys

examples/datasets/nerf_synthetic.py

+"""
+Copyright (c) 2022 Ruilong Li, UC Berkeley.
+"""
+
 import collections
 import json
 import os

examples/datasets/utils.py

+"""
+Copyright (c) 2022 Ruilong Li, UC Berkeley.
+"""
+
 import collections
 
 Rays = collections.namedtuple("Rays", ("origins", "viewdirs"))

examples/radiance_fields/mlp.py

-""" The MLPs and Voxels. """
+"""
+Copyright (c) 2022 Ruilong Li, UC Berkeley.
+"""
+
 import functools
 import math
 from typing import Callable, Optional

examples/radiance_fields/ngp.py

+"""
+Copyright (c) 2022 Ruilong Li, UC Berkeley.
+"""
+
 from typing import Callable, List, Union
 
 import torch

examples/train_mlp_dnerf.py

+"""
+Copyright (c) 2022 Ruilong Li, UC Berkeley.
+"""
+
 import argparse
 import math
 import os

examples/train_mlp_nerf.py

+"""
+Copyright (c) 2022 Ruilong Li, UC Berkeley.
+"""
+
 import argparse
 import math
 import os

examples/train_ngp_nerf.py

+"""
+Copyright (c) 2022 Ruilong Li, UC Berkeley.
+"""
+
 import argparse
 import math
 import os

examples/utils.py

+"""
+Copyright (c) 2022 Ruilong Li, UC Berkeley.
+"""
+
 import random
 from typing import Optional
 

nerfacc/__init__.py

+"""
+Copyright (c) 2022 Ruilong Li, UC Berkeley.
+"""
+
 from .contraction import ContractionType, contract, contract_inv
 from .grid import Grid, OccupancyGrid
-from .pipeline import rendering
-from .ray_marching import (
-    ray_aabb_intersect,
-    ray_marching,
-    unpack_to_ray_indices,
-)
+from .intersection import ray_aabb_intersect
+from .pack import unpack_to_ray_indices
+from .ray_marching import ray_marching
+from .version import __version__
 from .vol_rendering import (
     accumulate_along_rays,
     render_visibility,
     render_weight_from_alpha,
     render_weight_from_density,
+    rendering,
 )
 
 __all__ = [
@@ -27,4 +30,5 @@ __all__ = [
     "render_weight_from_alpha",
     "render_weight_from_density",
     "rendering",
+    "__version__",
 ]

nerfacc/contraction.py

+"""
+Copyright (c) 2022 Ruilong Li, UC Berkeley.
+"""
+
 from enum import Enum
 
 import torch

nerfacc/cuda/__init__.py

+"""
+Copyright (c) 2022 Ruilong Li, UC Berkeley.
+"""
+
 from typing import Any, Callable
 
 

nerfacc/cuda/_backend.py

-"""Setup cuda backend."""
+"""
+Copyright (c) 2022 Ruilong Li, UC Berkeley.
+"""
+
 import glob
 import os
 from subprocess import DEVNULL, call
@@ -31,5 +34,8 @@ if cuda_toolkit_available():
             extra_cflags=["-O3"],
             extra_cuda_cflags=["-O3"],
         )
+else:
+    console = Console()
+    console.print("[bold red]No CUDA toolkit found. NerfAcc will be disabled.")
 
 __all__ = ["_C"]

nerfacc/cuda/csrc/contraction.cu

+/*
+ * Copyright (c) 2022 Ruilong Li, UC Berkeley.
+ */
+
 #include "include/helpers_cuda.h"
 #include "include/helpers_math.h"
 #include "include/helpers_contraction.h"

nerfacc/cuda/csrc/include/helpers_contraction.h

+/*
+ * Copyright (c) 2022 Ruilong Li, UC Berkeley.
+ */
+
 #pragma once
 
 #include "helpers_math.h"