A high-throughput and memory-efficient inference and serving engine for LLMs
Mirrored from https://github.com/tduncan-lum/Nvidia-Optimization-Stack---VLLM.git
Synced Nov 14, 23:45 UTC
[Doc] update Contributing page's testing section (#18272)
Signed-off-by: David Xia <david@davidxia.com>
David Xia committed
Jul 29, 2025 at 13:32 UTC
7b49cb1c6b1bf154c134a962888f2a6e12f9fc18
1 file changed
+12
-5
docs/contributing/README.md
+12
-5
@@ -26,6 +26,8 @@ See <gh-file:LICENSE>.
26
27
## Developing
28
29
+--8<-- "docs/getting_started/installation/python_env_setup.inc.md"
30
+
31
Depending on the kind of development you'd like to do (e.g. Python, CUDA), you can choose to build vLLM with or without compilation.
32
Check out the [building from source][build-from-source] documentation for details.
33
@@ -42,7 +44,7 @@ For an optimized workflow when iterating on C++/CUDA kernels, see the [Increment
44
Install MkDocs along with the [plugins](https://github.com/vllm-project/vllm/blob/main/mkdocs.yaml) used in the vLLM documentation, as well as required dependencies:
45
46
```bash
45
-pip install -r requirements/docs.txt
47
+uv pip install -r requirements/docs.txt
48
```
49
50
!!! note
@@ -98,13 +100,14 @@ For additional features and advanced configurations, refer to the official [MkDo
100
??? console "Commands"
101
102
```bash
101
- pip install -r requirements/common.txt -r requirements/dev.txt
103
+ # These commands are only for Nvidia CUDA platforms.
104
+ uv pip install -r requirements/common.txt -r requirements/dev.txt --torch-backend=auto
105
106
# Linting, formatting and static type checking
104
- pre-commit install --hook-type pre-commit --hook-type commit-msg
107
+ pre-commit install
108
109
# You can manually run pre-commit with
107
- pre-commit run --all-files
110
+ pre-commit run --all-files --show-diff-on-failure
111
112
# To manually run something from CI that does not run
113
# locally by default, you can run:
@@ -122,6 +125,10 @@ For additional features and advanced configurations, refer to the official [MkDo
125
126
Therefore, we recommend developing with Python 3.12 to minimise the chance of your local environment clashing with our CI environment.
127
128
+!!! note "Install python3-dev if Python.h is missing"
129
+ If any of the above commands fails with `Python.h: No such file or directory`, install
130
+ `python3-dev` with `sudo apt install python3-dev`.
131
+
132
!!! note
133
Currently, the repository is not fully checked by `mypy`.
134
@@ -153,7 +160,7 @@ Using `-s` with `git commit` will automatically add this header.
160
161
!!! tip
162
You can enable automatic sign-off via your IDE:
156
-
163
+
164
- **PyCharm**: Click on the `Show Commit Options` icon to the right of the `Commit and Push...` button in the `Commit` window.
165
It will bring up a `git` window where you can modify the `Author` and enable `Sign-off commit`.
166
- **VSCode**: Open the [Settings editor](https://code.visualstudio.com/docs/configure/settings)