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
{{ message }}
Repository navigation
Commit 3df70b7
Browse filesBrowse the repository at this point in the historyBrowse files
Copy file name to clipboardExpand all lines: docs/source/IDP_GSG.md
+96-72Lines changed: 96 additions & 72 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,15 +1,17 @@
1
1
2
-
[!(Intel® Distribution for Python*)](https://www.intel.com/content/www/us/en/developer/tools/oneapi/distribution-for-python.html) is a cluster of packages that includes Numba*, NumPy* and more. All these packages are optimized via [!(Intel® oneAPI Math Kernel Library (oneMKL))](https://www.intel.com/content/www/us/en/developer/tools/oneapi/onemkl.html#gs.ddfdq4) and [!(Intel® oneAPI Data Analytics Library (oneDAL))](https://www.intel.com/content/www/us/en/developer/tools/oneapi/onedal.html) to make the Python* application more efficient. The distribution includes a multitude of popular components, some of which include:
2
+
[Intel® Distribution for Python*](https://www.intel.com/content/www/us/en/developer/tools/oneapi/distribution-for-python.html) is a cluster of packages that includes Numba*, NumPy* and more. All these packages are optimized via [Intel® oneAPI Math Kernel Library (oneMKL](https://www.intel.com/content/www/us/en/developer/tools/oneapi/onemkl.html#gs.ddfdq4) and [Intel® oneAPI Data Analytics Library (oneDAL](https://www.intel.com/content/www/us/en/developer/tools/oneapi/onedal.html) to make the Python* application more efficient. The distribution includes a multitude of popular components, some of which include:
3
3
4
4
Libraries:
5
5
- Python
6
-
-numPy
6
+
-NumPy
7
7
- SciPy
8
+
8
9
Mkl interfaces:
9
10
- Mkl-service
10
11
- Mkl-random
11
12
- Mkl-fft
12
13
- Mkl-umath
14
+
13
15
GPU components:
14
16
- Dpctl
15
17
- Dpnp
@@ -20,22 +22,26 @@ GPU components:
20
22
CPUs:
21
23
- Intel® Core™ processor family
22
24
- Intel® Xeon® processor family
25
+
23
26
GPUs:
24
27
- Intel® UHD Graphics for 11th generation Intel processors or newer
25
28
- Intel® Iris® Xᵉ graphics
26
29
- Intel® Arc™ graphics
27
30
- Intel® Data Center GPU Flex Series
28
31
- Intel® Data Center GPU Max Series
32
+
29
33
Operating systems:
30
34
- Unix family*
31
35
- Windows® 10
32
36
- Windows* 11
33
37
- pported versions:
34
38
- Python 3.11, Python 3.12
39
+
35
40
Package management:
36
41
- conda*
37
42
- Pip
38
-
- mamba
43
+
- Mamba
44
+
39
45
Compatible with:
40
46
- VS Code
41
47
- Jupyter Notebook
@@ -44,39 +50,46 @@ Compatible with:
44
50
45
51
## Supported Installation Options
46
52
47
-
The Intel® Distribution for Python* supports several installation options
53
+
The Intel® Distribution for Python* supports several installation options
48
54
49
55
Supported operating systems are outlined under System Requirements.
50
-
You may select the components you wish to install. The full list of components in the Intel® Distribution for Python* is outlined on the landing page section [!(What’s Included)](https://www.intel.com/content/www/us/en/developer/tools/oneapi/distribution-for-python.html).
56
+
You may select the components you wish to install. The full list of components in the Intel® Distribution for Python* is outlined on the landing page section [What’s Included](https://www.intel.com/content/www/us/en/developer/tools/oneapi/distribution-for-python.html).
51
57
52
-
## GPU USers
53
-
You can use [!(Intel® Distribution for Python* in Intel® Tiber™ Developer Cloud)](https://www.intel.com/content/www/us/en/developer/tools/devcloud/services.html). After getting access to the cloud system, follow the instructions below to install Intel® Distribution for Python* with one of the available installation options.
58
+
## GPU Users
59
+
You can use [Intel® Distribution for Python* in Intel® Tiber™ Developer Cloud](https://www.intel.com/content/www/us/en/developer/tools/devcloud/services.html). After getting access to the cloud system, follow the instructions below to install Intel® Distribution for Python* with one of the available installation options.
54
60
55
61
## Offline Installer
56
-
1. To download Intel Distribution for Python*, visit here and choose the installation method of your choice.
62
+
1. To download the Intel® Distribution for Python*, visit [here](https://www.intel.com/content/www/us/en/developer/tools/oneapi/distribution-python-download.html) and choose the installation method of your choice.
57
63
2. Run the following commands to install on respective platform:
64
+
65
+
**Linux installation (Interactive)**
66
+
Note that the file name must be changed to how to appears in your downloads folder.
58
67
```bash
59
-
# Linux installation (Interactive)
60
-
# Note that the file name must be changed to how to appears in your downloads folder.
61
68
bash ~/intelpython3-202X.X.X.sh
69
+
```
62
70
63
-
# Linux installation (CLI)
71
+
**Linux installation (CLI)**
72
+
```bash
64
73
bash ~/intelpython3.sh -b -u -p ~/intelpython3
74
+
```
75
+
The flags can be included as necessary. They are used as follows:
76
+
-b enables batch mode, running the installation without interactive prompts.
77
+
-u updates the current installation. You may omit this if this is the first time you’re installing IDP on this machine.
78
+
-p specifies the installation path prefix. In this example, ~/intelpython3 is the target directory.
65
79
66
-
# The flags can be included as necessary. They are used as follows:
67
-
# -b enables batch mode, running the installation without interactive prompts.
68
-
# -u updates the current installation. You may omit this if this is the first time you’re installing IDP on this machine.
69
-
# -p specifies the installation path prefix. In this example, ~/intelpython3 is the target directory.
Navigate to the installation directory of Intel Python and find the "Scripts" directory, then run `.\activate` in the terminal. This runs the base activate script found at
91
-
`C:/User/path/to/intelpython3\Scripts\activate`
102
+
**Windows**
103
+
Navigate to the installation directory of Intel Python and find the "Scripts" directory, then run `.\activate` in the terminal.
92
104
93
-
The command prompt should point to installation when running `where python`
94
-
`(base) C:/User/path/to/intelpython3`
105
+
The command prompt should now show `(base)` at the start of the command prompt.
106
+
107
+
4. Verify instalaltion.
108
+
```bash
109
+
conda list
110
+
```
111
+
112
+
**Deactivating environment for Offline Installer**
113
+
To deactivate your IDP environment, run the command below until base env is deactivated.
114
+
115
+
```bash
116
+
conda deactivate
117
+
```
95
118
96
-
Installation verification – `conda list`
97
-
98
-
*Deactivating environment for Offline Installer*
99
-
To deactivate your IDP environment, run `conda deactivate` until base env is deactivated
100
-
`conda deactivate`
101
119
102
120
## Conda
103
121
1. Follow conda Installation Guide to install conda in your environment. If you already have conda installed in your system, update it with the command:
104
-
`conda update conda `
122
+
```bash
123
+
conda update conda
124
+
```
105
125
2. Add Intel channel and conda-forge to tell conda to choose Intel packages over default packages when available.
# Remove defaults channel from .condarc if it exists
129
+
```
130
+
Remove defaults channel from .condarc if it exists
131
+
```bash
111
132
conda config --remove channels defaults
112
133
```
113
-
3. Install Intel® Distribution for Python* via conda. We recommend that you create a new environment while installing. To install the core python3 environment, run the following command:
134
+
3. Install Intel® Distribution for Python* via conda. We recommend that you create a new environment while installing. To install the python3 environment, run the following command:
For individual installation commands, refer to the [!(What’s included](https://www.intel.com/content/www/us/en/developer/articles/tool/whats-included-distribution-for-python.html#packageEnvironmentManagers) section.
>For individual installation commands, refer to the [What’s included](https://www.intel.com/content/www/us/en/developer/articles/tool/whats-included-distribution-for-python.html#packageEnvironmentManagers) section.
118
140
4. Activate the conda environment:
119
-
`conda activate idp`
141
+
```bash
142
+
conda activate idp
143
+
```
120
144
121
145
## Mamba
122
-
1. If you do not have Mamba, get Miniforge by following the instructions here
123
-
`conda update mamba`
146
+
1. If you do not have Mamba, get Miniforge by following the instructions [here](https://github.com/conda-forge/miniforge?tab=readme-ov-file#install). Otherwise, ensure that it is updated:
147
+
```bash
148
+
conda update mamba
149
+
```
124
150
2. Add Intel channel and conda-forge to tell conda to choose Intel packages over default packages, when available.
# Remove defaults channel from .condarc if it exists
154
+
```
155
+
Remove defaults channel from .condarc if it exists.
156
+
```bash
130
157
conda config --remove channels defaults
131
158
```
132
159
3. Install Intel® Distribution for Python* via Mamba. We recommend that you create a new environment while installing. To install the core python3 environment, run the following command:
Please note that “x” in “python=3.x” should signify which version of Python* you would like to install.
160
+
```bash
161
+
mamba create -n idp intelpython3_full python=3.x
162
+
```
163
+
Please note that “x” in `python=3.x` should signify which version of Python* you would like to install.
164
+
135
165
4. Acitvate conda environment, then follow the usual steps for activating the environment:
166
+
```bash
136
167
mamba activate idp
137
-
5. Installation verification
138
-
`mamba list `
168
+
```
169
+
5. Verify installation.
170
+
```bash
171
+
mamba list
172
+
```
139
173
140
174
## Docker
141
-
1. If you don’t have Docker installed on your machine, follow [!(these instructions)](https://docs.docker.com/engine/install/) to install it.
142
-
2. Pull the image from [!(DockerHub)](https://hub.docker.com/r/intel/python) using the following command:
143
-
`docker pull intel/python:latest `
175
+
1. If you don’t have Docker installed on your machine, follow [these instructions](https://docs.docker.com/engine/install/) to install it.
176
+
2. Pull the image from [DockerHub](https://hub.docker.com/r/intel/python) using the following command:
177
+
```bash
178
+
docker pull intel/python:latest
179
+
```
144
180
3. Run a performance sample by running the following commands:
145
181
```bash
146
182
git clone https://github.com/intel/ai-containers
@@ -150,27 +186,14 @@ docker run --rm -it \
150
186
intel/python:latest \
151
187
python /tests/perf_sample.py
152
188
```
153
-
4. Installation verification
154
-
`conda list`
155
-
156
-
## Proof of Concept
157
-
You can see the benefits of using the Intel® Distribution for Python* on your own machine by comparing a simple program’s runtime between both distributions. First, run the sample code below in your new Intel® Distribution for Python* environment, and take note of the total runtime which should be displayed in the output.
189
+
4. Verify installation.
158
190
```bash
159
-
import numpy as np
160
-
import time
161
-
162
-
start = time.time()
163
-
164
-
rd = np.random.RandomState(88)
165
-
a = rd.randint(1,1000,(1000,1000))
166
-
y = rd.randint(1,1000,(1000))
167
-
res = np.linalg.solve(a,y)
191
+
conda list
192
+
```
168
193
169
-
end = time.time()
194
+
## Example with NumPy
195
+
You can see the benefits of using the Intel® Distribution for Python* on your own machine by comparing a simple program’s runtime between both distributions. First, run the sample code below in your new Intel® Distribution for Python* environment, and take note of the total runtime which should be displayed in the output.
170
196
171
-
print(res)
172
-
print('Time Consuming:',end-start)
173
-
```
174
197
175
198
Once you have taken note of the runtime of this program, switch the environment back to stock Python* and run the script again. Compare the runtime in the stock environment to the runtime in the Intel® distribution environment. You should see the benefits provided by the Intel® Distribution for Python* through the significantly decreased runtime.
176
199
@@ -182,16 +205,17 @@ this]
182
205
No special modifications to your existing Python* projects are required to start using them with this toolkit. You can refer to samples on GitHub to learn more about this distribution.#
-[Data Parallel Extension for NumPy* documentation](https://intelpython.github.io/dpnp/)
214
+
-[Data Parallel Control Library* documentation](https://intelpython.github.io/dpctl/latest/index.html)
215
+
-[Data Parallel Extension for Numba* documentation](https://intelpython.github.io/numba-dpex/latest/index.html)
192
216
193
217
## Support
194
-
If you have further questions or need support on your workload optimization, please submit your queries to the [!(Intel® Distribution for Python* Forum)](https://community.intel.com/t5/Intel-Distribution-for-Python/bd-p/distribution-python) or [!(Intel® Distribution for Python* GitHub)](https://github.com/IntelPython), on the Issues or Discussions pages, depending on the type of support required.
218
+
If you have further questions or need support on your workload optimization, please submit your queries to the [Intel® Distribution for Python* Forum](https://community.intel.com/t5/Intel-Distribution-for-Python/bd-p/distribution-python) or [Intel® Distribution for Python* GitHub](https://github.com/IntelPython), on the Issues or Discussions pages, depending on the type of support required.
195
219
196
220
## Notices and Disclaimers
197
221
Performance varies by use, configuration and other factors. Learn more at www.Intel.com/PerformanceIndex.
0 commit comments