spatialvi.train.SpatialTrainingPlan
===================================

.. currentmodule:: spatialvi.train

.. autoclass:: SpatialTrainingPlan

   
   .. automethod:: __init__

   
   .. rubric:: Methods

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

   
   
   .. rubric:: Attributes

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