Modules
=======

Neural network modules implementing VAE components.

Core Modules
------------

SpatialVAEModule
~~~~~~~~~~~~~~~~

.. autoclass:: spatialvi.module.SpatialVAEModule
   :members:
   :undoc-members:
   :show-inheritance:

External Modules
----------------

AMICIModule
~~~~~~~~~~~

.. autoclass:: spatialvi.external.amici.AMICIModule
   :members:
   :undoc-members:
   :show-inheritance:

MRDeconv (DestVI)
~~~~~~~~~~~~~~~~~

.. autoclass:: spatialvi.external.destvi.MRDeconv
   :members:
   :undoc-members:
   :show-inheritance:

HarremanModule
~~~~~~~~~~~~~~

.. autoclass:: spatialvi.external.harreman.HarremanModule
   :members:
   :undoc-members:
   :show-inheritance:

MetabolicExchangeScorer
~~~~~~~~~~~~~~~~~~~~~~~

.. autoclass:: spatialvi.external.harreman.MetabolicExchangeScorer
   :members:
   :undoc-members:
   :show-inheritance:

LambdaAnnotator
~~~~~~~~~~~~~~~

.. autoclass:: spatialvi.external.lambda_model.LambdaAnnotator
   :members:
   :undoc-members:
   :show-inheritance:

NolanModule
~~~~~~~~~~~

.. autoclass:: spatialvi.external.nolan.NolanModule
   :members:
   :undoc-members:
   :show-inheritance:

NicheClusteringHead
~~~~~~~~~~~~~~~~~~~

.. autoclass:: spatialvi.external.nolan.NicheClusteringHead
   :members:
   :undoc-members:
   :show-inheritance:

MeanEstimator (PPI)
~~~~~~~~~~~~~~~~~~~

.. autoclass:: spatialvi.external.ppi.MeanEstimator
   :members:
   :undoc-members:
   :show-inheritance:

OLSEstimator (PPI)
~~~~~~~~~~~~~~~~~~

.. autoclass:: spatialvi.external.ppi.OLSEstimator
   :members:
   :undoc-members:
   :show-inheritance:

RESOLVAE
~~~~~~~~

.. autoclass:: spatialvi.external.resolvi.RESOLVAE
   :members:
   :undoc-members:
   :show-inheritance:

nicheVAE (scVIVA)
~~~~~~~~~~~~~~~~~

.. autoclass:: spatialvi.external.scviva.nicheVAE
   :members:
   :undoc-members:
   :show-inheritance:

SPARLModule
~~~~~~~~~~~

.. autoclass:: spatialvi.external.sparl.SPARLModule
   :members:
   :undoc-members:
   :show-inheritance:

StarfyshModule
~~~~~~~~~~~~~~

.. autoclass:: spatialvi.external.starfysh.StarfyshModule
   :members:
   :undoc-members:
   :show-inheritance:

VIVSModule
~~~~~~~~~~

.. autoclass:: spatialvi.external.vivs.VIVSModule
   :members:
   :undoc-members:
   :show-inheritance:

MultiScaleVIVS
~~~~~~~~~~~~~~

.. autoclass:: spatialvi.external.vivs.MultiScaleVIVS
   :members:
   :undoc-members:
   :show-inheritance: