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
Intel(R) Extension for Scikit-learn is easily built from sources with the majority of the necessary prerequisites available on conda or pip. The instructions below detail how to gather the prerequisites, and finally build and install the completed package. The package can be built for all three major platforms (Windows, Linux, macOS).
1
+
# Installation <!-- omit in toc -->
3
2
4
-
### Prerequisites
5
-
* Python version >= 3.6
3
+
Intel(R) Extension for Scikit-learn is available at the [Python Package Index](https://pypi.org/project/scikit-learn-intelex/),
4
+
on Anaconda Cloud in [Conda-Forge channel](https://anaconda.org/conda-forge/scikit-learn-intelex) and in [Intel channel](https://anaconda.org/intel/scikit-learn-intelex). You can also build the extension from sources.
6
5
7
-
### Configuring the build with environment variables
8
-
* SKLEARNEX_VERSION: sets package version
6
+
The extension is also available as a part of [Intel® oneAPI AI Analytics Toolkit](https://software.intel.com/content/www/us/en/develop/tools/oneapi/ai-analytics-toolkit.html) (AI Kit). If you already have AI Kit installed, you do not need to separately install the extension.
9
7
10
-
### Building Intel(R) Extension for Scikit-learn
11
-
To install the package:
8
+
## Installation scenarios <!-- omit in toc -->
12
9
13
-
```bash
14
-
cd<checkout-dir>
15
-
python setup_sklearnex.py install
16
-
```
10
+
-[Install via pip or conda](#install-via-pip-or-conda)
11
+
-[Install from PyPI channel (recommended by default)](#install-from-pypi-channel-recommended-by-default)
12
+
-[Install from Anaconda Cloud](#install-from-anaconda-cloud)
13
+
-[Install via Anaconda Cloud from Conda-Forge channel](#install-via-anaconda-cloud-from-conda-forge-channel)
14
+
-[Install via Anaconda Cloud from Intel channel](#install-via-anaconda-cloud-from-intel-channel)
15
+
-[Build from sources](#build-from-sources)
16
+
-[Prerequisites](#prerequisites)
17
+
-[Configure the build with environment variables](#configure-the-build-with-environment-variables)
18
+
-[Build Intel(R) Extension for Scikit-learn](#build-intelr-extension-for-scikit-learn)
19
+
-[Build documentation for Intel(R) Extension for Scikit-learn](#build-documentation-for-intelr-extension-for-scikit-learn)
20
+
-[Prerequisites for creating documentation](#prerequisites-for-creating-documentation)
21
+
-[Build documentation](#build-documentation)
17
22
18
-
To install the package in the development mode:
23
+
## Install via pip or conda
24
+
25
+
### Install from PyPI channel (recommended by default)
19
26
20
27
```bash
21
-
cd<checkout-dir>
22
-
python setup_sklearnex.py develop
28
+
pip install scikit-learn-intelex
23
29
```
24
30
25
-
To install scikit-learn-intelex without downloading daal4py:
31
+
#### 📦 Supported configurations for PyPI <!-- omit in toc -->
32
+
33
+
| OS / Python version |**Python 3.6**|**Python 3.7**|**Python 3.8**|**Python 3.9**|
Intel(R) Extension for Scikit-learn is easily built from sources with the majority of the necessary prerequisites available on conda or pip. The instructions below detail how to gather the prerequisites and build and install the completed package. The package can be built for all three major platforms (Windows, Linux, macOS).
75
+
76
+
### Prerequisites
77
+
* Python version >= 3.6
78
+
79
+
### Configure the build with environment variables
80
+
* SKLEARNEX_VERSION: sets package version
81
+
82
+
### Build Intel(R) Extension for Scikit-learn
83
+
- To install the package:
84
+
85
+
```bash
86
+
cd<checkout-dir>
87
+
python setup_sklearnex.py install
88
+
```
89
+
90
+
- To install the package in the development mode:
91
+
92
+
```bash
93
+
cd<checkout-dir>
94
+
python setup_sklearnex.py develop
95
+
```
96
+
97
+
- To install scikit-learn-intelex without downloading daal4py:
⚠️ 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
37
109
38
110
⚠️ The `develop` mode will not install the package but it will create a `.egg-link` in the deployment directory
@@ -42,11 +114,17 @@ without having to reinstall package every time you make a small change.
42
114
⚠️ `--single-version-externally-managed` is an option used for Python packages instructing the setuptools module
43
115
to create a Python package that can be easily managed by the package manager on the host.
44
116
45
-
## Building documentation for Intel(R) Extension for Scikit-learn
117
+
## Build documentation for Intel(R) Extension for Scikit-learn
46
118
### Prerequisites for creating documentation
47
-
* sphinx
48
-
* sphinx_rtd_theme
49
119
50
-
### Building documentation
51
-
1.```cd doc && make html```
52
-
2. The documentation will be in ```doc/_build/html```
120
+
See [requirements-doc.txt](requirements-doc.txt).
121
+
122
+
### Build documentation
123
+
124
+
Run:
125
+
126
+
```
127
+
cd doc && make html
128
+
```
129
+
130
+
The documentation will be in ```doc/_build/html```.
0 commit comments