https://github.com/nerfstudio-project/nerfstudio-method-template
Template repository for creating and registering new methods in NerfStudio.
https://github.com/nerfstudio-project/nerfstudio-method-template
Last synced: about 1 year ago
JSON representation
Template repository for creating and registering new methods in NerfStudio.
- Host: GitHub
- URL: https://github.com/nerfstudio-project/nerfstudio-method-template
- Owner: nerfstudio-project
- License: apache-2.0
- Created: 2023-08-09T15:11:26.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2024-06-19T16:16:36.000Z (about 2 years ago)
- Last Synced: 2025-04-01T11:50:32.829Z (over 1 year ago)
- Language: Python
- Size: 6.84 KB
- Stars: 51
- Watchers: 4
- Forks: 11
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 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](https://docs.nerf.studio/en/latest/quickstart/installation.html). 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]
```