torch==1.12 and requirements.txt update (#302)

* cleaning up requirements.txt and adding versions

* need to update github actions, docs, and make optional dependencies work

* updated documentation

* set directory

* new functorch version

* updated caching

* fixed hash

.github/workflows/core_code_checks.yml

@@ -22,10 +22,10 @@ jobs:
       - uses: actions/cache@v2
         with:
           path: ${{ env.pythonLocation }}
-          key: ${{ env.pythonLocation }}-${{ hashFiles('setup.py') }}-${{ hashFiles('dev-requirements.txt') }}
+          key: ${{ env.pythonLocation }}-${{ hashFiles('pyproject.toml') }}
       - name: Install dependencies
         run: |
-          pip install --upgrade --upgrade-strategy eager -r environment/requirements.txt -e .
+          pip install --upgrade --upgrade-strategy eager -e .
       - name: Run license checks
         run: |
           ./scripts/licensing/license_headers.sh --check

.readthedocs.yaml

@@ -9,7 +9,7 @@ version: 2
 build:
   os: ubuntu-20.04
   tools:
-    python: "3.9"
+    python: '3.9'
     # You can also specify other tool versions:
     # nodejs: "16"
     # rust: "1.55"
@@ -27,7 +27,11 @@ sphinx:
 # Optionally declare the Python requirements required to build your docs
 python:
   install:
-  - requirements: environment/requirements.txt
-  - requirements: docs/requirements.txt
-  - method: pip
-    path: .
+    # Equivalent to 'pip install .'
+    - method: pip
+      path: .
+    # Equivalent to 'pip install .[docs]'
+    - method: pip
+      path: .
+      extra_requirements:
+        - docs

README.md

@@ -71,11 +71,8 @@ conda activate nerfactory
 # Clone the repo
 git clone git@github.com:plenoptix/nerfactory.git
 
-# Install dependencies
+# Install dependencies and nerfactory as a library
 cd nerfactory
-pip install -r environment/requirements.txt
-
-# Install nerfactory as a library
 pip install -e .
 
 # Install tiny-cuda-nn (tcnn) and apex to use with the graph_instant_ngp.yaml config

docs/reference/contributing.md

@@ -40,7 +40,7 @@ In order to merge changes to the code base, all of these checks must be passing.
 To install the required packages:
 
 ```bash
-pip install -r docs/requirements.txt
+pip install -e .[docs]
 ```
 
 You may also need to install [pandoc](https://pandoc.org/). If you are using `conda` you can run the following:

docs/requirements.txt

@@ -1,8 +0,0 @@
-furo==2022.4.7
-readthedocs-sphinx-search==0.1.2
-myst-nb==0.16.0
-nbformat==5.4.0
-sphinx==4.5.0
-sphinxemoji==0.2.0
-sphinx-copybutton==0.5.0
-sphinx-design==0.2.0

docs/tutorials/quickstart.md

@@ -31,14 +31,7 @@ Clone the repo
 git clone git@github.com:plenoptix/nerfactory.git
 ```
 
-Install dependencies
-
-```bash
-cd nerfactory
-pip install -r environment/requirements.txt
-```
-
-Install nerfactory as a library
+Install dependencies and nerfactory as a library
 
 ```bash
 pip install -e .
@@ -106,13 +99,6 @@ Additionally, if you run everything with the default configuration, by default,
 tensorboard --logdir outputs
 ```
 
-Or the following:
-
-```bash
-export TENSORBOARD_PORT=<port>
-bash environment/run_tensorboard.sh
-```
-
 # Rendering a Trajectory
 
 To evaluate the trained NeRF, we provide an evaluation script that allows you to do benchmarking (see our [benchmarking workflow](../tooling/benchmarking.md)) or to render out the scene with a custom trajectory and save the output to a video.

environment/requirements.txt

@@ -1,33 +0,0 @@
-aiohttp
-aiortc
-av
-black[jupyter]==22.3.0
-dcargs>=0.2.6
-ninja
-functorch==0.1.1
-h5py>=2.9.0
-hydra-colorlog==1.2.0
-hydra-core==1.2.0
-imageio
-ipywidgets>=7.6
-jupyterlab==3.3.4
-kaleido
-matplotlib
-mediapy
-msgpack
-msgpack_numpy
-numpy-quaternion
-opencv-python
-plotly==5.7.0
-protobuf==3.20.0
-pylint==2.13.4
-pytest
-python-socketio
-tensorboard==2.9.0
-torch==1.11.0
-torchmetrics[image]==0.8.2
-torchtyping
-torchvision==0.12.0
-tqdm
-u-msgpack-python>=2.4.1
-wandb

environment/run_jupyter.sh

@@ -1 +0,0 @@
-python -m jupyter lab --ip 0.0.0.0 --port ${JUPYTER_PORT} --no-browser --config environments/jupyter.py

environment/run_tensorboard.sh

@@ -1 +0,0 @@
-tensorboard --samples_per_plugin scalars=100,images=10 --port ${TENSORBOARD_PORT} --logdir outputs

pyproject.toml

@@ -8,18 +8,74 @@ version = "0.0.0"
 description = "All-in-one repository for state-of-the-art NeRFs"
 readme = "README.md"
 license = { text="Apache 2.0"}
-requires-python = ">=3.7"
+requires-python = ">=3.8"
 classifiers = [
     "Development Status :: 3 - Alpha",
     "Programming Language :: Python",
 ]
+dependencies = [
+    "aiohttp==3.8.1",
+    "aiortc==1.3.2",
+    "av==9.2.0",
+    "black[jupyter]==22.3.0",
+    "dcargs>=0.2.6",
+    "ninja==1.10.2.3",
+    "functorch==0.2.1",
+    "h5py>=2.9.0",
+    "hydra-colorlog==1.2.0",
+    "hydra-core==1.2.0",
+    "imageio==2.21.1",
+    "ipywidgets>=7.6",
+    "jupyterlab==3.3.4",
+    "kaleido==0.2.1",
+    "matplotlib==3.5.3",
+    "mediapy==1.1.0",
+    "msgpack==1.0.4",
+    "msgpack_numpy==0.4.8",
+    "numpy-quaternion",
+    "opencv-python==4.6.0.66",
+    "plotly==5.7.0",
+    "protobuf==3.20.0",
+    "pylint==2.13.4",
+    "pytest==7.1.2",
+    "python-socketio==5.7.1",
+    "tensorboard==2.9.0",
+    "torch==1.12.1",
+    "torchmetrics[image]==0.8.2",
+    "torchtyping>=0.1.4",
+    "torchvision>=0.12.0",
+    "tqdm==4.64.0",
+    "u-msgpack-python>=2.4.1",
+    "wandb==0.13.2"
+]
 
 [project.urls]
 "Documentation" = "https://plenoptix-nerfactory.readthedocs-hosted.com/en/latest/?badge=latest"
 
+[project.optional-dependencies]
+docs = [
+    "furo==2022.4.7",
+    "readthedocs-sphinx-search==0.1.2",
+    "myst-nb==0.16.0",
+    "nbformat==5.4.0",
+    "sphinx==4.5.0",
+    "sphinxemoji==0.2.0",
+    "sphinx-copybutton==0.5.0",
+    "sphinx-design==0.2.0"
+]
+
 [project.scripts]
 viewer-bridge-server = "nerfactory.viewer.server.server:run_viewer_bridge_server"
 
+[options]
+# equivalent to using --extra-index-url with pip, which is needed for specifying the CUDA version torch and torchvision
+dependency_links = [
+    "https://download.pytorch.org/whl/cu113"
+]
+
+[tool.setuptools.packages.find]
+include = ["nerfactory"]
+
 # black
 [tool.black]
 line-length = 120

setup.cfg

@@ -1,3 +0,0 @@
-[options]
-packages = find:
-python_requires = >=3.8,