interscale.module.CombinedModule
================================

.. currentmodule:: interscale.module

.. add toctree option to make autodoc generate the pages

.. autoclass:: CombinedModule



Attributes table
~~~~~~~~~~~~~~~~

.. autosummary::

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





Methods table
~~~~~~~~~~~~~

.. autosummary::

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





Attributes
~~~~~~~~~~



.. autoattribute:: CombinedModule.CHECKPOINT_HYPER_PARAMS_KEY

.. autoattribute:: CombinedModule.CHECKPOINT_HYPER_PARAMS_NAME

.. autoattribute:: CombinedModule.CHECKPOINT_HYPER_PARAMS_TYPE

.. autoattribute:: CombinedModule.T_destination

.. autoattribute:: CombinedModule.automatic_optimization

.. autoattribute:: CombinedModule.call_super_init

.. autoattribute:: CombinedModule.current_epoch

.. autoattribute:: CombinedModule.device

.. autoattribute:: CombinedModule.device_mesh

.. autoattribute:: CombinedModule.dtype

.. autoattribute:: CombinedModule.dump_patches

.. autoattribute:: CombinedModule.example_input_array

.. autoattribute:: CombinedModule.fabric

.. autoattribute:: CombinedModule.global_rank

.. autoattribute:: CombinedModule.global_step

.. autoattribute:: CombinedModule.hparams

.. autoattribute:: CombinedModule.hparams_initial

.. autoattribute:: CombinedModule.local_rank

.. autoattribute:: CombinedModule.logger

.. autoattribute:: CombinedModule.loggers

.. autoattribute:: CombinedModule.on_gpu

.. autoattribute:: CombinedModule.strict_loading

.. autoattribute:: CombinedModule.trainer

.. autoattribute:: CombinedModule.training






Methods
~~~~~~~



.. automethod:: CombinedModule.add_module

.. automethod:: CombinedModule.all_gather

.. automethod:: CombinedModule.apply

.. automethod:: CombinedModule.backward

.. automethod:: CombinedModule.bfloat16

.. automethod:: CombinedModule.buffers

.. automethod:: CombinedModule.children

.. automethod:: CombinedModule.clip_gradients

.. automethod:: CombinedModule.compile

.. automethod:: CombinedModule.configure_callbacks

.. automethod:: CombinedModule.configure_gradient_clipping

.. automethod:: CombinedModule.configure_model

.. automethod:: CombinedModule.configure_optimizers

.. automethod:: CombinedModule.configure_sharded_model

.. automethod:: CombinedModule.cpu

.. automethod:: CombinedModule.cuda

.. automethod:: CombinedModule.double

.. automethod:: CombinedModule.eval

.. automethod:: CombinedModule.extra_repr

.. automethod:: CombinedModule.float

.. automethod:: CombinedModule.forward

.. automethod:: CombinedModule.freeze

.. automethod:: CombinedModule.get_buffer

.. automethod:: CombinedModule.get_extra_state

.. automethod:: CombinedModule.get_model_summary

.. automethod:: CombinedModule.get_parameter

.. automethod:: CombinedModule.get_submodule

.. automethod:: CombinedModule.half

.. automethod:: CombinedModule.ipu

.. automethod:: CombinedModule.load_from_checkpoint

.. automethod:: CombinedModule.load_state_dict

.. automethod:: CombinedModule.log

.. automethod:: CombinedModule.log_dict

.. automethod:: CombinedModule.lr_scheduler_step

.. automethod:: CombinedModule.lr_schedulers

.. automethod:: CombinedModule.manual_backward

.. automethod:: CombinedModule.modules

.. automethod:: CombinedModule.mtia

.. automethod:: CombinedModule.named_buffers

.. automethod:: CombinedModule.named_children

.. automethod:: CombinedModule.named_modules

.. automethod:: CombinedModule.named_parameters

.. automethod:: CombinedModule.on_after_backward

.. automethod:: CombinedModule.on_after_batch_transfer

.. automethod:: CombinedModule.on_before_backward

.. automethod:: CombinedModule.on_before_batch_transfer

.. automethod:: CombinedModule.on_before_optimizer_step

.. automethod:: CombinedModule.on_before_zero_grad

.. automethod:: CombinedModule.on_fit_end

.. automethod:: CombinedModule.on_fit_start

.. automethod:: CombinedModule.on_load_checkpoint

.. automethod:: CombinedModule.on_predict_batch_end

