Getting Intel(R) Extension for Scikit-learn*

Installation from distribution channels

Intel(R) Extension for Scikit-learn is available at the Python Package Index, on Anaconda Cloud in Conda-Forge channel and in Intel channel. Also Intel(R) Extension for Scikit-learn is available available as a part of Intel oneAPI AI Analytics Toolkit (AI Kit). Sources and build instructions are available in Intel(R) Extension for Scikit-learn repository.

  • Install from PyPI (Recommended):

    pip install scikit-learn-intelex
    
  • Install from Anaconda Cloud: Conda-Forge channel:

    сonda install scikit-learn-intelex -c conda-forge
    
  • Install from Anaconda Cloud: Intel channel:

    conda install scikit-learn-intelex -c intel
    

Supported configurations

PyPi channel

OS / Python version

Python 3.6

Python 3.7

Python 3.8

Python 3.9

Linux

✔️

✔️

✔️

Windows

✔️

✔️

✔️

OsX

✔️

✔️

✔️

Note

It supports Intel CPU and GPU except on OsX.

Anaconda Cloud: Conda-Forge channel

OS / Python version

Python 3.6

Python 3.7

Python 3.8

Python 3.9

Linux

✔️

✔️

✔️

✔️

Windows

✔️

✔️

✔️

✔️

OsX

✔️

✔️

✔️

✔️

Note

It supports only Intel CPU. Recommended for conda users by default.

Anaconda Cloud: Intel channel

OS / Python version

Python 3.6

Python 3.7

Python 3.8

Python 3.9

Linux

✔️

✔️

✔️

Windows

✔️

✔️

✔️

OsX

✔️

✔️

✔️

Note

It supports Intel CPU and GPU except on OsX. Recommended for conda users who use other components from Intel(R) Distribution for Python.

Building from Sources

Prerequisites:

Python version >= 3.6

Configuring the build with environment variables:

SKLEARNEX_VERSION: sets package version

Building Intel(R) Extension for Scikit-learn

To install the package:

cd <checkout-dir>
python setup_sklearnex.py install

To install the package in the development mode:

cd <checkout-dir>
python setup.py develop

To install scikit-learn-intelex without downloading daal4py:

cd <checkout-dir>
python setup_sklearnex.py install --single-version-externally-managed --record=record.txt

To install scikit-learn-intelex without downloading daal4py in the development mode:

cd <checkout-dir>
python setup_sklearnex.py develop --no-deps

Note

The develop mode will not install the package but it will create a .egg-link in the deployment directory back to the project source code directory. That way you can edit the source code and see the changes without having to reinstall the package every time you make a small change.

⚠️ Keys --single-version-externally-managed and --no-deps are required so that daal4py is not downloaded after installation of Intel(R) Extension for Scikit-learn

Note

--single-version-externally-managed is an option used for Python packages instructing the setuptools module to create a Python package that can be easily managed by the package manager on the host

Building documentation for Intel(R) Extension for Scikit-learn

Prerequisites for creating documentation

  • sphinx

  • sphinx_rtd_theme

Building documentation

  1. `cd doc && make html`

  2. The documentation will be in `doc/_build/html`