interscale.module.SCVILocalModule
=================================

.. currentmodule:: interscale.module

.. add toctree option to make autodoc generate the pages

.. autoclass:: SCVILocalModule



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

.. autosummary::

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





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

.. autosummary::

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





Attributes
~~~~~~~~~~



.. autoattribute:: SCVILocalModule.CHECKPOINT_HYPER_PARAMS_KEY

.. autoattribute:: SCVILocalModule.CHECKPOINT_HYPER_PARAMS_NAME

.. autoattribute:: SCVILocalModule.CHECKPOINT_HYPER_PARAMS_TYPE

.. autoattribute:: SCVILocalModule.T_destination

.. autoattribute:: SCVILocalModule.automatic_optimization

.. autoattribute:: SCVILocalModule.call_super_init

.. autoattribute:: SCVILocalModule.current_epoch

.. autoattribute:: SCVILocalModule.device

.. autoattribute:: SCVILocalModule.device_mesh

.. autoattribute:: SCVILocalModule.dtype

.. autoattribute:: SCVILocalModule.dump_patches

.. autoattribute:: SCVILocalModule.example_input_array

.. autoattribute:: SCVILocalModule.fabric

.. autoattribute:: SCVILocalModule.global_rank

.. autoattribute:: SCVILocalModule.global_step

.. autoattribute:: SCVILocalModule.hparams

.. autoattribute:: SCVILocalModule.hparams_initial

.. autoattribute:: SCVILocalModule.local_rank

.. autoattribute:: SCVILocalModule.logger

.. autoattribute:: SCVILocalModule.loggers

.. autoattribute:: SCVILocalModule.on_gpu

.. autoattribute:: SCVILocalModule.strict_loading

.. autoattribute:: SCVILocalModule.trainer

.. autoattribute:: SCVILocalModule.training






Methods
~~~~~~~



.. automethod:: SCVILocalModule.add_module

.. automethod:: SCVILocalModule.all_gather

.. automethod:: SCVILocalModule.apply

.. automethod:: SCVILocalModule.backward

.. automethod:: SCVILocalModule.bfloat16

.. automethod:: SCVILocalModule.buffers

.. automethod:: SCVILocalModule.children

.. automethod:: SCVILocalModule.clip_gradients

.. automethod:: SCVILocalModule.compile

.. automethod:: SCVILocalModule.configure_callbacks

.. automethod:: SCVILocalModule.configure_gradient_clipping

.. automethod:: SCVILocalModule.configure_model

.. automethod:: SCVILocalModule.configure_optimizers

.. automethod:: SCVILocalModule.configure_sharded_model

.. automethod:: SCVILocalModule.cpu

.. automethod:: SCVILocalModule.cuda

.. automethod:: SCVILocalModule.double

.. automethod:: SCVILocalModule.eval

.. automethod:: SCVILocalModule.extra_repr

.. automethod:: SCVILocalModule.float

.. automethod:: SCVILocalModule.forward

.. automethod:: SCVILocalModule.freeze

.. automethod:: SCVILocalModule.from_config

.. automethod:: SCVILocalModule.get_buffer

.. automethod:: SCVILocalModule.get_extra_state

.. automethod:: SCVILocalModule.get_local_embeddings

.. automethod:: SCVILocalModule.get_model_summary

.. automethod:: SCVILocalModule.get_parameter

.. automethod:: SCVILocalModule.get_submodule

.. automethod:: SCVILocalModule.half

.. automethod:: SCVILocalModule.ipu

.. automethod:: SCVILocalModule.load_from_checkpoint

.. automethod:: SCVILocalModule.load_state_dict

.. automethod:: SCVILocalModule.log

.. automethod:: SCVILocalModule.log_dict

.. automethod:: SCVILocalModule.loss_kl

.. automethod:: SCVILocalModule.lr_scheduler_step

.. automethod:: SCVILocalModule.lr_schedulers

.. automethod:: SCVILocalModule.manual_backward

.. automethod:: SCVILocalModule.modules

.. automethod:: SCVILocalModule.mtia

.. automethod:: SCVILocalModule.named_buffers

.. automethod:: SCVILocalModule.named_children

.. automethod:: SCVILocalModule.named_modules

.. automethod:: SCVILocalModule.named_parameters

.. automethod:: SCVILocalModule.on_after_backward

.. automethod:: SCVILocalModule.on_after_batch_transfer

.. automethod:: SCVILocalModule.on_before_backward

.. automethod:: SCVILocalModule.on_before_batch_transfer

.. automethod:: SCVILocalModule.on_before_optimizer_step

.. automethod:: SCVILocalModule.on_before_zero_grad

.. automethod:: SCVILocalModule.on_fit_end

.. automethod:: SCVILocalModule.on_fit_start

.. automethod:: SCVILocalModule.on_load_checkpoint

