﻿topomics.models.MultimodalAmortizedLDA
======================================

.. currentmodule:: topomics.models

.. add toctree option to make autodoc generate the pages

.. autoclass:: MultimodalAmortizedLDA



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

.. autosummary::

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





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

.. autosummary::

    ~MultimodalAmortizedLDA.check_input
    ~MultimodalAmortizedLDA.check_modalities_names
    ~MultimodalAmortizedLDA.clear_metric_cache
    ~MultimodalAmortizedLDA.convert_legacy_save
    ~MultimodalAmortizedLDA.cross_modality_score
    ~MultimodalAmortizedLDA.data_registry
    ~MultimodalAmortizedLDA.deregister_manager
    ~MultimodalAmortizedLDA.differential_abundance
    ~MultimodalAmortizedLDA.fit
    ~MultimodalAmortizedLDA.from_data
    ~MultimodalAmortizedLDA.from_mudata
    ~MultimodalAmortizedLDA.get_anndata_manager
    ~MultimodalAmortizedLDA.get_cell_entropy
    ~MultimodalAmortizedLDA.get_cell_topic_dist
    ~MultimodalAmortizedLDA.get_elbo
    ~MultimodalAmortizedLDA.get_entropy
    ~MultimodalAmortizedLDA.get_entropy_weight
    ~MultimodalAmortizedLDA.get_feature_topic_dist
    ~MultimodalAmortizedLDA.get_from_registry
    ~MultimodalAmortizedLDA.get_last_entropy
    ~MultimodalAmortizedLDA.get_last_topic_variance
    ~MultimodalAmortizedLDA.get_latent_representation
    ~MultimodalAmortizedLDA.get_learned_dispersion
    ~MultimodalAmortizedLDA.get_likelihood_per_modality
    ~MultimodalAmortizedLDA.get_likelihood_weights
    ~MultimodalAmortizedLDA.get_modality_weights
    ~MultimodalAmortizedLDA.get_normalized_expression
    ~MultimodalAmortizedLDA.get_perplexity
    ~MultimodalAmortizedLDA.get_perplexity_per_modality
    ~MultimodalAmortizedLDA.get_setup_arg
    ~MultimodalAmortizedLDA.get_state_registry
    ~MultimodalAmortizedLDA.get_top_features_per_topic
    ~MultimodalAmortizedLDA.get_topic_diversity
    ~MultimodalAmortizedLDA.get_topic_variance
    ~MultimodalAmortizedLDA.get_topic_variance_weight
    ~MultimodalAmortizedLDA.get_var_names
    ~MultimodalAmortizedLDA.load
    ~MultimodalAmortizedLDA.load_registry
    ~MultimodalAmortizedLDA.predict
    ~MultimodalAmortizedLDA.register_manager
    ~MultimodalAmortizedLDA.save
    ~MultimodalAmortizedLDA.setup_adata_dict
    ~MultimodalAmortizedLDA.setup_anndata
    ~MultimodalAmortizedLDA.setup_data
    ~MultimodalAmortizedLDA.setup_mudata
    ~MultimodalAmortizedLDA.setup_spatialdata
    ~MultimodalAmortizedLDA.to_device
    ~MultimodalAmortizedLDA.train
    ~MultimodalAmortizedLDA.transfer_fields
    ~MultimodalAmortizedLDA.update_setup_method_args
    ~MultimodalAmortizedLDA.view_anndata_setup
    ~MultimodalAmortizedLDA.view_registry
    ~MultimodalAmortizedLDA.view_setup_args
    ~MultimodalAmortizedLDA.view_setup_method_args





Attributes
~~~~~~~~~~



.. autoattribute:: MultimodalAmortizedLDA.adata

.. autoattribute:: MultimodalAmortizedLDA.adata_manager

.. autoattribute:: MultimodalAmortizedLDA.device

.. autoattribute:: MultimodalAmortizedLDA.get_normalized_function_name

.. autoattribute:: MultimodalAmortizedLDA.history

.. autoattribute:: MultimodalAmortizedLDA.is_trained

.. autoattribute:: MultimodalAmortizedLDA.registry

.. autoattribute:: MultimodalAmortizedLDA.run_id

.. autoattribute:: MultimodalAmortizedLDA.run_name

