Skip to content

Commit 27181ea

Browse files
YikunYikun
committed
doctest
Signed-off-by: Yikun Jiang <yikunkero@gmail.com>
1 parent e564470 commit 27181ea

File tree

5 files changed

+238
-3
lines changed

5 files changed

+238
-3
lines changed

‎.github/workflows/vllm_ascend_doctest.yaml‎

Lines changed: 100 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,100 @@
1+
#
2+
# Copyright (c) 2025 Huawei Technologies Co., Ltd. All Rights Reserved.
3+
#
4+
# Licensed under the Apache License, Version 2.0 (the "License");
5+
# you may not use this file except in compliance with the License.
6+
# You may obtain a copy of the License at
7+
#
8+
# http://www.apache.org/licenses/LICENSE-2.0
9+
#
10+
# Unless required by applicable law or agreed to in writing, software
11+
# distributed under the License is distributed on an "AS IS" BASIS,
12+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
# See the License for the specific language governing permissions and
14+
# limitations under the License.
15+
# This file is a part of the vllm-ascend project.
16+
#
17+
18+
name: 'Doctest'
19+
20+
on:
21+
workflow_dispatch:
22+
pull_request:
23+
branches:
24+
- 'main'
25+
- '*-dev'
26+
paths:
27+
# If we are changing the doctest we should do a PR test
28+
- '.github/workflows/vllm_ascend_doctest.yaml'
29+
- 'tests/doctest/**'
30+
schedule:
31+
# Runs every 4 hours
32+
- cron: '0 */4 * * *'
33+
34+
# Bash shells do not use ~/.profile or ~/.bashrc so these shells need to be explicitly
35+
# declared as "shell: bash -el {0}" on steps that need to be properly activated.
36+
# It's used to activate ascend-toolkit environment variables.
37+
defaults:
38+
run:
39+
shell: bash -el {0}
40+
41+
jobs:
42+
test:
43+
strategy:
44+
# Each version should be tested
45+
fail-fast: false
46+
matrix:
47+
vllm_verison: [main, v0.7.3-dev, main-openeuler, v0.7.3-dev-openeuler]
48+
name: vLLM Ascend test
49+
runs-on: linux-arm64-npu-1
50+
container:
51+
image: m.daocloud.io/quay.io/ascend/vllm-ascend:${{ matrix.vllm_verison }}
52+
steps:
53+
- name: Check NPU/CANN and git info
54+
run: |
55+
echo "====> Prnint NPU/CANN info"
56+
npu-smi info
57+
cat /usr/local/Ascend/ascend-toolkit/latest/"$(uname -i)"-linux/ascend_toolkit_install.info
58+
59+
echo "====> Prnint vllm-ascend git info"
60+
cd /vllm-workspace/vllm-ascend
61+
git --no-pager log -1 || true
62+
echo "====> Prnint vllm git info"
63+
cd /vllm-workspace/vllm
64+
git --no-pager log -1 || true
65+
66+
- name: Config OS mirrors - Ubuntu
67+
if: ${{ !endsWith(matrix.vllm_verison, '-openeuler') }}
68+
run: |
69+
sed -i 's|ports.ubuntu.com|mirrors.tuna.tsinghua.edu.cn|g' /etc/apt/sources.list
70+
apt-get update -y
71+
apt install git curl -y
72+
73+
- name: Config OS mirrors - openEuler
74+
if: ${{ endsWith(matrix.vllm_verison, '-openeuler') }}
75+
run: |
76+
yum update -y
77+
yum install git curl -y
78+
79+
- name: Config pip mirrors
80+
run: |
81+
pip config set global.index-url https://mirrors.tuna.tsinghua.edu.cn/pypi/web/simple
82+
83+
- name: Checkout vllm-project/vllm-ascend repo
84+
uses: actions/checkout@v4
85+
86+
- name: Run vllm-ascend/tests/e2e/run_doctests.sh
87+
run: |
88+
# PWD: /__w/vllm-ascend/vllm-ascend
89+
# Address old branch like v0.7.3:
90+
if [ ! -d /vllm-workspace/vllm-ascend/tests/e2e ]; then
91+
echo "Warning: the doctest path doesn't exists, copy now"
92+
cp -r tests/e2e /vllm-workspace/vllm-ascend/tests/
93+
fi
94+
95+
# Simulate container to enter directory
96+
cd /workspace
97+
98+
# Run real test
99+
echo "Test:"
100+
/vllm-workspace/vllm-ascend/tests/e2e/run_doctests.sh

‎docs/source/quick_start.md‎

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -68,6 +68,7 @@ The default workdir is `/workspace`, vLLM and vLLM Ascend code are placed in `/v
6868

6969
You can use Modelscope mirror to speed up download:
7070

71+
<!-- tests/doctest/001-quickstart-test.sh should be considered updating as well -->
7172
```bash
7273
export VLLM_USE_MODELSCOPE=true
7374
```
@@ -81,6 +82,7 @@ With vLLM installed, you can start generating texts for list of input prompts (i
8182

8283
Try to run below Python script directly or use `python3` shell to generate texts:
8384

85+
<!-- tests/doctest/001-quickstart-test.sh should be considered updating as well -->
8486
```python
8587
from vllm import LLM, SamplingParams
8688

@@ -108,6 +110,7 @@ vLLM can also be deployed as a server that implements the OpenAI API protocol. R
108110
the following command to start the vLLM server with the
109111
[Qwen/Qwen2.5-0.5B-Instruct](https://huggingface.co/Qwen/Qwen2.5-0.5B-Instruct) model:
110112

113+
<!-- tests/doctest/001-quickstart-test.sh should be considered updating as well -->
111114
```bash
112115
# Deploy vLLM server (The first run will take about 3-5 mins (10 MB/s) to download models)
113116
vllm serve Qwen/Qwen2.5-0.5B-Instruct &
@@ -125,12 +128,14 @@ Congratulations, you have successfully started the vLLM server!
125128

126129
You can query the list the models:
127130

131+
<!-- tests/doctest/001-quickstart-test.sh should be considered updating as well -->
128132
```bash
129133
curl http://localhost:8000/v1/models | python3 -m json.tool
130134
```
131135

132136
You can also query the model with input prompts:
133137

138+
<!-- tests/doctest/001-quickstart-test.sh should be considered updating as well -->
134139
```bash
135140
curl http://localhost:8000/v1/completions \
136141
-H "Content-Type: application/json" \
@@ -145,10 +150,10 @@ curl http://localhost:8000/v1/completions \
145150
vLLM is serving as background process, you can use `kill -2 $VLLM_PID` to stop the background process gracefully,
146151
it's equal to `Ctrl-C` to stop foreground vLLM process:
147152

153+
<!-- tests/doctest/001-quickstart-test.sh should be considered updating as well -->
148154
```bash
149-
ps -ef | grep "/.venv/bin/vllm serve" | grep -v grep
150-
VLLM_PID=`ps -ef | grep "/.venv/bin/vllm serve" | grep -v grep | awk '{print $2}'`
151-
kill -2 $VLLM_PID
155+
VLLM_PID=$(pgrep -f "vllm serve")
156+
kill -2 "$VLLM_PID"
152157
```
153158

154159
You will see output as below:

‎tests/e2e/common.sh‎

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
# bash fonts colors
2+
cyan='\e[96m'
3+
yellow='\e[33m'
4+
red='\e[31m'
5+
none='\e[0m'
6+
7+
_cyan() { echo -e "${cyan}$*${none}"; }
8+
_yellow() { echo -e "${yellow}$*${none}"; }
9+
_red() { echo -e "${red}$*${none}"; }
10+
11+
_info() { _cyan "Info: $*"; }
12+
_warn() { _yellow "Warn: $*"; }
13+
_err() { _red "Error: $*" && exit 1; }
14+
15+
CURL_TIMEOUT=1
16+
CURL_COOLDOWN=5
17+
CURL_MAX_TRIES=120
18+
19+
function wait_url_ready() {
20+
local serve_name="$1"
21+
local url="$2"
22+
i=0
23+
while true; do
24+
_info "===> Waiting for ${serve_name} to be ready...${i}s"
25+
i=$((i + CURL_COOLDOWN))
26+
set +e
27+
curl --silent --max-time "$CURL_TIMEOUT" "${url}" >/dev/null
28+
result=$?
29+
set -e
30+
if [ "$result" -eq 0 ]; then
31+
break
32+
fi
33+
if [ "$i" -gt "$CURL_MAX_TRIES" ]; then
34+
_info "===> \$CURL_MAX_TRIES exceeded waiting for ${serve_name} to be ready"
35+
return 1
36+
fi
37+
sleep "$CURL_COOLDOWN"
38+
done
39+
_info "===> ${serve_name} is ready."
40+
}
41+
42+
function wait_for_exit() {
43+
local VLLM_PID="$1"
44+
while kill -0 "$VLLM_PID"; do
45+
_info "===> Wait for ${VLLM_PID} to exit."
46+
sleep 1
47+
done
48+
_info "===> Wait for ${VLLM_PID} to exit."
49+
}
50+
51+
SCRIPT_DIR=$(cd "$(dirname "$0")" && pwd)

‎tests/e2e/doctests/001-quickstart-test.sh‎

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
#!/bin/bash
2+
3+
#
4+
# Copyright (c) 2025 Huawei Technologies Co., Ltd. All Rights Reserved.
5+
#
6+
# Licensed under the Apache License, Version 2.0 (the "License");
7+
# you may not use this file except in compliance with the License.
8+
# You may obtain a copy of the License at
9+
#
10+
# http://www.apache.org/licenses/LICENSE-2.0
11+
#
12+
# Unless required by applicable law or agreed to in writing, software
13+
# distributed under the License is distributed on an "AS IS" BASIS,
14+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15+
# See the License for the specific language governing permissions and
16+
# limitations under the License.
17+
# This file is a part of the vllm-ascend project.
18+
#
19+
20+
function simple_test() {
21+
python3 -c "import vllm; print(vllm.__version__)"
22+
}
23+
24+
function quickstart_offline_test() {
25+
export VLLM_USE_MODELSCOPE=true
26+
python3 "${SCRIPT_DIR}/../../examples/offline_inference_npu.py"
27+
}
28+
29+
function quickstart_online_test() {
30+
export VLLM_USE_MODELSCOPE=true
31+
vllm serve Qwen/Qwen2.5-0.5B-Instruct &
32+
wait_url_ready "vllm serve" "localhost:8000/v1/models"
33+
curl http://localhost:8000/v1/completions \
34+
-H "Content-Type: application/json" \
35+
-d '{
36+
"model": "Qwen/Qwen2.5-0.5B-Instruct",
37+
"prompt": "Beijing is a",
38+
"max_tokens": 5,
39+
"temperature": 0
40+
}' | python3 -m json.tool
41+
VLLM_PID=$(pgrep -f "vllm serve")
42+
_info "===> Try kill -2 ${VLLM_PID} to exit."
43+
kill -2 "$VLLM_PID"
44+
wait_for_exit "$VLLM_PID"
45+
}
46+
47+
_info "====> Start simple_test"
48+
simple_test
49+
_info "====> Start quickstart_offline_test"
50+
quickstart_offline_test
51+
_info "====> Start quickstart_online_test"
52+
quickstart_online_test

‎tests/e2e/run_doctests.sh‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
#!/bin/bash
2+
3+
#
4+
# Copyright (c) 2025 Huawei Technologies Co., Ltd. All Rights Reserved.
5+
#
6+
# Licensed under the Apache License, Version 2.0 (the "License");
7+
# you may not use this file except in compliance with the License.
8+
# You may obtain a copy of the License at
9+
#
10+
# http://www.apache.org/licenses/LICENSE-2.0
11+
#
12+
# Unless required by applicable law or agreed to in writing, software
13+
# distributed under the License is distributed on an "AS IS" BASIS,
14+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15+
# See the License for the specific language governing permissions and
16+
# limitations under the License.
17+
# This file is a part of the vllm-ascend project.
18+
#
19+
20+
set -eo errexit
21+
22+
. $(dirname "$0")/common.sh
23+
24+
_info "====> Start Quickstart test"
25+
. "${SCRIPT_DIR}/doctests/001-quickstart-test.sh"
26+
27+
_info "Doctest passed."

0 commit comments

Comments
 (0)