cellink.ml.DonorMILModel
========================

.. currentmodule:: cellink.ml

.. add toctree option to make autodoc generate the pages

.. autoclass:: DonorMILModel



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

.. autosummary::

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





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

.. autosummary::

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





Attributes
~~~~~~~~~~



.. autoattribute:: DonorMILModel.CHECKPOINT_HYPER_PARAMS_KEY

.. autoattribute:: DonorMILModel.CHECKPOINT_HYPER_PARAMS_NAME

.. autoattribute:: DonorMILModel.CHECKPOINT_HYPER_PARAMS_TYPE

.. autoattribute:: DonorMILModel.T_destination

.. autoattribute:: DonorMILModel.automatic_optimization

.. autoattribute:: DonorMILModel.call_super_init

.. autoattribute:: DonorMILModel.current_epoch

.. autoattribute:: DonorMILModel.device

.. autoattribute:: DonorMILModel.device_mesh

.. autoattribute:: DonorMILModel.dtype

.. autoattribute:: DonorMILModel.dump_patches

.. autoattribute:: DonorMILModel.example_input_array

.. autoattribute:: DonorMILModel.fabric

.. autoattribute:: DonorMILModel.global_rank

.. autoattribute:: DonorMILModel.global_step

.. autoattribute:: DonorMILModel.hparams

.. autoattribute:: DonorMILModel.hparams_initial

.. autoattribute:: DonorMILModel.local_rank

.. autoattribute:: DonorMILModel.logger

.. autoattribute:: DonorMILModel.loggers

.. autoattribute:: DonorMILModel.on_gpu

.. autoattribute:: DonorMILModel.strict_loading

.. autoattribute:: DonorMILModel.trainer

.. autoattribute:: DonorMILModel.training






Methods
~~~~~~~



.. automethod:: DonorMILModel.add_module

.. automethod:: DonorMILModel.all_gather

.. automethod:: DonorMILModel.apply

.. automethod:: DonorMILModel.backward

.. automethod:: DonorMILModel.bfloat16

.. automethod:: DonorMILModel.buffers

.. automethod:: DonorMILModel.children

.. automethod:: DonorMILModel.clip_gradients

.. automethod:: DonorMILModel.compile

.. automethod:: DonorMILModel.configure_callbacks

.. automethod:: DonorMILModel.configure_gradient_clipping

.. automethod:: DonorMILModel.configure_model

.. automethod:: DonorMILModel.configure_optimizers

.. automethod:: DonorMILModel.configure_sharded_model

.. automethod:: DonorMILModel.cpu

.. automethod:: DonorMILModel.cuda

.. automethod:: DonorMILModel.double

.. automethod:: DonorMILModel.eval

.. automethod:: DonorMILModel.extra_repr

.. automethod:: DonorMILModel.float

.. automethod:: DonorMILModel.forward

.. automethod:: DonorMILModel.freeze

.. automethod:: DonorMILModel.get_buffer

.. automethod:: DonorMILModel.get_extra_state

.. automethod:: DonorMILModel.get_parameter

.. automethod:: DonorMILModel.get_submodule

.. automethod:: DonorMILModel.half

.. automethod:: DonorMILModel.ipu

.. automethod:: DonorMILModel.load_from_checkpoint

.. automethod:: DonorMILModel.load_state_dict

.. automethod:: DonorMILModel.log

.. automethod:: DonorMILModel.log_dict

.. automethod:: DonorMILModel.lr_scheduler_step

.. automethod:: DonorMILModel.lr_schedulers

.. automethod:: DonorMILModel.manual_backward

.. automethod:: DonorMILModel.modules

.. automethod:: DonorMILModel.mtia

.. automethod:: DonorMILModel.named_buffers

.. automethod:: DonorMILModel.named_children

.. automethod:: DonorMILModel.named_modules

.. automethod:: DonorMILModel.named_parameters

.. automethod:: DonorMILModel.on_after_backward

.. automethod:: DonorMILModel.on_after_batch_transfer

.. automethod:: DonorMILModel.on_before_backward

.. automethod:: DonorMILModel.on_before_batch_transfer

.. automethod:: DonorMILModel.on_before_optimizer_step

.. automethod:: DonorMILModel.on_before_zero_grad

.. automethod:: DonorMILModel.on_fit_end

.. automethod:: DonorMILModel.on_fit_start

.. automethod:: DonorMILModel.on_load_checkpoint

.. automethod:: DonorMILModel.on_predict_batch_end

.. automethod:: DonorMILModel.on_predict_batch_start

