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

4
import functools
5
import json
6
import logging
7
import os
8
import sys
9
import tempfile
10
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
38
    VLLM_USAGE_STATS_SERVER: str = "https://stats.vllm.ai"
    VLLM_NO_USAGE_STATS: bool = False
    VLLM_DO_NOT_TRACK: bool = False
    VLLM_USAGE_SOURCE: str = ""
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
    VLLM_USE_FLASHINFER_SAMPLER: bool | None = None
    VLLM_PP_LAYER_PARTITION: str | None = None
50
    VLLM_PP_LAYER_PARTITION_D: Optional[str] = None
51
    VLLM_CPU_KVCACHE_SPACE: int | None = 0
52
    VLLM_CPU_OMP_THREADS_BIND: str = ""
53
    VLLM_CPU_NUM_OF_RESERVED_CPU: int | None = None
54
    VLLM_CPU_SGL_KERNEL: bool = False
55
    VLLM_XLA_CACHE_PATH: str = os.path.join(VLLM_CACHE_ROOT, "xla_cache")
56
    VLLM_XLA_CHECK_RECOMPILATION: bool = False
57
    VLLM_FUSED_MOE_CHUNK_SIZE: int = 16 * 1024
58
    VLLM_ENABLE_FUSED_MOE_ACTIVATION_CHUNKING: bool = True
59
    VLLM_USE_RAY_COMPILED_DAG_CHANNEL_TYPE: Literal["auto", "nccl", "shm"] = "auto"
60
    VLLM_USE_RAY_COMPILED_DAG_OVERLAP_COMM: bool = False
61
    VLLM_USE_RAY_WRAPPED_PP_COMM: bool = True
62
    VLLM_XLA_USE_SPMD: bool = False
63
    VLLM_WORKER_MULTIPROC_METHOD: Literal["fork", "spawn"] = "spawn"
64
    VLLM_ASSETS_CACHE: str = os.path.join(VLLM_CACHE_ROOT, "assets")
65
    VLLM_ASSETS_CACHE_MODEL_CLEAN: bool = False
66
    VLLM_IMAGE_FETCH_TIMEOUT: int = 5
67
    VLLM_VIDEO_FETCH_TIMEOUT: int = 30
68
    VLLM_AUDIO_FETCH_TIMEOUT: int = 10
69
    VLLM_MEDIA_URL_ALLOW_REDIRECTS: bool = True
70
    VLLM_MEDIA_LOADING_THREAD_COUNT: int = 8
71
    VLLM_MAX_AUDIO_CLIP_FILESIZE_MB: int = 25
72
    VLLM_VIDEO_LOADER_BACKEND: str = "opencv"
73
    VLLM_MEDIA_CONNECTOR: str = "http"
74
    VLLM_MM_HASHER_ALGORITHM: str = "blake3"
75
    VLLM_TARGET_DEVICE: str = "cuda"
76
    VLLM_MAIN_CUDA_VERSION: str = "12.9"
77
    VLLM_FLOAT32_MATMUL_PRECISION: Literal["highest", "high", "medium"] = "highest"
78
79
    MAX_JOBS: str | None = None
    NVCC_THREADS: str | None = None
80
    VLLM_USE_PRECOMPILED: bool = False
81
    VLLM_SKIP_PRECOMPILED_VERSION_SUFFIX: bool = False
82
    VLLM_DOCKER_BUILD_CONTEXT: bool = False
83
    VLLM_KEEP_ALIVE_ON_ENGINE_DEATH: bool = False
84
    CMAKE_BUILD_TYPE: Literal["Debug", "Release", "RelWithDebInfo"] | None = None
85
    VERBOSE: bool = False
86
    VLLM_ALLOW_LONG_MAX_MODEL_LEN: bool = False
87
    VLLM_RPC_TIMEOUT: int = 10000  # ms
88
    VLLM_HTTP_TIMEOUT_KEEP_ALIVE: int = 5  # seconds
89
90
    VLLM_PLUGINS: list[str] | None = None
    VLLM_LORA_RESOLVER_CACHE_DIR: str | None = None
91
92
93
    # Deprecated env variables for profiling, kept for backward compatibility
    # See also vllm/config/profiler.py and `--profiler-config` argument
    VLLM_TORCH_CUDA_PROFILE: str | None = None
94
    VLLM_TORCH_PROFILER_DIR: str | None = None
95
96
97
98
99
100
101
102
103
104
    VLLM_TORCH_PROFILER_RECORD_SHAPES: str | None = None
    VLLM_TORCH_PROFILER_WITH_PROFILE_MEMORY: str | None = None
    VLLM_TORCH_PROFILER_DISABLE_ASYNC_LLM: str | None = None
    VLLM_TORCH_PROFILER_WITH_STACK: str | None = None
    VLLM_TORCH_PROFILER_WITH_FLOPS: str | None = None
    VLLM_TORCH_PROFILER_USE_GZIP: str | None = None
    VLLM_TORCH_PROFILER_DUMP_CUDA_TIME_TOTAL: str | None = None
    VLLM_PROFILER_DELAY_ITERS: str | None = None
    VLLM_PROFILER_MAX_ITERS: str | None = None
    # End of deprecated env variables for profiling
105
    VLLM_USE_AOT_COMPILE: bool = False
106
    VLLM_USE_BYTECODE_HOOK: bool = False
107
    VLLM_FORCE_AOT_LOAD: bool = False
108
    VLLM_USE_MEGA_AOT_ARTIFACT: bool = False
109
    VLLM_USE_TRITON_AWQ: bool = False
110
    VLLM_ALLOW_RUNTIME_LORA_UPDATING: bool = False
111
    VLLM_SKIP_P2P_CHECK: bool = False
112
    VLLM_DISABLED_KERNELS: list[str] = []
113
    VLLM_DISABLE_PYNCCL: bool = False
114
    VLLM_ROCM_USE_AITER: bool = False
115
    VLLM_ROCM_USE_AITER_PAGED_ATTN: bool = False
116
    VLLM_ROCM_USE_AITER_LINEAR: bool = True
117
    VLLM_ROCM_USE_AITER_MOE: bool = True
118
    VLLM_ROCM_USE_AITER_RMSNORM: bool = True
119
    VLLM_ROCM_USE_AITER_MLA: bool = True
120
    VLLM_ROCM_USE_AITER_MHA: bool = True
121
    VLLM_ROCM_USE_AITER_FP4_ASM_GEMM: bool = False
122
    VLLM_ROCM_USE_AITER_TRITON_ROPE: bool = False
123
    VLLM_ROCM_USE_AITER_FP8BMM: bool = True
124
    VLLM_ROCM_USE_AITER_FP4BMM: bool = True
125
    VLLM_ROCM_USE_AITER_UNIFIED_ATTENTION: bool = False
126
    VLLM_ROCM_USE_AITER_FUSION_SHARED_EXPERTS: bool = False
127
    VLLM_ROCM_USE_AITER_TRITON_GEMM: bool = True
128
    VLLM_ROCM_USE_SKINNY_GEMM: bool = True
129
    VLLM_ROCM_FP8_PADDING: bool = True
130
    VLLM_ROCM_MOE_PADDING: bool = True
131
    VLLM_ROCM_CUSTOM_PAGED_ATTN: bool = True
132
    VLLM_ROCM_SHUFFLE_KV_CACHE_LAYOUT: bool = False
133
    VLLM_ENABLE_V1_MULTIPROCESSING: bool = True
134
    VLLM_LOG_BATCHSIZE_INTERVAL: float = -1
135
    VLLM_DISABLE_COMPILE_CACHE: bool = False
zhangshao's avatar
zhangshao committed
136
137
138
    Q_SCALE_CONSTANT: int = 10
    K_SCALE_CONSTANT: int = 10
    V_SCALE_CONSTANT: int = 10
139
    VLLM_SERVER_DEV_MODE: bool = False
140
    VLLM_V1_OUTPUT_PROC_CHUNK_SIZE: int = 128
141
    VLLM_MLA_DISABLE: bool = False
142
143
    VLLM_RAY_PER_WORKER_GPUS: float = 1.0
    VLLM_RAY_BUNDLE_INDICES: str = ""
144
    VLLM_CUDART_SO_PATH: str | None = None
145
    VLLM_DP_RANK: int = 0
146
    VLLM_DP_RANK_LOCAL: int = -1
147
    VLLM_DP_SIZE: int = 1
148
    VLLM_USE_STANDALONE_COMPILE: bool = True
149
150
    VLLM_DP_MASTER_IP: str = ""
    VLLM_DP_MASTER_PORT: int = 0
151
    VLLM_MOE_DP_CHUNK_SIZE: int = 256
152
    VLLM_ENABLE_MOE_DP_CHUNK: bool = True
153
    VLLM_RANDOMIZE_DP_DUMMY_INPUTS: bool = False
154
    VLLM_RAY_DP_PACK_STRATEGY: Literal["strict", "fill", "span"] = "strict"
155
    VLLM_MARLIN_USE_ATOMIC_ADD: bool = False
156
    VLLM_MARLIN_INPUT_DTYPE: Literal["int8", "fp8"] | None = None
157
    VLLM_MXFP4_USE_MARLIN: bool | None = None
158
    VLLM_DEEPEPLL_NVFP4_DISPATCH: bool = False
159
    VLLM_V1_USE_OUTLINES_CACHE: bool = False
guanyu1's avatar
guanyu1 committed
160
    VLLM_1D_MROPE: bool = False
161
    VLLM_ENCODER_CACHE_SIZE: int | None = None
162
    VLLM_TPU_BUCKET_PADDING_GAP: int = 0
163
    VLLM_TPU_MOST_MODEL_LEN: int | None = None
164
    VLLM_TPU_USING_PATHWAYS: bool = False
165
    VLLM_USE_DEEP_GEMM: bool = True
166
    VLLM_MOE_USE_DEEP_GEMM: bool = True
167
    VLLM_USE_DEEP_GEMM_E8M0: bool = True
168
    VLLM_USE_DEEP_GEMM_TMA_ALIGNED_SCALES: bool = True
169
170
171
172
173
    VLLM_DEEP_GEMM_WARMUP: Literal[
        "skip",
        "full",
        "relax",
    ] = "relax"
174
    VLLM_USE_FUSED_MOE_GROUPED_TOPK: bool = True
175
    VLLM_BLOCKSCALE_FP8_GEMM_FLASHINFER: bool = False
176
    VLLM_USE_FLASHINFER_MOE_FP16: bool = False
177
178
    VLLM_USE_FLASHINFER_MOE_FP8: bool = False
    VLLM_USE_FLASHINFER_MOE_FP4: bool = False
179
180
181
    VLLM_FLASHINFER_MOE_BACKEND: Literal["throughput", "latency", "masked_gemm"] = (
        "latency"
    )
182
    VLLM_FLASHINFER_WORKSPACE_BUFFER_SIZE: int = 394 * 1024 * 1024
183
    VLLM_XGRAMMAR_CACHE_MB: int = 0
184
    VLLM_MSGPACK_ZERO_COPY_THRESHOLD: int = 256
185
    VLLM_ALLOW_INSECURE_SERIALIZATION: bool = False
186
    VLLM_DISABLE_REQUEST_ID_RANDOMIZATION: bool = False
Robert Shaw's avatar
Robert Shaw committed
187
    VLLM_NIXL_SIDE_CHANNEL_HOST: str = "localhost"
188
    VLLM_NIXL_SIDE_CHANNEL_PORT: int = 5600
189
    VLLM_MOONCAKE_BOOTSTRAP_PORT: int = 8998
190
191
192
193
194
    VLLM_ALL2ALL_BACKEND: Literal[
        "naive",
        "pplx",
        "deepep_high_throughput",
        "deepep_low_latency",
195
        "mori",
196
197
198
        "allgather_reducescatter",
        "flashinfer_all2allv",
    ] = "allgather_reducescatter"
199
    VLLM_MAX_TOKENS_PER_EXPERT_FP4_MOE: int = 163840
200
    VLLM_TOOL_PARSE_REGEX_TIMEOUT_SECONDS: int = 1
201
    VLLM_SLEEP_WHEN_IDLE: bool = False
202
    VLLM_MQ_MAX_CHUNK_BYTES_MB: int = 16
203
    VLLM_EXECUTE_MODEL_TIMEOUT_SECONDS: int = 300
204
    VLLM_KV_CACHE_LAYOUT: Literal["NHD", "HND"] | None = None
205
    VLLM_COMPUTE_NANS_IN_LOGITS: bool = False
206
    VLLM_USE_NVFP4_CT_EMULATIONS: bool = False
207
208
209
    VLLM_ROCM_QUICK_REDUCE_QUANTIZATION: Literal[
        "FP", "INT8", "INT6", "INT4", "NONE"
    ] = "NONE"
210
    VLLM_ROCM_QUICK_REDUCE_CAST_BF16_TO_FP16: bool = True
211
    VLLM_ROCM_QUICK_REDUCE_MAX_SIZE_BYTES_MB: int | None = None
212
    VLLM_NIXL_ABORT_REQUEST_TIMEOUT: int = 480
213
214
215
216
    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
