setup.py 25.9 KB
Newer Older
1
# SPDX-License-Identifier: Apache-2.0
2
# SPDX-FileCopyrightText: Copyright contributors to the vLLM project
3

4
import ctypes
5
import importlib.util
6
import json
7
import logging
8
import os
9
import re
10
import shutil
11
import subprocess
bnellnm's avatar
bnellnm committed
12
import sys
13
from pathlib import Path
14
from shutil import which
15

Woosuk Kwon's avatar
Woosuk Kwon committed
16
import torch
17
from packaging.version import Version, parse
18
from setuptools import Extension, setup
19
from setuptools.command.build_ext import build_ext
20
from setuptools_scm import get_version
21
from torch.utils.cpp_extension import CUDA_HOME, ROCM_HOME
22

23
24
25
26
27
28
29
30
31

def load_module_from_path(module_name, path):
    spec = importlib.util.spec_from_file_location(module_name, path)
    module = importlib.util.module_from_spec(spec)
    sys.modules[module_name] = module
    spec.loader.exec_module(module)
    return module


32
ROOT_DIR = Path(__file__).parent
33
logger = logging.getLogger(__name__)
34
35
36
37
38
39

# cannot import envs directly because it depends on vllm,
#  which is not installed yet
envs = load_module_from_path('envs', os.path.join(ROOT_DIR, 'vllm', 'envs.py'))

VLLM_TARGET_DEVICE = envs.VLLM_TARGET_DEVICE
40

41
if sys.platform.startswith("darwin") and VLLM_TARGET_DEVICE != "cpu":
42
    logger.warning(
43
44
45
46
47
48
        "VLLM_TARGET_DEVICE automatically set to `cpu` due to macOS")
    VLLM_TARGET_DEVICE = "cpu"
elif not (sys.platform.startswith("linux")
          or sys.platform.startswith("darwin")):
    logger.warning(
        "vLLM only supports Linux platform (including WSL) and MacOS."
49
50
51
        "Building on %s, "
        "so vLLM may not be able to run correctly", sys.platform)
    VLLM_TARGET_DEVICE = "empty"
52
elif (sys.platform.startswith("linux") and torch.version.cuda is None
53
54
55
      and os.getenv("VLLM_TARGET_DEVICE") is None
      and torch.version.hip is None):
    # if cuda or hip is not available and VLLM_TARGET_DEVICE is not set,
56
57
    # fallback to cpu
    VLLM_TARGET_DEVICE = "cpu"
58

Huy Do's avatar
Huy Do committed
59
MAIN_CUDA_VERSION = "12.8"
60

bnellnm's avatar
bnellnm committed
61
62
63
64
65
66
67
68
69
70
71
72
73

def is_sccache_available() -> bool:
    return which("sccache") is not None


def is_ccache_available() -> bool:
    return which("ccache") is not None


def is_ninja_available() -> bool:
    return which("ninja") is not None


74
75
76
77
78
79
80
81
82
83
84
85
def is_url_available(url: str) -> bool:
    from urllib.request import urlopen

    status = None
    try:
        with urlopen(url) as f:
            status = f.status
    except Exception:
        return False
    return status == 200


bnellnm's avatar
bnellnm committed
86
87
88
class CMakeExtension(Extension):

    def __init__(self, name: str, cmake_lists_dir: str = '.', **kwa) -> None:
89
        super().__init__(name, sources=[], py_limited_api=True, **kwa)
bnellnm's avatar
bnellnm committed
90
91
92
93
94
        self.cmake_lists_dir = os.path.abspath(cmake_lists_dir)


class cmake_build_ext(build_ext):
    # A dict of extension directories that have been configured.
95
    did_config: dict[str, bool] = {}
bnellnm's avatar
bnellnm committed
96
97
98
99
100

    #
    # Determine number of compilation jobs and optionally nvcc compile threads.
    #
    def compute_num_jobs(self):
101
102
        # `num_jobs` is either the value of the MAX_JOBS environment variable
        # (if defined) or the number of CPUs available.
103
        num_jobs = envs.MAX_JOBS
104
105
        if num_jobs is not None:
            num_jobs = int(num_jobs)
106
            logger.info("Using MAX_JOBS=%d as the number of jobs.", num_jobs)
107
108
109
110
111
112
113
        else:
            try:
                # os.sched_getaffinity() isn't universally available, so fall
                #  back to os.cpu_count() if we get an error here.
                num_jobs = len(os.sched_getaffinity(0))
            except AttributeError:
                num_jobs = os.cpu_count()
