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

.. currentmodule:: scvi.train

.. add toctree option to make autodoc generate the pages

.. autoclass:: TrainingPlan
   :show-inheritance:



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

.. autosummary::

        ~scvi.train.TrainingPlan.kl_weight
        ~scvi.train.TrainingPlan.n_obs_training
        ~scvi.train.TrainingPlan.n_obs_validation
        ~scvi.train.TrainingPlan.training






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

.. autosummary::

    ~scvi.train.TrainingPlan.compute_and_log_metrics
    ~scvi.train.TrainingPlan.configure_optimizers
    ~scvi.train.TrainingPlan.forward
    ~scvi.train.TrainingPlan.get_optimizer_creator
    ~scvi.train.TrainingPlan.initialize_train_metrics
    ~scvi.train.TrainingPlan.initialize_val_metrics
    ~scvi.train.TrainingPlan.training_step
    ~scvi.train.TrainingPlan.validation_step





Attributes
~~~~~~~~~~



.. autoattribute:: TrainingPlan.kl_weight

.. autoattribute:: TrainingPlan.n_obs_training

.. autoattribute:: TrainingPlan.n_obs_validation

.. 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.training_step

.. automethod:: TrainingPlan.validation_step