Skip to content

Commit

Permalink
DOC add section about scikit-learn-intelex (scikit-learn-contrib#1026)
Browse files Browse the repository at this point in the history
  • Loading branch information
glemaitre authored Jul 11, 2023
1 parent 2859cb0 commit 1fb69ca
Showing 1 changed file with 20 additions and 2 deletions.
22 changes: 20 additions & 2 deletions doc/install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -20,12 +20,30 @@ 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
pip install imbalanced-learn

The package is released also on the Anaconda Cloud platform::
The package is released also on the conda-forge repositories and you can install
it with `conda` (or `mamba`)::

conda install -c conda-forge imbalanced-learn

Intel optimizations via scikit-learn-intelex
--------------------------------------------

Imbalanced-learn relies entirely on scikit-learn algorithms. Intel provides an
optimized version of scikit-learn for Intel hardwares, called scikit-learn-intelex.
Installing scikit-learn-intelex and patching scikit-learn will activate the
Intel optimizations.

You can refer to the following
`blog post <https://medium.com/intel-analytics-software/why-pay-more-for-machine-learning-893683bd78e4>`_
for some benchmarks.

Refer to the following documentation for instructions:

- `Installation guide <https://intel.github.io/scikit-learn-intelex/installation.html>`_.
- `Patching guide <https://intel.github.io/scikit-learn-intelex/what-is-patching.html>`_.

From source available on GitHub
-------------------------------

Expand Down

0 comments on commit 1fb69ca

Please sign in to comment.