.. |figCL| image:: ../figs/logo_large_3.png

.. table::
   :align: center
   :width: 100%

   +---------+
   | |figCL| |
   +---------+

|python| |pypi| |docs| |stars| |LOC| |downloads_month| |downloads_total| |license| |forks| |open issues| |project status| |medium| |colab| |DOI| |repo-size| |donate|


-----------------------------------

``clusteval`` is a python package for unsupervised cluster evaluation. Three evaluation methods, **Silhouette**, **DBindex**, and **Derivative** are implemented that can be used to evalute clusterings for four clustering methods *agglomerative*, *kmeans*, *dbscan* and *hdbscan*.


.. note::
	`Medium Blog: A step-by-step guide for clustering images <https://towardsdatascience.com/a-step-by-step-guide-for-clustering-images-4b45f9906128>`_

.. note::
	`Medium Blog: Detection of Duplicate Images Using Image Hash Functions <https://towardsdatascience.com/detection-of-duplicate-images-using-image-hash-functions-4d9c53f04a75>`_



-----------------------------------

.. note::
	**Your ❤️ is important to keep maintaining this package.** You can `support <https://erdogant.github.io/clusteval/pages/html/Documentation.html>`_ in various ways, have a look at the `sponser page <https://erdogant.github.io/clusteval/pages/html/Documentation.html>`_.
	Report bugs, issues and feature extensions at `github <https://github.com/erdogant/clusteval/>`_ page.

	.. code-block:: console

	   pip install clusteval

-----------------------------------

.. _schematic_overview:

.. figure:: ../figs/cluster.png

-----------------------------------


Content
=======

.. toctree::
   :maxdepth: 1
   :caption: Background
   
   Abstract


.. toctree::
   :maxdepth: 1
   :caption: Installation
   
   Installation


.. toctree::
  :maxdepth: 1
  :caption: Evaluation Methods

  Cluster Evaluation


.. toctree::
  :maxdepth: 1
  :caption: Plots

  Plots


.. toctree::
  :maxdepth: 1
  :caption: Examples

  Examples


.. toctree::
  :maxdepth: 1
  :caption: Save and Load

  Save and Load
  

.. toctree::
  :maxdepth: 1
  :caption: Documentation
  
  Documentation
  Coding quality
  clusteval.clusteval




Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`


.. |python| image:: https://img.shields.io/pypi/pyversions/clusteval.svg
    :alt: |Python
    :target: https://erdogant.github.io/clusteval/

.. |pypi| image:: https://img.shields.io/pypi/v/clusteval.svg
    :alt: |Python Version
    :target: https://pypi.org/project/clusteval/

.. |docs| image:: https://img.shields.io/badge/Sphinx-Docs-blue.svg
    :alt: Sphinx documentation
    :target: https://erdogant.github.io/clusteval/

.. |stars| image:: https://img.shields.io/github/stars/erdogant/clusteval
    :alt: Stars
    :target: https://img.shields.io/github/stars/erdogant/clusteval

.. |LOC| image:: https://sloc.xyz/github/erdogant/clusteval/?category=code
    :alt: lines of code
    :target: https://github.com/erdogant/clusteval

.. |downloads_month| image:: https://static.pepy.tech/personalized-badge/clusteval?period=month&units=international_system&left_color=grey&right_color=brightgreen&left_text=PyPI%20downloads/month
    :alt: Downloads per month
    :target: https://pepy.tech/project/clusteval

.. |downloads_total| image:: https://static.pepy.tech/personalized-badge/clusteval?period=total&units=international_system&left_color=grey&right_color=brightgreen&left_text=Downloads
    :alt: Downloads in total
    :target: https://pepy.tech/project/clusteval

.. |license| image:: https://img.shields.io/badge/license-MIT-green.svg
    :alt: License
    :target: https://github.com/erdogant/clusteval/blob/master/LICENSE

.. |forks| image:: https://img.shields.io/github/forks/erdogant/clusteval.svg
    :alt: Github Forks
    :target: https://github.com/erdogant/clusteval/network

.. |open issues| image:: https://img.shields.io/github/issues/erdogant/clusteval.svg
    :alt: Open Issues
    :target: https://github.com/erdogant/clusteval/issues

.. |project status| image:: http://www.repostatus.org/badges/latest/active.svg
    :alt: Project Status
    :target: http://www.repostatus.org/#active

.. |medium| image:: https://img.shields.io/badge/Medium-Blog-green.svg
    :alt: Medium Blog
    :target: https://erdogant.github.io/clusteval/pages/html/Documentation.html#medium-blog

.. |donate| image:: https://img.shields.io/badge/Support%20this%20project-grey.svg?logo=github%20sponsors
    :alt: donate
    :target: https://erdogant.github.io/clusteval/pages/html/Documentation.html#

.. |colab| image:: https://colab.research.google.com/assets/colab-badge.svg
    :alt: Colab example
    :target: https://erdogant.github.io/clusteval/pages/html/Documentation.html#colab-notebook

.. |DOI| image:: https://zenodo.org/badge/232915924.svg
    :alt: Cite
    :target: https://zenodo.org/badge/latestdoi/232915924

.. |repo-size| image:: https://img.shields.io/github/repo-size/erdogant/clusteval
    :alt: repo-size
    :target: https://img.shields.io/github/repo-size/erdogant/clusteval


.. include:: add_bottom.add