Skip to content

Commit d4e0f3d

Browse files
author
Tyler Titsworth
authored
Update README.md
Signed-off-by: Tyler Titsworth <tyler.titsworth@intel.com>
1 parent e194d63 commit d4e0f3d

File tree

1 file changed

+27
-14
lines changed

1 file changed

+27
-14
lines changed

python/README.md

+27-14
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,6 @@
22

33
[Intel® Distribution for Python] enhances performance and can improve your program speed from 10 to 100 times faster. It is a Python distribution that includes the [Intel® Math Kernel Library] (oneMKL) and other Intel performance libraries to enable near-native performance through acceleration of core numerical and machine learning packages.
44

5-
[Intel® Distribution for Python] is available as part of the [Intel® oneAPI Base Toolkit](https://software.intel.com/content/www/us/en/develop/tools/oneapi/base-toolkit.html).
6-
75
## Images
86

97
The images below include variations for only the core packages in the [Intel® Distribution for Python] installation, or all of the packages.
@@ -13,7 +11,33 @@ The images below include variations for only the core packages in the [Intel® D
1311
| `3.10-full`, `latest` | `2024.2.0` |
1412
| `3.10-core` | `2024.2.0` |
1513

16-
## Build from Source
14+
## Run a Performance Sample
15+
16+
To run a performance sample run the following commands:
17+
18+
```bash
19+
git clone https://github.com/intel/ai-containers
20+
cd ai-containers/python
21+
docker run --rm -it \
22+
-v $PWD/tests:/tests \
23+
intel/python:latest \
24+
python /tests/perf_sample.py
25+
```
26+
27+
### Compare the results against stock python
28+
29+
In the previous command, you should see a result at the bottom like: `Time Consuming: 0.03897857666015625`. We can compare this against `python:3.11-slim-bullseye`
30+
31+
```bash
32+
docker run --rm -it \
33+
-v $PWD/tests:/tests \
34+
python:3.11-slim-bullseye \
35+
bash
36+
pip install numpy
37+
python /tests/perf_sample.py
38+
```
39+
40+
## Build from Source (Advanced)
1741

1842
To build the images from source, clone the [Intel® AI Containers](https://github.com/intel/ai-containers) repository, follow the main `README.md` file to setup your environment, and run the following commands:
1943

@@ -30,17 +54,6 @@ You can find the list of services below for each container in the group:
3054
| `idp` | Base image with [Intel® Distribution for Python] |
3155
| `pip` | Equivalent python image without [Intel® Distribution for Python] |
3256

33-
## Run a Performance Sample
34-
35-
To run a performance sample, clone the [Intel® AI Containers](https://github.com/intel/ai-containers) repository, follow the main `README.md` file to setup your environment, and run the following commands:
36-
37-
```bash
38-
cd python
39-
docker run --rm -it \
40-
-v $PWD/tests:/tests \
41-
intel/python:latest \
42-
python /tests/perf_sample.py
43-
```
4457

4558
## License
4659

0 commit comments

Comments
 (0)