From b24034c16f7b955b7c82e867ae5e4426e359945a Mon Sep 17 00:00:00 2001 From: youkaichao Date: Thu, 23 May 2024 09:59:48 -0700 Subject: [PATCH 1/3] add ccache guide in doc --- docs/source/getting_started/installation.rst | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/source/getting_started/installation.rst b/docs/source/getting_started/installation.rst index 0c81f7ec6d2a9..041259db61ae4 100644 --- a/docs/source/getting_started/installation.rst +++ b/docs/source/getting_started/installation.rst @@ -56,6 +56,10 @@ You can also build and install vLLM from source: $ # export VLLM_INSTALL_PUNICA_KERNELS=1 # optionally build for multi-LoRA capability $ pip install -e . # This may take 5-10 minutes. +.. tip:: + + Building from source requires quite a lot compilation. To accelerate the compilation, 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. + .. tip:: To avoid your system being overloaded, you can limit the number of compilation jobs to be run simultaneously, via the environment variable `MAX_JOBS`. For example: From a8ff6f0ccccb1d28fffc622a7065cecbea8c13fd Mon Sep 17 00:00:00 2001 From: youkaichao Date: Thu, 23 May 2024 10:02:25 -0700 Subject: [PATCH 2/3] Update docs/source/getting_started/installation.rst Co-authored-by: Michael Goin --- docs/source/getting_started/installation.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/getting_started/installation.rst b/docs/source/getting_started/installation.rst index 041259db61ae4..7df2b95815a2c 100644 --- a/docs/source/getting_started/installation.rst +++ b/docs/source/getting_started/installation.rst @@ -58,7 +58,7 @@ You can also build and install vLLM from source: .. tip:: - Building from source requires quite a lot compilation. To accelerate the compilation, 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. + Building from source requires quite a lot compilation. To accelerate the compilation, 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. .. tip:: To avoid your system being overloaded, you can limit the number of compilation jobs From 38bc6220515ec811186a641cc2d35044b57695a8 Mon Sep 17 00:00:00 2001 From: youkaichao Date: Thu, 23 May 2024 10:04:24 -0700 Subject: [PATCH 3/3] update doc --- docs/source/getting_started/installation.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/getting_started/installation.rst b/docs/source/getting_started/installation.rst index 7df2b95815a2c..ba23e7468dcc1 100644 --- a/docs/source/getting_started/installation.rst +++ b/docs/source/getting_started/installation.rst @@ -58,7 +58,7 @@ You can also build and install vLLM from source: .. tip:: - Building from source requires quite a lot compilation. To accelerate the compilation, 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. + 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. .. tip:: To avoid your system being overloaded, you can limit the number of compilation jobs