Skip to content

Commit 40c1080

Browse files
youkaichaorasmith
authored andcommitted
[doc] update how pip can install nightly wheels (vllm-project#11806)
Signed-off-by: youkaichao <[email protected]>
1 parent 79c0aa6 commit 40c1080

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

docs/source/getting_started/installation/gpu-cuda.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -66,19 +66,19 @@ LLM inference is a fast-evolving field, and the latest code may contain bug fixe
6666
### Install the latest code using `pip`
6767

6868
```console
69-
$ pip install https://vllm-wheels.s3.us-west-2.amazonaws.com/nightly/vllm-1.0.0.dev-cp38-abi3-manylinux1_x86_64.whl
69+
$ pip install vllm --pre --extra-index-url https://wheels.vllm.ai/nightly
7070
```
7171

72-
If you want to access the wheels for previous commits (e.g. to bisect the behavior change, performance regression), you can specify the commit hash in the URL:
72+
`--pre` is required for `pip` to consider pre-released versions.
73+
74+
If you want to access the wheels for previous commits (e.g. to bisect the behavior change, performance regression), due to the limitation of `pip`, you have to specify the full URL of the wheel file by embedding the commit hash in the URL:
7375

7476
```console
7577
$ export VLLM_COMMIT=33f460b17a54acb3b6cc0b03f4a17876cff5eafd # use full commit hash from the main branch
7678
$ pip install https://vllm-wheels.s3.us-west-2.amazonaws.com/${VLLM_COMMIT}/vllm-1.0.0.dev-cp38-abi3-manylinux1_x86_64.whl
7779
```
7880

79-
Note that the wheels are built with Python 3.8 ABI (see [PEP 425](https://peps.python.org/pep-0425/) for more details about ABI), so **they are compatible with Python 3.8 and later**. The version string in the wheel file name (`1.0.0.dev`) is just a placeholder to have a unified URL for the wheels. The actual versions of wheels are contained in the wheel metadata. Although we don't support Python 3.8 any more (because PyTorch 2.5 dropped support for Python 3.8), the wheels are still built with Python 3.8 ABI to keep the same wheel name as before.
80-
81-
Due to the limitation of `pip`, you have to specify the full URL of the wheel file.
81+
Note that the wheels are built with Python 3.8 ABI (see [PEP 425](https://peps.python.org/pep-0425/) for more details about ABI), so **they are compatible with Python 3.8 and later**. The version string in the wheel file name (`1.0.0.dev`) is just a placeholder to have a unified URL for the wheels, the actual versions of wheels are contained in the wheel metadata (the wheels listed in the extra index url have correct versions). Although we don't support Python 3.8 any more (because PyTorch 2.5 dropped support for Python 3.8), the wheels are still built with Python 3.8 ABI to keep the same wheel name as before.
8282

8383
### Install the latest code using `uv`
8484

@@ -126,7 +126,7 @@ $ cd vllm
126126
$ VLLM_USE_PRECOMPILED=1 pip install --editable .
127127
```
128128

129-
This will download the latest nightly wheel and use the compiled libraries from there in the install.
129+
This will download the latest nightly wheel from https://vllm-wheels.s3.us-west-2.amazonaws.com/nightly/vllm-1.0.0.dev-cp38-abi3-manylinux1_x86_64.whl and use the compiled libraries from there in the installation.
130130

131131
The `VLLM_PRECOMPILED_WHEEL_LOCATION` environment variable can be used instead of `VLLM_USE_PRECOMPILED` to specify a custom path or URL to the wheel file. For example, to use the [0.6.1.post1 PyPi wheel](https://pypi.org/project/vllm/#files):
132132

0 commit comments

Comments
 (0)