envs.py 66.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
from typing import TYPE_CHECKING, Any, Callable, Literal, Optional, Union
10
11
12

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

211
212
213
214
215
216
217
218
219
220
221
222
223
224
225

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"),
    )


226
227
228
229
230
231
def maybe_convert_int(value: Optional[str]) -> Optional[int]:
    if value is None:
        return None
    return int(value)


232
233
234
235
236
237
def maybe_convert_bool(value: Optional[str]) -> Optional[bool]:
    if value is None:
        return None
    return bool(int(value))


238
def env_with_choices(
239
240
241
242
243
    env_name: str,
    default: Optional[str],
    choices: Union[list[str], Callable[[], list[str]]],
    case_sensitive: bool = True,
) -> Callable[[], Optional[str]]:
244
245
    """
    Create a lambda that validates environment variable against allowed choices
246

247
248
249
250
251
    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
252

253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
    Returns:
        Lambda function for environment_variables dict
    """

    def _get_validated_env() -> Optional[str]:
        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:
273
274
275
276
            raise ValueError(
                f"Invalid value '{value}' for {env_name}. "
                f"Valid options: {actual_choices}."
            )
277
278
279
280
281
282

        return value

    return _get_validated_env


283
def env_list_with_choices(
284
285
286
287
288
    env_name: str,
    default: list[str],
    choices: Union[list[str], Callable[[], list[str]]],
    case_sensitive: bool = True,
) -> Callable[[], list[str]]:
289
    """
290
    Create a lambda that validates environment variable
291
    containing comma-separated values against allowed choices
292

293
294
295
296
297
    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
298

299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
    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:
328
329
330
331
                raise ValueError(
                    f"Invalid value '{val}' in {env_name}. "
                    f"Valid options: {actual_choices}."
                )
332
333
334
335
336
337

        return values

    return _get_validated_env_list


338
339
def get_vllm_port() -> Optional[int]:
    """Get the port from VLLM_PORT environment variable.
340

341
342
    Returns:
        The port number as an integer if VLLM_PORT is set, None otherwise.
343

