=============
API Reference
=============

.. currentmodule:: clusx

The ``clusx`` module
=====================

.. automodule:: clusx
    :members:
    :special-members:
    :no-undoc-members:

The ``__main__`` module
-----------------------

.. automodule:: clusx.__main__
    :members:
    :no-undoc-members:

The ``cli`` module
------------------

.. automodule:: clusx.cli
    :members:
    :no-undoc-members:

The ``errors`` module
---------------------

.. automodule:: clusx.errors
    :members:
    :no-undoc-members:

The ``evaluation`` module
-------------------------

.. automodule:: clusx.evaluation
    :members:
    :no-undoc-members:

The ``logging`` module
----------------------

.. automodule:: clusx.logging
    :members:
    :no-undoc-members:

The ``utils`` module
--------------------

.. automodule:: clusx.utils
    :members:
    :no-undoc-members:

The ``version`` module
----------------------

.. automodule:: clusx.version
    :members:
    :special-members:
    :no-undoc-members:

The ``visualization`` module
----------------------------

.. automodule:: clusx.visualization
    :members:
    :special-members:
    :no-undoc-members:

.. currentmodule:: clusx.clustering

The ``clustering`` module
=========================

The ``models`` module
---------------------

.. automodule:: clusx.clustering.models
    :members:
    :special-members:
    :no-undoc-members:

The ``utils`` module
---------------------

.. automodule:: clusx.clustering.utils
    :members:
    :no-undoc-members: