interscale.module.DualDecoderCombinedModule
===========================================

.. currentmodule:: interscale.module

.. add toctree option to make autodoc generate the pages

.. autoclass:: DualDecoderCombinedModule



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

.. autosummary::

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





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

.. autosummary::

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





Attributes
~~~~~~~~~~



.. autoattribute:: DualDecoderCombinedModule.CHECKPOINT_HYPER_PARAMS_KEY

.. autoattribute:: DualDecoderCombinedModule.CHECKPOINT_HYPER_PARAMS_NAME

.. autoattribute:: DualDecoderCombinedModule.CHECKPOINT_HYPER_PARAMS_TYPE

.. autoattribute:: DualDecoderCombinedModule.T_destination

.. autoattribute:: DualDecoderCombinedModule.automatic_optimization

.. autoattribute:: DualDecoderCombinedModule.call_super_init

.. autoattribute:: DualDecoderCombinedModule.current_epoch

.. autoattribute:: DualDecoderCombinedModule.device

.. autoattribute:: DualDecoderCombinedModule.device_mesh

.. autoattribute:: DualDecoderCombinedModule.dtype

.. autoattribute:: DualDecoderCombinedModule.dump_patches

.. autoattribute:: DualDecoderCombinedModule.example_input_array

.. autoattribute:: DualDecoderCombinedModule.fabric

.. autoattribute:: DualDecoderCombinedModule.global_rank

.. autoattribute:: DualDecoderCombinedModule.global_step

.. autoattribute:: DualDecoderCombinedModule.hparams

.. autoattribute:: DualDecoderCombinedModule.hparams_initial

.. autoattribute:: DualDecoderCombinedModule.local_rank

.. autoattribute:: DualDecoderCombinedModule.logger

.. autoattribute:: DualDecoderCombinedModule.loggers

.. autoattribute:: DualDecoderCombinedModule.on_gpu

.. autoattribute:: DualDecoderCombinedModule.strict_loading

.. autoattribute:: DualDecoderCombinedModule.trainer

.. autoattribute:: DualDecoderCombinedModule.training






Methods
~~~~~~~



.. automethod:: DualDecoderCombinedModule.add_module

.. automethod:: DualDecoderCombinedModule.all_gather

.. automethod:: DualDecoderCombinedModule.apply

.. automethod:: DualDecoderCombinedModule.backward

.. automethod:: DualDecoderCombinedModule.bfloat16

.. automethod:: DualDecoderCombinedModule.buffers

.. automethod:: DualDecoderCombinedModule.children

.. automethod:: DualDecoderCombinedModule.clip_gradients

.. automethod:: DualDecoderCombinedModule.compile

.. automethod:: DualDecoderCombinedModule.compute_separate_losses

.. automethod:: DualDecoderCombinedModule.configure_callbacks

.. automethod:: DualDecoderCombinedModule.configure_gradient_clipping

.. automethod:: DualDecoderCombinedModule.configure_model

.. automethod:: DualDecoderCombinedModule.configure_optimizers

.. automethod:: DualDecoderCombinedModule.configure_sharded_model

.. automethod:: DualDecoderCombinedModule.cpu

.. automethod:: DualDecoderCombinedModule.cuda

.. automethod:: DualDecoderCombinedModule.double

.. automethod:: DualDecoderCombinedModule.eval

.. automethod:: DualDecoderCombinedModule.extra_repr

.. automethod:: DualDecoderCombinedModule.float

.. automethod:: DualDecoderCombinedModule.forward

.. automethod:: DualDecoderCombinedModule.freeze

.. automethod:: DualDecoderCombinedModule.get_buffer

.. automethod:: DualDecoderCombinedModule.get_extra_state

.. automethod:: DualDecoderCombinedModule.get_model_summary

.. automethod:: DualDecoderCombinedModule.get_parameter

.. automethod:: DualDecoderCombinedModule.get_separate_predictions

.. automethod:: DualDecoderCombinedModule.get_submodule

.. automethod:: DualDecoderCombinedModule.half

.. automethod:: DualDecoderCombinedModule.ipu

.. automethod:: DualDecoderCombinedModule.load_from_checkpoint

.. automethod:: DualDecoderCombinedModule.load_state_dict

.. automethod:: DualDecoderCombinedModule.log

.. automethod:: DualDecoderCombinedModule.log_dict

.. automethod:: DualDecoderCombinedModule.lr_scheduler_step

.. automethod:: DualDecoderCombinedModule.lr_schedulers

.. automethod:: DualDecoderCombinedModule.manual_backward

.. automethod:: DualDecoderCombinedModule.modules

.. automethod:: DualDecoderCombinedModule.mtia

.. automethod:: DualDecoderCombinedModule.named_buffers

.. automethod:: DualDecoderCombinedModule.named_children

.. automethod:: DualDecoderCombinedModule.named_modules

.. automethod:: DualDecoderCombinedModule.named_parameters

.. automethod:: DualDecoderCombinedModule.on_after_backward

.. automethod:: DualDecoderCombinedModule.on_after_batch_transfer

.. automethod:: DualDecoderCombinedModule.on_before_backward

.. automethod:: DualDecoderCombinedModule.on_before_batch_transfer

.. automethod:: DualDecoderCombinedModule.on_before_optimizer_step

.. automethod:: DualDecoderCombinedModule.on_before_zero_grad

.. automethod:: DualDecoderCombinedModule.on_fit_end

.. automethod:: DualDecoderCombinedModule.on_fit_start

.. automethod:: DualDecoderCombinedModule.on_load_checkpoint

.. automethod:: DualDecoderCombinedModule.on_predict_batch_end

