You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: doc/sources/quick-start.rst
+44-75Lines changed: 44 additions & 75 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -53,22 +53,21 @@ Alternatively, functions and classes from the |sklearnex| can be imported direct
53
53
from sklearnex.linear_model import LinearRegression
54
54
55
55
Installation
56
-
--------------------
57
-
58
-
.. contents:: :local:
56
+
------------
59
57
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.
61
60
62
-
Install from PyPI
63
-
**********************
61
+
Installing from PyPI
62
+
********************
64
63
65
-
Recommended by default.
64
+
To install with ``pip`` from the public Python Package Index (PyPI), execute the following command on a terminal: ::
66
65
67
-
To install |sklearnex|, run:
66
+
pip install scikit-learn-intelex
68
67
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.
70
69
71
-
pip install scikit-learn-intelex
70
+
.. tip:: To prevent version conflicts, we recommend creating and activating a new virtual environment for |sklearnex|.
72
71
73
72
.. tip:: Wheels are also available through Intel's index: ``https://software.repos.intel.com/python/pypi``
74
73
@@ -86,91 +85,61 @@ To install |sklearnex|, run:
86
85
* - Modes
87
86
- Single, SPMD (Linux* only)
88
87
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
-
91
88
.. note:: Wheels are only available for x86-64 architecture.
92
89
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.
.. 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.
137
103
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
.. note:: Packages are only available for x86-64 architecture.
149
125
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::
158
127
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``
160
129
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.
162
133
163
134
.. _build-from-sources:
164
135
165
-
Build from Sources
166
-
**********************
167
-
168
-
See :doc:`building-from-source` for details.
136
+
Building from Sources
137
+
*********************
169
138
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.
172
141
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.
0 commit comments