Skip to content

Commit 2253b84

Browse files
committed
Followup fix on official doc update
Signed-off-by: Yikun Jiang <yikunkero@gmail.com>
1 parent 51eadc6 commit 2253b84

File tree

3 files changed

+30
-25
lines changed

3 files changed

+30
-25
lines changed

README.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,11 @@ By using vLLM Ascend plugin, popular open-source models, including Transformer-l
3333
## Prerequisites
3434

3535
- Hardware: Atlas 800I A2 Inference series, Atlas A2 Training series
36-
- Software: vLLM (the same version as vllm-ascned), Python >= 3.9, CANN >= 8.0.RC2, PyTorch >= 2.4.0, torch-npu >= 2.4.0
36+
- Software:
37+
* Python >= 3.9
38+
* CANN >= 8.0.RC2
39+
* PyTorch >= 2.4.0, torch-npu >= 2.4.0
40+
* vLLM (the same version as vllm-ascend)
3741

3842
Find more about how to setup your environment step by step in [here](docs/installation.md).
3943

@@ -64,7 +68,7 @@ Run the following command to start the vLLM server with the [Qwen/Qwen2.5-0.5B-I
6468
vllm serve Qwen/Qwen2.5-0.5B-Instruct
6569
curl http://localhost:8000/v1/models
6670
```
67-
**Please refer to [Official Docs](./docs/index.md) for more details.**
71+
**Please refer to [official docs](./docs/index.md) for more details.**
6872

6973
## Contributing
7074
See [CONTRIBUTING](./CONTRIBUTING.md) for more details, which is a step-by-step guide to help you set up development environment, build and test.

README.zh.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,9 +33,13 @@ vLLM 昇腾插件 (`vllm-ascend`) 是一个让vLLM在Ascend NPU无缝运行的
3333
## 准备
3434

3535
- 硬件:Atlas 800I A2 Inference系列、Atlas A2 Training系列
36-
- 软件:vLLM(与vllm-ascn​​ed版本相同),Python >= 3.9,CANN >= 8.0.RC2,PyTorch >= 2.4.0,torch-npu >= 2.4.0
36+
- 软件:
37+
* Python >= 3.9
38+
* CANN >= 8.0.RC2
39+
* PyTorch >= 2.4.0, torch-npu >= 2.4.0
40+
* vLLM (与vllm-ascend版本一致)
3741

38-
[此处](docs/installation.md) 中查找有关如何逐步设置环境的更多信息
42+
[此处](docs/installation.md),您可以了解如何逐步准备环境
3943

4044
## 开始使用
4145

docs/installation.md

Lines changed: 18 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,14 @@
11
# Installation
22

3-
4-
## Building
5-
6-
#### Build Python package from source
7-
8-
```bash
9-
git clone https://github.com/vllm-project/vllm-ascend.git
10-
cd vllm-ascend
11-
pip install -e .
12-
```
13-
14-
#### Build container image from source
15-
```bash
16-
git clone https://github.com/vllm-project/vllm-ascend.git
17-
cd vllm-ascend
18-
docker build -t vllm-ascend-dev-image -f ./Dockerfile .
19-
```
20-
21-
### Prepare Ascend NPU environment
22-
23-
### Dependencies
3+
### 1. Dependencies
244
| Requirement | Supported version | Recommended version | Note |
255
| ------------ | ------- | ----------- | ----------- |
266
| Python | >= 3.9 | [3.10](https://www.python.org/downloads/) | Required for vllm |
277
| CANN | >= 8.0.RC2 | [8.0.RC3](https://www.hiascend.com/developer/download/community/result?module=cann&cann=8.0.0.beta1) | Required for vllm-ascend and torch-npu |
288
| torch-npu | >= 2.4.0 | [2.5.1rc1](https://gitee.com/ascend/pytorch/releases/tag/v6.0.0.alpha001-pytorch2.5.1) | Required for vllm-ascend |
299
| torch | >= 2.4.0 | [2.5.1](https://github.com/pytorch/pytorch/releases/tag/v2.5.1) | Required for torch-npu and vllm required |
3010

11+
### 2. Prepare Ascend NPU environment
3112

3213
Below is a quick note to install recommended version software:
3314

@@ -56,3 +37,19 @@ You do not need to install `torch` and `torch_npu` manually, they will be automa
5637

5738
Or follow the instructions provided in the [Ascend Installation Guide](https://ascend.github.io/docs/sources/ascend/quick_install.html) to set up the environment.
5839

40+
### 3. Building
41+
42+
#### Build Python package from source
43+
44+
```bash
45+
git clone https://github.com/vllm-project/vllm-ascend.git
46+
cd vllm-ascend
47+
pip install -e .
48+
```
49+
50+
#### Build container image from source
51+
```bash
52+
git clone https://github.com/vllm-project/vllm-ascend.git
53+
cd vllm-ascend
54+
docker build -t vllm-ascend-dev-image -f ./Dockerfile .
55+
```

0 commit comments

Comments
 (0)