Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[doc] improve installation doc #8550

Merged
merged 3 commits into from
Sep 17, 2024
Merged

[doc] improve installation doc #8550

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
bc599d0
improve doc
youkaichao Sep 17, 2024
8c0e24d
Update docs/source/getting_started/installation.rst
youkaichao Sep 17, 2024
5fe2743
further polish
youkaichao Sep 17, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions docs/source/getting_started/installation.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -95,6 +95,8 @@ You can also build and install vLLM from source:
$ export MAX_JOBS=6
$ pip install -e .

This is especially useful when you are building on less powerful machines. For example, when you use WSL, it only `gives you half of the memory by default <https://learn.microsoft.com/en-us/windows/wsl/wsl-config>`_, and you'd better use ``export MAX_JOBS=1`` to avoid running out of memory. The side effect is that the build process will be slower. It is okay if you only touch the Python code, as you can just change the code and run the Python script without any re-compilation or re-installation.
youkaichao marked this conversation as resolved.
Show resolved Hide resolved

.. tip::
If you have trouble building vLLM, we recommend using the NVIDIA PyTorch Docker image.

Expand Down
Loading