.. MetaCluster documentation master file, created by
   sphinx-quickstart on Sat May 20 16:59:33 2023.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to MetaCluster's documentation!
=======================================

.. image:: https://img.shields.io/badge/release-1.3.0-yellow.svg
   :target: https://github.com/thieu1995/metacluster/releases

.. image:: https://img.shields.io/pypi/wheel/gensim.svg
   :target: https://pypi.python.org/pypi/metacluster

.. image:: https://badge.fury.io/py/metacluster.svg
   :target: https://badge.fury.io/py/metacluster

.. image:: https://img.shields.io/pypi/pyversions/metacluster.svg
   :target: https://www.python.org/

.. image:: https://img.shields.io/pypi/status/metacluster.svg
   :target: https://img.shields.io/pypi/status/metacluster.svg

.. image:: https://github.com/thieu1995/metacluster/actions/workflows/publish-package.yaml/badge.svg
   :target: https://github.com/thieu1995/metacluster/actions/workflows/publish-package.yaml

.. image:: https://static.pepy.tech/badge/MetaCluster
   :target: https://pepy.tech/project/MetaCluster

.. image:: https://img.shields.io/github/release-date/thieu1995/metacluster.svg
   :target: https://img.shields.io/github/release-date/thieu1995/metacluster.svg

.. image:: https://readthedocs.org/projects/metacluster/badge/?version=latest
   :target: https://metacluster.readthedocs.io/en/latest/?badge=latest

.. image:: https://img.shields.io/badge/Chat-on%20Telegram-blue
   :target: https://t.me/+fRVCJGuGJg1mNDg1

.. image:: https://img.shields.io/github/contributors/thieu1995/metacluster.svg
   :target: https://img.shields.io/github/contributors/thieu1995/metacluster.svg

.. image:: https://img.shields.io/badge/PR-Welcome-%23FF8300.svg?
   :target: https://git-scm.com/book/en/v2/GitHub-Contributing-to-a-Project

.. image:: https://zenodo.org/badge/545209353.svg
   :target: https://doi.org/10.5281/zenodo.7969042

.. image:: https://img.shields.io/badge/License-GPLv3-blue.svg
   :target: https://www.gnu.org/licenses/gpl-3.0


MetaCluster is the largest open-source nature-inspired optimization (Metaheuristic Algorithms) library for
clustering problem in Python

* **Free software:** GNU General Public License (GPL) V3 license
* **Total nature-inspired metaheuristic optimizers (Metaheuristic Algorithms)**: > 200 optimizers
* **Total objective functions (as fitness)**: > 40 objectives
* **Total supported datasets**: 48 datasets from Scikit learn, UCI, ELKI, KEEL...
* **Total performance metrics**: > 40 metrics
* **Total different way of detecting the K value**: >= 10 methods
* **Documentation:** https://metacluster.readthedocs.io/en/latest/
* **Python versions:** >= 3.7.x
* **Dependencies:** numpy, scipy, scikit-learn, pandas, mealpy, permetrics, plotly, kaleido


.. toctree::
   :maxdepth: 4
   :caption: Quick Start:

   pages/quick_start.rst

.. toctree::
   :maxdepth: 4
   :caption: Models API:

   pages/metacluster.rst

.. toctree::
   :maxdepth: 4
   :caption: Support:

   pages/support.rst



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

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