.. denmune-skl documentation master file.

:notoc:

###########################################################
DenMune-Sklearn: Robust Density-Based Clustering
###########################################################

**Date**: |today| **Version**: |version|

**Useful links**:
`Source Repository <https://github.com/scikit-learn-contrib/denmune-skl>`__ |
`Issues & Ideas <https://github.com/scikit-learn-contrib/denmune-skl/issues>`__

**DenMune-Sklearn** is an efficient, scikit-learn compatible implementation of the "DENMUNE: Density peak based clustering using mutual nearest neighbors" algorithm. It was developed to provide a robust, performant, and API-compliant alternative to existing implementations.

This library excels at identifying non-convex clusters of varying densities, automatically detects noise, and integrates seamlessly into the scikit-learn ecosystem.


.. grid:: 1 2 2 2
    :gutter: 4
    :padding: 2 2 0 0
    :class-container: sd-text-center

    .. grid-item-card:: Getting Started
        :img-top: _static/img/index_getting_started.svg
        :class-card: intro-card
        :shadow: md

        Install the library and run your first clustering task in minutes.

        +++

        .. button-ref:: quick_start
            :ref-type: ref
            :click-parent:
            :color: secondary
            :expand:

            To the Getting Started guide

    .. grid-item-card::  User Guide
        :img-top: _static/img/index_user_guide.svg
        :class-card: intro-card
        :shadow: md

        Understand the theory behind DenMune, its parameters, and practical usage tips.

        +++

        .. button-ref:: user_guide
            :ref-type: ref
            :click-parent:
            :color: secondary
            :expand:

            To the User Guide

    .. grid-item-card::  API Reference
        :img-top: _static/img/index_api.svg
        :class-card: intro-card
        :shadow: md

        Detailed descriptions of all classes, functions, and their parameters.

        +++

        .. button-ref:: api
            :ref-type: ref
            :click-parent:
            :color: secondary
            :expand:

            To the API Reference

    .. grid-item-card::  Examples
        :img-top: _static/img/index_examples.svg
        :class-card: intro-card
        :shadow: md

        A gallery of examples demonstrating key features and advanced use cases.

        +++

        .. button-ref:: general_examples
            :ref-type: ref
            :click-parent:
            :color: secondary
            :expand:

            To the Example Gallery


.. toctree::
    :maxdepth: 3
    :hidden:
    :titlesonly:

    quick_start
    user_guide
    api
    auto_examples/index