envs.py 82.6 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
import uuid
11
12
from collections.abc import Callable
from typing import TYPE_CHECKING, Any, Literal
13
14
15

if TYPE_CHECKING:
    VLLM_HOST_IP: str = ""
16
    VLLM_PORT: int | None = None
17
    VLLM_RPC_BASE_PATH: str = tempfile.gettempdir()
18
    VLLM_USE_MODELSCOPE: bool = False
19
    VLLM_RINGBUFFER_WARNING_INTERVAL: int = 60
20
21
    VLLM_NCCL_SO_PATH: str | None = None
    LD_LIBRARY_PATH: str | None = None
22
    VLLM_ROCM_SLEEP_MEM_CHUNK_SIZE: int = 256
23
    LOCAL_RANK: int = 0
24
    CUDA_VISIBLE_DEVICES: str | None = None
25
    VLLM_ENGINE_ITERATION_TIMEOUT_S: int = 60
26
    VLLM_ENGINE_READY_TIMEOUT_S: int = 600
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
37
    VLLM_USAGE_STATS_SERVER: str = "https://stats.vllm.ai"
    VLLM_NO_USAGE_STATS: bool = False
    VLLM_DO_NOT_TRACK: bool = False
38
    VLLM_USAGE_SOURCE: str = "production"
39
    VLLM_CONFIGURE_LOGGING: bool = True
40
    VLLM_LOGGING_LEVEL: str = "INFO"
41
    VLLM_LOGGING_PREFIX: str = ""
42
    VLLM_LOGGING_STREAM: str = "ext://sys.stdout"
43
    VLLM_LOGGING_CONFIG_PATH: str | None = None
Nick Hill's avatar
Nick Hill committed
44
45
    VLLM_LOGGING_COLOR: str = "auto"
    NO_COLOR: bool = False
46
    VLLM_LOG_STATS_INTERVAL: float = 10.0
47
    VLLM_TRACE_FUNCTION: int = 0
48
49
50
    VLLM_USE_FLASHINFER_SAMPLER: bool | None = None
    VLLM_PP_LAYER_PARTITION: str | None = None
    VLLM_CPU_KVCACHE_SPACE: int | None = 0
51
    VLLM_CPU_OMP_THREADS_BIND: str = "auto"
52
    VLLM_CPU_NUM_OF_RESERVED_CPU: int | None = None
53
    VLLM_CPU_SGL_KERNEL: bool = False
54
    VLLM_ZENTORCH_WEIGHT_PREPACK: bool = True
55
    VLLM_CPU_INT4_W4A8: bool = True
56
    VLLM_XLA_CACHE_PATH: str = os.path.join(VLLM_CACHE_ROOT, "xla_cache")
57
    VLLM_XLA_CHECK_RECOMPILATION: bool = False
58
    VLLM_USE_RAY_COMPILED_DAG_CHANNEL_TYPE: Literal["auto", "nccl", "shm"] = "auto"
59
    VLLM_USE_RAY_COMPILED_DAG_OVERLAP_COMM: bool = False
60
    VLLM_USE_RAY_WRAPPED_PP_COMM: bool = True
61
    VLLM_XLA_USE_SPMD: bool = False
62
    VLLM_WORKER_MULTIPROC_METHOD: Literal["fork", "spawn"] = "fork"
63
    VLLM_ASSETS_CACHE: str = os.path.join(VLLM_CACHE_ROOT, "assets")
64
    VLLM_ASSETS_CACHE_MODEL_CLEAN: bool = False
65
    VLLM_IMAGE_FETCH_TIMEOUT: int = 5
66
    VLLM_VIDEO_FETCH_TIMEOUT: int = 30
67
    VLLM_AUDIO_FETCH_TIMEOUT: int = 10
68
69
70
    VLLM_MEDIA_CACHE: str = ""
    VLLM_MEDIA_CACHE_MAX_SIZE_MB: int = 5120
    VLLM_MEDIA_CACHE_TTL_HOURS: float = 24
71
    VLLM_MEDIA_FETCH_MAX_RETRIES: int = 3
72
    VLLM_MEDIA_URL_ALLOW_REDIRECTS: bool = True
73
    VLLM_MEDIA_LOADING_THREAD_COUNT: int = 8
74
    VLLM_MAX_AUDIO_CLIP_FILESIZE_MB: int = 25
75
    VLLM_VIDEO_LOADER_BACKEND: str = "opencv"
76
    VLLM_MEDIA_CONNECTOR: str = "http"
77
    VLLM_MM_HASHER_ALGORITHM: str = "blake3"
78
    VLLM_TARGET_DEVICE: str = "cuda"
79
    VLLM_MAIN_CUDA_VERSION: str = "12.9"
80
    VLLM_FLOAT32_MATMUL_PRECISION: Literal["highest", "high", "medium"] = "highest"
81
    VLLM_BATCH_INVARIANT: bool = False
82
83
    MAX_JOBS: str | None = None
    NVCC_THREADS: str | None = None
84
    VLLM_USE_PRECOMPILED: bool = False
85
    VLLM_SKIP_PRECOMPILED_VERSION_SUFFIX: bool = False
86
    VLLM_DOCKER_BUILD_CONTEXT: bool = False
87
    VLLM_KEEP_ALIVE_ON_ENGINE_DEATH: bool = False
88
    CMAKE_BUILD_TYPE: Literal["Debug", "Release", "RelWithDebInfo"] | None = None
89
    VERBOSE: bool = False
90
    VLLM_ALLOW_LONG_MAX_MODEL_LEN: bool = False
91
    VLLM_RPC_TIMEOUT: int = 10000  # ms
92
    VLLM_HTTP_TIMEOUT_KEEP_ALIVE: int = 5  # seconds
93
    VLLM_MAX_N_SEQUENCES: int = 16384
94
95
    VLLM_PLUGINS: list[str] | None = None
    VLLM_LORA_RESOLVER_CACHE_DIR: str | None = None
96
    VLLM_LORA_RESOLVER_HF_REPO_LIST: str | None = None
97
    VLLM_USE_AOT_COMPILE: bool = False
98
    VLLM_USE_BYTECODE_HOOK: bool = True
99
    VLLM_FORCE_AOT_LOAD: bool = False
100
    VLLM_USE_MEGA_AOT_ARTIFACT: bool = False
101
    VLLM_USE_TRITON_AWQ: bool = False
102
    VLLM_ALLOW_RUNTIME_LORA_UPDATING: bool = False
103
    VLLM_SKIP_P2P_CHECK: bool = False
104
    VLLM_DISABLED_KERNELS: list[str] = []
105
    VLLM_ENABLE_FLA_PACKED_RECURRENT_DECODE: bool = True
106
    VLLM_DISABLE_PYNCCL: bool = False
107
    VLLM_USE_OINK_OPS: bool = False
108
    VLLM_ROCM_USE_AITER: bool = False
109
    VLLM_ROCM_USE_AITER_PAGED_ATTN: bool = False
110
    VLLM_ROCM_USE_AITER_LINEAR: bool = True
111
    VLLM_ROCM_USE_AITER_MOE: bool = True
112
    VLLM_ROCM_USE_AITER_RMSNORM: bool = True
113
    VLLM_ROCM_USE_AITER_MLA: bool = True
114
    VLLM_ROCM_USE_AITER_MHA: bool = True
115
    VLLM_ROCM_USE_AITER_FP4_ASM_GEMM: bool = False
116
    VLLM_ROCM_USE_AITER_TRITON_ROPE: bool = False
117
    VLLM_ROCM_USE_AITER_FP8BMM: bool = True
118
    VLLM_ROCM_USE_AITER_FP4BMM: bool = True
119
    VLLM_ROCM_USE_AITER_UNIFIED_ATTENTION: bool = False
120
    VLLM_ROCM_USE_AITER_FUSION_SHARED_EXPERTS: bool = False
121
    VLLM_ROCM_USE_AITER_TRITON_GEMM: bool = True
122
    VLLM_ROCM_USE_SKINNY_GEMM: bool = True
123
    VLLM_ROCM_FP8_PADDING: bool = True
124
    VLLM_ROCM_MOE_PADDING: bool = True
125
    VLLM_ROCM_SHUFFLE_KV_CACHE_LAYOUT: bool = False
126
    VLLM_ENABLE_V1_MULTIPROCESSING: bool = True
127
    VLLM_LOG_BATCHSIZE_INTERVAL: float = -1
128
    VLLM_DISABLE_COMPILE_CACHE: bool = False
129
    Q_SCALE_CONSTANT: int = 200
130
131
    K_SCALE_CONSTANT: int = 200
    V_SCALE_CONSTANT: int = 100
132
    VLLM_SERVER_DEV_MODE: bool = False
133
    VLLM_V1_OUTPUT_PROC_CHUNK_SIZE: int = 128
134
    VLLM_MLA_DISABLE: bool = False
135
136
    VLLM_RAY_PER_WORKER_GPUS: float = 1.0
    VLLM_RAY_BUNDLE_INDICES: str = ""
137
    VLLM_CUDART_SO_PATH: str | None = None
138
    VLLM_DP_RANK: int = 0
139
    VLLM_DP_RANK_LOCAL: int = -1
140
    VLLM_DP_SIZE: int = 1
141
    VLLM_USE_STANDALONE_COMPILE: bool = True
142
    VLLM_ENABLE_PREGRAD_PASSES: bool = False
143
144
    VLLM_DP_MASTER_IP: str = ""
    VLLM_DP_MASTER_PORT: int = 0
145
    VLLM_MOE_DP_CHUNK_SIZE: int = 256
146
    VLLM_ENABLE_MOE_DP_CHUNK: bool = True
147
    VLLM_RANDOMIZE_DP_DUMMY_INPUTS: bool = False
148
    VLLM_RAY_DP_PACK_STRATEGY: Literal["strict", "fill", "span"] = "strict"
149
150
    VLLM_RAY_EXTRA_ENV_VAR_PREFIXES_TO_COPY: str = ""
    VLLM_RAY_EXTRA_ENV_VARS_TO_COPY: str = ""
151
    VLLM_MARLIN_USE_ATOMIC_ADD: bool = False
152
    VLLM_MARLIN_INPUT_DTYPE: Literal["int8", "fp8"] | None = None
153
    VLLM_MXFP4_USE_MARLIN: bool | None = None
154
    VLLM_DEEPEPLL_NVFP4_DISPATCH: bool = False
155
    VLLM_V1_USE_OUTLINES_CACHE: bool = False
156
    VLLM_TPU_BUCKET_PADDING_GAP: int = 0
157
    VLLM_TPU_MOST_MODEL_LEN: int | None = None
158
    VLLM_TPU_USING_PATHWAYS: bool = False
159
    VLLM_USE_DEEP_GEMM: bool = True
160
    VLLM_MOE_USE_DEEP_GEMM: bool = True
161
    VLLM_USE_DEEP_GEMM_E8M0: bool = True
162
    VLLM_USE_DEEP_GEMM_TMA_ALIGNED_SCALES: bool = True
163
164
165
166
167
    VLLM_DEEP_GEMM_WARMUP: Literal[
        "skip",
        "full",
        "relax",
    ] = "relax"
