spatialvi.train.DeconvolutionTrainingPlan
=========================================

.. currentmodule:: spatialvi.train

.. autoclass:: DeconvolutionTrainingPlan

   
   .. automethod:: __init__

   
   .. rubric:: Methods

   .. autosummary::
   
      ~DeconvolutionTrainingPlan.__init__
      ~DeconvolutionTrainingPlan.add_module
      ~DeconvolutionTrainingPlan.all_gather
      ~DeconvolutionTrainingPlan.apply
      ~DeconvolutionTrainingPlan.backward
      ~DeconvolutionTrainingPlan.bfloat16
      ~DeconvolutionTrainingPlan.buffers
      ~DeconvolutionTrainingPlan.children
      ~DeconvolutionTrainingPlan.clip_gradients
      ~DeconvolutionTrainingPlan.compile
      ~DeconvolutionTrainingPlan.compute_and_log_metrics
      ~DeconvolutionTrainingPlan.configure_callbacks
      ~DeconvolutionTrainingPlan.configure_gradient_clipping
      ~DeconvolutionTrainingPlan.configure_model
      ~DeconvolutionTrainingPlan.configure_optimizers
      ~DeconvolutionTrainingPlan.configure_sharded_model
      ~DeconvolutionTrainingPlan.cpu
      ~DeconvolutionTrainingPlan.cuda
      ~DeconvolutionTrainingPlan.double
      ~DeconvolutionTrainingPlan.eval
      ~DeconvolutionTrainingPlan.extra_repr
      ~DeconvolutionTrainingPlan.float
      ~DeconvolutionTrainingPlan.forward
      ~DeconvolutionTrainingPlan.freeze
      ~DeconvolutionTrainingPlan.get_buffer
      ~DeconvolutionTrainingPlan.get_extra_state
      ~DeconvolutionTrainingPlan.get_optimizer_creator
      ~DeconvolutionTrainingPlan.get_parameter
      ~DeconvolutionTrainingPlan.get_submodule
      ~DeconvolutionTrainingPlan.half
      ~DeconvolutionTrainingPlan.initialize_train_metrics
      ~DeconvolutionTrainingPlan.initialize_val_metrics
      ~DeconvolutionTrainingPlan.ipu
      ~DeconvolutionTrainingPlan.load_from_checkpoint
      ~DeconvolutionTrainingPlan.load_state_dict
      ~DeconvolutionTrainingPlan.log
      ~DeconvolutionTrainingPlan.log_dict
      ~DeconvolutionTrainingPlan.lr_scheduler_step
      ~DeconvolutionTrainingPlan.lr_schedulers
      ~DeconvolutionTrainingPlan.manual_backward
      ~DeconvolutionTrainingPlan.modules
      ~DeconvolutionTrainingPlan.mtia
      ~DeconvolutionTrainingPlan.named_buffers
      ~DeconvolutionTrainingPlan.named_children
      ~DeconvolutionTrainingPlan.named_modules
      ~DeconvolutionTrainingPlan.named_parameters
      ~DeconvolutionTrainingPlan.on_after_backward
      ~DeconvolutionTrainingPlan.on_after_batch_transfer
      ~DeconvolutionTrainingPlan.on_before_backward
      ~DeconvolutionTrainingPlan.on_before_batch_transfer
      ~DeconvolutionTrainingPlan.on_before_optimizer_step
      ~DeconvolutionTrainingPlan.on_before_zero_grad
      ~DeconvolutionTrainingPlan.on_fit_end
      ~DeconvolutionTrainingPlan.on_fit_start
      ~DeconvolutionTrainingPlan.on_load_checkpoint
      ~DeconvolutionTrainingPlan.on_predict_batch_end
      ~DeconvolutionTrainingPlan.on_predict_batch_start
      ~DeconvolutionTrainingPlan.on_predict_end
      ~DeconvolutionTrainingPlan.on_predict_epoch_end
      ~DeconvolutionTrainingPlan.on_predict_epoch_start
      ~DeconvolutionTrainingPlan.on_predict_model_eval
      ~DeconvolutionTrainingPlan.on_predict_start
      ~DeconvolutionTrainingPlan.on_save_checkpoint
      ~DeconvolutionTrainingPlan.on_test_batch_end
      ~DeconvolutionTrainingPlan.on_test_batch_start
      ~DeconvolutionTrainingPlan.on_test_end
      ~DeconvolutionTrainingPlan.on_test_epoch_end
      ~DeconvolutionTrainingPlan.on_test_epoch_start
      ~DeconvolutionTrainingPlan.on_test_model_eval
      ~DeconvolutionTrainingPlan.on_test_model_train
      ~DeconvolutionTrainingPlan.on_test_start
      ~DeconvolutionTrainingPlan.on_train_batch_end
      ~DeconvolutionTrainingPlan.on_train_batch_start
      ~DeconvolutionTrainingPlan.on_train_end
      ~DeconvolutionTrainingPlan.on_train_epoch_end
      ~DeconvolutionTrainingPlan.on_train_epoch_start
      ~DeconvolutionTrainingPlan.on_train_start
      ~DeconvolutionTrainingPlan.on_validation_batch_end
      ~DeconvolutionTrainingPlan.on_validation_batch_start
      ~DeconvolutionTrainingPlan.on_validation_end
      ~DeconvolutionTrainingPlan.on_validation_epoch_end
      ~DeconvolutionTrainingPlan.on_validation_epoch_start
      ~DeconvolutionTrainingPlan.on_validation_model_eval
      ~DeconvolutionTrainingPlan.on_validation_model_train
      ~DeconvolutionTrainingPlan.on_validation_model_zero_grad
      ~DeconvolutionTrainingPlan.on_validation_start
      ~DeconvolutionTrainingPlan.optimizer_step
      ~DeconvolutionTrainingPlan.optimizer_zero_grad
      ~DeconvolutionTrainingPlan.optimizers
      ~DeconvolutionTrainingPlan.parameters
      ~DeconvolutionTrainingPlan.predict_dataloader
      ~DeconvolutionTrainingPlan.predict_step
      ~DeconvolutionTrainingPlan.prepare_data
      ~DeconvolutionTrainingPlan.prepare_scib_autotune
      ~DeconvolutionTrainingPlan.print
      ~DeconvolutionTrainingPlan.register_backward_hook
      ~DeconvolutionTrainingPlan.register_buffer
      ~DeconvolutionTrainingPlan.register_forward_hook
      ~DeconvolutionTrainingPlan.register_forward_pre_hook
      ~DeconvolutionTrainingPlan.register_full_backward_hook
      ~DeconvolutionTrainingPlan.register_full_backward_pre_hook
      ~DeconvolutionTrainingPlan.register_load_state_dict_post_hook
      ~DeconvolutionTrainingPlan.register_load_state_dict_pre_hook
      ~DeconvolutionTrainingPlan.register_module
      ~DeconvolutionTrainingPlan.register_parameter
      ~DeconvolutionTrainingPlan.register_state_dict_post_hook
      ~DeconvolutionTrainingPlan.register_state_dict_pre_hook
      ~DeconvolutionTrainingPlan.requires_grad_
      ~DeconvolutionTrainingPlan.save_hyperparameters
      ~DeconvolutionTrainingPlan.set_extra_state
      ~DeconvolutionTrainingPlan.set_submodule
      ~DeconvolutionTrainingPlan.setup
      ~DeconvolutionTrainingPlan.share_memory
      ~DeconvolutionTrainingPlan.state_dict
      ~DeconvolutionTrainingPlan.teardown
      ~DeconvolutionTrainingPlan.test_dataloader
      ~DeconvolutionTrainingPlan.test_step
      ~DeconvolutionTrainingPlan.to
      ~DeconvolutionTrainingPlan.to_empty
      ~DeconvolutionTrainingPlan.to_onnx
      ~DeconvolutionTrainingPlan.to_tensorrt
      ~DeconvolutionTrainingPlan.to_torchscript
      ~DeconvolutionTrainingPlan.toggle_optimizer
      ~DeconvolutionTrainingPlan.toggled_optimizer
      ~DeconvolutionTrainingPlan.train
      ~DeconvolutionTrainingPlan.train_dataloader
      ~DeconvolutionTrainingPlan.training_step
      ~DeconvolutionTrainingPlan.transfer_batch_to_device
      ~DeconvolutionTrainingPlan.type
      ~DeconvolutionTrainingPlan.unfreeze
      ~DeconvolutionTrainingPlan.untoggle_optimizer
      ~DeconvolutionTrainingPlan.val_dataloader
      ~DeconvolutionTrainingPlan.validation_step
      ~DeconvolutionTrainingPlan.xpu
      ~DeconvolutionTrainingPlan.zero_grad
   
   

   
   
   .. rubric:: Attributes

   .. autosummary::
   
      ~DeconvolutionTrainingPlan.CHECKPOINT_HYPER_PARAMS_KEY
      ~DeconvolutionTrainingPlan.CHECKPOINT_HYPER_PARAMS_NAME
      ~DeconvolutionTrainingPlan.CHECKPOINT_HYPER_PARAMS_TYPE
      ~DeconvolutionTrainingPlan.T_destination
      ~DeconvolutionTrainingPlan.automatic_optimization
      ~DeconvolutionTrainingPlan.call_super_init
      ~DeconvolutionTrainingPlan.current_epoch
      ~DeconvolutionTrainingPlan.device
      ~DeconvolutionTrainingPlan.device_mesh
      ~DeconvolutionTrainingPlan.dtype
      ~DeconvolutionTrainingPlan.dump_patches
      ~DeconvolutionTrainingPlan.example_input_array
      ~DeconvolutionTrainingPlan.fabric
      ~DeconvolutionTrainingPlan.global_rank
      ~DeconvolutionTrainingPlan.global_step
      ~DeconvolutionTrainingPlan.hparams
      ~DeconvolutionTrainingPlan.hparams_initial
      ~DeconvolutionTrainingPlan.kl_weight
      ~DeconvolutionTrainingPlan.local_rank
      ~DeconvolutionTrainingPlan.logger
      ~DeconvolutionTrainingPlan.loggers
      ~DeconvolutionTrainingPlan.n_obs_training
      ~DeconvolutionTrainingPlan.n_obs_validation
      ~DeconvolutionTrainingPlan.on_gpu
      ~DeconvolutionTrainingPlan.strict_loading
      ~DeconvolutionTrainingPlan.trainer
      ~DeconvolutionTrainingPlan.use_sync_dist
      ~DeconvolutionTrainingPlan.training