"vscode:/vscode.git/clone" did not exist on "f8cf43ae581b2a3fc8a2ac0c0d0de0996f9835a1"
setup.py 25.3 KB
Newer Older
1
2
# SPDX-License-Identifier: Apache-2.0

3
import ctypes
4
import importlib.util
5
import logging
6
7
import os
import re
8
import subprocess
bnellnm's avatar
bnellnm committed
9
import sys
10
from pathlib import Path
11
from shutil import which
12
from typing import Dict, List
13

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

zhuwenwen's avatar
zhuwenwen committed
21
22
23
24
from typing import Optional, Union
import subprocess
from pathlib import Path

zhuwenwen's avatar
zhuwenwen committed
25
pwd = os.path.dirname(os.path.abspath(__file__))
gaoqiong's avatar
gaoqiong committed
26
add_git_version = False
27
28
if int(os.environ.get('ADD_GIT_VERSION', '0')) == 1:
    add_git_version = True
29
30
31
32
33
34
35
36
37

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


38
ROOT_DIR = os.path.dirname(__file__)
39
logger = logging.getLogger(__name__)
40
41
42
43
44
45

# 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
46

47
if sys.platform.startswith("darwin") and VLLM_TARGET_DEVICE != "cpu":
48
    logger.warning(
49
50
51
52
53
54
        "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."
55
56
57
        "Building on %s, "
        "so vLLM may not be able to run correctly", sys.platform)
    VLLM_TARGET_DEVICE = "empty"
58
elif (sys.platform.startswith("linux") and torch.version.cuda is None
59
60
61
      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,
62
63
    # fallback to cpu
    VLLM_TARGET_DEVICE = "cpu"
64

65
66
MAIN_CUDA_VERSION = "12.1"

bnellnm's avatar
bnellnm committed
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82

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


class CMakeExtension(Extension):

    def __init__(self, name: str, cmake_lists_dir: str = '.', **kwa) -> None:
83
        super().__init__(name, sources=[], py_limited_api=True, **kwa)
bnellnm's avatar
bnellnm committed
84
85
86
87
88
        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.
89
    did_config: Dict[str, bool] = {}
bnellnm's avatar
bnellnm committed
90
91
92
93
94

    #
    # Determine number of compilation jobs and optionally nvcc compile threads.
    #
    def compute_num_jobs(self):
95
96
        # `num_jobs` is either the value of the MAX_JOBS environment variable
        # (if defined) or the number of CPUs available.
97
        num_jobs = envs.MAX_JOBS
98
99
        if num_jobs is not None:
            num_jobs = int(num_jobs)
100
            logger.info("Using MAX_JOBS=%d as the number of jobs.", num_jobs)
101
102
103
104
105
106
107
        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
108

109
        nvcc_threads = None
110
111
112
113
114
        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.
115
            nvcc_threads = envs.NVCC_THREADS
116
117
            if nvcc_threads is not None:
                nvcc_threads = int(nvcc_threads)
118
119
120
                logger.info(
                    "Using NVCC_THREADS=%d as the number of nvcc threads.",
                    nvcc_threads)
121
122
123
            else:
                nvcc_threads = 1
            num_jobs = max(1, num_jobs // nvcc_threads)
bnellnm's avatar
bnellnm committed
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140

        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"
141
        cfg = envs.CMAKE_BUILD_TYPE or default_cfg
bnellnm's avatar
bnellnm committed
142
143
144

        cmake_args = [
            '-DCMAKE_BUILD_TYPE={}'.format(cfg),
145
            '-DVLLM_TARGET_DEVICE={}'.format(VLLM_TARGET_DEVICE),
bnellnm's avatar
bnellnm committed
146
147
        ]

148
        verbose = envs.VERBOSE
bnellnm's avatar
bnellnm committed
149
150
151
152
153
        if verbose:
            cmake_args += ['-DCMAKE_VERBOSE_MAKEFILE=ON']

        if is_sccache_available():
            cmake_args += [
154
                '-DCMAKE_C_COMPILER_LAUNCHER=sccache',
bnellnm's avatar
bnellnm committed
155
156
                '-DCMAKE_CXX_COMPILER_LAUNCHER=sccache',
                '-DCMAKE_CUDA_COMPILER_LAUNCHER=sccache',
157
                '-DCMAKE_HIP_COMPILER_LAUNCHER=sccache',
bnellnm's avatar
bnellnm committed
158
159
160
            ]
        elif is_ccache_available():
            cmake_args += [
161
                '-DCMAKE_C_COMPILER_LAUNCHER=ccache',
bnellnm's avatar
bnellnm committed
162
163
                '-DCMAKE_CXX_COMPILER_LAUNCHER=ccache',
                '-DCMAKE_CUDA_COMPILER_LAUNCHER=ccache',
164
                '-DCMAKE_HIP_COMPILER_LAUNCHER=ccache',
bnellnm's avatar
bnellnm committed
165
166
167
168
169
170
            ]

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

171
172
173
174
        # 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))]

175
176
177
178
179
180
181
182
        # 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
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
        #
        # 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 = []
        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)

215
        targets = []
216
217
218
219

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

bnellnm's avatar
bnellnm committed
220
221
222
        # Build all the extensions
        for ext in self.extensions:
            self.configure(ext)
223
            targets.append(target_name(ext.name))
bnellnm's avatar
bnellnm committed
224

225
        num_jobs, _ = self.compute_num_jobs()
bnellnm's avatar
bnellnm committed
226

227
228
229
230
231
232
        build_args = [
            "--build",
            ".",
            f"-j={num_jobs}",
            *[f"--target={name}" for name in targets],
        ]
bnellnm's avatar
bnellnm committed
233

234
        subprocess.check_call(["cmake", *build_args], cwd=self.build_temp)
bnellnm's avatar
bnellnm committed
235

236
237
238
239
240
241
242
243
244
245
246
        # 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.
247
248
249
            # We assume only the final component of extension prefix is added by
            # CMake, this is currently true for current extensions but may not
            # always be the case.
250
            prefix = outdir
251
            if '.' in ext.name:
252
253
254
255
256
257
258
259
260
                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)

