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

4
import hashlib
5
import json
6
import os
7
import sys
8
import tempfile
9
10
from collections.abc import Callable
from typing import TYPE_CHECKING, Any, Literal
11
12
13

if TYPE_CHECKING:
    VLLM_HOST_IP: str = ""
14
    VLLM_PORT: int | None = None
15
    VLLM_RPC_BASE_PATH: str = tempfile.gettempdir()
16
    VLLM_USE_MODELSCOPE: bool = False
17
    VLLM_RINGBUFFER_WARNING_INTERVAL: int = 60
18
19
    VLLM_NCCL_SO_PATH: str | None = None
    LD_LIBRARY_PATH: str | None = None
20
    VLLM_USE_TRITON_FLASH_ATTN: bool = True
21
    VLLM_V1_USE_PREFILL_DECODE_ATTENTION: bool = False
22
    VLLM_FLASH_ATTN_VERSION: int | None = None
23
    LOCAL_RANK: int = 0
24
    CUDA_VISIBLE_DEVICES: str | None = None
25
    VLLM_ENGINE_ITERATION_TIMEOUT_S: int = 60
26
27
28
29
30
    VLLM_API_KEY: str | None = None
    S3_ACCESS_KEY_ID: str | None = None
    S3_SECRET_ACCESS_KEY: str | None = None
    S3_ENDPOINT_URL: str | None = None
    VLLM_MODEL_REDIRECT_PATH: str | None = None
31
32
    VLLM_CACHE_ROOT: str = os.path.expanduser("~/.cache/vllm")
    VLLM_CONFIG_ROOT: str = os.path.expanduser("~/.config/vllm")
33
34
    VLLM_USAGE_STATS_SERVER: str = "https://stats.vllm.ai"
    VLLM_NO_USAGE_STATS: bool = False
35
    VLLM_DISABLE_FLASHINFER_PREFILL: bool = False
36
37
38
    VLLM_DO_NOT_TRACK: bool = False
    VLLM_USAGE_SOURCE: str = ""
    VLLM_CONFIGURE_LOGGING: int = 1
39
    VLLM_LOGGING_LEVEL: str = "INFO"
40
    VLLM_LOGGING_PREFIX: str = ""
41
    VLLM_LOGGING_STREAM: str = "ext://sys.stdout"
42
43
    VLLM_LOGGING_CONFIG_PATH: str | None = None
    VLLM_LOGITS_PROCESSOR_THREADS: int | None = None
44
    VLLM_LOG_STATS_INTERVAL: float = 10.0
45
    VLLM_TRACE_FUNCTION: int = 0
46
47
48
49
    VLLM_ATTENTION_BACKEND: str | None = None
    VLLM_USE_FLASHINFER_SAMPLER: bool | None = None
    VLLM_PP_LAYER_PARTITION: str | None = None
    VLLM_CPU_KVCACHE_SPACE: int | None = 0
50
    VLLM_CPU_OMP_THREADS_BIND: str = ""
51
    VLLM_CPU_NUM_OF_RESERVED_CPU: int | None = None
52
    VLLM_CPU_MOE_PREPACK: bool = True
53
    VLLM_CPU_SGL_KERNEL: bool = False
54
    VLLM_XLA_CACHE_PATH: str = os.path.join(VLLM_CACHE_ROOT, "xla_cache")
55
    VLLM_XLA_CHECK_RECOMPILATION: bool = False
56
    VLLM_FUSED_MOE_CHUNK_SIZE: int = 64 * 1024
57
    VLLM_ENABLE_FUSED_MOE_ACTIVATION_CHUNKING: bool = True
58
    VLLM_USE_RAY_SPMD_WORKER: bool = False
59
    VLLM_USE_RAY_COMPILED_DAG: bool = False
60
    VLLM_USE_RAY_COMPILED_DAG_CHANNEL_TYPE: Literal["auto", "nccl", "shm"] = "auto"
61
    VLLM_USE_RAY_COMPILED_DAG_OVERLAP_COMM: bool = False
62
    VLLM_USE_RAY_WRAPPED_PP_COMM: bool = True
63
    VLLM_XLA_USE_SPMD: bool = False
64
    VLLM_WORKER_MULTIPROC_METHOD: Literal["fork", "spawn"] = "fork"
65
    VLLM_ASSETS_CACHE: str = os.path.join(VLLM_CACHE_ROOT, "assets")
66
    VLLM_ASSETS_CACHE_MODEL_CLEAN: bool = False
67
    VLLM_IMAGE_FETCH_TIMEOUT: int = 5
68
    VLLM_VIDEO_FETCH_TIMEOUT: int = 30
69
    VLLM_AUDIO_FETCH_TIMEOUT: int = 10
70
    VLLM_MEDIA_URL_ALLOW_REDIRECTS: bool = True
71
    VLLM_MEDIA_LOADING_THREAD_COUNT: int = 8
72
    VLLM_MAX_AUDIO_CLIP_FILESIZE_MB: int = 25
73
    VLLM_VIDEO_LOADER_BACKEND: str = "opencv"
74
    VLLM_MM_INPUT_CACHE_GIB: int = 4
75
    VLLM_TARGET_DEVICE: str = "cuda"
76
    VLLM_MAIN_CUDA_VERSION: str = "12.8"
77
78
    MAX_JOBS: str | None = None
    NVCC_THREADS: str | None = None
79
    VLLM_USE_PRECOMPILED: bool = False
80
    VLLM_DOCKER_BUILD_CONTEXT: bool = False
81
    VLLM_TEST_USE_PRECOMPILED_NIGHTLY_WHEEL: bool = False
82
    VLLM_KEEP_ALIVE_ON_ENGINE_DEATH: bool = False
83
    CMAKE_BUILD_TYPE: Literal["Debug", "Release", "RelWithDebInfo"] | None = None
84
    VERBOSE: bool = False
85
    VLLM_ALLOW_LONG_MAX_MODEL_LEN: bool = False
86
    VLLM_RPC_TIMEOUT: int = 10000  # ms
87
    VLLM_HTTP_TIMEOUT_KEEP_ALIVE: int = 5  # seconds
88
89
90
    VLLM_PLUGINS: list[str] | None = None
    VLLM_LORA_RESOLVER_CACHE_DIR: str | None = None
    VLLM_TORCH_PROFILER_DIR: str | None = None
91
92
    VLLM_TORCH_PROFILER_RECORD_SHAPES: bool = False
    VLLM_TORCH_PROFILER_WITH_PROFILE_MEMORY: bool = False
93
94
    VLLM_USE_AOT_COMPILE: bool = False
    VLLM_FORCE_AOT_LOAD: bool = False
95
96
    VLLM_TORCH_PROFILER_WITH_STACK: bool = True
    VLLM_TORCH_PROFILER_WITH_FLOPS: bool = False
97
    VLLM_USE_TRITON_AWQ: bool = False
98
    VLLM_ALLOW_RUNTIME_LORA_UPDATING: bool = False
99
    VLLM_SKIP_P2P_CHECK: bool = False
100
    VLLM_DISABLED_KERNELS: list[str] = []
101
    VLLM_DISABLE_PYNCCL: bool = False
102
    VLLM_USE_V1: bool = True
103
    VLLM_ROCM_USE_AITER: bool = False
104
    VLLM_ROCM_USE_AITER_PAGED_ATTN: bool = False
105
    VLLM_ROCM_USE_AITER_LINEAR: bool = True
106
    VLLM_ROCM_USE_AITER_MOE: bool = True
107
    VLLM_ROCM_USE_AITER_RMSNORM: bool = True
108
    VLLM_ROCM_USE_AITER_MLA: bool = True
109
    VLLM_ROCM_USE_AITER_MHA: bool = True
110
111
    VLLM_ROCM_USE_AITER_FP4_ASM_GEMM: bool = False
    VLLM_ROCM_USE_TRITON_ROPE: bool = False
112
    VLLM_ROCM_USE_AITER_FP8BMM: bool = True
113
    VLLM_ROCM_USE_AITER_UNIFIED_ATTENTION: bool = False
114
    VLLM_ROCM_USE_SKINNY_GEMM: bool = True
115
    VLLM_ROCM_FP8_PADDING: bool = True
116
    VLLM_ROCM_MOE_PADDING: bool = True
117
    VLLM_ROCM_CUSTOM_PAGED_ATTN: bool = True
118
    VLLM_ENABLE_V1_MULTIPROCESSING: bool = True
119
    VLLM_LOG_BATCHSIZE_INTERVAL: float = -1
120
    VLLM_DISABLE_COMPILE_CACHE: bool = False
121
    Q_SCALE_CONSTANT: int = 200
122
123
    K_SCALE_CONSTANT: int = 200
    V_SCALE_CONSTANT: int = 100
124
    VLLM_SERVER_DEV_MODE: bool = False
125
    VLLM_V1_OUTPUT_PROC_CHUNK_SIZE: int = 128
126
    VLLM_MLA_DISABLE: bool = False
127
    VLLM_FLASH_ATTN_MAX_NUM_SPLITS_FOR_CUDA_GRAPH: int = 32
128
129
    VLLM_RAY_PER_WORKER_GPUS: float = 1.0
    VLLM_RAY_BUNDLE_INDICES: str = ""
130
    VLLM_CUDART_SO_PATH: str | None = None
131
    VLLM_DP_RANK: int = 0
132
    VLLM_DP_RANK_LOCAL: int = -1
133
    VLLM_DP_SIZE: int = 1
134
    VLLM_USE_STANDALONE_COMPILE: bool = False
135
136
    VLLM_DP_MASTER_IP: str = ""
    VLLM_DP_MASTER_PORT: int = 0
137
    VLLM_MOE_DP_CHUNK_SIZE: int = 256
138
    VLLM_RANDOMIZE_DP_DUMMY_INPUTS: bool = False
139
    VLLM_RAY_DP_PACK_STRATEGY: str = "strict"
140
    VLLM_MARLIN_USE_ATOMIC_ADD: bool = False
141
    VLLM_MXFP4_USE_MARLIN: bool | None = None
142
    VLLM_V0_USE_OUTLINES_CACHE: bool = False
143
    VLLM_V1_USE_OUTLINES_CACHE: bool = False
144
    VLLM_TPU_BUCKET_PADDING_GAP: int = 0
145
    VLLM_TPU_MOST_MODEL_LEN: int | None = None
146
    VLLM_TPU_USING_PATHWAYS: bool = False
147
    VLLM_USE_DEEP_GEMM: bool = True
148
    VLLM_USE_DEEP_GEMM_E8M0: bool = True
149
150
151
152
153
    VLLM_DEEP_GEMM_WARMUP: Literal[
        "skip",
        "full",
        "relax",
    ] = "relax"
154
    VLLM_USE_FUSED_MOE_GROUPED_TOPK: bool = True
155
    VLLM_USE_FLASHINFER_MOE_FP16: bool = False
156
157
    VLLM_USE_FLASHINFER_MOE_FP8: bool = False
    VLLM_USE_FLASHINFER_MOE_FP4: bool = False
158
    VLLM_FLASHINFER_MOE_BACKEND: Literal["throughput", "latency"] = "throughput"
159
    VLLM_XGRAMMAR_CACHE_MB: int = 0
160
    VLLM_MSGPACK_ZERO_COPY_THRESHOLD: int = 256
161
    VLLM_ALLOW_INSECURE_SERIALIZATION: bool = False
Robert Shaw's avatar
Robert Shaw committed
162
    VLLM_NIXL_SIDE_CHANNEL_HOST: str = "localhost"
163
    VLLM_NIXL_SIDE_CHANNEL_PORT: int = 5600
164
165
166
167
168
169
170
171
    VLLM_ALL2ALL_BACKEND: Literal[
        "naive",
        "pplx",
        "deepep_high_throughput",
        "deepep_low_latency",
        "allgather_reducescatter",
        "flashinfer_all2allv",
    ] = "allgather_reducescatter"