.. automethod:: DualDecoderCombinedModule.on_predict_batch_start

.. automethod:: DualDecoderCombinedModule.on_predict_end

.. automethod:: DualDecoderCombinedModule.on_predict_epoch_end

.. automethod:: DualDecoderCombinedModule.on_predict_epoch_start

.. automethod:: DualDecoderCombinedModule.on_predict_model_eval

.. automethod:: DualDecoderCombinedModule.on_predict_start

.. automethod:: DualDecoderCombinedModule.on_save_checkpoint

.. automethod:: DualDecoderCombinedModule.on_test_batch_end

.. automethod:: DualDecoderCombinedModule.on_test_batch_start

.. automethod:: DualDecoderCombinedModule.on_test_end

.. automethod:: DualDecoderCombinedModule.on_test_epoch_end

.. automethod:: DualDecoderCombinedModule.on_test_epoch_start

.. automethod:: DualDecoderCombinedModule.on_test_model_eval

.. automethod:: DualDecoderCombinedModule.on_test_model_train

.. automethod:: DualDecoderCombinedModule.on_test_start

.. automethod:: DualDecoderCombinedModule.on_train_batch_end

.. automethod:: DualDecoderCombinedModule.on_train_batch_start

.. automethod:: DualDecoderCombinedModule.on_train_end

.. automethod:: DualDecoderCombinedModule.on_train_epoch_end

.. automethod:: DualDecoderCombinedModule.on_train_epoch_start

.. automethod:: DualDecoderCombinedModule.on_train_start

.. automethod:: DualDecoderCombinedModule.on_validation_batch_end

.. automethod:: DualDecoderCombinedModule.on_validation_batch_start

.. automethod:: DualDecoderCombinedModule.on_validation_end

.. automethod:: DualDecoderCombinedModule.on_validation_epoch_end

.. automethod:: DualDecoderCombinedModule.on_validation_epoch_start

.. automethod:: DualDecoderCombinedModule.on_validation_model_eval

.. automethod:: DualDecoderCombinedModule.on_validation_model_train

.. automethod:: DualDecoderCombinedModule.on_validation_model_zero_grad

.. automethod:: DualDecoderCombinedModule.on_validation_start

.. automethod:: DualDecoderCombinedModule.optimizer_step

.. automethod:: DualDecoderCombinedModule.optimizer_zero_grad

.. automethod:: DualDecoderCombinedModule.optimizers

.. automethod:: DualDecoderCombinedModule.parameters

.. automethod:: DualDecoderCombinedModule.predict_dataloader

.. automethod:: DualDecoderCombinedModule.predict_global

.. automethod:: DualDecoderCombinedModule.predict_local

.. automethod:: DualDecoderCombinedModule.predict_step

.. automethod:: DualDecoderCombinedModule.prepare_data

.. automethod:: DualDecoderCombinedModule.print

.. automethod:: DualDecoderCombinedModule.register_backward_hook

.. automethod:: DualDecoderCombinedModule.register_buffer

.. automethod:: DualDecoderCombinedModule.register_forward_hook

.. automethod:: DualDecoderCombinedModule.register_forward_pre_hook

.. automethod:: DualDecoderCombinedModule.register_full_backward_hook

.. automethod:: DualDecoderCombinedModule.register_full_backward_pre_hook

.. automethod:: DualDecoderCombinedModule.register_load_state_dict_post_hook

.. automethod:: DualDecoderCombinedModule.register_load_state_dict_pre_hook

.. automethod:: DualDecoderCombinedModule.register_module

.. automethod:: DualDecoderCombinedModule.register_parameter

.. automethod:: DualDecoderCombinedModule.register_state_dict_post_hook

.. automethod:: DualDecoderCombinedModule.register_state_dict_pre_hook

.. automethod:: DualDecoderCombinedModule.remove_ignored_hparams

.. automethod:: DualDecoderCombinedModule.requires_grad_

.. automethod:: DualDecoderCombinedModule.save_hyperparameters

.. automethod:: DualDecoderCombinedModule.set_extra_state

.. automethod:: DualDecoderCombinedModule.set_submodule

.. automethod:: DualDecoderCombinedModule.setup

.. automethod:: DualDecoderCombinedModule.share_memory

.. automethod:: DualDecoderCombinedModule.state_dict

.. automethod:: DualDecoderCombinedModule.teardown

.. automethod:: DualDecoderCombinedModule.test_dataloader

.. automethod:: DualDecoderCombinedModule.test_step

.. automethod:: DualDecoderCombinedModule.to

.. automethod:: DualDecoderCombinedModule.to_empty

.. automethod:: DualDecoderCombinedModule.to_onnx

.. automethod:: DualDecoderCombinedModule.to_tensorrt

.. automethod:: DualDecoderCombinedModule.to_torchscript

.. automethod:: DualDecoderCombinedModule.toggle_optimizer

.. automethod:: DualDecoderCombinedModule.toggled_optimizer

.. automethod:: DualDecoderCombinedModule.train

.. automethod:: DualDecoderCombinedModule.train_dataloader

.. automethod:: DualDecoderCombinedModule.training_step

.. automethod:: DualDecoderCombinedModule.transfer_batch_to_device

.. automethod:: DualDecoderCombinedModule.type

.. automethod:: DualDecoderCombinedModule.unfreeze

.. automethod:: DualDecoderCombinedModule.untoggle_optimizer

.. automethod:: DualDecoderCombinedModule.val_dataloader

.. automethod:: DualDecoderCombinedModule.validation_step

.. automethod:: DualDecoderCombinedModule.xpu

.. automethod:: DualDecoderCombinedModule.zero_grad