From 6ba8b021c40bc7d17d3fc1dcf4dc63fee25c7c25 Mon Sep 17 00:00:00 2001 From: tomeras91 <57313761+tomeras91@users.noreply.github.com> Date: Mon, 12 Aug 2024 00:38:17 +0300 Subject: [PATCH] [Doc] building vLLM with VLLM_TARGET_DEVICE=empty (#7403) Signed-off-by: Alvant --- docs/source/getting_started/installation.rst | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/docs/source/getting_started/installation.rst b/docs/source/getting_started/installation.rst index 5294003aa9261..f0e54c29fcad7 100644 --- a/docs/source/getting_started/installation.rst +++ b/docs/source/getting_started/installation.rst @@ -68,6 +68,16 @@ You can also build and install vLLM from source: $ cd vllm $ pip install -e . # This may take 5-10 minutes. +.. note:: + + vLLM can fully run only on Linux, but you can still build it on other systems (for example, macOS). This build is only for development purposes, allowing for imports and a more convenient dev environment. The binaries will not be compiled and not work on non-Linux systems. You can create such a build with the following commands: + + .. code-block:: console + + $ export VLLM_TARGET_DEVICE=empty + $ pip install -e . + + .. tip:: Building from source requires quite a lot compilation. If you are building from source for multiple times, it is beneficial to cache the compilation results. For example, you can install `ccache `_ via either `conda install ccache` or `apt install ccache` . As long as `which ccache` command can find the `ccache` binary, it will be used automatically by the build system. After the first build, the subsequent builds will be much faster.