217
    VLLM_MOONCAKE_ABORT_REQUEST_TIMEOUT: int = 480
218
    VLLM_ENABLE_CUDAGRAPH_GC: bool = False
219
    VLLM_LOOPBACK_IP: str = ""
220
    VLLM_ALLOW_CHUNKED_LOCAL_ATTN_WITH_HYBRID_KV_CACHE: bool = True
221
    VLLM_ENABLE_RESPONSES_API_STORE: bool = False
222
    VLLM_NVFP4_GEMM_BACKEND: str | None = None
223
    VLLM_HAS_FLASHINFER_CUBIN: bool = False
224
225
    VLLM_USE_FLASHINFER_MOE_MXFP4_MXFP8: bool = False
    VLLM_USE_FLASHINFER_MOE_MXFP4_BF16: bool = False
xiao-llm's avatar
xiao-llm committed
226
    VLLM_ROCM_FP8_MFMA_PAGE_ATTN: bool = False
227
    VLLM_USE_FLASHINFER_MOE_MXFP4_MXFP8_CUTLASS: bool = False
228
    VLLM_ALLREDUCE_USE_SYMM_MEM: bool = True
229
    VLLM_TUNED_CONFIG_FOLDER: str | None = None
230
    VLLM_GPT_OSS_SYSTEM_TOOL_MCP_LABELS: set[str] = set()
231
    VLLM_USE_EXPERIMENTAL_PARSER_CONTEXT: bool = False
232
    VLLM_GPT_OSS_HARMONY_SYSTEM_INSTRUCTIONS: bool = False
233
    VLLM_TOOL_JSON_ERROR_AUTOMATIC_RETRY: bool = False
234
    VLLM_CUSTOM_SCOPES_FOR_PROFILING: bool = False
235
    VLLM_NVTX_SCOPES_FOR_PROFILING: bool = False
236
    VLLM_KV_EVENTS_USE_INT_BLOCK_HASHES: bool = True
237
    VLLM_OBJECT_STORAGE_SHM_BUFFER_NAME: str = "VLLM_OBJECT_STORAGE_SHM_BUFFER"
238
    VLLM_DEEPEP_BUFFER_SIZE_MB: int = 1024
239
240
    VLLM_DEEPEP_HIGH_THROUGHPUT_FORCE_INTRA_NODE: bool = False
    VLLM_DEEPEP_LOW_LATENCY_USE_MNNVL: bool = False
241
    VLLM_DBO_COMM_SMS: int = 20
242
243
    VLLM_PATTERN_MATCH_DEBUG: str | None = None
    VLLM_DEBUG_DUMP_PATH: str | None = None
244
245
    VLLM_ENABLE_INDUCTOR_MAX_AUTOTUNE: bool = True
    VLLM_ENABLE_INDUCTOR_COORDINATE_DESCENT_TUNING: bool = True
246
    VLLM_USE_NCCL_SYMM_MEM: bool = False
247
    VLLM_NCCL_INCLUDE_PATH: str | None = None
248
    VLLM_USE_FBGEMM: bool = False
249
    VLLM_GC_DEBUG: str = ""
250
    VLLM_DEBUG_WORKSPACE: bool = False
251
    VLLM_DISABLE_SHARED_EXPERTS_STREAM: bool = False
252
    VLLM_SHARED_EXPERTS_STREAM_TOKEN_THRESHOLD: int = 256
253
    VLLM_COMPILE_CACHE_SAVE_FORMAT: Literal["binary", "unpacked"] = "binary"
Woosuk Kwon's avatar
Woosuk Kwon committed
254
    VLLM_USE_V2_MODEL_RUNNER: bool = False
255
    VLLM_LOG_MODEL_INSPECTION: bool = False
256
    VLLM_DEBUG_MFU_METRICS: bool = False
257
    VLLM_DISABLE_LOG_LOGO: bool = False
258
    VLLM_LORA_DISABLE_PDL: bool = False
259
    
260
    # add envs
zhuwenwen's avatar
zhuwenwen committed
261
    VLLM_OPTEST_URLS_PORT: int | None = None
262
263
    VLLM_OPTEST_MODELS_PATH: str = ""
    VLLM_USE_TRITON_PREFIX_FLASH_ATTN: bool = False
264
    VLLM_USE_FLASH_ATTN_FP8: bool = False
265
    VLLM_USE_QUERY_QUANT: bool = False
266
267
268
269
270
271
    VLLM_USE_FLASH_MLA: bool = False
    VLLM_USE_OPT_OP: bool = False
    VLLM_USE_TC_PAGED_ATTN: bool = False
    VLLM_USE_PA_PRINT_PARAM: bool = False 
    VLLM_SPEC_DECODE_EAGER: bool = False
    VLLM_PCIE_USE_CUSTOM_ALLREDUCE: bool = False
272
    VLLM_CUSTOM_CACHE: bool = False
zhuwenwen's avatar
zhuwenwen committed
273
    VLLM_CUSTOM_ALLREDUCE_SUPPORTED_WORLDSIZE_MAX: int = 16
zhuwenwen's avatar
zhuwenwen committed
274
    VLLM_ENFORCE_EAGER_BS_THRESHOLD: int | None  = None
275
    VLLM_HAS_CONTEXT_DEFAULT: bool = False
276
    VLLM_USE_NN: bool = False
277
    VLLM_ENABLE_TBO: bool = False
278
    VLLM_ENABLE_MOE_FUSED_GATE: bool = False
279
    VLLM_USE_FLASH_ATTN_PA: bool = False
zhuwenwen's avatar
zhuwenwen committed
280
    VLLM_USE_APEX_RN: bool = False
281
    VLLM_USE_GLOBAL_CACHE13: bool = False
282
283
    VLLM_USE_LIGHTOP: bool = False
    VLLM_USE_OPT_CAT: bool = False
zhuwenwen's avatar
zhuwenwen committed
284
285
    VLLM_USE_LIGHTOP_MOE_SUM: bool = False
    VLLM_USE_LIGHTOP_MOE_ALIGN: bool = False
286
    VLLM_USE_MERGE_ATTN_STATES_OPT: bool = False
王敏's avatar
王敏 committed
287
    USE_FUSED_RMS_QUANT: bool = False
xuxz's avatar
xuxz committed
288
289
    VLLM_P2P_ASYNC: bool = False
    VLLM_P2P_BUF_TOKENS: int = 30000
290
    USE_FUSED_SILU_MUL_QUANT: bool = False
zhuwenwen's avatar
zhuwenwen committed
291
    VLLM_USE_PD_SPLIT: bool = False
zhuwenwen's avatar
zhuwenwen committed
292
    VLLM_USE_PP_SYNC: bool = False
293
    VLLM_USE_PIECEWISE: bool = False
294
    VLLM_USE_V32_ENCODE: bool = False
295
296
297
    VLLM_USE_FUSE_SILU_AND_MUL: bool = False
    VLLM_USE_OPT_RESHAPE_AND_CACHE: bool = False
    VLLM_USE_TOPK_RENORM: bool = False
298
    VLLM_USE_FUSED_RMS_ROPE: bool = False
299
    VLLM_USE_FUSED_FILL_RMS_CAT: bool = False
300
    VLLM_USE_CAT_MLA: bool = False
301
    FP8_USE_MIXED_BATCH: bool = False
302
    VLLM_W8A8_BACKEND: int = 3
jujl1's avatar
jujl1 committed
303
    VLLM_USE_PP_BALANCE = True
304
305
306
307
308
309
    VLLM_MOE_ROUTER_CAPTURE: bool = False
    VLLM_MOE_ROUTER_CAPTURE_DIR: str = "/tmp"
    VLLM_MOE_ROUTER_CAPTURE_RANK: int = -1
    VLLM_MOE_ROUTER_CAPTURE_MAX_LAYERS: int = 0
    VLLM_MOE_ROUTER_CAPTURE_NUM_TOKENS_GT: int = -1
    VLLM_MOE_ROUTER_CAPTURE_NUM_TOKENS_LT: int = -1
王敏's avatar
王敏 committed
310
    VLLM_REJECT_SAMPLE_OPT: bool = False
311
    VLLM_USE_MOE_W16A16_TRITON: bool = False
312
    VLLM_V1_FAST_TOKEN_ID_COPY: bool = False
313
    VLLM_V1_USE_REDUCED_TOPK_TOPP_SAMPLER: bool = False
314
    VLLM_V1_USE_FUSED_QKV_SPLIT_RMS_ROPE_KVSTORE: bool = False
315
    VLLM_USE_FUSED_DTBMM: bool = False # DOUBLE TRANS BMM FP8
316
    VLLM_USE_LIGHTOP_FILL_MOE_ALIGN: bool = False
317
    VLLM_USE_LIGHTOP_RMS_ROPE_CONCAT: bool = False
wujl5's avatar
wujl5 committed
318
    VLLM_USE_CUDA_GRAPH_SIZES: bool = False
319
    VLLM_USE_LIGHTOP_MOE_SUM_MUL_ADD: bool = False
320
    VLLM_USE_LIGHTOP_FUSED_TOPP_TOPK: bool = False
fanwl's avatar
fanwl committed
321
    VLLM_V1_USE_FA_UNIFIED_ATTN_2D: bool = False
322
    VLLM_ENABLE_RAY_ASYNC_SCHEDULING: bool = False
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338


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


339
def maybe_convert_int(value: str | None) -> int | None:
340
341
342
343
344
    if value is None:
        return None
    return int(value)


345
def maybe_convert_bool(value: str | None) -> bool | None:
346
347
348
349
350
    if value is None:
        return None
    return bool(int(value))


351
352
353
354
def disable_compile_cache() -> bool:
    return bool(int(os.getenv("VLLM_DISABLE_COMPILE_CACHE", "0")))


355
def use_aot_compile() -> bool:
356
357
358
    from vllm.model_executor.layers.batch_invariant import (
        vllm_is_batch_invariant,
    )
zhuwenwen's avatar
zhuwenwen committed
359
    from vllm.platforms import current_platform
360
    from vllm.utils.torch_utils import is_torch_equal_or_newer
361

362
363
    default_value = (
        "1"
zhuwenwen's avatar
zhuwenwen committed
364
365
366
367
368
        if is_torch_equal_or_newer("2.10.0.dev")
        and not disable_compile_cache()
        # Disabling AOT_COMPILE for CPU
        # See: https://github.com/vllm-project/vllm/issues/32033
        and not current_platform.is_cpu()
369
370
371
        else "0"
    )

372
373
374
375
    return (
        not vllm_is_batch_invariant()
        and os.environ.get("VLLM_USE_AOT_COMPILE", default_value) == "1"
    )
376
377


378
def env_with_choices(
379
    env_name: str,
380
381
    default: str | None,
    choices: list[str] | Callable[[], list[str]],
382
    case_sensitive: bool = True,
383
) -> Callable[[], str | None]:
384
385
    """
    Create a lambda that validates environment variable against allowed choices
386

387
388
389
390
391
    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
392

393
394
395
396
    Returns:
        Lambda function for environment_variables dict
    """

397
    def _get_validated_env() -> str | None:
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
        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:
413
414
415
416
            raise ValueError(
                f"Invalid value '{value}' for {env_name}. "
                f"Valid options: {actual_choices}."
            )
417
418
419
420
421
422

        return value

    return _get_validated_env


423
def env_list_with_choices(
424
425
    env_name: str,
    default: list[str],
426
    choices: list[str] | Callable[[], list[str]],
427
428
    case_sensitive: bool = True,
) -> Callable[[], list[str]]:
429
    """
430
    Create a lambda that validates environment variable
431
    containing comma-separated values against allowed choices
432

433
434
435
436
437
    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
438

439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
    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:
468
469
470
471
                raise ValueError(
                    f"Invalid value '{val}' in {env_name}. "
                    f"Valid options: {actual_choices}."
                )
472
473
474
475
476
477

        return values

    return _get_validated_env_list


478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
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


496
def get_vllm_port() -> int | None:
497
    """Get the port from VLLM_PORT environment variable.
498

499
500
    Returns:
        The port number as an integer if VLLM_PORT is set, None otherwise.
501

