interscale.module.PrecomputedEmbeddingModule
============================================

.. currentmodule:: interscale.module

.. add toctree option to make autodoc generate the pages

.. autoclass:: PrecomputedEmbeddingModule



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

.. autosummary::

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





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

.. autosummary::

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





Attributes
~~~~~~~~~~



.. autoattribute:: PrecomputedEmbeddingModule.CHECKPOINT_HYPER_PARAMS_KEY

.. autoattribute:: PrecomputedEmbeddingModule.CHECKPOINT_HYPER_PARAMS_NAME

.. autoattribute:: PrecomputedEmbeddingModule.CHECKPOINT_HYPER_PARAMS_TYPE

.. autoattribute:: PrecomputedEmbeddingModule.T_destination

.. autoattribute:: PrecomputedEmbeddingModule.automatic_optimization

.. autoattribute:: PrecomputedEmbeddingModule.call_super_init

.. autoattribute:: PrecomputedEmbeddingModule.current_epoch

.. autoattribute:: PrecomputedEmbeddingModule.device

.. autoattribute:: PrecomputedEmbeddingModule.device_mesh

.. autoattribute:: PrecomputedEmbeddingModule.dtype

.. autoattribute:: PrecomputedEmbeddingModule.dump_patches

.. autoattribute:: PrecomputedEmbeddingModule.example_input_array

.. autoattribute:: PrecomputedEmbeddingModule.fabric

.. autoattribute:: PrecomputedEmbeddingModule.global_rank

.. autoattribute:: PrecomputedEmbeddingModule.global_step

.. autoattribute:: PrecomputedEmbeddingModule.hparams

.. autoattribute:: PrecomputedEmbeddingModule.hparams_initial

.. autoattribute:: PrecomputedEmbeddingModule.local_rank

.. autoattribute:: PrecomputedEmbeddingModule.logger

.. autoattribute:: PrecomputedEmbeddingModule.loggers

.. autoattribute:: PrecomputedEmbeddingModule.on_gpu

.. autoattribute:: PrecomputedEmbeddingModule.strict_loading

.. autoattribute:: PrecomputedEmbeddingModule.trainer

.. autoattribute:: PrecomputedEmbeddingModule.training






Methods
~~~~~~~



.. automethod:: PrecomputedEmbeddingModule.add_module

.. automethod:: PrecomputedEmbeddingModule.all_gather

.. automethod:: PrecomputedEmbeddingModule.apply

.. automethod:: PrecomputedEmbeddingModule.backward

.. automethod:: PrecomputedEmbeddingModule.bfloat16

.. automethod:: PrecomputedEmbeddingModule.buffers

.. automethod:: PrecomputedEmbeddingModule.children

.. automethod:: PrecomputedEmbeddingModule.clip_gradients

.. automethod:: PrecomputedEmbeddingModule.compile

.. automethod:: PrecomputedEmbeddingModule.configure_callbacks

.. automethod:: PrecomputedEmbeddingModule.configure_gradient_clipping

.. automethod:: PrecomputedEmbeddingModule.configure_model

.. automethod:: PrecomputedEmbeddingModule.configure_optimizers

.. automethod:: PrecomputedEmbeddingModule.configure_sharded_model

.. automethod:: PrecomputedEmbeddingModule.cpu

.. automethod:: PrecomputedEmbeddingModule.cuda

.. automethod:: PrecomputedEmbeddingModule.double

.. automethod:: PrecomputedEmbeddingModule.eval

.. automethod:: PrecomputedEmbeddingModule.extra_repr

.. automethod:: PrecomputedEmbeddingModule.float

.. automethod:: PrecomputedEmbeddingModule.forward

.. automethod:: PrecomputedEmbeddingModule.freeze

.. automethod:: PrecomputedEmbeddingModule.from_config

.. automethod:: PrecomputedEmbeddingModule.get_buffer

.. automethod:: PrecomputedEmbeddingModule.get_extra_state

.. automethod:: PrecomputedEmbeddingModule.get_local_embeddings

