API

TODO: Explanation of each component

• Configs
  • Config
    • Config.data
    • Config.experiment_name
    • Config.get_base_dir()
    • Config.get_checkpoint_dir()
    • Config.is_tensorboard_enabled()
    • Config.is_viewer_enabled()
    • Config.is_wandb_enabled()
    • Config.logging
    • Config.machine
    • Config.method_name
    • Config.optimizers
    • Config.output_dir
    • Config.pipeline
    • Config.print_to_terminal()
    • Config.save_config()
    • Config.set_experiment_name()
    • Config.set_timestamp()
    • Config.timestamp
    • Config.trainer
    • Config.viewer
    • Config.vis
  • InstantiateConfig
    • InstantiateConfig.setup()
  • LocalWriterConfig
    • LocalWriterConfig.enable
    • LocalWriterConfig.max_log_size
    • LocalWriterConfig.setup()
    • LocalWriterConfig.stats_to_track
  • LoggingConfig
    • LoggingConfig.enable_profiler
    • LoggingConfig.local_writer
    • LoggingConfig.max_buffer_size
    • LoggingConfig.relative_log_dir
    • LoggingConfig.steps_per_log
  • MachineConfig
    • MachineConfig.dist_url
    • MachineConfig.machine_rank
    • MachineConfig.num_gpus
    • MachineConfig.num_machines
    • MachineConfig.seed
  • PrintableConfig
  • TrainerConfig
    • TrainerConfig.load_dir
    • TrainerConfig.load_step
    • TrainerConfig.max_num_iterations
    • TrainerConfig.mixed_precision
    • TrainerConfig.relative_model_dir
    • TrainerConfig.save_only_latest_checkpoint
    • TrainerConfig.steps_per_eval_all_images
    • TrainerConfig.steps_per_eval_batch
    • TrainerConfig.steps_per_eval_image
    • TrainerConfig.steps_per_save
  • ViewerConfig
    • ViewerConfig.ip_address
    • ViewerConfig.launch_bridge_server
    • ViewerConfig.max_num_display_images
    • ViewerConfig.num_rays_per_chunk
    • ViewerConfig.quit_on_train_completion
    • ViewerConfig.relative_log_filename
    • ViewerConfig.skip_openrelay
    • ViewerConfig.start_train
    • ViewerConfig.websocket_port
    • ViewerConfig.zmq_port
• Data
  • Data Parsers
  • Datasets
  • Dataloaders
    • CacheDataloader
    • EvalDataloader
      • EvalDataloader.__iter__()
      • EvalDataloader.__next__()
      • EvalDataloader.get_camera()
      • EvalDataloader.get_data_from_image_idx()
    • FixedIndicesEvalDataloader
    • RandIndicesEvalDataloader
  • Pixel Samplers
    • EquirectangularPixelSampler
      • EquirectangularPixelSampler.sample()
    • PixelSampler
      • PixelSampler.sample()
      • PixelSampler.set_num_rays_per_batch()
    • collate_image_dataset_batch()
    • collate_image_dataset_batch_equirectangular()
    • collate_image_dataset_batch_list()
  • Scene Box
    • SceneBox
      • SceneBox.aabb
      • SceneBox.from_camera_poses()
      • SceneBox.from_json()
      • SceneBox.get_center()
      • SceneBox.get_centered_and_scaled_scene_box()
      • SceneBox.get_diagonal_length()
      • SceneBox.get_normalized_positions()
      • SceneBox.to_json()
• Fields
  • Base
    • Field
      • Field.density_fn()
      • Field.forward()
      • Field.get_density()
      • Field.get_normals()
      • Field.get_outputs()
  • Instant NGP
    • TCNNInstantNGPField
      • TCNNInstantNGPField.get_density()
      • TCNNInstantNGPField.get_opacity()
      • TCNNInstantNGPField.get_outputs()
    • get_normalized_directions()
  • Vanilla NeRF
    • NeRFField
      • NeRFField.get_density()
      • NeRFField.get_outputs()
• Field Modules
  • Encodings
    • Encoding
      • Encoding.forward()
    • HashEncoding
      • HashEncoding.forward()
      • HashEncoding.get_out_dim()
      • HashEncoding.hash_fn()
      • HashEncoding.pytorch_fwd()
    • Identity
      • Identity.forward()
      • Identity.get_out_dim()
    • NeRFEncoding
      • NeRFEncoding.forward()
      • NeRFEncoding.get_out_dim()
    • RFFEncoding
      • RFFEncoding.forward()
      • RFFEncoding.get_out_dim()
    • SHEncoding
      • SHEncoding.forward()
      • SHEncoding.get_out_dim()
    • ScalingAndOffset
      • ScalingAndOffset.forward()
      • ScalingAndOffset.get_out_dim()
    • TensorCPEncoding
      • TensorCPEncoding.forward()
      • TensorCPEncoding.get_out_dim()
      • TensorCPEncoding.upsample_grid()
    • TensorVMEncoding
      • TensorVMEncoding.forward()
      • TensorVMEncoding.get_out_dim()
      • TensorVMEncoding.upsample_grid()
  • Embeddings
    • Embedding
      • Embedding.build_nn_modules()
      • Embedding.forward()
      • Embedding.mean()
  • Field Heads
    • DensityFieldHead
    • FieldHead
      • FieldHead.forward()
      • FieldHead.set_in_dim()
    • FieldHeadNames
    • PredNormalsFieldHead
      • PredNormalsFieldHead.forward()
    • RGBFieldHead
    • SHFieldHead
    • SemanticFieldHead
    • TransientDensityFieldHead
    • TransientRGBFieldHead
    • UncertaintyFieldHead
  • MLP
    • MLP
      • MLP.build_nn_modules()
      • MLP.forward()
  • Spatial Distortions
    • SceneContraction
      • SceneContraction.forward()
    • SpatialDistortion
      • SpatialDistortion.forward()