172
    VLLM_MAX_TOKENS_PER_EXPERT_FP4_MOE: int = 163840
173
    VLLM_TOOL_PARSE_REGEX_TIMEOUT_SECONDS: int = 1
174
    VLLM_SLEEP_WHEN_IDLE: bool = False
175
    VLLM_MQ_MAX_CHUNK_BYTES_MB: int = 16
176
    VLLM_EXECUTE_MODEL_TIMEOUT_SECONDS: int = 300
177
    VLLM_KV_CACHE_LAYOUT: Literal["NHD", "HND"] | None = None
178
    VLLM_COMPUTE_NANS_IN_LOGITS: bool = False
179
    VLLM_USE_NVFP4_CT_EMULATIONS: bool = False
180
181
182
    VLLM_ROCM_QUICK_REDUCE_QUANTIZATION: Literal[
        "FP", "INT8", "INT6", "INT4", "NONE"
    ] = "NONE"
183
    VLLM_ROCM_QUICK_REDUCE_CAST_BF16_TO_FP16: bool = True
184
    VLLM_ROCM_QUICK_REDUCE_MAX_SIZE_BYTES_MB: int | None = None
185
    VLLM_NIXL_ABORT_REQUEST_TIMEOUT: int = 480
186
    VLLM_USE_CUDNN_PREFILL: bool = False
187
    VLLM_ENABLE_CUDAGRAPH_GC: bool = False
188
    VLLM_LOOPBACK_IP: str = ""
189
    VLLM_ALLOW_CHUNKED_LOCAL_ATTN_WITH_HYBRID_KV_CACHE: bool = False
190
    VLLM_ENABLE_RESPONSES_API_STORE: bool = False
191
    VLLM_USE_TRTLLM_ATTENTION: str | None = None
192
    VLLM_FLASHINFER_DISABLE_Q_QUANTIZATION: bool = False
193
    VLLM_HAS_FLASHINFER_CUBIN: bool = False
194
195
    VLLM_USE_FLASHINFER_MOE_MXFP4_MXFP8: bool = False
    VLLM_USE_FLASHINFER_MOE_MXFP4_BF16: bool = False
xiao-llm's avatar
xiao-llm committed
196
    VLLM_ROCM_FP8_MFMA_PAGE_ATTN: bool = False
197
    VLLM_USE_FLASHINFER_MOE_MXFP4_MXFP8_CUTLASS: bool = False
198
    VLLM_ALLREDUCE_USE_SYMM_MEM: bool = True
199
    VLLM_TUNED_CONFIG_FOLDER: str | None = None
200
    VLLM_DISABLE_PAD_FOR_CUDAGRAPH: bool = False
201
    VLLM_GPT_OSS_HARMONY_SYSTEM_INSTRUCTIONS: bool = False
202
    VLLM_CUSTOM_SCOPES_FOR_PROFILING: bool = False
203
    VLLM_NVTX_SCOPES_FOR_PROFILING: bool = False
204
    VLLM_KV_EVENTS_USE_INT_BLOCK_HASHES: bool = True
205
    VLLM_OBJECT_STORAGE_SHM_BUFFER_NAME: str = "VLLM_OBJECT_STORAGE_SHM_BUFFER"
206
207
    VLLM_DEEPEP_BUFFER_SIZE_MB: int = 1024
    VLLM_DBO_COMM_SMS: int = 20
208
    GPT_OSS_SYSTEM_TOOL_MCP_LABELS: list[str] = []
209
210
    VLLM_PATTERN_MATCH_DEBUG: str | None = None
    VLLM_DEBUG_DUMP_PATH: str | None = None
211
212
    VLLM_ENABLE_INDUCTOR_MAX_AUTOTUNE: bool = True
    VLLM_ENABLE_INDUCTOR_COORDINATE_DESCENT_TUNING: bool = True
213
    VLLM_USE_NCCL_SYMM_MEM: bool = False
214
    VLLM_NCCL_INCLUDE_PATH: str | None = None
215
    VLLM_USE_FBGEMM: bool = False
216
    VLLM_GC_DEBUG: str = ""
217

218
219
220
221
222
223
224
225
226
227
228
229
230
231
232

def get_default_cache_root():
    return os.getenv(
        "XDG_CACHE_HOME",
        os.path.join(os.path.expanduser("~"), ".cache"),
    )


def get_default_config_root():
    return os.getenv(
        "XDG_CONFIG_HOME",
        os.path.join(os.path.expanduser("~"), ".config"),
    )


233
def maybe_convert_int(value: str | None) -> int | None:
234
235
236
237
238
    if value is None:
        return None
    return int(value)


239
def maybe_convert_bool(value: str | None) -> bool | None:
240
241
242
243
244
    if value is None:
        return None
    return bool(int(value))


245
246
247
248
249
250
251
def use_aot_compile() -> bool:
    from vllm.utils import is_torch_equal_or_newer

    default_value = "1" if is_torch_equal_or_newer("2.10.0.dev") else "0"
    return os.environ.get("VLLM_USE_AOT_COMPILE", default_value) == "1"


252
def env_with_choices(
253
    env_name: str,
254
255
    default: str | None,
    choices: list[str] | Callable[[], list[str]],
256
    case_sensitive: bool = True,
257
) -> Callable[[], str | None]:
258
259
    """
    Create a lambda that validates environment variable against allowed choices
260

261
262
263
264
265
    Args:
        env_name: Name of the environment variable
        default: Default value if not set (can be None)
        choices: List of valid string options or callable that returns list
        case_sensitive: Whether validation should be case sensitive
266

267
268
269
270
    Returns:
        Lambda function for environment_variables dict
    """

271
    def _get_validated_env() -> str | None:
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
        value = os.getenv(env_name)
        if value is None:
            return default

        # Resolve choices if it's a callable (for lazy loading)
        actual_choices = choices() if callable(choices) else choices

        if not case_sensitive:
            check_value = value.lower()
            check_choices = [choice.lower() for choice in actual_choices]
        else:
            check_value = value
            check_choices = actual_choices

        if check_value not in check_choices:
287
288
289
290
            raise ValueError(
                f"Invalid value '{value}' for {env_name}. "
                f"Valid options: {actual_choices}."
            )
291
292
293
294
295
296

        return value

    return _get_validated_env


297
def env_list_with_choices(
298
299
    env_name: str,
    default: list[str],
300
    choices: list[str] | Callable[[], list[str]],
301
302
    case_sensitive: bool = True,
) -> Callable[[], list[str]]:
303
    """
304
    Create a lambda that validates environment variable
305
    containing comma-separated values against allowed choices
306

307
308
309
310
311
    Args:
        env_name: Name of the environment variable
        default: Default list of values if not set
        choices: List of valid string options or callable that returns list
        case_sensitive: Whether validation should be case sensitive
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
339
340
341
    Returns:
        Lambda function for environment_variables
        dict that returns list of strings
    """

    def _get_validated_env_list() -> list[str]:
        value = os.getenv(env_name)
        if value is None:
            return default

        # Split comma-separated values and strip whitespace
        values = [v.strip() for v in value.split(",") if v.strip()]

        if not values:
            return default

        # Resolve choices if it's a callable (for lazy loading)
        actual_choices = choices() if callable(choices) else choices

        # Validate each value
        for val in values:
            if not case_sensitive:
                check_value = val.lower()
                check_choices = [choice.lower() for choice in actual_choices]
            else:
                check_value = val
                check_choices = actual_choices

            if check_value not in check_choices:
342
343
344
345
                raise ValueError(
                    f"Invalid value '{val}' in {env_name}. "
                    f"Valid options: {actual_choices}."
                )
346
347
348
349
350
351

        return values

    return _get_validated_env_list


352
def get_vllm_port() -> int | None:
353
    """Get the port from VLLM_PORT environment variable.
354

355
356
    Returns:
        The port number as an integer if VLLM_PORT is set, None otherwise.
357

358
359
360
    Raises:
        ValueError: If VLLM_PORT is a URI, suggest k8s service discovery issue.
    """
361
    if "VLLM_PORT" not in os.environ:
362
363
        return None

364
    port = os.getenv("VLLM_PORT", "0")
365
366
367
368
369

    try:
        return int(port)
    except ValueError as err:
        from urllib.parse import urlparse
370

371
372
373
374
375
376
377
        parsed = urlparse(port)
        if parsed.scheme:
            raise ValueError(
                f"VLLM_PORT '{port}' appears to be a URI. "
                "This may be caused by a Kubernetes service discovery issue,"
                "check the warning in: https://docs.vllm.ai/en/stable/serving/env_vars.html"
            ) from None
378
        raise ValueError(f"VLLM_PORT '{port}' must be a valid integer") from err
379
380


381
382
383
# The begin-* and end* here are used by the documentation generator
# to extract the used env vars.

384
# --8<-- [start:env-vars-definition]
385

