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

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

if TYPE_CHECKING:
    VLLM_HOST_IP: str = ""
15
    VLLM_PORT: int | None = None
16
    VLLM_RPC_BASE_PATH: str = tempfile.gettempdir()
17
    VLLM_USE_MODELSCOPE: bool = False
18
    VLLM_RINGBUFFER_WARNING_INTERVAL: int = 60
19
20
    VLLM_NCCL_SO_PATH: str | None = None
    LD_LIBRARY_PATH: str | None = None
21
    VLLM_ROCM_SLEEP_MEM_CHUNK_SIZE: int = 256
22
    VLLM_V1_USE_PREFILL_DECODE_ATTENTION: bool = False
23
    VLLM_FLASH_ATTN_VERSION: int | None = None
24
    LOCAL_RANK: int = 0
25
    CUDA_VISIBLE_DEVICES: str | None = None
26
    VLLM_ENGINE_ITERATION_TIMEOUT_S: int = 60
27
    VLLM_API_KEY: str | None = None
28
    VLLM_DEBUG_LOG_API_SERVER_RESPONSE: bool = False
29
30
31
32
    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
33
34
    VLLM_CACHE_ROOT: str = os.path.expanduser("~/.cache/vllm")
    VLLM_CONFIG_ROOT: str = os.path.expanduser("~/.config/vllm")
35
36
    VLLM_USAGE_STATS_SERVER: str = "https://stats.vllm.ai"
    VLLM_NO_USAGE_STATS: bool = False
37
    VLLM_DISABLE_FLASHINFER_PREFILL: bool = False
38
39
40
    VLLM_DO_NOT_TRACK: bool = False
    VLLM_USAGE_SOURCE: str = ""
    VLLM_CONFIGURE_LOGGING: int = 1
41
    VLLM_LOGGING_LEVEL: str = "INFO"
42
    VLLM_LOGGING_PREFIX: str = ""
43
    VLLM_LOGGING_STREAM: str = "ext://sys.stdout"
44
    VLLM_LOGGING_CONFIG_PATH: str | None = None
Nick Hill's avatar
Nick Hill committed
45
46
    VLLM_LOGGING_COLOR: str = "auto"
    NO_COLOR: bool = False
47
    VLLM_LOG_STATS_INTERVAL: float = 10.0
48
    VLLM_TRACE_FUNCTION: int = 0
49
50
51
52
    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
53
    VLLM_CPU_OMP_THREADS_BIND: str = ""
54
    VLLM_CPU_NUM_OF_RESERVED_CPU: int | None = None
55
    VLLM_CPU_SGL_KERNEL: bool = False
56
    VLLM_XLA_CACHE_PATH: str = os.path.join(VLLM_CACHE_ROOT, "xla_cache")
57
    VLLM_XLA_CHECK_RECOMPILATION: bool = False
58
    VLLM_FUSED_MOE_CHUNK_SIZE: int = 16 * 1024
59
    VLLM_ENABLE_FUSED_MOE_ACTIVATION_CHUNKING: bool = True
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"] = "spawn"
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_MEDIA_CONNECTOR: str = "http"
75
    VLLM_MM_INPUT_CACHE_GIB: int = 4
76
    VLLM_TARGET_DEVICE: str = "cuda"
77
    VLLM_MAIN_CUDA_VERSION: str = "12.9"
78
79
    MAX_JOBS: str | None = None
    NVCC_THREADS: str | None = None
80
    VLLM_USE_PRECOMPILED: bool = False
81
    VLLM_DOCKER_BUILD_CONTEXT: bool = False
82
    VLLM_TEST_USE_PRECOMPILED_NIGHTLY_WHEEL: bool = False
83
    VLLM_KEEP_ALIVE_ON_ENGINE_DEATH: bool = False
84
    CMAKE_BUILD_TYPE: Literal["Debug", "Release", "RelWithDebInfo"] | None = None
85
    VERBOSE: bool = False
86
    VLLM_ALLOW_LONG_MAX_MODEL_LEN: bool = False
87
    VLLM_RPC_TIMEOUT: int = 10000  # ms
88
    VLLM_HTTP_TIMEOUT_KEEP_ALIVE: int = 5  # seconds
89
90
    VLLM_PLUGINS: list[str] | None = None
    VLLM_LORA_RESOLVER_CACHE_DIR: str | None = None
91
    VLLM_TORCH_CUDA_PROFILE: bool = False
92
    VLLM_TORCH_PROFILER_DIR: str | None = None
93
94
    VLLM_TORCH_PROFILER_RECORD_SHAPES: bool = False
    VLLM_TORCH_PROFILER_WITH_PROFILE_MEMORY: bool = False
95
    VLLM_TORCH_PROFILER_DISABLE_ASYNC_LLM: bool = False
96
    VLLM_USE_AOT_COMPILE: bool = False
97
    VLLM_USE_BYTECODE_HOOK: bool = False
98
    VLLM_FORCE_AOT_LOAD: bool = False
99
100
    VLLM_TORCH_PROFILER_WITH_STACK: bool = True
    VLLM_TORCH_PROFILER_WITH_FLOPS: bool = False
101
102
    VLLM_PROFILER_DELAY_ITERS: int = 0
    VLLM_PROFILER_MAX_ITERS: int = 0
103
104
    VLLM_TORCH_PROFILER_USE_GZIP: bool = True
    VLLM_TORCH_PROFILER_DUMP_CUDA_TIME_TOTAL: bool = True
105
    VLLM_USE_TRITON_AWQ: bool = False
106
    VLLM_ALLOW_RUNTIME_LORA_UPDATING: bool = False
107
    VLLM_SKIP_P2P_CHECK: bool = False
108
    VLLM_DISABLED_KERNELS: list[str] = []
109
    VLLM_DISABLE_PYNCCL: bool = False
110
    VLLM_ROCM_USE_AITER: bool = False
111
    VLLM_ROCM_USE_AITER_PAGED_ATTN: bool = False
112
    VLLM_ROCM_USE_AITER_LINEAR: bool = True
113
    VLLM_ROCM_USE_AITER_MOE: bool = True
114
    VLLM_ROCM_USE_AITER_RMSNORM: bool = True
115
    VLLM_ROCM_USE_AITER_MLA: bool = True
116
    VLLM_ROCM_USE_AITER_MHA: bool = True
117
    VLLM_ROCM_USE_AITER_FP4_ASM_GEMM: bool = False
118
    VLLM_ROCM_USE_AITER_TRITON_ROPE: bool = False
119
    VLLM_ROCM_USE_AITER_FP8BMM: bool = True
120
    VLLM_ROCM_USE_AITER_UNIFIED_ATTENTION: bool = False
121
    VLLM_ROCM_USE_AITER_FUSION_SHARED_EXPERTS: bool = False
122
    VLLM_ROCM_USE_AITER_TRITON_GEMM: bool = True
123
    VLLM_ROCM_USE_SKINNY_GEMM: bool = True
124
    VLLM_ROCM_FP8_PADDING: bool = True
125
    VLLM_ROCM_MOE_PADDING: bool = True
126
    VLLM_ROCM_CUSTOM_PAGED_ATTN: bool = True
127
    VLLM_ENABLE_V1_MULTIPROCESSING: bool = True
128
    VLLM_LOG_BATCHSIZE_INTERVAL: float = -1
129
    VLLM_DISABLE_COMPILE_CACHE: bool = False
130
    Q_SCALE_CONSTANT: int = 200
131
132
    K_SCALE_CONSTANT: int = 200
    V_SCALE_CONSTANT: int = 100
133
    VLLM_SERVER_DEV_MODE: bool = False
134
    VLLM_V1_OUTPUT_PROC_CHUNK_SIZE: int = 128
135
    VLLM_MLA_DISABLE: bool = False
136
    VLLM_FLASH_ATTN_MAX_NUM_SPLITS_FOR_CUDA_GRAPH: int = 32
137
138
    VLLM_RAY_PER_WORKER_GPUS: float = 1.0
    VLLM_RAY_BUNDLE_INDICES: str = ""
139
    VLLM_CUDART_SO_PATH: str | None = None
140
    VLLM_DP_RANK: int = 0
141
    VLLM_DP_RANK_LOCAL: int = -1
142
    VLLM_DP_SIZE: int = 1
143
    VLLM_USE_STANDALONE_COMPILE: bool = True
144
145
    VLLM_DP_MASTER_IP: str = ""
    VLLM_DP_MASTER_PORT: int = 0
146
    VLLM_MOE_DP_CHUNK_SIZE: int = 256
147
    VLLM_RANDOMIZE_DP_DUMMY_INPUTS: bool = False
148
    VLLM_RAY_DP_PACK_STRATEGY: Literal["strict", "fill", "span"] = "strict"
149
    VLLM_MARLIN_USE_ATOMIC_ADD: bool = False
150
    VLLM_MARLIN_INPUT_DTYPE: Literal["int8", "fp8"] | None = None
151
    VLLM_MXFP4_USE_MARLIN: bool | None = None
152
    VLLM_DEEPEPLL_NVFP4_DISPATCH: bool = False
153
    VLLM_V1_USE_OUTLINES_CACHE: bool = False
154
    VLLM_TPU_BUCKET_PADDING_GAP: int = 0
155
    VLLM_TPU_MOST_MODEL_LEN: int | None = None
156
    VLLM_TPU_USING_PATHWAYS: bool = False
157
    VLLM_USE_DEEP_GEMM: bool = True
158
    VLLM_MOE_USE_DEEP_GEMM: bool = True
159
    VLLM_USE_DEEP_GEMM_E8M0: bool = True
160
161
162
163
164
    VLLM_DEEP_GEMM_WARMUP: Literal[
        "skip",
        "full",
        "relax",
    ] = "relax"
165
    VLLM_USE_FUSED_MOE_GROUPED_TOPK: bool = True
166
    VLLM_USE_FLASHINFER_MOE_FP16: bool = False
167
168
    VLLM_USE_FLASHINFER_MOE_FP8: bool = False
    VLLM_USE_FLASHINFER_MOE_FP4: bool = False
169
170
171
    VLLM_FLASHINFER_MOE_BACKEND: Literal["throughput", "latency", "masked_gemm"] = (
        "latency"
    )
172
    VLLM_FLASHINFER_WORKSPACE_BUFFER_SIZE: int = 394 * 1024 * 1024
173
    VLLM_XGRAMMAR_CACHE_MB: int = 0
174
    VLLM_MSGPACK_ZERO_COPY_THRESHOLD: int = 256
175
    VLLM_ALLOW_INSECURE_SERIALIZATION: bool = False
Robert Shaw's avatar
Robert Shaw committed
176
    VLLM_NIXL_SIDE_CHANNEL_HOST: str = "localhost"
177
    VLLM_NIXL_SIDE_CHANNEL_PORT: int = 5600
178
179
180
181
182
183
184
185
    VLLM_ALL2ALL_BACKEND: Literal[
        "naive",
        "pplx",
        "deepep_high_throughput",
        "deepep_low_latency",
        "allgather_reducescatter",
        "flashinfer_all2allv",
    ] = "allgather_reducescatter"
186
    VLLM_MAX_TOKENS_PER_EXPERT_FP4_MOE: int = 163840
187
    VLLM_TOOL_PARSE_REGEX_TIMEOUT_SECONDS: int = 1
188
    VLLM_SLEEP_WHEN_IDLE: bool = False
189
    VLLM_MQ_MAX_CHUNK_BYTES_MB: int = 16
190
    VLLM_EXECUTE_MODEL_TIMEOUT_SECONDS: int = 300
191
    VLLM_KV_CACHE_LAYOUT: Literal["NHD", "HND"] | None = None
192
    VLLM_COMPUTE_NANS_IN_LOGITS: bool = False
193
    VLLM_USE_NVFP4_CT_EMULATIONS: bool = False
194
195
196
    VLLM_ROCM_QUICK_REDUCE_QUANTIZATION: Literal[
        "FP", "INT8", "INT6", "INT4", "NONE"
    ] = "NONE"
197
    VLLM_ROCM_QUICK_REDUCE_CAST_BF16_TO_FP16: bool = True
198
    VLLM_ROCM_QUICK_REDUCE_MAX_SIZE_BYTES_MB: int | None = None
199
    VLLM_NIXL_ABORT_REQUEST_TIMEOUT: int = 480
200
    VLLM_USE_CUDNN_PREFILL: bool = False
201
    VLLM_USE_TRTLLM_RAGGED_DEEPSEEK_PREFILL: bool = False
202
    VLLM_ENABLE_CUDAGRAPH_GC: bool = False
203
    VLLM_LOOPBACK_IP: str = ""
204
    VLLM_ALLOW_CHUNKED_LOCAL_ATTN_WITH_HYBRID_KV_CACHE: bool = False
205
    VLLM_ENABLE_RESPONSES_API_STORE: bool = False