bnellnm's avatar
bnellnm committed
114

115
        nvcc_threads = None
116
117
118
119
120
        if _is_cuda() and get_nvcc_cuda_version() >= Version("11.2"):
            # `nvcc_threads` is either the value of the NVCC_THREADS
            # environment variable (if defined) or 1.
            # when it is set, we reduce `num_jobs` to avoid
            # overloading the system.
121
            nvcc_threads = envs.NVCC_THREADS
122
123
            if nvcc_threads is not None:
                nvcc_threads = int(nvcc_threads)
124
125
126
                logger.info(
                    "Using NVCC_THREADS=%d as the number of nvcc threads.",
                    nvcc_threads)
127
128
129
            else:
                nvcc_threads = 1
            num_jobs = max(1, num_jobs // nvcc_threads)
bnellnm's avatar
bnellnm committed
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146

        return num_jobs, nvcc_threads

    #
    # Perform cmake configuration for a single extension.
    #
    def configure(self, ext: CMakeExtension) -> None:
        # If we've already configured using the CMakeLists.txt for
        # this extension, exit early.
        if ext.cmake_lists_dir in cmake_build_ext.did_config:
            return

        cmake_build_ext.did_config[ext.cmake_lists_dir] = True

        # Select the build type.
        # Note: optimization level + debug info are set by the build type
        default_cfg = "Debug" if self.debug else "RelWithDebInfo"
147
        cfg = envs.CMAKE_BUILD_TYPE or default_cfg
bnellnm's avatar
bnellnm committed
148
149
150

        cmake_args = [
            '-DCMAKE_BUILD_TYPE={}'.format(cfg),
151
            '-DVLLM_TARGET_DEVICE={}'.format(VLLM_TARGET_DEVICE),
bnellnm's avatar
bnellnm committed
152
153
        ]

154
        verbose = envs.VERBOSE
bnellnm's avatar
bnellnm committed
155
156
157
158
159
        if verbose:
            cmake_args += ['-DCMAKE_VERBOSE_MAKEFILE=ON']

        if is_sccache_available():
            cmake_args += [
160
                '-DCMAKE_C_COMPILER_LAUNCHER=sccache',
bnellnm's avatar
bnellnm committed
161
162
                '-DCMAKE_CXX_COMPILER_LAUNCHER=sccache',
                '-DCMAKE_CUDA_COMPILER_LAUNCHER=sccache',
163
                '-DCMAKE_HIP_COMPILER_LAUNCHER=sccache',
bnellnm's avatar
bnellnm committed
164
165
166
            ]
        elif is_ccache_available():
            cmake_args += [
167
                '-DCMAKE_C_COMPILER_LAUNCHER=ccache',
bnellnm's avatar
bnellnm committed
168
169
                '-DCMAKE_CXX_COMPILER_LAUNCHER=ccache',
                '-DCMAKE_CUDA_COMPILER_LAUNCHER=ccache',
170
                '-DCMAKE_HIP_COMPILER_LAUNCHER=ccache',
bnellnm's avatar
bnellnm committed
171
172
173
174
175
176
            ]

        # Pass the python executable to cmake so it can find an exact
        # match.
        cmake_args += ['-DVLLM_PYTHON_EXECUTABLE={}'.format(sys.executable)]

177
178
179
180
        # Pass the python path to cmake so it can reuse the build dependencies
        # on subsequent calls to python.
        cmake_args += ['-DVLLM_PYTHON_PATH={}'.format(":".join(sys.path))]

181
182
183
184
185
186
187
188
        # Override the base directory for FetchContent downloads to $ROOT/.deps
        # This allows sharing dependencies between profiles,
        # and plays more nicely with sccache.
        # To override this, set the FETCHCONTENT_BASE_DIR environment variable.
        fc_base_dir = os.path.join(ROOT_DIR, ".deps")
        fc_base_dir = os.environ.get("FETCHCONTENT_BASE_DIR", fc_base_dir)
        cmake_args += ['-DFETCHCONTENT_BASE_DIR={}'.format(fc_base_dir)]

bnellnm's avatar
bnellnm committed
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
        #
        # Setup parallelism and build tool
        #
        num_jobs, nvcc_threads = self.compute_num_jobs()

        if nvcc_threads:
            cmake_args += ['-DNVCC_THREADS={}'.format(nvcc_threads)]

        if is_ninja_available():
            build_tool = ['-G', 'Ninja']
            cmake_args += [
                '-DCMAKE_JOB_POOL_COMPILE:STRING=compile',
                '-DCMAKE_JOB_POOLS:STRING=compile={}'.format(num_jobs),
            ]
        else:
            # Default build tool to whatever cmake picks.
            build_tool = []
206
207
208
        # Make sure we use the nvcc from CUDA_HOME
        if _is_cuda():
            cmake_args += [f'-DCMAKE_CUDA_COMPILER={CUDA_HOME}/bin/nvcc']
bnellnm's avatar
bnellnm committed
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
        subprocess.check_call(
            ['cmake', ext.cmake_lists_dir, *build_tool, *cmake_args],
            cwd=self.build_temp)

    def build_extensions(self) -> None:
        # Ensure that CMake is present and working
        try:
            subprocess.check_output(['cmake', '--version'])
        except OSError as e:
            raise RuntimeError('Cannot find CMake executable') from e

        # Create build directory if it does not exist.
        if not os.path.exists(self.build_temp):
            os.makedirs(self.build_temp)

224
        targets = []
225
226
227
228

        def target_name(s: str) -> str:
            return s.removeprefix("vllm.").removeprefix("vllm_flash_attn.")

bnellnm's avatar
bnellnm committed
229
230
231
        # Build all the extensions
        for ext in self.extensions:
            self.configure(ext)
232
            targets.append(target_name(ext.name))
bnellnm's avatar
bnellnm committed
233

234
        num_jobs, _ = self.compute_num_jobs()
bnellnm's avatar
bnellnm committed
235

236
237
238
239
240
241
        build_args = [
            "--build",
            ".",
            f"-j={num_jobs}",
            *[f"--target={name}" for name in targets],
        ]
bnellnm's avatar
bnellnm committed
242

243
        subprocess.check_call(["cmake", *build_args], cwd=self.build_temp)
244

245
246
247
248
249
250
251
252
253
254
255
256
        # Install the libraries
        for ext in self.extensions:
            # Install the extension into the proper location
            outdir = Path(self.get_ext_fullpath(ext.name)).parent.absolute()

            # Skip if the install directory is the same as the build directory
            if outdir == self.build_temp:
                continue

            # CMake appends the extension prefix to the install path,
            # and outdir already contains that prefix, so we need to remove it.
            prefix = outdir
257
            for _ in range(ext.name.count('.')):
258
259
260
261
262
263
264
265
266
                prefix = prefix.parent

            # prefix here should actually be the same for all components
            install_args = [
                "cmake", "--install", ".", "--prefix", prefix, "--component",
                target_name(ext.name)
            ]
            subprocess.check_call(install_args, cwd=self.build_temp)

267
268
269
270
    def run(self):
        # First, run the standard build_ext command to compile the extensions
        super().run()

271
        # copy vllm/vllm_flash_attn/**/*.py from self.build_lib to current
272
273
        # directory so that they can be included in the editable build
        import glob
274
275
276
        files = glob.glob(os.path.join(self.build_lib, "vllm",
                                       "vllm_flash_attn", "**", "*.py"),
                          recursive=True)
277
278
        for file in files:
            dst_file = os.path.join("vllm/vllm_flash_attn",
279
                                    file.split("vllm/vllm_flash_attn/")[-1])
280
            print(f"Copying {file} to {dst_file}")
281
            os.makedirs(os.path.dirname(dst_file), exist_ok=True)
282
283
            self.copy_file(file, dst_file)

284

285
286
287
class repackage_wheel(build_ext):
    """Extracts libraries and other files from an existing wheel."""

288
    def get_base_commit_in_main_branch(self) -> str:
289
290
291
        # Force to use the nightly wheel. This is mainly used for CI testing.
        if envs.VLLM_TEST_USE_PRECOMPILED_NIGHTLY_WHEEL:
            return "nightly"
292
293

        try:
294
295
296
297
298
299
300
            # Get the latest commit hash of the upstream main branch.
            resp_json = subprocess.check_output([
                "curl", "-s",
                "https://api.github.com/repos/vllm-project/vllm/commits/main"
            ]).decode("utf-8")
            upstream_main_commit = json.loads(resp_json)["sha"]

301
302
303
304
            # In Docker build context, .git may be immutable or missing.
            if envs.VLLM_DOCKER_BUILD_CONTEXT:
                return upstream_main_commit

305
306
307
308
309
310
311
312
313
314
315
316
317
            # Check if the upstream_main_commit exists in the local repo
            try:
                subprocess.check_output(
                    ["git", "cat-file", "-e", f"{upstream_main_commit}"])
            except subprocess.CalledProcessError:
                # If not present, fetch it from the remote repository.
                # Note that this does not update any local branches,
                # but ensures that this commit ref and its history are
                # available in our local repo.
                subprocess.check_call([
                    "git", "fetch", "https://github.com/vllm-project/vllm",
                    "main"
                ])
318
319
320

            # Then get the commit hash of the current branch that is the same as
            # the upstream main commit.
321
322
323
            current_branch = subprocess.check_output(
                ["git", "branch", "--show-current"]).decode("utf-8").strip()

324
325
326
            base_commit = subprocess.check_output([
                "git", "merge-base", f"{upstream_main_commit}", current_branch
            ]).decode("utf-8").strip()
327
            return base_commit
328
329
        except ValueError as err:
            raise ValueError(err) from None
330
331
332
333
334
335
        except Exception as err:
            logger.warning(
                "Failed to get the base commit in the main branch. "
                "Using the nightly wheel. The libraries in this "
                "wheel may not be compatible with your dev branch: %s", err)
            return "nightly"
336

337
    def run(self) -> None:
338
339
340
        assert _is_cuda(
        ), "VLLM_USE_PRECOMPILED is only supported for CUDA builds"

341
342
343
344
        wheel_location = os.getenv("VLLM_PRECOMPILED_WHEEL_LOCATION", None)
        if wheel_location is None:
            base_commit = self.get_base_commit_in_main_branch()
            wheel_location = f"https://wheels.vllm.ai/{base_commit}/vllm-1.0.0.dev-cp38-abi3-manylinux1_x86_64.whl"
345
346
347
348
            # Fallback to nightly wheel if latest commit wheel is unavailable,
            # in this rare case, the nightly release CI hasn't finished on main.
            if not is_url_available(wheel_location):
                wheel_location = "https://wheels.vllm.ai/nightly/vllm-1.0.0.dev-cp38-abi3-manylinux1_x86_64.whl"
349

350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
        import zipfile

        if os.path.isfile(wheel_location):
            wheel_path = wheel_location
            print(f"Using existing wheel={wheel_path}")
        else:
            # Download the wheel from a given URL, assume
            # the filename is the last part of the URL
            wheel_filename = wheel_location.split("/")[-1]

            import tempfile

            # create a temporary directory to store the wheel
            temp_dir = tempfile.mkdtemp(prefix="vllm-wheels")
            wheel_path = os.path.join(temp_dir, wheel_filename)
            print(f"Downloading wheel from {wheel_location} to {wheel_path}")
            from urllib.request import urlretrieve
            try:
                urlretrieve(wheel_location, filename=wheel_path)
            except Exception as e:
                from setuptools.errors import SetupError
                raise SetupError(
                    f"Failed to get vLLM wheel from {wheel_location}") from e

374
375
376
377
        # Set the dist_dir for Docker build context
        dist_dir = ("/workspace/dist"
                    if envs.VLLM_DOCKER_BUILD_CONTEXT else "dist")
        os.makedirs(dist_dir, exist_ok=True)
378

379
        # Extract only necessary compiled .so files from precompiled wheel
380
        with zipfile.ZipFile(wheel_path) as wheel:
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
            # Get version from METADATA (optional, mostly useful for logging)
            metadata_file = next((n for n in wheel.namelist()
                                  if n.endswith(".dist-info/METADATA")), None)
            if not metadata_file:
                raise RuntimeError(
                    "Could not find METADATA in precompiled wheel.")
            metadata = wheel.read(metadata_file).decode()
            version_line = next((line for line in metadata.splitlines()
                                 if line.startswith("Version: ")), None)
            if not version_line:
                raise RuntimeError(
                    "Could not determine version from METADATA.")
            version = version_line.split(": ")[1].strip()

            print(f"Extracting precompiled kernels from vLLM wheel version: "
                  f"{version}")

            # List of compiled shared objects to extract
399
400
401
            files_to_copy = [
                "vllm/_C.abi3.so",
                "vllm/_moe_C.abi3.so",
402
                "vllm/_flashmla_C.abi3.so",
403
404
                "vllm/vllm_flash_attn/_vllm_fa2_C.abi3.so",
                "vllm/vllm_flash_attn/_vllm_fa3_C.abi3.so",
405
                "vllm/cumem_allocator.abi3.so",
406
            ]
407

408
409
410
411
412
413
414
            file_members = list(
                filter(lambda x: x.filename in files_to_copy, wheel.filelist))
            compiled_regex = re.compile(
                r"vllm/vllm_flash_attn/(?:[^/.][^/]*/)*(?!\.)[^/]*\.py")
            file_members += list(
                filter(lambda x: compiled_regex.match(x.filename),
                       wheel.filelist))
415
416
417
418
419
420
421
422
423
424

            for file in file_members:
                print(f"Extracting and including {file.filename} "
                      "from existing wheel")
                package_name = os.path.dirname(file.filename).replace("/", ".")
                file_name = os.path.basename(file.filename)

                if package_name not in package_data:
                    package_data[package_name] = []

425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
                output_base = (dist_dir
                               if envs.VLLM_DOCKER_BUILD_CONTEXT else ".")
                target_path = os.path.join(output_base, file.filename)
                os.makedirs(os.path.dirname(target_path), exist_ok=True)
                with wheel.open(file.filename) as src, open(target_path,
                                                            "wb") as dst:
                    shutil.copyfileobj(src, dst)

                package_data[package_name].append(file_name)

        # Copy wheel into dist dir for Docker to consume (e.g., via --mount)
        if envs.VLLM_DOCKER_BUILD_CONTEXT:
            arch_tag = "cp38-abi3-manylinux1_x86_64"
            corrected_wheel_name = f"vllm-{version}-{arch_tag}.whl"
            final_wheel_path = os.path.join(dist_dir, corrected_wheel_name)

            print(
                "Docker build context detected, copying precompiled wheel to "
                f"{final_wheel_path}")
            shutil.copy2(wheel_path, final_wheel_path)
445
446


447
448
449
450
def _no_device() -> bool:
    return VLLM_TARGET_DEVICE == "empty"


451
def _is_cuda() -> bool:
452
453
454
    # Allow forced CUDA in Docker/precompiled builds, even without torch.cuda
    if envs.VLLM_USE_PRECOMPILED and envs.VLLM_DOCKER_BUILD_CONTEXT:
        return True
455
456
    has_cuda = torch.version.cuda is not None
    return (VLLM_TARGET_DEVICE == "cuda" and has_cuda
457
            and not (_is_neuron() or _is_tpu()))
458
459


460
def _is_hip() -> bool:
461
462
    return (VLLM_TARGET_DEVICE == "cuda"
            or VLLM_TARGET_DEVICE == "rocm") and torch.version.hip is not None
463
464


465
def _is_neuron() -> bool:
466
    return VLLM_TARGET_DEVICE == "neuron"
467
468


469
470
471
472
def _is_tpu() -> bool:
    return VLLM_TARGET_DEVICE == "tpu"


473
474
475
476
def _is_cpu() -> bool:
    return VLLM_TARGET_DEVICE == "cpu"


477
478
479
480
def _is_xpu() -> bool:
    return VLLM_TARGET_DEVICE == "xpu"


481
482
483
484
def _build_custom_ops() -> bool:
    return _is_cuda() or _is_hip() or _is_cpu()


485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
def get_rocm_version():
    # Get the Rocm version from the ROCM_HOME/bin/librocm-core.so
    # see https://github.com/ROCm/rocm-core/blob/d11f5c20d500f729c393680a01fa902ebf92094b/rocm_version.cpp#L21
    try:
        librocm_core_file = Path(ROCM_HOME) / "lib" / "librocm-core.so"
        if not librocm_core_file.is_file():
            return None
        librocm_core = ctypes.CDLL(librocm_core_file)
        VerErrors = ctypes.c_uint32
        get_rocm_core_version = librocm_core.getROCmVersion
        get_rocm_core_version.restype = VerErrors
        get_rocm_core_version.argtypes = [
            ctypes.POINTER(ctypes.c_uint32),
            ctypes.POINTER(ctypes.c_uint32),
            ctypes.POINTER(ctypes.c_uint32),
        ]
        major = ctypes.c_uint32()
        minor = ctypes.c_uint32()
        patch = ctypes.c_uint32()
504

505
506
        if (get_rocm_core_version(ctypes.byref(major), ctypes.byref(minor),
                                  ctypes.byref(patch)) == 0):
507
            return f"{major.value}.{minor.value}.{patch.value}"
508
        return None
509
    except Exception:
510
        return None
Woosuk Kwon's avatar
Woosuk Kwon committed
511

512

513
514
515
def get_neuronxcc_version():
    import sysconfig
    site_dir = sysconfig.get_paths()["purelib"]
516
517
    version_file = os.path.join(site_dir, "neuronxcc", "version",
                                "__init__.py")
518
519

    # Check if the command was executed successfully
520
    with open(version_file) as fp:
521
522
523
524
525
526
527
528
        content = fp.read()

    # Extract the version using a regular expression
    match = re.search(r"__version__ = '(\S+)'", content)
    if match:
        # Return the version string
        return match.group(1)
    else:
529
        raise RuntimeError("Could not find Neuron version in the output")
530
531


bnellnm's avatar
bnellnm committed
532
def get_nvcc_cuda_version() -> Version:
533
534
535
536
    """Get the CUDA version from nvcc.

    Adapted from https://github.com/NVIDIA/apex/blob/8b7a1ff183741dd8f9b87e7bafd04cfde99cea28/setup.py
    """
537
    assert CUDA_HOME is not None, "CUDA_HOME is not set"
bnellnm's avatar
bnellnm committed
538
    nvcc_output = subprocess.check_output([CUDA_HOME + "/bin/nvcc", "-V"],
539
540
541
542
543
544
545
                                          universal_newlines=True)
    output = nvcc_output.split()
    release_idx = output.index("release") + 1
    nvcc_cuda_version = parse(output[release_idx].split(",")[0])
    return nvcc_cuda_version


546
547
548
549
550
551
552
553
def get_gaudi_sw_version():
    """
    Returns the driver version.
    """
    # Enable console printing for `hl-smi` check
    output = subprocess.run("hl-smi",
                            shell=True,
                            text=True,
554
                            capture_output=True,
555
556
557
558
559
560
561
                            env={"ENABLE_CONSOLE": "true"})
    if output.returncode == 0 and output.stdout:
        return output.stdout.split("\n")[2].replace(
            " ", "").split(":")[1][:-1].split("-")[0]
    return "0.0.0"  # when hl-smi is not available


562
def get_vllm_version() -> str:
563
    version = get_version(write_to="vllm/_version.py")
564
    sep = "+" if "+" not in version else "."  # dev versions might contain +
565

566
    if _no_device():
567
        if envs.VLLM_TARGET_DEVICE == "empty":
568
            version += f"{sep}empty"
569
    elif _is_cuda():
570
        if envs.VLLM_USE_PRECOMPILED:
571
            version += f"{sep}precompiled"
572
573
574
575
576
577
578
        else:
            cuda_version = str(get_nvcc_cuda_version())
            if cuda_version != MAIN_CUDA_VERSION:
                cuda_version_str = cuda_version.replace(".", "")[:3]
                # skip this for source tarball, required for pypi
                if "sdist" not in sys.argv:
                    version += f"{sep}cu{cuda_version_str}"
579
    elif _is_hip():
580
581
582
583
        # Get the Rocm Version
        rocm_version = get_rocm_version() or torch.version.hip
        if rocm_version and rocm_version != MAIN_CUDA_VERSION:
            version += f"{sep}rocm{rocm_version.replace('.', '')[:3]}"
584
585
    elif _is_neuron():
        # Get the Neuron version
bnellnm's avatar
bnellnm committed
586
        neuron_version = str(get_neuronxcc_version())
587
588
        if neuron_version != MAIN_CUDA_VERSION:
            neuron_version_str = neuron_version.replace(".", "")[:3]
589
            version += f"{sep}neuron{neuron_version_str}"
590
    elif _is_tpu():
591
        version += f"{sep}tpu"
592
    elif _is_cpu():
593
594
        if envs.VLLM_TARGET_DEVICE == "cpu":
            version += f"{sep}cpu"
595
    elif _is_xpu():
596
        version += f"{sep}xpu"
597
    else:
598
        raise RuntimeError("Unknown runtime environment")
599

600
601
602
    return version


603
def get_requirements() -> list[str]:
604
    """Get Python package dependencies from requirements.txt."""
605
    requirements_dir = ROOT_DIR / "requirements"
606

607
    def _read_requirements(filename: str) -> list[str]:
608
        with open(requirements_dir / filename) as f:
609
            requirements = f.read().strip().split("\n")
610
611
612
613
        resolved_requirements = []
        for line in requirements:
            if line.startswith("-r "):
                resolved_requirements += _read_requirements(line.split()[1])
614
615
            elif not line.startswith("--") and not line.startswith(
                    "#") and line.strip() != "":
616
617
618
                resolved_requirements.append(line)
        return resolved_requirements

619
    if _no_device():
620
        requirements = _read_requirements("common.txt")
621
    elif _is_cuda():
622
        requirements = _read_requirements("cuda.txt")
623
        cuda_major, cuda_minor = torch.version.cuda.split(".")
624
625
        modified_requirements = []
        for req in requirements:
626
627
            if ("vllm-flash-attn" in req and cuda_major != "12"):
                # vllm-flash-attn is built only for CUDA 12.x.
628
629
630
                # Skip for other versions.
                continue
            modified_requirements.append(req)
631
        requirements = modified_requirements
632
    elif _is_hip():
633
        requirements = _read_requirements("rocm.txt")
634
    elif _is_neuron():
635
        requirements = _read_requirements("neuron.txt")
636
    elif _is_tpu():
637
        requirements = _read_requirements("tpu.txt")
638
    elif _is_cpu():
639
        requirements = _read_requirements("cpu.txt")
640
    elif _is_xpu():
641
        requirements = _read_requirements("xpu.txt")
642
643
    else:
        raise ValueError(
644
            "Unsupported platform, please use CUDA, ROCm, Neuron, or CPU.")
645
646
647
    return requirements


bnellnm's avatar
bnellnm committed
648
649
ext_modules = []

650
if _is_cuda() or _is_hip():
bnellnm's avatar
bnellnm committed
651
652
    ext_modules.append(CMakeExtension(name="vllm._moe_C"))

653
654
655
if _is_hip():
    ext_modules.append(CMakeExtension(name="vllm._rocm_C"))

656
if _is_cuda():
657
    ext_modules.append(CMakeExtension(name="vllm.vllm_flash_attn._vllm_fa2_C"))
658
659
    if envs.VLLM_USE_PRECOMPILED or get_nvcc_cuda_version() >= Version("12.3"):
        # FA3 requires CUDA 12.3 or later
660
661
        ext_modules.append(
            CMakeExtension(name="vllm.vllm_flash_attn._vllm_fa3_C"))
662
663
664
665
        # Optional since this doesn't get built (produce an .so file) when
        # not targeting a hopper system
        ext_modules.append(
            CMakeExtension(name="vllm._flashmla_C", optional=True))
666
    ext_modules.append(CMakeExtension(name="vllm.cumem_allocator"))
667

668
if _build_custom_ops():
bnellnm's avatar
bnellnm committed
669
670
    ext_modules.append(CMakeExtension(name="vllm._C"))

671
package_data = {
672
673
674
675
676
    "vllm": [
        "py.typed",
        "model_executor/layers/fused_moe/configs/*.json",
        "model_executor/layers/quantization/utils/configs/*.json",
    ]
677
}
Simon Mo's avatar
Simon Mo committed
678

679
680
681
if _no_device():
    ext_modules = []

682
683
684
685
686
687
688
689
if not ext_modules:
    cmdclass = {}
else:
    cmdclass = {
        "build_ext":
        repackage_wheel if envs.VLLM_USE_PRECOMPILED else cmake_build_ext
    }

bnellnm's avatar
bnellnm committed
690
setup(
691
    # static metadata should rather go in pyproject.toml
692
    version=get_vllm_version(),
Woosuk Kwon's avatar
Woosuk Kwon committed
693
    ext_modules=ext_modules,
694
    install_requires=get_requirements(),
695
    extras_require={
696
        "bench": ["pandas", "datasets"],
697
        "tensorizer": ["tensorizer==2.10.1"],
698
        "fastsafetensors": ["fastsafetensors >= 0.1.10"],
699
700
        "runai":
        ["runai-model-streamer >= 0.13.3", "runai-model-streamer-s3", "boto3"],
Patrick von Platen's avatar
Patrick von Platen committed
701
702
        "audio": ["librosa", "soundfile",
                  "mistral_common[audio]"],  # Required for audio processing
703
        "video": []  # Kept for backwards compatibility
704
    },
705
    cmdclass=cmdclass,
Simon Mo's avatar
Simon Mo committed
706
    package_data=package_data,
Woosuk Kwon's avatar
Woosuk Kwon committed
707
)