Skip to main content

Azure Travis AppVeyor Codecov CircleCI PythonVersion 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 3.6+. The dependency requirements are based on the last scikit-learn release:

  • scipy(>=0.17)

  • numpy(>=1.11)

  • scikit-learn(>=0.22)

  • joblib(>=0.11)

  • keras 2 (optional)

  • tensorflow (optional)

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

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 conda-forge 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 pytest 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. Condensed 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. SMOTENC - SMOTE for Nominal Continuous [8]

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

    5. SVM SMOTE - Support Vectors SMOTE [10]

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

    7. KMeans-SMOTE [17]

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

    2. SMOTE + ENN [11]

  • Ensemble classifier using samplers internally
    1. Easy Ensemble classifier [13]

    2. Balanced Random Forest [16]

    3. Balanced Bagging

    4. RUSBoost [18]

  • Mini-batch resampling for Keras and Tensorflow

The different algorithms are presented in the sphinx-gallery.

References:

Release files for imbalanced-learn 0.6.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for imbalanced-learn 0.6.0
File Size Uploaded
imbalanced-learn-0.6.0.tar.gz 176.6 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for imbalanced-learn 0.6.0
File Interpreter ABI Platform
imbalanced_learn-0.6.0-py3-none-any.whl Python 3 none any Details

Total release size: 339.2 kB

Release files / imbalanced-learn-0.6.0.tar.gz

Download URL imbalanced-learn-0.6.0.tar.gz
Size 176.6 kB
Tags Source
SHA-256 checksum
How to use checksums
51e0b92405045a2fcdd2e2c3e1b1f66b1e0e2606b0fe27da7e4bed36c0a7757d
BLAKE2b-256 checksum
How to use checksums
f1d3e0fa21cfef43d6f49865a1e39eae5eb50b0887bfbb92e0d7dac336000ae1
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/2.0.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/42.0.2.post20191203 requests-toolbelt/0.9.1 tqdm/4.40.0 CPython/3.7.5

Release files / imbalanced_learn-0.6.0-py3-none-any.whl

Download URL imbalanced_learn-0.6.0-py3-none-any.whl
Size 162.6 kB
Tags Python 3
SHA-256 checksum
How to use checksums
8b1e3b8078930a270cd40e1a8e23ad30496a724e03d0782273a44f1b66c9349e
BLAKE2b-256 checksum
How to use checksums
0c7c89596d6a89c4a0b8bbe51de7df0ec59fc382cb5948b0d4efa0d66c81dc4b
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/2.0.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/42.0.2.post20191203 requests-toolbelt/0.9.1 tqdm/4.40.0 CPython/3.7.5

Release history Release notifications | RSS feed

0.14.1

2 release files

0.14.0

2 release files

0.13.0

2 release files

0.12.3

2 release files

0.12.2

2 release files

0.12.1

2 release files

0.12.0

2 release files

0.10.1

2 release files

0.9.1

2 release files

0.9.0

2 release files

0.8.1

2 release files

0.8.0

2 release files

0.7.0

2 release files

0.6.2

2 release files

0.6.1

2 release files

This release

0.6.0 This release

2 release files

0.5.0

2 release files

0.4.3

2 release files

0.4.2

2 release files

0.4.1

2 release files

0.4.0

2 release files

0.3.3

2 release files

0.3.2

2 release files

0.3.1

2 release files

0.3.0

3 release files

0.2.1

2 release files

0.2.0

2 release files

0.1.9

2 release files

0.1.8

2 release files

0.1.7

2 release files

0.1.6

2 release files

0.1.5

2 release files

0.1.3

2 release files

0.1.2

2 release files

0.1.1

2 release files

0.1

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page