scvi.train.TrainingPlan
=======================

.. currentmodule:: scvi.train

.. add toctree option to make autodoc generate the pages

.. autoclass:: TrainingPlan
   :show-inheritance:



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

.. autosummary::

        ~TrainingPlan.kl_weight
        ~TrainingPlan.n_obs_training
        ~TrainingPlan.n_obs_validation
        ~TrainingPlan.use_sync_dist
        ~TrainingPlan.training






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

.. autosummary::

    ~TrainingPlan.compute_and_log_metrics
    ~TrainingPlan.configure_optimizers
    ~TrainingPlan.forward
    ~TrainingPlan.get_optimizer_creator
    ~TrainingPlan.initialize_train_metrics
    ~TrainingPlan.initialize_val_metrics
    ~TrainingPlan.on_train_end
    ~TrainingPlan.prepare_scib_autotune
    ~TrainingPlan.training_step
    ~TrainingPlan.validation_step





Attributes
~~~~~~~~~~



.. autoattribute:: TrainingPlan.kl_weight

.. autoattribute:: TrainingPlan.n_obs_training

.. autoattribute:: TrainingPlan.n_obs_validation

.. autoattribute:: TrainingPlan.use_sync_dist

.. autoattribute:: TrainingPlan.training






Methods
~~~~~~~



.. automethod:: TrainingPlan.compute_and_log_metrics

.. automethod:: TrainingPlan.configure_optimizers

.. automethod:: TrainingPlan.forward

.. automethod:: TrainingPlan.get_optimizer_creator

.. automethod:: TrainingPlan.initialize_train_metrics

.. automethod:: TrainingPlan.initialize_val_metrics

.. automethod:: TrainingPlan.on_train_end

.. automethod:: TrainingPlan.prepare_scib_autotune

.. automethod:: TrainingPlan.training_step

.. automethod:: TrainingPlan.validation_step