**********
SUMO modes
**********

.. automodule:: sumo.modes.mode
   :members:

=======
prepare
=======
-----------------
SumoPrepare Class
-----------------

.. automodule:: sumo.modes.prepare.prepare
   :members:

------------------
Similarity Metrics
------------------

.. automodule:: sumo.modes.prepare.similarity
   :members:

===
run
===
-------------
SumoRun Class
-------------

.. automodule:: sumo.modes.run.run
   :members:

-----------
NMF Solvers
-----------

.. automodule:: sumo.modes.run.solver
   :members:

~~~~~~~~~~~~~~~~~
Unsupervised SUMO
~~~~~~~~~~~~~~~~~

.. automodule:: sumo.modes.run.solvers.unsupervised_sumo
   :members:

~~~~~~~~~~~~~~~
Supervised SUMO
~~~~~~~~~~~~~~~

.. automodule:: sumo.modes.run.solvers.supervised_sumo
   :members:

========
evaluate
========
------------------
SumoEvaluate Class
------------------

.. automodule:: sumo.modes.evaluate.evaluate
   :members:

=========
interpret
=========
-------------------
SumoInterpret Class
-------------------

.. automodule:: sumo.modes.interpret.interpret
   :members: