#############################################
intra-class-rare-learn Documentation
#############################################

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

**Useful links**:
`Source Repository <https://github.com/jannewer/intra-class-rare-learn>`__

This is the documentation for the `intra-class-rare-learn` package. The package
provides sklearn-compatible estimators that are built to handle within-class rarity.


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

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

        The user guide is the right place to start if you are new to the library.
        It provides an overview of the library and how to use it.

        +++

        .. 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

        The API reference provides a detailed description of the library's API.

        +++

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

            To the reference guide

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

        A set of examples that demonstrate how to use the library.

        +++

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

            To the gallery of examples


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

    user_guide
    api
    auto_examples/index