deepspatial.module.DeepSpatialModule
====================================

.. currentmodule:: deepspatial.module

.. autoclass:: DeepSpatialModule

   
   .. automethod:: __init__

   
   .. rubric:: Methods

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

   
   
   .. rubric:: Attributes

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