386
environment_variables: dict[str, Callable[[], Any]] = {
387
    # ================== Installation Time Env Vars ==================
388
    # Target device of vLLM, supporting [cuda (by default),
389
    # rocm, cpu]
390
    "VLLM_TARGET_DEVICE": lambda: os.getenv("VLLM_TARGET_DEVICE", "cuda").lower(),
391
392
    # Main CUDA version of vLLM, supporting [12.6, 12.8, 12.9],
    # 12.8 is the default. This follows PyTorch but can be overridden.
393
394
    "VLLM_MAIN_CUDA_VERSION": lambda: os.getenv("VLLM_MAIN_CUDA_VERSION", "").lower()
    or "12.8",
395
396
    # Maximum number of compilation jobs to run in parallel.
    # By default this is the number of CPUs
397
    "MAX_JOBS": lambda: os.getenv("MAX_JOBS", None),
398
399
400
    # Number of threads to use for nvcc
    # By default this is 1.
    # If set, `MAX_JOBS` will be reduced to avoid oversubscribing the CPU.
401
    "NVCC_THREADS": lambda: os.getenv("NVCC_THREADS", None),
402
    # If set, vllm will use precompiled binaries (*.so)
403
404
405
406
407
    "VLLM_USE_PRECOMPILED": lambda: os.environ.get("VLLM_USE_PRECOMPILED", "")
    .strip()
    .lower()
    in ("1", "true")
    or bool(os.environ.get("VLLM_PRECOMPILED_WHEEL_LOCATION")),
408
409
    # Used to mark that setup.py is running in a Docker build context,
    # in order to force the use of precompiled binaries.
410
411
412
413
    "VLLM_DOCKER_BUILD_CONTEXT": lambda: os.environ.get("VLLM_DOCKER_BUILD_CONTEXT", "")
    .strip()
    .lower()
    in ("1", "true"),
414
415
    # Whether to force using nightly wheel in python build.
    # This is used for testing the nightly wheel in python build.
416
417
418
    "VLLM_TEST_USE_PRECOMPILED_NIGHTLY_WHEEL": lambda: bool(
        int(os.getenv("VLLM_TEST_USE_PRECOMPILED_NIGHTLY_WHEEL", "0"))
    ),
419
420
421
    # CMake build type
    # If not set, defaults to "Debug" or "RelWithDebInfo"
    # Available options: "Debug", "Release", "RelWithDebInfo"
422
423
424
    "CMAKE_BUILD_TYPE": env_with_choices(
        "CMAKE_BUILD_TYPE", None, ["Debug", "Release", "RelWithDebInfo"]
    ),
425
    # If set, vllm will print verbose logs during installation
426
    "VERBOSE": lambda: bool(int(os.getenv("VERBOSE", "0"))),
427
    # Root directory for vLLM configuration files
428
    # Defaults to `~/.config/vllm` unless `XDG_CONFIG_HOME` is set
429
430
431
    # Note that this not only affects how vllm finds its configuration files
    # during runtime, but also affects how vllm installs its configuration
    # files during **installation**.
432
    "VLLM_CONFIG_ROOT": lambda: os.path.expanduser(
433
434
435
        os.getenv(
            "VLLM_CONFIG_ROOT",
            os.path.join(get_default_config_root(), "vllm"),
436
437
        )
    ),
438
    # ================== Runtime Env Vars ==================
439
    # Root directory for vLLM cache files
440
    # Defaults to `~/.cache/vllm` unless `XDG_CACHE_HOME` is set
441
    "VLLM_CACHE_ROOT": lambda: os.path.expanduser(
442
443
444
        os.getenv(
            "VLLM_CACHE_ROOT",
            os.path.join(get_default_cache_root(), "vllm"),
445
446
        )
    ),
447
448
449
450
    # used in distributed environment to determine the ip address
    # of the current node, when the node has multiple network interfaces.
    # If you are using multi-node inference, you should set this differently
    # on each node.
451
    "VLLM_HOST_IP": lambda: os.getenv("VLLM_HOST_IP", ""),
452
    # used in distributed environment to manually set the communication port
453
454
455
    # Note: if VLLM_PORT is set, and some code asks for multiple ports, the
    # VLLM_PORT will be used as the first port, and the rest will be generated
    # by incrementing the VLLM_PORT value.
456
    "VLLM_PORT": get_vllm_port,
457
458
    # path used for ipc when the frontend api server is running in
    # multi-processing mode to communicate with the backend engine process.
459
460
461
    "VLLM_RPC_BASE_PATH": lambda: os.getenv(
        "VLLM_RPC_BASE_PATH", tempfile.gettempdir()
    ),
462
463
    # If true, will load models from ModelScope instead of Hugging Face Hub.
    # note that the value is true or false, not numbers
464
465
466
467
    "VLLM_USE_MODELSCOPE": lambda: os.environ.get(
        "VLLM_USE_MODELSCOPE", "False"
    ).lower()
    == "true",
468
    # Interval in seconds to log a warning message when the ring buffer is full
469
470
471
    "VLLM_RINGBUFFER_WARNING_INTERVAL": lambda: int(
        os.environ.get("VLLM_RINGBUFFER_WARNING_INTERVAL", "60")
    ),
472
473
    # path to cudatoolkit home directory, under which should be bin, include,
    # and lib directories.
474
    "CUDA_HOME": lambda: os.environ.get("CUDA_HOME", None),
475
476
    # Path to the NCCL library file. It is needed because nccl>=2.19 brought
    # by PyTorch contains a bug: https://github.com/NVIDIA/nccl/issues/1234
477
    "VLLM_NCCL_SO_PATH": lambda: os.environ.get("VLLM_NCCL_SO_PATH", None),
478
479
    # when `VLLM_NCCL_SO_PATH` is not set, vllm will try to find the nccl
    # library file in the locations specified by `LD_LIBRARY_PATH`
480
    "LD_LIBRARY_PATH": lambda: os.environ.get("LD_LIBRARY_PATH", None),
481
    # flag to control if vllm should use triton flash attention
482
483
484
    "VLLM_USE_TRITON_FLASH_ATTN": lambda: (
        os.environ.get("VLLM_USE_TRITON_FLASH_ATTN", "True").lower() in ("true", "1")
    ),
485
486
    # Use separate prefill and decode kernels for V1 attention instead of
    # the unified triton kernel.
487
488
489
490
    "VLLM_V1_USE_PREFILL_DECODE_ATTENTION": lambda: (
        os.getenv("VLLM_V1_USE_PREFILL_DECODE_ATTENTION", "False").lower()
        in ("true", "1")
    ),
491
492
    # Force vllm to use a specific flash-attention version (2 or 3), only valid
    # when using the flash-attention backend.
493
494
495
    "VLLM_FLASH_ATTN_VERSION": lambda: maybe_convert_int(
        os.environ.get("VLLM_FLASH_ATTN_VERSION", None)
    ),
496
497
    # Feature flag to enable/disable Inductor standalone compile.
    # In torch <= 2.7 we ignore this flag; in torch >= 2.8 this is
498
    # disabled by default.
499
500
501
502
    "VLLM_USE_STANDALONE_COMPILE": lambda: os.environ.get(
        "VLLM_USE_STANDALONE_COMPILE", "0"
    )
    == "1",
503
504
    # Debug pattern matching inside custom passes.
    # Should be set to the fx.Node name (e.g. 'getitem_34' or 'scaled_mm_3').
505
506
507
    "VLLM_PATTERN_MATCH_DEBUG": lambda: os.environ.get(
        "VLLM_PATTERN_MATCH_DEBUG", None
    ),
508
509
    # Dump fx graphs to the given directory.
    # It will override CompilationConfig.debug_dump_path if set.
510
    "VLLM_DEBUG_DUMP_PATH": lambda: os.environ.get("VLLM_DEBUG_DUMP_PATH", None),
511
512
513
514
515
516
517
518
    # Feature flag to enable/disable AOT compilation. This will ensure
    # compilation is done in warmup phase and the compilation will be
    # reused in subsequent calls.
    "VLLM_USE_AOT_COMPILE": use_aot_compile,
    # Force vllm to always load AOT compiled models from disk. Failure
    # to load will result in a hard error when this is enabled.
    # Will be ignored when VLLM_USE_AOT_COMPILE is disabled.
    "VLLM_FORCE_AOT_LOAD": lambda: os.environ.get("VLLM_FORCE_AOT_LOAD", "0") == "1",
519
520
    # local rank of the process in the distributed setting, used to determine
    # the GPU device id
521
    "LOCAL_RANK": lambda: int(os.environ.get("LOCAL_RANK", "0")),
522
    # used to control the visible devices in the distributed setting
523
    "CUDA_VISIBLE_DEVICES": lambda: os.environ.get("CUDA_VISIBLE_DEVICES", None),
524
    # timeout for each iteration in the engine
525
526
527
    "VLLM_ENGINE_ITERATION_TIMEOUT_S": lambda: int(
        os.environ.get("VLLM_ENGINE_ITERATION_TIMEOUT_S", "60")
    ),
528
    # API key for vLLM API server
529
    "VLLM_API_KEY": lambda: os.environ.get("VLLM_API_KEY", None),
530
    # Whether to log responses from API Server for debugging
531
532
533
534
    "VLLM_DEBUG_LOG_API_SERVER_RESPONSE": lambda: os.environ.get(
        "VLLM_DEBUG_LOG_API_SERVER_RESPONSE", "False"
    ).lower()
    == "true",
535
    # S3 access information, used for tensorizer to load model from S3
536
537
538
    "S3_ACCESS_KEY_ID": lambda: os.environ.get("S3_ACCESS_KEY_ID", None),
    "S3_SECRET_ACCESS_KEY": lambda: os.environ.get("S3_SECRET_ACCESS_KEY", None),
    "S3_ENDPOINT_URL": lambda: os.environ.get("S3_ENDPOINT_URL", None),
539
    # Usage stats collection
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
    "VLLM_USAGE_STATS_SERVER": lambda: os.environ.get(
        "VLLM_USAGE_STATS_SERVER", "https://stats.vllm.ai"
    ),
    "VLLM_NO_USAGE_STATS": lambda: os.environ.get("VLLM_NO_USAGE_STATS", "0") == "1",
    "VLLM_DISABLE_FLASHINFER_PREFILL": lambda: os.environ.get(
        "VLLM_DISABLE_FLASHINFER_PREFILL", "0"
    )
    == "1",
    "VLLM_DO_NOT_TRACK": lambda: (
        os.environ.get("VLLM_DO_NOT_TRACK", None)
        or os.environ.get("DO_NOT_TRACK", None)
        or "0"
    )
    == "1",
    "VLLM_USAGE_SOURCE": lambda: os.environ.get("VLLM_USAGE_SOURCE", "production"),
555
556
557
558
    # Logging configuration
    # If set to 0, vllm will not configure logging
    # If set to 1, vllm will configure logging using the default configuration
    #    or the configuration file specified by VLLM_LOGGING_CONFIG_PATH
559
560
    "VLLM_CONFIGURE_LOGGING": lambda: int(os.getenv("VLLM_CONFIGURE_LOGGING", "1")),
    "VLLM_LOGGING_CONFIG_PATH": lambda: os.getenv("VLLM_LOGGING_CONFIG_PATH"),
561
    # this is used for configuring the default logging level
562
    "VLLM_LOGGING_LEVEL": lambda: os.getenv("VLLM_LOGGING_LEVEL", "INFO").upper(),
563
    # this is used for configuring the default logging stream
564
    "VLLM_LOGGING_STREAM": lambda: os.getenv("VLLM_LOGGING_STREAM", "ext://sys.stdout"),
565
    # if set, VLLM_LOGGING_PREFIX will be prepended to all log messages
566
    "VLLM_LOGGING_PREFIX": lambda: os.getenv("VLLM_LOGGING_PREFIX", ""),
567
568
569
570
    # if set, vllm will call logits processors in a thread pool with this many
    # threads. This is useful when using custom logits processors that either
    # (a) launch additional CUDA kernels or (b) do significant CPU-bound work
    # while not holding the python GIL, or both.
571
572
573
574
575
    "VLLM_LOGITS_PROCESSOR_THREADS": lambda: int(
        os.getenv("VLLM_LOGITS_PROCESSOR_THREADS", "0")
    )
    if "VLLM_LOGITS_PROCESSOR_THREADS" in os.environ
    else None,
576
577
    # If set, vllm will log stats at this interval in seconds
    # If not set, vllm will log stats every 10 seconds.
578
579
580
    "VLLM_LOG_STATS_INTERVAL": lambda: val
    if (val := float(os.getenv("VLLM_LOG_STATS_INTERVAL", "10."))) > 0.0
    else 10.0,
581
582
583
    # Trace function calls
    # If set to 1, vllm will trace function calls
    # Useful for debugging
584
    "VLLM_TRACE_FUNCTION": lambda: int(os.getenv("VLLM_TRACE_FUNCTION", "0")),
585
    # Backend for attention computation
586
    # Example options:
587
588
589
    # - "TORCH_SDPA": use torch.nn.MultiheadAttention
    # - "FLASH_ATTN": use FlashAttention
    # - "XFORMERS": use XFormers
590
    # - "FLASHINFER": use flashinfer
591
    # - "FLASHMLA": use FlashMLA
592
    # - "FLASH_ATTN_MLA": use FlashAttention for MLA
593
594
    # - "FLASHINFER_MLA": use FlashInfer for MLA
    # - "CUTLASS_MLA": use CUTLASS for MLA
595
    # All possible options loaded dynamically from _Backend enum
596
597
598
599
600
601
602
603
604
    "VLLM_ATTENTION_BACKEND": env_with_choices(
        "VLLM_ATTENTION_BACKEND",
        None,
        lambda: list(
            __import__(
                "vllm.attention.backends.registry", fromlist=["_Backend"]
            )._Backend.__members__.keys()
        ),
    ),
605
    # If set, vllm will use flashinfer sampler
606
607
608
609
610
    "VLLM_USE_FLASHINFER_SAMPLER": lambda: bool(
        int(os.environ["VLLM_USE_FLASHINFER_SAMPLER"])
    )
    if "VLLM_USE_FLASHINFER_SAMPLER" in os.environ
    else None,
611
    # Pipeline stage partition strategy
612
    "VLLM_PP_LAYER_PARTITION": lambda: os.getenv("VLLM_PP_LAYER_PARTITION", None),
613
    # (CPU backend only) CPU key-value cache space.
614
    # default is None and will be set as 4 GB
615
616
617
    "VLLM_CPU_KVCACHE_SPACE": lambda: int(os.getenv("VLLM_CPU_KVCACHE_SPACE", "0"))
    if "VLLM_CPU_KVCACHE_SPACE" in os.environ
    else None,
618
619
    # (CPU backend only) CPU core ids bound by OpenMP threads, e.g., "0-31",
    # "0,1,2", "0-31,33". CPU cores of different ranks are separated by '|'.
620
    "VLLM_CPU_OMP_THREADS_BIND": lambda: os.getenv("VLLM_CPU_OMP_THREADS_BIND", "auto"),
621
622
    # (CPU backend only) CPU cores not used by OMP threads .
    # Those CPU cores will not be used by OMP threads of a rank.
623
624
625
626
627
    "VLLM_CPU_NUM_OF_RESERVED_CPU": lambda: int(
        os.getenv("VLLM_CPU_NUM_OF_RESERVED_CPU", "0")
    )
    if "VLLM_CPU_NUM_OF_RESERVED_CPU" in os.environ
    else None,
628
629
630
    # (CPU backend only) whether to use prepack for MoE layer. This will be
    # passed to ipex.llm.modules.GatedMLPMOE. On unsupported CPUs, you might
    # need to set this to "0" (False).
631
    "VLLM_CPU_MOE_PREPACK": lambda: bool(int(os.getenv("VLLM_CPU_MOE_PREPACK", "1"))),
632
    # (CPU backend only) whether to use SGL kernels, optimized for small batch.
633
    "VLLM_CPU_SGL_KERNEL": lambda: bool(int(os.getenv("VLLM_CPU_SGL_KERNEL", "0"))),
634
635
636
637
    # If the env var is set, then all workers will execute as separate
    # processes from the engine, and we use the same mechanism to trigger
    # execution on all workers.
    # Run vLLM with VLLM_USE_RAY_SPMD_WORKER=1 to enable it.
638
639
640
    "VLLM_USE_RAY_SPMD_WORKER": lambda: bool(
        int(os.getenv("VLLM_USE_RAY_SPMD_WORKER", "0"))
    ),
641
642
643
    # If the env var is set, it uses the Ray's Compiled Graph
    # (previously known as ADAG) API which optimizes the
    # control plane overhead.
644
    # Run vLLM with VLLM_USE_RAY_COMPILED_DAG=1 to enable it.
645
646
    # Note that this variable is set to 1 in V1 by default
    # when ray distributed executor is used.
647
648
649
    "VLLM_USE_RAY_COMPILED_DAG": lambda: bool(
        int(os.getenv("VLLM_USE_RAY_COMPILED_DAG", "0"))
    ),
650
651
652
653
654
655
656
657
    # If the env var is set, Ray Compiled Graph uses the specified
    # channel type to communicate between workers belonging to
    # different pipeline-parallel stages.
    # Available options:
    # - "auto": use the default channel type
    # - "nccl": use NCCL for communication
    # - "shm": use shared memory and gRPC for communication
    # This flag is ignored if VLLM_USE_RAY_COMPILED_DAG is not set.
658
659
660
    "VLLM_USE_RAY_COMPILED_DAG_CHANNEL_TYPE": env_with_choices(
        "VLLM_USE_RAY_COMPILED_DAG_CHANNEL_TYPE", "auto", ["auto", "nccl", "shm"]
    ),
661
    # If the env var is set, it enables GPU communication overlap
662
    # (experimental feature) in Ray's Compiled Graph. This flag is ignored if
663
    # VLLM_USE_RAY_COMPILED_DAG is not set.
664
665
666
    "VLLM_USE_RAY_COMPILED_DAG_OVERLAP_COMM": lambda: bool(
        int(os.getenv("VLLM_USE_RAY_COMPILED_DAG_OVERLAP_COMM", "0"))
    ),
667
668
669
670
    # If the env var is set, it uses a Ray Communicator wrapping
    # vLLM's pipeline parallelism communicator to interact with Ray's
    # Compiled Graph. Otherwise, it uses Ray's NCCL communicator.
    # This flag is ignored if VLLM_USE_RAY_COMPILED_DAG is not set.
671
672
673
    "VLLM_USE_RAY_WRAPPED_PP_COMM": lambda: bool(
        int(os.getenv("VLLM_USE_RAY_WRAPPED_PP_COMM", "1"))
    ),
674
675
    # Use dedicated multiprocess context for workers.
    # Both spawn and fork work
676
677
678
    "VLLM_WORKER_MULTIPROC_METHOD": env_with_choices(
        "VLLM_WORKER_MULTIPROC_METHOD", "fork", ["spawn", "fork"]
    ),
679
    # Path to the cache for storing downloaded assets
680
    "VLLM_ASSETS_CACHE": lambda: os.path.expanduser(
681
682
683
        os.getenv(
            "VLLM_ASSETS_CACHE",
            os.path.join(get_default_cache_root(), "vllm", "assets"),
684
685
        )
    ),
686
687
    # If the env var is set, we will clean model file in
    # this path $VLLM_ASSETS_CACHE/model_streamer/$model_name
688
689
690
    "VLLM_ASSETS_CACHE_MODEL_CLEAN": lambda: bool(
        int(os.getenv("VLLM_ASSETS_CACHE_MODEL_CLEAN", "0"))
    ),
691
692
    # Timeout for fetching images when serving multimodal models
    # Default is 5 seconds
693
    "VLLM_IMAGE_FETCH_TIMEOUT": lambda: int(os.getenv("VLLM_IMAGE_FETCH_TIMEOUT", "5")),
694
    # Timeout for fetching videos when serving multimodal models
695
    # Default is 30 seconds
696
697
698
    "VLLM_VIDEO_FETCH_TIMEOUT": lambda: int(
        os.getenv("VLLM_VIDEO_FETCH_TIMEOUT", "30")
    ),
699
    # Timeout for fetching audio when serving multimodal models
700
    # Default is 10 seconds
701
702
703
    "VLLM_AUDIO_FETCH_TIMEOUT": lambda: int(
        os.getenv("VLLM_AUDIO_FETCH_TIMEOUT", "10")
    ),
704
705
    # Whether to allow HTTP redirects when fetching from media URLs.
    # Default to True
706
707
708
    "VLLM_MEDIA_URL_ALLOW_REDIRECTS": lambda: bool(
        int(os.getenv("VLLM_MEDIA_URL_ALLOW_REDIRECTS", "1"))
    ),
709
710
711
    # Max number of workers for the thread pool handling
    # media bytes loading. Set to 1 to disable parallel processing.
    # Default is 8
712
713
714
    "VLLM_MEDIA_LOADING_THREAD_COUNT": lambda: int(
        os.getenv("VLLM_MEDIA_LOADING_THREAD_COUNT", "8")
    ),
715
716
717
    # Maximum filesize in MB for a single audio file when processing
    # speech-to-text requests. Files larger than this will be rejected.
    # Default is 25 MB
718
719
720
    "VLLM_MAX_AUDIO_CLIP_FILESIZE_MB": lambda: int(
        os.getenv("VLLM_MAX_AUDIO_CLIP_FILESIZE_MB", "25")
    ),
721
722
723
724
725
726
727
    # Backend for Video IO
    # - "opencv": Default backend that uses OpenCV stream buffered backend.
    #
    # Custom backend implementations can be registered
    # via `@VIDEO_LOADER_REGISTRY.register("my_custom_video_loader")` and
    # imported at runtime.
    # If a non-existing backend is used, an AssertionError will be thrown.
728
729
730
    "VLLM_VIDEO_LOADER_BACKEND": lambda: os.getenv(
        "VLLM_VIDEO_LOADER_BACKEND", "opencv"
    ),
731
    # [DEPRECATED] Cache size (in GiB per process) for multimodal input cache
732
    # Default is 4 GiB per API process + 4 GiB per engine core process
733
    "VLLM_MM_INPUT_CACHE_GIB": lambda: int(os.getenv("VLLM_MM_INPUT_CACHE_GIB", "4")),
734
735
    # Path to the XLA persistent cache directory.
    # Only used for XLA devices such as TPUs.
736
    "VLLM_XLA_CACHE_PATH": lambda: os.path.expanduser(
737
        os.getenv(
738
            "VLLM_XLA_CACHE_PATH",
739
            os.path.join(get_default_cache_root(), "vllm", "xla_cache"),
740
741
        )
    ),
742
    # If set, assert on XLA recompilation after each execution step.
743
744
745
    "VLLM_XLA_CHECK_RECOMPILATION": lambda: bool(
        int(os.getenv("VLLM_XLA_CHECK_RECOMPILATION", "0"))
    ),
746
    # Enable SPMD mode for TPU backend.
747
748
749
750
    "VLLM_XLA_USE_SPMD": lambda: bool(int(os.getenv("VLLM_XLA_USE_SPMD", "0"))),
    "VLLM_FUSED_MOE_CHUNK_SIZE": lambda: int(
        os.getenv("VLLM_FUSED_MOE_CHUNK_SIZE", "32768")
    ),
751
752
753
    # Control whether to use fused MoE activation chunking. Current chunking
    # logic is incompatible with torch.compile and causes IMA. See issue
    # https://github.com/vllm-project/vllm/issues/19631.
754
755
756
    "VLLM_ENABLE_FUSED_MOE_ACTIVATION_CHUNKING": lambda: bool(
        int(os.getenv("VLLM_ENABLE_FUSED_MOE_ACTIVATION_CHUNKING", "1"))
    ),
757
758
    # If set, the OpenAI API server will stay alive even after the underlying
    # AsyncLLMEngine errors and stops serving requests
759
760
761
    "VLLM_KEEP_ALIVE_ON_ENGINE_DEATH": lambda: bool(
        os.getenv("VLLM_KEEP_ALIVE_ON_ENGINE_DEATH", 0)
    ),
762
763
764
765
    # If the env var VLLM_ALLOW_LONG_MAX_MODEL_LEN is set, it allows
    # the user to specify a max sequence length greater than
    # the max length derived from the model's config.json.
    # To enable this, set VLLM_ALLOW_LONG_MAX_MODEL_LEN=1.
766
767
768
769
    "VLLM_ALLOW_LONG_MAX_MODEL_LEN": lambda: (
        os.environ.get("VLLM_ALLOW_LONG_MAX_MODEL_LEN", "0").strip().lower()
        in ("1", "true")
    ),
770
771
    # If set, forces FP8 Marlin to be used for FP8 quantization regardless
    # of the hardware support for FP8 compute.
772
773
774
775
776
777
778
    "VLLM_TEST_FORCE_FP8_MARLIN": lambda: (
        os.environ.get("VLLM_TEST_FORCE_FP8_MARLIN", "0").strip().lower()
        in ("1", "true")
    ),
    "VLLM_TEST_FORCE_LOAD_FORMAT": lambda: os.getenv(
        "VLLM_TEST_FORCE_LOAD_FORMAT", "dummy"
    ),
779
780
    # Time in ms for the zmq client to wait for a response from the backend
    # server for simple data operations
781
    "VLLM_RPC_TIMEOUT": lambda: int(os.getenv("VLLM_RPC_TIMEOUT", "10000")),
782
    # Timeout in seconds for keeping HTTP connections alive in API server
783
784
785
    "VLLM_HTTP_TIMEOUT_KEEP_ALIVE": lambda: int(
        os.environ.get("VLLM_HTTP_TIMEOUT_KEEP_ALIVE", "5")
    ),
786
787
788
    # a list of plugin names to load, separated by commas.
    # if this is not set, it means all plugins will be loaded
    # if this is set to an empty string, no plugins will be loaded
789
790
791
    "VLLM_PLUGINS": lambda: None
    if "VLLM_PLUGINS" not in os.environ
    else os.environ["VLLM_PLUGINS"].split(","),
792
793
794
    # a local directory to look in for unrecognized LoRA adapters.
    # only works if plugins are enabled and
    # VLLM_ALLOW_RUNTIME_LORA_UPDATING is enabled.
795
796
797
    "VLLM_LORA_RESOLVER_CACHE_DIR": lambda: os.getenv(
        "VLLM_LORA_RESOLVER_CACHE_DIR", None
    ),
798
799
800
801
    # Enables torch profiler if set.
    # Both AsyncLLM's CPU traces as well as workers'
    # traces (CPU & GPU) will be saved under this directory.
    # Note that it must be an absolute path.
802
803
804
805
806
807
808
    "VLLM_TORCH_PROFILER_DIR": lambda: (
        None
        if os.getenv("VLLM_TORCH_PROFILER_DIR", None) is None
        else os.path.abspath(
            os.path.expanduser(os.getenv("VLLM_TORCH_PROFILER_DIR", "."))
        )
    ),
809
810
811
    # Enable torch profiler to record shapes if set
    # VLLM_TORCH_PROFILER_RECORD_SHAPES=1. If not set, torch profiler will
    # not record shapes.
812
813
814
    "VLLM_TORCH_PROFILER_RECORD_SHAPES": lambda: bool(
        os.getenv("VLLM_TORCH_PROFILER_RECORD_SHAPES", "0") != "0"
    ),
815
816
817
    # Enable torch profiler to profile memory if set
    # VLLM_TORCH_PROFILER_WITH_PROFILE_MEMORY=1. If not set, torch profiler
    # will not profile memory.
818
819
820
    "VLLM_TORCH_PROFILER_WITH_PROFILE_MEMORY": lambda: bool(
        os.getenv("VLLM_TORCH_PROFILER_WITH_PROFILE_MEMORY", "0") != "0"
    ),
821
822
823
    # Enable torch profiler to profile stack if set
    # VLLM_TORCH_PROFILER_WITH_STACK=1. If not set, torch profiler WILL
    # profile stack by default.
824
825
826
    "VLLM_TORCH_PROFILER_WITH_STACK": lambda: bool(
        os.getenv("VLLM_TORCH_PROFILER_WITH_STACK", "1") != "0"
    ),
827
828
829
    # Enable torch profiler to profile flops if set
    # VLLM_TORCH_PROFILER_WITH_FLOPS=1. If not set, torch profiler will
    # not profile flops.
830
831
832
    "VLLM_TORCH_PROFILER_WITH_FLOPS": lambda: bool(
        os.getenv("VLLM_TORCH_PROFILER_WITH_FLOPS", "0") != "0"
    ),
833
    # If set, vLLM will use Triton implementations of AWQ.
834
    "VLLM_USE_TRITON_AWQ": lambda: bool(int(os.getenv("VLLM_USE_TRITON_AWQ", "0"))),
835
    # If set, allow loading or unloading lora adapters in runtime,
836
837
838
839
    "VLLM_ALLOW_RUNTIME_LORA_UPDATING": lambda: (
        os.environ.get("VLLM_ALLOW_RUNTIME_LORA_UPDATING", "0").strip().lower()
        in ("1", "true")
    ),
840
841
842
843
844
845
    # We assume drivers can report p2p status correctly.
    # If the program hangs when using custom allreduce,
    # potantially caused by a bug in the driver (535 series),
    # if might be helpful to set VLLM_SKIP_P2P_CHECK=0
    # so that vLLM can verify if p2p is actually working.
    # See https://github.com/vllm-project/vllm/blob/a9b15c606fea67a072416ea0ea115261a2756058/vllm/distributed/device_communicators/custom_all_reduce_utils.py#L101-L108 for details. # noqa
846
    "VLLM_SKIP_P2P_CHECK": lambda: os.getenv("VLLM_SKIP_P2P_CHECK", "1") == "1",
847
848
849
850
    # List of quantization kernels that should be disabled, used for testing
    # and performance comparisons. Currently only affects MPLinearKernel
    # selection
    # (kernels: MacheteLinearKernel, MarlinLinearKernel, ExllamaLinearKernel)
851
852
853
    "VLLM_DISABLED_KERNELS": lambda: []
    if "VLLM_DISABLED_KERNELS" not in os.environ
    else os.environ["VLLM_DISABLED_KERNELS"].split(","),
854
    # Disable pynccl (using torch.distributed instead)
855
856
857
    "VLLM_DISABLE_PYNCCL": lambda: (
        os.getenv("VLLM_DISABLE_PYNCCL", "False").lower() in ("true", "1")
    ),
858
    # If set, use the V1 code path.
859
    "VLLM_USE_V1": lambda: bool(int(os.getenv("VLLM_USE_V1", "1"))),
860
861
    # Disable aiter ops unless specifically enabled.
    # Acts as a parent switch to enable the rest of the other operations.
862
863
864
    "VLLM_ROCM_USE_AITER": lambda: (
        os.getenv("VLLM_ROCM_USE_AITER", "False").lower() in ("true", "1")
    ),
865
866
    # Whether to use aiter paged attention.
    # By default is disabled.
867
868
869
    "VLLM_ROCM_USE_AITER_PAGED_ATTN": lambda: (
        os.getenv("VLLM_ROCM_USE_AITER_PAGED_ATTN", "False").lower() in ("true", "1")
    ),
870
871
872
    # use aiter linear op if aiter ops are enabled
    # The following list of related ops
    # - scaled_mm (per-tensor / rowwise)
873
874
875
    "VLLM_ROCM_USE_AITER_LINEAR": lambda: (
        os.getenv("VLLM_ROCM_USE_AITER_LINEAR", "True").lower() in ("true", "1")
    ),
876
877
    # Whether to use aiter moe ops.
    # By default is enabled.
878
879
880
    "VLLM_ROCM_USE_AITER_MOE": lambda: (
        os.getenv("VLLM_ROCM_USE_AITER_MOE", "True").lower() in ("true", "1")
    ),
881
    # use aiter rms norm op if aiter ops are enabled.
882
883
884
    "VLLM_ROCM_USE_AITER_RMSNORM": lambda: (
        os.getenv("VLLM_ROCM_USE_AITER_RMSNORM", "True").lower() in ("true", "1")
    ),
885
886
    # Whether to use aiter mla ops.
    # By default is enabled.
887
888
889
    "VLLM_ROCM_USE_AITER_MLA": lambda: (
        os.getenv("VLLM_ROCM_USE_AITER_MLA", "True").lower() in ("true", "1")
    ),
890
891
    # Whether to use aiter mha ops.
    # By default is enabled.
892
893
894
    "VLLM_ROCM_USE_AITER_MHA": lambda: (
        os.getenv("VLLM_ROCM_USE_AITER_MHA", "True").lower() in ("true", "1")
    ),
895
896
    # Whether to use aiter fp4 gemm asm.
    # By default is disabled.
897
898
899
    "VLLM_ROCM_USE_AITER_FP4_ASM_GEMM": lambda: (
        os.getenv("VLLM_ROCM_USE_AITER_FP4_ASM_GEMM", "False").lower() in ("true", "1")
    ),
900
901
    # Whether to use aiter rope.
    # By default is disabled.
902
903
904
    "VLLM_ROCM_USE_TRITON_ROPE": lambda: (
        os.getenv("VLLM_ROCM_USE_TRITON_ROPE", "False").lower() in ("true", "1")
    ),
905
906
    # Whether to use aiter triton fp8 bmm kernel
    # By default is enabled.
907
908
909
    "VLLM_ROCM_USE_AITER_FP8BMM": lambda: (
        os.getenv("VLLM_ROCM_USE_AITER_FP8BMM", "True").lower() in ("true", "1")
    ),
910
911
912
913
914
    # Use AITER triton unified attention for V1 attention
    "VLLM_ROCM_USE_AITER_UNIFIED_ATTENTION": lambda: (
        os.getenv("VLLM_ROCM_USE_AITER_UNIFIED_ATTENTION", "False").lower()
        in ("true", "1")
    ),
915
    # use rocm skinny gemms
916
917
918
    "VLLM_ROCM_USE_SKINNY_GEMM": lambda: (
        os.getenv("VLLM_ROCM_USE_SKINNY_GEMM", "True").lower() in ("true", "1")
    ),
919
    # Pad the fp8 weights to 256 bytes for ROCm
920
    "VLLM_ROCM_FP8_PADDING": lambda: bool(int(os.getenv("VLLM_ROCM_FP8_PADDING", "1"))),
921
    # Pad the weights for the moe kernel
922
    "VLLM_ROCM_MOE_PADDING": lambda: bool(int(os.getenv("VLLM_ROCM_MOE_PADDING", "1"))),
923
    # custom paged attention kernel for MI3* cards
924
925
926
    "VLLM_ROCM_CUSTOM_PAGED_ATTN": lambda: (
        os.getenv("VLLM_ROCM_CUSTOM_PAGED_ATTN", "True").lower() in ("true", "1")
    ),
927
928
929
    # Custom quick allreduce kernel for MI3* cards
    # Choice of quantization level: FP, INT8, INT6, INT4 or NONE
    # Recommended for large models to get allreduce
930
931
932
933
934
    "VLLM_ROCM_QUICK_REDUCE_QUANTIZATION": env_with_choices(
        "VLLM_ROCM_QUICK_REDUCE_QUANTIZATION",
        "NONE",
        ["FP", "INT8", "INT6", "INT4", "NONE"],
    ),
935
936
937
938
    # Custom quick allreduce kernel for MI3* cards
    # Due to the lack of the bfloat16 asm instruction, bfloat16
    # kernels are slower than fp16,
    # If environment variable is set to 1, the input is converted to fp16
939
940
941
942
    "VLLM_ROCM_QUICK_REDUCE_CAST_BF16_TO_FP16": lambda: (
        os.getenv("VLLM_ROCM_QUICK_REDUCE_CAST_BF16_TO_FP16", "True").lower()
        in ("true", "1")
    ),
943
944
945
946
947
948
    # Custom quick allreduce kernel for MI3* cards.
    # Controls the maximum allowed number of data bytes(MB) for custom quick
    # allreduce communication.
    # Default: 2048 MB.
    # Data exceeding this size will use either custom allreduce or RCCL
    # communication.
949
950
951
    "VLLM_ROCM_QUICK_REDUCE_MAX_SIZE_BYTES_MB": lambda: maybe_convert_int(
        os.environ.get("VLLM_ROCM_QUICK_REDUCE_MAX_SIZE_BYTES_MB", None)
    ),
952
    # Divisor for dynamic query scale factor calculation for FP8 KV Cache
953
    "Q_SCALE_CONSTANT": lambda: int(os.getenv("Q_SCALE_CONSTANT", "200")),
954
    # Divisor for dynamic key scale factor calculation for FP8 KV Cache
955
    "K_SCALE_CONSTANT": lambda: int(os.getenv("K_SCALE_CONSTANT", "200")),
956
    # Divisor for dynamic value scale factor calculation for FP8 KV Cache
957
    "V_SCALE_CONSTANT": lambda: int(os.getenv("V_SCALE_CONSTANT", "100")),
958
    # If set, enable multiprocessing in LLM for the V1 code path.
959
960
961
962
963
964
965
966
967
    "VLLM_ENABLE_V1_MULTIPROCESSING": lambda: bool(
        int(os.getenv("VLLM_ENABLE_V1_MULTIPROCESSING", "1"))
    ),
    "VLLM_LOG_BATCHSIZE_INTERVAL": lambda: float(
        os.getenv("VLLM_LOG_BATCHSIZE_INTERVAL", "-1")
    ),
    "VLLM_DISABLE_COMPILE_CACHE": lambda: bool(
        int(os.getenv("VLLM_DISABLE_COMPILE_CACHE", "0"))
    ),
968
969
970
    # If set, vllm will run in development mode, which will enable
    # some additional endpoints for developing and debugging,
    # e.g. `/reset_prefix_cache`
971
    "VLLM_SERVER_DEV_MODE": lambda: bool(int(os.getenv("VLLM_SERVER_DEV_MODE", "0"))),
972
973
974
975
976
977
978
    # Controls the maximum number of requests to handle in a
    # single asyncio task when processing per-token outputs in the
    # V1 AsyncLLM interface. It is applicable when handling a high
    # concurrency of streaming requests.
    # Setting this too high can result in a higher variance of
    # inter-message latencies. Setting it too low can negatively impact
    # TTFT and overall throughput.
979
980
981
    "VLLM_V1_OUTPUT_PROC_CHUNK_SIZE": lambda: int(
        os.getenv("VLLM_V1_OUTPUT_PROC_CHUNK_SIZE", "128")
    ),
982
    # If set, vLLM will disable the MLA attention optimizations.
983
    "VLLM_MLA_DISABLE": lambda: bool(int(os.getenv("VLLM_MLA_DISABLE", "0"))),
984
985
    # If set, vLLM will pick up the provided Flash Attention MLA
    # max number splits for cuda graph decode
986
987
988
    "VLLM_FLASH_ATTN_MAX_NUM_SPLITS_FOR_CUDA_GRAPH": lambda: int(
        os.getenv("VLLM_FLASH_ATTN_MAX_NUM_SPLITS_FOR_CUDA_GRAPH", "32")
    ),
989
990
991
    # Number of GPUs per worker in Ray, if it is set to be a fraction,
    # it allows ray to schedule multiple actors on a single GPU,
    # so that users can colocate other actors on the same GPUs as vLLM.
992
993
994
    "VLLM_RAY_PER_WORKER_GPUS": lambda: float(
        os.getenv("VLLM_RAY_PER_WORKER_GPUS", "1.0")
    ),
995
996
997
    # Bundle indices for Ray, if it is set, it can control precisely
    # which indices are used for the Ray bundle, for every worker.
    # Format: comma-separated list of integers, e.g. "0,1,2,3"
998
    "VLLM_RAY_BUNDLE_INDICES": lambda: os.getenv("VLLM_RAY_BUNDLE_INDICES", ""),
999
1000
    # In some system, find_loaded_library() may not work. So we allow users to
    # specify the path through environment variable VLLM_CUDART_SO_PATH.
1001
    "VLLM_CUDART_SO_PATH": lambda: os.getenv("VLLM_CUDART_SO_PATH", None),
1002
    # Rank of the process in the data parallel setting
1003
    "VLLM_DP_RANK": lambda: int(os.getenv("VLLM_DP_RANK", "0")),
1004
1005
    # Rank of the process in the data parallel setting.
    # Defaults to VLLM_DP_RANK when not set.
1006
1007
1008
    "VLLM_DP_RANK_LOCAL": lambda: int(
        os.getenv("VLLM_DP_RANK_LOCAL", sys.modules[__name__].VLLM_DP_RANK)
    ),
1009
    # World size of the data parallel setting
1010
    "VLLM_DP_SIZE": lambda: int(os.getenv("VLLM_DP_SIZE", "1")),
1011
    # IP address of the master node in the data parallel setting
1012
    "VLLM_DP_MASTER_IP": lambda: os.getenv("VLLM_DP_MASTER_IP", "127.0.0.1"),
1013
    # Port of the master node in the data parallel setting
1014
    "VLLM_DP_MASTER_PORT": lambda: int(os.getenv("VLLM_DP_MASTER_PORT", "0")),
1015
1016
1017
1018
1019
    # In the context of executing MoE models with Data-Parallel, Expert-Parallel
    # and Batched All-to-All dispatch/combine kernels, VLLM_MOE_DP_CHUNK_SIZE
    # dictates the quantum of tokens that can be dispatched from a DP
    # rank. All DP ranks process the activations in VLLM_MOE_DP_CHUNK_SIZE
    # units.
1020
    "VLLM_MOE_DP_CHUNK_SIZE": lambda: int(os.getenv("VLLM_MOE_DP_CHUNK_SIZE", "256")),
1021
    # Randomize inputs during dummy runs when using Data Parallel
1022
1023
1024
1025
    "VLLM_RANDOMIZE_DP_DUMMY_INPUTS": lambda: os.environ.get(
        "VLLM_RANDOMIZE_DP_DUMMY_INPUTS", "0"
    )
    == "1",
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
    # Strategy to pack the data parallel ranks for Ray.
    # Available options:
    # - "fill":
    #   for DP master node, allocate exactly data-parallel-size-local DP ranks,
    #   for non-master nodes, allocate as many DP ranks as can fit;
    # - "strict":
    #   allocate exactly data-parallel-size-local DP ranks to each picked node;
    # This environment variable is ignored if data-parallel-backend is not Ray.
    "VLLM_RAY_DP_PACK_STRATEGY": lambda: os.getenv(
        "VLLM_RAY_DP_PACK_STRATEGY", "strict"
    ),
1037
    # Whether to use S3 path for model loading in CI via RunAI Streamer
1038
    "VLLM_CI_USE_S3": lambda: os.environ.get("VLLM_CI_USE_S3", "0") == "1",
1039
    # Use model_redirect to redirect the model name to a local folder.
1040
1041
1042
1043
1044
    # `model_redirect` can be a json file mapping the model between
    # repo_id and local folder:
    # {"meta-llama/Llama-3.2-1B": "/tmp/Llama-3.2-1B"}
    # or a space separated values table file:
    # meta-llama/Llama-3.2-1B   /tmp/Llama-3.2-1B
1045
1046
1047
    "VLLM_MODEL_REDIRECT_PATH": lambda: os.environ.get(
        "VLLM_MODEL_REDIRECT_PATH", None
    ),
1048
    # Whether to use atomicAdd reduce in gptq/awq marlin kernel.
1049
1050
1051
1052
    "VLLM_MARLIN_USE_ATOMIC_ADD": lambda: os.environ.get(
        "VLLM_MARLIN_USE_ATOMIC_ADD", "0"
    )
    == "1",
1053
    # Whether to use marlin kernel in mxfp4 quantization method
1054
1055
1056
    "VLLM_MXFP4_USE_MARLIN": lambda: maybe_convert_bool(
        os.environ.get("VLLM_MXFP4_USE_MARLIN", None)
    ),
1057
1058
1059
    # Whether to turn on the outlines cache for V0
    # This cache is unbounded and on disk, so it's not safe to use in
    # an environment with potentially malicious users.
1060
1061
1062
1063
    "VLLM_V0_USE_OUTLINES_CACHE": lambda: os.environ.get(
        "VLLM_V0_USE_OUTLINES_CACHE", "0"
    )
    == "1",
1064
1065
1066
    # Whether to turn on the outlines cache for V1
    # This cache is unbounded and on disk, so it's not safe to use in
    # an environment with potentially malicious users.
1067
1068
1069
1070
    "VLLM_V1_USE_OUTLINES_CACHE": lambda: os.environ.get(
        "VLLM_V1_USE_OUTLINES_CACHE", "0"
    )
    == "1",
1071
1072
    # Gap between padding buckets for the forward pass. So we have
    # 8, we will run forward pass with [16, 24, 32, ...].
1073
1074
1075
1076
1077
1078
1079
1080
    "VLLM_TPU_BUCKET_PADDING_GAP": lambda: int(
        os.environ["VLLM_TPU_BUCKET_PADDING_GAP"]
    )
    if "VLLM_TPU_BUCKET_PADDING_GAP" in os.environ
    else 0,
    "VLLM_TPU_MOST_MODEL_LEN": lambda: maybe_convert_int(
        os.environ.get("VLLM_TPU_MOST_MODEL_LEN", None)
    ),
1081
    # Whether using Pathways
1082
1083
1084
    "VLLM_TPU_USING_PATHWAYS": lambda: bool(
        "proxy" in os.getenv("JAX_PLATFORMS", "").lower()
    ),
1085
    # Allow use of DeepGemm kernels for fused moe ops.
1086
    "VLLM_USE_DEEP_GEMM": lambda: bool(int(os.getenv("VLLM_USE_DEEP_GEMM", "1"))),
1087
    # Whether to use E8M0 scaling when DeepGEMM is used on Blackwell GPUs.
1088
1089
1090
    "VLLM_USE_DEEP_GEMM_E8M0": lambda: bool(
        int(os.getenv("VLLM_USE_DEEP_GEMM_E8M0", "1"))
    ),
1091
1092
1093
1094
    # DeepGemm JITs the kernels on-demand. The warmup attempts to make DeepGemm
    # JIT all the required kernels before model execution so there is no
    # JIT'ing in the hot-path. However, this warmup increases the engine
    # startup time by a couple of minutes.
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
    # Available options:
    #  - "skip"  : Skip warmup.
    #  - "full"  : Warmup deepgemm by running all possible gemm shapes the
    #   engine could encounter.
    #  - "relax" : Select gemm shapes to run based on some heuristics. The
    #   heuristic aims to have the same effect as running all possible gemm
    #   shapes, but provides no guarantees.
    "VLLM_DEEP_GEMM_WARMUP": env_with_choices(
        "VLLM_DEEP_GEMM_WARMUP",
        "relax",
        [
            "skip",
            "full",
            "relax",
        ],
1110
    ),
1111
    # Whether to use fused grouped_topk used for MoE expert selection.
1112
1113
1114
    "VLLM_USE_FUSED_MOE_GROUPED_TOPK": lambda: bool(
        int(os.getenv("VLLM_USE_FUSED_MOE_GROUPED_TOPK", "1"))
    ),
1115
    # Allow use of FlashInfer MoE kernels for fused moe ops.
1116
1117
1118
    "VLLM_USE_FLASHINFER_MOE_FP16": lambda: bool(
        int(os.getenv("VLLM_USE_FLASHINFER_MOE_FP16", "0"))
    ),
1119
    # Allow use of FlashInfer MoE kernels for fused moe ops.
1120
1121
1122
    "VLLM_USE_FLASHINFER_MOE_FP8": lambda: bool(
        int(os.getenv("VLLM_USE_FLASHINFER_MOE_FP8", "0"))
    ),
1123
    # Allow use of FlashInfer CUTLASS kernels for fused moe ops.
1124
1125
1126
    "VLLM_USE_FLASHINFER_MOE_FP4": lambda: bool(
        int(os.getenv("VLLM_USE_FLASHINFER_MOE_FP4", "0"))
    ),
1127
1128
    # If set to 1, use the FlashInfer
    # MXFP8 (activation) x MXFP4 (weight) MoE backend.
1129
1130
1131
    "VLLM_USE_FLASHINFER_MOE_MXFP4_MXFP8": lambda: bool(
        int(os.getenv("VLLM_USE_FLASHINFER_MOE_MXFP4_MXFP8", "0"))
    ),
1132
1133
1134
1135
    # If set to 1, use the FlashInfer CUTLASS backend for
    # MXFP8 (activation) x MXFP4 (weight) MoE.
    # This is separate from the TRTLLMGEN path controlled by
    # VLLM_USE_FLASHINFER_MOE_MXFP4_MXFP8.
1136
1137
1138
    "VLLM_USE_FLASHINFER_MOE_MXFP4_MXFP8_CUTLASS": lambda: bool(
        int(os.getenv("VLLM_USE_FLASHINFER_MOE_MXFP4_MXFP8_CUTLASS", "0"))
    ),
1139
1140
    # If set to 1, use the FlashInfer
    # BF16 (activation) x MXFP4 (weight) MoE backend.
1141
1142
1143
    "VLLM_USE_FLASHINFER_MOE_MXFP4_BF16": lambda: bool(
        int(os.getenv("VLLM_USE_FLASHINFER_MOE_MXFP4_BF16", "0"))
    ),
1144
1145
1146
    # Control the cache sized used by the xgrammar compiler. The default
    # of 512 MB should be enough for roughly 1000 JSON schemas.
    # It can be changed with this variable if needed for some reason.
1147
    "VLLM_XGRAMMAR_CACHE_MB": lambda: int(os.getenv("VLLM_XGRAMMAR_CACHE_MB", "512")),
1148
1149
1150
1151
1152
1153
1154
    # Control the threshold for msgspec to use 'zero copy' for
    # serialization/deserialization of tensors. Tensors below
    # this limit will be encoded into the msgpack buffer, and
    # tensors above will instead be sent via a separate message.
    # While the sending side still actually copies the tensor
    # in all cases, on the receiving side, tensors above this
    # limit will actually be zero-copy decoded.
1155
1156
1157
    "VLLM_MSGPACK_ZERO_COPY_THRESHOLD": lambda: int(
        os.getenv("VLLM_MSGPACK_ZERO_COPY_THRESHOLD", "256")
    ),
1158
1159
1160
    # If set, allow insecure serialization using pickle.
    # This is useful for environments where it is deemed safe to use the
    # insecure method and it is needed for some reason.
1161
1162
1163
    "VLLM_ALLOW_INSECURE_SERIALIZATION": lambda: bool(
        int(os.getenv("VLLM_ALLOW_INSECURE_SERIALIZATION", "0"))
    ),
Robert Shaw's avatar
Robert Shaw committed
1164
    # IP address used for NIXL handshake between remote agents.
1165
1166
1167
    "VLLM_NIXL_SIDE_CHANNEL_HOST": lambda: os.getenv(
        "VLLM_NIXL_SIDE_CHANNEL_HOST", "localhost"
    ),
Robert Shaw's avatar
Robert Shaw committed
1168
    # Port used for NIXL handshake between remote agents.
1169
1170
1171
    "VLLM_NIXL_SIDE_CHANNEL_PORT": lambda: int(
        os.getenv("VLLM_NIXL_SIDE_CHANNEL_PORT", "5600")
    ),
1172
    # all2all backend for vllm's expert parallel communication
1173
    # Available options:
1174
1175
1176
    # - "naive": naive all2all implementation using broadcasts
    # - "allgather_reducescatter": all2all implementation based on allgather and
    #  reducescatter
1177
    # - "pplx": use pplx kernels
1178
1179
    # - "deepep_high_throughput", use deepep high-throughput kernels
    # - "deepep_low_latency", use deepep low-latency kernels
1180
    # - "flashinfer_all2allv", use flashinfer alltoallv kernels for mnnvl
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
    "VLLM_ALL2ALL_BACKEND": env_with_choices(
        "VLLM_ALL2ALL_BACKEND",
        "allgather_reducescatter",
        [
            "naive",
            "pplx",
            "deepep_high_throughput",
            "deepep_low_latency",
            "allgather_reducescatter",
            "flashinfer_all2allv",
        ],
    ),
1193
1194
    # Flashinfer MoE backend for vLLM's fused Mixture-of-Experts support.
    # Both require compute capability 10.0 or above.
1195
1196
1197
1198
1199
    # Available options:
    # - "throughput":  [default]
    #     Uses CUTLASS kernels optimized for high-throughput batch inference.
    # - "latency":
    #     Uses TensorRT-LLM kernels optimized for low-latency inference.
1200
1201
1202
    "VLLM_FLASHINFER_MOE_BACKEND": env_with_choices(
        "VLLM_FLASHINFER_MOE_BACKEND", "throughput", ["throughput", "latency"]
    ),
1203
1204
1205
1206
    # Control the maximum number of tokens per expert supported by the
    # NVFP4 MoE CUTLASS Kernel. This value is used to create a buffer for
    # the blockscale tensor of activations NVFP4 Quantization.
    # This is used to prevent the kernel from running out of memory.
1207
1208
1209
    "VLLM_MAX_TOKENS_PER_EXPERT_FP4_MOE": lambda: int(
        os.getenv("VLLM_MAX_TOKENS_PER_EXPERT_FP4_MOE", "163840")
    ),
1210
1211
1212
1213
    # Specifies the thresholds of the communicated tensor sizes under which
    # vllm should use flashinfer fused allreduce. The variable should be a
    # JSON with the following format:
    #     { <world size>: <max size in mb> }
1214
    # Unspecified world sizes will fall back to
1215
    #     { 2: 64, 4: 1, <everything else>: 0.5 }
1216
1217
1218
    "VLLM_FLASHINFER_ALLREDUCE_FUSION_THRESHOLDS_MB": lambda: json.loads(
        os.getenv("VLLM_FLASHINFER_ALLREDUCE_FUSION_THRESHOLDS_MB", "{}")
    ),
1219
1220
1221
1222
1223
1224
    # MoE routing strategy selector.
    # See `RoutingSimulator.get_available_strategies()` # for available
    # strategies.
    # Cutstom routing strategies can be registered by
    # RoutingSimulator.register_strategy()
    # Note: custom strategies may not produce correct model outputs
1225
1226
1227
    "VLLM_MOE_ROUTING_SIMULATION_STRATEGY": lambda: os.environ.get(
        "VLLM_MOE_ROUTING_SIMULATION_STRATEGY", ""
    ).lower(),
1228
    # Regex timeout for use by the vLLM tool parsing plugins.
1229
1230
1231
    "VLLM_TOOL_PARSE_REGEX_TIMEOUT_SECONDS": lambda: int(
        os.getenv("VLLM_TOOL_PARSE_REGEX_TIMEOUT_SECONDS", "1")
    ),
1232
1233
    # Reduce CPU usage when vLLM is idle. Enabling this will incur small
    # latency penalty when a request eventually comes.
1234
    "VLLM_SLEEP_WHEN_IDLE": lambda: bool(int(os.getenv("VLLM_SLEEP_WHEN_IDLE", "0"))),
1235
1236
1237
    # Control the max chunk bytes (in MB) for the rpc message queue.
    # Object larger than this threshold will be broadcast to worker
    # processes via zmq.
1238
1239
1240
    "VLLM_MQ_MAX_CHUNK_BYTES_MB": lambda: int(
        os.getenv("VLLM_MQ_MAX_CHUNK_BYTES_MB", "16")
    ),
1241
1242
    # Timeout in seconds for execute_model RPC calls in multiprocessing
    # executor (only applies when TP > 1).
1243
1244
1245
    "VLLM_EXECUTE_MODEL_TIMEOUT_SECONDS": lambda: int(
        os.getenv("VLLM_EXECUTE_MODEL_TIMEOUT_SECONDS", "300")
    ),
1246
1247
1248
1249
1250
1251
1252
    # KV Cache layout used throughout vllm.
    # Some common values are:
    # - NHD
    # - HND
    # Where N=num_blocks, H=num_heads and D=head_size. The default value will
    # leave the layout choice to the backend. Mind that backends may only
    # implement and support a subset of all possible layouts.
1253
1254
1255
    "VLLM_KV_CACHE_LAYOUT": env_with_choices(
        "VLLM_KV_CACHE_LAYOUT", None, ["NHD", "HND"]
    ),
1256
1257
1258
    # Enable checking whether the generated logits contain NaNs,
    # indicating corrupted output. Useful for debugging low level bugs
    # or bad hardware but it may add compute overhead.
1259
1260
1261
    "VLLM_COMPUTE_NANS_IN_LOGITS": lambda: bool(
        int(os.getenv("VLLM_COMPUTE_NANS_IN_LOGITS", "0"))
    ),
1262
1263
1264
    # Controls whether or not emulations are used for NVFP4
    # generations on machines < 100 for compressed-tensors
    # models
1265
1266
1267
    "VLLM_USE_NVFP4_CT_EMULATIONS": lambda: bool(
        int(os.getenv("VLLM_USE_NVFP4_CT_EMULATIONS", "0"))
    ),
1268
1269
1270
1271
    # Time (in seconds) after which the KV cache on the producer side is
    # automatically cleared if no READ notification is received from the
    # consumer. This is only applicable when using NixlConnector in a
    # disaggregated decode-prefill setup.
1272
1273
1274
    "VLLM_NIXL_ABORT_REQUEST_TIMEOUT": lambda: int(
        os.getenv("VLLM_NIXL_ABORT_REQUEST_TIMEOUT", "480")
    ),
1275
    # Controls whether or not to use cudnn prefill
1276
1277
1278
    "VLLM_USE_CUDNN_PREFILL": lambda: bool(
        int(os.getenv("VLLM_USE_CUDNN_PREFILL", "0"))
    ),
1279
1280
1281
    # If set to 1/True, use the TRTLLM attention backend in flashinfer.
    # If set to 0/False, use the default attention backend in flashinfer.
    # If not set, auto-detect the attention backend in flashinfer.
1282
1283
1284
1285
1286
    "VLLM_USE_TRTLLM_ATTENTION": lambda: (
        None
        if "VLLM_USE_TRTLLM_ATTENTION" not in os.environ
        else os.environ["VLLM_USE_TRTLLM_ATTENTION"].lower() in ("1", "true")
    ),
1287
    # If set to 1, when we use fp8 kv, we do not quantize Q to fp8
1288
1289
1290
    "VLLM_FLASHINFER_DISABLE_Q_QUANTIZATION": lambda: bool(
        int(os.getenv("VLLM_FLASHINFER_DISABLE_Q_QUANTIZATION", "0"))
    ),
1291
1292
    # If set, it means we pre-downloaded cubin files and flashinfer will
    # read the cubin files directly.
1293
    "VLLM_HAS_FLASHINFER_CUBIN": lambda: os.getenv("VLLM_HAS_FLASHINFER_CUBIN", False),
1294
1295
1296
    # If set to 1, force the use of TRTLLM FP4 GEMM backend in flashinfer.
    # Otherwise, uses the first available of: flashinfer cutlass GEMM,
    # vllm cutlass GEMM, marlin GEMM.
1297
1298
1299
    "VLLM_USE_TRTLLM_FP4_GEMM": lambda: bool(
        int(os.getenv("VLLM_USE_TRTLLM_FP4_GEMM", "0"))
    ),
1300
1301
1302
    # Controls garbage collection during CUDA graph capture.
    # If set to 0 (default), enables GC freezing to speed up capture time.
    # If set to 1, allows GC to run during capture.
1303
1304
1305
    "VLLM_ENABLE_CUDAGRAPH_GC": lambda: bool(
        int(os.getenv("VLLM_ENABLE_CUDAGRAPH_GC", "0"))
    ),
1306
1307
1308
    # Disable padding to CUDA graph capture batch sizes.
    # TODO(wentao): https://github.com/vllm-project/vllm/issues/23378
    # After the issue is fixed, we can remove this flag.
1309
1310
1311
    "VLLM_DISABLE_PAD_FOR_CUDAGRAPH": lambda: bool(
        int(os.getenv("VLLM_DISABLE_PAD_FOR_CUDAGRAPH", "0"))
    ),
1312
    # Used to force set up loopback IP
1313
    "VLLM_LOOPBACK_IP": lambda: os.getenv("VLLM_LOOPBACK_IP", ""),
1314
1315
1316
    # Used to set the process name prefix for vLLM processes.
    # This is useful for debugging and monitoring purposes.
    # The default value is "VLLM".
1317
    "VLLM_PROCESS_NAME_PREFIX": lambda: os.getenv("VLLM_PROCESS_NAME_PREFIX", "VLLM"),
1318
1319
1320
1321
1322
1323
1324
    # Allow chunked local attention with hybrid kv cache manager.
    # Currently using the Hybrid KV cache manager with chunked local attention
    # in the Llama4 models (the only models currently using chunked local attn)
    # causes a latency regression. For this reason, we disable it by default.
    # This flag is used to allow users to enable it if they want to (to save on
    # kv-cache memory usage and enable longer contexts)
    # TODO(lucas): Remove this flag once latency regression is resolved.
1325
1326
1327
    "VLLM_ALLOW_CHUNKED_LOCAL_ATTN_WITH_HYBRID_KV_CACHE": lambda: bool(
        int(os.getenv("VLLM_ALLOW_CHUNKED_LOCAL_ATTN_WITH_HYBRID_KV_CACHE", "0"))
    ),
1328
1329
    # Enables support for the "store" option in the OpenAI Responses API.
    # When set to 1, vLLM's OpenAI server will retain the input and output
1330
1331
    # messages for those requests in memory. By default, this is disabled (0),
    # and the "store" option is ignored.
1332
1333
1334
1335
1336
    # NOTE/WARNING:
    # 1. Messages are kept in memory only (not persisted to disk) and will be
    #    lost when the vLLM server shuts down.
    # 2. Enabling this option will cause a memory leak, as stored messages are
    #    never removed from memory until the server terminates.
1337
1338
1339
    "VLLM_ENABLE_RESPONSES_API_STORE": lambda: bool(
        int(os.getenv("VLLM_ENABLE_RESPONSES_API_STORE", "0"))
    ),
xiao-llm's avatar
xiao-llm committed
1340
    # If set, use the fp8 mfma in rocm paged attention.
1341
1342
1343
    "VLLM_ROCM_FP8_MFMA_PAGE_ATTN": lambda: bool(
        int(os.getenv("VLLM_ROCM_FP8_MFMA_PAGE_ATTN", "0"))
    ),
1344
    # Whether to use pytorch symmetric memory for allreduce
1345
1346
1347
    "VLLM_ALLREDUCE_USE_SYMM_MEM": lambda: bool(
        int(os.getenv("VLLM_ALLREDUCE_USE_SYMM_MEM", "1"))
    ),
1348
    # Allows vllm to find tuned config under customized folder
1349
    "VLLM_TUNED_CONFIG_FOLDER": lambda: os.getenv("VLLM_TUNED_CONFIG_FOLDER", None),
1350
    # Allows harmony instructions to be injected on system messages
1351
1352
1353
    "VLLM_GPT_OSS_HARMONY_SYSTEM_INSTRUCTIONS": lambda: bool(
        int(os.getenv("VLLM_GPT_OSS_HARMONY_SYSTEM_INSTRUCTIONS", "0"))
    ),
1354
    # Add optional custom scopes for profiling, disable to avoid overheads
1355
1356
1357
    "VLLM_CUSTOM_SCOPES_FOR_PROFILING": lambda: bool(
        int(os.getenv("VLLM_CUSTOM_SCOPES_FOR_PROFILING", "0"))
    ),
1358
    # Add optional nvtx scopes for profiling, disable to avoid overheads
1359
1360
1361
    "VLLM_NVTX_SCOPES_FOR_PROFILING": lambda: bool(
        int(os.getenv("VLLM_NVTX_SCOPES_FOR_PROFILING", "0"))
    ),
1362
1363
    # Represent block hashes in KV cache events as 64-bit integers instead of
    # raw bytes. Defaults to True for backward compatibility.
1364
1365
1366
    "VLLM_KV_EVENTS_USE_INT_BLOCK_HASHES": lambda: bool(
        int(os.getenv("VLLM_KV_EVENTS_USE_INT_BLOCK_HASHES", "1"))
    ),
1367
1368
    # Name of the shared memory buffer used for object storage.
    # Only effective when mm_config.mm_processor_cache_type == "shm".
1369
1370
1371
    "VLLM_OBJECT_STORAGE_SHM_BUFFER_NAME": lambda: os.getenv(
        "VLLM_OBJECT_STORAGE_SHM_BUFFER_NAME", "VLLM_OBJECT_STORAGE_SHM_BUFFER"
    ),
1372
    # The size in MB of the buffers (NVL and RDMA) used by DeepEP
1373
1374
1375
    "VLLM_DEEPEP_BUFFER_SIZE_MB": lambda: int(
        os.getenv("VLLM_DEEPEP_BUFFER_SIZE_MB", "1024")
    ),
1376
1377
    # The number of SMs to allocate for communication kernels when running DBO
    # the rest of the SMs on the device will be allocated to compute
1378
    "VLLM_DBO_COMM_SMS": lambda: int(os.getenv("VLLM_DBO_COMM_SMS", "20")),
1379
1380
    # Valid values are container,code_interpreter,web_search_preview
    # ex GPT_OSS_SYSTEM_TOOL_MCP_LABELS=container,code_interpreter
1381
1382
1383
1384
1385
    "GPT_OSS_SYSTEM_TOOL_MCP_LABELS": env_list_with_choices(
        "GPT_OSS_SYSTEM_TOOL_MCP_LABELS",
        [],
        ["container", "code_interpreter", "web_search_preview"],
    ),
1386
1387
1388
    # Enable max_autotune & coordinate_descent_tuning in inductor_config
    # to compile static shapes passed from compile_sizes in compilation_config
    # If set to 1, enable max_autotune; By default, this is enabled (1)
1389
1390
1391
    "VLLM_ENABLE_INDUCTOR_MAX_AUTOTUNE": lambda: bool(
        int(os.getenv("VLLM_ENABLE_INDUCTOR_MAX_AUTOTUNE", "1"))
    ),
1392
1393
    # If set to 1, enable coordinate_descent_tuning;
    # By default, this is enabled (1)
1394
1395
1396
    "VLLM_ENABLE_INDUCTOR_COORDINATE_DESCENT_TUNING": lambda: bool(
        int(os.getenv("VLLM_ENABLE_INDUCTOR_COORDINATE_DESCENT_TUNING", "1"))
    ),
1397
    # Flag to enable NCCL symmetric memory allocation and registration
1398
1399
1400
    "VLLM_USE_NCCL_SYMM_MEM": lambda: bool(
        int(os.getenv("VLLM_USE_NCCL_SYMM_MEM", "0"))
    ),
1401
    # NCCL header path
1402
    "VLLM_NCCL_INCLUDE_PATH": lambda: os.environ.get("VLLM_NCCL_INCLUDE_PATH", None),
1403
1404
    # Flag to enable FBGemm kernels on model execution
    "VLLM_USE_FBGEMM": lambda: bool(int(os.getenv("VLLM_USE_FBGEMM", "0"))),
1405
1406
1407
1408
1409
1410
    # GC debug config
    # - VLLM_GC_DEBUG=0: disable GC debugger
    # - VLLM_GC_DEBUG=1: enable GC debugger with gc.collect elpased times
    # - VLLM_GC_DEBUG='{"top_objects":5}': enable GC debugger with
    #                                      top 5 collected objects
    "VLLM_GC_DEBUG": lambda: os.getenv("VLLM_GC_DEBUG", ""),
1411
1412
}