.. automethod:: CombinedModule.on_predict_batch_start

.. automethod:: CombinedModule.on_predict_end

.. automethod:: CombinedModule.on_predict_epoch_end

.. automethod:: CombinedModule.on_predict_epoch_start

.. automethod:: CombinedModule.on_predict_model_eval

.. automethod:: CombinedModule.on_predict_start

.. automethod:: CombinedModule.on_save_checkpoint

.. automethod:: CombinedModule.on_test_batch_end

.. automethod:: CombinedModule.on_test_batch_start

.. automethod:: CombinedModule.on_test_end

.. automethod:: CombinedModule.on_test_epoch_end

.. automethod:: CombinedModule.on_test_epoch_start

.. automethod:: CombinedModule.on_test_model_eval

.. automethod:: CombinedModule.on_test_model_train

.. automethod:: CombinedModule.on_test_start

.. automethod:: CombinedModule.on_train_batch_end

.. automethod:: CombinedModule.on_train_batch_start

.. automethod:: CombinedModule.on_train_end

.. automethod:: CombinedModule.on_train_epoch_end

.. automethod:: CombinedModule.on_train_epoch_start

.. automethod:: CombinedModule.on_train_start

.. automethod:: CombinedModule.on_validation_batch_end

.. automethod:: CombinedModule.on_validation_batch_start

.. automethod:: CombinedModule.on_validation_end

.. automethod:: CombinedModule.on_validation_epoch_end

.. automethod:: CombinedModule.on_validation_epoch_start

.. automethod:: CombinedModule.on_validation_model_eval

.. automethod:: CombinedModule.on_validation_model_train

.. automethod:: CombinedModule.on_validation_model_zero_grad

.. automethod:: CombinedModule.on_validation_start

.. automethod:: CombinedModule.optimizer_step

.. automethod:: CombinedModule.optimizer_zero_grad

.. automethod:: CombinedModule.optimizers

.. automethod:: CombinedModule.parameters

.. automethod:: CombinedModule.predict_dataloader

.. automethod:: CombinedModule.predict_global

.. automethod:: CombinedModule.predict_local

.. automethod:: CombinedModule.predict_step

.. automethod:: CombinedModule.prepare_data

.. automethod:: CombinedModule.print

.. automethod:: CombinedModule.register_backward_hook

.. automethod:: CombinedModule.register_buffer

.. automethod:: CombinedModule.register_forward_hook

.. automethod:: CombinedModule.register_forward_pre_hook

.. automethod:: CombinedModule.register_full_backward_hook

.. automethod:: CombinedModule.register_full_backward_pre_hook

.. automethod:: CombinedModule.register_load_state_dict_post_hook

.. automethod:: CombinedModule.register_load_state_dict_pre_hook

.. automethod:: CombinedModule.register_module

.. automethod:: CombinedModule.register_parameter

.. automethod:: CombinedModule.register_state_dict_post_hook

.. automethod:: CombinedModule.register_state_dict_pre_hook

.. automethod:: CombinedModule.remove_ignored_hparams

.. automethod:: CombinedModule.requires_grad_

.. automethod:: CombinedModule.save_hyperparameters

.. automethod:: CombinedModule.set_extra_state

.. automethod:: CombinedModule.set_submodule

.. automethod:: CombinedModule.setup

.. automethod:: CombinedModule.share_memory

.. automethod:: CombinedModule.state_dict

.. automethod:: CombinedModule.teardown

.. automethod:: CombinedModule.test_dataloader

.. automethod:: CombinedModule.test_step

.. automethod:: CombinedModule.to

.. automethod:: CombinedModule.to_empty

.. automethod:: CombinedModule.to_onnx

.. automethod:: CombinedModule.to_tensorrt

.. automethod:: CombinedModule.to_torchscript

.. automethod:: CombinedModule.toggle_optimizer

.. automethod:: CombinedModule.toggled_optimizer

.. automethod:: CombinedModule.train

.. automethod:: CombinedModule.train_dataloader

.. automethod:: CombinedModule.training_step

.. automethod:: CombinedModule.transfer_batch_to_device

.. automethod:: CombinedModule.type

.. automethod:: CombinedModule.unfreeze

.. automethod:: CombinedModule.untoggle_optimizer

.. automethod:: CombinedModule.val_dataloader

.. automethod:: CombinedModule.validation_step

.. automethod:: CombinedModule.xpu

.. automethod:: CombinedModule.zero_grad