API

TODO: Explanation of each component

• dataset
  • Base dataset
    • BaseDataset
      • BaseDataset.Config
      • BaseDataset.load_camera_prior()
      • BaseDataset.load_data_list()
      • BaseDataset.load_observed_data()
      • BaseDataset.load_pointcloud_prior()
      • BaseDataset.transform_observed_data()
  • Data Prior
    • CameraPrior
    • CamerasPrior
      • CamerasPrior.generate_camera_path()
      • CamerasPrior.get_radius()
    • PointsPrior
      • PointsPrior.read_ply()
      • PointsPrior.save_ply()
• hook
  • Hook
    • Hook.after_load_checkpoint()
    • Hook.after_run()
    • Hook.after_train()
    • Hook.after_train_iter()
    • Hook.after_val()
    • Hook.after_val_iter()
    • Hook.before_run()
    • Hook.before_train()
    • Hook.before_train_iter()
    • Hook.before_val()
    • Hook.before_val_iter()
    • Hook.exception()
  • CheckPointHook
    • CheckPointHook.after_train()
    • CheckPointHook.after_train_iter()
    • CheckPointHook.exception()
  • LogHook
    • LogHook.after_train()
    • LogHook.after_train_iter()
    • LogHook.after_val()
    • LogHook.after_val_iter()
    • LogHook.before_run()
    • LogHook.before_train()
    • LogHook.before_val()
    • LogHook.exception()
• logger
  • ItersPerSecColumn
    • ItersPerSecColumn.render()
  • LogColumn
    • LogColumn.render()
  • ProgressLogger
    • ProgressLogger.add_task()
    • ProgressLogger.reset()
    • ProgressLogger.start()
    • ProgressLogger.start_task()
    • ProgressLogger.stop()
    • ProgressLogger.stop_task()
    • ProgressLogger.update()
  • TensorboardWriter
    • TensorboardWriter.write_config()
    • TensorboardWriter.write_image()
    • TensorboardWriter.write_scalar()
  • WandbWriter
    • WandbWriter.write_config()
    • WandbWriter.write_image()
    • WandbWriter.write_scalar()
  • Writer
    • Writer.write_config()
    • Writer.write_image()
    • Writer.write_scalar()
  • logproject()
• model
  • BaseModel
    • BaseModel.Config
    • BaseModel.forward()
    • BaseModel.get_loss_dict()
    • BaseModel.get_metric_dict()
    • BaseModel.get_optimizer_dict()
    • BaseModel.load_ply()
    • BaseModel.load_state_dict()
  • CameraModel
    • CameraModel.Config
    • CameraModel.camera_centers()
    • CameraModel.extrinsic_matrices()
    • CameraModel.image_height
    • CameraModel.image_width
    • CameraModel.intrinsic_params()
    • CameraModel.rotation_matrices()
    • CameraModel.setup()
    • CameraModel.translation_vectors()
  • GaussianPointCloud
    • GaussianPointCloud.Config
    • GaussianPointCloud.re_init()
    • GaussianPointCloud.setup()
  • PointCloud
    • PointCloud.Config
    • PointCloud.extand_points()
    • PointCloud.extend_optimizer()
    • PointCloud.get_all_atributes()
    • PointCloud.list_of_attributes()
    • PointCloud.load_ply()
    • PointCloud.prune_optimizer()
    • PointCloud.re_init()
    • PointCloud.register_atribute()
    • PointCloud.remove_points()
    • PointCloud.replace()
    • PointCloud.replace_optimizer()
    • PointCloud.save_ply()
    • PointCloud.select_atributes()
    • PointCloud.set_all_atributes_trainable()
    • PointCloud.set_prefix_name()
    • PointCloud.setup()
    • PointCloud.unwarp()
  • GaussianSplattingRender
    • GaussianSplattingRender.render_iter()
    • GaussianSplattingRender.setup()
  • MsplatRender
    • MsplatRender.Config
    • MsplatRender.load_state_dict()
    • MsplatRender.render_batch()
    • MsplatRender.render_iter()
    • MsplatRender.setup()
    • MsplatRender.state_dict()
    • MsplatRender.update_sh_degree()
  • GsplatRender
    • GsplatRender.render_iter()
• controller
  • DensificationController
    • DensificationController.Config
    • DensificationController.accumulate_viewspace_grad()
    • DensificationController.densify_clone()
    • DensificationController.densify_split()
    • DensificationController.generate_clone_mask()
    • DensificationController.generate_split_mask()
    • DensificationController.new_pos_scale()
    • DensificationController.prune()
    • DensificationController.prune_postprocess()
    • DensificationController.reset_controller_state()
    • DensificationController.reset_opacity()
• optimizer
  • BaseOptimizer
    • BaseOptimizer.Config
    • BaseOptimizer.get_lr()
    • BaseOptimizer.get_momentum()
    • BaseOptimizer.load_state_dict()
    • BaseOptimizer.param_groups
    • BaseOptimizer.state_dict()
    • BaseOptimizer.update_model()
  • OptimizerList
    • OptimizerList.load_state_dict()
    • OptimizerList.param_groups
    • OptimizerList.state_dict()
    • OptimizerList.update_model()
  • ExponLRScheduler
    • ExponLRScheduler.get_exponential_lr()
    • ExponLRScheduler.step()
• trainer
  • DefaultTrainer
    • DefaultTrainer.test()
    • DefaultTrainer.train_loop()
    • DefaultTrainer.train_step()