.. autoattribute:: MultimodalAmortizedLDA.spatial

.. autoattribute:: MultimodalAmortizedLDA.summary_string

.. autoattribute:: MultimodalAmortizedLDA.test_indices

.. autoattribute:: MultimodalAmortizedLDA.train_indices

.. autoattribute:: MultimodalAmortizedLDA.validation_indices






Methods
~~~~~~~



.. automethod:: MultimodalAmortizedLDA.check_input

.. automethod:: MultimodalAmortizedLDA.check_modalities_names

.. automethod:: MultimodalAmortizedLDA.clear_metric_cache

.. automethod:: MultimodalAmortizedLDA.convert_legacy_save

.. automethod:: MultimodalAmortizedLDA.cross_modality_score

.. automethod:: MultimodalAmortizedLDA.data_registry

.. automethod:: MultimodalAmortizedLDA.deregister_manager

.. automethod:: MultimodalAmortizedLDA.differential_abundance

.. automethod:: MultimodalAmortizedLDA.fit

.. automethod:: MultimodalAmortizedLDA.from_data

.. automethod:: MultimodalAmortizedLDA.from_mudata

.. automethod:: MultimodalAmortizedLDA.get_anndata_manager

.. automethod:: MultimodalAmortizedLDA.get_cell_entropy

.. automethod:: MultimodalAmortizedLDA.get_cell_topic_dist

.. automethod:: MultimodalAmortizedLDA.get_elbo

.. automethod:: MultimodalAmortizedLDA.get_entropy

.. automethod:: MultimodalAmortizedLDA.get_entropy_weight

.. automethod:: MultimodalAmortizedLDA.get_feature_topic_dist

.. automethod:: MultimodalAmortizedLDA.get_from_registry

.. automethod:: MultimodalAmortizedLDA.get_last_entropy

.. automethod:: MultimodalAmortizedLDA.get_last_topic_variance

.. automethod:: MultimodalAmortizedLDA.get_latent_representation

.. automethod:: MultimodalAmortizedLDA.get_learned_dispersion

.. automethod:: MultimodalAmortizedLDA.get_likelihood_per_modality

.. automethod:: MultimodalAmortizedLDA.get_likelihood_weights

.. automethod:: MultimodalAmortizedLDA.get_modality_weights

.. automethod:: MultimodalAmortizedLDA.get_normalized_expression

.. automethod:: MultimodalAmortizedLDA.get_perplexity

.. automethod:: MultimodalAmortizedLDA.get_perplexity_per_modality

.. automethod:: MultimodalAmortizedLDA.get_setup_arg

.. automethod:: MultimodalAmortizedLDA.get_state_registry

.. automethod:: MultimodalAmortizedLDA.get_top_features_per_topic

.. automethod:: MultimodalAmortizedLDA.get_topic_diversity

.. automethod:: MultimodalAmortizedLDA.get_topic_variance

.. automethod:: MultimodalAmortizedLDA.get_topic_variance_weight

.. automethod:: MultimodalAmortizedLDA.get_var_names

.. automethod:: MultimodalAmortizedLDA.load

.. automethod:: MultimodalAmortizedLDA.load_registry

.. automethod:: MultimodalAmortizedLDA.predict

.. automethod:: MultimodalAmortizedLDA.register_manager

.. automethod:: MultimodalAmortizedLDA.save

.. automethod:: MultimodalAmortizedLDA.setup_adata_dict

.. automethod:: MultimodalAmortizedLDA.setup_anndata

.. automethod:: MultimodalAmortizedLDA.setup_data

.. automethod:: MultimodalAmortizedLDA.setup_mudata

.. automethod:: MultimodalAmortizedLDA.setup_spatialdata

.. automethod:: MultimodalAmortizedLDA.to_device

.. automethod:: MultimodalAmortizedLDA.train

.. automethod:: MultimodalAmortizedLDA.transfer_fields

.. automethod:: MultimodalAmortizedLDA.update_setup_method_args

.. automethod:: MultimodalAmortizedLDA.view_anndata_setup

.. automethod:: MultimodalAmortizedLDA.view_registry

.. automethod:: MultimodalAmortizedLDA.view_setup_args

.. automethod:: MultimodalAmortizedLDA.view_setup_method_args


