# Copyright 2022 The Plenoptix Team. All rights reserved. # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. # You may obtain a copy of the License at # # http://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing, software # distributed under the License is distributed on an "AS IS" BASIS, # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # See the License for the specific language governing permissions and # limitations under the License. """ Put all the method implementations in one location. """ from __future__ import annotations import copy from typing import Dict, Type import dcargs from typeguard import typeguard_ignore from nerfactory.configs.base import ( AdamOptimizerConfig, Config, LoggingConfig, RAdamOptimizerConfig, SchedulerConfig, TrainerConfig, ViewerConfig, ) from nerfactory.datamanagers.base import VanillaDataManagerConfig from nerfactory.datamanagers.dataparsers.blender_parser import BlenderDataParserConfig from nerfactory.datamanagers.dataparsers.friends_parser import FriendsDataParserConfig from nerfactory.datamanagers.dataparsers.mipnerf_parser import ( MipNerf360DataParserConfig, ) from nerfactory.models.base import VanillaModelConfig from nerfactory.models.compound import CompoundModelConfig from nerfactory.models.instant_ngp import InstantNGPModelConfig from nerfactory.models.mipnerf import MipNerfModel from nerfactory.models.mipnerf_360 import MipNerf360Model from nerfactory.models.nerfw import NerfWModelConfig from nerfactory.models.proposal import ProposalModelConfig from nerfactory.models.semantic_nerf import SemanticNerfModel from nerfactory.models.tensorf import TensoRFModelConfig from nerfactory.models.vanilla_nerf import NeRFModel from nerfactory.pipelines.base import VanillaPipelineConfig from nerfactory.pipelines.dynamic_batch import DynamicBatchPipelineConfig base_configs: Dict[str, Config] = {} base_configs["compound"] = Config( method_name="compound", trainer=TrainerConfig(mixed_precision=True), pipeline=DynamicBatchPipelineConfig( datamanager=VanillaDataManagerConfig(dataparser=BlenderDataParserConfig(), train_num_rays_per_batch=8192), model=CompoundModelConfig(eval_num_rays_per_chunk=8192), ), optimizers={ "fields": { "optimizer": AdamOptimizerConfig(lr=1e-2, eps=1e-15), "scheduler": None, } }, viewer=ViewerConfig(enable=True), logging=LoggingConfig(event_writer="none"), ) base_configs["instant-ngp"] = Config( method_name="instant-ngp", trainer=TrainerConfig(steps_per_eval_batch=500, steps_per_save=2000, mixed_precision=True), pipeline=DynamicBatchPipelineConfig( datamanager=VanillaDataManagerConfig(dataparser=BlenderDataParserConfig(), train_num_rays_per_batch=8192), model=InstantNGPModelConfig(eval_num_rays_per_chunk=8192), ), optimizers={ "fields": { "optimizer": AdamOptimizerConfig(lr=1e-2, eps=1e-15), "scheduler": None, } }, viewer=ViewerConfig(enable=True), logging=LoggingConfig(event_writer="none"), ) base_configs["proposal"] = Config( method_name="proposal", trainer=TrainerConfig(steps_per_eval_batch=500, steps_per_save=2000, mixed_precision=True), pipeline=VanillaPipelineConfig( datamanager=VanillaDataManagerConfig( dataparser=BlenderDataParserConfig(), train_num_rays_per_batch=4096, eval_num_rays_per_batch=8192 ), model=ProposalModelConfig(eval_num_rays_per_chunk=8192), ), optimizers={ "fields": { "optimizer": AdamOptimizerConfig(lr=1e-2, eps=1e-15), "scheduler": None, } }, viewer=ViewerConfig(enable=True, num_rays_per_chunk=2 << 15), logging=LoggingConfig(event_writer="none"), ) base_configs["mipnerf-360"] = Config( method_name="mipnerf-360", trainer=TrainerConfig(steps_per_eval_batch=200), pipeline=VanillaPipelineConfig( datamanager=VanillaDataManagerConfig(dataparser=MipNerf360DataParserConfig(), train_num_rays_per_batch=8192), model=VanillaModelConfig( _target=MipNerf360Model, collider_params={"near_plane": 0.5, "far_plane": 20.0}, loss_coefficients={"ray_loss_coarse": 1.0, "ray_loss_fine": 1.0}, num_coarse_samples=128, num_importance_samples=128, eval_num_rays_per_chunk=8192, ), ), optimizers={ "fields": { "optimizer": RAdamOptimizerConfig(lr=5e-4, eps=1e-08), "scheduler": None, } }, ) base_configs["mipnerf"] = Config( method_name="mipnerf", pipeline=VanillaPipelineConfig( datamanager=VanillaDataManagerConfig(dataparser=BlenderDataParserConfig(), train_num_rays_per_batch=8192), model=VanillaModelConfig( _target=MipNerfModel, loss_coefficients={"rgb_loss_coarse": 0.1, "rgb_loss_fine": 1.0}, num_coarse_samples=128, num_importance_samples=128, eval_num_rays_per_chunk=8192, ), ), optimizers={ "fields": { "optimizer": RAdamOptimizerConfig(lr=5e-4, eps=1e-08), "scheduler": None, } }, ) base_configs["nerfw"] = Config( method_name="nerfw", pipeline=VanillaPipelineConfig( datamanager=VanillaDataManagerConfig( dataparser=FriendsDataParserConfig(), ), model=NerfWModelConfig(), ), optimizers={ "fields": { "optimizer": RAdamOptimizerConfig(lr=5e-4, eps=1e-08), "scheduler": None, } }, ) base_configs["semantic-nerf"] = Config( method_name="semantic-nerf", pipeline=VanillaPipelineConfig( datamanager=VanillaDataManagerConfig( dataparser=FriendsDataParserConfig(), ), model=VanillaModelConfig( _target=SemanticNerfModel, loss_coefficients={"rgb_loss_coarse": 1.0, "rgb_loss_fine": 1.0, "semantic_loss_fine": 0.05}, num_coarse_samples=64, num_importance_samples=64, ), ), optimizers={ "fields": { "optimizer": RAdamOptimizerConfig(lr=5e-4, eps=1e-08), "scheduler": None, } }, ) base_configs["vanilla-nerf"] = Config( method_name="vanilla-nerf", pipeline=VanillaPipelineConfig( datamanager=VanillaDataManagerConfig( dataparser=BlenderDataParserConfig(), ), model=VanillaModelConfig(_target=NeRFModel), ), optimizers={ "fields": { "optimizer": RAdamOptimizerConfig(lr=5e-4, eps=1e-08), "scheduler": None, } }, ) base_configs["tensorf"] = Config( method_name="tensorf", trainer=TrainerConfig(mixed_precision=True), pipeline=VanillaPipelineConfig( datamanager=VanillaDataManagerConfig( dataparser=BlenderDataParserConfig(), ), model=TensoRFModelConfig(), ), optimizers={ "fields": { "optimizer": RAdamOptimizerConfig(lr=0.001), "scheduler": SchedulerConfig(lr_final=0.00005, max_steps=15000), }, "position_encoding": { "optimizer": RAdamOptimizerConfig(lr=0.02), "scheduler": SchedulerConfig(lr_final=0.005, max_steps=15000), }, "direction_encoding": { "optimizer": RAdamOptimizerConfig(lr=0.02), "scheduler": SchedulerConfig(lr_final=0.005, max_steps=15000), }, }, ) @typeguard_ignore # TypeGuard doesn't understand the generic alias that's returned here. def _make_base_config_subcommand_type() -> Type[Config]: """Generate a Union[] type over the possible base config types, with runtime annotations containing default values. Used to generate CLIs. Returns: An annotated Union type, which can be used to pick a base configuration. """ # When a base config is used to generate a CLI: replace the auto-generated timestamp # with {timestamp}. This makes the CLI helptext (and, for zsh, autocomplete # generation) consistent everytime you run a script with --help. # # Note that when a config is instantiated with dcargs.cli(), the __post_init__ # called when the config is instantiated will set the correct timestamp. base_configs_placeholder_timestamp = {} for name, config in base_configs.items(): base_configs_placeholder_timestamp[name] = copy.deepcopy(config) return dcargs.extras.subcommand_type_from_defaults(base_configs_placeholder_timestamp) AnnotatedBaseConfigUnion = _make_base_config_subcommand_type() """Union[] type over config types, annotated with default instances for use with dcargs.cli(). Allows the user to pick between one of several base configurations, and then override values in it."""