.. automethod:: SCVILocalModule.on_predict_batch_end

.. automethod:: SCVILocalModule.on_predict_batch_start

.. automethod:: SCVILocalModule.on_predict_end

.. automethod:: SCVILocalModule.on_predict_epoch_end

.. automethod:: SCVILocalModule.on_predict_epoch_start

.. automethod:: SCVILocalModule.on_predict_model_eval

.. automethod:: SCVILocalModule.on_predict_start

.. automethod:: SCVILocalModule.on_save_checkpoint

.. automethod:: SCVILocalModule.on_test_batch_end

.. automethod:: SCVILocalModule.on_test_batch_start

.. automethod:: SCVILocalModule.on_test_end

.. automethod:: SCVILocalModule.on_test_epoch_end

.. automethod:: SCVILocalModule.on_test_epoch_start

.. automethod:: SCVILocalModule.on_test_model_eval

.. automethod:: SCVILocalModule.on_test_model_train

.. automethod:: SCVILocalModule.on_test_start

.. automethod:: SCVILocalModule.on_train_batch_end

.. automethod:: SCVILocalModule.on_train_batch_start

.. automethod:: SCVILocalModule.on_train_end

.. automethod:: SCVILocalModule.on_train_epoch_end

.. automethod:: SCVILocalModule.on_train_epoch_start

.. automethod:: SCVILocalModule.on_train_start

.. automethod:: SCVILocalModule.on_validation_batch_end

.. automethod:: SCVILocalModule.on_validation_batch_start

.. automethod:: SCVILocalModule.on_validation_end

.. automethod:: SCVILocalModule.on_validation_epoch_end

.. automethod:: SCVILocalModule.on_validation_epoch_start

.. automethod:: SCVILocalModule.on_validation_model_eval

.. automethod:: SCVILocalModule.on_validation_model_train

.. automethod:: SCVILocalModule.on_validation_model_zero_grad

.. automethod:: SCVILocalModule.on_validation_start

.. automethod:: SCVILocalModule.optimizer_step

.. automethod:: SCVILocalModule.optimizer_zero_grad

.. automethod:: SCVILocalModule.optimizers

.. automethod:: SCVILocalModule.parameters

.. automethod:: SCVILocalModule.predict

.. automethod:: SCVILocalModule.predict_dataloader

.. automethod:: SCVILocalModule.predict_step

.. automethod:: SCVILocalModule.prepare_data

.. automethod:: SCVILocalModule.print

.. automethod:: SCVILocalModule.register_backward_hook

.. automethod:: SCVILocalModule.register_buffer

.. automethod:: SCVILocalModule.register_forward_hook

.. automethod:: SCVILocalModule.register_forward_pre_hook

.. automethod:: SCVILocalModule.register_full_backward_hook

.. automethod:: SCVILocalModule.register_full_backward_pre_hook

.. automethod:: SCVILocalModule.register_load_state_dict_post_hook

.. automethod:: SCVILocalModule.register_load_state_dict_pre_hook

.. automethod:: SCVILocalModule.register_module

.. automethod:: SCVILocalModule.register_parameter

.. automethod:: SCVILocalModule.register_state_dict_post_hook

.. automethod:: SCVILocalModule.register_state_dict_pre_hook

.. automethod:: SCVILocalModule.remove_ignored_hparams

.. automethod:: SCVILocalModule.requires_grad_

.. automethod:: SCVILocalModule.save_hyperparameters

.. automethod:: SCVILocalModule.set_extra_state

.. automethod:: SCVILocalModule.set_submodule

.. automethod:: SCVILocalModule.setup

.. automethod:: SCVILocalModule.share_memory

.. automethod:: SCVILocalModule.state_dict

.. automethod:: SCVILocalModule.teardown

.. automethod:: SCVILocalModule.test_dataloader

.. automethod:: SCVILocalModule.test_step

.. automethod:: SCVILocalModule.to

.. automethod:: SCVILocalModule.to_empty

.. automethod:: SCVILocalModule.to_onnx

.. automethod:: SCVILocalModule.to_tensorrt

.. automethod:: SCVILocalModule.to_torchscript

.. automethod:: SCVILocalModule.toggle_optimizer

.. automethod:: SCVILocalModule.toggled_optimizer

.. automethod:: SCVILocalModule.train

.. automethod:: SCVILocalModule.train_dataloader

.. automethod:: SCVILocalModule.training_step

.. automethod:: SCVILocalModule.transfer_batch_to_device

.. automethod:: SCVILocalModule.type

.. automethod:: SCVILocalModule.unfreeze

.. automethod:: SCVILocalModule.untoggle_optimizer

.. automethod:: SCVILocalModule.val_dataloader

.. automethod:: SCVILocalModule.validation_step

.. automethod:: SCVILocalModule.xpu

.. automethod:: SCVILocalModule.zero_grad