502
503
504
    Raises:
        ValueError: If VLLM_PORT is a URI, suggest k8s service discovery issue.
    """
505
    if "VLLM_PORT" not in os.environ:
506
507
        return None

508
    port = os.getenv("VLLM_PORT", "0")
509
510
511
512

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

515
        parsed = parse_url(port)
516
517
518
519
520
521
        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
522
        raise ValueError(f"VLLM_PORT '{port}' must be a valid integer") from err
523
524


525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
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
546
# The start-* and end* here are used by the documentation generator
547
548
# to extract the used env vars.

549
# --8<-- [start:env-vars-definition]
550

551
logger = logging.getLogger(__name__)
552

553
environment_variables: dict[str, Callable[[], Any]] = {
554
    # ================== Installation Time Env Vars ==================
555
    # Target device of vLLM, supporting [cuda (by default),
556
    # rocm, cpu]
557
    "VLLM_TARGET_DEVICE": lambda: os.getenv("VLLM_TARGET_DEVICE", "cuda").lower(),
558
    # Main CUDA version of vLLM. This follows PyTorch but can be overridden.
559
    "VLLM_MAIN_CUDA_VERSION": lambda: os.getenv("VLLM_MAIN_CUDA_VERSION", "").lower()
560
    or "12.9",
561
    # Controls PyTorch float32 matmul precision mode within vLLM workers.
562
    # Valid options mirror torch.set_float32_matmul_precision
563
564
    "VLLM_FLOAT32_MATMUL_PRECISION": env_with_choices(
        "VLLM_FLOAT32_MATMUL_PRECISION",
565
566
        "highest",
        ["highest", "high", "medium"],
567
568
        case_sensitive=False,
    ),
569
570
    # Maximum number of compilation jobs to run in parallel.
    # By default this is the number of CPUs
571
    "MAX_JOBS": lambda: os.getenv("MAX_JOBS", None),
572
573
574
    # Number of threads to use for nvcc
    # By default this is 1.
    # If set, `MAX_JOBS` will be reduced to avoid oversubscribing the CPU.
575
    "NVCC_THREADS": lambda: os.getenv("NVCC_THREADS", None),
576
    # If set, vllm will use precompiled binaries (*.so)
577
578
579
580
581
    "VLLM_USE_PRECOMPILED": lambda: os.environ.get("VLLM_USE_PRECOMPILED", "")
    .strip()
    .lower()
    in ("1", "true")
    or bool(os.environ.get("VLLM_PRECOMPILED_WHEEL_LOCATION")),
582
583
584
585
    # 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"))
    ),
586
587
    # Used to mark that setup.py is running in a Docker build context,
    # in order to force the use of precompiled binaries.
588
589
590
591
    "VLLM_DOCKER_BUILD_CONTEXT": lambda: os.environ.get("VLLM_DOCKER_BUILD_CONTEXT", "")
    .strip()
    .lower()
    in ("1", "true"),
592
593
594
    # CMake build type
    # If not set, defaults to "Debug" or "RelWithDebInfo"
    # Available options: "Debug", "Release", "RelWithDebInfo"
595
596
597
    "CMAKE_BUILD_TYPE": env_with_choices(
        "CMAKE_BUILD_TYPE", None, ["Debug", "Release", "RelWithDebInfo"]
    ),
598
    # If set, vllm will print verbose logs during installation
599
    "VERBOSE": lambda: bool(int(os.getenv("VERBOSE", "0"))),
600
    # Root directory for vLLM configuration files
601
    # Defaults to `~/.config/vllm` unless `XDG_CONFIG_HOME` is set
602
603
604
    # 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**.
605
    "VLLM_CONFIG_ROOT": lambda: os.path.expanduser(
606
607
608
        os.getenv(
            "VLLM_CONFIG_ROOT",
            os.path.join(get_default_config_root(), "vllm"),
609
610
        )
    ),
611
    # ================== Runtime Env Vars ==================
612
    # Root directory for vLLM cache files
613
    # Defaults to `~/.cache/vllm` unless `XDG_CACHE_HOME` is set
614
    "VLLM_CACHE_ROOT": lambda: os.path.expanduser(
615
616
617
        os.getenv(
            "VLLM_CACHE_ROOT",
            os.path.join(get_default_cache_root(), "vllm"),
618
619
        )
    ),
620
621
622
623
    # 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.
624
    "VLLM_HOST_IP": lambda: os.getenv("VLLM_HOST_IP", ""),
625
    # used in distributed environment to manually set the communication port
626
627
628
    # 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.
629
    "VLLM_PORT": get_vllm_port,
630
631
    # path used for ipc when the frontend api server is running in
    # multi-processing mode to communicate with the backend engine process.
632
633
634
    "VLLM_RPC_BASE_PATH": lambda: os.getenv(
        "VLLM_RPC_BASE_PATH", tempfile.gettempdir()
    ),
635
636
    # If true, will load models from ModelScope instead of Hugging Face Hub.
    # note that the value is true or false, not numbers
637
638
639
640
    "VLLM_USE_MODELSCOPE": lambda: os.environ.get(
        "VLLM_USE_MODELSCOPE", "False"
    ).lower()
    == "true",
641
    # Interval in seconds to log a warning message when the ring buffer is full
642
643
644
    "VLLM_RINGBUFFER_WARNING_INTERVAL": lambda: int(
        os.environ.get("VLLM_RINGBUFFER_WARNING_INTERVAL", "60")
    ),
645
646
    # path to cudatoolkit home directory, under which should be bin, include,
    # and lib directories.
647
    "CUDA_HOME": lambda: os.environ.get("CUDA_HOME", None),
648
649
    # 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
650
    "VLLM_NCCL_SO_PATH": lambda: os.environ.get("VLLM_NCCL_SO_PATH", None),
651
652
    # 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`
653
    "LD_LIBRARY_PATH": lambda: os.environ.get("LD_LIBRARY_PATH", None),
654
655
    # flag to control if vllm should use triton flash attention
    "VLLM_USE_TRITON_FLASH_ATTN":
656
    lambda: (os.environ.get("VLLM_USE_TRITON_FLASH_ATTN", "False").lower() in
657
             ("true", "1")),
658
659
660
661
    # 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")
    ),
662
    # Feature flag to enable/disable Inductor standalone compile.
663
664
    # In torch <= 2.7 we ignore this flag; in torch >= 2.9 this is
    # enabled by default.
665
    "VLLM_USE_STANDALONE_COMPILE": lambda: os.environ.get(
666
        "VLLM_USE_STANDALONE_COMPILE", "1"
667
668
    )
    == "1",
669
670
    # Debug pattern matching inside custom passes.
    # Should be set to the fx.Node name (e.g. 'getitem_34' or 'scaled_mm_3').
671
672
673
    "VLLM_PATTERN_MATCH_DEBUG": lambda: os.environ.get(
        "VLLM_PATTERN_MATCH_DEBUG", None
    ),
674
675
    # Dump fx graphs to the given directory.
    # It will override CompilationConfig.debug_dump_path if set.
676
    "VLLM_DEBUG_DUMP_PATH": lambda: os.environ.get("VLLM_DEBUG_DUMP_PATH", None),
677
678
679
680
    # 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,
681
682
683
    # Feature flag to enable/disable bytecode in
    # TorchCompileWithNoGuardsWrapper.
    "VLLM_USE_BYTECODE_HOOK": lambda: bool(
684
        int(os.environ.get("VLLM_USE_BYTECODE_HOOK", "0"))
685
    ),
686
687
688
689
    # 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",
690
691
692
693
694
695
696
    # 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.
    "VLLM_USE_MEGA_AOT_ARTIFACT": lambda: os.environ.get(
        "VLLM_USE_MEGA_AOT_ARTIFACT", "0"
    )
    == "1",
697
698
    # local rank of the process in the distributed setting, used to determine
    # the GPU device id
699
    "LOCAL_RANK": lambda: int(os.environ.get("LOCAL_RANK", "0")),
700
    # used to control the visible devices in the distributed setting
701
    "CUDA_VISIBLE_DEVICES": lambda: os.environ.get("CUDA_VISIBLE_DEVICES", None),
702
    # timeout for each iteration in the engine
703
    "VLLM_ENGINE_ITERATION_TIMEOUT_S": lambda: int(
704
        os.environ.get("VLLM_ENGINE_ITERATION_TIMEOUT_S", "120")
705
    ),
706
707
708
709
710
    # 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")
    ),
711
    # API key for vLLM API server
712
    "VLLM_API_KEY": lambda: os.environ.get("VLLM_API_KEY", None),
713
    # Whether to log responses from API Server for debugging
714
715
716
717
    "VLLM_DEBUG_LOG_API_SERVER_RESPONSE": lambda: os.environ.get(
        "VLLM_DEBUG_LOG_API_SERVER_RESPONSE", "False"
    ).lower()
    == "true",
718
    # S3 access information, used for tensorizer to load model from S3
719
720
721
    "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),
722
    # Usage stats collection
723
724
725
726
727
728
729
730
731
732
733
    "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"),
734
735
736
737
    # 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
738
739
740
    "VLLM_CONFIGURE_LOGGING": lambda: bool(
        int(os.getenv("VLLM_CONFIGURE_LOGGING", "1"))
    ),
741
    "VLLM_LOGGING_CONFIG_PATH": lambda: os.getenv("VLLM_LOGGING_CONFIG_PATH"),
742
    # this is used for configuring the default logging level
743
    "VLLM_LOGGING_LEVEL": lambda: os.getenv("VLLM_LOGGING_LEVEL", "INFO").upper(),
744
    # this is used for configuring the default logging stream
745
    "VLLM_LOGGING_STREAM": lambda: os.getenv("VLLM_LOGGING_STREAM", "ext://sys.stdout"),
746
    # if set, VLLM_LOGGING_PREFIX will be prepended to all log messages
747
    "VLLM_LOGGING_PREFIX": lambda: os.getenv("VLLM_LOGGING_PREFIX", ""),
Nick Hill's avatar
Nick Hill committed
748
749
750
751
752
    # 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",
753
754
    # If set, vllm will log stats at this interval in seconds
    # If not set, vllm will log stats every 10 seconds.
755
756
757
    "VLLM_LOG_STATS_INTERVAL": lambda: val
    if (val := float(os.getenv("VLLM_LOG_STATS_INTERVAL", "10."))) > 0.0
    else 10.0,
758
759
760
    # Trace function calls
    # If set to 1, vllm will trace function calls
    # Useful for debugging
761
    "VLLM_TRACE_FUNCTION": lambda: int(os.getenv("VLLM_TRACE_FUNCTION", "0")),
762
    # If set, vllm will use flashinfer sampler
763
764
765
766
767
    "VLLM_USE_FLASHINFER_SAMPLER": lambda: bool(
        int(os.environ["VLLM_USE_FLASHINFER_SAMPLER"])
    )
    if "VLLM_USE_FLASHINFER_SAMPLER" in os.environ
    else None,
768
    # Pipeline stage partition strategy
769
    "VLLM_PP_LAYER_PARTITION": lambda: os.getenv("VLLM_PP_LAYER_PARTITION", None),
770
771
772
773
774
    
    # Pipeline stage partition strategy
    "VLLM_PP_LAYER_PARTITION_D":
    lambda: os.getenv("VLLM_PP_LAYER_PARTITION_D", None),

775
    # (CPU backend only) CPU key-value cache space.
776
    # default is None and will be set as 4 GB
777
778
779
    "VLLM_CPU_KVCACHE_SPACE": lambda: int(os.getenv("VLLM_CPU_KVCACHE_SPACE", "0"))
    if "VLLM_CPU_KVCACHE_SPACE" in os.environ
    else None,
780
781
    # (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 '|'.
782
    "VLLM_CPU_OMP_THREADS_BIND": lambda: os.getenv("VLLM_CPU_OMP_THREADS_BIND", "auto"),
783
784
    # (CPU backend only) CPU cores not used by OMP threads .
    # Those CPU cores will not be used by OMP threads of a rank.
785
786
787
788
789
    "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,
790
    # (CPU backend only) whether to use SGL kernels, optimized for small batch.
791
    "VLLM_CPU_SGL_KERNEL": lambda: bool(int(os.getenv("VLLM_CPU_SGL_KERNEL", "0"))),
792
793
794
795
796
797
798
    # 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
799
800
801
    "VLLM_USE_RAY_COMPILED_DAG_CHANNEL_TYPE": env_with_choices(
        "VLLM_USE_RAY_COMPILED_DAG_CHANNEL_TYPE", "auto", ["auto", "nccl", "shm"]
    ),
802
    # If the env var is set, it enables GPU communication overlap
803
    # (experimental feature) in Ray's Compiled Graph.
804
805
806
    "VLLM_USE_RAY_COMPILED_DAG_OVERLAP_COMM": lambda: bool(
        int(os.getenv("VLLM_USE_RAY_COMPILED_DAG_OVERLAP_COMM", "0"))
    ),
807
808
809
    # 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.
810
811
812
    "VLLM_USE_RAY_WRAPPED_PP_COMM": lambda: bool(
        int(os.getenv("VLLM_USE_RAY_WRAPPED_PP_COMM", "1"))
    ),
813
814
    # Use dedicated multiprocess context for workers.
    # Both spawn and fork work
815
    "VLLM_WORKER_MULTIPROC_METHOD": env_with_choices(
816
        "VLLM_WORKER_MULTIPROC_METHOD", "spawn", ["spawn", "fork"]
817
    ),
818
    # Path to the cache for storing downloaded assets
819
    "VLLM_ASSETS_CACHE": lambda: os.path.expanduser(
820
821
822
        os.getenv(
            "VLLM_ASSETS_CACHE",
            os.path.join(get_default_cache_root(), "vllm", "assets"),
823
824
        )
    ),
825
826
    # If the env var is set, we will clean model file in
    # this path $VLLM_ASSETS_CACHE/model_streamer/$model_name
827
828
829
    "VLLM_ASSETS_CACHE_MODEL_CLEAN": lambda: bool(
        int(os.getenv("VLLM_ASSETS_CACHE_MODEL_CLEAN", "0"))
    ),
830
831
    # Timeout for fetching images when serving multimodal models
    # Default is 5 seconds
832
    "VLLM_IMAGE_FETCH_TIMEOUT": lambda: int(os.getenv("VLLM_IMAGE_FETCH_TIMEOUT", "5")),
833
    # Timeout for fetching videos when serving multimodal models
834
    # Default is 30 seconds
835
836
837
    "VLLM_VIDEO_FETCH_TIMEOUT": lambda: int(
        os.getenv("VLLM_VIDEO_FETCH_TIMEOUT", "30")
    ),
838
    # Timeout for fetching audio when serving multimodal models
839
    # Default is 10 seconds
840
841
842
    "VLLM_AUDIO_FETCH_TIMEOUT": lambda: int(
        os.getenv("VLLM_AUDIO_FETCH_TIMEOUT", "10")
    ),
843
844
    # Whether to allow HTTP redirects when fetching from media URLs.
    # Default to True
845
846
847
    "VLLM_MEDIA_URL_ALLOW_REDIRECTS": lambda: bool(
        int(os.getenv("VLLM_MEDIA_URL_ALLOW_REDIRECTS", "1"))
    ),
848
849
850
    # Max number of workers for the thread pool handling
    # media bytes loading. Set to 1 to disable parallel processing.
    # Default is 8
851
852
853
    "VLLM_MEDIA_LOADING_THREAD_COUNT": lambda: int(
        os.getenv("VLLM_MEDIA_LOADING_THREAD_COUNT", "8")
    ),
854
855
856
    # 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
857
858
859
    "VLLM_MAX_AUDIO_CLIP_FILESIZE_MB": lambda: int(
        os.getenv("VLLM_MAX_AUDIO_CLIP_FILESIZE_MB", "25")
    ),
860
861
    # Backend for Video IO
    # - "opencv": Default backend that uses OpenCV stream buffered backend.
Roger Wang's avatar
Roger Wang committed
862
    # - "identity": Returns raw video bytes for model processor to handle.
863
864
865
866
867
    #
    # 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.
868
869
870
    "VLLM_VIDEO_LOADER_BACKEND": lambda: os.getenv(
        "VLLM_VIDEO_LOADER_BACKEND", "opencv"
    ),
871
872
873
874
875
876
877
878
    # 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"),
879
880
881
882
883
884
885
886
887
888
889
    # 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,
    ),
890
891
    # Path to the XLA persistent cache directory.
    # Only used for XLA devices such as TPUs.
892
    "VLLM_XLA_CACHE_PATH": lambda: os.path.expanduser(
893
        os.getenv(
894
            "VLLM_XLA_CACHE_PATH",
895
            os.path.join(get_default_cache_root(), "vllm", "xla_cache"),
896
897
        )
    ),
898
    # If set, assert on XLA recompilation after each execution step.
899
900
901
    "VLLM_XLA_CHECK_RECOMPILATION": lambda: bool(
        int(os.getenv("VLLM_XLA_CHECK_RECOMPILATION", "0"))
    ),
902
    # Enable SPMD mode for TPU backend.
903
904
    "VLLM_XLA_USE_SPMD": lambda: bool(int(os.getenv("VLLM_XLA_USE_SPMD", "0"))),
    "VLLM_FUSED_MOE_CHUNK_SIZE": lambda: int(
905
        os.getenv("VLLM_FUSED_MOE_CHUNK_SIZE", str(16 * 1024))
906
    ),
907
908
909
    # Control whether to use fused MoE activation chunking. Current chunking
    # logic is incompatible with torch.compile and causes IMA. See issue
    # https://github.com/vllm-project/vllm/issues/19631.
910
911
912
    "VLLM_ENABLE_FUSED_MOE_ACTIVATION_CHUNKING": lambda: bool(
        int(os.getenv("VLLM_ENABLE_FUSED_MOE_ACTIVATION_CHUNKING", "1"))
    ),
913
914
    # If set, the OpenAI API server will stay alive even after the underlying
    # AsyncLLMEngine errors and stops serving requests
915
    "VLLM_KEEP_ALIVE_ON_ENGINE_DEATH": lambda: bool(
916
        int(os.getenv("VLLM_KEEP_ALIVE_ON_ENGINE_DEATH", "0"))
917
    ),
918
919
920
921
    # 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.
922
923
924
925
    "VLLM_ALLOW_LONG_MAX_MODEL_LEN": lambda: (
        os.environ.get("VLLM_ALLOW_LONG_MAX_MODEL_LEN", "0").strip().lower()
        in ("1", "true")
    ),
926
927
    # If set, forces FP8 Marlin to be used for FP8 quantization regardless
    # of the hardware support for FP8 compute.
928
929
930
931
932
933
934
    "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"
    ),
935
936
    # Time in ms for the zmq client to wait for a response from the backend
    # server for simple data operations
937
    "VLLM_RPC_TIMEOUT": lambda: int(os.getenv("VLLM_RPC_TIMEOUT", "10000")),
938
    # Timeout in seconds for keeping HTTP connections alive in API server
939
940
941
    "VLLM_HTTP_TIMEOUT_KEEP_ALIVE": lambda: int(
        os.environ.get("VLLM_HTTP_TIMEOUT_KEEP_ALIVE", "5")
    ),
942
943
944
    # 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
945
946
947
    "VLLM_PLUGINS": lambda: None
    if "VLLM_PLUGINS" not in os.environ
    else os.environ["VLLM_PLUGINS"].split(","),
948
949
950
    # a local directory to look in for unrecognized LoRA adapters.
    # only works if plugins are enabled and
    # VLLM_ALLOW_RUNTIME_LORA_UPDATING is enabled.
951
952
953
    "VLLM_LORA_RESOLVER_CACHE_DIR": lambda: os.getenv(
        "VLLM_LORA_RESOLVER_CACHE_DIR", None
    ),
954
955
956
    # Enables torch CUDA profiling if set to 1.
    # Deprecated, see profiler_config.
    "VLLM_TORCH_CUDA_PROFILE": lambda: os.getenv("VLLM_TORCH_CUDA_PROFILE"),
957
    # Enables torch profiler if set.
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
    # Deprecated, see profiler_config.
    "VLLM_TORCH_PROFILER_DIR": lambda: os.getenv("VLLM_TORCH_PROFILER_DIR"),
    # Enable torch profiler to record shapes if set to 1.
    # Deprecated, see profiler_config.
    "VLLM_TORCH_PROFILER_RECORD_SHAPES": lambda: (
        os.getenv("VLLM_TORCH_PROFILER_RECORD_SHAPES")
    ),
    # Enable torch profiler to profile memory if set to 1.
    # Deprecated, see profiler_config.
    "VLLM_TORCH_PROFILER_WITH_PROFILE_MEMORY": lambda: (
        os.getenv("VLLM_TORCH_PROFILER_WITH_PROFILE_MEMORY")
    ),
    # Enable torch profiler to profile stack if set to 1.
    # Deprecated, see profiler_config.
    "VLLM_TORCH_PROFILER_WITH_STACK": lambda: (
        os.getenv("VLLM_TORCH_PROFILER_WITH_STACK")
    ),
    # Enable torch profiler to profile flops if set to 1.
    # Deprecated, see profiler_config.
    "VLLM_TORCH_PROFILER_WITH_FLOPS": lambda: (
        os.getenv("VLLM_TORCH_PROFILER_WITH_FLOPS")
    ),
    # Disable torch profiling of the AsyncLLMEngine process if set to 1.
    # Deprecated, see profiler_config.
    "VLLM_TORCH_PROFILER_DISABLE_ASYNC_LLM": lambda: (
        os.getenv("VLLM_TORCH_PROFILER_DISABLE_ASYNC_LLM")
984
985
986
    ),
    # Delay number of iterations before starting profiling when using
    # the torch/torch CUDA profiler. If set to 0, will start profiling immediately.
987
988
    # Deprecated, see profiler_config.
    "VLLM_PROFILER_DELAY_ITERS": lambda: (os.getenv("VLLM_PROFILER_DELAY_ITERS")),
989
990
    # Maximum number of iterations to profile when using the torch/torch CUDA profiler.
    # If set to 0, will not limit the number of iterations.
991
    "VLLM_PROFILER_MAX_ITERS": lambda: os.getenv("VLLM_PROFILER_MAX_ITERS"),
992
    # Control whether torch profiler gzip-compresses profiling files.
993
994
    # Deprecated, see profiler_config.
    "VLLM_TORCH_PROFILER_USE_GZIP": lambda: os.getenv("VLLM_TORCH_PROFILER_USE_GZIP"),
995
    # Control whether torch profiler dumps the self_cuda_time_total table.
996
997
998
999
    # Set to 0 to disable dumping the table.
    # Deprecated, see profiler_config.
    "VLLM_TORCH_PROFILER_DUMP_CUDA_TIME_TOTAL": lambda: (
        os.getenv("VLLM_TORCH_PROFILER_DUMP_CUDA_TIME_TOTAL")
1000
    ),
1001
    # If set, vLLM will use Triton implementations of AWQ.
1002
    "VLLM_USE_TRITON_AWQ": lambda: bool(int(os.getenv("VLLM_USE_TRITON_AWQ", "0"))),
1003
    # If set, allow loading or unloading lora adapters in runtime,
1004
1005
1006
1007
    "VLLM_ALLOW_RUNTIME_LORA_UPDATING": lambda: (
        os.environ.get("VLLM_ALLOW_RUNTIME_LORA_UPDATING", "0").strip().lower()
        in ("1", "true")
    ),
1008
1009
1010
1011
1012
1013
    # 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
1014
    "VLLM_SKIP_P2P_CHECK": lambda: os.getenv("VLLM_SKIP_P2P_CHECK", "1") == "1",
1015
1016
1017
1018
    # List of quantization kernels that should be disabled, used for testing
    # and performance comparisons. Currently only affects MPLinearKernel
    # selection
    # (kernels: MacheteLinearKernel, MarlinLinearKernel, ExllamaLinearKernel)
1019
1020
1021
    "VLLM_DISABLED_KERNELS": lambda: []
    if "VLLM_DISABLED_KERNELS" not in os.environ
    else os.environ["VLLM_DISABLED_KERNELS"].split(","),
1022
    # Disable pynccl (using torch.distributed instead)
1023
1024
1025
    "VLLM_DISABLE_PYNCCL": lambda: (
        os.getenv("VLLM_DISABLE_PYNCCL", "False").lower() in ("true", "1")
    ),
1026
1027
    # Disable aiter ops unless specifically enabled.
    # Acts as a parent switch to enable the rest of the other operations.
1028
1029
1030
    "VLLM_ROCM_USE_AITER": lambda: (
        os.getenv("VLLM_ROCM_USE_AITER", "False").lower() in ("true", "1")
    ),
1031
1032
    # Whether to use aiter paged attention.
    # By default is disabled.
1033
1034
1035
    "VLLM_ROCM_USE_AITER_PAGED_ATTN": lambda: (
        os.getenv("VLLM_ROCM_USE_AITER_PAGED_ATTN", "False").lower() in ("true", "1")
    ),
1036
1037
1038
    # use aiter linear op if aiter ops are enabled
    # The following list of related ops
    # - scaled_mm (per-tensor / rowwise)
1039
    "VLLM_ROCM_USE_AITER_LINEAR": lambda: (
1040
        os.getenv("VLLM_ROCM_USE_AITER_LINEAR", "False").lower() in ("true", "1")
1041
    ),
1042
1043
    # Whether to use aiter moe ops.
    # By default is enabled.
1044
    "VLLM_ROCM_USE_AITER_MOE": lambda: (
1045
        os.getenv("VLLM_ROCM_USE_AITER_MOE", "False").lower() in ("true", "1")
1046
    ),
1047
    # use aiter rms norm op if aiter ops are enabled.
1048
    "VLLM_ROCM_USE_AITER_RMSNORM": lambda: (
1049
        os.getenv("VLLM_ROCM_USE_AITER_RMSNORM", "False").lower() in ("true", "1")
1050
    ),
1051
1052
    # Whether to use aiter mla ops.
    # By default is enabled.
1053
    "VLLM_ROCM_USE_AITER_MLA": lambda: (
1054
        os.getenv("VLLM_ROCM_USE_AITER_MLA", "False").lower() in ("true", "1")
1055
    ),
1056
1057
    # Whether to use aiter mha ops.
    # By default is enabled.
1058
    "VLLM_ROCM_USE_AITER_MHA": lambda: (
1059
        os.getenv("VLLM_ROCM_USE_AITER_MHA", "False").lower() in ("true", "1")
1060
    ),
1061
1062
    # Whether to use aiter fp4 gemm asm.
    # By default is disabled.
1063
1064
1065
    "VLLM_ROCM_USE_AITER_FP4_ASM_GEMM": lambda: (
        os.getenv("VLLM_ROCM_USE_AITER_FP4_ASM_GEMM", "False").lower() in ("true", "1")
    ),
1066
1067
    # Whether to use aiter rope.
    # By default is disabled.
1068
1069
    "VLLM_ROCM_USE_AITER_TRITON_ROPE": lambda: (
        os.getenv("VLLM_ROCM_USE_AITER_TRITON_ROPE", "False").lower() in ("true", "1")
1070
    ),
1071
1072
    # Whether to use aiter triton fp8 bmm kernel
    # By default is enabled.
1073
    "VLLM_ROCM_USE_AITER_FP8BMM": lambda: (
1074
        os.getenv("VLLM_ROCM_USE_AITER_FP8BMM", "False").lower() in ("true", "1")
1075
    ),
1076
1077
1078
    # Whether to use aiter triton fp4 bmm kernel
    # By default is enabled.
    "VLLM_ROCM_USE_AITER_FP4BMM": lambda: (
1079
        os.getenv("VLLM_ROCM_USE_AITER_FP4BMM", "False").lower() in ("true", "1")
1080
    ),
1081
1082
1083
1084
1085
    # 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")
    ),
1086
    # Whether to use aiter fusion shared experts ops.
1087
    # By default is disabled.
1088
    "VLLM_ROCM_USE_AITER_FUSION_SHARED_EXPERTS": lambda: (
1089
        os.getenv("VLLM_ROCM_USE_AITER_FUSION_SHARED_EXPERTS", "False").lower()
1090
1091
        in ("true", "1")
    ),
1092
1093
1094
    # Whether to use aiter triton kernels for gemm ops.
    # By default is enabled.
    "VLLM_ROCM_USE_AITER_TRITON_GEMM": lambda: (
1095
        os.getenv("VLLM_ROCM_USE_AITER_TRITON_GEMM", "False").lower() in ("true", "1")
1096
    ),
1097
    # use rocm skinny gemms
1098
1099
1100
    "VLLM_ROCM_USE_SKINNY_GEMM": lambda: (
        os.getenv("VLLM_ROCM_USE_SKINNY_GEMM", "True").lower() in ("true", "1")
    ),
1101
    # Pad the fp8 weights to 256 bytes for ROCm
1102
    "VLLM_ROCM_FP8_PADDING": lambda: bool(int(os.getenv("VLLM_ROCM_FP8_PADDING", "1"))),
1103
    # Pad the weights for the moe kernel
1104
    "VLLM_ROCM_MOE_PADDING": lambda: bool(int(os.getenv("VLLM_ROCM_MOE_PADDING", "0"))),
1105
    # custom paged attention kernel for MI3* cards
1106
1107
1108
    "VLLM_ROCM_CUSTOM_PAGED_ATTN": lambda: (
        os.getenv("VLLM_ROCM_CUSTOM_PAGED_ATTN", "True").lower() in ("true", "1")
    ),
1109
1110
1111
1112
    # 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")
    ),
1113
1114
1115
    # Custom quick allreduce kernel for MI3* cards
    # Choice of quantization level: FP, INT8, INT6, INT4 or NONE
    # Recommended for large models to get allreduce
1116
1117
1118
1119
1120
    "VLLM_ROCM_QUICK_REDUCE_QUANTIZATION": env_with_choices(
        "VLLM_ROCM_QUICK_REDUCE_QUANTIZATION",
        "NONE",
        ["FP", "INT8", "INT6", "INT4", "NONE"],
    ),
1121
1122
1123
1124
    # 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
1125
1126
1127
1128
    "VLLM_ROCM_QUICK_REDUCE_CAST_BF16_TO_FP16": lambda: (
        os.getenv("VLLM_ROCM_QUICK_REDUCE_CAST_BF16_TO_FP16", "True").lower()
        in ("true", "1")
    ),
1129
1130
1131
1132
1133
1134
    # 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.
1135
1136
1137
    "VLLM_ROCM_QUICK_REDUCE_MAX_SIZE_BYTES_MB": lambda: maybe_convert_int(
        os.environ.get("VLLM_ROCM_QUICK_REDUCE_MAX_SIZE_BYTES_MB", None)
    ),
1138
    # Divisor for dynamic query scale factor calculation for FP8 KV Cache
zhangshao's avatar
zhangshao committed
1139
    "Q_SCALE_CONSTANT": lambda: int(os.getenv("Q_SCALE_CONSTANT", "10")),
1140
    # Divisor for dynamic key scale factor calculation for FP8 KV Cache
zhangshao's avatar
zhangshao committed
1141
    "K_SCALE_CONSTANT": lambda: int(os.getenv("K_SCALE_CONSTANT", "10")),
1142
    # Divisor for dynamic value scale factor calculation for FP8 KV Cache
zhangshao's avatar
zhangshao committed
1143
    "V_SCALE_CONSTANT": lambda: int(os.getenv("V_SCALE_CONSTANT", "10")),
1144
    # If set, enable multiprocessing in LLM for the V1 code path.
1145
1146
1147
1148
1149
1150
    "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")
    ),
1151
    "VLLM_DISABLE_COMPILE_CACHE": disable_compile_cache,
1152
1153
1154
    # If set, vllm will run in development mode, which will enable
    # some additional endpoints for developing and debugging,
    # e.g. `/reset_prefix_cache`
1155
    "VLLM_SERVER_DEV_MODE": lambda: bool(int(os.getenv("VLLM_SERVER_DEV_MODE", "0"))),
1156
1157
1158
1159
1160
1161
1162
    # 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.
1163
1164
1165
    "VLLM_V1_OUTPUT_PROC_CHUNK_SIZE": lambda: int(
        os.getenv("VLLM_V1_OUTPUT_PROC_CHUNK_SIZE", "128")
    ),
1166
    # If set, vLLM will disable the MLA attention optimizations.
1167
    "VLLM_MLA_DISABLE": lambda: bool(int(os.getenv("VLLM_MLA_DISABLE", "0"))),
1168
    # If set, vLLM will pick up the provided Flash Attention MLA
1169
1170
1171
    # 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.
1172
1173
1174
    "VLLM_RAY_PER_WORKER_GPUS": lambda: float(
        os.getenv("VLLM_RAY_PER_WORKER_GPUS", "1.0")
    ),
1175
1176
1177
    # 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"
1178
    "VLLM_RAY_BUNDLE_INDICES": lambda: os.getenv("VLLM_RAY_BUNDLE_INDICES", ""),
1179
1180
    # In some system, find_loaded_library() may not work. So we allow users to
    # specify the path through environment variable VLLM_CUDART_SO_PATH.
1181
    "VLLM_CUDART_SO_PATH": lambda: os.getenv("VLLM_CUDART_SO_PATH", None),
1182
    # Rank of the process in the data parallel setting
1183
    "VLLM_DP_RANK": lambda: int(os.getenv("VLLM_DP_RANK", "0")),
1184
1185
    # Rank of the process in the data parallel setting.
    # Defaults to VLLM_DP_RANK when not set.
1186
1187
1188
    "VLLM_DP_RANK_LOCAL": lambda: int(
        os.getenv("VLLM_DP_RANK_LOCAL", sys.modules[__name__].VLLM_DP_RANK)
    ),
1189
    # World size of the data parallel setting
1190
    "VLLM_DP_SIZE": lambda: int(os.getenv("VLLM_DP_SIZE", "1")),
1191
    # IP address of the master node in the data parallel setting
1192
    "VLLM_DP_MASTER_IP": lambda: os.getenv("VLLM_DP_MASTER_IP", "127.0.0.1"),
1193
    # Port of the master node in the data parallel setting
1194
    "VLLM_DP_MASTER_PORT": lambda: int(os.getenv("VLLM_DP_MASTER_PORT", "0")),
1195
1196
1197
1198
1199
    # 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.
1200
    "VLLM_MOE_DP_CHUNK_SIZE": lambda: int(os.getenv("VLLM_MOE_DP_CHUNK_SIZE", "256")),
1201
1202
1203
    "VLLM_ENABLE_MOE_DP_CHUNK": lambda: bool(
        int(os.getenv("VLLM_ENABLE_MOE_DP_CHUNK", "1"))
    ),
1204
    # Randomize inputs during dummy runs when using Data Parallel
1205
1206
1207
1208
    "VLLM_RANDOMIZE_DP_DUMMY_INPUTS": lambda: os.environ.get(
        "VLLM_RANDOMIZE_DP_DUMMY_INPUTS", "0"
    )
    == "1",
1209
1210
1211
1212
1213
1214
1215
    # 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;
1216
1217
1218
    # - "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;
1219
1220
1221
1222
    # 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"
    ),
1223
    # Whether to use S3 path for model loading in CI via RunAI Streamer
1224
    "VLLM_CI_USE_S3": lambda: os.environ.get("VLLM_CI_USE_S3", "0") == "1",
1225
    # Use model_redirect to redirect the model name to a local folder.
1226
1227
1228
1229
1230
    # `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
1231
1232
1233
    "VLLM_MODEL_REDIRECT_PATH": lambda: os.environ.get(
        "VLLM_MODEL_REDIRECT_PATH", None
    ),
1234
    # Whether to use atomicAdd reduce in gptq/awq marlin kernel.
1235
1236
1237
1238
    "VLLM_MARLIN_USE_ATOMIC_ADD": lambda: os.environ.get(
        "VLLM_MARLIN_USE_ATOMIC_ADD", "0"
    )
    == "1",
1239
    # Whether to use marlin kernel in mxfp4 quantization method
1240
1241
1242
    "VLLM_MXFP4_USE_MARLIN": lambda: maybe_convert_bool(
        os.environ.get("VLLM_MXFP4_USE_MARLIN", None)
    ),
1243
1244
1245
1246
    # The activation dtype for marlin kernel
    "VLLM_MARLIN_INPUT_DTYPE": env_with_choices(
        "VLLM_MARLIN_INPUT_DTYPE", None, ["int8", "fp8"]
    ),
1247
1248
1249
1250
1251
1252
    # 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"))
    ),
1253
1254
1255
    # 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.
1256
1257
1258
1259
    "VLLM_V1_USE_OUTLINES_CACHE": lambda: os.environ.get(
        "VLLM_V1_USE_OUTLINES_CACHE", "0"
    )
    == "1",
1260
1261
    # Gap between padding buckets for the forward pass. So we have
    # 8, we will run forward pass with [16, 24, 32, ...].
1262
1263
1264
1265
1266
1267
1268
1269
    "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)
    ),
1270
    # Whether using Pathways
1271
1272
1273
    "VLLM_TPU_USING_PATHWAYS": lambda: bool(
        "proxy" in os.getenv("JAX_PLATFORMS", "").lower()
    ),
1274
    # Allow use of DeepGemm kernels for fused moe ops.
1275
    "VLLM_USE_DEEP_GEMM": lambda: bool(int(os.getenv("VLLM_USE_DEEP_GEMM", "1"))),
1276
1277
1278
1279
    # 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"))
    ),
1280
    # Whether to use E8M0 scaling when DeepGEMM is used on Blackwell GPUs.
1281
1282
1283
    "VLLM_USE_DEEP_GEMM_E8M0": lambda: bool(
        int(os.getenv("VLLM_USE_DEEP_GEMM_E8M0", "1"))
    ),
1284
1285
1286
1287
    # 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"))
    ),
1288
1289
1290
1291
    # 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.
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
    # 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",
        ],
1307
    ),
1308
    # Whether to use fused grouped_topk used for MoE expert selection.
1309
1310
1311
    "VLLM_USE_FUSED_MOE_GROUPED_TOPK": lambda: bool(
        int(os.getenv("VLLM_USE_FUSED_MOE_GROUPED_TOPK", "1"))
    ),
1312
1313
1314
1315
1316
    # 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(
        int(os.getenv("VLLM_BLOCKSCALE_FP8_GEMM_FLASHINFER", "0"))
    ),
1317
    # Allow use of FlashInfer MoE kernels for fused moe ops.
1318
1319
1320
    "VLLM_USE_FLASHINFER_MOE_FP16": lambda: bool(
        int(os.getenv("VLLM_USE_FLASHINFER_MOE_FP16", "0"))
    ),
1321
    # Allow use of FlashInfer MoE kernels for fused moe ops.
1322
1323
1324
    "VLLM_USE_FLASHINFER_MOE_FP8": lambda: bool(
        int(os.getenv("VLLM_USE_FLASHINFER_MOE_FP8", "0"))
    ),
1325
    # Allow use of FlashInfer CUTLASS kernels for fused moe ops.
1326
1327
1328
    "VLLM_USE_FLASHINFER_MOE_FP4": lambda: bool(
        int(os.getenv("VLLM_USE_FLASHINFER_MOE_FP4", "0"))
    ),
1329
1330
    # If set to 1, use the FlashInfer
    # MXFP8 (activation) x MXFP4 (weight) MoE backend.
1331
1332
1333
    "VLLM_USE_FLASHINFER_MOE_MXFP4_MXFP8": lambda: bool(
        int(os.getenv("VLLM_USE_FLASHINFER_MOE_MXFP4_MXFP8", "0"))
    ),
1334
1335
1336
1337
    # 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.
1338
1339
1340
    "VLLM_USE_FLASHINFER_MOE_MXFP4_MXFP8_CUTLASS": lambda: bool(
        int(os.getenv("VLLM_USE_FLASHINFER_MOE_MXFP4_MXFP8_CUTLASS", "0"))
    ),
1341
1342
    # If set to 1, use the FlashInfer
    # BF16 (activation) x MXFP4 (weight) MoE backend.
1343
1344
1345
    "VLLM_USE_FLASHINFER_MOE_MXFP4_BF16": lambda: bool(
        int(os.getenv("VLLM_USE_FLASHINFER_MOE_MXFP4_BF16", "0"))
    ),
1346
1347
1348
    # 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.
1349
    "VLLM_XGRAMMAR_CACHE_MB": lambda: int(os.getenv("VLLM_XGRAMMAR_CACHE_MB", "512")),
1350
1351
1352
1353
1354
1355
1356
    # 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.
1357
1358
1359
    "VLLM_MSGPACK_ZERO_COPY_THRESHOLD": lambda: int(
        os.getenv("VLLM_MSGPACK_ZERO_COPY_THRESHOLD", "256")
    ),
1360
1361
1362
    # 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.
1363
1364
1365
    "VLLM_ALLOW_INSECURE_SERIALIZATION": lambda: bool(
        int(os.getenv("VLLM_ALLOW_INSECURE_SERIALIZATION", "0"))
    ),
1366
1367
1368
1369
1370
    # 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", "1"))
    ),
Robert Shaw's avatar
Robert Shaw committed
1371
    # IP address used for NIXL handshake between remote agents.
1372
1373
1374
    "VLLM_NIXL_SIDE_CHANNEL_HOST": lambda: os.getenv(
        "VLLM_NIXL_SIDE_CHANNEL_HOST", "localhost"
    ),
Robert Shaw's avatar
Robert Shaw committed
1375
    # Port used for NIXL handshake between remote agents.
1376
1377
1378
    "VLLM_NIXL_SIDE_CHANNEL_PORT": lambda: int(
        os.getenv("VLLM_NIXL_SIDE_CHANNEL_PORT", "5600")
    ),
1379
1380
1381
1382
    # Port used for Mooncake handshake between remote agents.
    "VLLM_MOONCAKE_BOOTSTRAP_PORT": lambda: int(
        os.getenv("VLLM_MOONCAKE_BOOTSTRAP_PORT", "8998")
    ),
1383
1384
    # [DEPRECATED - will be removed in v0.15.0] all2all backend for vllm's
    # expert parallel communication. Use --all2all-backend CLI argument instead.
1385
    # Available options:
1386
1387
1388
    # - "naive": naive all2all implementation using broadcasts
    # - "allgather_reducescatter": all2all implementation based on allgather and
    #  reducescatter
1389
    # - "pplx": use pplx kernels
1390
1391
    # - "deepep_high_throughput", use deepep high-throughput kernels
    # - "deepep_low_latency", use deepep low-latency kernels
1392
    # - "mori", use MoRI kernels
1393
    # - "flashinfer_all2allv", use flashinfer alltoallv kernels for mnnvl
1394
1395
    "VLLM_ALL2ALL_BACKEND": env_with_choices(
        "VLLM_ALL2ALL_BACKEND",
1396
        None,
1397
1398
1399
1400
1401
        [
            "naive",
            "pplx",
            "deepep_high_throughput",
            "deepep_low_latency",
1402
            "mori",
1403
1404
1405
1406
            "allgather_reducescatter",
            "flashinfer_all2allv",
        ],
    ),
1407
1408
    # Flashinfer MoE backend for vLLM's fused Mixture-of-Experts support.
    # Both require compute capability 10.0 or above.
1409
1410
1411
1412
1413
    # Available options:
    # - "throughput":  [default]
    #     Uses CUTLASS kernels optimized for high-throughput batch inference.
    # - "latency":
    #     Uses TensorRT-LLM kernels optimized for low-latency inference.
1414
    "VLLM_FLASHINFER_MOE_BACKEND": env_with_choices(
1415
1416
1417
        "VLLM_FLASHINFER_MOE_BACKEND",
        "latency",
        ["throughput", "latency", "masked_gemm"],
1418
    ),
1419
1420
1421
1422
    # 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))
    ),
1423
1424
1425
1426
    # 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.
1427
1428
1429
    "VLLM_MAX_TOKENS_PER_EXPERT_FP4_MOE": lambda: int(
        os.getenv("VLLM_MAX_TOKENS_PER_EXPERT_FP4_MOE", "163840")
    ),
1430
1431
1432
1433
    # 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> }
1434
    # Unspecified world sizes will fall back to
1435
    #     { 2: 64, 4: 1, <everything else>: 0.5 }
1436
1437
1438
    "VLLM_FLASHINFER_ALLREDUCE_FUSION_THRESHOLDS_MB": lambda: json.loads(
        os.getenv("VLLM_FLASHINFER_ALLREDUCE_FUSION_THRESHOLDS_MB", "{}")
    ),
1439
1440
1441
    # MoE routing strategy selector.
    # See `RoutingSimulator.get_available_strategies()` # for available
    # strategies.
1442
    # Custom routing strategies can be registered by
1443
1444
    # RoutingSimulator.register_strategy()
    # Note: custom strategies may not produce correct model outputs
1445
1446
1447
    "VLLM_MOE_ROUTING_SIMULATION_STRATEGY": lambda: os.environ.get(
        "VLLM_MOE_ROUTING_SIMULATION_STRATEGY", ""
    ).lower(),
1448
    # Regex timeout for use by the vLLM tool parsing plugins.
1449
1450
1451
    "VLLM_TOOL_PARSE_REGEX_TIMEOUT_SECONDS": lambda: int(
        os.getenv("VLLM_TOOL_PARSE_REGEX_TIMEOUT_SECONDS", "1")
    ),
1452
1453
    # Reduce CPU usage when vLLM is idle. Enabling this will incur small
    # latency penalty when a request eventually comes.
1454
    "VLLM_SLEEP_WHEN_IDLE": lambda: bool(int(os.getenv("VLLM_SLEEP_WHEN_IDLE", "0"))),
1455
1456
1457
    # 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.
1458
1459
1460
    "VLLM_MQ_MAX_CHUNK_BYTES_MB": lambda: int(
        os.getenv("VLLM_MQ_MAX_CHUNK_BYTES_MB", "16")
    ),
1461
1462
    # Timeout in seconds for execute_model RPC calls in multiprocessing
    # executor (only applies when TP > 1).
1463
1464
1465
    "VLLM_EXECUTE_MODEL_TIMEOUT_SECONDS": lambda: int(
        os.getenv("VLLM_EXECUTE_MODEL_TIMEOUT_SECONDS", "300")
    ),
1466
1467
1468
1469
1470
1471
1472
    # 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.
1473
1474
1475
    "VLLM_KV_CACHE_LAYOUT": env_with_choices(
        "VLLM_KV_CACHE_LAYOUT", None, ["NHD", "HND"]
    ),
1476
1477
1478
    # 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.
1479
1480
1481
    "VLLM_COMPUTE_NANS_IN_LOGITS": lambda: bool(
        int(os.getenv("VLLM_COMPUTE_NANS_IN_LOGITS", "0"))
    ),
1482
1483
1484
    # Controls whether or not emulations are used for NVFP4
    # generations on machines < 100 for compressed-tensors
    # models
1485
1486
1487
    "VLLM_USE_NVFP4_CT_EMULATIONS": lambda: bool(
        int(os.getenv("VLLM_USE_NVFP4_CT_EMULATIONS", "0"))
    ),
1488
1489
1490
1491
    # 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.
1492
1493
1494
    "VLLM_NIXL_ABORT_REQUEST_TIMEOUT": lambda: int(
        os.getenv("VLLM_NIXL_ABORT_REQUEST_TIMEOUT", "480")
    ),
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
    # 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")),
1509
1510
1511
1512
    # Timeout (in seconds) for MooncakeConnector in PD disaggregated setup.
    "VLLM_MOONCAKE_ABORT_REQUEST_TIMEOUT": lambda: int(
        os.getenv("VLLM_MOONCAKE_ABORT_REQUEST_TIMEOUT", "480")
    ),
1513
1514
    # If set, it means we pre-downloaded cubin files and flashinfer will
    # read the cubin files directly.
1515
1516
1517
    "VLLM_HAS_FLASHINFER_CUBIN": lambda: bool(
        int(os.getenv("VLLM_HAS_FLASHINFER_CUBIN", "0"))
    ),
1518
1519
1520
1521
    # Supported options:
    # - "flashinfer-cudnn": use flashinfer cudnn GEMM backend
    # - "flashinfer-trtllm": use flashinfer trtllm GEMM backend
    # - "flashinfer-cutlass": use flashinfer cutlass GEMM backend
1522
    # - "marlin": use marlin GEMM backend (for GPUs without native FP4 support)
1523
1524
1525
1526
    # - <none>: automatically pick an available backend
    "VLLM_NVFP4_GEMM_BACKEND": env_with_choices(
        "VLLM_NVFP4_GEMM_BACKEND",
        None,
1527
1528
1529
1530
1531
        [
            "flashinfer-cudnn",
            "flashinfer-trtllm",
            "flashinfer-cutlass",
            "cutlass",
1532
            "marlin",
1533
        ],
1534
    ),
1535
1536
1537
    # 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.
1538
1539
1540
    "VLLM_ENABLE_CUDAGRAPH_GC": lambda: bool(
        int(os.getenv("VLLM_ENABLE_CUDAGRAPH_GC", "0"))
    ),
1541
    # Used to force set up loopback IP
1542
    "VLLM_LOOPBACK_IP": lambda: os.getenv("VLLM_LOOPBACK_IP", ""),
1543
1544
1545
    # Used to set the process name prefix for vLLM processes.
    # This is useful for debugging and monitoring purposes.
    # The default value is "VLLM".
1546
    "VLLM_PROCESS_NAME_PREFIX": lambda: os.getenv("VLLM_PROCESS_NAME_PREFIX", "VLLM"),
1547
1548
1549
1550
1551
1552
1553
    # 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.
1554
    "VLLM_ALLOW_CHUNKED_LOCAL_ATTN_WITH_HYBRID_KV_CACHE": lambda: bool(
1555
        int(os.getenv("VLLM_ALLOW_CHUNKED_LOCAL_ATTN_WITH_HYBRID_KV_CACHE", "1"))
1556
    ),
1557
1558
    # 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
1559
1560
    # messages for those requests in memory. By default, this is disabled (0),
    # and the "store" option is ignored.
1561
1562
1563
1564
1565
    # 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.
1566
1567
1568
    "VLLM_ENABLE_RESPONSES_API_STORE": lambda: bool(
        int(os.getenv("VLLM_ENABLE_RESPONSES_API_STORE", "0"))
    ),
xiao-llm's avatar
xiao-llm committed
1569
    # If set, use the fp8 mfma in rocm paged attention.
1570
1571
1572
    "VLLM_ROCM_FP8_MFMA_PAGE_ATTN": lambda: bool(
        int(os.getenv("VLLM_ROCM_FP8_MFMA_PAGE_ATTN", "0"))
    ),
1573
    # Whether to use pytorch symmetric memory for allreduce
1574
    "VLLM_ALLREDUCE_USE_SYMM_MEM": lambda: bool(
1575
        int(os.getenv("VLLM_ALLREDUCE_USE_SYMM_MEM", "1"))
1576
    ),
1577
1578
1579
1580
    # 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"))
    ),
1581
    # Allows vllm to find tuned config under customized folder
1582
    "VLLM_TUNED_CONFIG_FOLDER": lambda: os.getenv("VLLM_TUNED_CONFIG_FOLDER", None),
1583
1584
1585
1586
1587
1588
1589
1590
1591
    # 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"],
    ),
1592
    # Allows harmony instructions to be injected on system messages
1593
1594
1595
    "VLLM_GPT_OSS_HARMONY_SYSTEM_INSTRUCTIONS": lambda: bool(
        int(os.getenv("VLLM_GPT_OSS_HARMONY_SYSTEM_INSTRUCTIONS", "0"))
    ),
1596
1597
1598
1599
1600
1601
    # 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"))
    ),
1602
    # Add optional custom scopes for profiling, disable to avoid overheads
1603
1604
1605
    "VLLM_CUSTOM_SCOPES_FOR_PROFILING": lambda: bool(
        int(os.getenv("VLLM_CUSTOM_SCOPES_FOR_PROFILING", "0"))
    ),
1606
    # Add optional nvtx scopes for profiling, disable to avoid overheads
1607
1608
1609
    "VLLM_NVTX_SCOPES_FOR_PROFILING": lambda: bool(
        int(os.getenv("VLLM_NVTX_SCOPES_FOR_PROFILING", "0"))
    ),
1610
1611
    # Represent block hashes in KV cache events as 64-bit integers instead of
    # raw bytes. Defaults to True for backward compatibility.
1612
1613
1614
    "VLLM_KV_EVENTS_USE_INT_BLOCK_HASHES": lambda: bool(
        int(os.getenv("VLLM_KV_EVENTS_USE_INT_BLOCK_HASHES", "1"))
    ),
1615
1616
    # Name of the shared memory buffer used for object storage.
    # Only effective when mm_config.mm_processor_cache_type == "shm".
1617
1618
1619
1620
1621
    # 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}",
1622
    ),
1623
    # The size in MB of the buffers (NVL and RDMA) used by DeepEP
1624
1625
1626
    "VLLM_DEEPEP_BUFFER_SIZE_MB": lambda: int(
        os.getenv("VLLM_DEEPEP_BUFFER_SIZE_MB", "1024")
    ),
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
    # Force DeepEP to use intranode kernel for inter-node communication in
    # high throughput mode. This is useful archive higher prefill throuhgput
    # on system supports multi-node nvlink (e.g GB200).
    "VLLM_DEEPEP_HIGH_THROUGHPUT_FORCE_INTRA_NODE": lambda: bool(
        int(os.getenv("VLLM_DEEPEP_HIGH_THROUGHPUT_FORCE_INTRA_NODE", "0"))
    ),
    # Allow DeepEP to use MNNVL (multi-node nvlink) for internode_ll kernel,
    # turn this for better latency on GB200 like system
    "VLLM_DEEPEP_LOW_LATENCY_USE_MNNVL": lambda: bool(
        int(os.getenv("VLLM_DEEPEP_LOW_LATENCY_USE_MNNVL", "0"))
    ),
1638
1639
    # 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
1640
    "VLLM_DBO_COMM_SMS": lambda: int(os.getenv("VLLM_DBO_COMM_SMS", "20")),
1641
1642
1643
    # 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)
1644
1645
1646
    "VLLM_ENABLE_INDUCTOR_MAX_AUTOTUNE": lambda: bool(
        int(os.getenv("VLLM_ENABLE_INDUCTOR_MAX_AUTOTUNE", "1"))
    ),
1647
1648
    # If set to 1, enable coordinate_descent_tuning;
    # By default, this is enabled (1)
1649
1650
1651
    "VLLM_ENABLE_INDUCTOR_COORDINATE_DESCENT_TUNING": lambda: bool(
        int(os.getenv("VLLM_ENABLE_INDUCTOR_COORDINATE_DESCENT_TUNING", "1"))
    ),
1652
    # Flag to enable NCCL symmetric memory allocation and registration
1653
1654
1655
    "VLLM_USE_NCCL_SYMM_MEM": lambda: bool(
        int(os.getenv("VLLM_USE_NCCL_SYMM_MEM", "0"))
    ),
1656
    # NCCL header path
1657
    "VLLM_NCCL_INCLUDE_PATH": lambda: os.environ.get("VLLM_NCCL_INCLUDE_PATH", None),
1658
1659
    # Flag to enable FBGemm kernels on model execution
    "VLLM_USE_FBGEMM": lambda: bool(int(os.getenv("VLLM_USE_FBGEMM", "0"))),
1660
1661
1662
1663
1664
1665
    # 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", ""),
1666
1667
1668
    # Debug workspace allocations.
    # logging of workspace resize operations.
    "VLLM_DEBUG_WORKSPACE": lambda: bool(int(os.getenv("VLLM_DEBUG_WORKSPACE", "0"))),
1669
    # Disables parallel execution of shared_experts via separate cuda stream
1670
1671
    "VLLM_DISABLE_SHARED_EXPERTS_STREAM": lambda: bool(
        int(os.getenv("VLLM_DISABLE_SHARED_EXPERTS_STREAM", "0"))
1672
    ),
1673
1674
1675
1676
1677
1678
1679
    # 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))
    ),
1680
1681
1682
1683
1684
1685
1686
1687
1688
    # 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
1689
1690
1691
1692
    # Flag to enable v2 model runner.
    "VLLM_USE_V2_MODEL_RUNNER": lambda: bool(
        int(os.getenv("VLLM_USE_V2_MODEL_RUNNER", "0"))
    ),
1693
1694
1695
1696
1697
1698
    # 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"))
    ),
1699
1700
1701
1702
    # Debug logging for --enable-mfu-metrics
    "VLLM_DEBUG_MFU_METRICS": lambda: bool(
        int(os.getenv("VLLM_DEBUG_MFU_METRICS", "0"))
    ),
1703
1704
    # Disable logging of vLLM logo at server startup time.
    "VLLM_DISABLE_LOG_LOGO": lambda: bool(int(os.getenv("VLLM_DISABLE_LOG_LOGO", "0"))),
1705
1706
1707
    # 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"))),
1708
    
1709
1710
1711
    # add envs
    
    # used in optest environment to manually set the https port
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
    'VLLM_OPTEST_URLS_PORT':
    lambda: int(os.getenv('VLLM_OPTEST_URLS_PORT', '8000'))
    if 'VLLM_OPTEST_URLS_PORT' in os.environ else None,
    
    # Path to the optest models.
    # If set, will load models from local path instead of Hugging Face Hub.
    'VLLM_OPTEST_MODELS_PATH':
    lambda: os.getenv('VLLM_OPTEST_MODELS_PATH', "") or os.getenv("OPTEST_MODELS_PATH", ""),
    
    # flag to control if vllm should use triton prefix flash attention
    "VLLM_USE_TRITON_PREFIX_FLASH_ATTN":
    lambda: (os.environ.get("VLLM_USE_TRITON_PREFIX_FLASH_ATTN", "False").lower() in
             ("true", "1")),
    
1726
1727
1728
1729
    # If set, vLLM will use FLASH ATTN fp8 attention optimizations.
    "VLLM_USE_FLASH_ATTN_FP8":
    lambda: bool(int(os.getenv("VLLM_USE_FLASH_ATTN_FP8", "0"))),
    
1730
1731
1732
1733
1734
    # flag to control if vllm should use q quant
    "VLLM_USE_QUERY_QUANT":
    lambda: (os.environ.get("VLLM_USE_QUERY_QUANT", "False").lower() in
             ("true", "1")),
    
zhuwenwen's avatar
zhuwenwen committed
1735
1736
1737
1738
    # If set, vLLM will use FLASH MLA attention optimizations.
    "VLLM_USE_FLASH_MLA":
    lambda: bool(int(os.getenv("VLLM_USE_FLASH_MLA", "1"))),
    
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
    # flag to control vllm to use optimized kernels
    "VLLM_USE_OPT_OP":
    lambda: (os.environ.get("VLLM_USE_OPT_OP", "True").lower() in
             ("true", "1")),
    
    # flag to control vllm to use optimized tc paged attn kernels
    "VLLM_USE_TC_PAGED_ATTN":
    lambda: (os.environ.get("VLLM_USE_TC_PAGED_ATTN", "True").lower() in
             ("true", "1")),
    
    # flag to control if vllm print pa parameters
    "VLLM_USE_PA_PRINT_PARAM":
    lambda: (os.environ.get("VLLM_USE_PA_PRINT_PARAM", "False").lower() in
             ("true", "1")),
    
    # If set, vLLM will disable the draft model in cudagraph mode.
    "VLLM_SPEC_DECODE_EAGER":
    lambda: bool(int(os.getenv("VLLM_SPEC_DECODE_EAGER", "0"))),
    
    # flag to control vllm to use optimized kernels
    "VLLM_PCIE_USE_CUSTOM_ALLREDUCE":
1760
    lambda: bool(int(os.environ.get("VLLM_PCIE_USE_CUSTOM_ALLREDUCE", "1"))),
1761
    
1762
1763
    # flag to control vllm to use optimized kernels
    "VLLM_CUSTOM_CACHE":
1764
    lambda: bool(int(os.environ.get("VLLM_CUSTOM_CACHE", "1"))),
1765
    
zhuwenwen's avatar
zhuwenwen committed
1766
1767
1768
1769
    # flag to control vllm to use optimized kernels
    "VLLM_CUSTOM_ALLREDUCE_SUPPORTED_WORLDSIZE_MAX":
    lambda: int(os.getenv("VLLM_CUSTOM_ALLREDUCE_SUPPORTED_WORLDSIZE_MAX", "16")),
    
1770
1771
1772
    # If set, vLLM will disable the draft model in cudagraph mode.
    "VLLM_ENFORCE_EAGER_BS_THRESHOLD":
    lambda: int(os.environ.get("VLLM_ENFORCE_EAGER_BS_THRESHOLD", "-1")),
1773

1774
1775
1776
1777
1778
1779
    # 'has_comtext' is a variable in common.py, which is calculated
    # by metadata by default. However, it may introduce synchronization 
    # and affect performance, so it is directly assigned as False. 
    # If there are any problems during use, use environment variables 
    # to restore the default usage.
    "VLLM_HAS_CONTEXT_DEFAULT":
zhuwenwen's avatar
zhuwenwen committed
1780
    lambda: bool(int(os.getenv("VLLM_HAS_CONTEXT_DEFAULT", "1"))),
1781
1782
1783
    
    # If set, vLLM will transpose weight to use nn layout
    "VLLM_USE_NN":
zhuwenwen's avatar
zhuwenwen committed
1784
    lambda: (os.environ.get("VLLM_USE_NN", "True").lower() in
1785
             ("true", "1")),
1786

1787
1788
1789
    # Enable two batch overlap.
    "VLLM_ENABLE_TBO":
    lambda: bool(int(os.getenv("VLLM_ENABLE_TBO", "0"))),
1790
1791
1792

    # If set, vLLM will enable the moe_fused_gate kernel.
    "VLLM_ENABLE_MOE_FUSED_GATE":
zhuwenwen's avatar
zhuwenwen committed
1793
    lambda: bool(int(os.getenv("VLLM_ENABLE_MOE_FUSED_GATE", "1"))),
zhuwenwen's avatar
zhuwenwen committed
1794
    
1795
1796
    # vLLM will use FlashAttention Backend for page attention computation on rocm
    "VLLM_USE_FLASH_ATTN_PA":
zhuwenwen's avatar
zhuwenwen committed
1797
    lambda: (os.environ.get("VLLM_USE_FLASH_ATTN_PA", "True").lower() in
zhuwenwen's avatar
zhuwenwen committed
1798
             ("true", "1")),
zhuwenwen's avatar
zhuwenwen committed
1799
1800
1801
1802
1803
    
    # vLLM will use apex for rmsnorm
    "VLLM_USE_APEX_RN":
    lambda: (os.environ.get("VLLM_USE_APEX_RN", "False").lower() in
             ("true", "1")),
1804
1805
1806
    
    # vLLM will use global cache for moe
    "VLLM_USE_GLOBAL_CACHE13":
1807
        lambda: (os.environ.get("VLLM_USE_GLOBAL_CACHE13", "False").lower() in
1808
                 ("true", "1")),
1809
        
1810
1811
1812
    # vLLM will use lightop for deepseek-v3
    "VLLM_USE_LIGHTOP":
        lambda: (os.environ.get("VLLM_USE_LIGHTOP", "False").lower() in
1813
                 ("true", "1")),
1814
        
1815
1816
1817
    # vLLM will use opt cat for deepseek-v3
    "VLLM_USE_OPT_CAT":
        lambda: (os.environ.get("VLLM_USE_OPT_CAT", "True").lower() in
zhuwenwen's avatar
zhuwenwen committed
1818
                 ("true", "1")), 
zhuwenwen's avatar
zhuwenwen committed
1819
1820
1821
1822
1823
1824
1825
    # vLLM will use lightop moe_sum 
    "VLLM_USE_LIGHTOP_MOE_SUM":
        lambda: (os.environ.get("VLLM_USE_LIGHTOP_MOE_SUM", "False").lower() in
                 ("true", "1")),  
    # vLLM will use lightop moe_align_block_size 
    "VLLM_USE_LIGHTOP_MOE_ALIGN":
        lambda: (os.environ.get("VLLM_USE_LIGHTOP_MOE_ALIGN", "False").lower() in
1826
1827
1828
1829
                 ("true", "1")),    
    # vllm will use fused cat and mla
    "VLLM_USE_CAT_MLA":
        lambda: (os.getenv('VLLM_USE_CAT_MLA', 'False').lower() in
1830
1831
1832
1833
1834
                 ("true", "1")),
    # vllm will use fused cat and mla
    "FP8_USE_MIXED_BATCH":
        lambda: (os.getenv('FP8_USE_MIXED_BATCH', 'False').lower() in
                 ("true", "1")),                                     
1835
1836
1837
1838
    # vLLM will use opt merge_aatn_states,not triton
    "VLLM_USE_MERGE_ATTN_STATES_OPT":
        lambda: (os.environ.get("VLLM_USE_MERGE_ATTN_STATES_OPT", "True").lower() in
                 ("true", "1")),  
jujl1's avatar
jujl1 committed
1839
1840
    # vllm will use rmsquant fused op
    "USE_FUSED_RMS_QUANT":
王敏's avatar
王敏 committed
1841
        lambda: bool(int(os.getenv("USE_FUSED_RMS_QUANT", "0"))),
xuxz's avatar
xuxz committed
1842
1843
1844
1845
1846
1847
    # vllm pd separation will be used async
    "VLLM_P2P_ASYNC":
    lambda: bool(int(os.getenv("VLLM_P2P_ASYNC", "0"))),
    # pd separation p2p async buf tokens
    "VLLM_P2P_BUF_TOKENS":
    lambda: int(os.getenv("VLLM_P2P_BUF_TOKENS", "30000")),
1848
1849
    # vllm will use silu_mul_quant fused op
    "USE_FUSED_SILU_MUL_QUANT":
1850
1851
        lambda: (os.getenv("USE_FUSED_SILU_MUL_QUANT", "False").lower() in
                ("true", "1")),
1852

zhuwenwen's avatar
zhuwenwen committed
1853
1854
    # vLLM will split prefill and decode, not mix up
    "VLLM_USE_PD_SPLIT":
1855
        lambda: (os.environ.get("VLLM_USE_PD_SPLIT", "True").lower() in
zhuwenwen's avatar
zhuwenwen committed
1856
                 ("true", "1")), 
zhuwenwen's avatar
zhuwenwen committed
1857
1858
1859
1860
    # vLLM will sync to avoid pp vmfault
    "VLLM_USE_PP_SYNC":
        lambda: (os.environ.get("VLLM_USE_PP_SYNC", "False").lower() in
                 ("true", "1")), 
1861
1862
    # vLLM will use piecewise
    "VLLM_USE_PIECEWISE":
王敏's avatar
王敏 committed
1863
        lambda: (os.environ.get("VLLM_USE_PIECEWISE", "False").lower() in
1864
                 ("true", "1")), 
1865
1866
    # vllm will use encoding_dsv32.py for dpsk-v32
    "VLLM_USE_V32_ENCODE":
1867
        lambda: (os.environ.get('VLLM_USE_V32_ENCODE', 'False').lower() in
1868
                 ("true", "1")),  
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
    # vLLM will use fused silu+mul kernel (fp16 + qwen3-30b)
    "VLLM_USE_FUSE_SILU_AND_MUL":
        lambda: (os.environ.get("VLLM_USE_FUSE_SILU_AND_MUL", "False").lower() in
                 ("true", "1")),
    # vLLM will use optimized reshape_and_cache kernel when enabled (fp16 + qwen3-30b)
    "VLLM_USE_OPT_RESHAPE_AND_CACHE":
        lambda:
        (os.environ.get("VLLM_USE_OPT_RESHAPE_AND_CACHE", "False").lower() in
                ("true", "1")),
    # vLLM will use optimized topk_softmax + renormalize
    "VLLM_USE_TOPK_RENORM":
        lambda:
zhuwenwen's avatar
zhuwenwen committed
1881
        (os.environ.get("VLLM_USE_TOPK_RENORM", "False").lower() in
1882
                ("true", "1")),
1883
1884
    # vLLM will use fused RMS + RoPE kernel
    "VLLM_USE_FUSED_RMS_ROPE":
1885
        lambda: (os.environ.get("VLLM_USE_FUSED_RMS_ROPE", "True").lower() in
1886
                 ("true", "1")),
1887
1888
1889
1890
    # vLLM will use lightop for dpsk mtp fill + rms*2 + cat
    "VLLM_USE_FUSED_FILL_RMS_CAT":
        lambda: (os.environ.get("VLLM_USE_FUSED_FILL_RMS_CAT", "False").lower() in
                 ("true", "1")),
jujl1's avatar
jujl1 committed
1891
1892
1893
    "VLLM_USE_PP_BALANCE":
        lambda: (os.environ.get("VLLM_USE_PP_BALANCE", "True").lower() in
                 ("true", "1")),
1894
1895
1896
1897
1898
1899
    # W8A8 GEMM backend selection for vLLM quantized models.
    # lightop/triton: 1
    # cutlass: 2 (will remove in the future)
    # blaslt: 3 (default)
    # rocblas: others
    "VLLM_W8A8_BACKEND": lambda: int(os.getenv("VLLM_W8A8_BACKEND", "3")),
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
    # Capture MoE router logits for debugging/analysis.
    "VLLM_MOE_ROUTER_CAPTURE":
    lambda: (os.getenv("VLLM_MOE_ROUTER_CAPTURE", "0").lower() in ("true", "1")),
    # Output directory for MoE router capture dumps.
    "VLLM_MOE_ROUTER_CAPTURE_DIR":
    lambda: os.environ.get(
        "VLLM_MOE_ROUTER_CAPTURE_DIR",
        "/tmp",
    ),
    # Capture only the specified rank; set to -1 to capture all ranks.
    "VLLM_MOE_ROUTER_CAPTURE_RANK":
    lambda: int(os.environ.get("VLLM_MOE_ROUTER_CAPTURE_RANK", "-1")),
    # Max number of MoE layers to record per process (0 = unlimited).
    "VLLM_MOE_ROUTER_CAPTURE_MAX_LAYERS":
    lambda: int(os.environ.get("VLLM_MOE_ROUTER_CAPTURE_MAX_LAYERS", "0")),
    # Only capture when num_tokens > N (negative disables).
    "VLLM_MOE_ROUTER_CAPTURE_NUM_TOKENS_GT":
    lambda: int(os.environ.get("VLLM_MOE_ROUTER_CAPTURE_NUM_TOKENS_GT", "-1")),
    # Only capture when num_tokens < N (0 disables).
    "VLLM_MOE_ROUTER_CAPTURE_NUM_TOKENS_LT":
    lambda: int(os.environ.get("VLLM_MOE_ROUTER_CAPTURE_NUM_TOKENS_LT", "-1")),
王敏's avatar
王敏 committed
1921
1922
1923
1924
1925

    # vllm will use optimized reject sample
    "VLLM_REJECT_SAMPLE_OPT":
        lambda: (os.getenv('VLLM_REJECT_SAMPLE_OPT', 'True').lower() in
                 ("true", "1")),
1926
1927
1928
1929
    # Force using Triton MoE path (disable Marlin W16A16 MoE).
    "VLLM_USE_MOE_W16A16_TRITON":
        lambda: (os.environ.get("VLLM_USE_MOE_W16A16_TRITON", "0").lower() in
                 ("true", "1")),
guanyu1's avatar
guanyu1 committed
1930
1931
    "VLLM_1D_MROPE":
        lambda: (os.environ.get("VLLM_1D_MROPE", "0").lower() in ("true", "1")),
1932
1933
    "VLLM_ENCODER_CACHE_SIZE":
        lambda: maybe_convert_int(os.environ.get("VLLM_ENCODER_CACHE_SIZE", None)),
1934
1935
1936
1937
    #If set to 1/True, enable the V1 fast token-id copy path in InputBatch.
    "VLLM_V1_FAST_TOKEN_ID_COPY":
        lambda: (os.environ.get("VLLM_V1_FAST_TOKEN_ID_COPY", "False").lower() in
                    ("true", "1")),
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
    # If set to 1/True, enable reduced top-k/top-p sampling fast path in the
    # V1 PyTorch-native sampler path.
    #
    # Recommended when both top_k is enabled and top_p < 1.0 (nucleus
    # sampling). Not recommended for top-k only (top_p == 1.0) due to
    # potential behavior differences when the k-th logit is tied.
    "VLLM_V1_USE_REDUCED_TOPK_TOPP_SAMPLER":
        lambda: (
            os.environ.get(
                "VLLM_V1_USE_REDUCED_TOPK_TOPP_SAMPLER", "False"
            ).lower()
            in ("true", "1")
        ),
1951
1952
1953
1954
    # vLLM will use lightop fill + moe_align_block_size
    "VLLM_USE_LIGHTOP_FILL_MOE_ALIGN":
        lambda: (os.environ.get("VLLM_USE_LIGHTOP_FILL_MOE_ALIGN", "False").lower() in
                 ("true", "1")),
1955
1956
1957
1958
1959

    #If set to 1/True, enable fuse split qkv+rmsnorm+rope+kv update just like glm4.7 moe attention.
    "VLLM_V1_USE_FUSED_QKV_SPLIT_RMS_ROPE_KVSTORE":
        lambda: (os.environ.get("VLLM_V1_USE_FUSED_QKV_SPLIT_RMS_ROPE_KVSTORE", "False").lower() in
                    ("true", "1")),
1960
1961
1962
1963
1964
    # DeepSeek MLA: fused rmsnorm + contiguous + rope + concat_and_cache_mla
    "VLLM_USE_LIGHTOP_RMS_ROPE_CONCAT":
        lambda: (os.environ.get("VLLM_USE_LIGHTOP_RMS_ROPE_CONCAT",
                                "False").lower() in ("true", "1")),

1965
1966
1967
1968
    # DOUBLE TRANSPOSE BMM FP8 format use in NMZ DeepSeek models
    "VLLM_USE_FUSED_DTBMM":
        lambda: (os.environ.get("VLLM_USE_FUSED_DTBMM", "False").lower() in
                ("true", "1")),
wujl5's avatar
wujl5 committed
1969
1970
1971
1972
    # vllm will use 1-24,32,40,48... (not only 1 2 4 8 16)
    "VLLM_USE_CUDA_GRAPH_SIZES":
        lambda: (os.getenv("VLLM_USE_CUDA_GRAPH_SIZES", "False").lower() in
                ("true", "1")),
1973

1974
1975
1976
1977
1978
    # vLLM will use lightop fused moe_sum + mul + add (bias + factor)
    "VLLM_USE_LIGHTOP_MOE_SUM_MUL_ADD":
        lambda: (os.environ.get("VLLM_USE_LIGHTOP_MOE_SUM_MUL_ADD",
                                "False").lower() in ("true", "1")),

1979
1980
1981
1982
    #If set to 1/True, enable fused topk topk kernel in lightop
    "VLLM_USE_LIGHTOP_FUSED_TOPP_TOPK":
        lambda: (os.environ.get("VLLM_USE_LIGHTOP_FUSED_TOPP_TOPK", "False").lower() in
                    ("true", "1")),
1983
1984
1985
1986
1987

    #If set to 1/True, enable async scheduling in ray distribute mode
    "VLLM_ENABLE_RAY_ASYNC_SCHEDULING":
        lambda: (os.environ.get("VLLM_ENABLE_RAY_ASYNC_SCHEDULING", "False").lower() in
                    ("true", "1")),
1988

fanwl's avatar
fanwl committed
1989
1990
1991
1992
    #If set to 1/True, enable the flash attention unified path.
    "VLLM_V1_USE_FA_UNIFIED_ATTN_2D":
        lambda: (os.environ.get("VLLM_V1_USE_FA_UNIFIED_ATTN_2D", "False").lower() in
                    ("true", "1")),
1993
1994
}

1995
# --8<-- [end:env-vars-definition]
1996

1997

1998
def __getattr__(name: str):
1999
2000
2001
2002
2003
2004
    """
    Gets environment variables lazily.

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