168
    VLLM_USE_FUSED_MOE_GROUPED_TOPK: bool = True
169
    VLLM_BLOCKSCALE_FP8_GEMM_FLASHINFER: bool = True
170
    VLLM_USE_FLASHINFER_MOE_FP16: bool = False
171
172
    VLLM_USE_FLASHINFER_MOE_FP8: bool = False
    VLLM_USE_FLASHINFER_MOE_FP4: bool = False
173
    VLLM_USE_FLASHINFER_MOE_INT4: bool = False
174
175
176
    VLLM_FLASHINFER_MOE_BACKEND: Literal["throughput", "latency", "masked_gemm"] = (
        "latency"
    )
177
    VLLM_FLASHINFER_ALLREDUCE_BACKEND: Literal["auto", "trtllm", "mnnvl"] = "auto"
178
    VLLM_FLASHINFER_WORKSPACE_BUFFER_SIZE: int = 394 * 1024 * 1024
179
    VLLM_XGRAMMAR_CACHE_MB: int = 0
180
    VLLM_MSGPACK_ZERO_COPY_THRESHOLD: int = 256
181
    VLLM_ALLOW_INSECURE_SERIALIZATION: bool = False
182
    VLLM_DISABLE_REQUEST_ID_RANDOMIZATION: bool = False
Robert Shaw's avatar
Robert Shaw committed
183
    VLLM_NIXL_SIDE_CHANNEL_HOST: str = "localhost"
184
    VLLM_NIXL_SIDE_CHANNEL_PORT: int = 5600
185
    VLLM_MOONCAKE_BOOTSTRAP_PORT: int = 8998
186
    VLLM_MAX_TOKENS_PER_EXPERT_FP4_MOE: int = 163840
187
    VLLM_TOOL_PARSE_REGEX_TIMEOUT_SECONDS: int = 1
188
    VLLM_MQ_MAX_CHUNK_BYTES_MB: int = 16
189
    VLLM_EXECUTE_MODEL_TIMEOUT_SECONDS: int = 300
190
    VLLM_KV_CACHE_LAYOUT: Literal["NHD", "HND"] | None = None
191
    VLLM_COMPUTE_NANS_IN_LOGITS: bool = False
192
    VLLM_USE_NVFP4_CT_EMULATIONS: bool = False
193
194
195
    VLLM_ROCM_QUICK_REDUCE_QUANTIZATION: Literal[
        "FP", "INT8", "INT6", "INT4", "NONE"
    ] = "NONE"
196
    VLLM_ROCM_QUICK_REDUCE_CAST_BF16_TO_FP16: bool = True
197
    VLLM_ROCM_QUICK_REDUCE_MAX_SIZE_BYTES_MB: int | None = None
198
    VLLM_NIXL_ABORT_REQUEST_TIMEOUT: int = 480
199
200
201
202
    VLLM_MORIIO_CONNECTOR_READ_MODE: bool = False
    VLLM_MORIIO_QP_PER_TRANSFER: int = 1
    VLLM_MORIIO_POST_BATCH_SIZE: int = -1
    VLLM_MORIIO_NUM_WORKERS: int = 1
203
    VLLM_MOONCAKE_ABORT_REQUEST_TIMEOUT: int = 480
204
    VLLM_ENABLE_CUDAGRAPH_GC: bool = False
205
    VLLM_LOOPBACK_IP: str = ""
206
    VLLM_ALLOW_CHUNKED_LOCAL_ATTN_WITH_HYBRID_KV_CACHE: bool = True
207
    VLLM_ENABLE_RESPONSES_API_STORE: bool = False
208
    VLLM_NVFP4_GEMM_BACKEND: str | None = None
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_ALLREDUCE_USE_FLASHINFER: bool = False
216
    VLLM_TUNED_CONFIG_FOLDER: str | None = None
217
    VLLM_GPT_OSS_SYSTEM_TOOL_MCP_LABELS: set[str] = set()
218
    VLLM_USE_EXPERIMENTAL_PARSER_CONTEXT: bool = False
219
    VLLM_GPT_OSS_HARMONY_SYSTEM_INSTRUCTIONS: bool = False
220
    VLLM_SYSTEM_START_DATE: str | None = None
221
    VLLM_TOOL_JSON_ERROR_AUTOMATIC_RETRY: bool = False
222
    VLLM_CUSTOM_SCOPES_FOR_PROFILING: bool = False
223
    VLLM_NVTX_SCOPES_FOR_PROFILING: bool = False
224
    VLLM_KV_EVENTS_USE_INT_BLOCK_HASHES: bool = True
225
    VLLM_OBJECT_STORAGE_SHM_BUFFER_NAME: str = "VLLM_OBJECT_STORAGE_SHM_BUFFER"
226
    VLLM_DEEPEP_BUFFER_SIZE_MB: int = 1024
227
228
    VLLM_DEEPEP_HIGH_THROUGHPUT_FORCE_INTRA_NODE: bool = False
    VLLM_DEEPEP_LOW_LATENCY_USE_MNNVL: bool = False
229
    VLLM_DBO_COMM_SMS: int = 20
230
231
    VLLM_PATTERN_MATCH_DEBUG: str | None = None
    VLLM_DEBUG_DUMP_PATH: str | None = None
232
233
    VLLM_ENABLE_INDUCTOR_MAX_AUTOTUNE: bool = True
    VLLM_ENABLE_INDUCTOR_COORDINATE_DESCENT_TUNING: bool = True
234
    VLLM_USE_NCCL_SYMM_MEM: bool = False
235
    VLLM_NCCL_INCLUDE_PATH: str | None = None
236
    VLLM_USE_FBGEMM: bool = False
237
    VLLM_GC_DEBUG: str = ""
238
    VLLM_DEBUG_WORKSPACE: bool = False
239
    VLLM_DISABLE_SHARED_EXPERTS_STREAM: bool = False
240
    VLLM_SHARED_EXPERTS_STREAM_TOKEN_THRESHOLD: int = 256
241
    VLLM_COMPILE_CACHE_SAVE_FORMAT: Literal["binary", "unpacked"] = "binary"
Woosuk Kwon's avatar
Woosuk Kwon committed
242
    VLLM_USE_V2_MODEL_RUNNER: bool = False
243
    VLLM_LOG_MODEL_INSPECTION: bool = False
244
    VLLM_DEBUG_MFU_METRICS: bool = False
245
246
    VLLM_WEIGHT_OFFLOADING_DISABLE_PIN_MEMORY: bool = False
    VLLM_WEIGHT_OFFLOADING_DISABLE_UVA: bool = False
247
    VLLM_DISABLE_LOG_LOGO: bool = False
248
    VLLM_LORA_DISABLE_PDL: bool = False
249
250
    VLLM_ENABLE_CUDA_COMPATIBILITY: bool = False
    VLLM_CUDA_COMPATIBILITY_PATH: str | None = None
251
252
    VLLM_ELASTIC_EP_SCALE_UP_LAUNCH: bool = False
    VLLM_ELASTIC_EP_DRAIN_REQUESTS: bool = False
253
    VLLM_MEMORY_PROFILER_ESTIMATE_CUDAGRAPHS: bool = False
254
    VLLM_NIXL_EP_MAX_NUM_RANKS: int = 32
255
    VLLM_XPU_ENABLE_XPU_GRAPH: bool = False
256

257
258
259
260
261
262
263
264
265
266
267
268
269
270
271

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


272
def maybe_convert_int(value: str | None) -> int | None:
273
274
275
276
277
    if value is None:
        return None
    return int(value)


278
def maybe_convert_bool(value: str | None) -> bool | None:
279
280
281
282
283
    if value is None:
        return None
    return bool(int(value))


284
285
286
287
def disable_compile_cache() -> bool:
    return bool(int(os.getenv("VLLM_DISABLE_COMPILE_CACHE", "0")))


288
def use_aot_compile() -> bool:
289
    from vllm.utils.torch_utils import is_torch_equal_or_newer
290

291
292
    default_value = (
        "1"
293
        if is_torch_equal_or_newer("2.10.0") and not disable_compile_cache()
294
295
296
        else "0"
    )

297
    return (
298
        not bool(int(os.getenv("VLLM_BATCH_INVARIANT", "0")))
299
300
        and os.environ.get("VLLM_USE_AOT_COMPILE", default_value) == "1"
    )
301
302


303
304
305
306
307
308
309
310
311
312
def use_mega_aot_artifact():
    from vllm.utils.torch_utils import is_torch_equal_or_newer

    default_value = (
        "1" if is_torch_equal_or_newer("2.12.0.dev") and use_aot_compile() else "0"
    )

    return os.environ.get("VLLM_USE_MEGA_AOT_ARTIFACT", default_value) == "1"


313
def env_with_choices(
314
    env_name: str,
315
316
    default: str | None,
    choices: list[str] | Callable[[], list[str]],
317
    case_sensitive: bool = True,
318
) -> Callable[[], str | None]:
319
320
    """
    Create a lambda that validates environment variable against allowed choices
321

322
323
324
325
326
    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
327

328
329
330
331
    Returns:
        Lambda function for environment_variables dict
    """

332
    def _get_validated_env() -> str | None:
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
        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:
348
349
350
351
            raise ValueError(
                f"Invalid value '{value}' for {env_name}. "
                f"Valid options: {actual_choices}."
            )
352
353
354
355
356
357

        return value

    return _get_validated_env


358
def env_list_with_choices(
359
360
    env_name: str,
    default: list[str],
361
    choices: list[str] | Callable[[], list[str]],
362
363
    case_sensitive: bool = True,
) -> Callable[[], list[str]]:
364
    """
365
    Create a lambda that validates environment variable
366
    containing comma-separated values against allowed choices
367

368
369
370
371
372
    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
373

374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
    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:
403
404
405
406
                raise ValueError(
                    f"Invalid value '{val}' in {env_name}. "
                    f"Valid options: {actual_choices}."
                )
407
408
409
410
411
412

        return values

    return _get_validated_env_list


413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
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


431
def get_vllm_port() -> int | None:
432
    """Get the port from VLLM_PORT environment variable.
433

434
435
    Returns:
        The port number as an integer if VLLM_PORT is set, None otherwise.
436

437
438
439
    Raises:
        ValueError: If VLLM_PORT is a URI, suggest k8s service discovery issue.
    """
440
    if "VLLM_PORT" not in os.environ:
441
442
        return None

443
    port = os.getenv("VLLM_PORT", "0")
444
445
446
447

    try:
        return int(port)
    except ValueError as err:
448
        from urllib3.util import parse_url
449

450
        parsed = parse_url(port)
451
452
453
454
455
456
        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
457
        raise ValueError(f"VLLM_PORT '{port}' must be a valid integer") from err
458
459


460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
def get_env_or_set_default(
    env_name: str,
    default_factory: Callable[[], str],
) -> Callable[[], str]:
    """
    Create a lambda that returns an environment variable value if set,
    or generates and sets a default value using the provided factory function.
    """

    def _get_or_set_default() -> str:
        value = os.getenv(env_name)
        if value is not None:
            return value

        default_value = default_factory()
        os.environ[env_name] = default_value
        return default_value

    return _get_or_set_default


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

484
# --8<-- [start:env-vars-definition]
485

486
487
logger = logging.getLogger(__name__)

488
environment_variables: dict[str, Callable[[], Any]] = {
489
    # ================== Installation Time Env Vars ==================
490
    # Target device of vLLM, supporting [cuda (by default),
491
    # rocm, cpu]
492
    "VLLM_TARGET_DEVICE": lambda: os.getenv("VLLM_TARGET_DEVICE", "cuda").lower(),
493
    # Main CUDA version of vLLM. This follows PyTorch but can be overridden.
494
    "VLLM_MAIN_CUDA_VERSION": lambda: os.getenv("VLLM_MAIN_CUDA_VERSION", "").lower()
495
    or "12.9",
496
    # Controls PyTorch float32 matmul precision mode within vLLM workers.
497
    # Valid options mirror torch.set_float32_matmul_precision
498
499
    "VLLM_FLOAT32_MATMUL_PRECISION": env_with_choices(
        "VLLM_FLOAT32_MATMUL_PRECISION",
500
501
        "highest",
        ["highest", "high", "medium"],
502
503
        case_sensitive=False,
    ),
504
505
506
    # Enable batch-invariant mode: deterministic results regardless of
    # batch composition. Requires NVIDIA GPU with compute capability >= 9.0.
    "VLLM_BATCH_INVARIANT": lambda: bool(int(os.getenv("VLLM_BATCH_INVARIANT", "0"))),
507
508
    # Maximum number of compilation jobs to run in parallel.
    # By default this is the number of CPUs
509
    "MAX_JOBS": lambda: os.getenv("MAX_JOBS", None),
510
511
512
    # Number of threads to use for nvcc
    # By default this is 1.
    # If set, `MAX_JOBS` will be reduced to avoid oversubscribing the CPU.
513
    "NVCC_THREADS": lambda: os.getenv("NVCC_THREADS", None),
514
    # If set, vllm will use precompiled binaries (*.so)
515
516
517
518
519
    "VLLM_USE_PRECOMPILED": lambda: os.environ.get("VLLM_USE_PRECOMPILED", "")
    .strip()
    .lower()
    in ("1", "true")
    or bool(os.environ.get("VLLM_PRECOMPILED_WHEEL_LOCATION")),
520
521
522
523
    # If set, skip adding +precompiled suffix to version string
    "VLLM_SKIP_PRECOMPILED_VERSION_SUFFIX": lambda: bool(
        int(os.environ.get("VLLM_SKIP_PRECOMPILED_VERSION_SUFFIX", "0"))
    ),
524
525
    # Used to mark that setup.py is running in a Docker build context,
    # in order to force the use of precompiled binaries.
526
527
528
529
    "VLLM_DOCKER_BUILD_CONTEXT": lambda: os.environ.get("VLLM_DOCKER_BUILD_CONTEXT", "")
    .strip()
    .lower()
    in ("1", "true"),
530
531
532
    # CMake build type
    # If not set, defaults to "Debug" or "RelWithDebInfo"
    # Available options: "Debug", "Release", "RelWithDebInfo"
533
534
535
    "CMAKE_BUILD_TYPE": env_with_choices(
        "CMAKE_BUILD_TYPE", None, ["Debug", "Release", "RelWithDebInfo"]
    ),
536
    # If set, vllm will print verbose logs during installation
537
    "VERBOSE": lambda: bool(int(os.getenv("VERBOSE", "0"))),
538
    # Root directory for vLLM configuration files
539
    # Defaults to `~/.config/vllm` unless `XDG_CONFIG_HOME` is set
540
541
542
    # 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**.
543
    "VLLM_CONFIG_ROOT": lambda: os.path.expanduser(
544
545
546
        os.getenv(
            "VLLM_CONFIG_ROOT",
            os.path.join(get_default_config_root(), "vllm"),
547
548
        )
    ),
549
    # ================== Runtime Env Vars ==================
550
    # Root directory for vLLM cache files
551
    # Defaults to `~/.cache/vllm` unless `XDG_CACHE_HOME` is set
552
    "VLLM_CACHE_ROOT": lambda: os.path.expanduser(
553
554
555
        os.getenv(
            "VLLM_CACHE_ROOT",
            os.path.join(get_default_cache_root(), "vllm"),
556
557
        )
    ),
558
559
560
561
    # 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.
562
    "VLLM_HOST_IP": lambda: os.getenv("VLLM_HOST_IP", ""),
563
    # used in distributed environment to manually set the communication port
564
565
566
    # 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.
567
    "VLLM_PORT": get_vllm_port,
568
569
    # path used for ipc when the frontend api server is running in
    # multi-processing mode to communicate with the backend engine process.
570
571
572
    "VLLM_RPC_BASE_PATH": lambda: os.getenv(
        "VLLM_RPC_BASE_PATH", tempfile.gettempdir()
    ),
573
574
    # If true, will load models from ModelScope instead of Hugging Face Hub.
    # note that the value is true or false, not numbers
575
576
577
578
    "VLLM_USE_MODELSCOPE": lambda: os.environ.get(
        "VLLM_USE_MODELSCOPE", "False"
    ).lower()
    == "true",
579
    # Interval in seconds to log a warning message when the ring buffer is full
580
581
582
    "VLLM_RINGBUFFER_WARNING_INTERVAL": lambda: int(
        os.environ.get("VLLM_RINGBUFFER_WARNING_INTERVAL", "60")
    ),
583
584
    # path to cudatoolkit home directory, under which should be bin, include,
    # and lib directories.
585
    "CUDA_HOME": lambda: os.environ.get("CUDA_HOME", None),
586
587
    # 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
588
    "VLLM_NCCL_SO_PATH": lambda: os.environ.get("VLLM_NCCL_SO_PATH", None),
589
590
    # 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`
591
    "LD_LIBRARY_PATH": lambda: os.environ.get("LD_LIBRARY_PATH", None),
592
593
594
595
    # 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")
    ),
596
    # Feature flag to enable/disable Inductor standalone compile.
597
598
    # In torch <= 2.7 we ignore this flag; in torch >= 2.9 this is
    # enabled by default.
599
    "VLLM_USE_STANDALONE_COMPILE": lambda: os.environ.get(
600
        "VLLM_USE_STANDALONE_COMPILE", "1"
601
602
    )
    == "1",
603
604
605
606
607
608
609
610
611
    # Inductor's pre-grad passes don't do anything for vLLM.
    # The pre-grad passes get run even on cache-hit and negatively impact
    # vllm cold compile times by O(1s)
    # Can remove this after the following issue gets fixed
    # https://github.com/pytorch/pytorch/issues/174502
    "VLLM_ENABLE_PREGRAD_PASSES": lambda: os.environ.get(
        "VLLM_ENABLE_PREGRAD_PASSES", "0"
    )
    == "1",
612
613
    # Debug pattern matching inside custom passes.
    # Should be set to the fx.Node name (e.g. 'getitem_34' or 'scaled_mm_3').
614
615
616
    "VLLM_PATTERN_MATCH_DEBUG": lambda: os.environ.get(
        "VLLM_PATTERN_MATCH_DEBUG", None
    ),
617
618
    # Dump fx graphs to the given directory.
    # It will override CompilationConfig.debug_dump_path if set.
619
    "VLLM_DEBUG_DUMP_PATH": lambda: os.environ.get("VLLM_DEBUG_DUMP_PATH", None),
620
621
622
623
    # 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,
624
625
626
627
628
    # Feature flag to enable/disable bytecode in
    # TorchCompileWithNoGuardsWrapper.
    "VLLM_USE_BYTECODE_HOOK": lambda: bool(
        int(os.environ.get("VLLM_USE_BYTECODE_HOOK", "1"))
    ),
629
630
631
632
    # 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",
633
634
635
    # Enable loading compiled models directly from cached standalone compile artifacts
    # without re-splitting graph modules. This reduces overhead during model
    # loading by using reconstruct_serializable_fn_from_mega_artifact.
636
    "VLLM_USE_MEGA_AOT_ARTIFACT": use_mega_aot_artifact,
637
638
    # local rank of the process in the distributed setting, used to determine
    # the GPU device id
639
    "LOCAL_RANK": lambda: int(os.environ.get("LOCAL_RANK", "0")),
640
    # used to control the visible devices in the distributed setting
641
    "CUDA_VISIBLE_DEVICES": lambda: os.environ.get("CUDA_VISIBLE_DEVICES", None),
642
    # timeout for each iteration in the engine
643
644
645
    "VLLM_ENGINE_ITERATION_TIMEOUT_S": lambda: int(
        os.environ.get("VLLM_ENGINE_ITERATION_TIMEOUT_S", "60")
    ),
646
647
648
649
650
    # Timeout in seconds for waiting for engine cores to become ready
    # during startup. Default is 600 seconds (10 minutes).
    "VLLM_ENGINE_READY_TIMEOUT_S": lambda: int(
        os.environ.get("VLLM_ENGINE_READY_TIMEOUT_S", "600")
    ),
651
    # API key for vLLM API server
652
    "VLLM_API_KEY": lambda: os.environ.get("VLLM_API_KEY", None),
653
    # Whether to log responses from API Server for debugging
654
655
656
657
    "VLLM_DEBUG_LOG_API_SERVER_RESPONSE": lambda: os.environ.get(
        "VLLM_DEBUG_LOG_API_SERVER_RESPONSE", "False"
    ).lower()
    == "true",
658
    # S3 access information, used for tensorizer to load model from S3
659
660
661
    "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),
662
    # Usage stats collection
663
664
665
666
667
668
669
670
671
672
673
    "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_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"),
674
675
676
677
    # 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
678
679
680
    "VLLM_CONFIGURE_LOGGING": lambda: bool(
        int(os.getenv("VLLM_CONFIGURE_LOGGING", "1"))
    ),
681
    "VLLM_LOGGING_CONFIG_PATH": lambda: os.getenv("VLLM_LOGGING_CONFIG_PATH"),
682
    # this is used for configuring the default logging level
683
    "VLLM_LOGGING_LEVEL": lambda: os.getenv("VLLM_LOGGING_LEVEL", "INFO").upper(),
684
    # this is used for configuring the default logging stream
685
    "VLLM_LOGGING_STREAM": lambda: os.getenv("VLLM_LOGGING_STREAM", "ext://sys.stdout"),
686
    # if set, VLLM_LOGGING_PREFIX will be prepended to all log messages
687
    "VLLM_LOGGING_PREFIX": lambda: os.getenv("VLLM_LOGGING_PREFIX", ""),
Nick Hill's avatar
Nick Hill committed
688
689
690
691
692
    # 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",
693
694
    # If set, vllm will log stats at this interval in seconds
    # If not set, vllm will log stats every 10 seconds.
695
696
697
    "VLLM_LOG_STATS_INTERVAL": lambda: val
    if (val := float(os.getenv("VLLM_LOG_STATS_INTERVAL", "10."))) > 0.0
    else 10.0,
698
699
700
    # Trace function calls
    # If set to 1, vllm will trace function calls
    # Useful for debugging
701
    "VLLM_TRACE_FUNCTION": lambda: int(os.getenv("VLLM_TRACE_FUNCTION", "0")),
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
    # (Zen CPU backend) eagerly prepack weights into ZenDNN blocked layout
    # at model load time. Eliminates per-inference layout conversion overhead.
    "VLLM_ZENTORCH_WEIGHT_PREPACK": lambda: bool(
        int(os.getenv("VLLM_ZENTORCH_WEIGHT_PREPACK", "1"))
    ),
732
733
    # (CPU backend only) whether to use SGLang INT4 W4A8 kernels for AWQ.
    "VLLM_CPU_INT4_W4A8": lambda: bool(int(os.getenv("VLLM_CPU_INT4_W4A8", "1"))),
734
735
736
737
738
739
740
    # 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
741
742
743
    "VLLM_USE_RAY_COMPILED_DAG_CHANNEL_TYPE": env_with_choices(
        "VLLM_USE_RAY_COMPILED_DAG_CHANNEL_TYPE", "auto", ["auto", "nccl", "shm"]
    ),
744
    # If the env var is set, it enables GPU communication overlap
745
    # (experimental feature) in Ray's Compiled Graph.
746
747
748
    "VLLM_USE_RAY_COMPILED_DAG_OVERLAP_COMM": lambda: bool(
        int(os.getenv("VLLM_USE_RAY_COMPILED_DAG_OVERLAP_COMM", "0"))
    ),
749
750
751
    # 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.
752
753
754
    "VLLM_USE_RAY_WRAPPED_PP_COMM": lambda: bool(
        int(os.getenv("VLLM_USE_RAY_WRAPPED_PP_COMM", "1"))
    ),
755
756
    # Use dedicated multiprocess context for workers.
    # Both spawn and fork work
757
758
759
    "VLLM_WORKER_MULTIPROC_METHOD": env_with_choices(
        "VLLM_WORKER_MULTIPROC_METHOD", "fork", ["spawn", "fork"]
    ),
760
    # Path to the cache for storing downloaded assets
761
    "VLLM_ASSETS_CACHE": lambda: os.path.expanduser(
762
763
764
        os.getenv(
            "VLLM_ASSETS_CACHE",
            os.path.join(get_default_cache_root(), "vllm", "assets"),
765
766
        )
    ),
767
768
    # If the env var is set, we will clean model file in
    # this path $VLLM_ASSETS_CACHE/model_streamer/$model_name
769
770
771
    "VLLM_ASSETS_CACHE_MODEL_CLEAN": lambda: bool(
        int(os.getenv("VLLM_ASSETS_CACHE_MODEL_CLEAN", "0"))
    ),
772
773
    # Timeout for fetching images when serving multimodal models
    # Default is 5 seconds
774
    "VLLM_IMAGE_FETCH_TIMEOUT": lambda: int(os.getenv("VLLM_IMAGE_FETCH_TIMEOUT", "5")),
775
    # Timeout for fetching videos when serving multimodal models
776
    # Default is 30 seconds
777
778
779
    "VLLM_VIDEO_FETCH_TIMEOUT": lambda: int(
        os.getenv("VLLM_VIDEO_FETCH_TIMEOUT", "30")
    ),
780
    # Timeout for fetching audio when serving multimodal models
781
    # Default is 10 seconds
782
783
784
    "VLLM_AUDIO_FETCH_TIMEOUT": lambda: int(
        os.getenv("VLLM_AUDIO_FETCH_TIMEOUT", "10")
    ),
785
786
787
788
789
790
791
792
793
794
795
796
797
    # Directory for caching media downloads (images, video, audio fetched
    # from URLs during inference). Empty string disables caching.
    "VLLM_MEDIA_CACHE": lambda: os.getenv("VLLM_MEDIA_CACHE", ""),
    # Maximum cache size in MB. When exceeded, least-recently-used entries
    # are evicted. Default is 5120 (5 GB).
    "VLLM_MEDIA_CACHE_MAX_SIZE_MB": lambda: int(
        os.getenv("VLLM_MEDIA_CACHE_MAX_SIZE_MB", "5120")
    ),
    # Time-to-live in hours for cached media files. Entries older than this
    # are evicted regardless of cache size. Default is 24 hours.
    "VLLM_MEDIA_CACHE_TTL_HOURS": lambda: float(
        os.getenv("VLLM_MEDIA_CACHE_TTL_HOURS", "24")
    ),
798
799
800
801
802
    # Maximum number of retries for fetching media (images, audio, video)
    # from URLs. Each retry quadruples the timeout. Default is 3.
    "VLLM_MEDIA_FETCH_MAX_RETRIES": lambda: int(
        os.getenv("VLLM_MEDIA_FETCH_MAX_RETRIES", "3")
    ),
803
804
    # Whether to allow HTTP redirects when fetching from media URLs.
    # Default to True
805
806
807
    "VLLM_MEDIA_URL_ALLOW_REDIRECTS": lambda: bool(
        int(os.getenv("VLLM_MEDIA_URL_ALLOW_REDIRECTS", "1"))
    ),
808
809
810
    # Max number of workers for the thread pool handling
    # media bytes loading. Set to 1 to disable parallel processing.
    # Default is 8
811
812
813
    "VLLM_MEDIA_LOADING_THREAD_COUNT": lambda: int(
        os.getenv("VLLM_MEDIA_LOADING_THREAD_COUNT", "8")
    ),
814
815
816
    # 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
817
818
819
    "VLLM_MAX_AUDIO_CLIP_FILESIZE_MB": lambda: int(
        os.getenv("VLLM_MAX_AUDIO_CLIP_FILESIZE_MB", "25")
    ),
820
821
    # Backend for Video IO
    # - "opencv": Default backend that uses OpenCV stream buffered backend.
Roger Wang's avatar
Roger Wang committed
822
    # - "identity": Returns raw video bytes for model processor to handle.
823
824
825
826
827
    #
    # 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.
828
829
830
    "VLLM_VIDEO_LOADER_BACKEND": lambda: os.getenv(
        "VLLM_VIDEO_LOADER_BACKEND", "opencv"
    ),
831
832
833
834
835
836
837
838
    # 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"),
839
840
841
842
843
844
845
846
847
848
849
    # Hash algorithm for multimodal content hashing.
    # - "blake3": Default, fast cryptographic hash (not FIPS 140-3 compliant)
    # - "sha256": FIPS 140-3 compliant, widely supported
    # - "sha512": FIPS 140-3 compliant, faster on 64-bit systems
    # Use sha256 or sha512 for FIPS compliance in government/enterprise deployments
    "VLLM_MM_HASHER_ALGORITHM": env_with_choices(
        "VLLM_MM_HASHER_ALGORITHM",
        "blake3",
        ["blake3", "sha256", "sha512"],
        case_sensitive=False,
    ),
850
851
    # Path to the XLA persistent cache directory.
    # Only used for XLA devices such as TPUs.
852
    "VLLM_XLA_CACHE_PATH": lambda: os.path.expanduser(
853
        os.getenv(
854
            "VLLM_XLA_CACHE_PATH",
855
            os.path.join(get_default_cache_root(), "vllm", "xla_cache"),
856
857
        )
    ),
858
    # If set, assert on XLA recompilation after each execution step.
859
860
861
    "VLLM_XLA_CHECK_RECOMPILATION": lambda: bool(
        int(os.getenv("VLLM_XLA_CHECK_RECOMPILATION", "0"))
    ),
862
    # Enable SPMD mode for TPU backend.
863
    "VLLM_XLA_USE_SPMD": lambda: bool(int(os.getenv("VLLM_XLA_USE_SPMD", "0"))),
864
865
    # If set, the OpenAI API server will stay alive even after the underlying
    # AsyncLLMEngine errors and stops serving requests
866
    "VLLM_KEEP_ALIVE_ON_ENGINE_DEATH": lambda: bool(
867
        int(os.getenv("VLLM_KEEP_ALIVE_ON_ENGINE_DEATH", "0"))
868
    ),
869
870
871
872
    # 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.
873
874
875
876
    "VLLM_ALLOW_LONG_MAX_MODEL_LEN": lambda: (
        os.environ.get("VLLM_ALLOW_LONG_MAX_MODEL_LEN", "0").strip().lower()
        in ("1", "true")
    ),
877
878
    # If set, forces FP8 Marlin to be used for FP8 quantization regardless
    # of the hardware support for FP8 compute.
879
880
881
882
883
884
885
    "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"
    ),
886
887
    # Time in ms for the zmq client to wait for a response from the backend
    # server for simple data operations
888
    "VLLM_RPC_TIMEOUT": lambda: int(os.getenv("VLLM_RPC_TIMEOUT", "10000")),
889
    # Timeout in seconds for keeping HTTP connections alive in API server
890
891
892
    "VLLM_HTTP_TIMEOUT_KEEP_ALIVE": lambda: int(
        os.environ.get("VLLM_HTTP_TIMEOUT_KEEP_ALIVE", "5")
    ),
893
894
895
896
897
898
    # Maximum allowed value for the `n` sampling parameter (number of output
    # sequences per request). Limits resource consumption to prevent
    # denial-of-service via excessively large fan-out. Default: 16384.
    "VLLM_MAX_N_SEQUENCES": lambda: int(
        os.environ.get("VLLM_MAX_N_SEQUENCES", "16384")
    ),
899
900
901
    # 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
902
903
904
    "VLLM_PLUGINS": lambda: None
    if "VLLM_PLUGINS" not in os.environ
    else os.environ["VLLM_PLUGINS"].split(","),
905
906
907
    # a local directory to look in for unrecognized LoRA adapters.
    # only works if plugins are enabled and
    # VLLM_ALLOW_RUNTIME_LORA_UPDATING is enabled.
908
909
910
    "VLLM_LORA_RESOLVER_CACHE_DIR": lambda: os.getenv(
        "VLLM_LORA_RESOLVER_CACHE_DIR", None
    ),
911
912
913
914
915
916
917
    # A remote HF repo(s) containing one or more LoRA adapters, which
    # may be downloaded and leveraged as needed. Only works if plugins
    # are enabled and VLLM_ALLOW_RUNTIME_LORA_UPDATING is enabled.
    # Values should be comma separated.
    "VLLM_LORA_RESOLVER_HF_REPO_LIST": lambda: os.getenv(
        "VLLM_LORA_RESOLVER_HF_REPO_LIST", None
    ),
918
    # If set, vLLM will use Triton implementations of AWQ.
919
    "VLLM_USE_TRITON_AWQ": lambda: bool(int(os.getenv("VLLM_USE_TRITON_AWQ", "0"))),
920
    # If set, allow loading or unloading lora adapters in runtime,
921
922
923
924
    "VLLM_ALLOW_RUNTIME_LORA_UPDATING": lambda: (
        os.environ.get("VLLM_ALLOW_RUNTIME_LORA_UPDATING", "0").strip().lower()
        in ("1", "true")
    ),
925
926
927
928
929
930
    # 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
931
    "VLLM_SKIP_P2P_CHECK": lambda: os.getenv("VLLM_SKIP_P2P_CHECK", "1") == "1",
932
933
934
935
    # List of quantization kernels that should be disabled, used for testing
    # and performance comparisons. Currently only affects MPLinearKernel
    # selection
    # (kernels: MacheteLinearKernel, MarlinLinearKernel, ExllamaLinearKernel)
936
937
938
    "VLLM_DISABLED_KERNELS": lambda: []
    if "VLLM_DISABLED_KERNELS" not in os.environ
    else os.environ["VLLM_DISABLED_KERNELS"].split(","),
939
940
941
    "VLLM_ENABLE_FLA_PACKED_RECURRENT_DECODE": lambda: bool(
        int(os.getenv("VLLM_ENABLE_FLA_PACKED_RECURRENT_DECODE", "1"))
    ),
942
    # Disable pynccl (using torch.distributed instead)
943
944
945
    "VLLM_DISABLE_PYNCCL": lambda: (
        os.getenv("VLLM_DISABLE_PYNCCL", "False").lower() in ("true", "1")
    ),
946
947
948
949
950
    # Optional: enable external Oink custom ops (e.g., Blackwell RMSNorm).
    # Disabled by default.
    "VLLM_USE_OINK_OPS": lambda: (
        os.getenv("VLLM_USE_OINK_OPS", "False").lower() in ("true", "1")
    ),
951
952
    # Disable aiter ops unless specifically enabled.
    # Acts as a parent switch to enable the rest of the other operations.
953
954
955
    "VLLM_ROCM_USE_AITER": lambda: (
        os.getenv("VLLM_ROCM_USE_AITER", "False").lower() in ("true", "1")
    ),
956
957
    # Whether to use aiter paged attention.
    # By default is disabled.
958
959
960
    "VLLM_ROCM_USE_AITER_PAGED_ATTN": lambda: (
        os.getenv("VLLM_ROCM_USE_AITER_PAGED_ATTN", "False").lower() in ("true", "1")
    ),
961
962
963
    # use aiter linear op if aiter ops are enabled
    # The following list of related ops
    # - scaled_mm (per-tensor / rowwise)
964
965
966
    "VLLM_ROCM_USE_AITER_LINEAR": lambda: (
        os.getenv("VLLM_ROCM_USE_AITER_LINEAR", "True").lower() in ("true", "1")
    ),
967
968
    # Whether to use aiter moe ops.
    # By default is enabled.
969
970
971
    "VLLM_ROCM_USE_AITER_MOE": lambda: (
        os.getenv("VLLM_ROCM_USE_AITER_MOE", "True").lower() in ("true", "1")
    ),
972
    # use aiter rms norm op if aiter ops are enabled.
973
974
975
    "VLLM_ROCM_USE_AITER_RMSNORM": lambda: (
        os.getenv("VLLM_ROCM_USE_AITER_RMSNORM", "True").lower() in ("true", "1")
    ),
976
977
    # Whether to use aiter mla ops.
    # By default is enabled.
978
979
980
    "VLLM_ROCM_USE_AITER_MLA": lambda: (
        os.getenv("VLLM_ROCM_USE_AITER_MLA", "True").lower() in ("true", "1")
    ),
981
982
    # Whether to use aiter mha ops.
    # By default is enabled.
983
984
985
    "VLLM_ROCM_USE_AITER_MHA": lambda: (
        os.getenv("VLLM_ROCM_USE_AITER_MHA", "True").lower() in ("true", "1")
    ),
986
987
    # Whether to use aiter fp4 gemm asm.
    # By default is disabled.
988
989
990
    "VLLM_ROCM_USE_AITER_FP4_ASM_GEMM": lambda: (
        os.getenv("VLLM_ROCM_USE_AITER_FP4_ASM_GEMM", "False").lower() in ("true", "1")
    ),
991
    # Whether to use aiter rope.
992
    # By default is disabled.
993
    "VLLM_ROCM_USE_AITER_TRITON_ROPE": lambda: (
994
        os.getenv("VLLM_ROCM_USE_AITER_TRITON_ROPE", "False").lower() in ("true", "1")
995
    ),
996
997
    # Whether to use aiter triton fp8 bmm kernel
    # By default is enabled.
998
999
1000
    "VLLM_ROCM_USE_AITER_FP8BMM": lambda: (
        os.getenv("VLLM_ROCM_USE_AITER_FP8BMM", "True").lower() in ("true", "1")
    ),
1001
1002
1003
1004
1005
    # Whether to use aiter triton fp4 bmm kernel
    # By default is enabled.
    "VLLM_ROCM_USE_AITER_FP4BMM": lambda: (
        os.getenv("VLLM_ROCM_USE_AITER_FP4BMM", "True").lower() in ("true", "1")
    ),
1006
1007
1008
1009
1010
    # 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")
    ),
1011
    # Whether to use aiter fusion shared experts ops.
1012
    # By default is disabled.
1013
    "VLLM_ROCM_USE_AITER_FUSION_SHARED_EXPERTS": lambda: (
1014
        os.getenv("VLLM_ROCM_USE_AITER_FUSION_SHARED_EXPERTS", "False").lower()
1015
1016
        in ("true", "1")
    ),
1017
1018
1019
1020
1021
    # Whether to use aiter triton kernels for gemm ops.
    # By default is enabled.
    "VLLM_ROCM_USE_AITER_TRITON_GEMM": lambda: (
        os.getenv("VLLM_ROCM_USE_AITER_TRITON_GEMM", "True").lower() in ("true", "1")
    ),
1022
    # use rocm skinny gemms
1023
1024
1025
    "VLLM_ROCM_USE_SKINNY_GEMM": lambda: (
        os.getenv("VLLM_ROCM_USE_SKINNY_GEMM", "True").lower() in ("true", "1")
    ),
1026
    # Pad the fp8 weights to 256 bytes for ROCm
1027
    "VLLM_ROCM_FP8_PADDING": lambda: bool(int(os.getenv("VLLM_ROCM_FP8_PADDING", "1"))),
1028
    # Pad the weights for the moe kernel
1029
    "VLLM_ROCM_MOE_PADDING": lambda: bool(int(os.getenv("VLLM_ROCM_MOE_PADDING", "1"))),
1030
1031
1032
1033
    # Whether to use the shuffled kv cache layout
    "VLLM_ROCM_SHUFFLE_KV_CACHE_LAYOUT": lambda: (
        os.getenv("VLLM_ROCM_SHUFFLE_KV_CACHE_LAYOUT", "False").lower() in ("true", "1")
    ),
1034
1035
1036
    # Custom quick allreduce kernel for MI3* cards
    # Choice of quantization level: FP, INT8, INT6, INT4 or NONE
    # Recommended for large models to get allreduce
1037
1038
1039
1040
1041
    "VLLM_ROCM_QUICK_REDUCE_QUANTIZATION": env_with_choices(
        "VLLM_ROCM_QUICK_REDUCE_QUANTIZATION",
        "NONE",
        ["FP", "INT8", "INT6", "INT4", "NONE"],
    ),
1042
1043
1044
1045
    # 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
1046
1047
1048
1049
    "VLLM_ROCM_QUICK_REDUCE_CAST_BF16_TO_FP16": lambda: (
        os.getenv("VLLM_ROCM_QUICK_REDUCE_CAST_BF16_TO_FP16", "True").lower()
        in ("true", "1")
    ),
1050
1051
1052
1053
1054
1055
    # 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.
1056
1057
1058
    "VLLM_ROCM_QUICK_REDUCE_MAX_SIZE_BYTES_MB": lambda: maybe_convert_int(
        os.environ.get("VLLM_ROCM_QUICK_REDUCE_MAX_SIZE_BYTES_MB", None)
    ),
1059
    # Divisor for dynamic query scale factor calculation for FP8 KV Cache
1060
    "Q_SCALE_CONSTANT": lambda: int(os.getenv("Q_SCALE_CONSTANT", "200")),
1061
    # Divisor for dynamic key scale factor calculation for FP8 KV Cache
1062
    "K_SCALE_CONSTANT": lambda: int(os.getenv("K_SCALE_CONSTANT", "200")),
1063
    # Divisor for dynamic value scale factor calculation for FP8 KV Cache
1064
    "V_SCALE_CONSTANT": lambda: int(os.getenv("V_SCALE_CONSTANT", "100")),
1065
    # If set, enable multiprocessing in LLM for the V1 code path.
1066
1067
1068
1069
1070
1071
    "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")
    ),
1072
    "VLLM_DISABLE_COMPILE_CACHE": disable_compile_cache,
1073
1074
1075
    # If set, vllm will run in development mode, which will enable
    # some additional endpoints for developing and debugging,
    # e.g. `/reset_prefix_cache`
1076
    "VLLM_SERVER_DEV_MODE": lambda: bool(int(os.getenv("VLLM_SERVER_DEV_MODE", "0"))),
1077
1078
1079
1080
1081
1082
1083
    # 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.
1084
1085
1086
    "VLLM_V1_OUTPUT_PROC_CHUNK_SIZE": lambda: int(
        os.getenv("VLLM_V1_OUTPUT_PROC_CHUNK_SIZE", "128")
    ),
1087
    # If set, vLLM will disable the MLA attention optimizations.
1088
    "VLLM_MLA_DISABLE": lambda: bool(int(os.getenv("VLLM_MLA_DISABLE", "0"))),
1089
    # If set, vLLM will pick up the provided Flash Attention MLA
1090
1091
1092
    # 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.
1093
1094
1095
    "VLLM_RAY_PER_WORKER_GPUS": lambda: float(
        os.getenv("VLLM_RAY_PER_WORKER_GPUS", "1.0")
    ),
1096
1097
1098
    # 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"
1099
    "VLLM_RAY_BUNDLE_INDICES": lambda: os.getenv("VLLM_RAY_BUNDLE_INDICES", ""),
1100
1101
    # In some system, find_loaded_library() may not work. So we allow users to
    # specify the path through environment variable VLLM_CUDART_SO_PATH.
1102
    "VLLM_CUDART_SO_PATH": lambda: os.getenv("VLLM_CUDART_SO_PATH", None),
1103
    # Rank of the process in the data parallel setting
1104
    "VLLM_DP_RANK": lambda: int(os.getenv("VLLM_DP_RANK", "0")),
1105
1106
    # Rank of the process in the data parallel setting.
    # Defaults to VLLM_DP_RANK when not set.
1107
1108
1109
    "VLLM_DP_RANK_LOCAL": lambda: int(
        os.getenv("VLLM_DP_RANK_LOCAL", sys.modules[__name__].VLLM_DP_RANK)
    ),
1110
    # World size of the data parallel setting
1111
    "VLLM_DP_SIZE": lambda: int(os.getenv("VLLM_DP_SIZE", "1")),
1112
    # IP address of the master node in the data parallel setting
1113
    "VLLM_DP_MASTER_IP": lambda: os.getenv("VLLM_DP_MASTER_IP", "127.0.0.1"),
1114
    # Port of the master node in the data parallel setting
1115
    "VLLM_DP_MASTER_PORT": lambda: int(os.getenv("VLLM_DP_MASTER_PORT", "0")),
1116
1117
1118
1119
1120
    # 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.
1121
    "VLLM_MOE_DP_CHUNK_SIZE": lambda: int(os.getenv("VLLM_MOE_DP_CHUNK_SIZE", "256")),
1122
1123
1124
    "VLLM_ENABLE_MOE_DP_CHUNK": lambda: bool(
        int(os.getenv("VLLM_ENABLE_MOE_DP_CHUNK", "1"))
    ),
1125
    # Randomize inputs during dummy runs when using Data Parallel
1126
1127
1128
1129
    "VLLM_RANDOMIZE_DP_DUMMY_INPUTS": lambda: os.environ.get(
        "VLLM_RANDOMIZE_DP_DUMMY_INPUTS", "0"
    )
    == "1",
1130
1131
1132
1133
1134
1135
1136
    # 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;
1137
1138
1139
    # - "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;
1140
1141
1142
1143
    # 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"
    ),
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
    # Comma-separated *additional* prefixes of env vars to copy from the
    # driver to Ray workers.  These are merged with the built-in defaults
    # defined in ``vllm.ray.ray_env`` (VLLM_, etc.).  Example: "MYLIB_,OTHER_"
    "VLLM_RAY_EXTRA_ENV_VAR_PREFIXES_TO_COPY": lambda: os.getenv(
        "VLLM_RAY_EXTRA_ENV_VAR_PREFIXES_TO_COPY", ""
    ),
    # Comma-separated *additional* individual env var names to copy from
    # the driver to Ray workers.  Merged with the built-in defaults
    # defined in ``vllm.ray.ray_env`` (PYTHONHASHSEED).
    # Example: "MY_SECRET,MY_FLAG"
    "VLLM_RAY_EXTRA_ENV_VARS_TO_COPY": lambda: os.getenv(
        "VLLM_RAY_EXTRA_ENV_VARS_TO_COPY", ""
    ),
1157
    # Whether to use S3 path for model loading in CI via RunAI Streamer
1158
    "VLLM_CI_USE_S3": lambda: os.environ.get("VLLM_CI_USE_S3", "0") == "1",
1159
    # Use model_redirect to redirect the model name to a local folder.
1160
1161
1162
1163
1164
    # `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
1165
1166
1167
    "VLLM_MODEL_REDIRECT_PATH": lambda: os.environ.get(
        "VLLM_MODEL_REDIRECT_PATH", None
    ),
1168
    # Whether to use atomicAdd reduce in gptq/awq marlin kernel.
1169
1170
1171
1172
    "VLLM_MARLIN_USE_ATOMIC_ADD": lambda: os.environ.get(
        "VLLM_MARLIN_USE_ATOMIC_ADD", "0"
    )
    == "1",
1173
    # Whether to use marlin kernel in mxfp4 quantization method
1174
1175
1176
    "VLLM_MXFP4_USE_MARLIN": lambda: maybe_convert_bool(
        os.environ.get("VLLM_MXFP4_USE_MARLIN", None)
    ),
1177
1178
1179
1180
    # The activation dtype for marlin kernel
    "VLLM_MARLIN_INPUT_DTYPE": env_with_choices(
        "VLLM_MARLIN_INPUT_DTYPE", None, ["int8", "fp8"]
    ),
1181
1182
1183
1184
1185
1186
    # 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"))
    ),
1187
1188
1189
    # 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.
1190
1191
1192
1193
    "VLLM_V1_USE_OUTLINES_CACHE": lambda: os.environ.get(
        "VLLM_V1_USE_OUTLINES_CACHE", "0"
    )
    == "1",
1194
1195
    # Gap between padding buckets for the forward pass. So we have
    # 8, we will run forward pass with [16, 24, 32, ...].
1196
1197
1198
1199
1200
1201
1202
1203
    "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)
    ),
1204
    # Whether using Pathways
1205
1206
1207
    "VLLM_TPU_USING_PATHWAYS": lambda: bool(
        "proxy" in os.getenv("JAX_PLATFORMS", "").lower()
    ),
1208
    # Allow use of DeepGemm kernels for fused moe ops.
1209
    "VLLM_USE_DEEP_GEMM": lambda: bool(int(os.getenv("VLLM_USE_DEEP_GEMM", "1"))),
1210
1211
1212
1213
    # 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"))
    ),
1214
    # Whether to use E8M0 scaling when DeepGEMM is used on Blackwell GPUs.
1215
1216
1217
    "VLLM_USE_DEEP_GEMM_E8M0": lambda: bool(
        int(os.getenv("VLLM_USE_DEEP_GEMM_E8M0", "1"))
    ),
1218
1219
1220
1221
    # Whether to create TMA-aligned scale tensor when DeepGEMM is used.
    "VLLM_USE_DEEP_GEMM_TMA_ALIGNED_SCALES": lambda: bool(
        int(os.getenv("VLLM_USE_DEEP_GEMM_TMA_ALIGNED_SCALES", "1"))
    ),
1222
1223
1224
1225
    # 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.
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
    # 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",
        ],
1241
    ),
1242
    # Whether to use fused grouped_topk used for MoE expert selection.
1243
1244
1245
    "VLLM_USE_FUSED_MOE_GROUPED_TOPK": lambda: bool(
        int(os.getenv("VLLM_USE_FUSED_MOE_GROUPED_TOPK", "1"))
    ),
1246
1247
1248
    # Allow use of FlashInfer FP8 block-scale GEMM for linear layers.
    # This uses TensorRT-LLM kernels and requires SM90+ (Hopper).
    "VLLM_BLOCKSCALE_FP8_GEMM_FLASHINFER": lambda: bool(
1249
        int(os.getenv("VLLM_BLOCKSCALE_FP8_GEMM_FLASHINFER", "1"))
1250
    ),
1251
    # Allow use of FlashInfer BF16 MoE kernels for fused moe ops.
1252
1253
1254
    "VLLM_USE_FLASHINFER_MOE_FP16": lambda: bool(
        int(os.getenv("VLLM_USE_FLASHINFER_MOE_FP16", "0"))
    ),
1255
    # Allow use of FlashInfer FP8 MoE kernels for fused moe ops.
1256
1257
1258
    "VLLM_USE_FLASHINFER_MOE_FP8": lambda: bool(
        int(os.getenv("VLLM_USE_FLASHINFER_MOE_FP8", "0"))
    ),
1259
    # Allow use of FlashInfer NVFP4 MoE kernels for fused moe ops.
1260
1261
1262
    "VLLM_USE_FLASHINFER_MOE_FP4": lambda: bool(
        int(os.getenv("VLLM_USE_FLASHINFER_MOE_FP4", "0"))
    ),
1263
1264
1265
1266
    # Allow use of FlashInfer MxInt4 MoE kernels for fused moe ops.
    "VLLM_USE_FLASHINFER_MOE_INT4": lambda: bool(
        int(os.getenv("VLLM_USE_FLASHINFER_MOE_INT4", "0"))
    ),
1267
1268
    # If set to 1, use the FlashInfer
    # MXFP8 (activation) x MXFP4 (weight) MoE backend.
1269
1270
1271
    "VLLM_USE_FLASHINFER_MOE_MXFP4_MXFP8": lambda: bool(
        int(os.getenv("VLLM_USE_FLASHINFER_MOE_MXFP4_MXFP8", "0"))
    ),
1272
1273
1274
1275
    # 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.
1276
1277
1278
    "VLLM_USE_FLASHINFER_MOE_MXFP4_MXFP8_CUTLASS": lambda: bool(
        int(os.getenv("VLLM_USE_FLASHINFER_MOE_MXFP4_MXFP8_CUTLASS", "0"))
    ),
1279
1280
    # If set to 1, use the FlashInfer
    # BF16 (activation) x MXFP4 (weight) MoE backend.
1281
1282
1283
    "VLLM_USE_FLASHINFER_MOE_MXFP4_BF16": lambda: bool(
        int(os.getenv("VLLM_USE_FLASHINFER_MOE_MXFP4_BF16", "0"))
    ),
1284
1285
1286
    # 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.
1287
    "VLLM_XGRAMMAR_CACHE_MB": lambda: int(os.getenv("VLLM_XGRAMMAR_CACHE_MB", "512")),
1288
1289
1290
1291
1292
1293
1294
    # 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.
1295
1296
1297
    "VLLM_MSGPACK_ZERO_COPY_THRESHOLD": lambda: int(
        os.getenv("VLLM_MSGPACK_ZERO_COPY_THRESHOLD", "256")
    ),
1298
1299
1300
    # 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.
1301
1302
1303
    "VLLM_ALLOW_INSECURE_SERIALIZATION": lambda: bool(
        int(os.getenv("VLLM_ALLOW_INSECURE_SERIALIZATION", "0"))
    ),
1304
1305
1306
1307
1308
    # Temporary: skip adding random suffix to internal request IDs. May be
    # needed for KV connectors that match request IDs across instances.
    "VLLM_DISABLE_REQUEST_ID_RANDOMIZATION": lambda: bool(
        int(os.getenv("VLLM_DISABLE_REQUEST_ID_RANDOMIZATION", "0"))
    ),
Robert Shaw's avatar
Robert Shaw committed
1309
    # IP address used for NIXL handshake between remote agents.
1310
1311
1312
    "VLLM_NIXL_SIDE_CHANNEL_HOST": lambda: os.getenv(
        "VLLM_NIXL_SIDE_CHANNEL_HOST", "localhost"
    ),
Robert Shaw's avatar
Robert Shaw committed
1313
    # Port used for NIXL handshake between remote agents.
1314
1315
1316
    "VLLM_NIXL_SIDE_CHANNEL_PORT": lambda: int(
        os.getenv("VLLM_NIXL_SIDE_CHANNEL_PORT", "5600")
    ),
1317
1318
1319
1320
    # Port used for Mooncake handshake between remote agents.
    "VLLM_MOONCAKE_BOOTSTRAP_PORT": lambda: int(
        os.getenv("VLLM_MOONCAKE_BOOTSTRAP_PORT", "8998")
    ),
1321
1322
    # Flashinfer MoE backend for vLLM's fused Mixture-of-Experts support.
    # Both require compute capability 10.0 or above.
1323
1324
1325
1326
1327
    # Available options:
    # - "throughput":  [default]
    #     Uses CUTLASS kernels optimized for high-throughput batch inference.
    # - "latency":
    #     Uses TensorRT-LLM kernels optimized for low-latency inference.
1328
    "VLLM_FLASHINFER_MOE_BACKEND": env_with_choices(
1329
1330
1331
        "VLLM_FLASHINFER_MOE_BACKEND",
        "latency",
        ["throughput", "latency", "masked_gemm"],
1332
    ),
1333
1334
1335
    # Flashinfer fused allreduce backend.
    "VLLM_FLASHINFER_ALLREDUCE_BACKEND": env_with_choices(
        "VLLM_FLASHINFER_ALLREDUCE_BACKEND",
1336
        "auto",
1337
1338
        ["auto", "trtllm", "mnnvl"],
    ),
1339
1340
1341
1342
    # 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))
    ),
1343
1344
1345
1346
    # 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.
1347
1348
1349
    "VLLM_MAX_TOKENS_PER_EXPERT_FP4_MOE": lambda: int(
        os.getenv("VLLM_MAX_TOKENS_PER_EXPERT_FP4_MOE", "163840")
    ),
1350
1351
1352
1353
    # 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> }
1354
    # Unspecified world sizes will fall back to
1355
    #     { 2: 64, 4: 1, <everything else>: 0.5 }
1356
1357
1358
    "VLLM_FLASHINFER_ALLREDUCE_FUSION_THRESHOLDS_MB": lambda: json.loads(
        os.getenv("VLLM_FLASHINFER_ALLREDUCE_FUSION_THRESHOLDS_MB", "{}")
    ),
1359
1360
1361
    # MoE routing strategy selector.
    # See `RoutingSimulator.get_available_strategies()` # for available
    # strategies.
1362
    # Custom routing strategies can be registered by
1363
1364
    # RoutingSimulator.register_strategy()
    # Note: custom strategies may not produce correct model outputs
1365
1366
1367
    "VLLM_MOE_ROUTING_SIMULATION_STRATEGY": lambda: os.environ.get(
        "VLLM_MOE_ROUTING_SIMULATION_STRATEGY", ""
    ).lower(),
1368
    # Regex timeout for use by the vLLM tool parsing plugins.
1369
1370
1371
    "VLLM_TOOL_PARSE_REGEX_TIMEOUT_SECONDS": lambda: int(
        os.getenv("VLLM_TOOL_PARSE_REGEX_TIMEOUT_SECONDS", "1")
    ),
1372
1373
1374
    # 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.
1375
1376
1377
    "VLLM_MQ_MAX_CHUNK_BYTES_MB": lambda: int(
        os.getenv("VLLM_MQ_MAX_CHUNK_BYTES_MB", "16")
    ),
1378
1379
    # Timeout in seconds for execute_model RPC calls in multiprocessing
    # executor (only applies when TP > 1).
1380
1381
1382
    "VLLM_EXECUTE_MODEL_TIMEOUT_SECONDS": lambda: int(
        os.getenv("VLLM_EXECUTE_MODEL_TIMEOUT_SECONDS", "300")
    ),
1383
1384
1385
1386
1387
1388
1389
    # 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.
1390
1391
1392
    "VLLM_KV_CACHE_LAYOUT": env_with_choices(
        "VLLM_KV_CACHE_LAYOUT", None, ["NHD", "HND"]
    ),
1393
1394
1395
    # 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.
1396
1397
1398
    "VLLM_COMPUTE_NANS_IN_LOGITS": lambda: bool(
        int(os.getenv("VLLM_COMPUTE_NANS_IN_LOGITS", "0"))
    ),
1399
1400
1401
    # Controls whether or not emulations are used for NVFP4
    # generations on machines < 100 for compressed-tensors
    # models
1402
1403
1404
    "VLLM_USE_NVFP4_CT_EMULATIONS": lambda: bool(
        int(os.getenv("VLLM_USE_NVFP4_CT_EMULATIONS", "0"))
    ),
1405
1406
1407
1408
    # 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.
1409
1410
1411
    "VLLM_NIXL_ABORT_REQUEST_TIMEOUT": lambda: int(
        os.getenv("VLLM_NIXL_ABORT_REQUEST_TIMEOUT", "480")
    ),
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
    # Controls the read mode for the Mori-IO connector
    "VLLM_MORIIO_CONNECTOR_READ_MODE": lambda: (
        os.getenv("VLLM_MORIIO_CONNECTOR_READ_MODE", "False").lower() in ("true", "1")
    ),
    # Controls the QP (Queue Pair) per transfer configuration for the Mori-IO connector
    "VLLM_MORIIO_QP_PER_TRANSFER": lambda: int(
        os.getenv("VLLM_MORIIO_QP_PER_TRANSFER", "1")
    ),
    # Controls the post-processing batch size for the Mori-IO connector
    "VLLM_MORIIO_POST_BATCH_SIZE": lambda: int(
        os.getenv("VLLM_MORIIO_POST_BATCH_SIZE", "-1")
    ),
    # Controls the number of workers for Mori operations for the Mori-IO connector
    "VLLM_MORIIO_NUM_WORKERS": lambda: int(os.getenv("VLLM_MORIIO_NUM_WORKERS", "1")),
1426
1427
1428
1429
    # Timeout (in seconds) for MooncakeConnector in PD disaggregated setup.
    "VLLM_MOONCAKE_ABORT_REQUEST_TIMEOUT": lambda: int(
        os.getenv("VLLM_MOONCAKE_ABORT_REQUEST_TIMEOUT", "480")
    ),
1430
1431
    # If set, it means we pre-downloaded cubin files and flashinfer will
    # read the cubin files directly.
1432
1433
1434
    "VLLM_HAS_FLASHINFER_CUBIN": lambda: bool(
        int(os.getenv("VLLM_HAS_FLASHINFER_CUBIN", "0"))
    ),
1435
1436
1437
1438
    # Supported options:
    # - "flashinfer-cudnn": use flashinfer cudnn GEMM backend
    # - "flashinfer-trtllm": use flashinfer trtllm GEMM backend
    # - "flashinfer-cutlass": use flashinfer cutlass GEMM backend
1439
    # - "marlin": use marlin GEMM backend (for GPUs without native FP4 support)
1440
1441
1442
1443
    # - <none>: automatically pick an available backend
    "VLLM_NVFP4_GEMM_BACKEND": env_with_choices(
        "VLLM_NVFP4_GEMM_BACKEND",
        None,
1444
1445
1446
1447
1448
        [
            "flashinfer-cudnn",
            "flashinfer-trtllm",
            "flashinfer-cutlass",
            "cutlass",
1449
            "marlin",
1450
        ],
1451
    ),
1452
1453
1454
    # 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.
1455
1456
1457
    "VLLM_ENABLE_CUDAGRAPH_GC": lambda: bool(
        int(os.getenv("VLLM_ENABLE_CUDAGRAPH_GC", "0"))
    ),
1458
    # Used to force set up loopback IP
1459
    "VLLM_LOOPBACK_IP": lambda: os.getenv("VLLM_LOOPBACK_IP", ""),
1460
1461
1462
    # Used to set the process name prefix for vLLM processes.
    # This is useful for debugging and monitoring purposes.
    # The default value is "VLLM".
1463
    "VLLM_PROCESS_NAME_PREFIX": lambda: os.getenv("VLLM_PROCESS_NAME_PREFIX", "VLLM"),
1464
1465
1466
1467
1468
1469
1470
    # 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.
1471
    "VLLM_ALLOW_CHUNKED_LOCAL_ATTN_WITH_HYBRID_KV_CACHE": lambda: bool(
1472
        int(os.getenv("VLLM_ALLOW_CHUNKED_LOCAL_ATTN_WITH_HYBRID_KV_CACHE", "1"))
1473
    ),
1474
1475
    # 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
1476
1477
    # messages for those requests in memory. By default, this is disabled (0),
    # and the "store" option is ignored.
1478
1479
1480
1481
1482
    # 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.
1483
1484
1485
    "VLLM_ENABLE_RESPONSES_API_STORE": lambda: bool(
        int(os.getenv("VLLM_ENABLE_RESPONSES_API_STORE", "0"))
    ),
xiao-llm's avatar
xiao-llm committed
1486
    # If set, use the fp8 mfma in rocm paged attention.
1487
1488
1489
    "VLLM_ROCM_FP8_MFMA_PAGE_ATTN": lambda: bool(
        int(os.getenv("VLLM_ROCM_FP8_MFMA_PAGE_ATTN", "0"))
    ),
1490
    # Whether to use pytorch symmetric memory for allreduce
1491
    "VLLM_ALLREDUCE_USE_SYMM_MEM": lambda: bool(
1492
        int(os.getenv("VLLM_ALLREDUCE_USE_SYMM_MEM", "1"))
1493
    ),
1494
1495
1496
1497
    # Whether to use FlashInfer allreduce
    "VLLM_ALLREDUCE_USE_FLASHINFER": lambda: bool(
        int(os.getenv("VLLM_ALLREDUCE_USE_FLASHINFER", "0"))
    ),
1498
1499
1500
1501
    # Experimental: use this to enable MCP tool calling for non harmony models
    "VLLM_USE_EXPERIMENTAL_PARSER_CONTEXT": lambda: bool(
        int(os.getenv("VLLM_USE_EXPERIMENTAL_PARSER_CONTEXT", "0"))
    ),
1502
    # Allows vllm to find tuned config under customized folder
1503
    "VLLM_TUNED_CONFIG_FOLDER": lambda: os.getenv("VLLM_TUNED_CONFIG_FOLDER", None),
1504
1505
1506
1507
1508
1509
1510
1511
1512
    # 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"],
    ),
1513
    # Allows harmony instructions to be injected on system messages
1514
1515
1516
    "VLLM_GPT_OSS_HARMONY_SYSTEM_INSTRUCTIONS": lambda: bool(
        int(os.getenv("VLLM_GPT_OSS_HARMONY_SYSTEM_INSTRUCTIONS", "0"))
    ),
1517
1518
1519
1520
1521
1522
    # Pin the conversation start date injected into the Harmony system
    # message. When unset the current date is used, which introduces
    # non-determinism (different tokens -> different model behaviour at
    # temperature=0). Set to an ISO date string, e.g. "2023-09-12",
    # for reproducible inference or testing.
    "VLLM_SYSTEM_START_DATE": lambda: os.getenv("VLLM_SYSTEM_START_DATE", None),
1523
1524
1525
1526
1527
1528
    # 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"))
    ),
1529
    # Add optional custom scopes for profiling, disable to avoid overheads
1530
1531
1532
    "VLLM_CUSTOM_SCOPES_FOR_PROFILING": lambda: bool(
        int(os.getenv("VLLM_CUSTOM_SCOPES_FOR_PROFILING", "0"))
    ),
1533
    # Add optional nvtx scopes for profiling, disable to avoid overheads
1534
1535
1536
    "VLLM_NVTX_SCOPES_FOR_PROFILING": lambda: bool(
        int(os.getenv("VLLM_NVTX_SCOPES_FOR_PROFILING", "0"))
    ),
1537
1538
    # Represent block hashes in KV cache events as 64-bit integers instead of
    # raw bytes. Defaults to True for backward compatibility.
1539
1540
1541
    "VLLM_KV_EVENTS_USE_INT_BLOCK_HASHES": lambda: bool(
        int(os.getenv("VLLM_KV_EVENTS_USE_INT_BLOCK_HASHES", "1"))
    ),
1542
1543
    # Name of the shared memory buffer used for object storage.
    # Only effective when mm_config.mm_processor_cache_type == "shm".
1544
1545
1546
1547
1548
    # Automatically generates a unique UUID-based name per process tree
    # if not explicitly set.
    "VLLM_OBJECT_STORAGE_SHM_BUFFER_NAME": get_env_or_set_default(
        "VLLM_OBJECT_STORAGE_SHM_BUFFER_NAME",
        lambda: f"VLLM_OBJECT_STORAGE_SHM_BUFFER_{uuid.uuid4().hex}",
1549
    ),
1550
    # The size in MB of the buffers (NVL and RDMA) used by DeepEP
1551
1552
1553
    "VLLM_DEEPEP_BUFFER_SIZE_MB": lambda: int(
        os.getenv("VLLM_DEEPEP_BUFFER_SIZE_MB", "1024")
    ),
1554
    # Force DeepEP to use intranode kernel for inter-node communication in
Jiayi Yan's avatar
Jiayi Yan committed
1555
    # high throughput mode. This is useful archive higher prefill throughput
1556
1557
1558
1559
1560
1561
1562
1563
1564
    # 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"))
    ),
1565
1566
    # 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
1567
    "VLLM_DBO_COMM_SMS": lambda: int(os.getenv("VLLM_DBO_COMM_SMS", "20")),
1568
1569
1570
    # 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)
1571
1572
1573
    "VLLM_ENABLE_INDUCTOR_MAX_AUTOTUNE": lambda: bool(
        int(os.getenv("VLLM_ENABLE_INDUCTOR_MAX_AUTOTUNE", "1"))
    ),
1574
1575
    # If set to 1, enable coordinate_descent_tuning;
    # By default, this is enabled (1)
1576
1577
1578
    "VLLM_ENABLE_INDUCTOR_COORDINATE_DESCENT_TUNING": lambda: bool(
        int(os.getenv("VLLM_ENABLE_INDUCTOR_COORDINATE_DESCENT_TUNING", "1"))
    ),
1579
    # Flag to enable NCCL symmetric memory allocation and registration
1580
1581
1582
    "VLLM_USE_NCCL_SYMM_MEM": lambda: bool(
        int(os.getenv("VLLM_USE_NCCL_SYMM_MEM", "0"))
    ),
1583
    # NCCL header path
1584
    "VLLM_NCCL_INCLUDE_PATH": lambda: os.environ.get("VLLM_NCCL_INCLUDE_PATH", None),
1585
1586
    # Flag to enable FBGemm kernels on model execution
    "VLLM_USE_FBGEMM": lambda: bool(int(os.getenv("VLLM_USE_FBGEMM", "0"))),
1587
1588
1589
1590
1591
1592
    # 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", ""),
1593
1594
1595
    # Debug workspace allocations.
    # logging of workspace resize operations.
    "VLLM_DEBUG_WORKSPACE": lambda: bool(int(os.getenv("VLLM_DEBUG_WORKSPACE", "0"))),
1596
    # Disables parallel execution of shared_experts via separate cuda stream
1597
1598
    "VLLM_DISABLE_SHARED_EXPERTS_STREAM": lambda: bool(
        int(os.getenv("VLLM_DISABLE_SHARED_EXPERTS_STREAM", "0"))
1599
    ),
1600
1601
1602
1603
1604
1605
1606
    # 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))
    ),
1607
1608
1609
1610
1611
1612
1613
1614
1615
    # 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
1616
1617
1618
1619
    # Flag to enable v2 model runner.
    "VLLM_USE_V2_MODEL_RUNNER": lambda: bool(
        int(os.getenv("VLLM_USE_V2_MODEL_RUNNER", "0"))
    ),
1620
1621
1622
1623
1624
1625
    # Log model inspection after loading.
    # If enabled, logs a transformers-style hierarchical view of the model
    # with quantization methods and attention backends.
    "VLLM_LOG_MODEL_INSPECTION": lambda: bool(
        int(os.getenv("VLLM_LOG_MODEL_INSPECTION", "0"))
    ),
1626
1627
1628
1629
    # Debug logging for --enable-mfu-metrics
    "VLLM_DEBUG_MFU_METRICS": lambda: bool(
        int(os.getenv("VLLM_DEBUG_MFU_METRICS", "0"))
    ),
1630
1631
1632
1633
1634
1635
1636
1637
    # Disable using pytorch's pin memory for CPU offloading.
    "VLLM_WEIGHT_OFFLOADING_DISABLE_PIN_MEMORY": lambda: bool(
        int(os.getenv("VLLM_WEIGHT_OFFLOADING_DISABLE_PIN_MEMORY", "0"))
    ),
    # Disable using UVA (Unified Virtual Addressing) for CPU offloading.
    "VLLM_WEIGHT_OFFLOADING_DISABLE_UVA": lambda: bool(
        int(os.getenv("VLLM_WEIGHT_OFFLOADING_DISABLE_UVA", "0"))
    ),
1638
1639
    # Disable logging of vLLM logo at server startup time.
    "VLLM_DISABLE_LOG_LOGO": lambda: bool(int(os.getenv("VLLM_DISABLE_LOG_LOGO", "0"))),
1640
1641
1642
    # Disable PDL for LoRA, as enabling PDL with LoRA on SM100 causes
    # Triton compilation to fail.
    "VLLM_LORA_DISABLE_PDL": lambda: bool(int(os.getenv("VLLM_LORA_DISABLE_PDL", "0"))),
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
    # Enable CUDA compatibility mode for datacenter GPUs with older
    # driver versions than the CUDA toolkit major version of vLLM.
    "VLLM_ENABLE_CUDA_COMPATIBILITY": lambda: (
        os.environ.get("VLLM_ENABLE_CUDA_COMPATIBILITY", "0").strip().lower()
        in ("1", "true")
    ),
    # Path to the CUDA compatibility libraries when CUDA compatibility is enabled.
    "VLLM_CUDA_COMPATIBILITY_PATH": lambda: os.environ.get(
        "VLLM_CUDA_COMPATIBILITY_PATH", None
    ),
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
    # Whether it is a scale up launch engine for elastic EP,
    # Should only be set by EngineCoreClient.
    "VLLM_ELASTIC_EP_SCALE_UP_LAUNCH": lambda: bool(
        int(os.getenv("VLLM_ELASTIC_EP_SCALE_UP_LAUNCH", "0"))
    ),
    # Whether to wait for all requests to drain before sending the
    # scaling command in elastic EP.
    "VLLM_ELASTIC_EP_DRAIN_REQUESTS": lambda: bool(
        int(os.getenv("VLLM_ELASTIC_EP_DRAIN_REQUESTS", "0"))
    ),
1663
1664
1665
1666
1667
1668
    # If set to 1, enable CUDA graph memory estimation during memory profiling.
    # This profiles CUDA graph memory usage to provide more accurate KV cache
    # memory allocation. Disabled by default to preserve existing behavior.
    "VLLM_MEMORY_PROFILER_ESTIMATE_CUDAGRAPHS": lambda: bool(
        int(os.getenv("VLLM_MEMORY_PROFILER_ESTIMATE_CUDAGRAPHS", "0"))
    ),
1669
1670
1671
    # NIXL EP environment variables
    "VLLM_NIXL_EP_MAX_NUM_RANKS": lambda: int(
        os.getenv("VLLM_NIXL_EP_MAX_NUM_RANKS", "32")
1672
1673
1674
1675
    ),
    # Whether enable XPU graph on Intel GPU
    "VLLM_XPU_ENABLE_XPU_GRAPH": lambda: bool(
        int(os.getenv("VLLM_XPU_ENABLE_XPU_GRAPH", "0"))
1676
    ),
1677
1678
}

1679

1680
# --8<-- [end:env-vars-definition]
1681

1682

1683
def __getattr__(name: str):
1684
1685
1686
1687
1688
1689
    """
    Gets environment variables lazily.

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


