ertk.pytorch.models.LightningWrapper
====================================

.. currentmodule:: ertk.pytorch.models

.. autoclass:: LightningWrapper
    :members:
    :show-inheritance:

    
    .. automethod:: __init__

    
    .. rubric:: Methods

    .. autosummary::
    
        ~LightningWrapper.__init__
        ~LightningWrapper.forward

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

    
    
    .. rubric:: Attributes

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