206
    VLLM_USE_TRTLLM_ATTENTION: str | None = None
207
    VLLM_NVFP4_GEMM_BACKEND: str | None = None
208
    VLLM_FLASHINFER_DISABLE_Q_QUANTIZATION: bool = False
209
    VLLM_HAS_FLASHINFER_CUBIN: bool = False
210
211
    VLLM_USE_FLASHINFER_MOE_MXFP4_MXFP8: bool = False
    VLLM_USE_FLASHINFER_MOE_MXFP4_BF16: bool = False
xiao-llm's avatar
xiao-llm committed
212
    VLLM_ROCM_FP8_MFMA_PAGE_ATTN: bool = False
213
    VLLM_USE_FLASHINFER_MOE_MXFP4_MXFP8_CUTLASS: bool = False
214
    VLLM_ALLREDUCE_USE_SYMM_MEM: bool = True
215
    VLLM_TUNED_CONFIG_FOLDER: str | None = None
216
    VLLM_GPT_OSS_SYSTEM_TOOL_MCP_LABELS: set[str] = set()
217
    VLLM_GPT_OSS_HARMONY_SYSTEM_INSTRUCTIONS: bool = False
218
    VLLM_TOOL_JSON_ERROR_AUTOMATIC_RETRY: bool = False
219
    VLLM_CUSTOM_SCOPES_FOR_PROFILING: bool = False
220
    VLLM_NVTX_SCOPES_FOR_PROFILING: bool = False
221
    VLLM_KV_EVENTS_USE_INT_BLOCK_HASHES: bool = True
222
    VLLM_OBJECT_STORAGE_SHM_BUFFER_NAME: str = "VLLM_OBJECT_STORAGE_SHM_BUFFER"
223
    VLLM_DEEPEP_BUFFER_SIZE_MB: int = 1024
224
225
    VLLM_DEEPEP_HIGH_THROUGHPUT_FORCE_INTRA_NODE: bool = False
    VLLM_DEEPEP_LOW_LATENCY_USE_MNNVL: bool = False
226
    VLLM_DBO_COMM_SMS: int = 20
227
228
    VLLM_PATTERN_MATCH_DEBUG: str | None = None
    VLLM_DEBUG_DUMP_PATH: str | None = None
229
230
    VLLM_ENABLE_INDUCTOR_MAX_AUTOTUNE: bool = True
    VLLM_ENABLE_INDUCTOR_COORDINATE_DESCENT_TUNING: bool = True
231
    VLLM_USE_NCCL_SYMM_MEM: bool = False
232
    VLLM_NCCL_INCLUDE_PATH: str | None = None
233
    VLLM_USE_FBGEMM: bool = False
234
    VLLM_GC_DEBUG: str = ""
235
    VLLM_DISABLE_SHARED_EXPERTS_STREAM: bool = False
236
    VLLM_SHARED_EXPERTS_STREAM_TOKEN_THRESHOLD: int = 256
237
    VLLM_COMPILE_CACHE_SAVE_FORMAT: Literal["binary", "unpacked"] = "binary"
Woosuk Kwon's avatar
Woosuk Kwon committed
238
    VLLM_USE_V2_MODEL_RUNNER: bool = False
239
    # add envs
zhuwenwen's avatar
zhuwenwen committed
240
    VLLM_OPTEST_URLS_PORT: int | None = None
241
242
243
244
245
246
    VLLM_OPTEST_MODELS_PATH: str = ""
    VLLM_USE_TRITON_PREFIX_FLASH_ATTN: bool = False
    VLLM_USE_FLASH_MLA: bool = False
    VLLM_USE_OPT_OP: bool = False
    VLLM_USE_TC_PAGED_ATTN: bool = False
    VLLM_USE_PA_PRINT_PARAM: bool = False 
zhuwenwen's avatar
zhuwenwen committed
247
    VLLM_TREE_DECODING: bool = False
248
249
    VLLM_SPEC_DECODE_EAGER: bool = False
    VLLM_PCIE_USE_CUSTOM_ALLREDUCE: bool = False
zhuwenwen's avatar
zhuwenwen committed
250
    VLLM_CUSTOM_ALLREDUCE_SUPPORTED_WORLDSIZE_MAX: int = 16
zhuwenwen's avatar
zhuwenwen committed
251
    VLLM_ENFORCE_EAGER_BS_THRESHOLD: int | None  = None
252
    VLLM_HAS_CONTEXT_DEFAULT: bool = False
253
    VLLM_USE_NN: bool = False
254
    VLLM_ENABLE_TBO: bool = False
255
    VLLM_ENABLE_MOE_FUSED_GATE: bool = False
256
    VLLM_USE_FLASH_ATTN_PA: bool = False
zhuwenwen's avatar
zhuwenwen committed
257
    VLLM_USE_APEX_RN: bool = False
258
    VLLM_USE_GLOBAL_CACHE13: bool = False
259
260
    VLLM_USE_LIGHTOP: bool = False
    VLLM_USE_OPT_CAT: bool = False
zhuwenwen's avatar
zhuwenwen committed
261
262
263
    VLLM_USE_OPT_MOE_SUM: bool = False
    VLLM_USE_LIGHTOP_MOE_SUM: bool = False
    VLLM_USE_LIGHTOP_MOE_ALIGN: bool = False
264
    VLLM_USE_MERGE_ATTN_STATES_OPT: bool = False
265
    USE_FUSED_RMS_QUANT: bool = False
266
    USE_FUSED_SILU_MUL_QUANT: bool = False
zhuwenwen's avatar
zhuwenwen committed
267
    VLLM_USE_PD_SPLIT: bool = False
zhuwenwen's avatar
zhuwenwen committed
268
    VLLM_USE_PP_SYNC: bool = False
269
    VLLM_USE_PIECEWISE: bool = False
270
    VLLM_USE_V32_ENCODE: bool = False
271
272
273
    VLLM_USE_FUSE_SILU_AND_MUL: bool = False
    VLLM_USE_OPT_RESHAPE_AND_CACHE: bool = False
    VLLM_USE_TOPK_RENORM: bool = False
274
275
    VLLM_USE_FUSED_RMS_ROPE: bool = False
    VLLM_USE_MARLIN_W16A16_MOE:bool = False
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291


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


292
def maybe_convert_int(value: str | None) -> int | None:
293
294
295
296
297
    if value is None:
        return None
    return int(value)


298
def maybe_convert_bool(value: str | None) -> bool | None:
299
300
301
302
303
    if value is None:
        return None
    return bool(int(value))


304
305
306
307
def disable_compile_cache() -> bool:
    return bool(int(os.getenv("VLLM_DISABLE_COMPILE_CACHE", "0")))


308
def use_aot_compile() -> bool:
309
310
311
    from vllm.model_executor.layers.batch_invariant import (
        vllm_is_batch_invariant,
    )
312
    from vllm.utils.torch_utils import is_torch_equal_or_newer
313

314
315
316
317
318
319
    default_value = (
        "1"
        if is_torch_equal_or_newer("2.10.0.dev") and not disable_compile_cache()
        else "0"
    )

320
321
322
323
    return (
        not vllm_is_batch_invariant()
        and os.environ.get("VLLM_USE_AOT_COMPILE", default_value) == "1"
    )
324
325


326
def env_with_choices(
327
    env_name: str,
328
329
    default: str | None,
    choices: list[str] | Callable[[], list[str]],
330
    case_sensitive: bool = True,
331
) -> Callable[[], str | None]:
332
333
    """
    Create a lambda that validates environment variable against allowed choices
334

335
336
337
338
339
    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
340

341
342
343
344
    Returns:
        Lambda function for environment_variables dict
    """

345
    def _get_validated_env() -> str | None:
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
        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:
361
362
363
364
            raise ValueError(
                f"Invalid value '{value}' for {env_name}. "
                f"Valid options: {actual_choices}."
            )
365
366
367
368
369
370

        return value

    return _get_validated_env


371
def env_list_with_choices(
372
373
    env_name: str,
    default: list[str],
374
    choices: list[str] | Callable[[], list[str]],
375
376
    case_sensitive: bool = True,
) -> Callable[[], list[str]]:
377
    """
378
    Create a lambda that validates environment variable
379
    containing comma-separated values against allowed choices
380

381
382
383
384
385
    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
386

387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
    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:
416
417
418
419
                raise ValueError(
                    f"Invalid value '{val}' in {env_name}. "
                    f"Valid options: {actual_choices}."
                )
420
421
422
423
424
425

        return values

    return _get_validated_env_list


426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
def env_set_with_choices(
    env_name: str,
    default: list[str],
    choices: list[str] | Callable[[], list[str]],
    case_sensitive: bool = True,
) -> Callable[[], set[str]]:
    """
    Creates a lambda which that validates environment variable
    containing comma-separated values against allowed choices which
    returns choices as a set.
    """

    def _get_validated_env_set() -> set[str]:
        return set(env_list_with_choices(env_name, default, choices, case_sensitive)())

    return _get_validated_env_set


444
def get_vllm_port() -> int | None:
445
    """Get the port from VLLM_PORT environment variable.
446

447
448
    Returns:
        The port number as an integer if VLLM_PORT is set, None otherwise.
449

