setup.py 26.1 KB
Newer Older
1
import ctypes
2
import importlib.util
3
import logging
4
5
import os
import re
6
import subprocess
bnellnm's avatar
bnellnm committed
7
import sys
8
from pathlib import Path
9
from shutil import which
10
from typing import Dict, List
11

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

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

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

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


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

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

45
if sys.platform.startswith("darwin") and VLLM_TARGET_DEVICE != "cpu":
46
    logger.warning(
47
48
49
50
51
52
        "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."
53
54
55
        "Building on %s, "
        "so vLLM may not be able to run correctly", sys.platform)
    VLLM_TARGET_DEVICE = "empty"
56

57
58
MAIN_CUDA_VERSION = "12.1"

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

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:
75
        super().__init__(name, sources=[], py_limited_api=True, **kwa)
bnellnm's avatar
bnellnm committed
76
77
78
79
80
        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.
81
    did_config: Dict[str, bool] = {}
bnellnm's avatar
bnellnm committed
82
83
84
85
86

    #
    # Determine number of compilation jobs and optionally nvcc compile threads.
    #
    def compute_num_jobs(self):
87
88
        # `num_jobs` is either the value of the MAX_JOBS environment variable
        # (if defined) or the number of CPUs available.
89
        num_jobs = envs.MAX_JOBS
90
91
        if num_jobs is not None:
            num_jobs = int(num_jobs)
92
            logger.info("Using MAX_JOBS=%d as the number of jobs.", num_jobs)
93
94
95
96
97
98
99
        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
100

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

        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"
133
        cfg = envs.CMAKE_BUILD_TYPE or default_cfg
bnellnm's avatar
bnellnm committed
134
135
136

        cmake_args = [
            '-DCMAKE_BUILD_TYPE={}'.format(cfg),
137
            '-DVLLM_TARGET_DEVICE={}'.format(VLLM_TARGET_DEVICE),
bnellnm's avatar
bnellnm committed
138
139
        ]

140
        verbose = envs.VERBOSE
bnellnm's avatar
bnellnm committed
141
142
143
144
145
        if verbose:
            cmake_args += ['-DCMAKE_VERBOSE_MAKEFILE=ON']

        if is_sccache_available():
            cmake_args += [
146
                '-DCMAKE_C_COMPILER_LAUNCHER=sccache',
bnellnm's avatar
bnellnm committed
147
148
                '-DCMAKE_CXX_COMPILER_LAUNCHER=sccache',
                '-DCMAKE_CUDA_COMPILER_LAUNCHER=sccache',
149
                '-DCMAKE_HIP_COMPILER_LAUNCHER=sccache',
bnellnm's avatar
bnellnm committed
150
151
152
            ]
        elif is_ccache_available():
            cmake_args += [
153
                '-DCMAKE_C_COMPILER_LAUNCHER=ccache',
bnellnm's avatar
bnellnm committed
154
155
                '-DCMAKE_CXX_COMPILER_LAUNCHER=ccache',
                '-DCMAKE_CUDA_COMPILER_LAUNCHER=ccache',
156
                '-DCMAKE_HIP_COMPILER_LAUNCHER=ccache',
bnellnm's avatar
bnellnm committed
157
158
159
160
161
162
            ]

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

163
164
165
166
        # 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))]

167
168
169
170
171
172
173
174
        # 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
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
        #
        # 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)

207
        targets = []
208
209
210
211

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

bnellnm's avatar
bnellnm committed
212
213
214
        # Build all the extensions
        for ext in self.extensions:
            self.configure(ext)
215
            targets.append(target_name(ext.name))
bnellnm's avatar
bnellnm committed
216

217
        num_jobs, _ = self.compute_num_jobs()
bnellnm's avatar
bnellnm committed
218

219
220
221
222
223
224
        build_args = [
            "--build",
            ".",
            f"-j={num_jobs}",
            *[f"--target={name}" for name in targets],
        ]
bnellnm's avatar
bnellnm committed
225

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

228
229
230
231
232
233
234
235
236
237
238
        # 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.
239
240
241
            # 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.
242
            prefix = outdir
243
            if '.' in ext.name:
244
245
246
247
248
249
250
251
252
                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)

253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
    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)

268

269
270
class repackage_wheel(build_ext):
    """Extracts libraries and other files from an existing wheel."""
youkaichao's avatar
youkaichao committed
271
    default_wheel = "https://wheels.vllm.ai/nightly/vllm-1.0.0.dev-cp38-abi3-manylinux1_x86_64.whl"
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311

    def run(self) -> None:
        wheel_location = os.getenv("VLLM_PRECOMPILED_WHEEL_LOCATION",
                                   self.default_wheel)

        assert _is_cuda(
        ), "VLLM_USE_PRECOMPILED is only supported for CUDA builds"

        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",
