sccoral.model.SCCORAL
=====================

.. currentmodule:: sccoral.model

.. add toctree option to make autodoc generate the pages

.. autoclass:: SCCORAL



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

.. autosummary::

    ~sccoral.model.SCCORAL.adata
    ~sccoral.model.SCCORAL.adata_manager
    ~sccoral.model.SCCORAL.device
    ~sccoral.model.SCCORAL.history
    ~sccoral.model.SCCORAL.is_trained
    ~sccoral.model.SCCORAL.summary_string
    ~sccoral.model.SCCORAL.test_indices
    ~sccoral.model.SCCORAL.train_indices
    ~sccoral.model.SCCORAL.validation_indices





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

.. autosummary::

    ~sccoral.model.SCCORAL.convert_legacy_save
    ~sccoral.model.SCCORAL.deregister_manager
    ~sccoral.model.SCCORAL.get_anndata_manager
    ~sccoral.model.SCCORAL.get_elbo
    ~sccoral.model.SCCORAL.get_explained_variance_per_factor
    ~sccoral.model.SCCORAL.get_from_registry
    ~sccoral.model.SCCORAL.get_latent_representation
    ~sccoral.model.SCCORAL.get_loadings
    ~sccoral.model.SCCORAL.get_marginal_ll
    ~sccoral.model.SCCORAL.get_reconstruction_error
    ~sccoral.model.SCCORAL.load
    ~sccoral.model.SCCORAL.load_registry
    ~sccoral.model.SCCORAL.register_manager
    ~sccoral.model.SCCORAL.save
    ~sccoral.model.SCCORAL.setup_anndata
    ~sccoral.model.SCCORAL.to_device
    ~sccoral.model.SCCORAL.train
    ~sccoral.model.SCCORAL.view_anndata_setup
    ~sccoral.model.SCCORAL.view_setup_args





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



.. autoattribute:: SCCORAL.adata

.. autoattribute:: SCCORAL.adata_manager

.. autoattribute:: SCCORAL.device

.. autoattribute:: SCCORAL.history

.. autoattribute:: SCCORAL.is_trained

.. autoattribute:: SCCORAL.summary_string

.. autoattribute:: SCCORAL.test_indices

.. autoattribute:: SCCORAL.train_indices

.. autoattribute:: SCCORAL.validation_indices






Methods
~~~~~~~



.. automethod:: SCCORAL.convert_legacy_save

.. automethod:: SCCORAL.deregister_manager

.. automethod:: SCCORAL.get_anndata_manager

.. automethod:: SCCORAL.get_elbo

.. automethod:: SCCORAL.get_explained_variance_per_factor

.. automethod:: SCCORAL.get_from_registry

.. automethod:: SCCORAL.get_latent_representation

.. automethod:: SCCORAL.get_loadings

.. automethod:: SCCORAL.get_marginal_ll

.. automethod:: SCCORAL.get_reconstruction_error

.. automethod:: SCCORAL.load

.. automethod:: SCCORAL.load_registry

.. automethod:: SCCORAL.register_manager

.. automethod:: SCCORAL.save

.. automethod:: SCCORAL.setup_anndata

.. automethod:: SCCORAL.to_device

.. automethod:: SCCORAL.train

.. automethod:: SCCORAL.view_anndata_setup

.. automethod:: SCCORAL.view_setup_args