450
451
452
    Raises:
        ValueError: If VLLM_PORT is a URI, suggest k8s service discovery issue.
    """
453
    if "VLLM_PORT" not in os.environ:
454
455
        return None

456
    port = os.getenv("VLLM_PORT", "0")
457
458
459
460
461

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

463
464
465
466
467
468
469
        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
470
        raise ValueError(f"VLLM_PORT '{port}' must be a valid integer") from err
471
472


Ning Xie's avatar
Ning Xie committed
473
# The start-* and end* here are used by the documentation generator
474
475
# to extract the used env vars.

476
# --8<-- [start:env-vars-definition]
477

478
logger = logging.getLogger(__name__)
479

480
environment_variables: dict[str, Callable[[], Any]] = {
481
    # ================== Installation Time Env Vars ==================
482
    # Target device of vLLM, supporting [cuda (by default),
483
    # rocm, cpu]
484
    "VLLM_TARGET_DEVICE": lambda: os.getenv("VLLM_TARGET_DEVICE", "cuda").lower(),
485
    # Main CUDA version of vLLM. This follows PyTorch but can be overridden.
486
    "VLLM_MAIN_CUDA_VERSION": lambda: os.getenv("VLLM_MAIN_CUDA_VERSION", "").lower()
487
    or "12.9",
488
489
    # Maximum number of compilation jobs to run in parallel.
    # By default this is the number of CPUs
490
    "MAX_JOBS": lambda: os.getenv("MAX_JOBS", None),
491
492
493
    # Number of threads to use for nvcc
    # By default this is 1.
    # If set, `MAX_JOBS` will be reduced to avoid oversubscribing the CPU.
494
    "NVCC_THREADS": lambda: os.getenv("NVCC_THREADS", None),
495
    # If set, vllm will use precompiled binaries (*.so)
496
497
498
499
500
    "VLLM_USE_PRECOMPILED": lambda: os.environ.get("VLLM_USE_PRECOMPILED", "")
    .strip()
    .lower()
    in ("1", "true")
    or bool(os.environ.get("VLLM_PRECOMPILED_WHEEL_LOCATION")),
501
502
    # Used to mark that setup.py is running in a Docker build context,
    # in order to force the use of precompiled binaries.
503
504
505
506
    "VLLM_DOCKER_BUILD_CONTEXT": lambda: os.environ.get("VLLM_DOCKER_BUILD_CONTEXT", "")
    .strip()
    .lower()
    in ("1", "true"),
507
508
    # Whether to force using nightly wheel in python build.
    # This is used for testing the nightly wheel in python build.
509
510
511
    "VLLM_TEST_USE_PRECOMPILED_NIGHTLY_WHEEL": lambda: bool(
        int(os.getenv("VLLM_TEST_USE_PRECOMPILED_NIGHTLY_WHEEL", "0"))
    ),
512
513
514
    # CMake build type
    # If not set, defaults to "Debug" or "RelWithDebInfo"
    # Available options: "Debug", "Release", "RelWithDebInfo"
515
516
517
    "CMAKE_BUILD_TYPE": env_with_choices(
        "CMAKE_BUILD_TYPE", None, ["Debug", "Release", "RelWithDebInfo"]
    ),
518
    # If set, vllm will print verbose logs during installation
519
    "VERBOSE": lambda: bool(int(os.getenv("VERBOSE", "0"))),
520
    # Root directory for vLLM configuration files
521
    # Defaults to `~/.config/vllm` unless `XDG_CONFIG_HOME` is set
522
523
524
    # 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**.
525
    "VLLM_CONFIG_ROOT": lambda: os.path.expanduser(
526
527
528
        os.getenv(
            "VLLM_CONFIG_ROOT",
            os.path.join(get_default_config_root(), "vllm"),
529
530
        )
    ),
531
    # ================== Runtime Env Vars ==================
532
    # Root directory for vLLM cache files
533
    # Defaults to `~/.cache/vllm` unless `XDG_CACHE_HOME` is set
534
    "VLLM_CACHE_ROOT": lambda: os.path.expanduser(
535
536
537
        os.getenv(
            "VLLM_CACHE_ROOT",
            os.path.join(get_default_cache_root(), "vllm"),
538
539
        )
    ),
540
541
542
543
    # 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.
544
    "VLLM_HOST_IP": lambda: os.getenv("VLLM_HOST_IP", ""),
545
    # used in distributed environment to manually set the communication port
546
547
548
    # 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.
549
    "VLLM_PORT": get_vllm_port,
550
551
    # path used for ipc when the frontend api server is running in
    # multi-processing mode to communicate with the backend engine process.
552
553
554
    "VLLM_RPC_BASE_PATH": lambda: os.getenv(
        "VLLM_RPC_BASE_PATH", tempfile.gettempdir()
    ),
555
556
    # If true, will load models from ModelScope instead of Hugging Face Hub.
    # note that the value is true or false, not numbers
557
558
559
560
    "VLLM_USE_MODELSCOPE": lambda: os.environ.get(
        "VLLM_USE_MODELSCOPE", "False"
    ).lower()
    == "true",
561
    # Interval in seconds to log a warning message when the ring buffer is full
562
563
564
    "VLLM_RINGBUFFER_WARNING_INTERVAL": lambda: int(
        os.environ.get("VLLM_RINGBUFFER_WARNING_INTERVAL", "60")
    ),
565
566
    # path to cudatoolkit home directory, under which should be bin, include,
    # and lib directories.
567
    "CUDA_HOME": lambda: os.environ.get("CUDA_HOME", None),
568
569
    # 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
570
    "VLLM_NCCL_SO_PATH": lambda: os.environ.get("VLLM_NCCL_SO_PATH", None),
571
572
    # 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`
573
    "LD_LIBRARY_PATH": lambda: os.environ.get("LD_LIBRARY_PATH", None),
574
575
    # flag to control if vllm should use triton flash attention
    "VLLM_USE_TRITON_FLASH_ATTN":
576
    lambda: (os.environ.get("VLLM_USE_TRITON_FLASH_ATTN", "False").lower() in
577
             ("true", "1")),
578
579
580
581
    # flag to control the chunk size (in MB) for sleeping memory allocations under ROCm
    "VLLM_ROCM_SLEEP_MEM_CHUNK_SIZE": lambda: int(
        os.environ.get("VLLM_ROCM_SLEEP_MEM_CHUNK_SIZE", "256")
    ),
582
583
    # Use separate prefill and decode kernels for V1 attention instead of
    # the unified triton kernel.
584
585
586
587
    "VLLM_V1_USE_PREFILL_DECODE_ATTENTION": lambda: (
        os.getenv("VLLM_V1_USE_PREFILL_DECODE_ATTENTION", "False").lower()
        in ("true", "1")
    ),
588
589
    # Force vllm to use a specific flash-attention version (2 or 3), only valid
    # when using the flash-attention backend.
590
591
592
    "VLLM_FLASH_ATTN_VERSION": lambda: maybe_convert_int(
        os.environ.get("VLLM_FLASH_ATTN_VERSION", None)
    ),
593
    # Feature flag to enable/disable Inductor standalone compile.
594
595
    # In torch <= 2.7 we ignore this flag; in torch >= 2.9 this is
    # enabled by default.
596
    "VLLM_USE_STANDALONE_COMPILE": lambda: os.environ.get(
597
        "VLLM_USE_STANDALONE_COMPILE", "1"
598
599
    )
    == "1",
600
601
    # Debug pattern matching inside custom passes.
    # Should be set to the fx.Node name (e.g. 'getitem_34' or 'scaled_mm_3').
602
603
604
    "VLLM_PATTERN_MATCH_DEBUG": lambda: os.environ.get(
        "VLLM_PATTERN_MATCH_DEBUG", None
    ),
605
606
    # Dump fx graphs to the given directory.
    # It will override CompilationConfig.debug_dump_path if set.
607
    "VLLM_DEBUG_DUMP_PATH": lambda: os.environ.get("VLLM_DEBUG_DUMP_PATH", None),
608
609
610
611
    # 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,
612
613
614
    # Feature flag to enable/disable bytecode in
    # TorchCompileWithNoGuardsWrapper.
    "VLLM_USE_BYTECODE_HOOK": lambda: bool(
615
        int(os.environ.get("VLLM_USE_BYTECODE_HOOK", "0"))
616
    ),
617
618
619
620
    # 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",
621
622
    # local rank of the process in the distributed setting, used to determine
    # the GPU device id
623
    "LOCAL_RANK": lambda: int(os.environ.get("LOCAL_RANK", "0")),
624
    # used to control the visible devices in the distributed setting
625
    "CUDA_VISIBLE_DEVICES": lambda: os.environ.get("CUDA_VISIBLE_DEVICES", None),
626
    # timeout for each iteration in the engine
627
    "VLLM_ENGINE_ITERATION_TIMEOUT_S": lambda: int(
628
        os.environ.get("VLLM_ENGINE_ITERATION_TIMEOUT_S", "120")
629
    ),
630
    # API key for vLLM API server
631
    "VLLM_API_KEY": lambda: os.environ.get("VLLM_API_KEY", None),
632
    # Whether to log responses from API Server for debugging
633
634
635
636
    "VLLM_DEBUG_LOG_API_SERVER_RESPONSE": lambda: os.environ.get(
        "VLLM_DEBUG_LOG_API_SERVER_RESPONSE", "False"
    ).lower()
    == "true",
637
    # S3 access information, used for tensorizer to load model from S3
638
639
640
    "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),
641
    # Usage stats collection
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
    "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"),
657
658
659
660
    # 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
661
662
    "VLLM_CONFIGURE_LOGGING": lambda: int(os.getenv("VLLM_CONFIGURE_LOGGING", "1")),
    "VLLM_LOGGING_CONFIG_PATH": lambda: os.getenv("VLLM_LOGGING_CONFIG_PATH"),
663
    # this is used for configuring the default logging level
664
    "VLLM_LOGGING_LEVEL": lambda: os.getenv("VLLM_LOGGING_LEVEL", "INFO").upper(),
665
    # this is used for configuring the default logging stream
666
    "VLLM_LOGGING_STREAM": lambda: os.getenv("VLLM_LOGGING_STREAM", "ext://sys.stdout"),
667
    # if set, VLLM_LOGGING_PREFIX will be prepended to all log messages
668
    "VLLM_LOGGING_PREFIX": lambda: os.getenv("VLLM_LOGGING_PREFIX", ""),
Nick Hill's avatar
Nick Hill committed
669
670
671
672
673
    # Controls colored logging output. Options: "auto" (default, colors when terminal),
    # "1" (always use colors), "0" (never use colors)
    "VLLM_LOGGING_COLOR": lambda: os.getenv("VLLM_LOGGING_COLOR", "auto"),
    # Standard unix flag for disabling ANSI color codes
    "NO_COLOR": lambda: os.getenv("NO_COLOR", "0") != "0",
674
675
    # If set, vllm will log stats at this interval in seconds
    # If not set, vllm will log stats every 10 seconds.
676
677
678
    "VLLM_LOG_STATS_INTERVAL": lambda: val
    if (val := float(os.getenv("VLLM_LOG_STATS_INTERVAL", "10."))) > 0.0
    else 10.0,
679
680
681
    # Trace function calls
    # If set to 1, vllm will trace function calls
    # Useful for debugging
682
    "VLLM_TRACE_FUNCTION": lambda: int(os.getenv("VLLM_TRACE_FUNCTION", "0")),
683
    # Backend for attention computation
684
    # Example options:
685
686
    # - "TORCH_SDPA": use torch.nn.MultiheadAttention
    # - "FLASH_ATTN": use FlashAttention
687
    # - "FLASHINFER": use flashinfer
688
    # - "FLASHMLA": use FlashMLA
689
    # - "FLASH_ATTN_MLA": use FlashAttention for MLA
690
691
    # - "FLASHINFER_MLA": use FlashInfer for MLA
    # - "CUTLASS_MLA": use CUTLASS for MLA
692
    # All possible options loaded dynamically from AttentionBackendEnum
693
694
695
696
697
    "VLLM_ATTENTION_BACKEND": env_with_choices(
        "VLLM_ATTENTION_BACKEND",
        None,
        lambda: list(
            __import__(
698
699
                "vllm.attention.backends.registry", fromlist=["AttentionBackendEnum"]
            ).AttentionBackendEnum.__members__.keys()
700
701
        ),
    ),
702
    # If set, vllm will use flashinfer sampler
703
704
705
706
707
    "VLLM_USE_FLASHINFER_SAMPLER": lambda: bool(
        int(os.environ["VLLM_USE_FLASHINFER_SAMPLER"])
    )
    if "VLLM_USE_FLASHINFER_SAMPLER" in os.environ
    else None,
708
    # Pipeline stage partition strategy
709
    "VLLM_PP_LAYER_PARTITION": lambda: os.getenv("VLLM_PP_LAYER_PARTITION", None),
710
    # (CPU backend only) CPU key-value cache space.
711
    # default is None and will be set as 4 GB
712
713
714
    "VLLM_CPU_KVCACHE_SPACE": lambda: int(os.getenv("VLLM_CPU_KVCACHE_SPACE", "0"))
    if "VLLM_CPU_KVCACHE_SPACE" in os.environ
    else None,
715
716
    # (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 '|'.
717
    "VLLM_CPU_OMP_THREADS_BIND": lambda: os.getenv("VLLM_CPU_OMP_THREADS_BIND", "auto"),
718
719
    # (CPU backend only) CPU cores not used by OMP threads .
    # Those CPU cores will not be used by OMP threads of a rank.
720
721
722
723
724
    "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,
725
    # (CPU backend only) whether to use SGL kernels, optimized for small batch.
726
    "VLLM_CPU_SGL_KERNEL": lambda: bool(int(os.getenv("VLLM_CPU_SGL_KERNEL", "0"))),
727
728
729
730
731
732
733
    # 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
734
735
736
    "VLLM_USE_RAY_COMPILED_DAG_CHANNEL_TYPE": env_with_choices(
        "VLLM_USE_RAY_COMPILED_DAG_CHANNEL_TYPE", "auto", ["auto", "nccl", "shm"]
    ),
737
    # If the env var is set, it enables GPU communication overlap
738
    # (experimental feature) in Ray's Compiled Graph.
739
740
741
    "VLLM_USE_RAY_COMPILED_DAG_OVERLAP_COMM": lambda: bool(
        int(os.getenv("VLLM_USE_RAY_COMPILED_DAG_OVERLAP_COMM", "0"))
    ),
742
743
744
    # 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.
745
746
747
    "VLLM_USE_RAY_WRAPPED_PP_COMM": lambda: bool(
        int(os.getenv("VLLM_USE_RAY_WRAPPED_PP_COMM", "1"))
    ),
748
749
    # Use dedicated multiprocess context for workers.
    # Both spawn and fork work
750
    "VLLM_WORKER_MULTIPROC_METHOD": env_with_choices(
751
        "VLLM_WORKER_MULTIPROC_METHOD", "spawn", ["spawn", "fork"]
752
    ),
753
    # Path to the cache for storing downloaded assets
754
    "VLLM_ASSETS_CACHE": lambda: os.path.expanduser(
755
756
757
        os.getenv(
            "VLLM_ASSETS_CACHE",
            os.path.join(get_default_cache_root(), "vllm", "assets"),
758
759
        )
    ),
760
761
    # If the env var is set, we will clean model file in
    # this path $VLLM_ASSETS_CACHE/model_streamer/$model_name
762
763
764
    "VLLM_ASSETS_CACHE_MODEL_CLEAN": lambda: bool(
        int(os.getenv("VLLM_ASSETS_CACHE_MODEL_CLEAN", "0"))
    ),
765
766
    # Timeout for fetching images when serving multimodal models
    # Default is 5 seconds
767
    "VLLM_IMAGE_FETCH_TIMEOUT": lambda: int(os.getenv("VLLM_IMAGE_FETCH_TIMEOUT", "5")),
768
    # Timeout for fetching videos when serving multimodal models
769
    # Default is 30 seconds
770
771
772
    "VLLM_VIDEO_FETCH_TIMEOUT": lambda: int(
        os.getenv("VLLM_VIDEO_FETCH_TIMEOUT", "30")
    ),
773
    # Timeout for fetching audio when serving multimodal models
774
    # Default is 10 seconds
775
776
777
    "VLLM_AUDIO_FETCH_TIMEOUT": lambda: int(
        os.getenv("VLLM_AUDIO_FETCH_TIMEOUT", "10")
    ),
778
779
    # Whether to allow HTTP redirects when fetching from media URLs.
    # Default to True
780
781
782
    "VLLM_MEDIA_URL_ALLOW_REDIRECTS": lambda: bool(
        int(os.getenv("VLLM_MEDIA_URL_ALLOW_REDIRECTS", "1"))
    ),
783
784
785
    # Max number of workers for the thread pool handling
    # media bytes loading. Set to 1 to disable parallel processing.
    # Default is 8
786
787
788
    "VLLM_MEDIA_LOADING_THREAD_COUNT": lambda: int(
        os.getenv("VLLM_MEDIA_LOADING_THREAD_COUNT", "8")
    ),
789
790
791
    # 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
792
793
794
    "VLLM_MAX_AUDIO_CLIP_FILESIZE_MB": lambda: int(
        os.getenv("VLLM_MAX_AUDIO_CLIP_FILESIZE_MB", "25")
    ),
795
796
797
798
799
800
801
    # 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.
802
803
804
    "VLLM_VIDEO_LOADER_BACKEND": lambda: os.getenv(
        "VLLM_VIDEO_LOADER_BACKEND", "opencv"
    ),
805
806
807
808
809
810
811
812
    # Media connector implementation.
    # - "http": Default connector that supports fetching media via HTTP.
    #
    # Custom implementations can be registered
    # via `@MEDIA_CONNECTOR_REGISTRY.register("my_custom_media_connector")` and
    # imported at runtime.
    # If a non-existing backend is used, an AssertionError will be thrown.
    "VLLM_MEDIA_CONNECTOR": lambda: os.getenv("VLLM_MEDIA_CONNECTOR", "http"),
813
    # [DEPRECATED] Cache size (in GiB per process) for multimodal input cache
814
    # Default is 4 GiB per API process + 4 GiB per engine core process
815
    "VLLM_MM_INPUT_CACHE_GIB": lambda: int(os.getenv("VLLM_MM_INPUT_CACHE_GIB", "4")),
816
817
    # Path to the XLA persistent cache directory.
    # Only used for XLA devices such as TPUs.
818
    "VLLM_XLA_CACHE_PATH": lambda: os.path.expanduser(
819
        os.getenv(
820
            "VLLM_XLA_CACHE_PATH",
821
            os.path.join(get_default_cache_root(), "vllm", "xla_cache"),
822
823
        )
    ),
824
    # If set, assert on XLA recompilation after each execution step.
825
826
827
    "VLLM_XLA_CHECK_RECOMPILATION": lambda: bool(
        int(os.getenv("VLLM_XLA_CHECK_RECOMPILATION", "0"))
    ),
828
    # Enable SPMD mode for TPU backend.
829
830
    "VLLM_XLA_USE_SPMD": lambda: bool(int(os.getenv("VLLM_XLA_USE_SPMD", "0"))),
    "VLLM_FUSED_MOE_CHUNK_SIZE": lambda: int(
831
        os.getenv("VLLM_FUSED_MOE_CHUNK_SIZE", str(16 * 1024))
832
    ),
833
834
835
    # 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.
836
837
838
    "VLLM_ENABLE_FUSED_MOE_ACTIVATION_CHUNKING": lambda: bool(
        int(os.getenv("VLLM_ENABLE_FUSED_MOE_ACTIVATION_CHUNKING", "1"))
    ),
839
840
    # If set, the OpenAI API server will stay alive even after the underlying
    # AsyncLLMEngine errors and stops serving requests
841
    "VLLM_KEEP_ALIVE_ON_ENGINE_DEATH": lambda: bool(
842
        int(os.getenv("VLLM_KEEP_ALIVE_ON_ENGINE_DEATH", "0"))
843
    ),
844
845
846
847
    # 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.
848
849
850
851
    "VLLM_ALLOW_LONG_MAX_MODEL_LEN": lambda: (
        os.environ.get("VLLM_ALLOW_LONG_MAX_MODEL_LEN", "0").strip().lower()
        in ("1", "true")
    ),
852
853
    # If set, forces FP8 Marlin to be used for FP8 quantization regardless
    # of the hardware support for FP8 compute.
854
855
856
857
858
859
860
    "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"
    ),
861
862
    # Time in ms for the zmq client to wait for a response from the backend
    # server for simple data operations
863
    "VLLM_RPC_TIMEOUT": lambda: int(os.getenv("VLLM_RPC_TIMEOUT", "10000")),
864
    # Timeout in seconds for keeping HTTP connections alive in API server
865
866
867
    "VLLM_HTTP_TIMEOUT_KEEP_ALIVE": lambda: int(
        os.environ.get("VLLM_HTTP_TIMEOUT_KEEP_ALIVE", "5")
    ),
868
869
870
    # 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
871
872
873
    "VLLM_PLUGINS": lambda: None
    if "VLLM_PLUGINS" not in os.environ
    else os.environ["VLLM_PLUGINS"].split(","),
874
875
876
    # a local directory to look in for unrecognized LoRA adapters.
    # only works if plugins are enabled and
    # VLLM_ALLOW_RUNTIME_LORA_UPDATING is enabled.
877
878
879
    "VLLM_LORA_RESOLVER_CACHE_DIR": lambda: os.getenv(
        "VLLM_LORA_RESOLVER_CACHE_DIR", None
    ),
880
881
882
883
884
    # Enables torch CUDA profiling if set.
    # On NVIDIA GPUs, this will start/stop cudaProfilerApi when triggered.
    "VLLM_TORCH_CUDA_PROFILE": lambda: bool(
        os.getenv("VLLM_TORCH_CUDA_PROFILE", "0") != "0"
    ),
885
886
887
888
    # 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.
889
890
    "VLLM_TORCH_PROFILER_DIR": lambda: (
        None
891
892
893
894
895
        if (val := os.getenv("VLLM_TORCH_PROFILER_DIR")) is None
        else (
            val
            if val.startswith("gs://") and val[5:] and val[5] != "/"
            else os.path.abspath(os.path.expanduser(val))
896
897
        )
    ),
898
899
900
    # Enable torch profiler to record shapes if set
    # VLLM_TORCH_PROFILER_RECORD_SHAPES=1. If not set, torch profiler will
    # not record shapes.
901
902
903
    "VLLM_TORCH_PROFILER_RECORD_SHAPES": lambda: bool(
        os.getenv("VLLM_TORCH_PROFILER_RECORD_SHAPES", "0") != "0"
    ),
904
905
906
    # Enable torch profiler to profile memory if set
    # VLLM_TORCH_PROFILER_WITH_PROFILE_MEMORY=1. If not set, torch profiler
    # will not profile memory.
907
908
909
    "VLLM_TORCH_PROFILER_WITH_PROFILE_MEMORY": lambda: bool(
        os.getenv("VLLM_TORCH_PROFILER_WITH_PROFILE_MEMORY", "0") != "0"
    ),
910
911
912
    # Enable torch profiler to profile stack if set
    # VLLM_TORCH_PROFILER_WITH_STACK=1. If not set, torch profiler WILL
    # profile stack by default.
913
914
915
    "VLLM_TORCH_PROFILER_WITH_STACK": lambda: bool(
        os.getenv("VLLM_TORCH_PROFILER_WITH_STACK", "1") != "0"
    ),
916
917
918
    # Enable torch profiler to profile flops if set
    # VLLM_TORCH_PROFILER_WITH_FLOPS=1. If not set, torch profiler will
    # not profile flops.
919
920
921
    "VLLM_TORCH_PROFILER_WITH_FLOPS": lambda: bool(
        os.getenv("VLLM_TORCH_PROFILER_WITH_FLOPS", "0") != "0"
    ),
922
923
924
925
926
927
928
929
930
931
932
933
934
    # Disable torch profiling of the AsyncLLMEngine process.
    # If set to 1, will not profile the engine process.
    "VLLM_TORCH_PROFILER_DISABLE_ASYNC_LLM": lambda: bool(
        os.getenv("VLLM_TORCH_PROFILER_DISABLE_ASYNC_LLM", "0") != "0"
    ),
    # Delay number of iterations before starting profiling when using
    # the torch/torch CUDA profiler. If set to 0, will start profiling immediately.
    "VLLM_PROFILER_DELAY_ITERS": lambda: int(
        os.getenv("VLLM_PROFILER_DELAY_ITERS", "0")
    ),
    # Maximum number of iterations to profile when using the torch/torch CUDA profiler.
    # If set to 0, will not limit the number of iterations.
    "VLLM_PROFILER_MAX_ITERS": lambda: int(os.getenv("VLLM_PROFILER_MAX_ITERS", "0")),
935
936
937
938
939
940
941
942
943
944
945
    # Control whether torch profiler gzip-compresses profiling files.
    # Set VLLM_TORCH_PROFILER_USE_GZIP=0 to disable gzip (enabled by default).
    "VLLM_TORCH_PROFILER_USE_GZIP": lambda: bool(
        os.getenv("VLLM_TORCH_PROFILER_USE_GZIP", "1") != "0"
    ),
    # Control whether torch profiler dumps the self_cuda_time_total table.
    # Set VLLM_TORCH_PROFILER_DUMP_CUDA_TIME_TOTAL=0 to disable dumping
    # (enabled by default).
    "VLLM_TORCH_PROFILER_DUMP_CUDA_TIME_TOTAL": lambda: bool(
        os.getenv("VLLM_TORCH_PROFILER_DUMP_CUDA_TIME_TOTAL", "1") != "0"
    ),
946
    # If set, vLLM will use Triton implementations of AWQ.
947
    "VLLM_USE_TRITON_AWQ": lambda: bool(int(os.getenv("VLLM_USE_TRITON_AWQ", "0"))),
948
    # If set, allow loading or unloading lora adapters in runtime,
949
950
951
952
    "VLLM_ALLOW_RUNTIME_LORA_UPDATING": lambda: (
        os.environ.get("VLLM_ALLOW_RUNTIME_LORA_UPDATING", "0").strip().lower()
        in ("1", "true")
    ),
953
954
955
956
957
958
    # 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
959
    "VLLM_SKIP_P2P_CHECK": lambda: os.getenv("VLLM_SKIP_P2P_CHECK", "1") == "1",
960
961
962
963
    # List of quantization kernels that should be disabled, used for testing
    # and performance comparisons. Currently only affects MPLinearKernel
    # selection
    # (kernels: MacheteLinearKernel, MarlinLinearKernel, ExllamaLinearKernel)
964
965
966
    "VLLM_DISABLED_KERNELS": lambda: []
    if "VLLM_DISABLED_KERNELS" not in os.environ
    else os.environ["VLLM_DISABLED_KERNELS"].split(","),
967
    # Disable pynccl (using torch.distributed instead)
968
969
970
    "VLLM_DISABLE_PYNCCL": lambda: (
        os.getenv("VLLM_DISABLE_PYNCCL", "False").lower() in ("true", "1")
    ),
971
972
    # Disable aiter ops unless specifically enabled.
    # Acts as a parent switch to enable the rest of the other operations.
973
974
975
    "VLLM_ROCM_USE_AITER": lambda: (
        os.getenv("VLLM_ROCM_USE_AITER", "False").lower() in ("true", "1")
    ),
976
977
    # Whether to use aiter paged attention.
    # By default is disabled.
978
979
980
    "VLLM_ROCM_USE_AITER_PAGED_ATTN": lambda: (
        os.getenv("VLLM_ROCM_USE_AITER_PAGED_ATTN", "False").lower() in ("true", "1")
    ),
981
982
983
    # use aiter linear op if aiter ops are enabled
    # The following list of related ops
    # - scaled_mm (per-tensor / rowwise)
984
    "VLLM_ROCM_USE_AITER_LINEAR": lambda: (
985
        os.getenv("VLLM_ROCM_USE_AITER_LINEAR", "False").lower() in ("true", "1")
986
    ),
987
988
    # Whether to use aiter moe ops.
    # By default is enabled.
989
    "VLLM_ROCM_USE_AITER_MOE": lambda: (
990
        os.getenv("VLLM_ROCM_USE_AITER_MOE", "False").lower() in ("true", "1")
991
    ),
992
    # use aiter rms norm op if aiter ops are enabled.
993
    "VLLM_ROCM_USE_AITER_RMSNORM": lambda: (
994
        os.getenv("VLLM_ROCM_USE_AITER_RMSNORM", "False").lower() in ("true", "1")
995
    ),
996
997
    # Whether to use aiter mla ops.
    # By default is enabled.
998
    "VLLM_ROCM_USE_AITER_MLA": lambda: (
999
        os.getenv("VLLM_ROCM_USE_AITER_MLA", "False").lower() in ("true", "1")
1000
    ),
1001
1002
    # Whether to use aiter mha ops.
    # By default is enabled.
1003
    "VLLM_ROCM_USE_AITER_MHA": lambda: (
1004
        os.getenv("VLLM_ROCM_USE_AITER_MHA", "False").lower() in ("true", "1")
1005
    ),
1006
1007
    # Whether to use aiter fp4 gemm asm.
    # By default is disabled.
1008
1009
1010
    "VLLM_ROCM_USE_AITER_FP4_ASM_GEMM": lambda: (
        os.getenv("VLLM_ROCM_USE_AITER_FP4_ASM_GEMM", "False").lower() in ("true", "1")
    ),
1011
1012
    # Whether to use aiter rope.
    # By default is disabled.
1013
1014
    "VLLM_ROCM_USE_AITER_TRITON_ROPE": lambda: (
        os.getenv("VLLM_ROCM_USE_AITER_TRITON_ROPE", "False").lower() in ("true", "1")
1015
    ),
1016
1017
    # Whether to use aiter triton fp8 bmm kernel
    # By default is enabled.
1018
    "VLLM_ROCM_USE_AITER_FP8BMM": lambda: (
1019
        os.getenv("VLLM_ROCM_USE_AITER_FP8BMM", "False").lower() in ("true", "1")
1020
    ),
1021
1022
1023
1024
1025
    # 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")
    ),
1026
    # Whether to use aiter fusion shared experts ops.
1027
    # By default is disabled.
1028
    "VLLM_ROCM_USE_AITER_FUSION_SHARED_EXPERTS": lambda: (
1029
        os.getenv("VLLM_ROCM_USE_AITER_FUSION_SHARED_EXPERTS", "False").lower()
1030
1031
        in ("true", "1")
    ),
1032
1033
1034
    # Whether to use aiter triton kernels for gemm ops.
    # By default is enabled.
    "VLLM_ROCM_USE_AITER_TRITON_GEMM": lambda: (
1035
        os.getenv("VLLM_ROCM_USE_AITER_TRITON_GEMM", "False").lower() in ("true", "1")
1036
    ),
1037
    # use rocm skinny gemms
1038
1039
1040
    "VLLM_ROCM_USE_SKINNY_GEMM": lambda: (
        os.getenv("VLLM_ROCM_USE_SKINNY_GEMM", "True").lower() in ("true", "1")
    ),
1041
    # Pad the fp8 weights to 256 bytes for ROCm
1042
    "VLLM_ROCM_FP8_PADDING": lambda: bool(int(os.getenv("VLLM_ROCM_FP8_PADDING", "1"))),
1043
    # Pad the weights for the moe kernel
1044
    "VLLM_ROCM_MOE_PADDING": lambda: bool(int(os.getenv("VLLM_ROCM_MOE_PADDING", "0"))),
1045
    # custom paged attention kernel for MI3* cards
1046
1047
1048
    "VLLM_ROCM_CUSTOM_PAGED_ATTN": lambda: (
        os.getenv("VLLM_ROCM_CUSTOM_PAGED_ATTN", "True").lower() in ("true", "1")
    ),
1049
1050
1051
    # Custom quick allreduce kernel for MI3* cards
    # Choice of quantization level: FP, INT8, INT6, INT4 or NONE
    # Recommended for large models to get allreduce
1052
1053
1054
1055
1056
    "VLLM_ROCM_QUICK_REDUCE_QUANTIZATION": env_with_choices(
        "VLLM_ROCM_QUICK_REDUCE_QUANTIZATION",
        "NONE",
        ["FP", "INT8", "INT6", "INT4", "NONE"],
    ),
1057
1058
1059
1060
    # 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
1061
1062
1063
1064
    "VLLM_ROCM_QUICK_REDUCE_CAST_BF16_TO_FP16": lambda: (
        os.getenv("VLLM_ROCM_QUICK_REDUCE_CAST_BF16_TO_FP16", "True").lower()
        in ("true", "1")
    ),
1065
1066
1067
1068
1069
1070
    # 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.
1071
1072
1073
    "VLLM_ROCM_QUICK_REDUCE_MAX_SIZE_BYTES_MB": lambda: maybe_convert_int(
        os.environ.get("VLLM_ROCM_QUICK_REDUCE_MAX_SIZE_BYTES_MB", None)
    ),
1074
    # Divisor for dynamic query scale factor calculation for FP8 KV Cache
1075
    "Q_SCALE_CONSTANT": lambda: int(os.getenv("Q_SCALE_CONSTANT", "200")),
1076
    # Divisor for dynamic key scale factor calculation for FP8 KV Cache
1077
    "K_SCALE_CONSTANT": lambda: int(os.getenv("K_SCALE_CONSTANT", "200")),
1078
    # Divisor for dynamic value scale factor calculation for FP8 KV Cache
1079
    "V_SCALE_CONSTANT": lambda: int(os.getenv("V_SCALE_CONSTANT", "100")),
1080
    # If set, enable multiprocessing in LLM for the V1 code path.
1081
1082
1083
1084
1085
1086
    "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")
    ),
1087
    "VLLM_DISABLE_COMPILE_CACHE": disable_compile_cache,
1088
1089
1090
    # If set, vllm will run in development mode, which will enable
    # some additional endpoints for developing and debugging,
    # e.g. `/reset_prefix_cache`
1091
    "VLLM_SERVER_DEV_MODE": lambda: bool(int(os.getenv("VLLM_SERVER_DEV_MODE", "0"))),
1092
1093
1094
1095
1096
1097
1098
    # 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.
1099
1100
1101
    "VLLM_V1_OUTPUT_PROC_CHUNK_SIZE": lambda: int(
        os.getenv("VLLM_V1_OUTPUT_PROC_CHUNK_SIZE", "128")
    ),
1102
    # If set, vLLM will disable the MLA attention optimizations.
1103
    "VLLM_MLA_DISABLE": lambda: bool(int(os.getenv("VLLM_MLA_DISABLE", "0"))),
1104
1105
    # If set, vLLM will pick up the provided Flash Attention MLA
    # max number splits for cuda graph decode
1106
1107
1108
    "VLLM_FLASH_ATTN_MAX_NUM_SPLITS_FOR_CUDA_GRAPH": lambda: int(
        os.getenv("VLLM_FLASH_ATTN_MAX_NUM_SPLITS_FOR_CUDA_GRAPH", "32")
    ),
1109
1110
1111
    # 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.
1112
1113
1114
    "VLLM_RAY_PER_WORKER_GPUS": lambda: float(
        os.getenv("VLLM_RAY_PER_WORKER_GPUS", "1.0")
    ),
1115
1116
1117
    # 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"
1118
    "VLLM_RAY_BUNDLE_INDICES": lambda: os.getenv("VLLM_RAY_BUNDLE_INDICES", ""),
1119
1120
    # In some system, find_loaded_library() may not work. So we allow users to
    # specify the path through environment variable VLLM_CUDART_SO_PATH.
1121
    "VLLM_CUDART_SO_PATH": lambda: os.getenv("VLLM_CUDART_SO_PATH", None),
1122
    # Rank of the process in the data parallel setting
1123
    "VLLM_DP_RANK": lambda: int(os.getenv("VLLM_DP_RANK", "0")),
1124
1125
    # Rank of the process in the data parallel setting.
    # Defaults to VLLM_DP_RANK when not set.
1126
1127
1128
    "VLLM_DP_RANK_LOCAL": lambda: int(
        os.getenv("VLLM_DP_RANK_LOCAL", sys.modules[__name__].VLLM_DP_RANK)
    ),
1129
    # World size of the data parallel setting
1130
    "VLLM_DP_SIZE": lambda: int(os.getenv("VLLM_DP_SIZE", "1")),
1131
    # IP address of the master node in the data parallel setting
1132
    "VLLM_DP_MASTER_IP": lambda: os.getenv("VLLM_DP_MASTER_IP", "127.0.0.1"),
1133
    # Port of the master node in the data parallel setting
1134
    "VLLM_DP_MASTER_PORT": lambda: int(os.getenv("VLLM_DP_MASTER_PORT", "0")),
1135
1136
1137
1138
1139
    # 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.
1140
    "VLLM_MOE_DP_CHUNK_SIZE": lambda: int(os.getenv("VLLM_MOE_DP_CHUNK_SIZE", "256")),
1141
    # Randomize inputs during dummy runs when using Data Parallel
1142
1143
1144
1145
    "VLLM_RANDOMIZE_DP_DUMMY_INPUTS": lambda: os.environ.get(
        "VLLM_RANDOMIZE_DP_DUMMY_INPUTS", "0"
    )
    == "1",
1146
1147
1148
1149
1150
1151
1152
    # 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;
1153
1154
1155
    # - "span":
    #   Should be used only when a single DP rank requires multiple nodes.
    #   allocate one DP rank over as many nodes as required for set world_size;
1156
1157
1158
1159
    # 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"
    ),
1160
    # Whether to use S3 path for model loading in CI via RunAI Streamer
1161
    "VLLM_CI_USE_S3": lambda: os.environ.get("VLLM_CI_USE_S3", "0") == "1",
1162
    # Use model_redirect to redirect the model name to a local folder.
1163
1164
1165
1166
1167
    # `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
1168
1169
1170
    "VLLM_MODEL_REDIRECT_PATH": lambda: os.environ.get(
        "VLLM_MODEL_REDIRECT_PATH", None
    ),
1171
    # Whether to use atomicAdd reduce in gptq/awq marlin kernel.
1172
1173
1174
1175
    "VLLM_MARLIN_USE_ATOMIC_ADD": lambda: os.environ.get(
        "VLLM_MARLIN_USE_ATOMIC_ADD", "0"
    )
    == "1",
1176
    # Whether to use marlin kernel in mxfp4 quantization method
1177
1178
1179
    "VLLM_MXFP4_USE_MARLIN": lambda: maybe_convert_bool(
        os.environ.get("VLLM_MXFP4_USE_MARLIN", None)
    ),
1180
1181
1182
1183
    # The activation dtype for marlin kernel
    "VLLM_MARLIN_INPUT_DTYPE": env_with_choices(
        "VLLM_MARLIN_INPUT_DTYPE", None, ["int8", "fp8"]
    ),
1184
1185
1186
1187
1188
1189
    # Whether to use DeepEPLL kernels for NVFP4 quantization and dispatch method
    # only supported on Blackwell GPUs and with
    # https://github.com/deepseek-ai/DeepEP/pull/341
    "VLLM_DEEPEPLL_NVFP4_DISPATCH": lambda: bool(
        int(os.getenv("VLLM_DEEPEPLL_NVFP4_DISPATCH", "0"))
    ),
1190
1191
1192
    # 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.
1193
1194
1195
1196
    "VLLM_V1_USE_OUTLINES_CACHE": lambda: os.environ.get(
        "VLLM_V1_USE_OUTLINES_CACHE", "0"
    )
    == "1",
1197
1198
    # Gap between padding buckets for the forward pass. So we have
    # 8, we will run forward pass with [16, 24, 32, ...].
1199
1200
1201
1202
1203
1204
1205
1206
    "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)
    ),
1207
    # Whether using Pathways
1208
1209
1210
    "VLLM_TPU_USING_PATHWAYS": lambda: bool(
        "proxy" in os.getenv("JAX_PLATFORMS", "").lower()
    ),
1211
    # Allow use of DeepGemm kernels for fused moe ops.
1212
    "VLLM_USE_DEEP_GEMM": lambda: bool(int(os.getenv("VLLM_USE_DEEP_GEMM", "1"))),
1213
1214
1215
1216
    # Allow use of DeepGemm specifically for MoE fused ops (overrides only MoE).
    "VLLM_MOE_USE_DEEP_GEMM": lambda: bool(
        int(os.getenv("VLLM_MOE_USE_DEEP_GEMM", "1"))
    ),
1217
    # Whether to use E8M0 scaling when DeepGEMM is used on Blackwell GPUs.
1218
1219
1220
    "VLLM_USE_DEEP_GEMM_E8M0": lambda: bool(
        int(os.getenv("VLLM_USE_DEEP_GEMM_E8M0", "1"))
    ),
1221
1222
1223
1224
    # 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.
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
    # 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",
        ],
1240
    ),
1241
    # Whether to use fused grouped_topk used for MoE expert selection.
1242
1243
1244
    "VLLM_USE_FUSED_MOE_GROUPED_TOPK": lambda: bool(
        int(os.getenv("VLLM_USE_FUSED_MOE_GROUPED_TOPK", "1"))
    ),
1245
    # Allow use of FlashInfer MoE kernels for fused moe ops.
1246
1247
1248
    "VLLM_USE_FLASHINFER_MOE_FP16": lambda: bool(
        int(os.getenv("VLLM_USE_FLASHINFER_MOE_FP16", "0"))
    ),
1249
    # Allow use of FlashInfer MoE kernels for fused moe ops.
1250
1251
1252
    "VLLM_USE_FLASHINFER_MOE_FP8": lambda: bool(
        int(os.getenv("VLLM_USE_FLASHINFER_MOE_FP8", "0"))
    ),
1253
    # Allow use of FlashInfer CUTLASS kernels for fused moe ops.
1254
1255
1256
    "VLLM_USE_FLASHINFER_MOE_FP4": lambda: bool(
        int(os.getenv("VLLM_USE_FLASHINFER_MOE_FP4", "0"))
    ),
1257
1258
    # If set to 1, use the FlashInfer
    # MXFP8 (activation) x MXFP4 (weight) MoE backend.
1259
1260
1261
    "VLLM_USE_FLASHINFER_MOE_MXFP4_MXFP8": lambda: bool(
        int(os.getenv("VLLM_USE_FLASHINFER_MOE_MXFP4_MXFP8", "0"))
    ),
1262
1263
1264
1265
    # 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.
1266
1267
1268
    "VLLM_USE_FLASHINFER_MOE_MXFP4_MXFP8_CUTLASS": lambda: bool(
        int(os.getenv("VLLM_USE_FLASHINFER_MOE_MXFP4_MXFP8_CUTLASS", "0"))
    ),
1269
1270
    # If set to 1, use the FlashInfer
    # BF16 (activation) x MXFP4 (weight) MoE backend.
1271
1272
1273
    "VLLM_USE_FLASHINFER_MOE_MXFP4_BF16": lambda: bool(
        int(os.getenv("VLLM_USE_FLASHINFER_MOE_MXFP4_BF16", "0"))
    ),
1274
1275
1276
    # 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.
1277
    "VLLM_XGRAMMAR_CACHE_MB": lambda: int(os.getenv("VLLM_XGRAMMAR_CACHE_MB", "512")),
1278
1279
1280
1281
1282
1283
1284
    # 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.
1285
1286
1287
    "VLLM_MSGPACK_ZERO_COPY_THRESHOLD": lambda: int(
        os.getenv("VLLM_MSGPACK_ZERO_COPY_THRESHOLD", "256")
    ),
1288
1289
1290
    # 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.
1291
1292
1293
    "VLLM_ALLOW_INSECURE_SERIALIZATION": lambda: bool(
        int(os.getenv("VLLM_ALLOW_INSECURE_SERIALIZATION", "0"))
    ),
Robert Shaw's avatar
Robert Shaw committed
1294
    # IP address used for NIXL handshake between remote agents.
1295
1296
1297
    "VLLM_NIXL_SIDE_CHANNEL_HOST": lambda: os.getenv(
        "VLLM_NIXL_SIDE_CHANNEL_HOST", "localhost"
    ),
Robert Shaw's avatar
Robert Shaw committed
1298
    # Port used for NIXL handshake between remote agents.
1299
1300
1301
    "VLLM_NIXL_SIDE_CHANNEL_PORT": lambda: int(
        os.getenv("VLLM_NIXL_SIDE_CHANNEL_PORT", "5600")
    ),
1302
    # all2all backend for vllm's expert parallel communication
1303
    # Available options:
1304
1305
1306
    # - "naive": naive all2all implementation using broadcasts
    # - "allgather_reducescatter": all2all implementation based on allgather and
    #  reducescatter
1307
    # - "pplx": use pplx kernels
1308
1309
    # - "deepep_high_throughput", use deepep high-throughput kernels
    # - "deepep_low_latency", use deepep low-latency kernels
1310
    # - "flashinfer_all2allv", use flashinfer alltoallv kernels for mnnvl
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
    "VLLM_ALL2ALL_BACKEND": env_with_choices(
        "VLLM_ALL2ALL_BACKEND",
        "allgather_reducescatter",
        [
            "naive",
            "pplx",
            "deepep_high_throughput",
            "deepep_low_latency",
            "allgather_reducescatter",
            "flashinfer_all2allv",
        ],
    ),
1323
1324
    # Flashinfer MoE backend for vLLM's fused Mixture-of-Experts support.
    # Both require compute capability 10.0 or above.
1325
1326
1327
1328
1329
    # Available options:
    # - "throughput":  [default]
    #     Uses CUTLASS kernels optimized for high-throughput batch inference.
    # - "latency":
    #     Uses TensorRT-LLM kernels optimized for low-latency inference.
1330
    "VLLM_FLASHINFER_MOE_BACKEND": env_with_choices(
1331
1332
1333
        "VLLM_FLASHINFER_MOE_BACKEND",
        "latency",
        ["throughput", "latency", "masked_gemm"],
1334
    ),
1335
1336
1337
1338
    # Control the workspace buffer size for the FlashInfer backend.
    "VLLM_FLASHINFER_WORKSPACE_BUFFER_SIZE": lambda: int(
        os.getenv("VLLM_FLASHINFER_WORKSPACE_BUFFER_SIZE", str(394 * 1024 * 1024))
    ),
1339
1340
1341
1342
    # 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.
1343
1344
1345
    "VLLM_MAX_TOKENS_PER_EXPERT_FP4_MOE": lambda: int(
        os.getenv("VLLM_MAX_TOKENS_PER_EXPERT_FP4_MOE", "163840")
    ),
1346
1347
1348
1349
    # 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> }
1350
    # Unspecified world sizes will fall back to
1351
    #     { 2: 64, 4: 1, <everything else>: 0.5 }
1352
1353
1354
    "VLLM_FLASHINFER_ALLREDUCE_FUSION_THRESHOLDS_MB": lambda: json.loads(
        os.getenv("VLLM_FLASHINFER_ALLREDUCE_FUSION_THRESHOLDS_MB", "{}")
    ),
1355
1356
1357
    # MoE routing strategy selector.
    # See `RoutingSimulator.get_available_strategies()` # for available
    # strategies.
1358
    # Custom routing strategies can be registered by
1359
1360
    # RoutingSimulator.register_strategy()
    # Note: custom strategies may not produce correct model outputs
1361
1362
1363
    "VLLM_MOE_ROUTING_SIMULATION_STRATEGY": lambda: os.environ.get(
        "VLLM_MOE_ROUTING_SIMULATION_STRATEGY", ""
    ).lower(),
1364
    # Regex timeout for use by the vLLM tool parsing plugins.
1365
1366
1367
    "VLLM_TOOL_PARSE_REGEX_TIMEOUT_SECONDS": lambda: int(
        os.getenv("VLLM_TOOL_PARSE_REGEX_TIMEOUT_SECONDS", "1")
    ),
1368
1369
    # Reduce CPU usage when vLLM is idle. Enabling this will incur small
    # latency penalty when a request eventually comes.
1370
    "VLLM_SLEEP_WHEN_IDLE": lambda: bool(int(os.getenv("VLLM_SLEEP_WHEN_IDLE", "0"))),
1371
1372
1373
    # 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.
1374
1375
1376
    "VLLM_MQ_MAX_CHUNK_BYTES_MB": lambda: int(
        os.getenv("VLLM_MQ_MAX_CHUNK_BYTES_MB", "16")
    ),
1377
1378
    # Timeout in seconds for execute_model RPC calls in multiprocessing
    # executor (only applies when TP > 1).
1379
1380
1381
    "VLLM_EXECUTE_MODEL_TIMEOUT_SECONDS": lambda: int(
        os.getenv("VLLM_EXECUTE_MODEL_TIMEOUT_SECONDS", "300")
    ),
1382
1383
1384
1385
1386
1387
1388
    # 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.
1389
1390
1391
    "VLLM_KV_CACHE_LAYOUT": env_with_choices(
        "VLLM_KV_CACHE_LAYOUT", None, ["NHD", "HND"]
    ),
1392
1393
1394
    # 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.
1395
1396
1397
    "VLLM_COMPUTE_NANS_IN_LOGITS": lambda: bool(
        int(os.getenv("VLLM_COMPUTE_NANS_IN_LOGITS", "0"))
    ),
1398
1399
1400
    # Controls whether or not emulations are used for NVFP4
    # generations on machines < 100 for compressed-tensors
    # models
1401
1402
1403
    "VLLM_USE_NVFP4_CT_EMULATIONS": lambda: bool(
        int(os.getenv("VLLM_USE_NVFP4_CT_EMULATIONS", "0"))
    ),
1404
1405
1406
1407
    # 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.
1408
1409
1410
    "VLLM_NIXL_ABORT_REQUEST_TIMEOUT": lambda: int(
        os.getenv("VLLM_NIXL_ABORT_REQUEST_TIMEOUT", "480")
    ),
1411
    # Controls whether or not to use cudnn prefill
1412
1413
1414
    "VLLM_USE_CUDNN_PREFILL": lambda: bool(
        int(os.getenv("VLLM_USE_CUDNN_PREFILL", "0"))
    ),
1415
1416
1417
1418
    # Controls whether to use TRT-LLM ragged DeepSeek prefill
    "VLLM_USE_TRTLLM_RAGGED_DEEPSEEK_PREFILL": lambda: bool(
        int(os.getenv("VLLM_USE_TRTLLM_RAGGED_DEEPSEEK_PREFILL", "0"))
    ),
1419
1420
1421
    # 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.
1422
1423
1424
1425
1426
    "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")
    ),
1427
    # If set to 1, when we use fp8 kv, we do not quantize Q to fp8
1428
1429
1430
    "VLLM_FLASHINFER_DISABLE_Q_QUANTIZATION": lambda: bool(
        int(os.getenv("VLLM_FLASHINFER_DISABLE_Q_QUANTIZATION", "0"))
    ),
1431
1432
    # If set, it means we pre-downloaded cubin files and flashinfer will
    # read the cubin files directly.
1433
1434
1435
    "VLLM_HAS_FLASHINFER_CUBIN": lambda: bool(
        int(os.getenv("VLLM_HAS_FLASHINFER_CUBIN", "0"))
    ),
1436
1437
1438
1439
1440
1441
1442
1443
    # Supported options:
    # - "flashinfer-cudnn": use flashinfer cudnn GEMM backend
    # - "flashinfer-trtllm": use flashinfer trtllm GEMM backend
    # - "flashinfer-cutlass": use flashinfer cutlass GEMM backend
    # - <none>: automatically pick an available backend
    "VLLM_NVFP4_GEMM_BACKEND": env_with_choices(
        "VLLM_NVFP4_GEMM_BACKEND",
        None,
1444
        ["flashinfer-cudnn", "flashinfer-trtllm", "flashinfer-cutlass", "cutlass"],
1445
    ),
1446
1447
1448
    # 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.
1449
1450
1451
    "VLLM_ENABLE_CUDAGRAPH_GC": lambda: bool(
        int(os.getenv("VLLM_ENABLE_CUDAGRAPH_GC", "0"))
    ),
1452
    # Used to force set up loopback IP
1453
    "VLLM_LOOPBACK_IP": lambda: os.getenv("VLLM_LOOPBACK_IP", ""),
1454
1455
1456
    # Used to set the process name prefix for vLLM processes.
    # This is useful for debugging and monitoring purposes.
    # The default value is "VLLM".
1457
    "VLLM_PROCESS_NAME_PREFIX": lambda: os.getenv("VLLM_PROCESS_NAME_PREFIX", "VLLM"),
1458
1459
1460
1461
1462
1463
1464
    # 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.
1465
1466
1467
    "VLLM_ALLOW_CHUNKED_LOCAL_ATTN_WITH_HYBRID_KV_CACHE": lambda: bool(
        int(os.getenv("VLLM_ALLOW_CHUNKED_LOCAL_ATTN_WITH_HYBRID_KV_CACHE", "0"))
    ),
1468
1469
    # 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
1470
1471
    # messages for those requests in memory. By default, this is disabled (0),
    # and the "store" option is ignored.
1472
1473
1474
1475
1476
    # 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.
1477
1478
1479
    "VLLM_ENABLE_RESPONSES_API_STORE": lambda: bool(
        int(os.getenv("VLLM_ENABLE_RESPONSES_API_STORE", "0"))
    ),
xiao-llm's avatar
xiao-llm committed
1480
    # If set, use the fp8 mfma in rocm paged attention.
1481
1482
1483
    "VLLM_ROCM_FP8_MFMA_PAGE_ATTN": lambda: bool(
        int(os.getenv("VLLM_ROCM_FP8_MFMA_PAGE_ATTN", "0"))
    ),
1484
    # Whether to use pytorch symmetric memory for allreduce
1485
    "VLLM_ALLREDUCE_USE_SYMM_MEM": lambda: bool(
1486
        int(os.getenv("VLLM_ALLREDUCE_USE_SYMM_MEM", "1"))
1487
    ),
1488
    # Allows vllm to find tuned config under customized folder
1489
    "VLLM_TUNED_CONFIG_FOLDER": lambda: os.getenv("VLLM_TUNED_CONFIG_FOLDER", None),
1490
1491
1492
1493
1494
1495
1496
1497
1498
    # Valid values are container,code_interpreter,web_search_preview
    # ex VLLM_GPT_OSS_SYSTEM_TOOL_MCP_LABELS=container,code_interpreter
    # If the server_label of your mcp tool is not in this list it will
    # be completely ignored.
    "VLLM_GPT_OSS_SYSTEM_TOOL_MCP_LABELS": env_set_with_choices(
        "VLLM_GPT_OSS_SYSTEM_TOOL_MCP_LABELS",
        default=[],
        choices=["container", "code_interpreter", "web_search_preview"],
    ),
1499
    # Allows harmony instructions to be injected on system messages
1500
1501
1502
    "VLLM_GPT_OSS_HARMONY_SYSTEM_INSTRUCTIONS": lambda: bool(
        int(os.getenv("VLLM_GPT_OSS_HARMONY_SYSTEM_INSTRUCTIONS", "0"))
    ),
1503
1504
1505
1506
1507
1508
    # Enable automatic retry when tool call JSON parsing fails
    # If enabled, returns an error message to the model to retry
    # If disabled (default), raises an exception and fails the request
    "VLLM_TOOL_JSON_ERROR_AUTOMATIC_RETRY": lambda: bool(
        int(os.getenv("VLLM_TOOL_JSON_ERROR_AUTOMATIC_RETRY", "0"))
    ),
1509
    # Add optional custom scopes for profiling, disable to avoid overheads
1510
1511
1512
    "VLLM_CUSTOM_SCOPES_FOR_PROFILING": lambda: bool(
        int(os.getenv("VLLM_CUSTOM_SCOPES_FOR_PROFILING", "0"))
    ),
1513
    # Add optional nvtx scopes for profiling, disable to avoid overheads
1514
1515
1516
    "VLLM_NVTX_SCOPES_FOR_PROFILING": lambda: bool(
        int(os.getenv("VLLM_NVTX_SCOPES_FOR_PROFILING", "0"))
    ),
1517
1518
    # Represent block hashes in KV cache events as 64-bit integers instead of
    # raw bytes. Defaults to True for backward compatibility.
1519
1520
1521
    "VLLM_KV_EVENTS_USE_INT_BLOCK_HASHES": lambda: bool(
        int(os.getenv("VLLM_KV_EVENTS_USE_INT_BLOCK_HASHES", "1"))
    ),
1522
1523
    # Name of the shared memory buffer used for object storage.
    # Only effective when mm_config.mm_processor_cache_type == "shm".
1524
1525
1526
    "VLLM_OBJECT_STORAGE_SHM_BUFFER_NAME": lambda: os.getenv(
        "VLLM_OBJECT_STORAGE_SHM_BUFFER_NAME", "VLLM_OBJECT_STORAGE_SHM_BUFFER"
    ),
1527
    # The size in MB of the buffers (NVL and RDMA) used by DeepEP
1528
1529
1530
    "VLLM_DEEPEP_BUFFER_SIZE_MB": lambda: int(
        os.getenv("VLLM_DEEPEP_BUFFER_SIZE_MB", "1024")
    ),
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
    # Force DeepEP to use intranode kernel for inter-node communication in
    # high throughput mode. This is useful archive higher prefill throuhgput
    # on system supports multi-node nvlink (e.g GB200).
    "VLLM_DEEPEP_HIGH_THROUGHPUT_FORCE_INTRA_NODE": lambda: bool(
        int(os.getenv("VLLM_DEEPEP_HIGH_THROUGHPUT_FORCE_INTRA_NODE", "0"))
    ),
    # Allow DeepEP to use MNNVL (multi-node nvlink) for internode_ll kernel,
    # turn this for better latency on GB200 like system
    "VLLM_DEEPEP_LOW_LATENCY_USE_MNNVL": lambda: bool(
        int(os.getenv("VLLM_DEEPEP_LOW_LATENCY_USE_MNNVL", "0"))
    ),
1542
1543
    # 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
1544
    "VLLM_DBO_COMM_SMS": lambda: int(os.getenv("VLLM_DBO_COMM_SMS", "20")),
1545
1546
1547
    # 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)
1548
1549
1550
    "VLLM_ENABLE_INDUCTOR_MAX_AUTOTUNE": lambda: bool(
        int(os.getenv("VLLM_ENABLE_INDUCTOR_MAX_AUTOTUNE", "1"))
    ),
1551
1552
    # If set to 1, enable coordinate_descent_tuning;
    # By default, this is enabled (1)
1553
1554
1555
    "VLLM_ENABLE_INDUCTOR_COORDINATE_DESCENT_TUNING": lambda: bool(
        int(os.getenv("VLLM_ENABLE_INDUCTOR_COORDINATE_DESCENT_TUNING", "1"))
    ),
1556
    # Flag to enable NCCL symmetric memory allocation and registration
1557
1558
1559
    "VLLM_USE_NCCL_SYMM_MEM": lambda: bool(
        int(os.getenv("VLLM_USE_NCCL_SYMM_MEM", "0"))
    ),
1560
    # NCCL header path
1561
    "VLLM_NCCL_INCLUDE_PATH": lambda: os.environ.get("VLLM_NCCL_INCLUDE_PATH", None),
1562
1563
    # Flag to enable FBGemm kernels on model execution
    "VLLM_USE_FBGEMM": lambda: bool(int(os.getenv("VLLM_USE_FBGEMM", "0"))),
1564
1565
1566
1567
1568
1569
    # 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", ""),
1570
    # Disables parallel execution of shared_experts via separate cuda stream
1571
1572
    "VLLM_DISABLE_SHARED_EXPERTS_STREAM": lambda: bool(
        int(os.getenv("VLLM_DISABLE_SHARED_EXPERTS_STREAM", "0"))
1573
    ),
1574
1575
1576
1577
1578
1579
1580
    # Limits when we run shared_experts in a separate stream.
    # We found out that for large batch sizes, the separate stream
    # execution is not beneficial (most likely because of the input clone)
    # TODO(alexm-redhat): Tune to be more dynamic based on GPU type
    "VLLM_SHARED_EXPERTS_STREAM_TOKEN_THRESHOLD": lambda: int(
        int(os.getenv("VLLM_SHARED_EXPERTS_STREAM_TOKEN_THRESHOLD", 256))
    ),
1581
1582
1583
1584
1585
1586
1587
1588
1589
    # Format for saving torch.compile cache artifacts
    # - "binary": saves as binary file
    #     Safe for multiple vllm serve processes accessing the same torch compile cache.
    # - "unpacked": saves as directory structure (for inspection/debugging)
    #     NOT multiprocess safe - race conditions may occur with multiple processes.
    #     Allows viewing and setting breakpoints in Inductor's code output files.
    "VLLM_COMPILE_CACHE_SAVE_FORMAT": env_with_choices(
        "VLLM_COMPILE_CACHE_SAVE_FORMAT", "binary", ["binary", "unpacked"]
    ),
Woosuk Kwon's avatar
Woosuk Kwon committed
1590
1591
1592
1593
    # Flag to enable v2 model runner.
    "VLLM_USE_V2_MODEL_RUNNER": lambda: bool(
        int(os.getenv("VLLM_USE_V2_MODEL_RUNNER", "0"))
    ),
1594
    
1595
1596
1597
    # add envs
    
    # used in optest environment to manually set the https port
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
    'VLLM_OPTEST_URLS_PORT':
    lambda: int(os.getenv('VLLM_OPTEST_URLS_PORT', '8000'))
    if 'VLLM_OPTEST_URLS_PORT' in os.environ else None,
    
    # Path to the optest models.
    # If set, will load models from local path instead of Hugging Face Hub.
    'VLLM_OPTEST_MODELS_PATH':
    lambda: os.getenv('VLLM_OPTEST_MODELS_PATH', "") or os.getenv("OPTEST_MODELS_PATH", ""),
    
    # flag to control if vllm should use triton prefix flash attention
    "VLLM_USE_TRITON_PREFIX_FLASH_ATTN":
    lambda: (os.environ.get("VLLM_USE_TRITON_PREFIX_FLASH_ATTN", "False").lower() in
             ("true", "1")),
    
zhuwenwen's avatar
zhuwenwen committed
1612
1613
1614
1615
    # If set, vLLM will use FLASH MLA attention optimizations.
    "VLLM_USE_FLASH_MLA":
    lambda: bool(int(os.getenv("VLLM_USE_FLASH_MLA", "1"))),
    
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
    # flag to control vllm to use optimized kernels
    "VLLM_USE_OPT_OP":
    lambda: (os.environ.get("VLLM_USE_OPT_OP", "True").lower() in
             ("true", "1")),
    
    # flag to control vllm to use optimized tc paged attn kernels
    "VLLM_USE_TC_PAGED_ATTN":
    lambda: (os.environ.get("VLLM_USE_TC_PAGED_ATTN", "True").lower() in
             ("true", "1")),
    
    # flag to control if vllm print pa parameters
    "VLLM_USE_PA_PRINT_PARAM":
    lambda: (os.environ.get("VLLM_USE_PA_PRINT_PARAM", "False").lower() in
             ("true", "1")),
    
1631
1632
1633
1634
1635
1636
    # If set, vLLM will use tree-style speculative decoding.
    "VLLM_TREE_DECODING":
    lambda: 
    (os.environ.get("VLLM_TREE_DECODING", "0").strip().lower() in
     ("1", "true")),
    
1637
1638
1639
1640
1641
1642
1643
1644
    # If set, vLLM will disable the draft model in cudagraph mode.
    "VLLM_SPEC_DECODE_EAGER":
    lambda: bool(int(os.getenv("VLLM_SPEC_DECODE_EAGER", "0"))),
    
    # flag to control vllm to use optimized kernels
    "VLLM_PCIE_USE_CUSTOM_ALLREDUCE":
    lambda: bool(int(os.environ.get("VLLM_PCIE_USE_CUSTOM_ALLREDUCE", "0"))),
    
zhuwenwen's avatar
zhuwenwen committed
1645
1646
1647
1648
    # flag to control vllm to use optimized kernels
    "VLLM_CUSTOM_ALLREDUCE_SUPPORTED_WORLDSIZE_MAX":
    lambda: int(os.getenv("VLLM_CUSTOM_ALLREDUCE_SUPPORTED_WORLDSIZE_MAX", "16")),
    
1649
1650
1651
    # If set, vLLM will disable the draft model in cudagraph mode.
    "VLLM_ENFORCE_EAGER_BS_THRESHOLD":
    lambda: int(os.environ.get("VLLM_ENFORCE_EAGER_BS_THRESHOLD", "-1")),
1652

1653
1654
1655
1656
1657
1658
    # 'has_comtext' is a variable in common.py, which is calculated
    # by metadata by default. However, it may introduce synchronization 
    # and affect performance, so it is directly assigned as False. 
    # If there are any problems during use, use environment variables 
    # to restore the default usage.
    "VLLM_HAS_CONTEXT_DEFAULT":
zhuwenwen's avatar
zhuwenwen committed
1659
    lambda: bool(int(os.getenv("VLLM_HAS_CONTEXT_DEFAULT", "1"))),
1660
1661
1662
    
    # If set, vLLM will transpose weight to use nn layout
    "VLLM_USE_NN":
zhuwenwen's avatar
zhuwenwen committed
1663
    lambda: (os.environ.get("VLLM_USE_NN", "True").lower() in
1664
             ("true", "1")),
1665

1666
1667
1668
    # Enable two batch overlap.
    "VLLM_ENABLE_TBO":
    lambda: bool(int(os.getenv("VLLM_ENABLE_TBO", "0"))),
1669
1670
1671

    # If set, vLLM will enable the moe_fused_gate kernel.
    "VLLM_ENABLE_MOE_FUSED_GATE":
zhuwenwen's avatar
zhuwenwen committed
1672
    lambda: bool(int(os.getenv("VLLM_ENABLE_MOE_FUSED_GATE", "1"))),
zhuwenwen's avatar
zhuwenwen committed
1673
    
1674
1675
    # vLLM will use FlashAttention Backend for page attention computation on rocm
    "VLLM_USE_FLASH_ATTN_PA":
zhuwenwen's avatar
zhuwenwen committed
1676
    lambda: (os.environ.get("VLLM_USE_FLASH_ATTN_PA", "True").lower() in
zhuwenwen's avatar
zhuwenwen committed
1677
             ("true", "1")),
zhuwenwen's avatar
zhuwenwen committed
1678
1679
1680
1681
1682
    
    # vLLM will use apex for rmsnorm
    "VLLM_USE_APEX_RN":
    lambda: (os.environ.get("VLLM_USE_APEX_RN", "False").lower() in
             ("true", "1")),
1683
1684
1685
    
    # vLLM will use global cache for moe
    "VLLM_USE_GLOBAL_CACHE13":
1686
        lambda: (os.environ.get("VLLM_USE_GLOBAL_CACHE13", "False").lower() in
1687
                 ("true", "1")),
1688
        
1689
1690
1691
    # vLLM will use lightop for deepseek-v3
    "VLLM_USE_LIGHTOP":
        lambda: (os.environ.get("VLLM_USE_LIGHTOP", "False").lower() in
1692
                 ("true", "1")),
1693
        
1694
1695
1696
    # vLLM will use opt cat for deepseek-v3
    "VLLM_USE_OPT_CAT":
        lambda: (os.environ.get("VLLM_USE_OPT_CAT", "True").lower() in
1697
                 ("true", "1")),  
zhuwenwen's avatar
zhuwenwen committed
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
    # vLLM will use triton moe_sum 
    "VLLM_USE_OPT_MOE_SUM":
        lambda: (os.environ.get("VLLM_USE_OPT_MOE_SUM", "False").lower() in
                 ("true", "1")),  
    # vLLM will use lightop moe_sum 
    "VLLM_USE_LIGHTOP_MOE_SUM":
        lambda: (os.environ.get("VLLM_USE_LIGHTOP_MOE_SUM", "False").lower() in
                 ("true", "1")),  
    # vLLM will use lightop moe_align_block_size 
    "VLLM_USE_LIGHTOP_MOE_ALIGN":
        lambda: (os.environ.get("VLLM_USE_LIGHTOP_MOE_ALIGN", "False").lower() in
                 ("true", "1")),     
1710
1711
1712
1713
    # vLLM will use opt merge_aatn_states,not triton
    "VLLM_USE_MERGE_ATTN_STATES_OPT":
        lambda: (os.environ.get("VLLM_USE_MERGE_ATTN_STATES_OPT", "True").lower() in
                 ("true", "1")),  
1714
1715
1716
1717
    # vllm will use rmsquant fused op 
    "USE_FUSED_RMS_QUANT": 
    lambda: (os.getenv('USE_FUSED_RMS_QUANT', '0').lower() in
             ("true", "1")),
1718
1719
1720
1721
    # vllm will use silu_mul_quant fused op 
    "USE_FUSED_SILU_MUL_QUANT": 
    lambda: (os.getenv('USE_FUSED_SILU_MUL_QUANT', '0').lower() in
             ("true", "1")),
zhuwenwen's avatar
zhuwenwen committed
1722
1723
    # vLLM will split prefill and decode, not mix up
    "VLLM_USE_PD_SPLIT":
1724
        lambda: (os.environ.get("VLLM_USE_PD_SPLIT", "False").lower() in
zhuwenwen's avatar
zhuwenwen committed
1725
                 ("true", "1")), 
zhuwenwen's avatar
zhuwenwen committed
1726
1727
1728
1729
    # vLLM will sync to avoid pp vmfault
    "VLLM_USE_PP_SYNC":
        lambda: (os.environ.get("VLLM_USE_PP_SYNC", "False").lower() in
                 ("true", "1")), 
1730
1731
1732
1733
    # vLLM will use piecewise
    "VLLM_USE_PIECEWISE":
        lambda: (os.environ.get("VLLM_USE_PIECEWISE", "True").lower() in
                 ("true", "1")), 
1734
1735
    # vllm will use encoding_dsv32.py for dpsk-v32
    "VLLM_USE_V32_ENCODE":
1736
        lambda: (os.environ.get('VLLM_USE_V32_ENCODE', 'False').lower() in
1737
                 ("true", "1")),  
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
    # vLLM will use fused silu+mul kernel (fp16 + qwen3-30b)
    "VLLM_USE_FUSE_SILU_AND_MUL":
        lambda: (os.environ.get("VLLM_USE_FUSE_SILU_AND_MUL", "False").lower() in
                 ("true", "1")),
    # vLLM will use optimized reshape_and_cache kernel when enabled (fp16 + qwen3-30b)
    "VLLM_USE_OPT_RESHAPE_AND_CACHE":
        lambda:
        (os.environ.get("VLLM_USE_OPT_RESHAPE_AND_CACHE", "False").lower() in
                ("true", "1")),
    # vLLM will use optimized topk_softmax + renormalize
    "VLLM_USE_TOPK_RENORM":
        lambda:
        (os.environ.get("VLLM_USE_TOPK_RENORM", "True").lower() in
                ("true", "1")),
1752
1753
1754
1755
1756
1757
1758
1759
    # vLLM will use fused RMS + RoPE kernel
    "VLLM_USE_FUSED_RMS_ROPE":
        lambda: (os.environ.get("VLLM_USE_FUSED_RMS_ROPE", "False").lower() in
                 ("true", "1")),
    # vLLM will use Marlin W16A16 kernel for MoE experts
    "VLLM_USE_MARLIN_W16A16_MOE":
        lambda: (os.environ.get("VLLM_USE_MARLIN_W16A16_MOE", "False").lower() in
                 ("true", "1")),
1760
1761
}

1762
# --8<-- [end:env-vars-definition]
1763

1764

1765
def __getattr__(name: str):
1766
1767
1768
1769
1770
1771
    """
    Gets environment variables lazily.

    NOTE: After enable_envs_cache() invocation (which triggered after service
    initialization), all environment variables will be cached.
    """
1772
1773
1774
1775
1776
    if name in environment_variables:
        return environment_variables[name]()
    raise AttributeError(f"module {__name__!r} has no attribute {name!r}")


1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
def enable_envs_cache() -> None:
    """
    Enables caching of environment variables. This is useful for performance
    reasons, as it avoids the need to re-evaluate environment variables on
    every call.

    NOTE: Currently, it's invoked after service initialization to reduce
    runtime overhead. This also means that environment variables should NOT
    be updated after the service is initialized.
    """
    # Tag __getattr__ with functools.cache
    global __getattr__
    __getattr__ = functools.cache(__getattr__)

    # Cache all environment variables
    for key in environment_variables:
        __getattr__(key)


1796
1797
def __dir__():
    return list(environment_variables.keys())
1798
1799
1800
1801
1802
1803
1804
1805
1806


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


1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
def compile_factors() -> dict[str, object]:
    """Return env vars used for torch.compile cache keys.

    Start with every known vLLM env var; drop entries in `ignored_factors`;
    hash everything else. This keeps the cache key aligned across workers."""

    ignored_factors: set[str] = {
        "MAX_JOBS",
        "VLLM_RPC_BASE_PATH",
        "VLLM_USE_MODELSCOPE",
        "VLLM_RINGBUFFER_WARNING_INTERVAL",
        "VLLM_DEBUG_DUMP_PATH",
        "VLLM_PORT",
        "VLLM_CACHE_ROOT",
        "LD_LIBRARY_PATH",
        "VLLM_SERVER_DEV_MODE",
        "VLLM_DP_MASTER_IP",
        "VLLM_DP_MASTER_PORT",
        "VLLM_RANDOMIZE_DP_DUMMY_INPUTS",
        "VLLM_CI_USE_S3",
        "VLLM_MODEL_REDIRECT_PATH",
        "VLLM_HOST_IP",
        "S3_ACCESS_KEY_ID",
        "S3_SECRET_ACCESS_KEY",
        "S3_ENDPOINT_URL",
        "VLLM_USAGE_STATS_SERVER",
        "VLLM_NO_USAGE_STATS",
        "VLLM_DO_NOT_TRACK",
        "VLLM_LOGGING_LEVEL",
        "VLLM_LOGGING_PREFIX",
        "VLLM_LOGGING_STREAM",
        "VLLM_LOGGING_CONFIG_PATH",
Nick Hill's avatar
Nick Hill committed
1839
        "VLLM_LOGGING_COLOR",
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
        "VLLM_LOG_STATS_INTERVAL",
        "VLLM_DEBUG_LOG_API_SERVER_RESPONSE",
        "VLLM_TUNED_CONFIG_FOLDER",
        "VLLM_ENGINE_ITERATION_TIMEOUT_S",
        "VLLM_HTTP_TIMEOUT_KEEP_ALIVE",
        "VLLM_EXECUTE_MODEL_TIMEOUT_SECONDS",
        "VLLM_KEEP_ALIVE_ON_ENGINE_DEATH",
        "VLLM_SLEEP_WHEN_IDLE",
        "VLLM_IMAGE_FETCH_TIMEOUT",
        "VLLM_VIDEO_FETCH_TIMEOUT",
        "VLLM_AUDIO_FETCH_TIMEOUT",
        "VLLM_MEDIA_URL_ALLOW_REDIRECTS",
        "VLLM_MEDIA_LOADING_THREAD_COUNT",
        "VLLM_MAX_AUDIO_CLIP_FILESIZE_MB",
        "VLLM_VIDEO_LOADER_BACKEND",
        "VLLM_MEDIA_CONNECTOR",
        "VLLM_ASSETS_CACHE",
        "VLLM_ASSETS_CACHE_MODEL_CLEAN",
        "VLLM_MM_INPUT_CACHE_GIB",
        "VLLM_WORKER_MULTIPROC_METHOD",
        "VLLM_ENABLE_V1_MULTIPROCESSING",
        "VLLM_V1_OUTPUT_PROC_CHUNK_SIZE",
        "VLLM_CPU_KVCACHE_SPACE",
        "VLLM_CPU_OMP_THREADS_BIND",
        "VLLM_CPU_NUM_OF_RESERVED_CPU",
        "VLLM_CPU_MOE_PREPACK",
        "VLLM_CPU_SGL_KERNEL",
        "VLLM_TEST_FORCE_LOAD_FORMAT",
        "LOCAL_RANK",
        "CUDA_VISIBLE_DEVICES",
Nick Hill's avatar
Nick Hill committed
1870
        "NO_COLOR",
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
    }

    from vllm.config.utils import normalize_value

    factors: dict[str, object] = {}
    for factor, getter in environment_variables.items():
        if factor in ignored_factors:
            continue

        try:
            raw = getter()
        except Exception as exc:  # pragma: no cover - defensive logging
            logger.warning(
                "Skipping environment variable %s while hashing compile factors: %s",
                factor,
                exc,
            )
            continue
1889

1890
        factors[factor] = normalize_value(raw)
1891

1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
    ray_noset_env_vars = [
        # Refer to
        # https://github.com/ray-project/ray/blob/c584b1ea97b00793d1def71eaf81537d70efba42/python/ray/_private/accelerators/nvidia_gpu.py#L11
        # https://github.com/ray-project/ray/blob/c584b1ea97b00793d1def71eaf81537d70efba42/python/ray/_private/accelerators/amd_gpu.py#L11
        # https://github.com/ray-project/ray/blob/b97d21dab233c2bd8ed7db749a82a1e594222b5c/python/ray/_private/accelerators/amd_gpu.py#L10
        # https://github.com/ray-project/ray/blob/c584b1ea97b00793d1def71eaf81537d70efba42/python/ray/_private/accelerators/npu.py#L12
        # https://github.com/ray-project/ray/blob/c584b1ea97b00793d1def71eaf81537d70efba42/python/ray/_private/accelerators/hpu.py#L12
        # https://github.com/ray-project/ray/blob/c584b1ea97b00793d1def71eaf81537d70efba42/python/ray/_private/accelerators/neuron.py#L14
        # https://github.com/ray-project/ray/blob/c584b1ea97b00793d1def71eaf81537d70efba42/python/ray/_private/accelerators/tpu.py#L38
        # https://github.com/ray-project/ray/blob/c584b1ea97b00793d1def71eaf81537d70efba42/python/ray/_private/accelerators/intel_gpu.py#L10
        # https://github.com/ray-project/ray/blob/c584b1ea97b00793d1def71eaf81537d70efba42/python/ray/_private/accelerators/rbln.py#L10
        "RAY_EXPERIMENTAL_NOSET_CUDA_VISIBLE_DEVICES",
        "RAY_EXPERIMENTAL_NOSET_ROCR_VISIBLE_DEVICES",
        "RAY_EXPERIMENTAL_NOSET_HIP_VISIBLE_DEVICES",
        "RAY_EXPERIMENTAL_NOSET_ASCEND_RT_VISIBLE_DEVICES",
        "RAY_EXPERIMENTAL_NOSET_HABANA_VISIBLE_MODULES",
        "RAY_EXPERIMENTAL_NOSET_NEURON_RT_VISIBLE_CORES",
        "RAY_EXPERIMENTAL_NOSET_TPU_VISIBLE_CHIPS",
        "RAY_EXPERIMENTAL_NOSET_ONEAPI_DEVICE_SELECTOR",
        "RAY_EXPERIMENTAL_NOSET_RBLN_RT_VISIBLE_DEVICES",
1912
    ]
1913

1914
1915
    for var in ray_noset_env_vars:
        factors[var] = normalize_value(os.getenv(var))
1916

1917
    return factors