scvi.train.TrainingPlanConfig
=============================

.. currentmodule:: scvi.train

.. add toctree option to make autodoc generate the pages

.. autoclass:: TrainingPlanConfig



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

.. autosummary::

    ~scvi.train.TrainingPlanConfig.compile
    ~scvi.train.TrainingPlanConfig.compile_kwargs
    ~scvi.train.TrainingPlanConfig.eps
    ~scvi.train.TrainingPlanConfig.lr
    ~scvi.train.TrainingPlanConfig.lr_factor
    ~scvi.train.TrainingPlanConfig.lr_min
    ~scvi.train.TrainingPlanConfig.lr_patience
    ~scvi.train.TrainingPlanConfig.lr_scheduler_metric
    ~scvi.train.TrainingPlanConfig.lr_threshold
    ~scvi.train.TrainingPlanConfig.max_kl_weight
    ~scvi.train.TrainingPlanConfig.min_kl_weight
    ~scvi.train.TrainingPlanConfig.n_epochs_kl_warmup
    ~scvi.train.TrainingPlanConfig.n_steps_kl_warmup
    ~scvi.train.TrainingPlanConfig.on_epoch
    ~scvi.train.TrainingPlanConfig.on_step
    ~scvi.train.TrainingPlanConfig.optimizer
    ~scvi.train.TrainingPlanConfig.optimizer_creator
    ~scvi.train.TrainingPlanConfig.reduce_lr_on_plateau
    ~scvi.train.TrainingPlanConfig.update_only_decoder
    ~scvi.train.TrainingPlanConfig.weight_decay
    ~scvi.train.TrainingPlanConfig.loss_kwargs





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

.. autosummary::

    ~scvi.train.TrainingPlanConfig.to_kwargs





Attributes
~~~~~~~~~~~



.. autoattribute:: TrainingPlanConfig.compile

.. autoattribute:: TrainingPlanConfig.compile_kwargs

.. autoattribute:: TrainingPlanConfig.eps

.. autoattribute:: TrainingPlanConfig.lr

.. autoattribute:: TrainingPlanConfig.lr_factor

.. autoattribute:: TrainingPlanConfig.lr_min

.. autoattribute:: TrainingPlanConfig.lr_patience

.. autoattribute:: TrainingPlanConfig.lr_scheduler_metric

.. autoattribute:: TrainingPlanConfig.lr_threshold

.. autoattribute:: TrainingPlanConfig.max_kl_weight

.. autoattribute:: TrainingPlanConfig.min_kl_weight

.. autoattribute:: TrainingPlanConfig.n_epochs_kl_warmup

.. autoattribute:: TrainingPlanConfig.n_steps_kl_warmup

.. autoattribute:: TrainingPlanConfig.on_epoch

.. autoattribute:: TrainingPlanConfig.on_step

.. autoattribute:: TrainingPlanConfig.optimizer

.. autoattribute:: TrainingPlanConfig.optimizer_creator

.. autoattribute:: TrainingPlanConfig.reduce_lr_on_plateau

.. autoattribute:: TrainingPlanConfig.update_only_decoder

.. autoattribute:: TrainingPlanConfig.weight_decay

.. autoattribute:: TrainingPlanConfig.loss_kwargs






Methods
~~~~~~~



.. automethod:: TrainingPlanConfig.to_kwargs