Skip to main content

Toolbox for imbalanced dataset in machine learning.

Project description

Landscape Travis AppVeyor Codecov CircleCI Python27 Python35 Pypi Gitter

imbalanced-learn

imbalanced-learn is a python package offering a number of re-sampling techniques commonly used in datasets showing strong between-class imbalance. It is compatible with scikit-learn and is part of scikit-learn-contrib projects.

Documentation

Installation documentation, API documentation, and examples can be found on the documentation.

Installation

Dependencies

imbalanced-learn is tested to work under Python 2.7 and Python 3.5, and 3.6. The dependency requirements are based on the last scikit-learn release:

  • scipy(>=0.13.3)

  • numpy(>=1.8.2)

  • scikit-learn(>=0.19.0)

Additionally, to run the examples, you need matplotlib(>=2.0.0).

Installation

imbalanced-learn is currently available on the PyPi’s repository and you can install it via pip:

pip install -U imbalanced-learn

The package is release also in Anaconda Cloud platform:

conda install -c glemaitre imbalanced-learn

If you prefer, you can clone it and run the setup.py file. Use the following commands to get a copy from GitHub and install all dependencies:

git clone https://github.com/scikit-learn-contrib/imbalanced-learn.git
cd imbalanced-learn
pip install .

Or install using pip and GitHub:

pip install -U git+https://github.com/scikit-learn-contrib/imbalanced-learn.git

Testing

After installation, you can use nose to run the test suite:

make coverage

Development

The development of this scikit-learn-contrib is in line with the one of the scikit-learn community. Therefore, you can refer to their Development Guide.

About

If you use imbalanced-learn in a scientific publication, we would appreciate citations to the following paper:

@article{JMLR:v18:16-365,
author  = {Guillaume  Lema{{\^i}}tre and Fernando Nogueira and Christos K. Aridas},
title   = {Imbalanced-learn: A Python Toolbox to Tackle the Curse of Imbalanced Datasets in Machine Learning},
journal = {Journal of Machine Learning Research},
year    = {2017},
volume  = {18},
number  = {17},
pages   = {1-5},
url     = {http://jmlr.org/papers/v18/16-365}
}

Most classification algorithms will only perform optimally when the number of samples of each class is roughly the same. Highly skewed datasets, where the minority is heavily outnumbered by one or more classes, have proven to be a challenge while at the same time becoming more and more common.

One way of addressing this issue is by re-sampling the dataset as to offset this imbalance with the hope of arriving at a more robust and fair decision boundary than you would otherwise.

Re-sampling techniques are divided in two categories:
  1. Under-sampling the majority class(es).

  2. Over-sampling the minority class.

  3. Combining over- and under-sampling.

  4. Create ensemble balanced sets.

Below is a list of the methods currently implemented in this module.

  • Under-sampling
    1. Random majority under-sampling with replacement

    2. Extraction of majority-minority Tomek links [1]

    3. Under-sampling with Cluster Centroids

    4. NearMiss-(1 & 2 & 3) [2]

    5. Condensend Nearest Neighbour [3]

    6. One-Sided Selection [4]

    7. Neighboorhood Cleaning Rule [5]

    8. Edited Nearest Neighbours [6]

    9. Instance Hardness Threshold [7]

    10. Repeated Edited Nearest Neighbours [14]

    11. AllKNN [14]

  • Over-sampling
    1. Random minority over-sampling with replacement

    2. SMOTE - Synthetic Minority Over-sampling Technique [8]

    3. bSMOTE(1 & 2) - Borderline SMOTE of types 1 and 2 [9]

    4. SVM SMOTE - Support Vectors SMOTE [10]

    5. ADASYN - Adaptive synthetic sampling approach for imbalanced learning [15]

  • Over-sampling followed by under-sampling
    1. SMOTE + Tomek links [12]

    2. SMOTE + ENN [11]

  • Ensemble sampling
    1. EasyEnsemble [13]

    2. BalanceCascade [13]

The different algorithms are presented in the sphinx-gallery.

References:

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

imbalanced-learn-0.3.0.tar.gz (42.0 MB view details)

Uploaded Source

Built Distributions

imbalanced_learn-0.3.0-py3-none-any.whl (144.1 kB view details)

Uploaded Python 3

imbalanced_learn-0.3.0-py2-none-any.whl (144.1 kB view details)

Uploaded Python 2

File details

Details for the file imbalanced-learn-0.3.0.tar.gz.

File metadata

File hashes

Hashes for imbalanced-learn-0.3.0.tar.gz
Algorithm Hash digest
SHA256 eb9140f50d898057845419bbba98c357f88db341d4c3c37a8984423c831cdc17
MD5 6f33d314b57366d8aed83f10aa28026b
BLAKE2b-256 8be6bcbb53e04268176576605372c54da72710b2ba1945baa23ab18f5f642bec

See more details on using hashes here.

File details

Details for the file imbalanced_learn-0.3.0-py3-none-any.whl.

File metadata

File hashes

Hashes for imbalanced_learn-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 d3eee2522484c58e0b73f73e917f1027bcaa94ec3c78ba4f8c5afe1e7da17b1f
MD5 d41123060472b0b765f43d64c61d7674
BLAKE2b-256 e9d18650bd1b9902176d4f54660b401cd9b402e7cc36d4b8877c23f526a787d7

See more details on using hashes here.

File details

Details for the file imbalanced_learn-0.3.0-py2-none-any.whl.

File metadata

File hashes

Hashes for imbalanced_learn-0.3.0-py2-none-any.whl
Algorithm Hash digest
SHA256 2a807f0d0b0738c748facfae4398afca955fb9a82703cf5ef8cde3459a0c2613
MD5 4513a1d5efa585eee072c1b206a967e7
BLAKE2b-256 6f7c8c5069b8b6f8fd6f48bafc146372e2dc1e651ac79ff549fa35a9e50d5967

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page