344
345
346
    Raises:
        ValueError: If VLLM_PORT is a URI, suggest k8s service discovery issue.
    """
347
    if "VLLM_PORT" not in os.environ:
348
349
        return None

350
    port = os.getenv("VLLM_PORT", "0")
351
352
353
354
355

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

357
358
359
360
361
362
363
        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
364
        raise ValueError(f"VLLM_PORT '{port}' must be a valid integer") from err
365
366


367
368
369
# The begin-* and end* here are used by the documentation generator
# to extract the used env vars.

370
# --8<-- [start:env-vars-definition]
371

372
environment_variables: dict[str, Callable[[], Any]] = {
373
    # ================== Installation Time Env Vars ==================
374
    # Target device of vLLM, supporting [cuda (by default),
375
    # rocm, cpu]
376
    "VLLM_TARGET_DEVICE": lambda: os.getenv("VLLM_TARGET_DEVICE", "cuda").lower(),
377
378
    # Main CUDA version of vLLM, supporting [12.6, 12.8, 12.9],
    # 12.8 is the default. This follows PyTorch but can be overridden.
379
380
    "VLLM_MAIN_CUDA_VERSION": lambda: os.getenv("VLLM_MAIN_CUDA_VERSION", "").lower()
    or "12.8",
381
382
    # Maximum number of compilation jobs to run in parallel.
    # By default this is the number of CPUs
383
    "MAX_JOBS": lambda: os.getenv("MAX_JOBS", None),
384
385
386
    # Number of threads to use for nvcc
    # By default this is 1.
    # If set, `MAX_JOBS` will be reduced to avoid oversubscribing the CPU.
387
    "NVCC_THREADS": lambda: os.getenv("NVCC_THREADS", None),
388
    # If set, vllm will use precompiled binaries (*.so)
389
390
391
392
393
    "VLLM_USE_PRECOMPILED": lambda: os.environ.get("VLLM_USE_PRECOMPILED", "")
    .strip()
    .lower()
    in ("1", "true")
    or bool(os.environ.get("VLLM_PRECOMPILED_WHEEL_LOCATION")),
394
395
    # Used to mark that setup.py is running in a Docker build context,
    # in order to force the use of precompiled binaries.
396
397
398
399
    "VLLM_DOCKER_BUILD_CONTEXT": lambda: os.environ.get("VLLM_DOCKER_BUILD_CONTEXT", "")
    .strip()
    .lower()
    in ("1", "true"),
400
401
    # Whether to force using nightly wheel in python build.
    # This is used for testing the nightly wheel in python build.
402
403
404
    "VLLM_TEST_USE_PRECOMPILED_NIGHTLY_WHEEL": lambda: bool(
        int(os.getenv("VLLM_TEST_USE_PRECOMPILED_NIGHTLY_WHEEL", "0"))
    ),
405
406
407
    # CMake build type
    # If not set, defaults to "Debug" or "RelWithDebInfo"
    # Available options: "Debug", "Release", "RelWithDebInfo"
408
409
410
    "CMAKE_BUILD_TYPE": env_with_choices(
        "CMAKE_BUILD_TYPE", None, ["Debug", "Release", "RelWithDebInfo"]
    ),
411
    # If set, vllm will print verbose logs during installation
412
    "VERBOSE": lambda: bool(int(os.getenv("VERBOSE", "0"))),
413
    # Root directory for vLLM configuration files
414
    # Defaults to `~/.config/vllm` unless `XDG_CONFIG_HOME` is set
415
416
417
    # 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**.
418
    "VLLM_CONFIG_ROOT": lambda: os.path.expanduser(
419
420
421
        os.getenv(
            "VLLM_CONFIG_ROOT",
            os.path.join(get_default_config_root(), "vllm"),
422
423
        )
    ),
424
    # ================== Runtime Env Vars ==================
425
    # Root directory for vLLM cache files
426
    # Defaults to `~/.cache/vllm` unless `XDG_CACHE_HOME` is set
427
    "VLLM_CACHE_ROOT": lambda: os.path.expanduser(
428
429
430
        os.getenv(
            "VLLM_CACHE_ROOT",
            os.path.join(get_default_cache_root(), "vllm"),
431
432
        )
    ),
433
434
435
436
    # 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.
437
    "VLLM_HOST_IP": lambda: os.getenv("VLLM_HOST_IP", ""),
438
    # used in distributed environment to manually set the communication port
439
440
441
    # 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.
442
    "VLLM_PORT": get_vllm_port,
443
444
    # path used for ipc when the frontend api server is running in
    # multi-processing mode to communicate with the backend engine process.
445
446
447
    "VLLM_RPC_BASE_PATH": lambda: os.getenv(
        "VLLM_RPC_BASE_PATH", tempfile.gettempdir()
    ),
448
449
    # If true, will load models from ModelScope instead of Hugging Face Hub.
    # note that the value is true or false, not numbers
450
451
452
453
    "VLLM_USE_MODELSCOPE": lambda: os.environ.get(
        "VLLM_USE_MODELSCOPE", "False"
    ).lower()
    == "true",
454
    # Interval in seconds to log a warning message when the ring buffer is full
455
456
457
    "VLLM_RINGBUFFER_WARNING_INTERVAL": lambda: int(
        os.environ.get("VLLM_RINGBUFFER_WARNING_INTERVAL", "60")
    ),
458
459
    # path to cudatoolkit home directory, under which should be bin, include,
    # and lib directories.
460
    "CUDA_HOME": lambda: os.environ.get("CUDA_HOME", None),
461
462
    # 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
463
    "VLLM_NCCL_SO_PATH": lambda: os.environ.get("VLLM_NCCL_SO_PATH", None),
464
465
    # 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`
466
    "LD_LIBRARY_PATH": lambda: os.environ.get("LD_LIBRARY_PATH", None),
467
    # flag to control if vllm should use triton flash attention
468
469
470
    "VLLM_USE_TRITON_FLASH_ATTN": lambda: (
        os.environ.get("VLLM_USE_TRITON_FLASH_ATTN", "True").lower() in ("true", "1")
    ),
471
472
    # Use separate prefill and decode kernels for V1 attention instead of
    # the unified triton kernel.
473
474
475
476
    "VLLM_V1_USE_PREFILL_DECODE_ATTENTION": lambda: (
        os.getenv("VLLM_V1_USE_PREFILL_DECODE_ATTENTION", "False").lower()
        in ("true", "1")
    ),
477
478
    # Force vllm to use a specific flash-attention version (2 or 3), only valid
    # when using the flash-attention backend.
479
480
481
    "VLLM_FLASH_ATTN_VERSION": lambda: maybe_convert_int(
        os.environ.get("VLLM_FLASH_ATTN_VERSION", None)
    ),
482
483
    # Feature flag to enable/disable Inductor standalone compile.
    # In torch <= 2.7 we ignore this flag; in torch >= 2.8 this is
484
    # disabled by default.
485
486
487
488
    "VLLM_USE_STANDALONE_COMPILE": lambda: os.environ.get(
        "VLLM_USE_STANDALONE_COMPILE", "0"
    )
    == "1",
489
490
    # Debug pattern matching inside custom passes.
    # Should be set to the fx.Node name (e.g. 'getitem_34' or 'scaled_mm_3').
491
492
493
    "VLLM_PATTERN_MATCH_DEBUG": lambda: os.environ.get(
        "VLLM_PATTERN_MATCH_DEBUG", None
    ),
494
495
    # Dump fx graphs to the given directory.
    # It will override CompilationConfig.debug_dump_path if set.
496
    "VLLM_DEBUG_DUMP_PATH": lambda: os.environ.get("VLLM_DEBUG_DUMP_PATH", None),
497
498
    # local rank of the process in the distributed setting, used to determine
    # the GPU device id
499
    "LOCAL_RANK": lambda: int(os.environ.get("LOCAL_RANK", "0")),
500
    # used to control the visible devices in the distributed setting
501
    "CUDA_VISIBLE_DEVICES": lambda: os.environ.get("CUDA_VISIBLE_DEVICES", None),
502
    # timeout for each iteration in the engine
503
504
505
    "VLLM_ENGINE_ITERATION_TIMEOUT_S": lambda: int(
        os.environ.get("VLLM_ENGINE_ITERATION_TIMEOUT_S", "60")
    ),
506
    # API key for vLLM API server
507
    "VLLM_API_KEY": lambda: os.environ.get("VLLM_API_KEY", None),
508
    # Whether to log responses from API Server for debugging
509
510
511
512
    "VLLM_DEBUG_LOG_API_SERVER_RESPONSE": lambda: os.environ.get(
        "VLLM_DEBUG_LOG_API_SERVER_RESPONSE", "False"
    ).lower()
    == "true",
513
    # S3 access information, used for tensorizer to load model from S3
514
515
516
    "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),
517
    # Usage stats collection
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
    "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"),
533
534
535
536
    # 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
537
538
    "VLLM_CONFIGURE_LOGGING": lambda: int(os.getenv("VLLM_CONFIGURE_LOGGING", "1")),
    "VLLM_LOGGING_CONFIG_PATH": lambda: os.getenv("VLLM_LOGGING_CONFIG_PATH"),
539
    # this is used for configuring the default logging level
540
    "VLLM_LOGGING_LEVEL": lambda: os.getenv("VLLM_LOGGING_LEVEL", "INFO").upper(),
541
    # this is used for configuring the default logging stream
542
    "VLLM_LOGGING_STREAM": lambda: os.getenv("VLLM_LOGGING_STREAM", "ext://sys.stdout"),
543
    # if set, VLLM_LOGGING_PREFIX will be prepended to all log messages
544
    "VLLM_LOGGING_PREFIX": lambda: os.getenv("VLLM_LOGGING_PREFIX", ""),
545
546
547
548
    # 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.
549
550
551
552
553
    "VLLM_LOGITS_PROCESSOR_THREADS": lambda: int(
        os.getenv("VLLM_LOGITS_PROCESSOR_THREADS", "0")
    )
    if "VLLM_LOGITS_PROCESSOR_THREADS" in os.environ
    else None,
554
555
    # If set, vllm will log stats at this interval in seconds
    # If not set, vllm will log stats every 10 seconds.
556
557
558
    "VLLM_LOG_STATS_INTERVAL": lambda: val
    if (val := float(os.getenv("VLLM_LOG_STATS_INTERVAL", "10."))) > 0.0
    else 10.0,
559
560
561
    # Trace function calls
    # If set to 1, vllm will trace function calls
    # Useful for debugging
562
    "VLLM_TRACE_FUNCTION": lambda: int(os.getenv("VLLM_TRACE_FUNCTION", "0")),
563
    # Backend for attention computation
564
    # Example options:
565
566
567
    # - "TORCH_SDPA": use torch.nn.MultiheadAttention
    # - "FLASH_ATTN": use FlashAttention
    # - "XFORMERS": use XFormers
568
    # - "FLASHINFER": use flashinfer
569
    # - "FLASHMLA": use FlashMLA
570
    # - "FLASH_ATTN_MLA": use FlashAttention for MLA
571
572
    # - "FLASHINFER_MLA": use FlashInfer for MLA
    # - "CUTLASS_MLA": use CUTLASS for MLA
573
    # All possible options loaded dynamically from _Backend enum
574
575
576
577
578
579
580
581
582
    "VLLM_ATTENTION_BACKEND": env_with_choices(
        "VLLM_ATTENTION_BACKEND",
        None,
        lambda: list(
            __import__(
                "vllm.attention.backends.registry", fromlist=["_Backend"]
            )._Backend.__members__.keys()
        ),
    ),
583
    # If set, vllm will use flashinfer sampler
584
585
586
587
588
    "VLLM_USE_FLASHINFER_SAMPLER": lambda: bool(
        int(os.environ["VLLM_USE_FLASHINFER_SAMPLER"])
    )
    if "VLLM_USE_FLASHINFER_SAMPLER" in os.environ
    else None,
589
    # Pipeline stage partition strategy
590
    "VLLM_PP_LAYER_PARTITION": lambda: os.getenv("VLLM_PP_LAYER_PARTITION", None),
591
    # (CPU backend only) CPU key-value cache space.
592
    # default is None and will be set as 4 GB
593
594
595
    "VLLM_CPU_KVCACHE_SPACE": lambda: int(os.getenv("VLLM_CPU_KVCACHE_SPACE", "0"))
    if "VLLM_CPU_KVCACHE_SPACE" in os.environ
    else None,
596
597
    # (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 '|'.
598
    "VLLM_CPU_OMP_THREADS_BIND": lambda: os.getenv("VLLM_CPU_OMP_THREADS_BIND", "auto"),
599
600
    # (CPU backend only) CPU cores not used by OMP threads .
    # Those CPU cores will not be used by OMP threads of a rank.
601
602
603
604
605
    "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,
606
607
608
    # (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).
609
    "VLLM_CPU_MOE_PREPACK": lambda: bool(int(os.getenv("VLLM_CPU_MOE_PREPACK", "1"))),
610
    # (CPU backend only) whether to use SGL kernels, optimized for small batch.
611
    "VLLM_CPU_SGL_KERNEL": lambda: bool(int(os.getenv("VLLM_CPU_SGL_KERNEL", "0"))),
612
613
614
615
    # 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.
616
617
618
    "VLLM_USE_RAY_SPMD_WORKER": lambda: bool(
        int(os.getenv("VLLM_USE_RAY_SPMD_WORKER", "0"))
    ),
619
620
621
    # If the env var is set, it uses the Ray's Compiled Graph
    # (previously known as ADAG) API which optimizes the
    # control plane overhead.
622
    # Run vLLM with VLLM_USE_RAY_COMPILED_DAG=1 to enable it.
623
624
    # Note that this variable is set to 1 in V1 by default
    # when ray distributed executor is used.
625
626
627
    "VLLM_USE_RAY_COMPILED_DAG": lambda: bool(
        int(os.getenv("VLLM_USE_RAY_COMPILED_DAG", "0"))
    ),
628
629
630
631
632
633
634
635
    # 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.
636
637
638
    "VLLM_USE_RAY_COMPILED_DAG_CHANNEL_TYPE": env_with_choices(
        "VLLM_USE_RAY_COMPILED_DAG_CHANNEL_TYPE", "auto", ["auto", "nccl", "shm"]
    ),
639
    # If the env var is set, it enables GPU communication overlap
640
    # (experimental feature) in Ray's Compiled Graph. This flag is ignored if
641
    # VLLM_USE_RAY_COMPILED_DAG is not set.
642
643
644
    "VLLM_USE_RAY_COMPILED_DAG_OVERLAP_COMM": lambda: bool(
        int(os.getenv("VLLM_USE_RAY_COMPILED_DAG_OVERLAP_COMM", "0"))
    ),
645
646
647
648
    # 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.
649
650
651
    "VLLM_USE_RAY_WRAPPED_PP_COMM": lambda: bool(
        int(os.getenv("VLLM_USE_RAY_WRAPPED_PP_COMM", "1"))
    ),
652
653
    # Use dedicated multiprocess context for workers.
    # Both spawn and fork work
654
655
656
    "VLLM_WORKER_MULTIPROC_METHOD": env_with_choices(
        "VLLM_WORKER_MULTIPROC_METHOD", "fork", ["spawn", "fork"]
    ),
657
    # Path to the cache for storing downloaded assets
658
    "VLLM_ASSETS_CACHE": lambda: os.path.expanduser(
659
660
661
        os.getenv(
            "VLLM_ASSETS_CACHE",
            os.path.join(get_default_cache_root(), "vllm", "assets"),
662
663
        )
    ),
664
665
    # If the env var is set, we will clean model file in
    # this path $VLLM_ASSETS_CACHE/model_streamer/$model_name
666
667
668
    "VLLM_ASSETS_CACHE_MODEL_CLEAN": lambda: bool(
        int(os.getenv("VLLM_ASSETS_CACHE_MODEL_CLEAN", "0"))
    ),
669
670
    # Timeout for fetching images when serving multimodal models
    # Default is 5 seconds
671
    "VLLM_IMAGE_FETCH_TIMEOUT": lambda: int(os.getenv("VLLM_IMAGE_FETCH_TIMEOUT", "5")),
672
    # Timeout for fetching videos when serving multimodal models
673
    # Default is 30 seconds
674
675
676
    "VLLM_VIDEO_FETCH_TIMEOUT": lambda: int(
        os.getenv("VLLM_VIDEO_FETCH_TIMEOUT", "30")
    ),
677
    # Timeout for fetching audio when serving multimodal models
678
    # Default is 10 seconds
679
680
681
    "VLLM_AUDIO_FETCH_TIMEOUT": lambda: int(
        os.getenv("VLLM_AUDIO_FETCH_TIMEOUT", "10")
    ),
682
683
    # Whether to allow HTTP redirects when fetching from media URLs.
    # Default to True
684
685
686
    "VLLM_MEDIA_URL_ALLOW_REDIRECTS": lambda: bool(
        int(os.getenv("VLLM_MEDIA_URL_ALLOW_REDIRECTS", "1"))
    ),
687
688
689
    # Max number of workers for the thread pool handling
    # media bytes loading. Set to 1 to disable parallel processing.
    # Default is 8
690
691
692
    "VLLM_MEDIA_LOADING_THREAD_COUNT": lambda: int(
        os.getenv("VLLM_MEDIA_LOADING_THREAD_COUNT", "8")
    ),
693
694
695
    # 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
696
697
698
    "VLLM_MAX_AUDIO_CLIP_FILESIZE_MB": lambda: int(
        os.getenv("VLLM_MAX_AUDIO_CLIP_FILESIZE_MB", "25")
    ),
699
700
701
702
703
704
705
    # 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.
706
707
708
    "VLLM_VIDEO_LOADER_BACKEND": lambda: os.getenv(
        "VLLM_VIDEO_LOADER_BACKEND", "opencv"
    ),
709
    # [DEPRECATED] Cache size (in GiB per process) for multimodal input cache
710
    # Default is 4 GiB per API process + 4 GiB per engine core process
711
    "VLLM_MM_INPUT_CACHE_GIB": lambda: int(os.getenv("VLLM_MM_INPUT_CACHE_GIB", "4")),
712
713
    # Path to the XLA persistent cache directory.
    # Only used for XLA devices such as TPUs.
714
    "VLLM_XLA_CACHE_PATH": lambda: os.path.expanduser(
715
        os.getenv(
716
            "VLLM_XLA_CACHE_PATH",
717
            os.path.join(get_default_cache_root(), "vllm", "xla_cache"),
718
719
        )
    ),
720
    # If set, assert on XLA recompilation after each execution step.
721
722
723
    "VLLM_XLA_CHECK_RECOMPILATION": lambda: bool(
        int(os.getenv("VLLM_XLA_CHECK_RECOMPILATION", "0"))
    ),
724
    # Enable SPMD mode for TPU backend.
725
726
727
728
    "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")
    ),
729
730
731
    # 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.
732
733
734
    "VLLM_ENABLE_FUSED_MOE_ACTIVATION_CHUNKING": lambda: bool(
        int(os.getenv("VLLM_ENABLE_FUSED_MOE_ACTIVATION_CHUNKING", "1"))
    ),
735
736
    # If set, the OpenAI API server will stay alive even after the underlying
    # AsyncLLMEngine errors and stops serving requests
737
738
739
    "VLLM_KEEP_ALIVE_ON_ENGINE_DEATH": lambda: bool(
        os.getenv("VLLM_KEEP_ALIVE_ON_ENGINE_DEATH", 0)
    ),
740
741
742
743
    # 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.
744
745
746
747
    "VLLM_ALLOW_LONG_MAX_MODEL_LEN": lambda: (
        os.environ.get("VLLM_ALLOW_LONG_MAX_MODEL_LEN", "0").strip().lower()
        in ("1", "true")
    ),
748
749
    # If set, forces FP8 Marlin to be used for FP8 quantization regardless
    # of the hardware support for FP8 compute.
750
751
752
753
754
755
756
    "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"
    ),
757
758
    # Time in ms for the zmq client to wait for a response from the backend
    # server for simple data operations
759
    "VLLM_RPC_TIMEOUT": lambda: int(os.getenv("VLLM_RPC_TIMEOUT", "10000")),
760
    # Timeout in seconds for keeping HTTP connections alive in API server
761
762
763
    "VLLM_HTTP_TIMEOUT_KEEP_ALIVE": lambda: int(
        os.environ.get("VLLM_HTTP_TIMEOUT_KEEP_ALIVE", "5")
    ),
764
765
766
    # 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
767
768
769
    "VLLM_PLUGINS": lambda: None
    if "VLLM_PLUGINS" not in os.environ
    else os.environ["VLLM_PLUGINS"].split(","),
770
771
772
    # a local directory to look in for unrecognized LoRA adapters.
    # only works if plugins are enabled and
    # VLLM_ALLOW_RUNTIME_LORA_UPDATING is enabled.
773
774
775
    "VLLM_LORA_RESOLVER_CACHE_DIR": lambda: os.getenv(
        "VLLM_LORA_RESOLVER_CACHE_DIR", None
    ),
776
777
778
779
    # 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.
780
781
782
783
784
785
786
    "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", "."))
        )
    ),
787
788
789
    # Enable torch profiler to record shapes if set
    # VLLM_TORCH_PROFILER_RECORD_SHAPES=1. If not set, torch profiler will
    # not record shapes.
790
791
792
    "VLLM_TORCH_PROFILER_RECORD_SHAPES": lambda: bool(
        os.getenv("VLLM_TORCH_PROFILER_RECORD_SHAPES", "0") != "0"
    ),
793
794
795
    # Enable torch profiler to profile memory if set
    # VLLM_TORCH_PROFILER_WITH_PROFILE_MEMORY=1. If not set, torch profiler
    # will not profile memory.
796
797
798
    "VLLM_TORCH_PROFILER_WITH_PROFILE_MEMORY": lambda: bool(
        os.getenv("VLLM_TORCH_PROFILER_WITH_PROFILE_MEMORY", "0") != "0"
    ),
799
800
801
    # Enable torch profiler to profile stack if set
    # VLLM_TORCH_PROFILER_WITH_STACK=1. If not set, torch profiler WILL
    # profile stack by default.
802
803
804
    "VLLM_TORCH_PROFILER_WITH_STACK": lambda: bool(
        os.getenv("VLLM_TORCH_PROFILER_WITH_STACK", "1") != "0"
    ),
805
806
807
    # Enable torch profiler to profile flops if set
    # VLLM_TORCH_PROFILER_WITH_FLOPS=1. If not set, torch profiler will
    # not profile flops.
808
809
810
    "VLLM_TORCH_PROFILER_WITH_FLOPS": lambda: bool(
        os.getenv("VLLM_TORCH_PROFILER_WITH_FLOPS", "0") != "0"
    ),
811
    # If set, vLLM will use Triton implementations of AWQ.
812
    "VLLM_USE_TRITON_AWQ": lambda: bool(int(os.getenv("VLLM_USE_TRITON_AWQ", "0"))),
813
    # If set, allow loading or unloading lora adapters in runtime,
814
815
816
817
    "VLLM_ALLOW_RUNTIME_LORA_UPDATING": lambda: (
        os.environ.get("VLLM_ALLOW_RUNTIME_LORA_UPDATING", "0").strip().lower()
        in ("1", "true")
    ),
818
819
820
821
822
823
    # 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
824
    "VLLM_SKIP_P2P_CHECK": lambda: os.getenv("VLLM_SKIP_P2P_CHECK", "1") == "1",
825
826
827
828
    # List of quantization kernels that should be disabled, used for testing
    # and performance comparisons. Currently only affects MPLinearKernel
    # selection
    # (kernels: MacheteLinearKernel, MarlinLinearKernel, ExllamaLinearKernel)
829
830
831
    "VLLM_DISABLED_KERNELS": lambda: []
    if "VLLM_DISABLED_KERNELS" not in os.environ
    else os.environ["VLLM_DISABLED_KERNELS"].split(","),
832
    # Disable pynccl (using torch.distributed instead)
833
834
835
    "VLLM_DISABLE_PYNCCL": lambda: (
        os.getenv("VLLM_DISABLE_PYNCCL", "False").lower() in ("true", "1")
    ),
836
    # If set, use the V1 code path.
837
    "VLLM_USE_V1": lambda: bool(int(os.getenv("VLLM_USE_V1", "1"))),
838
839
    # Disable aiter ops unless specifically enabled.
    # Acts as a parent switch to enable the rest of the other operations.
840
841
842
    "VLLM_ROCM_USE_AITER": lambda: (
        os.getenv("VLLM_ROCM_USE_AITER", "False").lower() in ("true", "1")
    ),
843
844
    # Whether to use aiter paged attention.
    # By default is disabled.
845
846
847
    "VLLM_ROCM_USE_AITER_PAGED_ATTN": lambda: (
        os.getenv("VLLM_ROCM_USE_AITER_PAGED_ATTN", "False").lower() in ("true", "1")
    ),
848
849
850
    # use aiter linear op if aiter ops are enabled
    # The following list of related ops
    # - scaled_mm (per-tensor / rowwise)
851
852
853
    "VLLM_ROCM_USE_AITER_LINEAR": lambda: (
        os.getenv("VLLM_ROCM_USE_AITER_LINEAR", "True").lower() in ("true", "1")
    ),
854
855
    # Whether to use aiter moe ops.
    # By default is enabled.
856
857
858
    "VLLM_ROCM_USE_AITER_MOE": lambda: (
        os.getenv("VLLM_ROCM_USE_AITER_MOE", "True").lower() in ("true", "1")
    ),
859
    # use aiter rms norm op if aiter ops are enabled.
860
861
862
    "VLLM_ROCM_USE_AITER_RMSNORM": lambda: (
        os.getenv("VLLM_ROCM_USE_AITER_RMSNORM", "True").lower() in ("true", "1")
    ),
863
864
    # Whether to use aiter mla ops.
    # By default is enabled.
865
866
867
    "VLLM_ROCM_USE_AITER_MLA": lambda: (
        os.getenv("VLLM_ROCM_USE_AITER_MLA", "True").lower() in ("true", "1")
    ),
868
869
    # Whether to use aiter mha ops.
    # By default is enabled.
870
871
872
    "VLLM_ROCM_USE_AITER_MHA": lambda: (
        os.getenv("VLLM_ROCM_USE_AITER_MHA", "True").lower() in ("true", "1")
    ),
873
874
    # Whether to use aiter fp4 gemm asm.
    # By default is disabled.
875
876
877
    "VLLM_ROCM_USE_AITER_FP4_ASM_GEMM": lambda: (
        os.getenv("VLLM_ROCM_USE_AITER_FP4_ASM_GEMM", "False").lower() in ("true", "1")
    ),
878
879
    # Whether to use aiter rope.
    # By default is disabled.
880
881
882
    "VLLM_ROCM_USE_TRITON_ROPE": lambda: (
        os.getenv("VLLM_ROCM_USE_TRITON_ROPE", "False").lower() in ("true", "1")
    ),
883
884
    # Whether to use aiter triton fp8 bmm kernel
    # By default is enabled.
885
886
887
    "VLLM_ROCM_USE_AITER_FP8BMM": lambda: (
        os.getenv("VLLM_ROCM_USE_AITER_FP8BMM", "True").lower() in ("true", "1")
    ),
888
889
890
891
892
    # 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")
    ),
893
    # use rocm skinny gemms
894
895
896
    "VLLM_ROCM_USE_SKINNY_GEMM": lambda: (
        os.getenv("VLLM_ROCM_USE_SKINNY_GEMM", "True").lower() in ("true", "1")
    ),
897
    # Pad the fp8 weights to 256 bytes for ROCm
898
    "VLLM_ROCM_FP8_PADDING": lambda: bool(int(os.getenv("VLLM_ROCM_FP8_PADDING", "1"))),
899
    # Pad the weights for the moe kernel
900
    "VLLM_ROCM_MOE_PADDING": lambda: bool(int(os.getenv("VLLM_ROCM_MOE_PADDING", "1"))),
901
    # custom paged attention kernel for MI3* cards
902
903
904
    "VLLM_ROCM_CUSTOM_PAGED_ATTN": lambda: (
        os.getenv("VLLM_ROCM_CUSTOM_PAGED_ATTN", "True").lower() in ("true", "1")
    ),
905
906
907
    # Custom quick allreduce kernel for MI3* cards
    # Choice of quantization level: FP, INT8, INT6, INT4 or NONE
    # Recommended for large models to get allreduce
908
909
910
911
912
    "VLLM_ROCM_QUICK_REDUCE_QUANTIZATION": env_with_choices(
        "VLLM_ROCM_QUICK_REDUCE_QUANTIZATION",
        "NONE",
        ["FP", "INT8", "INT6", "INT4", "NONE"],
    ),
913
914
915
916
    # 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
917
918
919
920
    "VLLM_ROCM_QUICK_REDUCE_CAST_BF16_TO_FP16": lambda: (
        os.getenv("VLLM_ROCM_QUICK_REDUCE_CAST_BF16_TO_FP16", "True").lower()
        in ("true", "1")
    ),
921
922
923
924
925
926
    # 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.
927
928
929
    "VLLM_ROCM_QUICK_REDUCE_MAX_SIZE_BYTES_MB": lambda: maybe_convert_int(
        os.environ.get("VLLM_ROCM_QUICK_REDUCE_MAX_SIZE_BYTES_MB", None)
    ),
930
    # Divisor for dynamic query scale factor calculation for FP8 KV Cache
931
    "Q_SCALE_CONSTANT": lambda: int(os.getenv("Q_SCALE_CONSTANT", "200")),
932
    # Divisor for dynamic key scale factor calculation for FP8 KV Cache
933
    "K_SCALE_CONSTANT": lambda: int(os.getenv("K_SCALE_CONSTANT", "200")),
934
    # Divisor for dynamic value scale factor calculation for FP8 KV Cache
935
    "V_SCALE_CONSTANT": lambda: int(os.getenv("V_SCALE_CONSTANT", "100")),
936
    # If set, enable multiprocessing in LLM for the V1 code path.
937
938
939
940
941
942
943
944
945
    "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"))
    ),
946
947
948
    # If set, vllm will run in development mode, which will enable
    # some additional endpoints for developing and debugging,
    # e.g. `/reset_prefix_cache`
949
    "VLLM_SERVER_DEV_MODE": lambda: bool(int(os.getenv("VLLM_SERVER_DEV_MODE", "0"))),
950
951
952
953
954
955
956
    # 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.
957
958
959
    "VLLM_V1_OUTPUT_PROC_CHUNK_SIZE": lambda: int(
        os.getenv("VLLM_V1_OUTPUT_PROC_CHUNK_SIZE", "128")
    ),
960
    # If set, vLLM will disable the MLA attention optimizations.
961
    "VLLM_MLA_DISABLE": lambda: bool(int(os.getenv("VLLM_MLA_DISABLE", "0"))),
962
963
    # If set, vLLM will pick up the provided Flash Attention MLA
    # max number splits for cuda graph decode
964
965
966
    "VLLM_FLASH_ATTN_MAX_NUM_SPLITS_FOR_CUDA_GRAPH": lambda: int(
        os.getenv("VLLM_FLASH_ATTN_MAX_NUM_SPLITS_FOR_CUDA_GRAPH", "32")
    ),
967
968
969
    # 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.
970
971
972
    "VLLM_RAY_PER_WORKER_GPUS": lambda: float(
        os.getenv("VLLM_RAY_PER_WORKER_GPUS", "1.0")
    ),
973
974
975
    # 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"
976
    "VLLM_RAY_BUNDLE_INDICES": lambda: os.getenv("VLLM_RAY_BUNDLE_INDICES", ""),
977
978
    # In some system, find_loaded_library() may not work. So we allow users to
    # specify the path through environment variable VLLM_CUDART_SO_PATH.
979
    "VLLM_CUDART_SO_PATH": lambda: os.getenv("VLLM_CUDART_SO_PATH", None),
980
    # Rank of the process in the data parallel setting
981
    "VLLM_DP_RANK": lambda: int(os.getenv("VLLM_DP_RANK", "0")),
982
983
    # Rank of the process in the data parallel setting.
    # Defaults to VLLM_DP_RANK when not set.
984
985
986
    "VLLM_DP_RANK_LOCAL": lambda: int(
        os.getenv("VLLM_DP_RANK_LOCAL", sys.modules[__name__].VLLM_DP_RANK)
    ),
987
    # World size of the data parallel setting
988
    "VLLM_DP_SIZE": lambda: int(os.getenv("VLLM_DP_SIZE", "1")),
989
    # IP address of the master node in the data parallel setting
990
    "VLLM_DP_MASTER_IP": lambda: os.getenv("VLLM_DP_MASTER_IP", "127.0.0.1"),
991
    # Port of the master node in the data parallel setting
992
    "VLLM_DP_MASTER_PORT": lambda: int(os.getenv("VLLM_DP_MASTER_PORT", "0")),
993
994
995
996
997
    # 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.
998
    "VLLM_MOE_DP_CHUNK_SIZE": lambda: int(os.getenv("VLLM_MOE_DP_CHUNK_SIZE", "256")),
999
    # Randomize inputs during dummy runs when using Data Parallel
1000
1001
1002
1003
    "VLLM_RANDOMIZE_DP_DUMMY_INPUTS": lambda: os.environ.get(
        "VLLM_RANDOMIZE_DP_DUMMY_INPUTS", "0"
    )
    == "1",
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
    # 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"
    ),
1015
    # Whether to use S3 path for model loading in CI via RunAI Streamer
1016
    "VLLM_CI_USE_S3": lambda: os.environ.get("VLLM_CI_USE_S3", "0") == "1",
1017
    # Use model_redirect to redirect the model name to a local folder.
1018
1019
1020
1021
1022
    # `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
1023
1024
1025
    "VLLM_MODEL_REDIRECT_PATH": lambda: os.environ.get(
        "VLLM_MODEL_REDIRECT_PATH", None
    ),
1026
    # Whether to use atomicAdd reduce in gptq/awq marlin kernel.
1027
1028
1029
1030
    "VLLM_MARLIN_USE_ATOMIC_ADD": lambda: os.environ.get(
        "VLLM_MARLIN_USE_ATOMIC_ADD", "0"
    )
    == "1",
1031
    # Whether to use marlin kernel in mxfp4 quantization method
1032
1033
1034
    "VLLM_MXFP4_USE_MARLIN": lambda: maybe_convert_bool(
        os.environ.get("VLLM_MXFP4_USE_MARLIN", None)
    ),
1035
1036
1037
    # 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.
1038
1039
1040
1041
    "VLLM_V0_USE_OUTLINES_CACHE": lambda: os.environ.get(
        "VLLM_V0_USE_OUTLINES_CACHE", "0"
    )
    == "1",
1042
1043
1044
    # 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.
1045
1046
1047
1048
    "VLLM_V1_USE_OUTLINES_CACHE": lambda: os.environ.get(
        "VLLM_V1_USE_OUTLINES_CACHE", "0"
    )
    == "1",
1049
1050
    # Gap between padding buckets for the forward pass. So we have
    # 8, we will run forward pass with [16, 24, 32, ...].
1051
1052
1053
1054
1055
1056
1057
1058
    "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)
    ),
1059
    # Whether using Pathways
1060
1061
1062
    "VLLM_TPU_USING_PATHWAYS": lambda: bool(
        "proxy" in os.getenv("JAX_PLATFORMS", "").lower()
    ),
1063
    # Allow use of DeepGemm kernels for fused moe ops.
1064
    "VLLM_USE_DEEP_GEMM": lambda: bool(int(os.getenv("VLLM_USE_DEEP_GEMM", "1"))),
1065
    # Whether to use E8M0 scaling when DeepGEMM is used on Blackwell GPUs.
1066
1067
1068
    "VLLM_USE_DEEP_GEMM_E8M0": lambda: bool(
        int(os.getenv("VLLM_USE_DEEP_GEMM_E8M0", "1"))
    ),
1069
1070
1071
1072
1073
    # 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.
    # Set `VLLM_SKIP_DEEP_GEMM_WARMUP` to disable the warmup.
1074
1075
1076
    "VLLM_SKIP_DEEP_GEMM_WARMUP": lambda: bool(
        int(os.getenv("VLLM_SKIP_DEEP_GEMM_WARMUP", "0"))
    ),
1077
    # Whether to use fused grouped_topk used for MoE expert selection.
1078
1079
1080
    "VLLM_USE_FUSED_MOE_GROUPED_TOPK": lambda: bool(
        int(os.getenv("VLLM_USE_FUSED_MOE_GROUPED_TOPK", "1"))
    ),
1081
    # Allow use of FlashInfer MoE kernels for fused moe ops.
1082
1083
1084
    "VLLM_USE_FLASHINFER_MOE_FP16": lambda: bool(
        int(os.getenv("VLLM_USE_FLASHINFER_MOE_FP16", "0"))
    ),
1085
    # Allow use of FlashInfer MoE kernels for fused moe ops.
1086
1087
1088
    "VLLM_USE_FLASHINFER_MOE_FP8": lambda: bool(
        int(os.getenv("VLLM_USE_FLASHINFER_MOE_FP8", "0"))
    ),
1089
    # Allow use of FlashInfer CUTLASS kernels for fused moe ops.
1090
1091
1092
    "VLLM_USE_FLASHINFER_MOE_FP4": lambda: bool(
        int(os.getenv("VLLM_USE_FLASHINFER_MOE_FP4", "0"))
    ),
1093
1094
    # If set to 1, use the FlashInfer
    # MXFP8 (activation) x MXFP4 (weight) MoE backend.
1095
1096
1097
    "VLLM_USE_FLASHINFER_MOE_MXFP4_MXFP8": lambda: bool(
        int(os.getenv("VLLM_USE_FLASHINFER_MOE_MXFP4_MXFP8", "0"))
    ),
1098
1099
1100
1101
    # 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.
1102
1103
1104
    "VLLM_USE_FLASHINFER_MOE_MXFP4_MXFP8_CUTLASS": lambda: bool(
        int(os.getenv("VLLM_USE_FLASHINFER_MOE_MXFP4_MXFP8_CUTLASS", "0"))
    ),
1105
1106
    # If set to 1, use the FlashInfer
    # BF16 (activation) x MXFP4 (weight) MoE backend.
1107
1108
1109
    "VLLM_USE_FLASHINFER_MOE_MXFP4_BF16": lambda: bool(
        int(os.getenv("VLLM_USE_FLASHINFER_MOE_MXFP4_BF16", "0"))
    ),
1110
1111
1112
    # 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.
1113
    "VLLM_XGRAMMAR_CACHE_MB": lambda: int(os.getenv("VLLM_XGRAMMAR_CACHE_MB", "512")),
1114
1115
1116
1117
1118
1119
1120
    # 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.
1121
1122
1123
    "VLLM_MSGPACK_ZERO_COPY_THRESHOLD": lambda: int(
        os.getenv("VLLM_MSGPACK_ZERO_COPY_THRESHOLD", "256")
    ),
1124
1125
1126
    # 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.
1127
1128
1129
    "VLLM_ALLOW_INSECURE_SERIALIZATION": lambda: bool(
        int(os.getenv("VLLM_ALLOW_INSECURE_SERIALIZATION", "0"))
    ),
Robert Shaw's avatar
Robert Shaw committed
1130
    # IP address used for NIXL handshake between remote agents.
1131
1132
1133
    "VLLM_NIXL_SIDE_CHANNEL_HOST": lambda: os.getenv(
        "VLLM_NIXL_SIDE_CHANNEL_HOST", "localhost"
    ),
Robert Shaw's avatar
Robert Shaw committed
1134
    # Port used for NIXL handshake between remote agents.
1135
1136
1137
    "VLLM_NIXL_SIDE_CHANNEL_PORT": lambda: int(
        os.getenv("VLLM_NIXL_SIDE_CHANNEL_PORT", "5600")
    ),
1138
    # all2all backend for vllm's expert parallel communication
1139
    # Available options:
1140
1141
1142
    # - "naive": naive all2all implementation using broadcasts
    # - "allgather_reducescatter": all2all implementation based on allgather and
    #  reducescatter
1143
    # - "pplx": use pplx kernels
1144
1145
    # - "deepep_high_throughput", use deepep high-throughput kernels
    # - "deepep_low_latency", use deepep low-latency kernels
1146
    # - "flashinfer_all2allv", use flashinfer alltoallv kernels for mnnvl
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
    "VLLM_ALL2ALL_BACKEND": env_with_choices(
        "VLLM_ALL2ALL_BACKEND",
        "allgather_reducescatter",
        [
            "naive",
            "pplx",
            "deepep_high_throughput",
            "deepep_low_latency",
            "allgather_reducescatter",
            "flashinfer_all2allv",
        ],
    ),
1159
1160
    # Flashinfer MoE backend for vLLM's fused Mixture-of-Experts support.
    # Both require compute capability 10.0 or above.
1161
1162
1163
1164
1165
    # Available options:
    # - "throughput":  [default]
    #     Uses CUTLASS kernels optimized for high-throughput batch inference.
    # - "latency":
    #     Uses TensorRT-LLM kernels optimized for low-latency inference.
1166
1167
1168
    "VLLM_FLASHINFER_MOE_BACKEND": env_with_choices(
        "VLLM_FLASHINFER_MOE_BACKEND", "throughput", ["throughput", "latency"]
    ),
1169
1170
1171
1172
    # 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.
1173
1174
1175
    "VLLM_MAX_TOKENS_PER_EXPERT_FP4_MOE": lambda: int(
        os.getenv("VLLM_MAX_TOKENS_PER_EXPERT_FP4_MOE", "163840")
    ),
1176
1177
1178
1179
    # 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> }
1180
    # Unspecified world sizes will fall back to
1181
    #     { 2: 64, 4: 1, <everything else>: 0.5 }
1182
1183
1184
    "VLLM_FLASHINFER_ALLREDUCE_FUSION_THRESHOLDS_MB": lambda: json.loads(
        os.getenv("VLLM_FLASHINFER_ALLREDUCE_FUSION_THRESHOLDS_MB", "{}")
    ),
1185
1186
1187
1188
1189
1190
    # 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
1191
1192
1193
    "VLLM_MOE_ROUTING_SIMULATION_STRATEGY": lambda: os.environ.get(
        "VLLM_MOE_ROUTING_SIMULATION_STRATEGY", ""
    ).lower(),
1194
    # Regex timeout for use by the vLLM tool parsing plugins.
1195
1196
1197
    "VLLM_TOOL_PARSE_REGEX_TIMEOUT_SECONDS": lambda: int(
        os.getenv("VLLM_TOOL_PARSE_REGEX_TIMEOUT_SECONDS", "1")
    ),
1198
1199
    # Reduce CPU usage when vLLM is idle. Enabling this will incur small
    # latency penalty when a request eventually comes.
1200
    "VLLM_SLEEP_WHEN_IDLE": lambda: bool(int(os.getenv("VLLM_SLEEP_WHEN_IDLE", "0"))),
1201
1202
1203
    # 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.
1204
1205
1206
    "VLLM_MQ_MAX_CHUNK_BYTES_MB": lambda: int(
        os.getenv("VLLM_MQ_MAX_CHUNK_BYTES_MB", "16")
    ),
1207
1208
    # Timeout in seconds for execute_model RPC calls in multiprocessing
    # executor (only applies when TP > 1).
1209
1210
1211
    "VLLM_EXECUTE_MODEL_TIMEOUT_SECONDS": lambda: int(
        os.getenv("VLLM_EXECUTE_MODEL_TIMEOUT_SECONDS", "300")
    ),
1212
1213
1214
1215
1216
1217
1218
    # 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.
1219
1220
1221
    "VLLM_KV_CACHE_LAYOUT": env_with_choices(
        "VLLM_KV_CACHE_LAYOUT", None, ["NHD", "HND"]
    ),
1222
1223
1224
    # 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.
1225
1226
1227
    "VLLM_COMPUTE_NANS_IN_LOGITS": lambda: bool(
        int(os.getenv("VLLM_COMPUTE_NANS_IN_LOGITS", "0"))
    ),
1228
1229
1230
    # Controls whether or not emulations are used for NVFP4
    # generations on machines < 100 for compressed-tensors
    # models
1231
1232
1233
    "VLLM_USE_NVFP4_CT_EMULATIONS": lambda: bool(
        int(os.getenv("VLLM_USE_NVFP4_CT_EMULATIONS", "0"))
    ),
1234
1235
1236
1237
    # 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.
1238
1239
1240
    "VLLM_NIXL_ABORT_REQUEST_TIMEOUT": lambda: int(
        os.getenv("VLLM_NIXL_ABORT_REQUEST_TIMEOUT", "480")
    ),
1241
    # Controls whether or not to use cudnn prefill
1242
1243
1244
    "VLLM_USE_CUDNN_PREFILL": lambda: bool(
        int(os.getenv("VLLM_USE_CUDNN_PREFILL", "0"))
    ),
1245
1246
1247
    # 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.
1248
1249
1250
1251
1252
    "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")
    ),
1253
    # If set to 1, when we use fp8 kv, we do not quantize Q to fp8
1254
1255
1256
    "VLLM_FLASHINFER_DISABLE_Q_QUANTIZATION": lambda: bool(
        int(os.getenv("VLLM_FLASHINFER_DISABLE_Q_QUANTIZATION", "0"))
    ),
1257
1258
    # If set, it means we pre-downloaded cubin files and flashinfer will
    # read the cubin files directly.
1259
    "VLLM_HAS_FLASHINFER_CUBIN": lambda: os.getenv("VLLM_HAS_FLASHINFER_CUBIN", False),
1260
1261
1262
    # 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.
1263
1264
1265
    "VLLM_USE_TRTLLM_FP4_GEMM": lambda: bool(
        int(os.getenv("VLLM_USE_TRTLLM_FP4_GEMM", "0"))
    ),
1266
1267
1268
    # 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.
1269
1270
1271
    "VLLM_ENABLE_CUDAGRAPH_GC": lambda: bool(
        int(os.getenv("VLLM_ENABLE_CUDAGRAPH_GC", "0"))
    ),
1272
1273
1274
    # 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.
1275
1276
1277
    "VLLM_DISABLE_PAD_FOR_CUDAGRAPH": lambda: bool(
        int(os.getenv("VLLM_DISABLE_PAD_FOR_CUDAGRAPH", "0"))
    ),
1278
    # Used to force set up loopback IP
1279
    "VLLM_LOOPBACK_IP": lambda: os.getenv("VLLM_LOOPBACK_IP", ""),
1280
1281
1282
    # Used to set the process name prefix for vLLM processes.
    # This is useful for debugging and monitoring purposes.
    # The default value is "VLLM".
1283
    "VLLM_PROCESS_NAME_PREFIX": lambda: os.getenv("VLLM_PROCESS_NAME_PREFIX", "VLLM"),
1284
1285
1286
1287
1288
1289
1290
    # 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.
1291
1292
1293
    "VLLM_ALLOW_CHUNKED_LOCAL_ATTN_WITH_HYBRID_KV_CACHE": lambda: bool(
        int(os.getenv("VLLM_ALLOW_CHUNKED_LOCAL_ATTN_WITH_HYBRID_KV_CACHE", "0"))
    ),
1294
1295
    # 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
1296
1297
    # messages for those requests in memory. By default, this is disabled (0),
    # and the "store" option is ignored.
1298
1299
1300
1301
1302
    # 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.
1303
1304
1305
    "VLLM_ENABLE_RESPONSES_API_STORE": lambda: bool(
        int(os.getenv("VLLM_ENABLE_RESPONSES_API_STORE", "0"))
    ),
xiao-llm's avatar
xiao-llm committed
1306
    # If set, use the fp8 mfma in rocm paged attention.
1307
1308
1309
    "VLLM_ROCM_FP8_MFMA_PAGE_ATTN": lambda: bool(
        int(os.getenv("VLLM_ROCM_FP8_MFMA_PAGE_ATTN", "0"))
    ),
1310
    # Whether to use pytorch symmetric memory for allreduce
1311
1312
1313
    "VLLM_ALLREDUCE_USE_SYMM_MEM": lambda: bool(
        int(os.getenv("VLLM_ALLREDUCE_USE_SYMM_MEM", "1"))
    ),
1314
    # Allows vllm to find tuned config under customized folder
1315
    "VLLM_TUNED_CONFIG_FOLDER": lambda: os.getenv("VLLM_TUNED_CONFIG_FOLDER", None),
1316
    # Allows harmony instructions to be injected on system messages
1317
1318
1319
    "VLLM_GPT_OSS_HARMONY_SYSTEM_INSTRUCTIONS": lambda: bool(
        int(os.getenv("VLLM_GPT_OSS_HARMONY_SYSTEM_INSTRUCTIONS", "0"))
    ),
1320
    # Add optional custom scopes for profiling, disable to avoid overheads
1321
1322
1323
    "VLLM_CUSTOM_SCOPES_FOR_PROFILING": lambda: bool(
        int(os.getenv("VLLM_CUSTOM_SCOPES_FOR_PROFILING", "0"))
    ),
1324
    # Add optional nvtx scopes for profiling, disable to avoid overheads
1325
1326
1327
    "VLLM_NVTX_SCOPES_FOR_PROFILING": lambda: bool(
        int(os.getenv("VLLM_NVTX_SCOPES_FOR_PROFILING", "0"))
    ),
1328
1329
    # Represent block hashes in KV cache events as 64-bit integers instead of
    # raw bytes. Defaults to True for backward compatibility.
1330
1331
1332
    "VLLM_KV_EVENTS_USE_INT_BLOCK_HASHES": lambda: bool(
        int(os.getenv("VLLM_KV_EVENTS_USE_INT_BLOCK_HASHES", "1"))
    ),
1333
1334
    # Name of the shared memory buffer used for object storage.
    # Only effective when mm_config.mm_processor_cache_type == "shm".
1335
1336
1337
    "VLLM_OBJECT_STORAGE_SHM_BUFFER_NAME": lambda: os.getenv(
        "VLLM_OBJECT_STORAGE_SHM_BUFFER_NAME", "VLLM_OBJECT_STORAGE_SHM_BUFFER"
    ),
1338
    # The size in MB of the buffers (NVL and RDMA) used by DeepEP
1339
1340
1341
    "VLLM_DEEPEP_BUFFER_SIZE_MB": lambda: int(
        os.getenv("VLLM_DEEPEP_BUFFER_SIZE_MB", "1024")
    ),
1342
1343
    # 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
1344
    "VLLM_DBO_COMM_SMS": lambda: int(os.getenv("VLLM_DBO_COMM_SMS", "20")),
1345
1346
    # Valid values are container,code_interpreter,web_search_preview
    # ex GPT_OSS_SYSTEM_TOOL_MCP_LABELS=container,code_interpreter
1347
1348
1349
1350
1351
    "GPT_OSS_SYSTEM_TOOL_MCP_LABELS": env_list_with_choices(
        "GPT_OSS_SYSTEM_TOOL_MCP_LABELS",
        [],
        ["container", "code_interpreter", "web_search_preview"],
    ),
1352
1353
1354
    # 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)
1355
1356
1357
    "VLLM_ENABLE_INDUCTOR_MAX_AUTOTUNE": lambda: bool(
        int(os.getenv("VLLM_ENABLE_INDUCTOR_MAX_AUTOTUNE", "1"))
    ),
1358
1359
    # If set to 1, enable coordinate_descent_tuning;
    # By default, this is enabled (1)
1360
1361
1362
    "VLLM_ENABLE_INDUCTOR_COORDINATE_DESCENT_TUNING": lambda: bool(
        int(os.getenv("VLLM_ENABLE_INDUCTOR_COORDINATE_DESCENT_TUNING", "1"))
    ),
1363
    # Flag to enable NCCL symmetric memory allocation and registration
1364
1365
1366
    "VLLM_USE_NCCL_SYMM_MEM": lambda: bool(
        int(os.getenv("VLLM_USE_NCCL_SYMM_MEM", "0"))
    ),
1367
    # NCCL header path
1368
    "VLLM_NCCL_INCLUDE_PATH": lambda: os.environ.get("VLLM_NCCL_INCLUDE_PATH", None),
1369
1370
    # Flag to enable FBGemm kernels on model execution
    "VLLM_USE_FBGEMM": lambda: bool(int(os.getenv("VLLM_USE_FBGEMM", "0"))),
1371
1372
1373
1374
1375
1376
    # 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", ""),
1377
1378
}

1379
# --8<-- [end:env-vars-definition]
1380

1381

1382
def __getattr__(name: str):
1383
1384
1385
1386
1387
1388
1389
1390
    # 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())
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404


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 "
1405
1406
            "Issue and explicitly set VLLM_USE_V1=0 or 1."
        )
1407
    os.environ["VLLM_USE_V1"] = "1" if use_v1 else "0"
1408
1409
1410
1411
1412
1413
1414
1415


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
1416
    graphs, so it is included in the factors list. The env vars that
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
    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",
1428
        "VLLM_FLASH_ATTN_MAX_NUM_SPLITS_FOR_CUDA_GRAPH",
1429
1430
1431
1432
        "VLLM_USE_TRITON_FLASH_ATTN",
        "VLLM_USE_TRITON_AWQ",
        "VLLM_DP_RANK",
        "VLLM_DP_SIZE",
1433
        "VLLM_USE_STANDALONE_COMPILE",
1434
        "VLLM_FUSED_MOE_CHUNK_SIZE",
1435
1436
1437
1438
1439
1440
        "VLLM_FLASHINFER_MOE_BACKEND",
        "VLLM_V1_USE_PREFILL_DECODE_ATTENTION",
        "VLLM_ATTENTION_BACKEND",
        "VLLM_USE_FLASHINFER_SAMPLER",
        "VLLM_DISABLED_KERNELS",
        "VLLM_USE_DEEP_GEMM",
1441
        "VLLM_USE_DEEP_GEMM_E8M0",
1442
        "VLLM_USE_TRTLLM_FP4_GEMM",
1443
        "VLLM_USE_FUSED_MOE_GROUPED_TOPK",
1444
        "VLLM_USE_FLASHINFER_MOE_FP16",
1445
1446
1447
        "VLLM_USE_FLASHINFER_MOE_FP8",
        "VLLM_USE_FLASHINFER_MOE_FP4",
        "VLLM_USE_FLASHINFER_MOE_MXFP4_MXFP8",
1448
        "VLLM_USE_FLASHINFER_MOE_MXFP4_MXFP8_CUTLASS",
1449
1450
1451
        "VLLM_USE_FLASHINFER_MOE_MXFP4_BF16",
        "VLLM_USE_CUDNN_PREFILL",
        "VLLM_USE_TRTLLM_ATTENTION",
1452
        "VLLM_FLASHINFER_DISABLE_Q_QUANTIZATION",
1453
1454
1455
1456
1457
1458
1459
        "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",
1460
1461
        "VLLM_ROCM_USE_AITER_FP4_ASM_GEMM",
        "VLLM_ROCM_USE_TRITON_ROPE",
1462
        "VLLM_ROCM_USE_AITER_FP8BMM",
1463
        "VLLM_ROCM_USE_AITER_UNIFIED_ATTENTION",
1464
1465
1466
1467
1468
1469
1470
        "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
1471
        "VLLM_ROCM_FP8_MFMA_PAGE_ATTN",
1472
1473
        "VLLM_ENABLE_INDUCTOR_MAX_AUTOTUNE",
        "VLLM_ENABLE_INDUCTOR_COORDINATE_DESCENT_TUNING",
1474
        "VLLM_USE_FBGEMM",
1475
1476
    ]
    for key in environment_variables_to_hash:
1477
1478
        # if this goes out of sync with environment_variables,
        # it's not a user error, it's a bug
1479
        assert key in environment_variables, (
1480
            "Please update environment_variables_to_hash in envs.py"
1481
        )
1482

1483
    factors = [environment_variables[key]() for key in environment_variables_to_hash]
1484

1485
    hash_str = hashlib.md5(str(factors).encode(), usedforsecurity=False).hexdigest()
1486
1487

    return hash_str