interscale.module.TransformerNodeEncoderHook
============================================

.. currentmodule:: interscale.module

.. add toctree option to make autodoc generate the pages

.. autoclass:: TransformerNodeEncoderHook



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

.. autosummary::

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





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

.. autosummary::

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





Attributes
~~~~~~~~~~



.. autoattribute:: TransformerNodeEncoderHook.CHECKPOINT_HYPER_PARAMS_KEY

.. autoattribute:: TransformerNodeEncoderHook.CHECKPOINT_HYPER_PARAMS_NAME

.. autoattribute:: TransformerNodeEncoderHook.CHECKPOINT_HYPER_PARAMS_TYPE

.. autoattribute:: TransformerNodeEncoderHook.T_destination

.. autoattribute:: TransformerNodeEncoderHook.automatic_optimization

.. autoattribute:: TransformerNodeEncoderHook.call_super_init

.. autoattribute:: TransformerNodeEncoderHook.current_epoch

.. autoattribute:: TransformerNodeEncoderHook.device

.. autoattribute:: TransformerNodeEncoderHook.device_mesh

.. autoattribute:: TransformerNodeEncoderHook.dtype

.. autoattribute:: TransformerNodeEncoderHook.dump_patches

.. autoattribute:: TransformerNodeEncoderHook.example_input_array

.. autoattribute:: TransformerNodeEncoderHook.fabric

.. autoattribute:: TransformerNodeEncoderHook.global_rank

.. autoattribute:: TransformerNodeEncoderHook.global_step

.. autoattribute:: TransformerNodeEncoderHook.hparams

.. autoattribute:: TransformerNodeEncoderHook.hparams_initial

.. autoattribute:: TransformerNodeEncoderHook.local_rank

.. autoattribute:: TransformerNodeEncoderHook.logger

.. autoattribute:: TransformerNodeEncoderHook.loggers

.. autoattribute:: TransformerNodeEncoderHook.on_gpu

.. autoattribute:: TransformerNodeEncoderHook.strict_loading

.. autoattribute:: TransformerNodeEncoderHook.trainer

.. autoattribute:: TransformerNodeEncoderHook.training






Methods
~~~~~~~



.. automethod:: TransformerNodeEncoderHook.add_module

.. automethod:: TransformerNodeEncoderHook.all_gather

.. automethod:: TransformerNodeEncoderHook.apply

.. automethod:: TransformerNodeEncoderHook.backward

.. automethod:: TransformerNodeEncoderHook.bfloat16

.. automethod:: TransformerNodeEncoderHook.buffers

.. automethod:: TransformerNodeEncoderHook.children

.. automethod:: TransformerNodeEncoderHook.clip_gradients

.. automethod:: TransformerNodeEncoderHook.common_step_local_to_global

.. automethod:: TransformerNodeEncoderHook.compile

.. automethod:: TransformerNodeEncoderHook.configure_callbacks

.. automethod:: TransformerNodeEncoderHook.configure_gradient_clipping

.. automethod:: TransformerNodeEncoderHook.configure_model

.. automethod:: TransformerNodeEncoderHook.configure_optimizers

.. automethod:: TransformerNodeEncoderHook.configure_sharded_model

.. automethod:: TransformerNodeEncoderHook.cpu

.. automethod:: TransformerNodeEncoderHook.create_gex_embedding

.. automethod:: TransformerNodeEncoderHook.cuda

.. automethod:: TransformerNodeEncoderHook.double

.. automethod:: TransformerNodeEncoderHook.eval

.. automethod:: TransformerNodeEncoderHook.evaluate

.. automethod:: TransformerNodeEncoderHook.extra_repr

.. automethod:: TransformerNodeEncoderHook.float

.. automethod:: TransformerNodeEncoderHook.forward

.. automethod:: TransformerNodeEncoderHook.freeze

.. automethod:: TransformerNodeEncoderHook.from_config

.. automethod:: TransformerNodeEncoderHook.get_buffer