2010
2011
2012
2013
2014
2015
def _is_envs_cache_enabled() -> bool:
    """Checked if __getattr__ is wrapped with functools.cache"""
    global __getattr__
    return hasattr(__getattr__, "cache_clear")


2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
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.
    """
2026
2027
2028
    if _is_envs_cache_enabled():
        # Avoid wrapping functools.cache multiple times
        return
2029
2030
2031
2032
2033
2034
2035
2036
2037
    # Tag __getattr__ with functools.cache
    global __getattr__
    __getattr__ = functools.cache(__getattr__)

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


2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
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():
        __getattr__ = __getattr__.__wrapped__


2049
2050
def __dir__():
    return list(environment_variables.keys())
2051
2052
2053
2054
2055
2056
2057
2058
2059


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


2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
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",
2082
        "VLLM_FORCE_AOT_LOAD",
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
        "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
2093
        "VLLM_LOGGING_COLOR",
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
        "VLLM_LOG_STATS_INTERVAL",
        "VLLM_DEBUG_LOG_API_SERVER_RESPONSE",
        "VLLM_TUNED_CONFIG_FOLDER",
        "VLLM_ENGINE_ITERATION_TIMEOUT_S",
        "VLLM_HTTP_TIMEOUT_KEEP_ALIVE",
        "VLLM_EXECUTE_MODEL_TIMEOUT_SECONDS",
        "VLLM_KEEP_ALIVE_ON_ENGINE_DEATH",
        "VLLM_SLEEP_WHEN_IDLE",
        "VLLM_IMAGE_FETCH_TIMEOUT",
        "VLLM_VIDEO_FETCH_TIMEOUT",
        "VLLM_AUDIO_FETCH_TIMEOUT",
        "VLLM_MEDIA_URL_ALLOW_REDIRECTS",
        "VLLM_MEDIA_LOADING_THREAD_COUNT",
        "VLLM_MAX_AUDIO_CLIP_FILESIZE_MB",
        "VLLM_VIDEO_LOADER_BACKEND",
        "VLLM_MEDIA_CONNECTOR",
2110
        "VLLM_OBJECT_STORAGE_SHM_BUFFER_NAME",
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
        "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_OMP_THREADS_BIND",
        "VLLM_CPU_NUM_OF_RESERVED_CPU",
        "VLLM_CPU_MOE_PREPACK",
        "VLLM_CPU_SGL_KERNEL",
        "VLLM_TEST_FORCE_LOAD_FORMAT",
        "LOCAL_RANK",
        "CUDA_VISIBLE_DEVICES",
Nick Hill's avatar
Nick Hill committed
2124
        "NO_COLOR",
2125
        "VLLM_W8A8_BACKEND",
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
    }

    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
2144

2145
        factors[factor] = normalize_value(raw)
2146

2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
    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",
2167
    ]
2168

2169
2170
    for var in ray_noset_env_vars:
        factors[var] = normalize_value(os.getenv(var))
2171

2172
    return factors