312
313
                "vllm/vllm_flash_attn/_vllm_fa2_C.abi3.so",
                "vllm/vllm_flash_attn/_vllm_fa3_C.abi3.so",
314
315
                "vllm/vllm_flash_attn/flash_attn_interface.py",
                "vllm/vllm_flash_attn/__init__.py",
316
                "vllm/cumem_allocator.abi3.so",
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
                # "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)


339
def _is_hpu() -> bool:
340
341
342
343
344
345
346
    # 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
347
    try:
348
349
        out = subprocess.run(["hl-smi"], capture_output=True, check=True)
        is_hpu_available = out.returncode == 0
350
    except (FileNotFoundError, PermissionError, subprocess.CalledProcessError):
351
        if sys.platform.startswith("linux"):
352
353
354
355
356
357
            try:
                output = subprocess.check_output(
                    'lsmod | grep habanalabs | wc -l', shell=True)
                is_hpu_available = int(output) > 0
            except (ValueError, FileNotFoundError, PermissionError,
                    subprocess.CalledProcessError):
358
359
                pass
    return is_hpu_available
360
361


362
363
364
365
def _no_device() -> bool:
    return VLLM_TARGET_DEVICE == "empty"


366
def _is_cuda() -> bool:
367
368
    has_cuda = torch.version.cuda is not None
    return (VLLM_TARGET_DEVICE == "cuda" and has_cuda
369
            and not (_is_neuron() or _is_tpu() or _is_hpu()))
370
371
372


def _is_hip() -> bool:
373
374
    return (VLLM_TARGET_DEVICE == "cuda"
            or VLLM_TARGET_DEVICE == "rocm") and torch.version.hip is not None
375
376


377
378
379
380
def _is_neuron() -> bool:
    torch_neuronx_installed = True
    try:
        subprocess.run(["neuron-ls"], capture_output=True, check=True)
381
    except (FileNotFoundError, PermissionError, subprocess.CalledProcessError):
382
        torch_neuronx_installed = False
383
    return torch_neuronx_installed or VLLM_TARGET_DEVICE == "neuron"
384
385


386
387
388
389
def _is_tpu() -> bool:
    return VLLM_TARGET_DEVICE == "tpu"


390
391
def _is_cpu() -> bool:
    return VLLM_TARGET_DEVICE == "cpu"
392
393


394
395
396
397
def _is_openvino() -> bool:
    return VLLM_TARGET_DEVICE == "openvino"


398
399
400
401
def _is_xpu() -> bool:
    return VLLM_TARGET_DEVICE == "xpu"


402
403
404
405
def _build_custom_ops() -> bool:
    return _is_cuda() or _is_hip() or _is_cpu()


406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
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()
425

426
427
        if (get_rocm_core_version(ctypes.byref(major), ctypes.byref(minor),
                                  ctypes.byref(patch)) == 0):
428
            return f"{major.value}.{minor.value}.{patch.value}"
429
        return None
430
    except Exception:
431
        return None
Woosuk Kwon's avatar
Woosuk Kwon committed
432

433

434
435
436
def get_neuronxcc_version():
    import sysconfig
    site_dir = sysconfig.get_paths()["purelib"]
437
438
    version_file = os.path.join(site_dir, "neuronxcc", "version",
                                "__init__.py")
439
440

    # Check if the command was executed successfully
441
    with open(version_file) as fp:
442
443
444
445
446
447
448
449
        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:
450
        raise RuntimeError("Could not find Neuron version in the output")
451
452


bnellnm's avatar
bnellnm committed
453
def get_nvcc_cuda_version() -> Version:
454
455
456
457
    """Get the CUDA version from nvcc.

    Adapted from https://github.com/NVIDIA/apex/blob/8b7a1ff183741dd8f9b87e7bafd04cfde99cea28/setup.py
    """
458
    assert CUDA_HOME is not None, "CUDA_HOME is not set"