.. automethod:: DonorMILModel.on_predict_end

.. automethod:: DonorMILModel.on_predict_epoch_end

.. automethod:: DonorMILModel.on_predict_epoch_start

.. automethod:: DonorMILModel.on_predict_model_eval

.. automethod:: DonorMILModel.on_predict_start

.. automethod:: DonorMILModel.on_save_checkpoint

.. automethod:: DonorMILModel.on_test_batch_end

.. automethod:: DonorMILModel.on_test_batch_start

.. automethod:: DonorMILModel.on_test_end

.. automethod:: DonorMILModel.on_test_epoch_end

.. automethod:: DonorMILModel.on_test_epoch_start

.. automethod:: DonorMILModel.on_test_model_eval

.. automethod:: DonorMILModel.on_test_model_train

.. automethod:: DonorMILModel.on_test_start

.. automethod:: DonorMILModel.on_train_batch_end

.. automethod:: DonorMILModel.on_train_batch_start

.. automethod:: DonorMILModel.on_train_end

.. automethod:: DonorMILModel.on_train_epoch_end

.. automethod:: DonorMILModel.on_train_epoch_start

.. automethod:: DonorMILModel.on_train_start

.. automethod:: DonorMILModel.on_validation_batch_end

.. automethod:: DonorMILModel.on_validation_batch_start

.. automethod:: DonorMILModel.on_validation_end

.. automethod:: DonorMILModel.on_validation_epoch_end

.. automethod:: DonorMILModel.on_validation_epoch_start

.. automethod:: DonorMILModel.on_validation_model_eval

.. automethod:: DonorMILModel.on_validation_model_train

.. automethod:: DonorMILModel.on_validation_model_zero_grad

.. automethod:: DonorMILModel.on_validation_start

.. automethod:: DonorMILModel.optimizer_step

.. automethod:: DonorMILModel.optimizer_zero_grad

.. automethod:: DonorMILModel.optimizers

.. automethod:: DonorMILModel.parameters

.. automethod:: DonorMILModel.predict_dataloader

.. automethod:: DonorMILModel.predict_step

.. automethod:: DonorMILModel.prepare_data

.. automethod:: DonorMILModel.print

.. automethod:: DonorMILModel.register_backward_hook

.. automethod:: DonorMILModel.register_buffer

.. automethod:: DonorMILModel.register_forward_hook

.. automethod:: DonorMILModel.register_forward_pre_hook

.. automethod:: DonorMILModel.register_full_backward_hook

.. automethod:: DonorMILModel.register_full_backward_pre_hook

.. automethod:: DonorMILModel.register_load_state_dict_post_hook

.. automethod:: DonorMILModel.register_load_state_dict_pre_hook

.. automethod:: DonorMILModel.register_module

.. automethod:: DonorMILModel.register_parameter

.. automethod:: DonorMILModel.register_state_dict_post_hook

.. automethod:: DonorMILModel.register_state_dict_pre_hook

.. automethod:: DonorMILModel.remove_ignored_hparams

.. automethod:: DonorMILModel.requires_grad_

.. automethod:: DonorMILModel.save_hyperparameters

.. automethod:: DonorMILModel.set_extra_state

.. automethod:: DonorMILModel.set_submodule

.. automethod:: DonorMILModel.setup

.. automethod:: DonorMILModel.share_memory

.. automethod:: DonorMILModel.state_dict

.. automethod:: DonorMILModel.teardown

.. automethod:: DonorMILModel.test_dataloader

.. automethod:: DonorMILModel.test_step

.. automethod:: DonorMILModel.to

.. automethod:: DonorMILModel.to_empty

.. automethod:: DonorMILModel.to_onnx

.. automethod:: DonorMILModel.to_tensorrt

.. automethod:: DonorMILModel.to_torchscript

.. automethod:: DonorMILModel.toggle_optimizer

.. automethod:: DonorMILModel.toggled_optimizer

.. automethod:: DonorMILModel.train

.. automethod:: DonorMILModel.train_dataloader

.. automethod:: DonorMILModel.training_step

.. automethod:: DonorMILModel.transfer_batch_to_device

.. automethod:: DonorMILModel.type

.. automethod:: DonorMILModel.unfreeze

.. automethod:: DonorMILModel.untoggle_optimizer

.. automethod:: DonorMILModel.val_dataloader

.. automethod:: DonorMILModel.validation_step

.. automethod:: DonorMILModel.xpu

.. automethod:: DonorMILModel.zero_grad