:orphan:

Examples Gallery
================

This gallery showcases how to use the estimators provided by ``sklekmeans``.

Contents
--------

- ``example.py``: Minimal example demonstrating a basic ``EKMeans`` fit.
- ``plot_imbalanced_ekmeans.py``: Comparison of clustering on an imbalanced dataset.

How to run locally
------------------

You can execute the examples directly, or build the documentation to render the
plots and notebooks via Sphinx-Gallery.

To build the documentation gallery locally:

1. Install the docs dependencies:

   ``pip install -e .[docs]``

2. Build the docs:

   ``sphinx-build -E -b html doc doc\_build\html``

The gallery will appear under ``doc/_build/html/auto_examples``.



.. raw:: html

    <div class="sphx-glr-thumbnails">

.. thumbnail-parent-div-open

.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This example compares clustering performance on an imbalanced dataset for several algorithms, including EKMeans and MiniBatchEKMeans.">

.. only:: html

  .. image:: /auto_examples/images/thumb/sphx_glr_plot_imbalanced_ekmeans_thumb.png
    :alt:

  :ref:`sphx_glr_auto_examples_plot_imbalanced_ekmeans.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Imbalanced clustering comparison with EKMeans</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This example mirrors scikit-learn&#x27;s &quot;Comparing different clustering algorithms on toy datasets&quot; in layout and visuals, and extends it with EKMeans.">

.. only:: html

  .. image:: /auto_examples/images/thumb/sphx_glr_plot_toy_ekmeans_thumb.png
    :alt:

  :ref:`sphx_glr_auto_examples_plot_toy_ekmeans.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Comparing EKMeans and other clustering algorithms on toy datasets</div>
    </div>


.. thumbnail-parent-div-close

.. raw:: html

    </div>


.. toctree::
   :hidden:

   /auto_examples/plot_imbalanced_ekmeans
   /auto_examples/plot_toy_ekmeans


.. only:: html

  .. container:: sphx-glr-footer sphx-glr-footer-gallery

    .. container:: sphx-glr-download sphx-glr-download-python

      :download:`Download all examples in Python source code: auto_examples_python.zip </auto_examples/auto_examples_python.zip>`

    .. container:: sphx-glr-download sphx-glr-download-jupyter

      :download:`Download all examples in Jupyter notebooks: auto_examples_jupyter.zip </auto_examples/auto_examples_jupyter.zip>`


.. only:: html

 .. rst-class:: sphx-glr-signature

    `Gallery generated by Sphinx-Gallery <https://sphinx-gallery.github.io>`_