Rename to nerfstudio (#589)

This commit is contained in:
Matthew Tancik authored and GitHub committed 2022-09-29 23:42:15 -07:00
1 parent fae01d3ca6
commit 1f83ad03db
210 files changed
+3400 -3413

No files matched your search

+6 -6
View File
@@ -1,12 +1,12 @@
# Custom dataset formats
We've implemented many common datasets inside the `nerfactory/format/<dataset_format>.py` files. If you have a posed image dataset that does not match these existing formats can create a custom dataset format.
We've implemented many common datasets inside the `nerfstudio/format/<dataset_format>.py` files. If you have a posed image dataset that does not match these existing formats can create a custom dataset format.
1. Create a function `nerfactory/format/<dataset_format>.py` and implements a function called `load_<dataset_format>_data` returns a `DatasetInputs` object.
1. Create a function `nerfstudio/format/<dataset_format>.py` and implements a function called `load_<dataset_format>_data` returns a `DatasetInputs` object.
```python
# The DatasetInputs dataclass that is passed around to create datasets and initialize the graphs.
# See `nerfactory/data/structs.py` for the code.
# See `nerfstudio/data/structs.py` for the code.
@dataclass
class DatasetInputs:
"""Dataset inputs are used to initialize datasets and the NeRF graph."""
@@ -22,7 +22,7 @@ class DatasetInputs:
alpha_color: Optional[TensorType[3]] = None
# The method signature for the `instant_ngp` dataset format.
# See `nerfactory/data/format/instant_ngp.py` for the code.
# See `nerfstudio/data/format/instant_ngp.py` for the code.
def load_instant_ngp_data(
basedir: str,
split: str = "train", camera_translation_scalar=0.33
@@ -30,12 +30,12 @@ def load_instant_ngp_data(
"""Returns a DatasetInputs struct."""
```
2. Add a new case to `get_dataset_inputs()` in `nerfactory/data/utils.py` for the new dataset.
2. Add a new case to `get_dataset_inputs()` in `nerfstudio/data/utils.py` for the new dataset.
```python
# The method signature for get_dataset_inputs.
# Notice that the parameters match the yaml config parameters above.
# See `nerfactory/data/utils.py` for the code.
# See `nerfstudio/data/utils.py` for the code.
def get_dataset_inputs(
data_directory: str,
dataset_format: str,