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: INSTALL.md
+17-19Lines changed: 17 additions & 19 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -18,25 +18,23 @@
18
18
19
19
# Installation <!-- omit in toc -->
20
20
21
-
To install Intel(R) Extension for Scikit-learn*, use one of the following scenarios:
21
+
To install Extension for Scikit-learn*, use one of the following scenarios:
22
22
23
23
-[Before You Begin](#before-you-begin)
24
24
-[Install via PIP](#install-via-pip)
25
25
-[Install from PyPI Channel (recommended by default)](#install-from-pypi-channel-recommended-by-default)
26
-
-[Install from Anaconda Cloud](#install-from-anaconda-cloud)
27
-
-[Install via Anaconda Cloud from Conda-Forge Channel](#install-via-anaconda-cloud-from-conda-forge-channel)
28
-
-[Install via Anaconda Cloud from Intel Channel](#install-via-anaconda-cloud-from-intel-channel)
26
+
-[Install via conda](#install-via-conda)
27
+
-[Install from Conda-Forge Channel](#install-from-conda-forge-channel)
28
+
-[Install from Intel conda Channel](#install-from-intel-conda-channel)
29
29
-[Build from Sources](#build-from-sources)
30
30
-[Prerequisites](#prerequisites)
31
31
-[Configure the Build with Environment Variables](#configure-the-build-with-environment-variables)
32
-
-[Build Intel(R) Extension for Scikit-learn](#build-intelr-extension-for-scikit-learn)
32
+
-[Build Extension for Scikit-learn](#build-intelr-extension-for-scikit-learn)
33
33
-[Build from Sources with `conda-build`](#build-from-sources-with-conda-build)
34
34
-[Prerequisites for `conda-build`](#prerequisites-for-conda-build)
35
-
-[Build Intel(R) Extension for Scikit-learn with `conda-build`](#build-intelr-extension-for-scikit-learn-with-conda-build)
35
+
-[Build Extension for Scikit-learn with `conda-build`](#build-intelr-extension-for-scikit-learn-with-conda-build)
36
36
-[Next Steps](#next-steps)
37
37
38
-
> **_NOTE:_** Intel(R) Extension for Scikit-learn* is also available as a part of [Intel® AI Tools](https://www.intel.com/content/www/us/en/developer/tools/oneapi/ai-analytics-toolkit.html). If you already have it installed, you do not need to separately install the extension.
To prevent version conflicts, we recommend to create and activate a new environment.
84
82
85
-
### Install via Anaconda Cloud from Conda-Forge Channel
83
+
### Install from Conda-Forge Channel
86
84
87
85
- Install into a newly created environment (recommended):
88
86
@@ -102,7 +100,7 @@ To prevent version conflicts, we recommend to create and activate a new environm
102
100
conda install scikit-learn-intelex
103
101
```
104
102
105
-
### Install via Anaconda Cloud from Intel Channel
103
+
### Install Intel conda Channel
106
104
107
105
We recommend this installation for the users of Intel® Distribution for Python.
108
106
@@ -133,7 +131,7 @@ We recommend this installation for the users of Intel® Distribution for Python.
133
131
```
134
132
135
133
## Build from Sources
136
-
Intel(R) Extension for Scikit-learn* is easily built from the sources with the majority of the necessary prerequisites available with conda or pip.
134
+
Extension for Scikit-learn* is easily built from the sources with the majority of the necessary prerequisites available with conda or pip.
137
135
138
136
The package is available for Windows* OS, Linux* OS, and macOS*.
139
137
@@ -153,7 +151,7 @@ The build-process (using setup.py) happens in 4 stages:
153
151
* cmake and pybind11
154
152
* A C++ compiler with C++11 support
155
153
* Clang-Format version >=14
156
-
* [Intel® oneAPI Data Analytics Library (oneDAL)](https://github.com/uxlfoundation/oneDAL) version 2021.1 or later, but be mindful that **the oneDAL version must be <= than that of scikit-learn-intelex** (it's backwards compatible but not forwards compatible).
154
+
* [oneAPI Data Analytics Library (oneDAL)](https://github.com/uxlfoundation/oneDAL) version 2021.1 or later, but be mindful that **the oneDAL version must be <= than that of scikit-learn-intelex** (it's backwards compatible but not forwards compatible).
157
155
* You can use the pre-built `dal-devel` conda package from conda-forge channel
158
156
* MPI (optional, needed for distributed mode)
159
157
* You can use the pre-built `impi_rt` and `impi-devel` conda packages from conda-forge channel
@@ -173,7 +171,7 @@ The build-process (using setup.py) happens in 4 stages:
173
171
**Note:** The `-j` flag in the ``MAKEFLAGS`` environment variable is superseded in `setup.py` modes which support the ``--parallel`` and `-j` command line flags.
174
172
175
173
176
-
### Build Intel(R) Extension for Scikit-learn
174
+
### Build Extension for Scikit-learn
177
175
178
176
- To install the package:
179
177
@@ -202,7 +200,7 @@ The build-process (using setup.py) happens in 4 stages:
202
200
203
201
Where:
204
202
205
-
* Keys `--single-version-externally-managed` and `--no-deps` are required to not download daal4py after the installation of Intel(R) Extension for Scikit-learn.
203
+
* Keys `--single-version-externally-managed` and `--no-deps` are required to not download daal4py after the installation of Extension for Scikit-learn.
206
204
* The `develop` mode does not install the package but creates a `.egg-link` in the deployment directory
207
205
back to the project source-code directory. That way, you can edit the source code and see the changes
208
206
without reinstalling the package after a small change.
Intel(R) Extension for Scikit-learn is a **free software AI accelerator** designed to deliver over **10-100X** acceleration to your existing scikit-learn code.
43
-
The software acceleration is achieved with vector instructions, AI hardware-specific memory optimizations, threading, and optimizations for all upcoming Intel(R) platforms at launch time.
42
+
Extension for Scikit-learn is a **free software AI accelerator** designed to deliver over **10-100X** acceleration to your existing scikit-learn code.
43
+
The software acceleration is achieved with vector instructions, AI hardware-specific memory optimizations, threading, and optimizations.
44
44
45
45
46
-
With Intel(R) Extension for Scikit-learn, you can:
46
+
With Extension for Scikit-learn, you can:
47
47
48
48
* Speed up training and inference by up to 100x with equivalent mathematical accuracy
49
-
* Benefit from performance improvements across different Intel(R) hardware configurations, including GPUs and multi-GPU configurations
49
+
* Benefit from performance improvements across different CPU hardware configurations, including GPUs and multi-GPU configurations
50
50
* Integrate the extension into your existing Scikit-learn applications without code modifications
51
51
* Continue to use the open-source scikit-learn API
52
52
* Enable and disable the extension with a couple of lines of code or at the command line
53
53
54
-
Intel(R) Extension for Scikit-learn is also a part of [Intel(R) AI Tools](https://www.intel.com/content/www/us/en/developer/tools/oneapi/ai-analytics-toolkit.html).
@@ -75,7 +73,7 @@ Intel(R) Extension for Scikit-learn is also a part of [Intel(R) AI Tools](https:
75
73
clustering = DBSCAN(eps=3, min_samples=2).fit(X)
76
74
```
77
75
78
-
-**Enable Intel(R) GPU optimizations**
76
+
-**Enable GPU optimizations**
79
77
80
78
_Note: executing on GPU has [additional system software requirements](https://www.intel.com/content/www/us/en/developer/articles/system-requirements/intel-oneapi-dpcpp-system-requirements.html) - see [details](https://uxlfoundation.github.io/scikit-learn-intelex/latest/oneapi-gpu.html)._
81
79
@@ -96,7 +94,7 @@ Intel(R) Extension for Scikit-learn is also a part of [Intel(R) AI Tools](https:
96
94
97
95
## Installation
98
96
99
-
To install Intel(R) Extension for Scikit-learn, run:
97
+
To install Extension for Scikit-learn, run:
100
98
101
99
```
102
100
pip install scikit-learn-intelex
@@ -136,8 +134,8 @@ To patch scikit-learn, you can:
136
134
137
135
### daal4py and oneDAL
138
136
139
-
The acceleration is achieved through the use of the Intel(R) oneAPI Data Analytics Library (oneDAL). Learn more:
140
-
- [About Intel(R) oneAPI Data Analytics Library](https://github.com/uxlfoundation/oneDAL)
137
+
The acceleration is achieved through the use of the oneAPI Data Analytics Library (oneDAL). Learn more:
138
+
- [About oneAPI Data Analytics Library](https://github.com/uxlfoundation/oneDAL)
We are committed to providing support and assistance to help you make the most out of Intel(R) Extension for Scikit-learn.
20
+
We are committed to providing support and assistance to help you make the most out of Extension for Scikit-learn.
21
21
Use the following methods if you face any challenges.
22
22
23
23
@@ -34,7 +34,7 @@ Visit the [GitHub Discussions](https://github.com/uxlfoundation/scikit-learn-int
34
34
35
35
## Forum
36
36
37
-
Ask questions about Intel(R) Extension for Scikit-learn on our [Forum](https://community.intel.com/t5/Intel-Distribution-for-Python/bd-p/distribution-python).
37
+
Ask questions about Extension for Scikit-learn on our [Forum](https://community.intel.com/t5/Intel-Distribution-for-Python/bd-p/distribution-python).
38
38
Make sure to provide all relevant details, so we could help you as soon as possible.
[](https://github.com/IntelPython/daal4py/discussions)
@@ -23,9 +23,9 @@
23
23
24
24
**IMPORTANT NOTICE**: `daal4py` has been merged into `scikit-learn-intelex`. As of version 2025.0, it is distributed as an additional importable module within the package `scikit-learn-intelex` instead of being a separate package. The last standalone release of `daal4py` was version 2024.7, and this standalone package will not receive further updates.
25
25
26
-
A simplified API to Intel(R) oneAPI Data Analytics Library that allows for fast usage of the framework suited for Data Scientists or Machine Learning users. Built to help provide an abstraction to Intel(R) oneAPI Data Analytics Library for either direct usage or integration into one's own framework.
26
+
A simplified API to oneAPI Data Analytics Library that allows for fast usage of the framework suited for Data Scientists or Machine Learning users. Built to help provide an abstraction to oneAPI Data Analytics Library for either direct usage or integration into one's own framework.
27
27
28
-
Note: For the most part, `daal4py` is used as an internal backend within the Intel(R) Scikit-Learn extension, and it is highly recommended to use `sklearnex` instead. Nevertheless, some functionalities from `daal4py` can still be of use, and the module can still be imported directly (`import daal4py`) after installing `scikit-learn-intelex`.
28
+
Note: For the most part, `daal4py` is used as an internal backend within the Scikit-Learn extension, and it is highly recommended to use `sklearnex` instead. Nevertheless, some functionalities from `daal4py` can still be of use, and the module can still be imported directly (`import daal4py`) after installing `scikit-learn-intelex`.
29
29
30
30
## 👀 Follow us on Medium
31
31
@@ -43,7 +43,7 @@ We publish blogs on Medium, so [follow us](https://medium.com/intel-analytics-so
Scikit-learn patching functionality in daal4py was deprecated and moved to a separate package - [Intel(R) Extension for Scikit-learn*](https://github.com/uxlfoundation/scikit-learn-intelex). All future updates for the patching will be available in Intel(R) Extension for Scikit-learn only. Please use the package instead of daal4py for the Scikit-learn acceleration.
95
+
Scikit-learn patching functionality in daal4py was deprecated and moved to a separate package - [Extension for Scikit-learn*](https://github.com/uxlfoundation/scikit-learn-intelex). All future updates for the patching will be available in Extension for Scikit-learn only. Please use the package instead of daal4py for the Scikit-learn acceleration.
0 commit comments