README.md

nerfstudio-method-template

Template repository for creating and registering methods in Nerfstudio.

File Structure

We recommend the following file structure:

├── my_method
│   ├── __init__.py
│   ├── my_config.py
│   ├── custom_pipeline.py [optional]
│   ├── custom_model.py [optional]
│   ├── custom_field.py [optional]
│   ├── custom_datamanger.py [optional]
│   ├── custom_dataparser.py [optional]
│   ├── ...
├── pyproject.toml

Registering with Nerfstudio

Ensure that nerfstudio has been installed according to the instructions. Clone or fork this repository and run the commands:

conda activate nerfstudio
cd nerfstudio-method-template/
pip install -e .
ns-install-cli

Running the new method

This repository creates a new Nerfstudio method named "method-template". To train with it, run the command:

ns-train method-template --data [PATH]