.. _clustering:

.. currentmodule:: scikitplot.cluster

==========
Clustering
==========

This module contains functions related to clustering.

.. _plot_elbow:

plot elbow
---------------------

:func:`~scikitplot.cluster.plot_elbow`

Trained model of :class:`~sklearn.cluster.KMeans` or :class:`~sklearn.cluster.MiniBatchKMeans`.
For an example of performing image:

.. rubric:: Examples

* :ref:`sphx_glr_auto_examples_cluster_plot_elbow_script.py`: Example usage of
  :class:`~sklearn.cluster.KMeans` using the iris dataset

.. dropdown:: References

  * `"scikit-learn k-means"
    <https://scikit-learn.org/stable/modules/clustering.html#k-means>`_.

  * `"scikit-learn mini-batch-k-means"
    <https://scikit-learn.org/stable/modules/clustering.html#mini-batch-k-means>`_.