Skip to content

Commit 3e4afaa

Browse files
committed
update doc and test name
Signed-off-by: Srikanth Ramakrishna <srikanth.ramakrishna@intel.com>
1 parent 62e2031 commit 3e4afaa

File tree

3 files changed

+29
-36
lines changed

3 files changed

+29
-36
lines changed

python/README.md

+28
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
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 also available for Intel® dGPUs, that includes the latest driver packages and Intel® OneAPI runtime libraries that enables Machine Learning frameworks leverage the XPU device plugin.
6+
57
## Images
68

79
The images below include variations for only the core packages in the [Intel® Distribution for Python*] installation, or all of the packages.
@@ -10,6 +12,7 @@ The images below include variations for only the core packages in the [Intel® D
1012
| ---------------------- | ---------- |
1113
| `3.10-full`, `latest` | `2024.2.0` |
1214
| `3.10-core` | `2024.2.0` |
15+
| `3.10-xpu-idp` | `2024.2.1` |
1316

1417
## Run a Performance Sample
1518

@@ -38,6 +41,19 @@ pip install numpy
3841
python /tests/perf_sample.py
3942
```
4043

44+
### Run a Sanity test using the XPU variant
45+
46+
Use the following command to check the availability of Intel dGPU devices on your system and the presence of Intel® OneAPI runtime libraries.
47+
48+
```bash
49+
# Use the working directory from the first command
50+
docker run --rm -it \
51+
-v $PWD/tests:/tests \
52+
--device /dev/dri \
53+
intel/python:3.10-xpu-idp \
54+
bash /tests/xpu_base_layers_test.sh
55+
```
56+
4157
## Build from Source (Advanced)
4258

4359
To build the images from source, clone the [AI Containers](https://github.com/intel/ai-containers) repository, follow the main `README.md` file to setup your environment, and run the following command:
@@ -48,12 +64,21 @@ docker compose build idp
4864
docker compose run idp
4965
```
5066

67+
To build the xpu variant of the image, run the following commands:
68+
69+
```bash
70+
cd python
71+
docker compose build xpu
72+
docker compose run xpu
73+
```
74+
5175
You can find the list of services below for each container in the group:
5276

5377
| Service Name | Description |
5478
| ------------ | ------------------------------------------------------------------- |
5579
| `idp` | Base image with [Intel® Distribution for Python*] |
5680
| `pip` | Equivalent python image without [Intel® Distribution for Python*] |
81+
| `xpu` | Base Image for Intel XPU plugin with and without [Intel® Distribution for Python*] |
5782

5883
## License
5984

@@ -67,3 +92,6 @@ It is the image user's responsibility to ensure that any use of The images below
6792

6893
[Intel® Distribution for Python*]: https://www.intel.com/content/www/us/en/developer/tools/oneapi/distribution-for-python.html#gs.9bos9m
6994
[Intel® Math Kernel Library]: https://www.intel.com/content/www/us/en/developer/tools/oneapi/onemkl.html
95+
[Intel® DPC++ Compiler Library]: https://www.intel.com/content/www/us/en/developer/tools/oneapi/dpc-compiler-download.html
96+
[Intel® Collective Communications Library]: https://www.intel.com/content/www/us/en/developer/tools/oneapi/oneccl.html
97+
[Intel® dGPU driver releases ]: https://dgpu-docs.intel.com/releases/releases.html

python/tests/tests.yaml

+1-1
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ perf-stock:
2727
volumes:
2828
- dst: /tests
2929
src: $PWD/python/tests
30-
xpu-packages-${PACKAGE_OPTION:-pip}:
30+
xpu-base-layers-${PACKAGE_OPTION:-pip}:
3131
img: ${REGISTRY}/${REPO}:b-${GITHUB_RUN_NUMBER:-0}-${BASE_IMAGE_NAME:-ubuntu}-${BASE_IMAGE_TAG:-22.04}-${PACKAGE_OPTION:-pip}-py${PYTHON_VERSION:-3.10}-xpu-base
3232
cmd: bash /tests/xpu_packages_test.sh
3333
device: ["/dev/dri"]

python/tests/xpu_packages_test.sh

-35
This file was deleted.

0 commit comments

Comments
 (0)