Skip to main content

Azure Codecov CircleCI PythonVersion Pypi Gitter Black

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 requires the following dependencies:

  • Python (>= 3.8)

  • NumPy (>= 1.17.3)

  • SciPy (>= 1.5.0)

  • Scikit-learn (>= 1.0.2)

Additionally, imbalanced-learn requires the following optional dependencies:

  • Pandas (>= 1.0.5) for dealing with dataframes

  • Tensorflow (>= 2.4.3) for dealing with TensorFlow models

  • Keras (>= 2.4.3) for dealing with Keras models

The examples will requires the following additional dependencies:

  • Matplotlib (>= 3.1.2)

  • Seaborn (>= 0.9.0)

Installation

From PyPi or conda-forge repositories

imbalanced-learn is currently available on the PyPi’s repositories 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

From source available on GitHub

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 .

Be aware that you can install in developer mode with:

pip install --no-build-isolation --editable .

If you wish to make pull-requests on GitHub, we advise you to install pre-commit:

pip install pre-commit
pre-commit install

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.

You can refer to the imbalanced-learn documentation to find details about the implemented algorithms.

Metadata

Release files for imbalanced-learn 0.12.2

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.12.2
File Size Uploaded Provenance Actions
imbalanced-learn-0.12.2.tar.gz 29.7 MB Without provenance Details for imbalanced-learn-0.12.2.tar.gz

Built distribution (wheel)

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

Total release size: 30.0 MB

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

Download URL imbalanced-learn-0.12.2.tar.gz
Size 29.7 MB
Tags Source
SHA-256 checksum
How to use checksums
a80c56cedcb07124f266be62d3a5d2ab5b5779909a7343fdf1b993479662f6c1
BLAKE2b-256 checksum
How to use checksums
3b19e4237e07c49c0e540c9d620ed9fcaa9cac236cd32fbc87987c36dd43a4d8
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.10.12

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

Download URL imbalanced_learn-0.12.2-py3-none-any.whl
Size 258.0 kB
Tags Python 3
SHA-256 checksum
How to use checksums
8523b3ee6c10c1d25f6bebe3faa73a0bca28d1fed55e0435b49af22802cdc259
BLAKE2b-256 checksum
How to use checksums
6e1b66764ecf370e797759be06fb38c11640ea1f9456ae10f8640a33cfa726ea
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.10.12

Security for imbalanced-learn 0.12.2

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

0.12.2 This release

2 release files No provenance

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