Welcome to SuSi's documentation!
================================

We present the SuSi package for Python.
It includes a fully functional SOM for unsupervised, supervised and semi-supervised tasks.

:License:
    `3-Clause BSD license <https://github.com/felixriese/susi/blob/main/LICENSE>`_

:Author:
    `Felix M. Riese <mailto:github@felixriese.de>`_

:Citation: see `Citation <citation.html>`_ and in the `bibtex <https://github.com/felixriese/susi/blob/main/bibliography.bib>`_ file

:Paper:
    `F. M. Riese, S. Keller and S. Hinz in Remote Sensing, 2020 <https://www.mdpi.com/2072-4292/12/1/7>`_


.. toctree::
   :maxdepth: 1

   Home <self>

   Changelog <changelog.rst>

   Citation <citation.rst>

   Installation <install.rst>

   Examples <examples.rst>

   Hyperparameters <hyperparameters.rst>

   FAQs <faqs.rst>

.. toctree::
   :maxdepth: 1
   :caption: Code:

    SOMClustering <SOMClustering.rst>

    SOMRegressor <SOMRegressor.rst>

    SOMClassifier <SOMClassifier.rst>

    SOMPlots <SOMPlots.rst>

    SOMUtils <SOMUtils.rst>