.. automethod:: PrecomputedEmbeddingModule.get_model_summary

.. automethod:: PrecomputedEmbeddingModule.get_parameter

.. automethod:: PrecomputedEmbeddingModule.get_submodule

.. automethod:: PrecomputedEmbeddingModule.half

.. automethod:: PrecomputedEmbeddingModule.ipu

.. automethod:: PrecomputedEmbeddingModule.load_from_checkpoint

.. automethod:: PrecomputedEmbeddingModule.load_state_dict

.. automethod:: PrecomputedEmbeddingModule.log

.. automethod:: PrecomputedEmbeddingModule.log_dict

.. automethod:: PrecomputedEmbeddingModule.lr_scheduler_step

.. automethod:: PrecomputedEmbeddingModule.lr_schedulers

.. automethod:: PrecomputedEmbeddingModule.manual_backward

.. automethod:: PrecomputedEmbeddingModule.modules

.. automethod:: PrecomputedEmbeddingModule.mtia

.. automethod:: PrecomputedEmbeddingModule.named_buffers

.. automethod:: PrecomputedEmbeddingModule.named_children

.. automethod:: PrecomputedEmbeddingModule.named_modules

.. automethod:: PrecomputedEmbeddingModule.named_parameters

.. automethod:: PrecomputedEmbeddingModule.on_after_backward

.. automethod:: PrecomputedEmbeddingModule.on_after_batch_transfer

.. automethod:: PrecomputedEmbeddingModule.on_before_backward

.. automethod:: PrecomputedEmbeddingModule.on_before_batch_transfer

.. automethod:: PrecomputedEmbeddingModule.on_before_optimizer_step

.. automethod:: PrecomputedEmbeddingModule.on_before_zero_grad

.. automethod:: PrecomputedEmbeddingModule.on_fit_end

.. automethod:: PrecomputedEmbeddingModule.on_fit_start

.. automethod:: PrecomputedEmbeddingModule.on_load_checkpoint

.. automethod:: PrecomputedEmbeddingModule.on_predict_batch_end

.. automethod:: PrecomputedEmbeddingModule.on_predict_batch_start

.. automethod:: PrecomputedEmbeddingModule.on_predict_end

.. automethod:: PrecomputedEmbeddingModule.on_predict_epoch_end

.. automethod:: PrecomputedEmbeddingModule.on_predict_epoch_start

.. automethod:: PrecomputedEmbeddingModule.on_predict_model_eval

.. automethod:: PrecomputedEmbeddingModule.on_predict_start

.. automethod:: PrecomputedEmbeddingModule.on_save_checkpoint

.. automethod:: PrecomputedEmbeddingModule.on_test_batch_end

.. automethod:: PrecomputedEmbeddingModule.on_test_batch_start

.. automethod:: PrecomputedEmbeddingModule.on_test_end

.. automethod:: PrecomputedEmbeddingModule.on_test_epoch_end

.. automethod:: PrecomputedEmbeddingModule.on_test_epoch_start

.. automethod:: PrecomputedEmbeddingModule.on_test_model_eval

.. automethod:: PrecomputedEmbeddingModule.on_test_model_train

.. automethod:: PrecomputedEmbeddingModule.on_test_start

.. automethod:: PrecomputedEmbeddingModule.on_train_batch_end

.. automethod:: PrecomputedEmbeddingModule.on_train_batch_start

.. automethod:: PrecomputedEmbeddingModule.on_train_end

.. automethod:: PrecomputedEmbeddingModule.on_train_epoch_end

.. automethod:: PrecomputedEmbeddingModule.on_train_epoch_start

.. automethod:: PrecomputedEmbeddingModule.on_train_start

.. automethod:: PrecomputedEmbeddingModule.on_validation_batch_end

.. automethod:: PrecomputedEmbeddingModule.on_validation_batch_start

.. automethod:: PrecomputedEmbeddingModule.on_validation_end

.. automethod:: PrecomputedEmbeddingModule.on_validation_epoch_end

.. automethod:: PrecomputedEmbeddingModule.on_validation_epoch_start

.. automethod:: PrecomputedEmbeddingModule.on_validation_model_eval

.. automethod:: PrecomputedEmbeddingModule.on_validation_model_train

.. automethod:: PrecomputedEmbeddingModule.on_validation_model_zero_grad

.. automethod:: PrecomputedEmbeddingModule.on_validation_start

.. automethod:: PrecomputedEmbeddingModule.optimizer_step

.. automethod:: PrecomputedEmbeddingModule.optimizer_zero_grad

.. automethod:: PrecomputedEmbeddingModule.optimizers

.. automethod:: PrecomputedEmbeddingModule.parameters

.. automethod:: PrecomputedEmbeddingModule.predict

.. automethod:: PrecomputedEmbeddingModule.predict_dataloader

.. automethod:: PrecomputedEmbeddingModule.predict_step

.. automethod:: PrecomputedEmbeddingModule.prepare_data

.. automethod:: PrecomputedEmbeddingModule.print

.. automethod:: PrecomputedEmbeddingModule.register_backward_hook

.. automethod:: PrecomputedEmbeddingModule.register_buffer

.. automethod:: PrecomputedEmbeddingModule.register_forward_hook

.. automethod:: PrecomputedEmbeddingModule.register_forward_pre_hook

.. automethod:: PrecomputedEmbeddingModule.register_full_backward_hook

.. automethod:: PrecomputedEmbeddingModule.register_full_backward_pre_hook

.. automethod:: PrecomputedEmbeddingModule.register_load_state_dict_post_hook

.. automethod:: PrecomputedEmbeddingModule.register_load_state_dict_pre_hook

.. automethod:: PrecomputedEmbeddingModule.register_module

.. automethod:: PrecomputedEmbeddingModule.register_parameter

.. automethod:: PrecomputedEmbeddingModule.register_state_dict_post_hook

.. automethod:: PrecomputedEmbeddingModule.register_state_dict_pre_hook

.. automethod:: PrecomputedEmbeddingModule.remove_ignored_hparams

.. automethod:: PrecomputedEmbeddingModule.requires_grad_

.. automethod:: PrecomputedEmbeddingModule.save_hyperparameters

.. automethod:: PrecomputedEmbeddingModule.set_extra_state

.. automethod:: PrecomputedEmbeddingModule.set_submodule

.. automethod:: PrecomputedEmbeddingModule.setup

.. automethod:: PrecomputedEmbeddingModule.share_memory

.. automethod:: PrecomputedEmbeddingModule.state_dict

.. automethod:: PrecomputedEmbeddingModule.teardown

.. automethod:: PrecomputedEmbeddingModule.test_dataloader

.. automethod:: PrecomputedEmbeddingModule.test_step

.. automethod:: PrecomputedEmbeddingModule.to

.. automethod:: PrecomputedEmbeddingModule.to_empty

.. automethod:: PrecomputedEmbeddingModule.to_onnx

.. automethod:: PrecomputedEmbeddingModule.to_tensorrt

.. automethod:: PrecomputedEmbeddingModule.to_torchscript

.. automethod:: PrecomputedEmbeddingModule.toggle_optimizer

.. automethod:: PrecomputedEmbeddingModule.toggled_optimizer

.. automethod:: PrecomputedEmbeddingModule.train

.. automethod:: PrecomputedEmbeddingModule.train_dataloader

.. automethod:: PrecomputedEmbeddingModule.training_step

.. automethod:: PrecomputedEmbeddingModule.transfer_batch_to_device

.. automethod:: PrecomputedEmbeddingModule.type

.. automethod:: PrecomputedEmbeddingModule.unfreeze

.. automethod:: PrecomputedEmbeddingModule.untoggle_optimizer

.. automethod:: PrecomputedEmbeddingModule.val_dataloader

.. automethod:: PrecomputedEmbeddingModule.validation_step

.. automethod:: PrecomputedEmbeddingModule.xpu

.. automethod:: PrecomputedEmbeddingModule.zero_grad