.. automethod:: TransformerNodeEncoderHook.get_extra_state

.. automethod:: TransformerNodeEncoderHook.get_global_embeddings

.. automethod:: TransformerNodeEncoderHook.get_model_summary

.. automethod:: TransformerNodeEncoderHook.get_parameter

.. automethod:: TransformerNodeEncoderHook.get_submodule

.. automethod:: TransformerNodeEncoderHook.half

.. automethod:: TransformerNodeEncoderHook.ipu

.. automethod:: TransformerNodeEncoderHook.load_from_checkpoint

.. automethod:: TransformerNodeEncoderHook.load_state_dict

.. automethod:: TransformerNodeEncoderHook.log

.. automethod:: TransformerNodeEncoderHook.log_dict

.. automethod:: TransformerNodeEncoderHook.lr_scheduler_step

.. automethod:: TransformerNodeEncoderHook.lr_schedulers

.. automethod:: TransformerNodeEncoderHook.manual_backward

.. automethod:: TransformerNodeEncoderHook.modules

.. automethod:: TransformerNodeEncoderHook.mtia

.. automethod:: TransformerNodeEncoderHook.named_buffers

.. automethod:: TransformerNodeEncoderHook.named_children

.. automethod:: TransformerNodeEncoderHook.named_modules

.. automethod:: TransformerNodeEncoderHook.named_parameters

.. automethod:: TransformerNodeEncoderHook.on_after_backward

.. automethod:: TransformerNodeEncoderHook.on_after_batch_transfer

.. automethod:: TransformerNodeEncoderHook.on_before_backward

.. automethod:: TransformerNodeEncoderHook.on_before_batch_transfer

.. automethod:: TransformerNodeEncoderHook.on_before_optimizer_step

.. automethod:: TransformerNodeEncoderHook.on_before_zero_grad

.. automethod:: TransformerNodeEncoderHook.on_fit_end

.. automethod:: TransformerNodeEncoderHook.on_fit_start

.. automethod:: TransformerNodeEncoderHook.on_load_checkpoint

.. automethod:: TransformerNodeEncoderHook.on_predict_batch_end

.. automethod:: TransformerNodeEncoderHook.on_predict_batch_start

.. automethod:: TransformerNodeEncoderHook.on_predict_end

.. automethod:: TransformerNodeEncoderHook.on_predict_epoch_end

.. automethod:: TransformerNodeEncoderHook.on_predict_epoch_start

.. automethod:: TransformerNodeEncoderHook.on_predict_model_eval

.. automethod:: TransformerNodeEncoderHook.on_predict_start

.. automethod:: TransformerNodeEncoderHook.on_save_checkpoint

.. automethod:: TransformerNodeEncoderHook.on_test_batch_end

.. automethod:: TransformerNodeEncoderHook.on_test_batch_start

.. automethod:: TransformerNodeEncoderHook.on_test_end

.. automethod:: TransformerNodeEncoderHook.on_test_epoch_end

.. automethod:: TransformerNodeEncoderHook.on_test_epoch_start

.. automethod:: TransformerNodeEncoderHook.on_test_model_eval

.. automethod:: TransformerNodeEncoderHook.on_test_model_train

.. automethod:: TransformerNodeEncoderHook.on_test_start

.. automethod:: TransformerNodeEncoderHook.on_train_batch_end

.. automethod:: TransformerNodeEncoderHook.on_train_batch_start

.. automethod:: TransformerNodeEncoderHook.on_train_end

.. automethod:: TransformerNodeEncoderHook.on_train_epoch_end

.. automethod:: TransformerNodeEncoderHook.on_train_epoch_start

.. automethod:: TransformerNodeEncoderHook.on_train_start

.. automethod:: TransformerNodeEncoderHook.on_validation_batch_end

.. automethod:: TransformerNodeEncoderHook.on_validation_batch_start

.. automethod:: TransformerNodeEncoderHook.on_validation_end

.. automethod:: TransformerNodeEncoderHook.on_validation_epoch_end

