Skip to content

Commit 6161185

Browse files
update installation instructions for current ecosystem (#2912)
1 parent 954f4dc commit 6161185

1 file changed

Lines changed: 44 additions & 75 deletions

File tree

doc/sources/quick-start.rst

Lines changed: 44 additions & 75 deletions
Original file line numberDiff line numberDiff line change
@@ -53,22 +53,21 @@ Alternatively, functions and classes from the |sklearnex| can be imported direct
5353
from sklearnex.linear_model import LinearRegression
5454
5555
Installation
56-
--------------------
57-
58-
.. contents:: :local:
56+
------------
5957

60-
.. tip:: To prevent version conflicts, we recommend creating and activating a new environment for |sklearnex|.
58+
The |sklearnex| can be easily installed as a Python package under name ``scikit-learn-intelex`` from the most
59+
common distribution channels for Python.
6160

62-
Install from PyPI
63-
**********************
61+
Installing from PyPI
62+
********************
6463

65-
Recommended by default.
64+
To install with ``pip`` from the public Python Package Index (PyPI), execute the following command on a terminal: ::
6665

67-
To install |sklearnex|, run:
66+
pip install scikit-learn-intelex
6867

69-
::
68+
.. tip:: Running on GPU involves additional dependencies, see :doc:`oneapi-gpu`. SPMD mode has additional requirements on top of GPU ones, see :doc:`distributed-mode` for details.
7069

71-
pip install scikit-learn-intelex
70+
.. tip:: To prevent version conflicts, we recommend creating and activating a new virtual environment for |sklearnex|.
7271

7372
.. tip:: Wheels are also available through Intel's index: ``https://software.repos.intel.com/python/pypi``
7473

@@ -86,91 +85,61 @@ To install |sklearnex|, run:
8685
* - Modes
8786
- Single, SPMD (Linux* only)
8887

89-
.. tip:: Running on GPU involves additional dependencies, see :doc:`oneapi-gpu`. SPMD mode has additional requirements on top of GPU ones, see :doc:`distributed-mode` for details.
90-
9188
.. note:: Wheels are only available for x86-64 architecture.
9289

93-
Install through Conda
94-
*********************
95-
96-
To prevent version conflicts, we recommend installing ``scikit-learn-intelex`` into a new conda environment.
97-
98-
.. note::
99-
The main Anaconda channel also provides distributions of ``scikit-learn-intelex``, but it does not provide the latest versions, nor does
100-
it provide GPU-enabled builds. It is highly recommended to install ``scikit-learn-intelex`` from either Intel's channel or from conda-forge instead.
101-
102-
.. tabs::
103-
104-
.. tab:: Intel channel
105-
106-
Recommended for the Intel® Distribution for Python users.
107-
108-
To install in a fresh environment: ::
109-
110-
conda create -n sklex -c https://software.repos.intel.com/python/conda/ -c conda-forge --override-channels scikit-learn-intelex
111-
conda activate sklex
112-
113-
To install in an existing environment: ::
114-
115-
conda install -c https://software.repos.intel.com/python/conda/ -c conda-forge --override-channels scikit-learn-intelex
90+
Installing from conda-forge
91+
***************************
11692

117-
.. warning::
118-
Packages from the Intel channel are meant to be used together with dependencies from the **conda-forge** channel, and might not
119-
work correctly when used in an environment where packages from the ``anaconda`` default channel have been installed. It is
120-
advisable to use the `miniforge <https://github.com/conda-forge/miniforge>`__ installer for ``conda``/``mamba``, as it comes with
121-
``conda-forge`` as the only default channel.
93+
To install the |sklearnex| in a fresh environment, execute the following command in a terminal: ::
12294

123-
.. list-table:: **Supported Configurations**
124-
:align: left
95+
conda create -n sklex -c conda-forge --override-channels scikit-learn-intelex
96+
conda activate sklex
12597

126-
* - Operating systems
127-
- Windows*, Linux*
128-
* - Python versions
129-
- 3.10, 3.11, 3.12, 3.13, 3.14
130-
* - Devices
131-
- CPU, GPU
132-
* - Modes
133-
- Single, SPMD (Linux* only)
98+
To install in an existing environment: ::
13499

100+
conda install -c conda-forge --override-channels scikit-learn-intelex
135101

136-
.. tab:: Conda-Forge channel
102+
.. tip:: Running on GPU involves additional dependencies, see :doc:`oneapi-gpu`. SPMD mode has additional requirements on top of GPU ones, see :doc:`distributed-mode` for details.
137103

138-
To install in a fresh environment: ::
104+
.. hint::
105+
It is advisable to use the `miniforge <https://github.com/conda-forge/miniforge>`__ installer for ``conda``/``mamba``, as it comes with
106+
``conda-forge`` as the default channel.
139107

140-
conda create -n sklex -c conda-forge --override-channels scikit-learn-intelex
141-
conda activate sklex
108+
.. warning::
109+
The main Anaconda channel also provides distributions of ``scikit-learn-intelex``, but it does not provide the latest versions, nor does
110+
it provide GPU-enabled builds. It is highly recommended to install ``scikit-learn-intelex`` from either conda-forge or from Intel's channel instead.
142111

143-
To install in an existing environment: ::
112+
.. list-table:: **Supported Configurations**
113+
:align: left
144114

145-
conda install -c conda-forge --override-channels scikit-learn-intelex
115+
* - Operating systems
116+
- Windows*, Linux*
117+
* - Python versions
118+
- 3.10, 3.11, 3.12, 3.13, 3.14
119+
* - Devices
120+
- CPU, GPU
121+
* - Modes
122+
- Single, SPMD (Linux* only)
146123

147-
.. list-table:: **Supported Configurations**
148-
:align: left
124+
.. note:: Packages are only available for x86-64 architecture.
149125

150-
* - Operating systems
151-
- Windows*, Linux*
152-
* - Python versions
153-
- 3.10, 3.11, 3.12, 3.13, 3.14
154-
* - Devices
155-
- CPU, GPU
156-
* - Modes
157-
- Single, SPMD (Linux* only)
126+
.. tip::
158127

159-
.. tip:: Running on GPU involves additional dependencies, see :doc:`oneapi-gpu`. SPMD mode has additional requirements on top of GPU ones, see :doc:`distributed-mode` for details.
128+
The |sklearnex| is also available at Intel's conda channel: ``https://software.repos.intel.com/python/conda``
160129

161-
.. note:: Packages are only available for x86-64 architecture.
130+
Packages from the Intel channel, which include also optimized versions of NumPy and SciPy, are meant to be used together with
131+
dependencies from the **conda-forge** channel, and might not work correctly when used in an environment where packages from the
132+
``anaconda`` default channel have been installed.
162133

163134
.. _build-from-sources:
164135

165-
Build from Sources
166-
**********************
167-
168-
See :doc:`building-from-source` for details.
136+
Building from Sources
137+
*********************
169138

170-
Install Intel*(R) AI Tools
171-
****************************
139+
The |sklearnex| is a fully open-source package (`link to source code <https://github.com/uxlfoundation/scikit-learn-intelex>`_) which
140+
can be compiled from source with standard compiler toolkits.
172141

173-
Download the Intel AI Tools `here <https://www.intel.com/content/www/us/en/developer/tools/oneapi/ai-tools-selector.html>`_. The extension is already included.
142+
See :doc:`building-from-source` for details.
174143

175144
Release Notes
176145
-------------------

0 commit comments

Comments
 (0)