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.6, and 3.7. The dependency requirements are based on the last scikit-learn release:

scipy(>=0.13.3)
numpy(>=1.8.2)
scikit-learn(>=0.20)
keras 2 (optional)
tensorflow (optional)

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

imbalanced-learn 0.4 is the last version to support Python 2.7

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:

Under-sampling the majority class(es).
Over-sampling the minority class.
Combining over- and under-sampling.
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. 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 classifier using samplers internally
1. EasyEnsemble [13]
2. BalanceCascade [13]
3. Balanced Random Forest [16]
4. Balanced Bagging

The different algorithms are presented in the sphinx-gallery.

References:

Metadata

Release files for imbalanced-learn 0.4.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.4.0
File	Size	Uploaded
imbalanced-learn-0.4.0.tar.gz	175.5 kB	Oct 12, 2018	Details

Built distribution (wheel)

Table of built distributions (wheels) for imbalanced-learn 0.4.0
File	Interpreter	ABI	Platform	Reset
imbalanced_learn-0.4.0-py3-none-any.whl 165.2 kB Oct 12, 2018	Python 3	none	any	Details

Total release size: 340.8 kB

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

Download URL	imbalanced-learn-0.4.0.tar.gz
Size	175.5 kB
Tags	Source
SHA-256 checksum How to use checksums	`caeef36036c6f4aae659d2fdd7ca2da35664862d9876ab19e0c44a6f431331b4`
BLAKE2b-256 checksum How to use checksums	`64d18c2c6c30414521b1b9e9aef337ef61ec6346a04318db1a13f5ebe6b9ec1d`
Upload date	Oct 12, 2018
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`Python-urllib/3.6`

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

Download URL	imbalanced_learn-0.4.0-py3-none-any.whl
Size	165.2 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`da7f5aadfcf4c7b06785d37886f5637a07a61d133da66821375cb94e2da281ba`
BLAKE2b-256 checksum How to use checksums	`427307459186288bdfbae30c50eca4b54e16473a1e0ceee5f9c79480d6dc9b50`
Upload date	Oct 12, 2018
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`Python-urllib/3.6`

Release history Release notifications | RSS feed

0.14.2

Jun 7, 2026 2 release files

0.14.1

Dec 21, 2025 2 release files

0.14.0

Aug 14, 2025 2 release files

0.13.0

Dec 20, 2024 2 release files

0.12.4

Oct 4, 2024 2 release files

0.12.3

May 28, 2024 2 release files

0.12.2

Mar 31, 2024 2 release files

0.12.1

Mar 31, 2024 2 release files

0.12.0

Jan 24, 2024 2 release files

0.11.0

Jul 8, 2023 2 release files

0.10.1

Dec 28, 2022 2 release files

0.10.0

Dec 9, 2022 2 release files

0.9.1

May 16, 2022 2 release files

0.9.0

Jan 11, 2022 2 release files

0.8.1

Sep 29, 2021 2 release files

0.8.0

Feb 18, 2021 2 release files

0.7.0

Jun 9, 2020 2 release files

0.6.2

Feb 16, 2020 2 release files

0.6.1

Dec 7, 2019 2 release files

0.6.0

Dec 5, 2019 2 release files

0.5.0

Jun 28, 2019 2 release files

0.4.3

Nov 6, 2018 2 release files

0.4.2

Oct 21, 2018 2 release files

0.4.1

Oct 12, 2018 2 release files

This release

0.4.0 This release

Oct 12, 2018 2 release files

0.3.3

Feb 22, 2018 2 release files

0.3.2

Dec 7, 2017 2 release files

0.3.1

Oct 9, 2017 2 release files

0.3.0

Aug 24, 2017 3 release files

0.2.1

Jan 1, 2017 2 release files

0.2.0

Dec 31, 2016 2 release files

0.1.9

Dec 26, 2016 2 release files

0.1.8

Sep 7, 2016 2 release files

0.1.7

Aug 31, 2016 2 release files

0.1.6

Aug 9, 2016 2 release files

0.1.5

Jul 31, 2016 2 release files

0.1.3

Jul 19, 2016 2 release files

0.1.2

Jul 19, 2016 2 release files

0.1.1

Jul 9, 2016 2 release files

0.1

Jul 6, 2016

imbalanced-learn 0.4.0