Skip to content

Commit 933fa25

Browse files
PahandrovichPahandrovich
authored
Add HW list in documentation (#785)
1 parent 263ea96 commit 933fa25

File tree

5 files changed

+175
-102
lines changed

5 files changed

+175
-102
lines changed

‎doc/sources/algorithms.rst‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -34,11 +34,11 @@ algorithms:
3434
- Data support
3535
* - Classification
3636
- SVC
37-
- All parameters except ``kernel`` = 'sigmoid'.
37+
- All parameters are supported
3838
- No limitations.
3939
* - Classification
4040
- NuSVC
41-
- All parameters except ``kernel`` = 'sigmoid'.
41+
- All parameters are supported
4242
- No limitations.
4343
* - Classification
4444
- RandomForestClassifier
@@ -54,11 +54,11 @@ algorithms:
5454
- Only dense data is supported.
5555
* - Regression
5656
- SVR
57-
- All parameters except ``kernel`` = 'sigmoid'.
57+
- All parameters are supported
5858
- No limitations.
5959
* - Regression
6060
- NuSVR
61-
- All parameters except ``kernel`` = 'sigmoid'.
61+
- All parameters are supported
6262
- No limitations.
6363
* - Regression
6464
- RandomForestRegressor

‎doc/sources/contents.rst‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,3 +29,4 @@ Intel(R) Extension for Scikit-learn*
2929
Intel(R) Extension for Scikit-learn* Verbose <verbose>
3030
Global patching <global_patching>
3131
oneAPI and GPU support <oneapi_gpu>
32+
System requirements <system_requirements>

‎doc/sources/get_started.rst‎

Lines changed: 0 additions & 98 deletions
Original file line numberDiff line numberDiff line change
@@ -39,104 +39,6 @@ Sources and build instructions are available in `Intel(R) Extension for Scikit-l
3939

4040
conda install scikit-learn-intelex -c intel
4141

42-
Supported configurations
43-
------------------------
44-
45-
**PyPi channel**
46-
47-
.. list-table::
48-
:widths: 25 8 8 8 8
49-
:header-rows: 1
50-
:align: left
51-
52-
* - OS / Python version
53-
- Python 3.6
54-
- Python 3.7
55-
- Python 3.8
56-
- Python 3.9
57-
* - Linux
58-
- ✔️
59-
- ✔️
60-
- ✔️
61-
- ❌
62-
* - Windows
63-
- ✔️
64-
- ✔️
65-
- ✔️
66-
- ❌
67-
* - OsX
68-
- ✔️
69-
- ✔️
70-
- ✔️
71-
- ❌
72-
73-
.. note::
74-
It supports Intel CPU and GPU except on OsX.
75-
76-
**Anaconda Cloud: Conda-Forge channel**
77-
78-
.. list-table::
79-
:widths: 25 8 8 8 8
80-
:header-rows: 1
81-
:align: left
82-
83-
* - OS / Python version
84-
- Python 3.6
85-
- Python 3.7
86-
- Python 3.8
87-
- Python 3.9
88-
* - Linux
89-
- ✔️
90-
- ✔️
91-
- ✔️
92-
- ✔️
93-
* - Windows
94-
- ✔️
95-
- ✔️
96-
- ✔️
97-
- ✔️
98-
* - OsX
99-
- ✔️
100-
- ✔️
101-
- ✔️
102-
- ✔️
103-
104-
.. note::
105-
It supports only Intel CPU.
106-
Recommended for conda users by default.
107-
108-
**Anaconda Cloud: Intel channel**
109-
110-
.. list-table::
111-
:widths: 25 8 8 8 8
112-
:header-rows: 1
113-
:align: left
114-
115-
* - OS / Python version
116-
- Python 3.6
117-
- Python 3.7
118-
- Python 3.8
119-
- Python 3.9
120-
* - Linux
121-
- ✔️
122-
- ✔️
123-
- ✔️
124-
- ❌
125-
* - Windows
126-
- ✔️
127-
- ✔️
128-
- ✔️
129-
- ❌
130-
* - OsX
131-
- ✔️
132-
- ✔️
133-
- ✔️
134-
- ❌
135-
136-
.. note::
137-
It supports Intel CPU and GPU except on OsX.
138-
Recommended for conda users who use other components from Intel(R) Distribution for Python.
139-
14042
Building from Sources
14143
---------------------
14244

‎doc/sources/index.rst‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -99,6 +99,8 @@ You can find the :ref:`full patching map here <sklearn_algorithms>`.
9999
Intel(R) Extension for Scikit-learn supports optimizations for the last four versions of scikit-learn.
100100
The latest release of scikit-learn-intelex-2021.3.X supports scikit-learn 0.22.X, 0.23.X, 0.24.X and 1.0.X.
101101

102+
.. _blogs:
103+
102104
Follow us on Medium
103105
--------------------
104106
We publish blogs on Medium, so `follow us <https://medium.com/intel-analytics-software/tagged/machine-learning>`_

‎doc/sources/system_requirements.rst‎

Lines changed: 168 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,168 @@
1+
.. ******************************************************************************
2+
.. * Copyright 2021 Intel Corporation
3+
.. *
4+
.. * Licensed under the Apache License, Version 2.0 (the "License");
5+
.. * you may not use this file except in compliance with the License.
6+
.. * You may obtain a copy of the License at
7+
.. *
8+
.. * http://www.apache.org/licenses/LICENSE-2.0
9+
.. *
10+
.. * Unless required by applicable law or agreed to in writing, software
11+
.. * distributed under the License is distributed on an "AS IS" BASIS,
12+
.. * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
.. * See the License for the specific language governing permissions and
14+
.. * limitations under the License.
15+
.. *******************************************************************************/
16+
17+
.. _system_requirements:
18+
19+
###################
20+
System requirements
21+
###################
22+
23+
This page provides details about hardware, operating system, and software prerequisites for Intel® Extension for Scikit-learn.
24+
25+
Supported configurations
26+
------------------------
27+
28+
**PyPi channel**
29+
30+
.. list-table::
31+
:widths: 25 8 8 8 8
32+
:header-rows: 1
33+
:align: left
34+
35+
* - OS / Python version
36+
- Python 3.6
37+
- Python 3.7
38+
- Python 3.8
39+
- Python 3.9
40+
* - Linux
41+
- ✔️
42+
- ✔️
43+
- ✔️
44+
- ✔️
45+
* - Windows
46+
- ✔️
47+
- ✔️
48+
- ✔️
49+
- ✔️
50+
* - macOS
51+
- ✔️
52+
- ✔️
53+
- ✔️
54+
- ✔️
55+
56+
.. note::
57+
It supports CPUs and GPUs
58+
59+
**Anaconda Cloud: Conda-Forge channel**
60+
61+
.. list-table::
62+
:widths: 25 8 8 8 8
63+
:header-rows: 1
64+
:align: left
65+
66+
* - OS / Python version
67+
- Python 3.6
68+
- Python 3.7
69+
- Python 3.8
70+
- Python 3.9
71+
* - Linux
72+
- ✔️
73+
- ✔️
74+
- ✔️
75+
- ✔️
76+
* - Windows
77+
- ✔️
78+
- ✔️
79+
- ✔️
80+
- ✔️
81+
* - macOS
82+
- ✔️
83+
- ✔️
84+
- ✔️
85+
- ✔️
86+
87+
.. note::
88+
It supports only CPUs.
89+
Recommended for conda users by default
90+
91+
**Anaconda Cloud: Intel channel**
92+
93+
.. list-table::
94+
:widths: 25 8 8 8 8
95+
:header-rows: 1
96+
:align: left
97+
98+
* - OS / Python version
99+
- Python 3.6
100+
- Python 3.7
101+
- Python 3.8
102+
- Python 3.9
103+
* - Linux
104+
- ✔️
105+
- ✔️
106+
- ✔️
107+
- ✔️
108+
* - Windows
109+
- ✔️
110+
- ✔️
111+
- ✔️
112+
- ✔️
113+
* - macOS
114+
- ✔️
115+
- ✔️
116+
- ✔️
117+
- ✔️
118+
119+
.. note::
120+
It supports CPUs and GPUs.
121+
Recommended for conda users who use other components from Intel(R) Distribution for Python
122+
123+
System Requirements
124+
-------------------
125+
126+
For CPU users
127+
=============
128+
129+
**Operating systems**
130+
131+
The last two versions of the following operating systems:
132+
133+
- **Linux**\*
134+
- **Windows**\* and **Windows\* Server**
135+
- **macOS**\*
136+
137+
**Hardware platforms**
138+
139+
- All processors with x86 architecture
140+
141+
.. note::
142+
Your processor must support at least one of SSE2, AVX, AVX2, AVX512 instruction sets.
143+
144+
.. note::
145+
ARM* architecture is not supported.
146+
147+
.. note::
148+
Intel® processors provide better performance then other CPUs.
149+
Read more about hardware comparison in our :ref:`blogs <blogs>`.
150+
151+
For GPU users
152+
=============
153+
154+
.. warning::
155+
If you are using accelerators, please refer to the DPC++ compiler system
156+
requirements `here <https://software.intel.com/content/www/us/en/develop/articles/intel-oneapi-dpcpp-system-requirements.html>`_
157+
158+
**Operating systems**
159+
160+
The last two versions of the following operating systems:
161+
162+
- **Linux**\*
163+
- **Windows**\* and **Windows\* Server**
164+
165+
**Hardware platforms**
166+
167+
- All Intel® integrated and discrete GPUs
168+
- `Intel® GPU drivers <https://www.intel.com/content/www/us/en/develop/articles/installation-guide-for-intel-oneapi-toolkits.html#installGPUdriver>`__

0 commit comments

Comments
 (0)