Plugins

Method Registry

Module that keeps all registered plugins and allows for plugin discovery.

nerfstudio.plugins.registry.discover_methods() → Tuple[Dict[str, TrainerConfig], Dict[str, str]]

Discovers all methods registered using the nerfstudio.method_configs entrypoint. And also methods in the NERFSTUDIO_METHOD_CONFIGS environment variable.

DataParser Registry

Module that keeps all registered plugins and allows for plugin discovery.

class nerfstudio.plugins.registry_dataparser.DataParserSpecification(config: DataParserConfig, description: Optional[str] = None)

Bases: object

DataParser specification class used to register custom dataparsers with Nerfstudio. The registered dataparsers will be available in commands such as ns-train

config: DataParserConfig

Dataparser configuration

description: Optional[str] = None

Description of the dataparser

nerfstudio.plugins.registry_dataparser.discover_dataparsers() → Tuple[Dict[str, DataParserConfig], Dict[str, str]]

Discovers all dataparsers registered using the nerfstudio.dataparser_configs entrypoint. And also dataparsers in the NERFSTUDIO_DATAPARSER_CONFIGS environment variable.

Types

This package contains specifications used to register plugins.

class nerfstudio.plugins.types.MethodSpecification(config: TrainerConfig, description: str)

Bases: object

Method specification class used to register custom methods with Nerfstudio. The registered methods will be available in commands such as ns-train

config: TrainerConfig

Trainer configuration

description: str

Method description shown in ns-train help