1413
# --8<-- [end:env-vars-definition]
1414

1415

1416
def __getattr__(name: str):
1417
1418
1419
1420
1421
1422
1423
1424
    # lazy evaluation of environment variables
    if name in environment_variables:
        return environment_variables[name]()
    raise AttributeError(f"module {__name__!r} has no attribute {name!r}")


def __dir__():
    return list(environment_variables.keys())
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438


def is_set(name: str):
    """Check if an environment variable is explicitly set."""
    if name in environment_variables:
        return name in os.environ
    raise AttributeError(f"module {__name__!r} has no attribute {name!r}")


def set_vllm_use_v1(use_v1: bool):
    if is_set("VLLM_USE_V1"):
        raise ValueError(
            "Should not call set_vllm_use_v1() if VLLM_USE_V1 is set "
            "explicitly by the user. Please raise this as a Github "
1439
1440
            "Issue and explicitly set VLLM_USE_V1=0 or 1."
        )
1441
    os.environ["VLLM_USE_V1"] = "1" if use_v1 else "0"
1442
1443
1444
1445
1446
1447
1448
1449


def compute_hash() -> str:
    """
    WARNING: Whenever a new key is added to this environment
    variables, ensure that it is included in the factors list if
    it affects the computation graph. For example, different values
    of VLLM_PP_LAYER_PARTITION will generate different computation
1450
    graphs, so it is included in the factors list. The env vars that
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
    affect the choice of different kernels or attention backends should
    also be included in the factors list.
    """

    # The values of envs may affects the computation graph.
    # TODO(DefTruth): hash all environment variables?
    # for key in environment_variables:
    #     factorize(key)
    environment_variables_to_hash = [
        "VLLM_PP_LAYER_PARTITION",
        "VLLM_MLA_DISABLE",
1462
        "VLLM_FLASH_ATTN_MAX_NUM_SPLITS_FOR_CUDA_GRAPH",
1463
1464
1465
1466
        "VLLM_USE_TRITON_FLASH_ATTN",
        "VLLM_USE_TRITON_AWQ",
        "VLLM_DP_RANK",
        "VLLM_DP_SIZE",
1467
        "VLLM_USE_STANDALONE_COMPILE",
1468
        "VLLM_FUSED_MOE_CHUNK_SIZE",
1469
1470
1471
1472
1473
1474
        "VLLM_FLASHINFER_MOE_BACKEND",
        "VLLM_V1_USE_PREFILL_DECODE_ATTENTION",
        "VLLM_ATTENTION_BACKEND",
        "VLLM_USE_FLASHINFER_SAMPLER",
        "VLLM_DISABLED_KERNELS",
        "VLLM_USE_DEEP_GEMM",
1475
        "VLLM_USE_DEEP_GEMM_E8M0",
1476
        "VLLM_USE_TRTLLM_FP4_GEMM",
1477
        "VLLM_USE_FUSED_MOE_GROUPED_TOPK",
1478
        "VLLM_USE_FLASHINFER_MOE_FP16",
1479
1480
1481
        "VLLM_USE_FLASHINFER_MOE_FP8",
        "VLLM_USE_FLASHINFER_MOE_FP4",
        "VLLM_USE_FLASHINFER_MOE_MXFP4_MXFP8",
1482
        "VLLM_USE_FLASHINFER_MOE_MXFP4_MXFP8_CUTLASS",
1483
1484
1485
        "VLLM_USE_FLASHINFER_MOE_MXFP4_BF16",
        "VLLM_USE_CUDNN_PREFILL",
        "VLLM_USE_TRTLLM_ATTENTION",
1486
        "VLLM_FLASHINFER_DISABLE_Q_QUANTIZATION",
1487
1488
1489
1490
1491
1492
1493
        "VLLM_ROCM_USE_AITER",
        "VLLM_ROCM_USE_AITER_PAGED_ATTN",
        "VLLM_ROCM_USE_AITER_LINEAR",
        "VLLM_ROCM_USE_AITER_MOE",
        "VLLM_ROCM_USE_AITER_RMSNORM",
        "VLLM_ROCM_USE_AITER_MLA",
        "VLLM_ROCM_USE_AITER_MHA",
1494
1495
        "VLLM_ROCM_USE_AITER_FP4_ASM_GEMM",
        "VLLM_ROCM_USE_TRITON_ROPE",
1496
        "VLLM_ROCM_USE_AITER_FP8BMM",
1497
        "VLLM_ROCM_USE_AITER_UNIFIED_ATTENTION",
1498
1499
1500
1501
1502
1503
1504
        "VLLM_ROCM_USE_SKINNY_GEMM",
        "VLLM_ROCM_FP8_PADDING",
        "VLLM_ROCM_MOE_PADDING",
        "VLLM_ROCM_CUSTOM_PAGED_ATTN",
        "VLLM_ROCM_QUICK_REDUCE_QUANTIZATION",
        "VLLM_ROCM_QUICK_REDUCE_CAST_BF16_TO_FP16",
        "VLLM_ROCM_QUICK_REDUCE_MAX_SIZE_BYTES_MB",
xiao-llm's avatar
xiao-llm committed
1505
        "VLLM_ROCM_FP8_MFMA_PAGE_ATTN",
1506
1507
        "VLLM_ENABLE_INDUCTOR_MAX_AUTOTUNE",
        "VLLM_ENABLE_INDUCTOR_COORDINATE_DESCENT_TUNING",
1508
        "VLLM_USE_FBGEMM",
1509
1510
    ]
    for key in environment_variables_to_hash:
1511
1512
        # if this goes out of sync with environment_variables,
        # it's not a user error, it's a bug
1513
        assert key in environment_variables, (
1514
            "Please update environment_variables_to_hash in envs.py"
1515
        )
1516

1517
    factors = [environment_variables[key]() for key in environment_variables_to_hash]
1518

1519
    hash_str = hashlib.md5(str(factors).encode(), usedforsecurity=False).hexdigest()
1520
1521

    return hash_str