.. 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 `__ | `Source Repository `__ | `Issues & Ideas `__ | `Q&A Support `__ 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. .. raw:: html
Getting started

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

.. container:: custom-button :ref:`To the installation guideline` .. raw:: html
User guide

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

.. container:: custom-button :ref:`To the user guide` .. raw:: html
API reference

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

.. container:: custom-button :ref:`To the reference guide` .. raw:: html
Examples

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

.. container:: custom-button :ref:`To the gallery of examples` .. raw:: html
.. toctree:: :maxdepth: 3 :hidden: :titlesonly: install user_guide references/index auto_examples/index whats_new about