Skip to content

Template repository for creating and registering new methods in NerfStudio.

License

Notifications You must be signed in to change notification settings

nerfstudio-project/nerfstudio-method-template

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

4 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

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]

About

Template repository for creating and registering new methods in NerfStudio.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages