Skip to content

Commit f18bd88

Browse files
committed
fix pymarkdown
Signed-off-by: wangli <wangli858794774@gmail.com>
1 parent 7e84df7 commit f18bd88

File tree

4 files changed

+20
-5
lines changed

4 files changed

+20
-5
lines changed

docs/source/developer_guide/feature_guide/patch.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,7 @@ Before writing a patch, following the principle above, we should patch the least
5050
2. Decide which process we should patch. For example, here `distributed` belongs to the vLLM main process, so we should patch `platform`.
5151
3. Create the patch file in the right folder. The file should be named as `patch_{module_name}.py`. The example here is `vllm_ascend/patch/platform/patch_common/patch_distributed.py`.
5252
4. Write your patch code in the new file. Here is an example:
53+
5354
```python
5455
import vllm
5556

@@ -59,8 +60,10 @@ Before writing a patch, following the principle above, we should patch the least
5960

6061
vllm.distributed.parallel_state.destroy_model_parallel = patch_destroy_model_parallel
6162
```
62-
5. Import the patch file in `__init__.py`. In this example, add `import vllm_ascend.patch.platform.patch_common.patch_distributed` into `vllm_ascend/patch/platform/patch_common/__init__.py`.
63-
6. Add the description of the patch in `vllm_ascend/patch/__init__.py`. The description format is as follows:
63+
64+
6. Import the patch file in `__init__.py`. In this example, add `import vllm_ascend.patch.platform.patch_common.patch_distributed` into `vllm_ascend/patch/platform/patch_common/__init__.py`.
65+
7. Add the description of the patch in `vllm_ascend/patch/__init__.py`. The description format is as follows:
66+
6467
```
6568
# ** File: <The patch file name> **
6669
# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -74,8 +77,8 @@ Before writing a patch, following the principle above, we should patch the least
7477
# Future Plan:
7578
# <Describe the future plan to remove the patch>
7679
```
77-
7. Add the Unit Test and E2E Test. Any newly added code in vLLM Ascend should contain the Unit Test and E2E Test as well. You can find more details in [test guide](../contribution/testing.md)
7880

81+
8. Add the Unit Test and E2E Test. Any newly added code in vLLM Ascend should contain the Unit Test and E2E Test as well. You can find more details in [test guide](../contribution/testing.md)
7982

8083
## Limitation
8184
1. In V1 Engine, vLLM starts three kinds of process: Main process, EngineCore process and Worker process. Now vLLM Ascend only support patch the code in Main process and Worker process by default. If you want to patch the code runs in EngineCore process, you should patch EngineCore process entirely during setup, the entry code is here `vllm.v1.engine.core`. Please override `EngineCoreProc` and `DPEngineCoreProc` entirely.

docs/source/developer_guide/modeling/adding_a_new_model.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -216,6 +216,7 @@ The first argument of `vllm.ModelRegistry.register_model()` indicates the unique
216216
],
217217
}
218218
```
219+
219220
:::
220221

221222
## Step 3: Verification

docs/source/quick_start.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,7 @@ docker run --rm \
3535
# Install curl
3636
apt-get update -y && apt-get install -y curl
3737
```
38+
3839
::::
3940

4041
::::{tab-item} openEuler
@@ -63,6 +64,7 @@ docker run --rm \
6364
# Install curl
6465
yum update -y && yum install -y curl
6566
```
67+
6668
::::
6769
:::::
6870

@@ -73,6 +75,7 @@ The default workdir is `/workspace`, vLLM and vLLM Ascend code are placed in `/v
7375
You can use Modelscope mirror to speed up download:
7476

7577
<!-- tests/e2e/doctest/001-quickstart-test.sh should be considered updating as well -->
78+
7679
```bash
7780
export VLLM_USE_MODELSCOPE=true
7881
```
@@ -87,6 +90,7 @@ With vLLM installed, you can start generating texts for list of input prompts (i
8790
Try to run below Python script directly or use `python3` shell to generate texts:
8891

8992
<!-- tests/e2e/doctest/001-quickstart-test.sh should be considered updating as well -->
93+
9094
```python
9195
from vllm import LLM, SamplingParams
9296

@@ -115,6 +119,7 @@ the following command to start the vLLM server with the
115119
[Qwen/Qwen2.5-0.5B-Instruct](https://huggingface.co/Qwen/Qwen2.5-0.5B-Instruct) model:
116120

117121
<!-- tests/e2e/doctest/001-quickstart-test.sh should be considered updating as well -->
122+
118123
```bash
119124
# Deploy vLLM server (The first run will take about 3-5 mins (10 MB/s) to download models)
120125
vllm serve Qwen/Qwen2.5-0.5B-Instruct &
@@ -128,18 +133,21 @@ INFO: Waiting for application startup.
128133
INFO: Application startup complete.
129134
INFO: Uvicorn running on http://0.0.0.0:8000 (Press CTRL+C to quit)
130135
```
136+
131137
Congratulations, you have successfully started the vLLM server!
132138

133139
You can query the list the models:
134140

135141
<!-- tests/e2e/doctest/001-quickstart-test.sh should be considered updating as well -->
142+
136143
```bash
137144
curl http://localhost:8000/v1/models | python3 -m json.tool
138145
```
139146

140147
You can also query the model with input prompts:
141148

142149
<!-- tests/e2e/doctest/001-quickstart-test.sh should be considered updating as well -->
150+
143151
```bash
144152
curl http://localhost:8000/v1/completions \
145153
-H "Content-Type: application/json" \
@@ -155,12 +163,14 @@ vLLM is serving as background process, you can use `kill -2 $VLLM_PID` to stop t
155163
it's equal to `Ctrl-C` to stop foreground vLLM process:
156164

157165
<!-- tests/e2e/doctest/001-quickstart-test.sh should be considered updating as well -->
166+
158167
```bash
159168
VLLM_PID=$(pgrep -f "vllm serve")
160169
kill -2 "$VLLM_PID"
161170
```
162171

163172
You will see output as below:
173+
164174
```
165175
INFO: Shutting down FastAPI HTTP server.
166176
INFO: Shutting down
@@ -170,4 +180,4 @@ INFO: Application shutdown complete.
170180

171181
Finally, you can exit container by using `ctrl-D`.
172182
::::
173-
:::::
183+
:::::

pyproject.toml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,4 +32,5 @@ plugins.md013.enabled = false # line-length
3232
plugins.md041.enabled = false # first-line-h1
3333
plugins.md033.enabled = false # inline-html
3434
plugins.md046.enabled = false # code-block-style
35-
plugins.md024.allow_different_nesting = true # no-duplicate-headers
35+
plugins.md024.allow_different_nesting = true # no-duplicate-headers
36+
plugins.md029.enabled = false # automatic numbering

0 commit comments

Comments
 (0)