drvi.model.DRVI
===============

.. currentmodule:: drvi.model

.. add toctree option to make autodoc generate the pages

.. autoclass:: DRVI



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

.. autosummary::

    ~DRVI.adata
    ~DRVI.adata_manager
    ~DRVI.device
    ~DRVI.get_normalized_function_name
    ~DRVI.history
    ~DRVI.is_trained
    ~DRVI.registry
    ~DRVI.run_id
    ~DRVI.run_name
    ~DRVI.summary_string
    ~DRVI.test_indices
    ~DRVI.train_indices
    ~DRVI.validation_indices





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

.. autosummary::

    ~DRVI.calculate_interpretability_scores
    ~DRVI.convert_legacy_save
    ~DRVI.data_registry
    ~DRVI.decode_latent_samples
    ~DRVI.deregister_manager
    ~DRVI.differential_abundance
    ~DRVI.differential_expression
    ~DRVI.generate_sparse_latent_representation
    ~DRVI.get_aggregated_posterior
    ~DRVI.get_anndata_manager
    ~DRVI.get_effect_of_splits_out_of_distribution
    ~DRVI.get_effect_of_splits_within_distribution
    ~DRVI.get_elbo
    ~DRVI.get_feature_correlation_matrix
    ~DRVI.get_from_registry
    ~DRVI.get_importance_weights
    ~DRVI.get_interpretability_scores
    ~DRVI.get_latent_library_size
    ~DRVI.get_latent_representation
    ~DRVI.get_likelihood_parameters
    ~DRVI.get_marginal_ll
    ~DRVI.get_normalized_expression
    ~DRVI.get_reconstruction_effect_of_each_split
    ~DRVI.get_reconstruction_error
    ~DRVI.get_setup_arg
    ~DRVI.get_sparse_latent_representation
    ~DRVI.get_state_registry
    ~DRVI.get_var_names
    ~DRVI.iterate_on_ae_output
    ~DRVI.iterate_on_decoded_latent_samples
    ~DRVI.iterate_on_effect_of_splits_within_distribution
    ~DRVI.iterate_on_encoded_input
    ~DRVI.load
    ~DRVI.load_query_data
    ~DRVI.load_registry
    ~DRVI.plot_interpretability_scores
    ~DRVI.posterior_predictive_sample
    ~DRVI.prepare_query_anndata
    ~DRVI.prepare_query_mudata
    ~DRVI.register_manager
    ~DRVI.save
    ~DRVI.set_latent_dimension_stats
    ~DRVI.setup_anndata
    ~DRVI.to_device
    ~DRVI.train
    ~DRVI.transfer_fields
    ~DRVI.update_setup_method_args
    ~DRVI.view_anndata_setup
    ~DRVI.view_registry
    ~DRVI.view_setup_args
    ~DRVI.view_setup_method_args





Attributes
~~~~~~~~~~



.. autoattribute:: DRVI.adata

.. autoattribute:: DRVI.adata_manager

.. autoattribute:: DRVI.device

.. autoattribute:: DRVI.get_normalized_function_name

.. autoattribute:: DRVI.history

.. autoattribute:: DRVI.is_trained

.. autoattribute:: DRVI.registry

.. autoattribute:: DRVI.run_id

.. autoattribute:: DRVI.run_name

.. autoattribute:: DRVI.summary_string

.. autoattribute:: DRVI.test_indices

.. autoattribute:: DRVI.train_indices

.. autoattribute:: DRVI.validation_indices






Methods
~~~~~~~



.. automethod:: DRVI.calculate_interpretability_scores

.. automethod:: DRVI.convert_legacy_save

.. automethod:: DRVI.data_registry

.. automethod:: DRVI.decode_latent_samples

.. automethod:: DRVI.deregister_manager

.. automethod:: DRVI.differential_abundance

.. automethod:: DRVI.differential_expression

.. automethod:: DRVI.generate_sparse_latent_representation

.. automethod:: DRVI.get_aggregated_posterior

.. automethod:: DRVI.get_anndata_manager

.. automethod:: DRVI.get_effect_of_splits_out_of_distribution

.. automethod:: DRVI.get_effect_of_splits_within_distribution

.. automethod:: DRVI.get_elbo

.. automethod:: DRVI.get_feature_correlation_matrix

.. automethod:: DRVI.get_from_registry

.. automethod:: DRVI.get_importance_weights

.. automethod:: DRVI.get_interpretability_scores

.. automethod:: DRVI.get_latent_library_size

.. automethod:: DRVI.get_latent_representation

.. automethod:: DRVI.get_likelihood_parameters

.. automethod:: DRVI.get_marginal_ll

.. automethod:: DRVI.get_normalized_expression

.. automethod:: DRVI.get_reconstruction_effect_of_each_split

.. automethod:: DRVI.get_reconstruction_error

.. automethod:: DRVI.get_setup_arg

.. automethod:: DRVI.get_sparse_latent_representation

.. automethod:: DRVI.get_state_registry

.. automethod:: DRVI.get_var_names

.. automethod:: DRVI.iterate_on_ae_output

.. automethod:: DRVI.iterate_on_decoded_latent_samples

.. automethod:: DRVI.iterate_on_effect_of_splits_within_distribution

.. automethod:: DRVI.iterate_on_encoded_input

.. automethod:: DRVI.load

.. automethod:: DRVI.load_query_data

.. automethod:: DRVI.load_registry

.. automethod:: DRVI.plot_interpretability_scores

.. automethod:: DRVI.posterior_predictive_sample

.. automethod:: DRVI.prepare_query_anndata

.. automethod:: DRVI.prepare_query_mudata

.. automethod:: DRVI.register_manager

.. automethod:: DRVI.save

.. automethod:: DRVI.set_latent_dimension_stats

.. automethod:: DRVI.setup_anndata

.. automethod:: DRVI.to_device

.. automethod:: DRVI.train

.. automethod:: DRVI.transfer_fields

.. automethod:: DRVI.update_setup_method_args

.. automethod:: DRVI.view_anndata_setup

.. automethod:: DRVI.view_registry

.. automethod:: DRVI.view_setup_args

.. automethod:: DRVI.view_setup_method_args