GPU#
vLLM is a Python library that supports the following GPU variants. Select your GPU type to see vendor specific instructions:
vLLM contains pre-compiled C++ and CUDA (12.1) binaries.
vLLM supports AMD GPUs with ROCm 6.3.
Attention
There are no pre-built wheels for this device, so you must either use the pre-built Docker image or build vLLM from source.
vLLM initially supports basic model inferencing and serving on Intel GPU platform.
Attention
There are no pre-built wheels or images for this device, so you must build vLLM from source.
Requirements#
OS: Linux
Python: 3.9 – 3.12
GPU: compute capability 7.0 or higher (e.g., V100, T4, RTX20xx, A100, L4, H100, etc.)
GPU: MI200s (gfx90a), MI300 (gfx942), Radeon RX 7900 series (gfx1100)
ROCm 6.3
Supported Hardware: Intel Data Center GPU, Intel ARC GPU
OneAPI requirements: oneAPI 2024.2
Set up using Python#
Create a new Python environment#
You can create a new Python environment using conda
:
# (Recommended) Create a new conda environment.
conda create -n myenv python=3.12 -y
conda activate myenv
Note
PyTorch has deprecated the conda release channel. If you use conda
, please only use it to create Python environment rather than installing packages.
Or you can create a new Python environment using uv, a very fast Python environment manager. Please follow the documentation to install uv
. After installing uv
, you can create a new Python environment using the following command:
# (Recommended) Create a new uv environment. Use `--seed` to install `pip` and `setuptools` in the environment.
uv venv myenv --python 3.12 --seed
source myenv/bin/activate
Note
PyTorch installed via conda
will statically link NCCL
library, which can cause issues when vLLM tries to use NCCL
. See Issue #8420 for more details.
In order to be performant, vLLM has to compile many cuda kernels. The compilation unfortunately introduces binary incompatibility with other CUDA versions and PyTorch versions, even for the same PyTorch version with different building configurations.
Therefore, it is recommended to install vLLM with a fresh new environment. If either you have a different CUDA version or you want to use an existing PyTorch installation, you need to build vLLM from source. See below for more details.
There is no extra information on creating a new Python environment for this device.
There is no extra information on creating a new Python environment for this device.
Pre-built wheels#
You can install vLLM using either pip
or uv pip
:
# Install vLLM with CUDA 12.1.
pip install vllm # If you are using pip.
uv pip install vllm # If you are using uv.
As of now, vLLM’s binaries are compiled with CUDA 12.1 and public PyTorch release versions by default. We also provide vLLM binaries compiled with CUDA 11.8 and public PyTorch release versions:
# Install vLLM with CUDA 11.8.
export VLLM_VERSION=0.6.1.post1
export PYTHON_VERSION=310
pip install https://github.com/vllm-project/vllm/releases/download/v${VLLM_VERSION}/vllm-${VLLM_VERSION}+cu118-cp${PYTHON_VERSION}-cp${PYTHON_VERSION}-manylinux1_x86_64.whl --extra-index-url https://download.pytorch.org/whl/cu118
Install the latest code
LLM inference is a fast-evolving field, and the latest code may contain bug fixes, performance improvements, and new features that are not released yet. To allow users to try the latest code without waiting for the next release, vLLM provides wheels for Linux running on a x86 platform with CUDA 12 for every commit since v0.5.3
.
Install the latest code using pip
pip install vllm --pre --extra-index-url https://wheels.vllm.ai/nightly
--pre
is required for pip
to consider pre-released versions.
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:
export VLLM_COMMIT=33f460b17a54acb3b6cc0b03f4a17876cff5eafd # use full commit hash from the main branch
pip install https://wheels.vllm.ai/${VLLM_COMMIT}/vllm-1.0.0.dev-cp38-abi3-manylinux1_x86_64.whl
Note that the wheels are built with Python 3.8 ABI (see PEP 425 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.
Install the latest code using uv
Another way to install the latest code is to use uv
:
uv pip install vllm --extra-index-url https://wheels.vllm.ai/nightly
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:
export VLLM_COMMIT=72d9c316d3f6ede485146fe5aabd4e61dbc59069 # use full commit hash from the main branch
uv pip install vllm --extra-index-url https://wheels.vllm.ai/${VLLM_COMMIT}
The uv
approach works for vLLM v0.6.6
and later and offers an easy-to-remember command. A unique feature of uv
is that packages in --extra-index-url
have higher priority than the default index. If the latest public release is v0.6.6.post1
, uv
’s behavior allows installing a commit before v0.6.6.post1
by specifying the --extra-index-url
. In contrast, pip
combines packages from --extra-index-url
and the default index, choosing only the latest version, which makes it difficult to install a development version prior to the released version.
Currently, there are no pre-built ROCm wheels.
Currently, there are no pre-built XPU wheels.
Build wheel from source#
Set up using Python-only build (without compilation)
If you only need to change Python code, you can build and install vLLM without compilation. Using pip
’s --editable
flag, changes you make to the code will be reflected when you run vLLM:
git clone https://github.com/vllm-project/vllm.git
cd vllm
VLLM_USE_PRECOMPILED=1 pip install --editable .
This command will do the following:
Look for the current branch in your vLLM clone.
Identify the corresponding base commit in the main branch.
Download the pre-built wheel of the base commit.
Use its compiled libraries in the installation.
Note
If you change C++ or kernel code, you cannot use Python-only build; otherwise you will see an import error about library not found or undefined symbol.
If you rebase your dev branch, it is recommended to uninstall vllm and re-run the above command to make sure your libraries are up to date.
In case you see an error about wheel not found when running the above command, it might be because the commit you based on in the main branch was just merged and the wheel is being built. In this case, you can wait for around an hour to try again, or manually assign the previous commit in the installation using the VLLM_PRECOMPILED_WHEEL_LOCATION
environment variable.
export VLLM_COMMIT=72d9c316d3f6ede485146fe5aabd4e61dbc59069 # use full commit hash from the main branch
export VLLM_PRECOMPILED_WHEEL_LOCATION=https://wheels.vllm.ai/${VLLM_COMMIT}/vllm-1.0.0.dev-cp38-abi3-manylinux1_x86_64.whl
pip install --editable .
You can find more information about vLLM’s wheels in Install the latest code.
Note
There is a possibility that your source code may have a different commit ID compared to the latest vLLM wheel, which could potentially lead to unknown errors. It is recommended to use the same commit ID for the source code as the vLLM wheel you have installed. Please refer to Install the latest code for instructions on how to install a specified wheel.
Full build (with compilation)
If you want to modify C++ or CUDA code, you’ll need to build vLLM from source. This can take several minutes:
git clone https://github.com/vllm-project/vllm.git
cd vllm
pip install -e .
Tip
Building from source requires a lot of compilation. If you are building from source repeatedly, it’s more efficient to cache the compilation results.
For example, you can install ccache using 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, subsequent builds will be much faster.
sccache works similarly to ccache
, but has the capability to utilize caching in remote storage environments.
The following environment variables can be set to configure the vLLM sccache
remote: SCCACHE_BUCKET=vllm-build-sccache SCCACHE_REGION=us-west-2 SCCACHE_S3_NO_CREDENTIALS=1
. We also recommend setting SCCACHE_IDLE_TIMEOUT=0
.
Use an existing PyTorch installation
There are scenarios where the PyTorch dependency cannot be easily installed via pip, e.g.:
Building vLLM with PyTorch nightly or a custom PyTorch build.
Building vLLM with aarch64 and CUDA (GH200), where the PyTorch wheels are not available on PyPI. Currently, only the PyTorch nightly has wheels for aarch64 with CUDA. You can run
pip3 install --pre torch torchvision torchaudio --index-url https://download.pytorch.org/whl/nightly/cu124
to install PyTorch nightly, and then build vLLM on top of it.
To build vLLM using an existing PyTorch installation:
git clone https://github.com/vllm-project/vllm.git
cd vllm
python use_existing_torch.py
pip install -r requirements-build.txt
pip install -e . --no-build-isolation
Use the local cutlass for compilation
Currently, before starting the build process, vLLM fetches cutlass code from GitHub. However, there may be scenarios where you want to use a local version of cutlass instead. To achieve this, you can set the environment variable VLLM_CUTLASS_SRC_DIR to point to your local cutlass directory.
git clone https://github.com/vllm-project/vllm.git
cd vllm
VLLM_CUTLASS_SRC_DIR=/path/to/cutlass pip install -e .
Troubleshooting
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:
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 assigns 50% of the total memory by default, so using export MAX_JOBS=1
can avoid compiling multiple files simultaneously and running out of memory.
A side effect is a much slower build process.
Additionally, if you have trouble building vLLM, we recommend using the NVIDIA PyTorch Docker image.
# Use `--ipc=host` to make sure the shared memory is large enough.
docker run --gpus all -it --rm --ipc=host nvcr.io/nvidia/pytorch:23.10-py3
If you don’t want to use docker, it is recommended to have a full installation of CUDA Toolkit. You can download and install it from the official website. After installation, set the environment variable CUDA_HOME
to the installation path of CUDA Toolkit, and make sure that the nvcc
compiler is in your PATH
, e.g.:
export CUDA_HOME=/usr/local/cuda
export PATH="${CUDA_HOME}/bin:$PATH"
Here is a sanity check to verify that the CUDA Toolkit is correctly installed:
nvcc --version # verify that nvcc is in your PATH
${CUDA_HOME}/bin/nvcc --version # verify that nvcc is in your CUDA_HOME
Unsupported OS build
vLLM can fully run only on Linux but for development purposes, you can still build it on other systems (for example, macOS), allowing for imports and a more convenient development environment. The binaries will not be compiled and won’t work on non-Linux systems.
Simply disable the VLLM_TARGET_DEVICE
environment variable before installing:
export VLLM_TARGET_DEVICE=empty
pip install -e .
Install prerequisites (skip if you are already in an environment/docker with the following installed):
-
For installing PyTorch, you can start from a fresh docker image, e.g,
rocm/pytorch:rocm6.3_ubuntu24.04_py3.12_pytorch_release_2.4.0
,rocm/pytorch-nightly
. If you are using docker image, you can skip to Step 3.Alternatively, you can install PyTorch using PyTorch wheels. You can check PyTorch installation guide in PyTorch Getting Started. Example:
# Install PyTorch $ pip uninstall torch -y $ pip install --no-cache-dir --pre torch --index-url https://download.pytorch.org/whl/rocm6.3
Install Triton flash attention for ROCm
Install ROCm’s Triton flash attention (the default triton-mlir branch) following the instructions from ROCm/triton
python3 -m pip install ninja cmake wheel pybind11 pip uninstall -y triton git clone https://github.com/OpenAI/triton.git cd triton git checkout e5be006 cd python pip3 install . cd ../..
Note
If you see HTTP issue related to downloading packages during building triton, please try again as the HTTP error is intermittent.
Optionally, if you choose to use CK flash attention, you can install flash attention for ROCm
Install ROCm’s flash attention (v2.7.2) following the instructions from ROCm/flash-attention Alternatively, wheels intended for vLLM use can be accessed under the releases.
For example, for ROCm 6.3, suppose your gfx arch is
gfx90a
. To get your gfx architecture, runrocminfo |grep gfx
.git clone https://github.com/ROCm/flash-attention.git cd flash-attention git checkout b7d29fb git submodule update --init GPU_ARCHS="gfx90a" python3 setup.py install cd ..
Note
You might need to downgrade the “ninja” version to 1.10 it is not used when compiling flash-attention-2 (e.g.
pip install ninja==1.10.2.4
)Build vLLM. For example, vLLM on ROCM 6.3 can be built with the following steps:
$ pip install --upgrade pip # Build & install AMD SMI $ pip install /opt/rocm/share/amd_smi # Install dependencies $ pip install --upgrade numba scipy huggingface-hub[cli,hf_transfer] setuptools_scm $ pip install "numpy<2" $ pip install -r requirements-rocm.txt # Build vLLM for MI210/MI250/MI300. $ export PYTORCH_ROCM_ARCH="gfx90a;gfx942" $ python3 setup.py develop
This may take 5-10 minutes. Currently,
pip install .
does not work for ROCm installation.Tip
Triton flash attention is used by default. For benchmarking purposes, it is recommended to run a warm up step before collecting perf numbers.
Triton flash attention does not currently support sliding window attention. If using half precision, please use CK flash-attention for sliding window support.
To use CK flash-attention or PyTorch naive attention, please use this flag
export VLLM_USE_TRITON_FLASH_ATTN=0
to turn off triton flash attention.The ROCm version of PyTorch, ideally, should match the ROCm driver version.
Tip
For MI300x (gfx942) users, to achieve optimal performance, please refer to MI300x tuning guide for performance optimization and tuning tips on system and workflow level. For vLLM, please refer to vLLM performance optimization.
First, install required driver and intel OneAPI 2024.2 or later.
Second, install Python packages for vLLM XPU backend building:
source /opt/intel/oneapi/setvars.sh
pip install --upgrade pip
pip install -v -r requirements-xpu.txt
Finally, build and install vLLM XPU backend:
VLLM_TARGET_DEVICE=xpu python setup.py install
Note
FP16 is the default data type in the current XPU backend. The BF16 data type is supported on Intel Data Center GPU, not supported on Intel Arc GPU yet.
Set up using Docker#
Pre-built images#
See Use vLLM’s Official Docker Image for instructions on using the official Docker image.
Another way to access the latest code is to use the docker images:
export VLLM_COMMIT=33f460b17a54acb3b6cc0b03f4a17876cff5eafd # use full commit hash from the main branch
docker pull public.ecr.aws/q9t5s3a7/vllm-ci-postmerge-repo:${VLLM_COMMIT}
These docker images are used for CI and testing only, and they are not intended for production use. They will be expired after several days.
The latest code can contain bugs and may not be stable. Please use it with caution.
The AMD Infinity hub for vLLM offers a prebuilt, optimized docker image designed for validating inference performance on the AMD Instinct™ MI300X accelerator.
Tip
Please check LLM inference performance validation on AMD Instinct MI300X for instructions on how to use this prebuilt docker image.
Currently, there are no pre-built XPU images.
Build image from source#
See Building vLLM’s Docker Image from Source for instructions on building the Docker image.
Building the Docker image from source is the recommended way to use vLLM with ROCm.
(Optional) Build an image with ROCm software stack
Build a docker image from Dockerfile.rocm_base which setup ROCm software stack needed by the vLLM.
This step is optional as this rocm_base image is usually prebuilt and store at Docker Hub under tag rocm/vllm-dev:base
to speed up user experience.
If you choose to build this rocm_base image yourself, the steps are as follows.
It is important that the user kicks off the docker build using buildkit. Either the user put DOCKER_BUILDKIT=1 as environment variable when calling docker build command, or the user needs to setup buildkit in the docker daemon configuration /etc/docker/daemon.json as follows and restart the daemon:
{
"features": {
"buildkit": true
}
}
To build vllm on ROCm 6.3 for MI200 and MI300 series, you can use the default:
DOCKER_BUILDKIT=1 docker build -f Dockerfile.rocm_base -t rocm/vllm-dev:base .
Build an image with vLLM
First, build a docker image from Dockerfile.rocm and launch a docker container from the image.
It is important that the user kicks off the docker build using buildkit. Either the user put DOCKER_BUILDKIT=1
as environment variable when calling docker build command, or the user needs to setup buildkit in the docker daemon configuration /etc/docker/daemon.json as follows and restart the daemon:
{
"features": {
"buildkit": true
}
}
Dockerfile.rocm uses ROCm 6.3 by default, but also supports ROCm 5.7, 6.0, 6.1, and 6.2, in older vLLM branches. It provides flexibility to customize the build of docker image using the following arguments:
BASE_IMAGE
: specifies the base image used when runningdocker build
. The default valuerocm/vllm-dev:base
is an image published and maintained by AMD. It is being built using Dockerfile.rocm_baseUSE_CYTHON
: An option to run cython compilation on a subset of python files upon docker buildBUILD_RPD
: Include RocmProfileData profiling tool in the imageARG_PYTORCH_ROCM_ARCH
: Allows to override the gfx architecture values from the base docker image
Their values can be passed in when running docker build
with --build-arg
options.
To build vllm on ROCm 6.3 for MI200 and MI300 series, you can use the default:
DOCKER_BUILDKIT=1 docker build -f Dockerfile.rocm -t vllm-rocm .
To build vllm on ROCm 6.3 for Radeon RX7900 series (gfx1100), you should pick the alternative base image:
DOCKER_BUILDKIT=1 docker build --build-arg BASE_IMAGE="rocm/vllm-dev:navi_base" -f Dockerfile.rocm -t vllm-rocm .
To run the above docker image vllm-rocm
, use the below command:
docker run -it \
--network=host \
--group-add=video \
--ipc=host \
--cap-add=SYS_PTRACE \
--security-opt seccomp=unconfined \
--device /dev/kfd \
--device /dev/dri \
-v <path/to/model>:/app/model \
vllm-rocm \
bash
Where the <path/to/model>
is the location where the model is stored, for example, the weights for llama2 or llama3 models.
$ docker build -f Dockerfile.xpu -t vllm-xpu-env --shm-size=4g .
$ docker run -it \
--rm \
--network=host \
--device /dev/dri \
-v /dev/dri/by-path:/dev/dri/by-path \
vllm-xpu-env
Supported features#
See Feature x Hardware compatibility matrix for feature support information.
See Feature x Hardware compatibility matrix for feature support information.
XPU platform supports tensor-parallel inference/serving and also supports pipeline parallel as a beta feature for online serving. We requires Ray as the distributed runtime backend. For example, a reference execution likes following:
python -m vllm.entrypoints.openai.api_server \
--model=facebook/opt-13b \
--dtype=bfloat16 \
--device=xpu \
--max_model_len=1024 \
--distributed-executor-backend=ray \
--pipeline-parallel-size=2 \
-tp=8
By default, a ray instance will be launched automatically if no existing one is detected in system, with num-gpus
equals to parallel_config.world_size
. We recommend properly starting a ray cluster before execution, referring to the examples/online_serving/run_cluster.sh helper script.