ertk.pytorch.models.ERTKPyTorchModel
====================================

.. currentmodule:: ertk.pytorch.models

.. autoclass:: ERTKPyTorchModel
    :members:
    :show-inheritance:

    
    .. automethod:: __init__

    
    .. rubric:: Methods

    .. autosummary::
    
        ~ERTKPyTorchModel.__init__
        ~ERTKPyTorchModel.forward
        ~ERTKPyTorchModel.get_config_type
        ~ERTKPyTorchModel.get_default_config
        ~ERTKPyTorchModel.get_model_class
        ~ERTKPyTorchModel.make_model
        ~ERTKPyTorchModel.preprocess_input
        ~ERTKPyTorchModel.valid_models

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

    
    
    .. rubric:: Attributes

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