bnellnm's avatar
bnellnm committed
459
    nvcc_output = subprocess.check_output([CUDA_HOME + "/bin/nvcc", "-V"],
460
461
462
463
464
465
466
                                          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


467
468
469
470
def get_path(*filepath) -> str:
    return os.path.join(ROOT_DIR, *filepath)


zhuwenwen's avatar
zhuwenwen committed
471
472
473
474
475
476
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'

477

zhuwenwen's avatar
zhuwenwen committed
478
def get_version_add(sha: Optional[str] = None) -> str:
zhuwenwen's avatar
zhuwenwen committed
479
480
    command = "git config --global --add safe.directory "+pwd  
    result = subprocess.run(command, shell=True, capture_output=False, text=True) 
zhuwenwen's avatar
zhuwenwen committed
481
482
    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
483
    major, minor, _ = torch.__version__.split('.')
484
485
486
487
    if add_git_version:
        if sha != 'Unknown':
            if sha is None:
                sha = get_sha(vllm_root)
zhuwenwen's avatar
zhuwenwen committed
488
489
            # if (major, minor) == ('2', '3'):
            #     version = 'das.opt1.' + sha[:7]
zhuwenwen's avatar
zhuwenwen committed
490
            if (major, minor) == ('2', '4'):
zhuwenwen's avatar
zhuwenwen committed
491
                version = 'das.opt1.' + sha[:7]
492
    else:
zhuwenwen's avatar
zhuwenwen committed
493
494
        # if (major, minor) == ('2', '3'):
        #     version = 'das.opt1'
zhuwenwen's avatar
zhuwenwen committed
495
        if (major, minor) == ('2', '4'):
zhuwenwen's avatar
zhuwenwen committed
496
            version = 'das.opt1'
497

zhuwenwen's avatar
zhuwenwen committed
498
499
500
501
502
503
504

    # 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
505
        rocm_version=lines[0].replace(".", "")
zhuwenwen's avatar
zhuwenwen committed
506
        version += ".dtk" + rocm_version
zhuwenwen's avatar
zhuwenwen committed
507
    
508
    new_version_content = f"""
509
try:
zhuwenwen's avatar
zhuwenwen committed
510
511
512
    __version__ = "0.7.1"
    __version_tuple__ = (0, 7, 1)
    __hcu_version__ = f'0.7.1+{version}' 
zhuwenwen's avatar
zhuwenwen committed
513
    
zhuwenwen's avatar
zhuwenwen committed
514
    from vllm.version import __version__, __version_tuple__, __hcu_version__
515
except Exception as e:
zhuwenwen's avatar
zhuwenwen committed
516
517
    import warnings

zhuwenwen's avatar
zhuwenwen committed
518
    warnings.warn(f"Failed to read commit hash:\\n + str(e)",
519
520
                  RuntimeWarning,
                  stacklevel=2)
521
522
    __version__ = "dev"
    __version_tuple__ = (0, 0, __version__)
523
"""
zhuwenwen's avatar
zhuwenwen committed
524
    
zhuwenwen's avatar
zhuwenwen committed
525
    with open(add_version_path, encoding="utf-8",mode="w") as file:
zhuwenwen's avatar
zhuwenwen committed
526
        file.write(new_version_content)
zhuwenwen's avatar
zhuwenwen committed
527
528
529
530
531
532
533
534
    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
535
    return locals()['__hcu_version__']
zhuwenwen's avatar
zhuwenwen committed
536
537


538
539
540
541
542
543
544
545
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,
546
                            capture_output=True,
547
548
549
550
551
552
553
                            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


554
def get_vllm_version() -> str:
zhuwenwen's avatar
zhuwenwen committed
555
556
557
558
    if not _is_hip():
        version = get_version(
            write_to="vllm/_version.py",  # TODO: move this to pyproject.toml
        )
559

zhuwenwen's avatar
zhuwenwen committed
560
        sep = "+" if "+" not in version else "."  # dev versions might contain +
561

562
    if _no_device():
563
        if envs.VLLM_TARGET_DEVICE == "empty":
564
            version += f"{sep}empty"
565
    elif _is_cuda():
566
        if envs.VLLM_USE_PRECOMPILED:
567
            version += f"{sep}precompiled"
568
569
570
571
572
573
574
        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}"
575
    elif _is_hip():
576
        # Get the Rocm Version
zhuwenwen's avatar
zhuwenwen committed
577
578
579
        # 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
580
        version = get_version()
581
582
    elif _is_neuron():
        # Get the Neuron version
bnellnm's avatar
bnellnm committed
583
        neuron_version = str(get_neuronxcc_version())
584
585
        if neuron_version != MAIN_CUDA_VERSION:
            neuron_version_str = neuron_version.replace(".", "")[:3]
586
            version += f"{sep}neuron{neuron_version_str}"
587
588
589
590
591
592
    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}"
593
    elif _is_openvino():
594
        version += f"{sep}openvino"
595
    elif _is_tpu():
596
        version += f"{sep}tpu"
597
    elif _is_cpu():
598
        version += f"{sep}cpu"
599
    elif _is_xpu():
600
        version += f"{sep}xpu"
601
    else:
602
        raise RuntimeError("Unknown runtime environment")
603

604
605
606
    return version


607
def read_readme() -> str:
Stephen Krider's avatar
Stephen Krider committed
608
609
610
    """Read the README file if present."""
    p = get_path("README.md")
    if os.path.isfile(p):