.. automethod:: TransformerNodeEncoderHook.on_validation_epoch_start

.. automethod:: TransformerNodeEncoderHook.on_validation_model_eval

.. automethod:: TransformerNodeEncoderHook.on_validation_model_train

.. automethod:: TransformerNodeEncoderHook.on_validation_model_zero_grad

.. automethod:: TransformerNodeEncoderHook.on_validation_start

.. automethod:: TransformerNodeEncoderHook.optimizer_step

.. automethod:: TransformerNodeEncoderHook.optimizer_zero_grad

.. automethod:: TransformerNodeEncoderHook.optimizers

.. automethod:: TransformerNodeEncoderHook.parameters

.. automethod:: TransformerNodeEncoderHook.predict

.. automethod:: TransformerNodeEncoderHook.predict_dataloader

.. automethod:: TransformerNodeEncoderHook.predict_step

.. automethod:: TransformerNodeEncoderHook.prepare_data

.. automethod:: TransformerNodeEncoderHook.print

.. automethod:: TransformerNodeEncoderHook.register_backward_hook

.. automethod:: TransformerNodeEncoderHook.register_buffer

.. automethod:: TransformerNodeEncoderHook.register_forward_hook

.. automethod:: TransformerNodeEncoderHook.register_forward_pre_hook

.. automethod:: TransformerNodeEncoderHook.register_full_backward_hook

.. automethod:: TransformerNodeEncoderHook.register_full_backward_pre_hook

.. automethod:: TransformerNodeEncoderHook.register_load_state_dict_post_hook

.. automethod:: TransformerNodeEncoderHook.register_load_state_dict_pre_hook

.. automethod:: TransformerNodeEncoderHook.register_module

.. automethod:: TransformerNodeEncoderHook.register_parameter

.. automethod:: TransformerNodeEncoderHook.register_state_dict_post_hook

.. automethod:: TransformerNodeEncoderHook.register_state_dict_pre_hook

.. automethod:: TransformerNodeEncoderHook.remove_ignored_hparams

.. automethod:: TransformerNodeEncoderHook.requires_grad_

.. automethod:: TransformerNodeEncoderHook.save_hyperparameters

.. automethod:: TransformerNodeEncoderHook.set_extra_state

.. automethod:: TransformerNodeEncoderHook.set_submodule

.. automethod:: TransformerNodeEncoderHook.setup

.. automethod:: TransformerNodeEncoderHook.share_memory

.. automethod:: TransformerNodeEncoderHook.state_dict

.. automethod:: TransformerNodeEncoderHook.teardown

.. automethod:: TransformerNodeEncoderHook.test_dataloader

.. automethod:: TransformerNodeEncoderHook.test_step

.. automethod:: TransformerNodeEncoderHook.to

.. automethod:: TransformerNodeEncoderHook.to_empty

.. automethod:: TransformerNodeEncoderHook.to_onnx

.. automethod:: TransformerNodeEncoderHook.to_tensorrt

.. automethod:: TransformerNodeEncoderHook.to_torchscript

.. automethod:: TransformerNodeEncoderHook.toggle_optimizer

.. automethod:: TransformerNodeEncoderHook.toggled_optimizer

.. automethod:: TransformerNodeEncoderHook.train

.. automethod:: TransformerNodeEncoderHook.train_dataloader

.. automethod:: TransformerNodeEncoderHook.training_step

.. automethod:: TransformerNodeEncoderHook.transfer_batch_to_device

.. automethod:: TransformerNodeEncoderHook.type

.. automethod:: TransformerNodeEncoderHook.unfreeze

.. automethod:: TransformerNodeEncoderHook.untoggle_optimizer

.. automethod:: TransformerNodeEncoderHook.val_dataloader

.. automethod:: TransformerNodeEncoderHook.validation_step

.. automethod:: TransformerNodeEncoderHook.xpu

.. automethod:: TransformerNodeEncoderHook.zero_grad