Repository files navigation

imbalanced-learn is a python package offering a number of re-sampling techniquescommonly used in datasets showing strong between-class imbalance.It is compatible withscikit-learn and is part ofscikit-learn-contribprojects.

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

imbalanced-learn requires the following dependencies:

• Python (>= 3.10)
• NumPy (>= 1.24.3)
• SciPy (>= 1.10.1)
• Scikit-learn (>= 1.3.2)
• Pytest (>= 7.2.2)

Additionally, imbalanced-learn requires the following optional dependencies:

• Pandas (>= 1.5.3) for dealing with dataframes
• Tensorflow (>= 2.13.1) for dealing with TensorFlow models
• Keras (>= 3.0.5) for dealing with Keras models

The examples will requires the following additional dependencies:

• Matplotlib (>= 3.7.3)
• Seaborn (>= 0.12.2)

imbalanced-learn is currently available on the PyPi's repositories and you caninstall 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 followingcommands to get a copy from Github and install all dependencies:

git clone https://github.com/scikit-learn-contrib/imbalanced-learn.gitcd imbalanced-learnpip 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 installpre-commit:

pip install pre-commitpre-commit install

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

make coverage

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

We endorse good practices from the Scientific Python Ecosystem Coordination (SPEC).The full list of recommendations is availablehere.

See below the list of recommendations that we endorse for the imbalanced-learn project.

If you use imbalanced-learn in a scientific publication, we would appreciatecitations 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 ofsamples of each class is roughly the same. Highly skewed datasets, where theminority is heavily outnumbered by one or more classes, have proven to be achallenge 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 thisimbalance with the hope of arriving at a more robust and fair decision boundarythan you would otherwise.

You can refer to theimbalanced-learn documentation to find details aboutthe implemented algorithms.