261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
    def run(self):
        # First, run the standard build_ext command to compile the extensions
        super().run()

        # copy vllm/vllm_flash_attn/*.py from self.build_lib to current
        # directory so that they can be included in the editable build
        import glob
        files = glob.glob(
            os.path.join(self.build_lib, "vllm", "vllm_flash_attn", "*.py"))
        for file in files:
            dst_file = os.path.join("vllm/vllm_flash_attn",
                                    os.path.basename(file))
            print(f"Copying {file} to {dst_file}")
            self.copy_file(file, dst_file)

276

277
278
279
class repackage_wheel(build_ext):
    """Extracts libraries and other files from an existing wheel."""

280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
    def get_base_commit_in_main_branch(self) -> str:
        import subprocess

        try:
            current_branch = subprocess.check_output(
                ["git", "branch", "--show-current"]).decode("utf-8").strip()

            base_commit = subprocess.check_output(
                ["git", "merge-base", "main",
                 current_branch]).decode("utf-8").strip()
            return base_commit
        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"
297

298
    def run(self) -> None:
299
300
301
        assert _is_cuda(
        ), "VLLM_USE_PRECOMPILED is only supported for CUDA builds"

302
303
304
305
306
        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"

307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
        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

        with zipfile.ZipFile(wheel_path) as wheel:
            files_to_copy = [
                "vllm/_C.abi3.so",
                "vllm/_moe_C.abi3.so",
339
340
                "vllm/vllm_flash_attn/_vllm_fa2_C.abi3.so",
                "vllm/vllm_flash_attn/_vllm_fa3_C.abi3.so",
341
342
                "vllm/vllm_flash_attn/flash_attn_interface.py",
                "vllm/vllm_flash_attn/__init__.py",
343
                "vllm/cumem_allocator.abi3.so",
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
                # "vllm/_version.py", # not available in nightly wheels yet
            ]
            file_members = filter(lambda x: x.filename in files_to_copy,
                                  wheel.filelist)

            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] = []

                wheel.extract(file)
                if file_name.endswith(".py"):
                    # python files shouldn't be added to package_data
                    continue

                package_data[package_name].append(file_name)


366
def _is_hpu() -> bool:
367
368
369
370
371
372
373
    # if VLLM_TARGET_DEVICE env var was set explicitly, skip HPU autodetection
    if os.getenv("VLLM_TARGET_DEVICE", None) == VLLM_TARGET_DEVICE:
        return VLLM_TARGET_DEVICE == "hpu"

    # if VLLM_TARGET_DEVICE was not set explicitly, check if hl-smi succeeds,
    # and if it doesn't, check if habanalabs driver is loaded
    is_hpu_available = False
374
    try:
375
376
        out = subprocess.run(["hl-smi"], capture_output=True, check=True)
        is_hpu_available = out.returncode == 0
377
    except (FileNotFoundError, PermissionError, subprocess.CalledProcessError):
378
        if sys.platform.startswith("linux"):