• Models
  • Base
    • Model
      • Model.device
      • Model.forward()
      • Model.get_image_metrics_and_images()
      • Model.get_loss_dict()
      • Model.get_metrics_dict()
      • Model.get_outputs()
      • Model.get_outputs_for_camera_ray_bundle()
      • Model.get_param_groups()
      • Model.get_training_callbacks()
      • Model.load_model()
      • Model.populate_modules()
    • ModelConfig
      • ModelConfig.collider_params
      • ModelConfig.enable_collider
      • ModelConfig.eval_num_rays_per_chunk
      • ModelConfig.loss_coefficients
  • Instant NGP
    • InstantNGPModelConfig
      • InstantNGPModelConfig.collider_params
      • InstantNGPModelConfig.cone_angle
      • InstantNGPModelConfig.contraction_type
      • InstantNGPModelConfig.enable_collider
      • InstantNGPModelConfig.far_plane
      • InstantNGPModelConfig.grid_resolution
      • InstantNGPModelConfig.max_num_samples_per_ray
      • InstantNGPModelConfig.near_plane
      • InstantNGPModelConfig.randomize_background
      • InstantNGPModelConfig.render_step_size
      • InstantNGPModelConfig.use_appearance_embedding
    • NGPModel
      • NGPModel.get_image_metrics_and_images()
      • NGPModel.get_loss_dict()
      • NGPModel.get_metrics_dict()
      • NGPModel.get_outputs()
      • NGPModel.get_param_groups()
      • NGPModel.get_training_callbacks()
      • NGPModel.populate_modules()
  • Semantic NeRF-W
    • SemanticNerfWModel
      • SemanticNerfWModel.get_image_metrics_and_images()
      • SemanticNerfWModel.get_loss_dict()
      • SemanticNerfWModel.get_metrics_dict()
      • SemanticNerfWModel.get_outputs()
      • SemanticNerfWModel.get_param_groups()
      • SemanticNerfWModel.get_training_callbacks()
      • SemanticNerfWModel.populate_modules()
    • SemanticNerfWModelConfig
      • SemanticNerfWModelConfig.use_transient_embedding
  • NeRF
    • NeRFModel
      • NeRFModel.get_image_metrics_and_images()
      • NeRFModel.get_loss_dict()
      • NeRFModel.get_outputs()
      • NeRFModel.get_param_groups()
      • NeRFModel.populate_modules()
    • VanillaModelConfig
      • VanillaModelConfig.enable_temporal_distortion
      • VanillaModelConfig.num_coarse_samples
      • VanillaModelConfig.num_importance_samples
      • VanillaModelConfig.temporal_distortion_params
• Model components
  • Ray Sampler
    • LinearDisparitySampler
    • LogSampler
    • PDFSampler
      • PDFSampler.generate_ray_samples()
    • ProposalNetworkSampler
      • ProposalNetworkSampler.generate_ray_samples()
      • ProposalNetworkSampler.set_anneal()
      • ProposalNetworkSampler.step_cb()
    • Sampler
      • Sampler.forward()
      • Sampler.generate_ray_samples()
    • SpacedSampler
      • SpacedSampler.generate_ray_samples()
    • SqrtSampler
    • UniformLinDispPiecewiseSampler
    • UniformSampler
    • VolumetricSampler
      • VolumetricSampler.forward()
      • VolumetricSampler.generate_ray_samples()
      • VolumetricSampler.get_sigma_fn()
  • Losses
    • distortion_loss()
    • interlevel_loss()
    • lossfun_distortion()
    • lossfun_outer()
    • nerfstudio_distortion_loss()
    • orientation_loss()
    • outer()
    • pred_normal_loss()
    • ray_samples_to_sdist()
  • Renderers
    • AccumulationRenderer
      • AccumulationRenderer.forward()
    • DepthRenderer
      • DepthRenderer.forward()
    • NormalsRenderer
      • NormalsRenderer.forward()
    • RGBRenderer
      • RGBRenderer.combine_rgb()
      • RGBRenderer.forward()
    • SHRenderer
      • SHRenderer.forward()
    • SemanticRenderer
      • SemanticRenderer.forward()
    • UncertaintyRenderer
      • UncertaintyRenderer.forward()
• Engine
  • Optimizers
    • AdamOptimizerConfig
    • OptimizerConfig
      • OptimizerConfig.setup()
    • Optimizers
      • Optimizers.load_optimizers()
      • Optimizers.optimizer_scaler_step_all()
      • Optimizers.optimizer_step()
      • Optimizers.optimizer_step_all()
      • Optimizers.scheduler_step()
      • Optimizers.scheduler_step_all()
      • Optimizers.zero_grad_all()
    • RAdamOptimizerConfig
    • setup_optimizers()
  • Schedulers
    • DelayedExponentialScheduler
    • DelayerScheduler
    • ExponentialDecaySchedule
    • SchedulerConfig
      • SchedulerConfig.setup()
• Utils
  • Colors
    • get_color()
  • Math
    • Gaussians
    • components_from_spherical_harmonics()
    • compute_3d_gaussian()
    • conical_frustum_to_gaussian()
    • cylinder_to_gaussian()
    • expected_sin()
  • Colormaps
    • apply_boolean_colormap()
    • apply_colormap()
    • apply_depth_colormap()
  • TensorDataclass
    • TensorDataclass
      • TensorDataclass.__post_init__()
      • TensorDataclass.broadcast_to()
      • TensorDataclass.flatten()
      • TensorDataclass.ndim
      • TensorDataclass.reshape()
      • TensorDataclass.shape
      • TensorDataclass.size
      • TensorDataclass.to()
• Viewer