Skip to content

Commit a373b89

Browse files
author
Lu Teng
authored
[Doc] Update release info (#410)
1 parent 433b4ce commit a373b89

File tree

6 files changed

+29
-49
lines changed

6 files changed

+29
-49
lines changed

README.md

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ This guide introduces the overview of OpenXLA high level integration structure a
1414
## 1. Overview
1515

1616
<p align="center">
17-
<img src="openxla_for_intel_gpu.jpg" width="50%">
17+
<img src="openxla_for_intel_gpu.png" width="50%">
1818
</p>
1919

2020
* [JAX](https://jax.readthedocs.io/en/latest/) provides a familiar NumPy-style API, includes composable function transformations for compilation, batching, automatic differentiation, and parallelization, and the same code executes on multiple backends.
@@ -26,29 +26,29 @@ This guide introduces the overview of OpenXLA high level integration structure a
2626

2727
Verified Hardware Platforms:
2828

29-
* Intel® Data Center GPU Max Series, Driver Version: [803](https://dgpu-docs.intel.com/releases/LTS_803.29_20240131.html)
29+
* Intel® Data Center GPU Max Series, Driver Version: [803](https://dgpu-docs.intel.com/releases/LTS_803.63_20240617.html)
3030

31-
* Intel® Data Center GPU Flex Series 170, Driver Version: [803](https://dgpu-docs.intel.com/releases/LTS_803.29_20240131.html)
31+
* Intel® Data Center GPU Flex Series 170, Driver Version: [803](https://dgpu-docs.intel.com/releases/LTS_803.63_20240617.html)
3232

3333
### Software Requirements
3434

3535
* Ubuntu 22.04 (64-bit)
3636
* Intel® Data Center GPU Flex Series
3737
* Ubuntu 22.04, SUSE Linux Enterprise Server(SLES) 15 SP4
3838
* Intel® Data Center GPU Max Series
39-
* Intel® oneAPI Base Toolkit 2024.1
39+
* [Intel® oneAPI Base Toolkit 2024.2](https://www.intel.com/content/www/us/en/developer/articles/release-notes/intel-oneapi-toolkit-release-notes.html)
4040
* Jax/Jaxlib 0.4.26
4141
* Python 3.9-3.12
4242
* pip 19.0 or later (requires manylinux2014 support)
4343

44-
**NOTE: Since Jax has its own [platform limitation](https://jax.readthedocs.io/en/latest/installation.html#supported-platforms) (Ubuntu 20.04 or later), real software requirements is restricted when works with Jax.**
44+
**NOTE: Since JAX has its own [platform limitation](https://jax.readthedocs.io/en/latest/installation.html#supported-platforms) (Ubuntu 20.04 or later), real software requirements is restricted when works with JAX.**
4545

4646
### Install Intel GPU Drivers
4747

4848
|OS|Intel GPU|Install Intel GPU Driver|
4949
|-|-|-|
50-
|Ubuntu 22.04 |Intel® Data Center GPU Flex Series| Refer to the [Installation Guides](https://dgpu-docs.intel.com/installation-guides/index.html#intel-data-center-gpu-flex-series) for latest driver installation. If install the verified Intel® Data Center GPU Max Series/Intel® Data Center GPU Flex Series [803](https://dgpu-docs.intel.com/releases/LTS_803.29_20240131.html), please append the specific version after components, such as `sudo apt-get install intel-opencl-icd==23.43.27642.38-803~22.04`|
51-
|Ubuntu 22.04, SLES 15 SP4|Intel® Data Center GPU Max Series| Refer to the [Installation Guides](https://dgpu-docs.intel.com/installation-guides/index.html#intel-data-center-gpu-max-series) for latest driver installation. If install the verified Intel® Data Center GPU Max Series/Intel® Data Center GPU Flex Series [803](https://dgpu-docs.intel.com/releases/LTS_803.29_20240131.html), please append the specific version after components, such as `sudo apt-get install intel-opencl-icd==23.43.27642.38-803~22.04`|
50+
|Ubuntu 22.04 |Intel® Data Center GPU Flex Series| Refer to the [Installation Guides](https://dgpu-docs.intel.com/installation-guides/index.html#intel-data-center-gpu-flex-series) for latest driver installation. If install the verified Intel® Data Center GPU Max Series/Intel® Data Center GPU Flex Series [803](https://dgpu-docs.intel.com/releases/LTS_803.63_20240617.html), please append the specific version after components, such as `sudo apt-get install intel-opencl-icd==23.43.27642.52-803~22.04`|
51+
|Ubuntu 22.04, SLES 15 SP4|Intel® Data Center GPU Max Series| Refer to the [Installation Guides](https://dgpu-docs.intel.com/installation-guides/index.html#intel-data-center-gpu-max-series) for latest driver installation. If install the verified Intel® Data Center GPU Max Series/Intel® Data Center GPU Flex Series [803](https://dgpu-docs.intel.com/releases/LTS_803.63_20240617.html), please append the specific version after components, such as `sudo apt-get install intel-opencl-icd==23.43.27642.52-803~22.04`|
5252

5353
### Install oneAPI Base Toolkit Packages
5454

@@ -58,34 +58,34 @@ Need to install components of Intel® oneAPI Base Toolkit:
5858
* Intel® oneAPI Math Kernel Library (oneMKL)
5959

6060
```bash
61-
$ wget https://registrationcenter-download.intel.com/akdlm/IRC_NAS/fdc7a2bc-b7a8-47eb-8876-de6201297144/l_BaseKit_p_2024.1.0.596.sh
61+
$ wget https://registrationcenter-download.intel.com/akdlm/IRC_NAS/e6ff8e9c-ee28-47fb-abd7-5c524c983e1c/l_BaseKit_p_2024.2.1.100_offline.sh
6262
# 2 components are necessary: DPC++/C++ Compiler and oneMKL
63-
sudo sh l_BaseKit_p_2024.1.0.596.sh
63+
sudo sh l_BaseKit_p_2024.2.1.100_offline.sh
6464

6565
# Source OneAPI env
66-
source /opt/intel/oneapi/compiler/2024.1/env/vars.sh
67-
source /opt/intel/oneapi/mkl/2024.1/env/vars.sh
66+
source /opt/intel/oneapi/compiler/2024.2/env/vars.sh
67+
source /opt/intel/oneapi/mkl/2024.2/env/vars.sh
6868
```
6969

70-
**Backup**: Recommend to rollback to **Toolkit 2024.0** if need collective feature. See [Release Notes](https://github.com/intel-innersource/frameworks.ai.intel-extension-for-openxla.intel-extension-for-openxla/releases) for more details.
70+
**Backup**: Recommend to rollback to **Toolkit 2024.1** if meet performance issue. See [Release Notes](https://github.com/intel/intel-extension-for-openxla/releases) for more details.
7171
```bash
72-
wget https://registrationcenter-download.intel.com/akdlm//IRC_NAS/20f4e6a1-6b0b-4752-b8c1-e5eacba10e01/l_BaseKit_p_2024.0.0.49564.sh
72+
wget https://registrationcenter-download.intel.com/akdlm/IRC_NAS/fdc7a2bc-b7a8-47eb-8876-de6201297144/l_BaseKit_p_2024.1.0.596.sh
7373
# 2 components are necessary: DPC++/C++ Compiler and oneMKL
74-
sudo sh l_BaseKit_p_2024.0.0.49564.sh
74+
sudo sh l_BaseKit_p_2024.1.0.596.sh
7575

7676
# Source OneAPI env
77-
source /opt/intel/oneapi/compiler/2024.0/env/vars.sh
78-
source /opt/intel/oneapi/mkl/2024.0/env/vars.sh
77+
source /opt/intel/oneapi/compiler/2024.1/env/vars.sh
78+
source /opt/intel/oneapi/mkl/2024.1/env/vars.sh
7979
```
8080

8181
### Install Jax and Jaxlib
8282

8383
```bash
84-
pip install -r test/requirements.txt
84+
pip install -r https://raw.githubusercontent.com/intel/intel-extension-for-openxla/main/test/requirements.txt
8585
```
86-
Check [test/requirements.txt](test/requirements.txt) for more details.
86+
Please refer to [test/requirements.txt](test/requirements.txt) for the version dependency of `jax`, `jaxlib` and `flax`.
8787

88-
The following table tracks intel-extension-for-openxla versions and compatible versions of jax and jaxlib. The compatibility between jax and jaxlib is maintained through JAX. This version restriction will be relaxed over time as the plugin API matures.
88+
The following table tracks intel-extension-for-openxla versions and compatible versions of `jax` and `jaxlib`. The compatibility between `jax` and `jaxlib` is maintained through JAX. This version restriction will be relaxed over time as the plugin API matures.
8989
|**intel-extension-for-openxla**|**jaxlib**|**jax**|
9090
|:-:|:-:|:-:|
9191
| 0.4.0 | 0.4.26 | >= 0.4.26, <= 0.4.27|

docs/acc_jax.md

Lines changed: 8 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,13 @@
11
# Accelerated JAX on Intel GPU
22

33
## Intel® Extension for OpenXLA* plug-in
4-
Intel® Extension for OpenXLA includes PJRT plugin implementation, which seamlessly runs JAX models on Intel GPU. The PJRT API simplified the integration, which allowed the Intel GPU plugin to be developed separately and quickly integrated into JAX. Refer to [OpenXLA PJRT Plugin RFC](https://github.com/openxla/community/blob/main/rfcs/20230123-pjrt-plugin.md) for more details.
4+
Intel® Extension for OpenXLA* includes PJRT plugin implementation, which seamlessly runs JAX models on Intel GPU. The PJRT API simplified the integration, which allowed the Intel GPU plugin to be developed separately and quickly integrated into JAX. Refer to [OpenXLA PJRT Plugin RFC](https://github.com/openxla/community/blob/main/rfcs/20230123-pjrt-plugin.md) for more details.
55

66
## Requirements
7-
8-
### Hardware Requirements
9-
10-
Verified Hardware Platforms:
11-
12-
* Intel® Data Center GPU Max Series, Driver Version: [803](https://dgpu-docs.intel.com/releases/LTS_803.63_20240617.html) ([Installation Guides](https://dgpu-docs.intel.com/installation-guides/index.html#intel-data-center-gpu-max-series))
13-
14-
* Intel® Data Center GPU Flex Series 170, Driver Version: [803](https://dgpu-docs.intel.com/releases/LTS_803.63_20240617.html) ([Installation Guides](https://dgpu-docs.intel.com/installation-guides/index.html#intel-data-center-gpu-flex-series))
15-
16-
### Software Requirements
17-
18-
* Ubuntu 22.04 (64-bit)
19-
* Intel® Data Center GPU Flex Series
20-
* Ubuntu 22.04, SUSE Linux Enterprise Server(SLES) 15 SP4
21-
* Intel® Data Center GPU Max Series
22-
* Intel® oneAPI Base Toolkit 2024.1 ([Installation Guides](https://github.com/intel/intel-extension-for-openxla/?tab=readme-ov-file#install-oneapi-base-toolkit-packages))
23-
* Jax/Jaxlib 0.4.26
24-
* Python 3.9-3.12
25-
* pip 19.0 or later (requires manylinux2014 support)
7+
Please check [README#requirements](../README.md#2-requirements) for the requirements of hardware and software.
268

279
## Install
28-
The following table tracks intel-extension-for-openxla versions and compatible versions of jax and jaxlib. The compatibility between jax and jaxlib is maintained through JAX. This version restriction will be relaxed over time as the plugin API matures.
10+
The following table tracks intel-extension-for-openxla versions and compatible versions of `jax` and `jaxlib`. The compatibility between `jax` and `jaxlib` is maintained through JAX. This version restriction will be relaxed over time as the plugin API matures.
2911
|**intel-extension-for-openxla**|**jaxlib**|**jax**|
3012
|:-:|:-:|:-:|
3113
| 0.4.0 | 0.4.26 | >= 0.4.26, <= 0.4.27|
@@ -39,9 +21,12 @@ The following table tracks intel-extension-for-openxla versions and compatible v
3921
conda create -n jax-ioex python=3.10
4022
conda activate jax-ioex
4123
pip install -U pip
42-
pip install jax==0.4.26 jaxlib==0.4.26
4324
pip install intel-extension-for-openxla
25+
26+
# Install jax, jaxlib and flax dependency
27+
pip install -r https://raw.githubusercontent.com/intel/intel-extension-for-openxla/main/test/requirements.txt
4428
```
29+
Please refer to [requirements.txt](../test/requirements.txt) for the version dependency of `jax`, `jaxlib` and `flax`.
4530

4631
## Verify
4732
```
@@ -61,12 +46,8 @@ bash Miniforge3-$(uname)-$(uname -m).sh
6146
```
6247

6348
### Setup environment
49+
Please follow [Install](#install) to prepare the basic environment first.
6450
```
65-
conda create -n stable-diffusion python=3.10
66-
conda activate stable-diffusion
67-
pip install -U pip
68-
pip install jax==0.4.26 jaxlib==0.4.26 flax==0.8.2
69-
pip install intel-extension-for-openxla
7051
pip install transformers==4.38 diffusers==0.26.3 datasets==2.12.0 msgpack==1.0.7
7152
```
7253
Source OneAPI env
@@ -76,9 +57,7 @@ source /opt/intel/oneapi/mkl/2024.2/env/vars.sh
7657
```
7758
**NOTE**: The path of OneAPI env script is based on the OneAPI installed path.
7859

79-
8060
### Run Demo (Stable Diffusion Inference)
81-
8261
Go to [example/stable_diffusion](../example/stable_diffusion/README.md) for detail about this demo.
8362

8463
| **Command** | **Model** | **Output Image Resolution** |

example/gptj/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ Script jax_gptj.py for [EleutherAI/gpt-j-6B](https://huggingface.co/EleutherAI/g
77
Mark `intel-extension-for-openxla` folder as \<WORKSPACE\>, then
88
```bash
99
cd <WORKSPACE>/example/gptj/
10-
pip transformers==4.38 datasets==2.20.0
10+
pip install transformers==4.38 datasets==2.20.0
1111
pip install -r ../../test/requirements.txt
1212
```
1313

openxla_for_intel_gpu.jpg

-67.2 KB
Binary file not shown.

openxla_for_intel_gpu.png

49.2 KB
Loading

xla/tools/pip_package/xla_setup.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -149,6 +149,7 @@ def finalize_options(self):
149149
'Programming Language :: Python :: 3.9',
150150
'Programming Language :: Python :: 3.10',
151151
'Programming Language :: Python :: 3.11',
152+
'Programming Language :: Python :: 3.12',
152153
'Topic :: Scientific/Engineering',
153154
'Topic :: Scientific/Engineering :: Mathematics',
154155
'Topic :: Scientific/Engineering :: Artificial Intelligence',

0 commit comments

Comments
 (0)