379
380
381
382
383
384
            try:
                output = subprocess.check_output(
                    'lsmod | grep habanalabs | wc -l', shell=True)
                is_hpu_available = int(output) > 0
            except (ValueError, FileNotFoundError, PermissionError,
                    subprocess.CalledProcessError):
385
386
                pass
    return is_hpu_available
387
388


389
390
391
392
def _no_device() -> bool:
    return VLLM_TARGET_DEVICE == "empty"


393
def _is_cuda() -> bool:
394
395
    has_cuda = torch.version.cuda is not None
    return (VLLM_TARGET_DEVICE == "cuda" and has_cuda
396
            and not (_is_neuron() or _is_tpu() or _is_hpu()))
397
398
399


def _is_hip() -> bool:
400
401
    return (VLLM_TARGET_DEVICE == "cuda"
            or VLLM_TARGET_DEVICE == "rocm") and torch.version.hip is not None
402
403


404
def _is_neuron() -> bool:
405
    return VLLM_TARGET_DEVICE == "neuron"
406
407


408
409
410
411
def _is_tpu() -> bool:
    return VLLM_TARGET_DEVICE == "tpu"


412
413
def _is_cpu() -> bool:
    return VLLM_TARGET_DEVICE == "cpu"
414
415


416
417
418
419
def _is_openvino() -> bool:
    return VLLM_TARGET_DEVICE == "openvino"


420
421
422
423
def _is_xpu() -> bool:
    return VLLM_TARGET_DEVICE == "xpu"


424
425
426
427
def _build_custom_ops() -> bool:
    return _is_cuda() or _is_hip() or _is_cpu()


428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
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()
447

448
449
        if (get_rocm_core_version(ctypes.byref(major), ctypes.byref(minor),
                                  ctypes.byref(patch)) == 0):
450
            return f"{major.value}.{minor.value}.{patch.value}"
451
        return None
452
    except Exception:
453
        return None
Woosuk Kwon's avatar
Woosuk Kwon committed
454

455

456
457
458
def get_neuronxcc_version():
    import sysconfig
    site_dir = sysconfig.get_paths()["purelib"]
459
460
    version_file = os.path.join(site_dir, "neuronxcc", "version",
                                "__init__.py")
461
462

    # Check if the command was executed successfully
463
    with open(version_file) as fp:
464
465
466
467
468
469
470
471
        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:
472
        raise RuntimeError("Could not find Neuron version in the output")
473
474


bnellnm's avatar
bnellnm committed
475
def get_nvcc_cuda_version() -> Version:
476
477
478
479
    """Get the CUDA version from nvcc.

    Adapted from https://github.com/NVIDIA/apex/blob/8b7a1ff183741dd8f9b87e7bafd04cfde99cea28/setup.py
    """
480
    assert CUDA_HOME is not None, "CUDA_HOME is not set"
