Skip to content

Commit e244659

Browse files
authored
readme minor update (#5)
Signed-off-by: roger feng <[email protected]>
1 parent 97d4c29 commit e244659

File tree

1 file changed

+12
-13
lines changed

1 file changed

+12
-13
lines changed

README.md

Lines changed: 12 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,46 +1,45 @@
11
## About
22

3-
This repo is designed as a vLLM plugin for Intel GPU (also know as XPU in pytorch) which will provide custom kernels used in vLLM.
3+
This repo is designed as a vLLM plugin which provides custom kernels for Intel GPU (known as XPU in PyTorch).
44

55
## Getting started
6+
Currently we use PyTorch 2.8, oneapi 2025.1.
67

7-
current we use torch 2.8, oneapi is 2025.1.
8+
### How it works
9+
python3 setup.py build - will build a `_C.abi3.so` under build directory
10+
python3 setup.py install - will copy above .so to `vllm_xpu_kernels` folder
11+
python3 setup.py develop - will be local install if we use develop build or system/virtual env lib path if we use install.
812

9-
### how this project works
10-
Build system of this project will build a `_C.abi3.so` under build dir, and install step will copy this to `vllm_xpu_kernels` folder(will be local install if we use develop build or system/virtual env lib path if we use install). On vllm side, we will
11-
`import vllm_xpu_kernels._C` at start time which should register all custom ops so we can directly use.
13+
On vllm side, we will `import vllm_xpu_kernels._C` at start time which should register all custom ops so we can directly use.
1214

1315
### prepare
1416

1517
Install oneapi 2025.1 deep learning essential [dependency](https://www.intel.com/content/www/us/en/developer/tools/oneapi/base-toolkit-download.html).
1618

17-
create a new virtual env, install build dependency and torch dependency
19+
Create a new virtual env, install build dependency and torch dependency
1820

1921
```
2022
pip install -r requirements.txt
2123
```
2224

2325
### build & install
24-
development install command (which will install to current dir):
26+
Build development installation to current directory:
2527

2628
```
2729
VLLM_TARGET_DEVICE=xpu python3 setup.py develop
2830
```
2931

30-
or
31-
32-
install to system dir
32+
or installation to system directory:
3333

3434
```
3535
VLLM_TARGET_DEVICE=xpu python3 setup.py install
3636
```
3737

38-
or build wheel(generate on dist folder)
38+
or build wheel (generated .whl in dist folder)
3939

4040
```
4141
VLLM_TARGET_DEVICE=xpu python3 setup.py bdist_wheel
4242
```
4343

4444
### how to use in vLLM
45-
46-
please use this branch https://github.com/jikunshang/vllm/tree/xpu_kernel to install & test vllm. which already replace rms norm kernel from ipex to vllm-xpu-kernels.
45+
Please refer to temporary branch https://github.com/jikunshang/vllm/tree/xpu_kernel to install & test vllm which replaces `rms_norm` kernel from IPEX to vllm-xpu-kernels.

0 commit comments

Comments
 (0)