1695
1696
1697
1698
1699
1700
def _is_envs_cache_enabled() -> bool:
    """Checked if __getattr__ is wrapped with functools.cache"""
    global __getattr__
    return hasattr(__getattr__, "cache_clear")


1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
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.
    """
1711
1712
1713
    if _is_envs_cache_enabled():
        # Avoid wrapping functools.cache multiple times
        return
1714
1715
1716
1717
1718
1719
1720
1721
1722
    # Tag __getattr__ with functools.cache
    global __getattr__
    __getattr__ = functools.cache(__getattr__)

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


1723
1724
1725
1726
1727
1728
1729
1730
def disable_envs_cache() -> None:
    """
    Resets the environment variables cache. It could be used to isolate environments
    between unit tests.
    """
    global __getattr__
    # If __getattr__ is wrapped by functions.cache, unwrap the caching layer.
    if _is_envs_cache_enabled():
1731
        assert hasattr(__getattr__, "__wrapped__")
1732
1733
1734
        __getattr__ = __getattr__.__wrapped__


1735
1736
def __dir__():
    return list(environment_variables.keys())
1737
1738
1739
1740
1741
1742
1743
1744
1745


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


1746
1747
1748
1749
1750
1751
1752
1753
1754
def validate_environ(hard_fail: bool) -> None:
    for env in os.environ:
        if env.startswith("VLLM_") and env not in environment_variables:
            if hard_fail:
                raise ValueError(f"Unknown vLLM environment variable detected: {env}")
            else:
                logger.warning("Unknown vLLM environment variable detected: %s", env)


1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
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",
1777
        "VLLM_FORCE_AOT_LOAD",
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
        "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
1788
        "VLLM_LOGGING_COLOR",
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
        "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_IMAGE_FETCH_TIMEOUT",
        "VLLM_VIDEO_FETCH_TIMEOUT",
        "VLLM_AUDIO_FETCH_TIMEOUT",
1799
1800
1801
        "VLLM_MEDIA_CACHE",
        "VLLM_MEDIA_CACHE_MAX_SIZE_MB",
        "VLLM_MEDIA_CACHE_TTL_HOURS",
1802
        "VLLM_MEDIA_FETCH_MAX_RETRIES",
1803
1804
1805
1806
1807
        "VLLM_MEDIA_URL_ALLOW_REDIRECTS",
        "VLLM_MEDIA_LOADING_THREAD_COUNT",
        "VLLM_MAX_AUDIO_CLIP_FILESIZE_MB",
        "VLLM_VIDEO_LOADER_BACKEND",
        "VLLM_MEDIA_CONNECTOR",
1808
        "VLLM_OBJECT_STORAGE_SHM_BUFFER_NAME",
1809
1810
1811
1812
1813
1814
1815
        "VLLM_ASSETS_CACHE",
        "VLLM_ASSETS_CACHE_MODEL_CLEAN",
        "VLLM_WORKER_MULTIPROC_METHOD",
        "VLLM_ENABLE_V1_MULTIPROCESSING",
        "VLLM_V1_OUTPUT_PROC_CHUNK_SIZE",
        "VLLM_CPU_KVCACHE_SPACE",
        "VLLM_CPU_MOE_PREPACK",
1816
        "VLLM_ZENTORCH_WEIGHT_PREPACK",
1817
        "VLLM_TEST_FORCE_LOAD_FORMAT",
1818
1819
        "VLLM_ENABLE_CUDA_COMPATIBILITY",
        "VLLM_CUDA_COMPATIBILITY_PATH",
1820
1821
        "LOCAL_RANK",
        "CUDA_VISIBLE_DEVICES",
Nick Hill's avatar
Nick Hill committed
1822
        "NO_COLOR",
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
    }

    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
1841

1842
        factors[factor] = normalize_value(raw)
1843

1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
    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",
    ]

1866
1867
    for var in ray_noset_env_vars:
        factors[var] = normalize_value(os.getenv(var))
1868

1869
    return factors