bnellnm's avatar
bnellnm committed
481
    nvcc_output = subprocess.check_output([CUDA_HOME + "/bin/nvcc", "-V"],
482
483
484
485
486
487
488
                                          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


489
490
491
492
def get_path(*filepath) -> str:
    return os.path.join(ROOT_DIR, *filepath)


zhuwenwen's avatar
zhuwenwen committed
493
494
495
496
497
498
def get_sha(root: Union[str, Path]) -> str:
    try:
        return subprocess.check_output(['git', 'rev-parse', 'HEAD'], cwd=root).decode('ascii').strip()
    except Exception:
        return 'Unknown'

499

zhuwenwen's avatar
zhuwenwen committed
500
def get_version_add(sha: Optional[str] = None) -> str:
zhuwenwen's avatar
zhuwenwen committed
501
502
    command = "git config --global --add safe.directory "+pwd  
    result = subprocess.run(command, shell=True, capture_output=False, text=True) 
zhuwenwen's avatar
zhuwenwen committed
503
504
    vllm_root = os.path.dirname(os.path.abspath(__file__))
    add_version_path = os.path.join(os.path.join(vllm_root, "vllm"), "version.py")
zhuwenwen's avatar
zhuwenwen committed
505
    major, minor, _ = torch.__version__.split('.')
506
507
508
509
    if add_git_version:
        if sha != 'Unknown':
            if sha is None:
                sha = get_sha(vllm_root)
zhuwenwen's avatar
zhuwenwen committed
510
            if (major, minor) == ('2', '4'):
511
                version = 'das.opt1.' + sha[:7]
512
    else:
zhuwenwen's avatar
zhuwenwen committed
513
        if (major, minor) == ('2', '4'):
514
            version = 'das.opt1'
515

zhuwenwen's avatar
zhuwenwen committed
516
517
518
519
520
521
522

    # dtk version
    if os.getenv("ROCM_PATH"):
        rocm_path = os.getenv('ROCM_PATH', "")
        rocm_version_path = os.path.join(rocm_path, '.info', "rocm_version")
        with open(rocm_version_path, 'r',encoding='utf-8') as file:
            lines = file.readlines()
zhuwenwen's avatar
zhuwenwen committed
523
        rocm_version=lines[0].replace(".", "")
zhuwenwen's avatar
zhuwenwen committed
524
        version += ".dtk" + rocm_version
zhuwenwen's avatar
zhuwenwen committed
525
    
526
    new_version_content = f"""
527
try:
zhuwenwen's avatar
zhuwenwen committed
528
529
530
    __version__ = "0.7.3"
    __version_tuple__ = (0, 7, 3)
    __hcu_version__ = f'0.7.3+{version}' 
zhuwenwen's avatar
zhuwenwen committed
531
    
zhuwenwen's avatar
zhuwenwen committed
532
    from vllm.version import __version__, __version_tuple__, __hcu_version__
533
except Exception as e:
zhuwenwen's avatar
zhuwenwen committed
534
535
    import warnings

zhuwenwen's avatar
zhuwenwen committed
536
    warnings.warn(f"Failed to read commit hash:\\n + str(e)",
537
538
                  RuntimeWarning,
                  stacklevel=2)
539
540
    __version__ = "dev"
    __version_tuple__ = (0, 0, __version__)
541
"""
zhuwenwen's avatar
zhuwenwen committed
542
    
zhuwenwen's avatar
zhuwenwen committed
543
    with open(add_version_path, encoding="utf-8",mode="w") as file:
zhuwenwen's avatar
zhuwenwen committed
544
        file.write(new_version_content)
zhuwenwen's avatar
zhuwenwen committed
545
546
547
548
549
550
551
552
    file.close()
    
    
def get_version():
    get_version_add()
    version_file = 'vllm/version.py'
    with open(version_file, encoding='utf-8') as f:
        exec(compile(f.read(), version_file, 'exec'))
zhuwenwen's avatar
zhuwenwen committed
553
    return locals()['__hcu_version__']
zhuwenwen's avatar
zhuwenwen committed
554
555


556
557
558
559
560
561
562
563
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,
564
                            capture_output=True,
565
566
567
568
569
570
571
                            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


572
def get_vllm_version() -> str:
zhuwenwen's avatar
zhuwenwen committed
573
    if not _is_hip():
zhuwenwen's avatar
zhuwenwen committed
574
        version = get_version(write_to="vllm/_version.py")
zhuwenwen's avatar
zhuwenwen committed
575
        sep = "+" if "+" not in version else "."  # dev versions might contain +
576

577
    if _no_device():
578
        if envs.VLLM_TARGET_DEVICE == "empty":
579
            version += f"{sep}empty"
580
    elif _is_cuda():
581
        if envs.VLLM_USE_PRECOMPILED:
582
            version += f"{sep}precompiled"
583
584
585
586
587
588
589
        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}"
590
    elif _is_hip():
591
        # Get the Rocm Version
zhuwenwen's avatar
zhuwenwen committed
592
593
594
        # 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]}"
zhuwenwen's avatar
zhuwenwen committed
595
        version = get_version()
596
597
    elif _is_neuron():
        # Get the Neuron version
bnellnm's avatar
bnellnm committed
598
        neuron_version = str(get_neuronxcc_version())
599
600
        if neuron_version != MAIN_CUDA_VERSION:
            neuron_version_str = neuron_version.replace(".", "")[:3]
601
            version += f"{sep}neuron{neuron_version_str}"
602
603
604
605
606
607
    elif _is_hpu():
        # Get the Intel Gaudi Software Suite version
        gaudi_sw_version = str(get_gaudi_sw_version())
        if gaudi_sw_version != MAIN_CUDA_VERSION:
            gaudi_sw_version = gaudi_sw_version.replace(".", "")[:3]
            version += f"{sep}gaudi{gaudi_sw_version}"
608
    elif _is_openvino():
609
        version += f"{sep}openvino"
610
    elif _is_tpu():
611
        version += f"{sep}tpu"
612
    elif _is_cpu():
613
614
        if envs.VLLM_TARGET_DEVICE == "cpu":
            version += f"{sep}cpu"
615
    elif _is_xpu():
616
        version += f"{sep}xpu"
617
    else:
618
        raise RuntimeError("Unknown runtime environment")
