.. project-template documentation master file, created by
   sphinx-quickstart on Mon Jan 18 14:44:12 2016.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

:notoc:

##############################
imbalanced-learn documentation
##############################

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

**Useful links**:
`Binary Installers <https://pypi.org/project/imbalanced-learn>`__ |
`Source Repository <https://github.com/scikit-learn-contrib/imbalanced-learn>`__ |
`Issues & Ideas <https://github.com/scikit-learn-contrib/imbalanced-learn/issues>`__ |
`Q&A Support <https://gitter.im/scikit-learn-contrib/imbalanced-learn>`__

Imbalanced-learn (imported as :mod:`imblearn`) is an open source, MIT-licensed
library relying on scikit-learn (imported as :mod:`sklearn`) and provides tools
when dealing with classification with imbalanced classes.

.. 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/index_getting_started.svg
        :class-card: intro-card
        :shadow: md

        Check out the getting started guides to install `imbalanced-learn`.
        Some extra information to get started with a new contribution is also provided.

        +++

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

            To the installation guideline

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

        The user guide provides in-depth information on the key concepts of
        `imbalanced-learn` with useful background information and explanation.

        +++

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

            To the user guide

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

        The reference guide contains a detailed description of
        the `imbalanced-learn` API. To known more about methods parameters.

        +++

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

            To the reference guide

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

        The gallery of examples is a good place to see `imbalanced-learn` in action.
        Select an example and dive in.

        +++

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

            To the gallery of examples


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

    install
    user_guide
    references/index
    auto_examples/index
    whats_new
    about