611
612
        with open(get_path("README.md"), encoding="utf-8") as f:
            return f.read()
Stephen Krider's avatar
Stephen Krider committed
613
614
    else:
        return ""
615
616


617
618
def get_requirements() -> List[str]:
    """Get Python package dependencies from requirements.txt."""
619
620
621

    def _read_requirements(filename: str) -> List[str]:
        with open(get_path(filename)) as f:
622
            requirements = f.read().strip().split("\n")
623
624
625
626
        resolved_requirements = []
        for line in requirements:
            if line.startswith("-r "):
                resolved_requirements += _read_requirements(line.split()[1])
627
628
            elif line.startswith("--"):
                continue
629
630
631
632
            else:
                resolved_requirements.append(line)
        return resolved_requirements

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


bnellnm's avatar
bnellnm committed
668
669
ext_modules = []

670
if _is_cuda() or _is_hip():
bnellnm's avatar
bnellnm committed
671
672
    ext_modules.append(CMakeExtension(name="vllm._moe_C"))

673
674
# if _is_hip():
#     ext_modules.append(CMakeExtension(name="vllm._rocm_C"))
675

676
if _is_cuda():
677
    ext_modules.append(CMakeExtension(name="vllm.vllm_flash_attn._vllm_fa2_C"))
678
679
680
681
    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"))
682
    ext_modules.append(CMakeExtension(name="vllm.cumem_allocator"))
683

684
if _build_custom_ops():
bnellnm's avatar
bnellnm committed
685
686
    ext_modules.append(CMakeExtension(name="vllm._C"))

687
package_data = {
688
689
690
691
    "vllm": [
        "py.typed",
        "model_executor/layers/fused_moe/configs/*.json",
        "model_executor/layers/quantization/utils/configs/*.json",
zhuwenwen's avatar
zhuwenwen committed
692
693
        "benchmarks/*.py",
        "model_executor/layers/quantization/configs/w8a8/*.json"
694
    ]
695
}
Simon Mo's avatar
Simon Mo committed
696

697
698
699
if _no_device():
    ext_modules = []

700
701
702
703
704
705
706
707
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
708
setup(
Woosuk Kwon's avatar
Woosuk Kwon committed
709
    name="vllm",
710
    version=get_vllm_version(),
Woosuk Kwon's avatar
Woosuk Kwon committed
711
    author="vLLM Team",
712
    license="Apache 2.0",
Woosuk Kwon's avatar
Woosuk Kwon committed
713
714
    description=("A high-throughput and memory-efficient inference and "
                 "serving engine for LLMs"),
715
716
    long_description=read_readme(),
    long_description_content_type="text/markdown",
717
    url="https://github.com/vllm-project/vllm",
718
    project_urls={
719
720
        "Homepage": "https://github.com/vllm-project/vllm",
        "Documentation": "https://vllm.readthedocs.io/en/latest/",
721
722
723
724
    },
    classifiers=[
        "Programming Language :: Python :: 3.9",
        "Programming Language :: Python :: 3.10",
Woosuk Kwon's avatar
Woosuk Kwon committed
725
        "Programming Language :: Python :: 3.11",
726
        "Programming Language :: Python :: 3.12",
727
        "License :: OSI Approved :: Apache Software License",
728
729
730
        "Intended Audience :: Developers",
        "Intended Audience :: Information Technology",
        "Intended Audience :: Science/Research",
731
        "Topic :: Scientific/Engineering :: Artificial Intelligence",
732
        "Topic :: Scientific/Engineering :: Information Analysis",
733
    ],
bnellnm's avatar
bnellnm committed
734
    packages=find_packages(exclude=("benchmarks", "csrc", "docs", "examples",
735
                                    "tests*")),
736
    python_requires=">=3.9",
737
    install_requires=get_requirements(),
Woosuk Kwon's avatar
Woosuk Kwon committed
738
    ext_modules=ext_modules,
739
    extras_require={
740
        "tensorizer": ["tensorizer>=2.9.0"],
741
        "runai": ["runai-model-streamer", "runai-model-streamer-s3", "boto3"],
742
743
        "audio": ["librosa", "soundfile"],  # Required for audio processing
        "video": ["decord"]  # Required for video processing
744
    },
745
    cmdclass=cmdclass,
Simon Mo's avatar
Simon Mo committed
746
    package_data=package_data,
Ethan Xu's avatar
Ethan Xu committed
747
748
749
750
751
    entry_points={
        "console_scripts": [
            "vllm=vllm.scripts:main",
        ],
    },
Woosuk Kwon's avatar
Woosuk Kwon committed
752
)