619

620
621
622
    return version


623
624
def get_requirements() -> List[str]:
    """Get Python package dependencies from requirements.txt."""
625
626
627

    def _read_requirements(filename: str) -> List[str]:
        with open(get_path(filename)) as f:
628
            requirements = f.read().strip().split("\n")
629
630
631
632
        resolved_requirements = []
        for line in requirements:
            if line.startswith("-r "):
                resolved_requirements += _read_requirements(line.split()[1])
633
634
            elif line.startswith("--"):
                continue
635
636
637
638
            else:
                resolved_requirements.append(line)
        return resolved_requirements

639
    if _no_device():
640
        requirements = _read_requirements("requirements-common.txt")
641
    elif _is_cuda():
642
        requirements = _read_requirements("requirements-cuda.txt")
643
        cuda_major, cuda_minor = torch.version.cuda.split(".")
644
645
        modified_requirements = []
        for req in requirements:
646
647
            if ("vllm-flash-attn" in req
                    and not (cuda_major == "12" and cuda_minor == "1")):
648
649
650
651
                # vllm-flash-attn is built only for CUDA 12.1.
                # Skip for other versions.
                continue
            modified_requirements.append(req)
652
        requirements = modified_requirements
653
    elif _is_hip():
654
        requirements = _read_requirements("requirements-rocm.txt")
655
    elif _is_neuron():
656
        requirements = _read_requirements("requirements-neuron.txt")
657
658
    elif _is_hpu():
        requirements = _read_requirements("requirements-hpu.txt")
659
660
    elif _is_openvino():
        requirements = _read_requirements("requirements-openvino.txt")
661
662
    elif _is_tpu():
        requirements = _read_requirements("requirements-tpu.txt")
663
    elif _is_cpu():
664
        requirements = _read_requirements("requirements-cpu.txt")
665
666
    elif _is_xpu():
        requirements = _read_requirements("requirements-xpu.txt")
667
    else:
668
        raise ValueError(
669
            "Unsupported platform, please use CUDA, ROCm, Neuron, HPU, "
670
            "OpenVINO, or CPU.")
671
672
673
    return requirements


bnellnm's avatar
bnellnm committed
674
675
ext_modules = []

676
if _is_cuda() or _is_hip():
bnellnm's avatar
bnellnm committed
677
678
    ext_modules.append(CMakeExtension(name="vllm._moe_C"))

679
680
# if _is_hip():
#     ext_modules.append(CMakeExtension(name="vllm._rocm_C"))
681

682
if _is_cuda():
683
    ext_modules.append(CMakeExtension(name="vllm.vllm_flash_attn._vllm_fa2_C"))
684
685
686
687
    if envs.VLLM_USE_PRECOMPILED or get_nvcc_cuda_version() >= Version("12.0"):
        # FA3 requires CUDA 12.0 or later
        ext_modules.append(
            CMakeExtension(name="vllm.vllm_flash_attn._vllm_fa3_C"))
688
    ext_modules.append(CMakeExtension(name="vllm.cumem_allocator"))
689

690
if _build_custom_ops():
bnellnm's avatar
bnellnm committed
691
692
    ext_modules.append(CMakeExtension(name="vllm._C"))

693
package_data = {
694
695
696
697
    "vllm": [
        "py.typed",
        "model_executor/layers/fused_moe/configs/*.json",
        "model_executor/layers/quantization/utils/configs/*.json",
zhuwenwen's avatar
zhuwenwen committed
698
        "benchmarks/*.py",
699
        "attention/backends/configs/*.json",
700
        "model_executor/layers/quantization/configs/awq/*.json"
701
    ]
702
}
Simon Mo's avatar
Simon Mo committed
703

704
705
706
if _no_device():
    ext_modules = []

707
708
709
710
711
712
713
714
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
715
setup(
716
    # static metadata should rather go in pyproject.toml
717
    version=get_vllm_version(),
Woosuk Kwon's avatar
Woosuk Kwon committed
718
    ext_modules=ext_modules,
719
    install_requires=get_requirements(),
720
    extras_require={
721
        "tensorizer": ["tensorizer>=2.9.0"],
722
        "runai": ["runai-model-streamer", "runai-model-streamer-s3", "boto3"],
723
724
        "audio": ["librosa", "soundfile"],  # Required for audio processing
        "video": ["decord"]  # Required for video processing
725
    },
726
    cmdclass=cmdclass,
Simon Mo's avatar
Simon Mo committed
727
    package_data=package_data,
Woosuk Kwon's avatar
Woosuk Kwon committed
728
)