.. PyCVI documentation master file, created by
   sphinx-quickstart on Sun Dec 10 11:51:26 2023.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

.. Main welcoming text
   ---------------------------------------

.. include:: md/welcome_top.md
   :parser: myst_parser.sphinx_

.. Tutorials sections
   ---------------------------------------

.. .. toctree::
..    :maxdepth: 4
..    :caption: Tutorials:

..    md/tutorials.md

.. Tutorials sections
   ---------------------------------------

.. toctree::
   :maxdepth: 4
   :caption: Examples:

   examples/basic_usage
   examples/basic_usage_time_series
   examples/cluster_center
   examples/variation_information
   examples/pdist_cdist
   examples/select_k
   examples/full_example
   examples/cvi_aggregator
   examples/functional_or_OO

.. include:: /examples/examples_reminders.rst

.. Main module section
   ---------------------------------------

Main Modules
----------------------------

All implemented CVIs are available here:

.. autosummary::
   :toctree:
   :nosignatures:
   :caption: Main Features

   pycvi.cvi

High level functions are defined to compute clusterings, compare clusterings and evaluate clusterings:

.. autosummary::
   :toctree:
   :nosignatures:
   :template: function.rst

   pycvi.cluster.generate_all_clusterings
   pycvi.vi.variation_information
   pycvi.compute_scores.compute_all_scores

More low-level functions are defined to perform common operations but that can handle the case of DTW and DBA if working on time-series data:

.. autosummary::
   :nosignatures:
   :template: function.rst

   pycvi.dist.f_pdist
   pycvi.dist.f_cdist
   pycvi.compute_scores.f_inertia
   pycvi.cluster.compute_center
   pycvi.cluster.compute_centers

.. Full API section
   ---------------------------------------

.. include:: api.rst

.. Contribute / Issues, etc.
   ---------------------------------------

.. include:: md/welcome_bottom.md
   :parser: myst_parser.sphinx_

Index
-------------------

* :ref:`genindex`