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

4
import argparse
5
import copy
6
import dataclasses
7
import functools
8
import json
9
import sys
10
from collections.abc import Callable
11
from dataclasses import MISSING, dataclass, fields, is_dataclass
12
from itertools import permutations
13
from types import UnionType
14
15
16
17
18
from typing import (
    TYPE_CHECKING,
    Annotated,
    Any,
    Literal,
19
    TypeAlias,
20
21
22
23
24
25
    TypeVar,
    Union,
    cast,
    get_args,
    get_origin,
)
26

27
import huggingface_hub
28
import regex as re
29
import torch
30
from pydantic import TypeAdapter, ValidationError
31
from pydantic.fields import FieldInfo
32
from typing_extensions import TypeIs
33

34
import vllm.envs as envs
35
from vllm.config import (
36
    AttentionConfig,
37
38
39
40
    CacheConfig,
    CompilationConfig,
    ConfigType,
    DeviceConfig,
41
    ECTransferConfig,
42
    EPLBConfig,
43
    KernelConfig,
44
45
46
47
48
    KVEventsConfig,
    KVTransferConfig,
    LoadConfig,
    LoRAConfig,
    ModelConfig,
49
    MultiModalConfig,
50
    ObservabilityConfig,
51
    OffloadConfig,
52
53
    ParallelConfig,
    PoolerConfig,
54
    PrefetchOffloadConfig,
55
    ProfilerConfig,
56
57
58
    SchedulerConfig,
    SpeculativeConfig,
    StructuredOutputsConfig,
59
    UVAOffloadConfig,
60
    VllmConfig,
61
    WeightTransferConfig,
62
63
    get_attr_docs,
)
64
from vllm.config.cache import (
65
    BlockSize,
66
67
    CacheDType,
    KVOffloadingBackend,
68
    MambaCacheMode,
69
70
71
    MambaDType,
    PrefixCachingHashAlgo,
)
72
from vllm.config.device import Device
73
from vllm.config.kernel import MoEBackend
74
from vllm.config.lora import MaxLoRARanks
75
76
77
78
79
80
from vllm.config.model import (
    ConvertOption,
    HfOverrides,
    LogprobsMode,
    ModelDType,
    RunnerOption,
81
    TokenizerMode,
82
83
84
)
from vllm.config.multimodal import MMCacheType, MMEncoderTPMode
from vllm.config.observability import DetailedTraceModules
85
86
87
from vllm.config.parallel import (
    All2AllBackend,
    DataParallelBackend,
88
    DCPCommBackend,
89
90
91
    DistributedExecutorBackend,
    ExpertPlacementStrategy,
)
92
from vllm.config.scheduler import SchedulerPolicy
93
from vllm.config.utils import get_field
94
from vllm.config.vllm import OptimizationLevel, PerformanceMode
95
from vllm.logger import init_logger, suppress_logging
96
from vllm.platforms import CpuArchEnum, current_platform
97
from vllm.plugins import load_general_plugins
98
from vllm.ray.lazy_utils import is_in_ray_actor, is_ray_initialized
99
100
101
102
from vllm.transformers_utils.config import (
    is_interleaved,
    maybe_override_with_speculators,
)
103
from vllm.transformers_utils.gguf_utils import is_gguf
104
from vllm.transformers_utils.repo_utils import get_model_path
105
from vllm.transformers_utils.utils import is_cloud_storage
106
from vllm.utils.argparse_utils import FlexibleArgumentParser
107
from vllm.utils.mem_constants import GiB_bytes
108
from vllm.utils.network_utils import get_ip
109
from vllm.utils.torch_utils import resolve_kv_cache_dtype_string
110
from vllm.v1.attention.backends.registry import AttentionBackendEnum
111
from vllm.v1.sample.logits_processor import LogitsProcessor
112

113
114
if TYPE_CHECKING:
    from vllm.model_executor.layers.quantization import QuantizationMethods
115
    from vllm.model_executor.model_loader import LoadFormats
116
    from vllm.usage.usage_lib import UsageContext
117
    from vllm.v1.executor import Executor
118
else:
119
    Executor = Any
120
    QuantizationMethods = Any
121
    LoadFormats = Any
122
123
    UsageContext = Any

124

125
126
logger = init_logger(__name__)

127
128
# object is used to allow for special typing forms
T = TypeVar("T")
129
130
TypeHint: TypeAlias = type[Any] | object
TypeHintT: TypeAlias = type[T] | object
131

132

133
134
def parse_type(return_type: Callable[[str], T]) -> Callable[[str], T]:
    def _parse_type(val: str) -> T:
135
136
137
138
        try:
            return return_type(val)
        except ValueError as e:
            raise argparse.ArgumentTypeError(
139
140
                f"Value {val} cannot be converted to {return_type}."
            ) from e
141

142
143
144
    return _parse_type


145
146
def optional_type(return_type: Callable[[str], T]) -> Callable[[str], T | None]:
    def _optional_type(val: str) -> T | None:
147
148
149
150
        if val == "" or val == "None":
            return None
        return parse_type(return_type)(val)

151
    return _optional_type
152
153


154
def union_dict_and_str(val: str) -> str | dict[str, str] | None:
155
    if not re.match(r"(?s)^\s*{.*}\s*$", val):
156
        return str(val)
157
    return optional_type(json.loads)(val)
158
159


160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
def is_type(type_hint: TypeHint, type: TypeHintT) -> TypeIs[TypeHintT]:
    """Check if the type hint is a specific type."""
    return type_hint is type or get_origin(type_hint) is type


def contains_type(type_hints: set[TypeHint], type: TypeHintT) -> bool:
    """Check if the type hints contain a specific type."""
    return any(is_type(type_hint, type) for type_hint in type_hints)


def get_type(type_hints: set[TypeHint], type: TypeHintT) -> TypeHintT:
    """Get the specific type from the type hints."""
    return next((th for th in type_hints if is_type(th, type)), None)


175
def literal_to_kwargs(type_hints: set[TypeHint]) -> dict[str, Any]:
176
177
178
179
    """Get the `type` and `choices` from a `Literal` type hint in `type_hints`.

    If `type_hints` also contains `str`, we use `metavar` instead of `choices`.
    """
180
    type_hint = get_type(type_hints, Literal)
181
182
183
    options = get_args(type_hint)
    option_type = type(options[0])
    if not all(isinstance(option, option_type) for option in options):
184
        raise ValueError(
185
            "All options must be of the same type. "
186
187
            f"Got {options} with types {[type(c) for c in options]}"
        )
188
189
    kwarg = "metavar" if contains_type(type_hints, str) else "choices"
    return {"type": option_type, kwarg: sorted(options)}
190
191


192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
def collection_to_kwargs(type_hints: set[TypeHint], type: TypeHint) -> dict[str, Any]:
    type_hint = get_type(type_hints, type)
    types = get_args(type_hint)
    elem_type = types[0]

    # Handle Ellipsis
    assert all(t is elem_type for t in types if t is not Ellipsis), (
        f"All non-Ellipsis elements must be of the same type. Got {types}."
    )

    # Handle Union types
    if get_origin(elem_type) in {Union, UnionType}:
        # Union for Union[X, Y] and UnionType for X | Y
        assert str in get_args(elem_type), (
            "If element can have multiple types, one must be 'str' "
            f"(i.e. 'list[int | str]'). Got {elem_type}."
        )
        elem_type = str

    return {
        "type": elem_type,
        "nargs": "+" if type is not tuple or Ellipsis in types else len(types),
    }


217
218
219
220
221
def is_not_builtin(type_hint: TypeHint) -> bool:
    """Check if the class is not a built-in type."""
    return type_hint.__module__ != "builtins"


222
223
224
225
226
227
228
229
def get_type_hints(type_hint: TypeHint) -> set[TypeHint]:
    """Extract type hints from Annotated or Union type hints."""
    type_hints: set[TypeHint] = set()
    origin = get_origin(type_hint)
    args = get_args(type_hint)

    if origin is Annotated:
        type_hints.update(get_type_hints(args[0]))
230
231
    elif origin in {Union, UnionType}:
        # Union for Union[X, Y] and UnionType for X | Y
232
233
234
235
236
237
238
239
        for arg in args:
            type_hints.update(get_type_hints(arg))
    else:
        type_hints.add(type_hint)

    return type_hints


240
NEEDS_HELP = (
241
242
    any("--help" in arg for arg in sys.argv)  # vllm SUBCOMMAND --help
    or (argv0 := sys.argv[0]).endswith("mkdocs")  # mkdocs SUBCOMMAND
243
244
245
246
    or argv0.endswith("mkdocs/__main__.py")  # python -m mkdocs SUBCOMMAND
)


247
@functools.lru_cache(maxsize=30)
248
def _compute_kwargs(cls: ConfigType) -> dict[str, dict[str, Any]]:
249
250
    # Save time only getting attr docs if we're generating help text
    cls_docs = get_attr_docs(cls) if NEEDS_HELP else {}
251
252
    kwargs = {}
    for field in fields(cls):
253
        # Get the set of possible types for the field
254
        type_hints: set[TypeHint] = get_type_hints(field.type)
255
256
257
258
259

        # If the field is a dataclass, we can use the model_validate_json
        generator = (th for th in type_hints if is_dataclass(th))
        dataclass_cls = next(generator, None)

260
        # Get the default value of the field
261
262
        if field.default is not MISSING:
            default = field.default
263
264
            # Handle pydantic.Field defaults
            if isinstance(default, FieldInfo):
265
266
267
268
269
270
                if default.default_factory is None:
                    default = default.default
                else:
                    # VllmConfig's Fields have default_factory set to config classes.
                    # These could emit logs on init, which would be confusing.
                    with suppress_logging():
271
                        default = default.default_factory()  # type: ignore[call-arg]
272
        elif field.default_factory is not MISSING:
273
            default = field.default_factory()
274
275
276

        # Get the help text for the field
        name = field.name
277
        help = cls_docs.get(name, "").strip()
278
279
280
281
282
283
284
        # Escape % for argparse
        help = help.replace("%", "%%")

        # Initialise the kwargs dictionary for the field
        kwargs[name] = {"default": default, "help": help}

        # Set other kwargs based on the type hints
285
286
287
        json_tip = (
            "Should either be a valid JSON string or JSON keys passed individually."
        )
288
        if dataclass_cls is not None:
289
290
291
292
293
294
295
296

            def parse_dataclass(val: str, cls=dataclass_cls) -> Any:
                try:
                    return TypeAdapter(cls).validate_json(val)
                except ValidationError as e:
                    raise argparse.ArgumentTypeError(repr(e)) from e

            kwargs[name]["type"] = parse_dataclass
297
            kwargs[name]["help"] += f"\n\n{json_tip}"
298
        elif contains_type(type_hints, bool):
299
300
301
            # Creates --no-<name> and --<name> flags
            kwargs[name]["action"] = argparse.BooleanOptionalAction
        elif contains_type(type_hints, Literal):
302
            kwargs[name].update(literal_to_kwargs(type_hints))
303
        elif contains_type(type_hints, tuple):
304
            kwargs[name].update(collection_to_kwargs(type_hints, tuple))
305
        elif contains_type(type_hints, list):
306
307
308
            kwargs[name].update(collection_to_kwargs(type_hints, list))
        elif contains_type(type_hints, set):
            kwargs[name].update(collection_to_kwargs(type_hints, set))
309
        elif contains_type(type_hints, int):
310
311
312
313
            if name == "max_model_len":
                kwargs[name]["type"] = human_readable_int_or_auto
                kwargs[name]["help"] += f"\n\n{human_readable_int_or_auto.__doc__}"
            elif name in ("max_num_batched_tokens", "kv_cache_memory_bytes"):
314
                kwargs[name]["type"] = human_readable_int
315
                kwargs[name]["help"] += f"\n\n{human_readable_int.__doc__}"
316
317
            else:
                kwargs[name]["type"] = int
318
319
        elif contains_type(type_hints, float):
            kwargs[name]["type"] = float
320
321
322
323
        elif contains_type(type_hints, dict) and (
            contains_type(type_hints, str)
            or any(is_not_builtin(th) for th in type_hints)
        ):
324
            kwargs[name]["type"] = union_dict_and_str
325
        elif contains_type(type_hints, dict):
326
            kwargs[name]["type"] = parse_type(json.loads)
327
            kwargs[name]["help"] += f"\n\n{json_tip}"
328
329
330
        elif contains_type(type_hints, str) or any(
            is_not_builtin(th) for th in type_hints
        ):
331
332
            kwargs[name]["type"] = str
        else:
333
            raise ValueError(f"Unsupported type {type_hints} for argument {name}.")
334

335
336
337
338
339
        # If the type hint was a sequence of literals, use the helper function
        # to update the type and choices
        if get_origin(kwargs[name].get("type")) is Literal:
            kwargs[name].update(literal_to_kwargs({kwargs[name]["type"]}))

340
341
342
343
344
345
346
        # If None is in type_hints, make the argument optional.
        # But not if it's a bool, argparse will handle this better.
        if type(None) in type_hints and not contains_type(type_hints, bool):
            kwargs[name]["type"] = optional_type(kwargs[name]["type"])
            if kwargs[name].get("choices"):
                kwargs[name]["choices"].append("None")
    return kwargs
347
348


349
def get_kwargs(cls: ConfigType) -> dict[str, dict[str, Any]]:
350
351
    """Return argparse kwargs for the given Config dataclass.

352
353
354
    If `--help` or `mkdocs` are not present in the command line command, the
    attribute documentation will not be included in the help output.

355
356
357
358
359
360
361
    The heavy computation is cached via functools.lru_cache, and a deep copy
    is returned so callers can mutate the dictionary without affecting the
    cached version.
    """
    return copy.deepcopy(_compute_kwargs(cls))


362
@dataclass
Zhuohan Li's avatar
Zhuohan Li committed
363
class EngineArgs:
Woosuk Kwon's avatar
Woosuk Kwon committed
364
    """Arguments for vLLM engine."""
365

366
    model: str = ModelConfig.model
367
    enable_return_routed_experts: bool = ModelConfig.enable_return_routed_experts
368
    model_weights: str = ModelConfig.model_weights
369
    served_model_name: str | list[str] | None = ModelConfig.served_model_name
370
    tokenizer: str | None = ModelConfig.tokenizer
371
    hf_config_path: str | None = ModelConfig.hf_config_path
372
373
    runner: RunnerOption = ModelConfig.runner
    convert: ConvertOption = ModelConfig.convert
374
    skip_tokenizer_init: bool = ModelConfig.skip_tokenizer_init
375
    enable_prompt_embeds: bool = ModelConfig.enable_prompt_embeds
376
    tokenizer_mode: TokenizerMode | str = ModelConfig.tokenizer_mode
377
    trust_remote_code: bool = ModelConfig.trust_remote_code
378
379
    allowed_local_media_path: str = ModelConfig.allowed_local_media_path
    allowed_media_domains: list[str] | None = ModelConfig.allowed_media_domains
380
    download_dir: str | None = LoadConfig.download_dir
381
    safetensors_load_strategy: str = LoadConfig.safetensors_load_strategy
382
    load_format: str | LoadFormats = LoadConfig.load_format
383
384
    config_format: str = ModelConfig.config_format
    dtype: ModelDType = ModelConfig.dtype
385
    kv_cache_dtype: CacheDType = CacheConfig.cache_dtype
386
    seed: int = ModelConfig.seed
387
    max_model_len: int = ModelConfig.max_model_len
388
389
390
391
392
393
    cudagraph_capture_sizes: list[int] | None = (
        CompilationConfig.cudagraph_capture_sizes
    )
    max_cudagraph_capture_size: int | None = get_field(
        CompilationConfig, "max_cudagraph_capture_size"
    )
394
395
396
    # Note: Specifying a custom executor backend by passing a class
    # is intended for expert use only. The API may change without
    # notice.
397
    distributed_executor_backend: (
398
        str | DistributedExecutorBackend | type[Executor] | None
399
    ) = ParallelConfig.distributed_executor_backend
400
    # number of P/D disaggregation (or other disaggregation) workers
401
    pipeline_parallel_size: int = ParallelConfig.pipeline_parallel_size
402
403
404
405
    master_addr: str = ParallelConfig.master_addr
    master_port: int = ParallelConfig.master_port
    nnodes: int = ParallelConfig.nnodes
    node_rank: int = ParallelConfig.node_rank
406
    tensor_parallel_size: int = ParallelConfig.tensor_parallel_size
407
    prefill_context_parallel_size: int = ParallelConfig.prefill_context_parallel_size
408
    decode_context_parallel_size: int = ParallelConfig.decode_context_parallel_size
409
    dcp_comm_backend: DCPCommBackend = ParallelConfig.dcp_comm_backend
410
    dcp_kv_cache_interleave_size: int = ParallelConfig.dcp_kv_cache_interleave_size
411
    cp_kv_cache_interleave_size: int = ParallelConfig.cp_kv_cache_interleave_size
412
    data_parallel_size: int = ParallelConfig.data_parallel_size
413
414
415
416
417
    data_parallel_rank: int | None = None
    data_parallel_start_rank: int | None = None
    data_parallel_size_local: int | None = None
    data_parallel_address: str | None = None
    data_parallel_rpc_port: int | None = None
418
    data_parallel_hybrid_lb: bool = False
419
    data_parallel_external_lb: bool = False
420
    data_parallel_backend: DataParallelBackend = ParallelConfig.data_parallel_backend
421
    enable_expert_parallel: bool = ParallelConfig.enable_expert_parallel
422
    moe_backend: MoEBackend = KernelConfig.moe_backend
423
    all2all_backend: All2AllBackend = ParallelConfig.all2all_backend
424
    enable_elastic_ep: bool = ParallelConfig.enable_elastic_ep
425
    enable_dbo: bool = ParallelConfig.enable_dbo
426
    ubatch_size: int = ParallelConfig.ubatch_size
427
428
    dbo_decode_token_threshold: int = ParallelConfig.dbo_decode_token_threshold
    dbo_prefill_token_threshold: int = ParallelConfig.dbo_prefill_token_threshold
429
    disable_nccl_for_dp_synchronization: bool | None = (
430
431
        ParallelConfig.disable_nccl_for_dp_synchronization
    )
432
    eplb_config: EPLBConfig = get_field(ParallelConfig, "eplb_config")
433
    enable_eplb: bool = ParallelConfig.enable_eplb
434
    expert_placement_strategy: ExpertPlacementStrategy = (
435
        ParallelConfig.expert_placement_strategy
436
    )
437
438
    _api_process_count: int = ParallelConfig._api_process_count
    _api_process_rank: int = ParallelConfig._api_process_rank
439
    max_parallel_loading_workers: int | None = (
440
441
        ParallelConfig.max_parallel_loading_workers
    )
442
    block_size: BlockSize = CacheConfig.block_size
443
    enable_prefix_caching: bool | None = None
444
    prefix_caching_hash_algo: PrefixCachingHashAlgo = (
445
        CacheConfig.prefix_caching_hash_algo
446
    )
447
448
    disable_sliding_window: bool = ModelConfig.disable_sliding_window
    disable_cascade_attn: bool = ModelConfig.disable_cascade_attn
449
    swap_space: float = CacheConfig.swap_space
450
451
452
453
454
455
456
    offload_backend: str = OffloadConfig.offload_backend
    cpu_offload_gb: float = UVAOffloadConfig.cpu_offload_gb
    cpu_offload_params: set[str] = get_field(UVAOffloadConfig, "cpu_offload_params")
    offload_group_size: int = PrefetchOffloadConfig.offload_group_size
    offload_num_in_group: int = PrefetchOffloadConfig.offload_num_in_group
    offload_prefetch_step: int = PrefetchOffloadConfig.offload_prefetch_step
    offload_params: set[str] = get_field(PrefetchOffloadConfig, "offload_params")
457
    gpu_memory_utilization: float = CacheConfig.gpu_memory_utilization
458
    kv_cache_memory_bytes: int | None = CacheConfig.kv_cache_memory_bytes
459
    max_num_batched_tokens: int | None = None
460
461
    max_num_partial_prefills: int = SchedulerConfig.max_num_partial_prefills
    max_long_partial_prefills: int = SchedulerConfig.max_long_partial_prefills
462
    long_prefill_token_threshold: int = SchedulerConfig.long_prefill_token_threshold
463
    max_num_seqs: int | None = None
464
    max_logprobs: int = ModelConfig.max_logprobs
465
    logprobs_mode: LogprobsMode = ModelConfig.logprobs_mode
466
    disable_log_stats: bool = False
467
    aggregate_engine_logging: bool = False
468
469
470
    revision: str | None = ModelConfig.revision
    code_revision: str | None = ModelConfig.code_revision
    hf_token: bool | str | None = ModelConfig.hf_token
471
    hf_overrides: HfOverrides = get_field(ModelConfig, "hf_overrides")
472
    tokenizer_revision: str | None = ModelConfig.tokenizer_revision
473
    quantization: QuantizationMethods | str | None = ModelConfig.quantization
474
    allow_deprecated_quantization: bool = ModelConfig.allow_deprecated_quantization
475
    enforce_eager: bool = ModelConfig.enforce_eager
476
    disable_custom_all_reduce: bool = ParallelConfig.disable_custom_all_reduce
477
    language_model_only: bool = MultiModalConfig.language_model_only
478
    limit_mm_per_prompt: dict[str, int | dict[str, int]] = get_field(
479
480
        MultiModalConfig, "limit_per_prompt"
    )
481
    enable_mm_embeds: bool = MultiModalConfig.enable_mm_embeds
482
    interleave_mm_strings: bool = MultiModalConfig.interleave_mm_strings
483
484
485
    media_io_kwargs: dict[str, dict[str, Any]] = get_field(
        MultiModalConfig, "media_io_kwargs"
    )
486
    mm_processor_kwargs: dict[str, Any] | None = MultiModalConfig.mm_processor_kwargs
487
    mm_processor_cache_gb: float = MultiModalConfig.mm_processor_cache_gb
488
    mm_processor_cache_type: MMCacheType | None = (
489
        MultiModalConfig.mm_processor_cache_type
490
491
    )
    mm_shm_cache_max_object_size_mb: int = (
492
        MultiModalConfig.mm_shm_cache_max_object_size_mb
493
    )
494
    mm_encoder_only: bool = MultiModalConfig.mm_encoder_only
495
    mm_encoder_tp_mode: MMEncoderTPMode = MultiModalConfig.mm_encoder_tp_mode
496
    mm_encoder_attn_backend: AttentionBackendEnum | str | None = (
497
498
        MultiModalConfig.mm_encoder_attn_backend
    )
499
    io_processor_plugin: str | None = None
500
    skip_mm_profiling: bool = MultiModalConfig.skip_mm_profiling
501
    video_pruning_rate: float | None = MultiModalConfig.video_pruning_rate
502
    # LoRA fields
503
    enable_lora: bool = False
504
    max_loras: int = LoRAConfig.max_loras
505
    max_lora_rank: MaxLoRARanks = LoRAConfig.max_lora_rank
506
    default_mm_loras: dict[str, str] | None = LoRAConfig.default_mm_loras
507
    fully_sharded_loras: bool = LoRAConfig.fully_sharded_loras
508
509
    max_cpu_loras: int | None = LoRAConfig.max_cpu_loras
    lora_dtype: str | torch.dtype | None = LoRAConfig.lora_dtype
510
    enable_tower_connector_lora: bool = LoRAConfig.enable_tower_connector_lora
511
    specialize_active_lora: bool = LoRAConfig.specialize_active_lora
512

513
    ray_workers_use_nsight: bool = ParallelConfig.ray_workers_use_nsight
514
    num_gpu_blocks_override: int | None = CacheConfig.num_gpu_blocks_override
515
    model_loader_extra_config: dict = get_field(LoadConfig, "model_loader_extra_config")
516
    ignore_patterns: str | list[str] = get_field(LoadConfig, "ignore_patterns")
517

518
    enable_chunked_prefill: bool | None = None
519
    disable_chunked_mm_input: bool = SchedulerConfig.disable_chunked_mm_input
520

521
    disable_hybrid_kv_cache_manager: bool | None = (
522
523
        SchedulerConfig.disable_hybrid_kv_cache_manager
    )
524

525
    structured_outputs_config: StructuredOutputsConfig = get_field(
526
527
        VllmConfig, "structured_outputs_config"
    )
528
    reasoning_parser: str = StructuredOutputsConfig.reasoning_parser
529
    reasoning_parser_plugin: str | None = None
530

531
    speculative_config: dict[str, Any] | None = None
532

533
    show_hidden_metrics_for_version: str | None = (
534
        ObservabilityConfig.show_hidden_metrics_for_version
535
    )
536
537
    otlp_traces_endpoint: str | None = ObservabilityConfig.otlp_traces_endpoint
    collect_detailed_traces: list[DetailedTraceModules] | None = (
538
        ObservabilityConfig.collect_detailed_traces
539
    )
540
541
542
543
    kv_cache_metrics: bool = ObservabilityConfig.kv_cache_metrics
    kv_cache_metrics_sample: float = get_field(
        ObservabilityConfig, "kv_cache_metrics_sample"
    )
544
    cudagraph_metrics: bool = ObservabilityConfig.cudagraph_metrics
545
546
547
    enable_layerwise_nvtx_tracing: bool = (
        ObservabilityConfig.enable_layerwise_nvtx_tracing
    )
548
    enable_mfu_metrics: bool = ObservabilityConfig.enable_mfu_metrics
549
550
551
    enable_logging_iteration_details: bool = (
        ObservabilityConfig.enable_logging_iteration_details
    )
552
    enable_mm_processor_stats: bool = ObservabilityConfig.enable_mm_processor_stats
553
    scheduling_policy: SchedulerPolicy = SchedulerConfig.policy
554
    scheduler_cls: str | type[object] | None = SchedulerConfig.scheduler_cls
555

556
    pooler_config: PoolerConfig | None = ModelConfig.pooler_config
557
    compilation_config: CompilationConfig = get_field(VllmConfig, "compilation_config")
558
    attention_config: AttentionConfig = get_field(VllmConfig, "attention_config")
559
560
561
562
    kernel_config: KernelConfig = get_field(VllmConfig, "kernel_config")
    enable_flashinfer_autotune: bool = get_field(
        KernelConfig, "enable_flashinfer_autotune"
    )
563
564
    worker_cls: str = ParallelConfig.worker_cls
    worker_extension_cls: str = ParallelConfig.worker_extension_cls
565

566
567
    profiler_config: ProfilerConfig = get_field(VllmConfig, "profiler_config")

568
569
    kv_transfer_config: KVTransferConfig | None = None
    kv_events_config: KVEventsConfig | None = None
570

571
572
    ec_transfer_config: ECTransferConfig | None = None

573
574
    generation_config: str = ModelConfig.generation_config
    enable_sleep_mode: bool = ModelConfig.enable_sleep_mode
575
576
577
    override_generation_config: dict[str, Any] = get_field(
        ModelConfig, "override_generation_config"
    )
578
    model_impl: str = ModelConfig.model_impl
579
    override_attention_dtype: str | None = ModelConfig.override_attention_dtype
580
    attention_backend: AttentionBackendEnum | None = AttentionConfig.backend
581

582
    calculate_kv_scales: bool = CacheConfig.calculate_kv_scales
583
584
    mamba_cache_dtype: MambaDType = CacheConfig.mamba_cache_dtype
    mamba_ssm_cache_dtype: MambaDType = CacheConfig.mamba_ssm_cache_dtype
585
    mamba_block_size: int | None = get_field(CacheConfig, "mamba_block_size")
586
    mamba_cache_mode: MambaCacheMode = CacheConfig.mamba_cache_mode
587

588
    additional_config: dict[str, Any] = get_field(VllmConfig, "additional_config")
589

590
    use_tqdm_on_load: bool = LoadConfig.use_tqdm_on_load
591
    pt_load_map_location: str | dict[str, str] = LoadConfig.pt_load_map_location
592

593
    logits_processors: list[str | type[LogitsProcessor]] | None = (
594
595
        ModelConfig.logits_processors
    )
596
597
    """Custom logitproc types"""

598
    async_scheduling: bool | None = SchedulerConfig.async_scheduling
599

600
601
    stream_interval: int = SchedulerConfig.stream_interval

602
    kv_sharing_fast_prefill: bool = CacheConfig.kv_sharing_fast_prefill
603
    optimization_level: OptimizationLevel = VllmConfig.optimization_level
604
    performance_mode: PerformanceMode = VllmConfig.performance_mode
605

606
    kv_offloading_size: float | None = CacheConfig.kv_offloading_size
607
    kv_offloading_backend: KVOffloadingBackend = CacheConfig.kv_offloading_backend
608
    tokens_only: bool = False
609

610
611
612
613
    weight_transfer_config: WeightTransferConfig | None = get_field(
        VllmConfig,
        "weight_transfer_config",
    )
614

615
616
    fail_on_environ_validation: bool = False

617
    def __post_init__(self):
618
619
620
        # support `EngineArgs(compilation_config={...})`
        # without having to manually construct a
        # CompilationConfig object
621
        if isinstance(self.compilation_config, dict):
622
            self.compilation_config = CompilationConfig(**self.compilation_config)
623
624
        if isinstance(self.attention_config, dict):
            self.attention_config = AttentionConfig(**self.attention_config)
625
626
        if isinstance(self.kernel_config, dict):
            self.kernel_config = KernelConfig(**self.kernel_config)
627
        if isinstance(self.eplb_config, dict):
628
            self.eplb_config = EPLBConfig(**self.eplb_config)
629
630
631
632
        if isinstance(self.weight_transfer_config, dict):
            self.weight_transfer_config = WeightTransferConfig(
                **self.weight_transfer_config
            )
633
        # Setup plugins
634
        from vllm.plugins import load_general_plugins
635

636
        load_general_plugins()
637
        # when use hf offline,replace model and tokenizer id to local model path
638
639
640
        if huggingface_hub.constants.HF_HUB_OFFLINE:
            model_id = self.model
            self.model = get_model_path(self.model, self.revision)
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
            if model_id is not self.model:
                logger.info(
                    "HF_HUB_OFFLINE is True, replace model_id [%s] to model_path [%s]",
                    model_id,
                    self.model,
                )
            if self.tokenizer is not None:
                tokenizer_id = self.tokenizer
                self.tokenizer = get_model_path(self.tokenizer, self.tokenizer_revision)
                if tokenizer_id is not self.tokenizer:
                    logger.info(
                        "HF_HUB_OFFLINE is True, replace tokenizer_id [%s] "
                        "to tokenizer_path [%s]",
                        tokenizer_id,
                        self.tokenizer,
                    )
657
658

    @staticmethod
659
    def add_cli_args(parser: FlexibleArgumentParser) -> FlexibleArgumentParser:
Woosuk Kwon's avatar
Woosuk Kwon committed
660
        """Shared CLI arguments for vLLM engine."""
661

662
        # Model arguments
663
664
665
666
667
        model_kwargs = get_kwargs(ModelConfig)
        model_group = parser.add_argument_group(
            title="ModelConfig",
            description=ModelConfig.__doc__,
        )
668
        if not ("serve" in sys.argv[1:] and "--help" in sys.argv[1:]):
669
            model_group.add_argument("--model", **model_kwargs["model"])
670
671
        model_group.add_argument("--runner", **model_kwargs["runner"])
        model_group.add_argument("--convert", **model_kwargs["convert"])
672
673
        model_group.add_argument("--tokenizer", **model_kwargs["tokenizer"])
        model_group.add_argument("--tokenizer-mode", **model_kwargs["tokenizer_mode"])
674
675
676
        model_group.add_argument(
            "--trust-remote-code", **model_kwargs["trust_remote_code"]
        )
677
678
        model_group.add_argument("--dtype", **model_kwargs["dtype"])
        model_group.add_argument("--seed", **model_kwargs["seed"])
679
        model_group.add_argument("--hf-config-path", **model_kwargs["hf_config_path"])
680
681
682
683
684
685
        model_group.add_argument(
            "--allowed-local-media-path", **model_kwargs["allowed_local_media_path"]
        )
        model_group.add_argument(
            "--allowed-media-domains", **model_kwargs["allowed_media_domains"]
        )
686
        model_group.add_argument("--revision", **model_kwargs["revision"])
687
        model_group.add_argument("--code-revision", **model_kwargs["code_revision"])
688
689
690
        model_group.add_argument(
            "--tokenizer-revision", **model_kwargs["tokenizer_revision"]
        )
691
692
        model_group.add_argument("--max-model-len", **model_kwargs["max_model_len"])
        model_group.add_argument("--quantization", "-q", **model_kwargs["quantization"])
693
694
695
696
        model_group.add_argument(
            "--allow-deprecated-quantization",
            **model_kwargs["allow_deprecated_quantization"],
        )
697
        model_group.add_argument("--enforce-eager", **model_kwargs["enforce_eager"])
698
699
700
701
        model_group.add_argument(
            "--enable-return-routed-experts",
            **model_kwargs["enable_return_routed_experts"],
        )
702
703
704
705
706
707
708
709
        model_group.add_argument("--max-logprobs", **model_kwargs["max_logprobs"])
        model_group.add_argument("--logprobs-mode", **model_kwargs["logprobs_mode"])
        model_group.add_argument(
            "--disable-sliding-window", **model_kwargs["disable_sliding_window"]
        )
        model_group.add_argument(
            "--disable-cascade-attn", **model_kwargs["disable_cascade_attn"]
        )
710
711
712
        model_group.add_argument(
            "--skip-tokenizer-init", **model_kwargs["skip_tokenizer_init"]
        )
713
714
715
716
717
718
719
        model_group.add_argument(
            "--enable-prompt-embeds", **model_kwargs["enable_prompt_embeds"]
        )
        model_group.add_argument(
            "--served-model-name", **model_kwargs["served_model_name"]
        )
        model_group.add_argument("--config-format", **model_kwargs["config_format"])
720
721
        # This one is a special case because it can bool
        # or str. TODO: Handle this in get_kwargs
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
        model_group.add_argument(
            "--hf-token",
            type=str,
            nargs="?",
            const=True,
            default=model_kwargs["hf_token"]["default"],
            help=model_kwargs["hf_token"]["help"],
        )
        model_group.add_argument("--hf-overrides", **model_kwargs["hf_overrides"])
        model_group.add_argument("--pooler-config", **model_kwargs["pooler_config"])
        model_group.add_argument(
            "--generation-config", **model_kwargs["generation_config"]
        )
        model_group.add_argument(
            "--override-generation-config", **model_kwargs["override_generation_config"]
        )
        model_group.add_argument(
            "--enable-sleep-mode", **model_kwargs["enable_sleep_mode"]
        )
741
        model_group.add_argument("--model-impl", **model_kwargs["model_impl"])
742
743
744
745
746
747
        model_group.add_argument(
            "--override-attention-dtype", **model_kwargs["override_attention_dtype"]
        )
        model_group.add_argument(
            "--logits-processors", **model_kwargs["logits_processors"]
        )
748
749
        model_group.add_argument(
            "--io-processor-plugin", **model_kwargs["io_processor_plugin"]
750
        )
751

752
753
754
755
756
757
        # Model loading arguments
        load_kwargs = get_kwargs(LoadConfig)
        load_group = parser.add_argument_group(
            title="LoadConfig",
            description=LoadConfig.__doc__,
        )
758
        load_group.add_argument("--load-format", **load_kwargs["load_format"])
759
760
761
762
763
764
765
766
767
768
769
770
        load_group.add_argument("--download-dir", **load_kwargs["download_dir"])
        load_group.add_argument(
            "--safetensors-load-strategy", **load_kwargs["safetensors_load_strategy"]
        )
        load_group.add_argument(
            "--model-loader-extra-config", **load_kwargs["model_loader_extra_config"]
        )
        load_group.add_argument("--ignore-patterns", **load_kwargs["ignore_patterns"])
        load_group.add_argument("--use-tqdm-on-load", **load_kwargs["use_tqdm_on_load"])
        load_group.add_argument(
            "--pt-load-map-location", **load_kwargs["pt_load_map_location"]
        )
771

772
773
774
775
776
777
778
779
780
781
        # Attention arguments
        attention_kwargs = get_kwargs(AttentionConfig)
        attention_group = parser.add_argument_group(
            title="AttentionConfig",
            description=AttentionConfig.__doc__,
        )
        attention_group.add_argument(
            "--attention-backend", **attention_kwargs["backend"]
        )

782
783
784
785
786
        # Structured outputs arguments
        structured_outputs_kwargs = get_kwargs(StructuredOutputsConfig)
        structured_outputs_group = parser.add_argument_group(
            title="StructuredOutputsConfig",
            description=StructuredOutputsConfig.__doc__,
787
        )
788
        structured_outputs_group.add_argument(
789
            "--reasoning-parser",
790
            # Choices need to be validated after parsing to include plugins
791
792
            **structured_outputs_kwargs["reasoning_parser"],
        )
793
794
795
796
        structured_outputs_group.add_argument(
            "--reasoning-parser-plugin",
            **structured_outputs_kwargs["reasoning_parser_plugin"],
        )
797

798
        # Parallel arguments
799
800
801
802
803
804
        parallel_kwargs = get_kwargs(ParallelConfig)
        parallel_group = parser.add_argument_group(
            title="ParallelConfig",
            description=ParallelConfig.__doc__,
        )
        parallel_group.add_argument(
805
            "--distributed-executor-backend",
806
807
            **parallel_kwargs["distributed_executor_backend"],
        )
808
        parallel_group.add_argument(
809
810
811
812
            "--pipeline-parallel-size",
            "-pp",
            **parallel_kwargs["pipeline_parallel_size"],
        )
813
814
815
816
        parallel_group.add_argument("--master-addr", **parallel_kwargs["master_addr"])
        parallel_group.add_argument("--master-port", **parallel_kwargs["master_port"])
        parallel_group.add_argument("--nnodes", "-n", **parallel_kwargs["nnodes"])
        parallel_group.add_argument("--node-rank", "-r", **parallel_kwargs["node_rank"])
817
        parallel_group.add_argument(
818
819
            "--tensor-parallel-size", "-tp", **parallel_kwargs["tensor_parallel_size"]
        )
820
        parallel_group.add_argument(
821
822
823
824
            "--decode-context-parallel-size",
            "-dcp",
            **parallel_kwargs["decode_context_parallel_size"],
        )
825
826
827
828
        parallel_group.add_argument(
            "--dcp-comm-backend",
            **parallel_kwargs["dcp_comm_backend"],
        )
829
830
831
832
        parallel_group.add_argument(
            "--dcp-kv-cache-interleave-size",
            **parallel_kwargs["dcp_kv_cache_interleave_size"],
        )
833
834
835
836
837
838
839
840
841
        parallel_group.add_argument(
            "--cp-kv-cache-interleave-size",
            **parallel_kwargs["cp_kv_cache_interleave_size"],
        )
        parallel_group.add_argument(
            "--prefill-context-parallel-size",
            "-pcp",
            **parallel_kwargs["prefill_context_parallel_size"],
        )
842
843
844
845
846
847
        parallel_group.add_argument(
            "--data-parallel-size", "-dp", **parallel_kwargs["data_parallel_size"]
        )
        parallel_group.add_argument(
            "--data-parallel-rank",
            "-dpn",
848
            type=int,
849
850
851
            help="Data parallel rank of this instance. "
            "When set, enables external load balancer mode.",
        )
852
        parallel_group.add_argument(
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
            "--data-parallel-start-rank",
            "-dpr",
            type=int,
            help="Starting data parallel rank for secondary nodes.",
        )
        parallel_group.add_argument(
            "--data-parallel-size-local",
            "-dpl",
            type=int,
            help="Number of data parallel replicas to run on this node.",
        )
        parallel_group.add_argument(
            "--data-parallel-address",
            "-dpa",
            type=str,
            help="Address of data parallel cluster head-node.",
        )
        parallel_group.add_argument(
            "--data-parallel-rpc-port",
            "-dpp",
            type=int,
            help="Port for data parallel RPC communication.",
        )
        parallel_group.add_argument(
            "--data-parallel-backend",
            "-dpb",
            type=str,
            default="mp",
            help='Backend for data parallel, either "mp" or "ray".',
        )
883
        parallel_group.add_argument(
884
885
886
887
888
889
890
891
            "--data-parallel-hybrid-lb",
            "-dph",
            **parallel_kwargs["data_parallel_hybrid_lb"],
        )
        parallel_group.add_argument(
            "--data-parallel-external-lb",
            "-dpe",
            **parallel_kwargs["data_parallel_external_lb"],
892
893
        )
        parallel_group.add_argument(
894
895
896
            "--enable-expert-parallel",
            "-ep",
            **parallel_kwargs["enable_expert_parallel"],
897
        )
898
899
900
        parallel_group.add_argument(
            "--all2all-backend", **parallel_kwargs["all2all_backend"]
        )
901
        parallel_group.add_argument("--enable-dbo", **parallel_kwargs["enable_dbo"])
902
903
904
905
        parallel_group.add_argument(
            "--ubatch-size",
            **parallel_kwargs["ubatch_size"],
        )
906
907
908
        parallel_group.add_argument(
            "--enable-elastic-ep", **parallel_kwargs["enable_elastic_ep"]
        )
909
910
        parallel_group.add_argument(
            "--dbo-decode-token-threshold",
911
912
            **parallel_kwargs["dbo_decode_token_threshold"],
        )
913
914
        parallel_group.add_argument(
            "--dbo-prefill-token-threshold",
915
916
            **parallel_kwargs["dbo_prefill_token_threshold"],
        )
917
918
919
920
        parallel_group.add_argument(
            "--disable-nccl-for-dp-synchronization",
            **parallel_kwargs["disable_nccl_for_dp_synchronization"],
        )
921
922
        parallel_group.add_argument("--enable-eplb", **parallel_kwargs["enable_eplb"])
        parallel_group.add_argument("--eplb-config", **parallel_kwargs["eplb_config"])
923
924
        parallel_group.add_argument(
            "--expert-placement-strategy",
925
926
            **parallel_kwargs["expert_placement_strategy"],
        )
927

928
        parallel_group.add_argument(
929
            "--max-parallel-loading-workers",
930
931
            **parallel_kwargs["max_parallel_loading_workers"],
        )
932
        parallel_group.add_argument(
933
934
            "--ray-workers-use-nsight", **parallel_kwargs["ray_workers_use_nsight"]
        )
935
        parallel_group.add_argument(
936
            "--disable-custom-all-reduce",
937
938
939
940
941
942
            **parallel_kwargs["disable_custom_all_reduce"],
        )
        parallel_group.add_argument("--worker-cls", **parallel_kwargs["worker_cls"])
        parallel_group.add_argument(
            "--worker-extension-cls", **parallel_kwargs["worker_extension_cls"]
        )
943

944
945
946
947
948
        # KV cache arguments
        cache_kwargs = get_kwargs(CacheConfig)
        cache_group = parser.add_argument_group(
            title="CacheConfig",
            description=CacheConfig.__doc__,
949
        )
950
        cache_group.add_argument("--block-size", **cache_kwargs["block_size"])
951
952
953
954
955
956
        cache_group.add_argument(
            "--gpu-memory-utilization", **cache_kwargs["gpu_memory_utilization"]
        )
        cache_group.add_argument(
            "--kv-cache-memory-bytes", **cache_kwargs["kv_cache_memory_bytes"]
        )
957
        cache_group.add_argument("--swap-space", **cache_kwargs["swap_space"])
958
959
960
961
962
        cache_group.add_argument("--kv-cache-dtype", **cache_kwargs["cache_dtype"])
        cache_group.add_argument(
            "--num-gpu-blocks-override", **cache_kwargs["num_gpu_blocks_override"]
        )
        cache_group.add_argument(
963
964
965
966
967
            "--enable-prefix-caching",
            **{
                **cache_kwargs["enable_prefix_caching"],
                "default": None,
            },
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
        )
        cache_group.add_argument(
            "--prefix-caching-hash-algo", **cache_kwargs["prefix_caching_hash_algo"]
        )
        cache_group.add_argument(
            "--calculate-kv-scales", **cache_kwargs["calculate_kv_scales"]
        )
        cache_group.add_argument(
            "--kv-sharing-fast-prefill", **cache_kwargs["kv_sharing_fast_prefill"]
        )
        cache_group.add_argument(
            "--mamba-cache-dtype", **cache_kwargs["mamba_cache_dtype"]
        )
        cache_group.add_argument(
            "--mamba-ssm-cache-dtype", **cache_kwargs["mamba_ssm_cache_dtype"]
        )
984
985
986
        cache_group.add_argument(
            "--mamba-block-size", **cache_kwargs["mamba_block_size"]
        )
987
988
989
        cache_group.add_argument(
            "--mamba-cache-mode", **cache_kwargs["mamba_cache_mode"]
        )
990
991
992
993
994
995
        cache_group.add_argument(
            "--kv-offloading-size", **cache_kwargs["kv_offloading_size"]
        )
        cache_group.add_argument(
            "--kv-offloading-backend", **cache_kwargs["kv_offloading_backend"]
        )
996

997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
        # Model weight offload related configs
        offload_kwargs = get_kwargs(OffloadConfig)
        uva_kwargs = get_kwargs(UVAOffloadConfig)
        prefetch_kwargs = get_kwargs(PrefetchOffloadConfig)
        offload_group = parser.add_argument_group(
            title="OffloadConfig",
            description=OffloadConfig.__doc__,
        )
        offload_group.add_argument(
            "--offload-backend", **offload_kwargs["offload_backend"]
        )
        offload_group.add_argument("--cpu-offload-gb", **uva_kwargs["cpu_offload_gb"])
        offload_group.add_argument(
            "--cpu-offload-params", **uva_kwargs["cpu_offload_params"]
        )
        offload_group.add_argument(
            "--offload-group-size",
            **prefetch_kwargs["offload_group_size"],
        )
        offload_group.add_argument(
            "--offload-num-in-group",
            **prefetch_kwargs["offload_num_in_group"],
        )
        offload_group.add_argument(
            "--offload-prefetch-step",
            **prefetch_kwargs["offload_prefetch_step"],
        )
        offload_group.add_argument(
            "--offload-params", **prefetch_kwargs["offload_params"]
        )

1028
        # Multimodal related configs
1029
1030
1031
1032
1033
        multimodal_kwargs = get_kwargs(MultiModalConfig)
        multimodal_group = parser.add_argument_group(
            title="MultiModalConfig",
            description=MultiModalConfig.__doc__,
        )
1034
1035
1036
        multimodal_group.add_argument(
            "--language-model-only", **multimodal_kwargs["language_model_only"]
        )
1037
        multimodal_group.add_argument(
1038
1039
            "--limit-mm-per-prompt", **multimodal_kwargs["limit_per_prompt"]
        )
1040
1041
1042
        multimodal_group.add_argument(
            "--enable-mm-embeds", **multimodal_kwargs["enable_mm_embeds"]
        )
1043
1044
1045
        multimodal_group.add_argument(
            "--media-io-kwargs", **multimodal_kwargs["media_io_kwargs"]
        )
1046
1047
1048
1049
1050
1051
        multimodal_group.add_argument(
            "--mm-processor-kwargs", **multimodal_kwargs["mm_processor_kwargs"]
        )
        multimodal_group.add_argument(
            "--mm-processor-cache-gb", **multimodal_kwargs["mm_processor_cache_gb"]
        )
1052
        multimodal_group.add_argument(
1053
1054
            "--mm-processor-cache-type", **multimodal_kwargs["mm_processor_cache_type"]
        )
1055
1056
        multimodal_group.add_argument(
            "--mm-shm-cache-max-object-size-mb",
1057
1058
            **multimodal_kwargs["mm_shm_cache_max_object_size_mb"],
        )
1059
1060
1061
        multimodal_group.add_argument(
            "--mm-encoder-only", **multimodal_kwargs["mm_encoder_only"]
        )
1062
        multimodal_group.add_argument(
1063
1064
            "--mm-encoder-tp-mode", **multimodal_kwargs["mm_encoder_tp_mode"]
        )
1065
1066
1067
1068
        multimodal_group.add_argument(
            "--mm-encoder-attn-backend",
            **multimodal_kwargs["mm_encoder_attn_backend"],
        )
1069
1070
1071
        multimodal_group.add_argument(
            "--interleave-mm-strings", **multimodal_kwargs["interleave_mm_strings"]
        )
1072
        multimodal_group.add_argument(
1073
1074
            "--skip-mm-profiling", **multimodal_kwargs["skip_mm_profiling"]
        )
1075

1076
        multimodal_group.add_argument(
1077
1078
            "--video-pruning-rate", **multimodal_kwargs["video_pruning_rate"]
        )
1079

1080
        # LoRA related configs
1081
1082
1083
1084
1085
1086
        lora_kwargs = get_kwargs(LoRAConfig)
        lora_group = parser.add_argument_group(
            title="LoRAConfig",
            description=LoRAConfig.__doc__,
        )
        lora_group.add_argument(
1087
            "--enable-lora",
1088
            action=argparse.BooleanOptionalAction,
1089
1090
            help="If True, enable handling of LoRA adapters.",
        )
1091
        lora_group.add_argument("--max-loras", **lora_kwargs["max_loras"])
1092
        lora_group.add_argument("--max-lora-rank", **lora_kwargs["max_lora_rank"])
1093
        lora_group.add_argument(
1094
            "--lora-dtype",
1095
1096
            **lora_kwargs["lora_dtype"],
        )
1097
1098
1099
1100
        lora_group.add_argument(
            "--enable-tower-connector-lora",
            **lora_kwargs["enable_tower_connector_lora"],
        )
1101
1102
1103
1104
1105
        lora_group.add_argument("--max-cpu-loras", **lora_kwargs["max_cpu_loras"])
        lora_group.add_argument(
            "--fully-sharded-loras", **lora_kwargs["fully_sharded_loras"]
        )
        lora_group.add_argument("--default-mm-loras", **lora_kwargs["default_mm_loras"])
1106
1107
1108
        lora_group.add_argument(
            "--specialize-active-lora", **lora_kwargs["specialize_active_lora"]
        )
1109

1110
1111
1112
1113
1114
1115
1116
1117
        # Observability arguments
        observability_kwargs = get_kwargs(ObservabilityConfig)
        observability_group = parser.add_argument_group(
            title="ObservabilityConfig",
            description=ObservabilityConfig.__doc__,
        )
        observability_group.add_argument(
            "--show-hidden-metrics-for-version",
1118
1119
            **observability_kwargs["show_hidden_metrics_for_version"],
        )
1120
        observability_group.add_argument(
1121
1122
            "--otlp-traces-endpoint", **observability_kwargs["otlp_traces_endpoint"]
        )
1123
1124
1125
1126
1127
        # TODO: generalise this special case
        choices = observability_kwargs["collect_detailed_traces"]["choices"]
        metavar = f"{{{','.join(choices)}}}"
        observability_kwargs["collect_detailed_traces"]["metavar"] = metavar
        observability_kwargs["collect_detailed_traces"]["choices"] += [
1128
            ",".join(p) for p in permutations(get_args(DetailedTraceModules), r=2)
1129
1130
1131
        ]
        observability_group.add_argument(
            "--collect-detailed-traces",
1132
1133
            **observability_kwargs["collect_detailed_traces"],
        )
1134
1135
1136
1137
1138
1139
1140
        observability_group.add_argument(
            "--kv-cache-metrics", **observability_kwargs["kv_cache_metrics"]
        )
        observability_group.add_argument(
            "--kv-cache-metrics-sample",
            **observability_kwargs["kv_cache_metrics_sample"],
        )
1141
1142
1143
1144
        observability_group.add_argument(
            "--cudagraph-metrics",
            **observability_kwargs["cudagraph_metrics"],
        )
1145
1146
1147
1148
        observability_group.add_argument(
            "--enable-layerwise-nvtx-tracing",
            **observability_kwargs["enable_layerwise_nvtx_tracing"],
        )
1149
1150
1151
1152
        observability_group.add_argument(
            "--enable-mfu-metrics",
            **observability_kwargs["enable_mfu_metrics"],
        )
1153
1154
1155
1156
        observability_group.add_argument(
            "--enable-logging-iteration-details",
            **observability_kwargs["enable_logging_iteration_details"],
        )
1157

1158
1159
1160
1161
1162
1163
1164
        # Scheduler arguments
        scheduler_kwargs = get_kwargs(SchedulerConfig)
        scheduler_group = parser.add_argument_group(
            title="SchedulerConfig",
            description=SchedulerConfig.__doc__,
        )
        scheduler_group.add_argument(
1165
1166
1167
1168
1169
            "--max-num-batched-tokens",
            **{
                **scheduler_kwargs["max_num_batched_tokens"],
                "default": None,
            },
1170
        )
1171
        scheduler_group.add_argument(
1172
1173
1174
1175
1176
            "--max-num-seqs",
            **{
                **scheduler_kwargs["max_num_seqs"],
                "default": None,
            },
1177
1178
1179
1180
        )
        scheduler_group.add_argument(
            "--max-num-partial-prefills", **scheduler_kwargs["max_num_partial_prefills"]
        )
1181
1182
        scheduler_group.add_argument(
            "--max-long-partial-prefills",
1183
1184
            **scheduler_kwargs["max_long_partial_prefills"],
        )
1185
1186
        scheduler_group.add_argument(
            "--long-prefill-token-threshold",
1187
1188
            **scheduler_kwargs["long_prefill_token_threshold"],
        )
1189
1190
        # multi-step scheduling has been removed; corresponding arguments
        # are no longer supported.
1191
        scheduler_group.add_argument(
1192
1193
            "--scheduling-policy", **scheduler_kwargs["policy"]
        )
1194
        scheduler_group.add_argument(
1195
1196
1197
1198
1199
            "--enable-chunked-prefill",
            **{
                **scheduler_kwargs["enable_chunked_prefill"],
                "default": None,
            },
1200
1201
1202
1203
1204
1205
1206
        )
        scheduler_group.add_argument(
            "--disable-chunked-mm-input", **scheduler_kwargs["disable_chunked_mm_input"]
        )
        scheduler_group.add_argument(
            "--scheduler-cls", **scheduler_kwargs["scheduler_cls"]
        )
1207
1208
        scheduler_group.add_argument(
            "--disable-hybrid-kv-cache-manager",
1209
1210
1211
1212
1213
            **scheduler_kwargs["disable_hybrid_kv_cache_manager"],
        )
        scheduler_group.add_argument(
            "--async-scheduling", **scheduler_kwargs["async_scheduling"]
        )
1214
1215
1216
        scheduler_group.add_argument(
            "--stream-interval", **scheduler_kwargs["stream_interval"]
        )
1217

1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
        # Compilation arguments
        compilation_kwargs = get_kwargs(CompilationConfig)
        compilation_group = parser.add_argument_group(
            title="CompilationConfig",
            description=CompilationConfig.__doc__,
        )
        compilation_group.add_argument(
            "--cudagraph-capture-sizes", **compilation_kwargs["cudagraph_capture_sizes"]
        )
        compilation_group.add_argument(
            "--max-cudagraph-capture-size",
            **compilation_kwargs["max_cudagraph_capture_size"],
        )

1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
        # Kernel arguments
        kernel_kwargs = get_kwargs(KernelConfig)
        kernel_group = parser.add_argument_group(
            title="KernelConfig",
            description=KernelConfig.__doc__,
        )
        kernel_group.add_argument(
            "--enable-flashinfer-autotune",
            **kernel_kwargs["enable_flashinfer_autotune"],
        )
1242
1243
1244
        moe_backend_kwargs = kernel_kwargs["moe_backend"]
        moe_backend_kwargs["type"] = lambda s: s.lower().replace("-", "_")
        kernel_group.add_argument("--moe-backend", **moe_backend_kwargs)
1245

1246
        # vLLM arguments
1247
        vllm_kwargs = get_kwargs(VllmConfig)
1248
1249
1250
1251
        vllm_group = parser.add_argument_group(
            title="VllmConfig",
            description=VllmConfig.__doc__,
        )
1252
1253
1254
1255
        # We construct SpeculativeConfig using fields from other configs in
        # create_engine_config. So we set the type to a JSON string here to
        # delay the Pydantic validation that comes with SpeculativeConfig.
        vllm_kwargs["speculative_config"]["type"] = optional_type(json.loads)
1256
1257
1258
1259
1260
1261
1262
        vllm_group.add_argument(
            "--speculative-config", **vllm_kwargs["speculative_config"]
        )
        vllm_group.add_argument(
            "--kv-transfer-config", **vllm_kwargs["kv_transfer_config"]
        )
        vllm_group.add_argument("--kv-events-config", **vllm_kwargs["kv_events_config"])
1263
1264
1265
        vllm_group.add_argument(
            "--ec-transfer-config", **vllm_kwargs["ec_transfer_config"]
        )
1266
        vllm_group.add_argument(
1267
            "--compilation-config", "-cc", **vllm_kwargs["compilation_config"]
1268
        )
1269
1270
1271
        vllm_group.add_argument(
            "--attention-config", "-ac", **vllm_kwargs["attention_config"]
        )
1272
        vllm_group.add_argument("--kernel-config", **vllm_kwargs["kernel_config"])
1273
1274
1275
1276
1277
1278
        vllm_group.add_argument(
            "--additional-config", **vllm_kwargs["additional_config"]
        )
        vllm_group.add_argument(
            "--structured-outputs-config", **vllm_kwargs["structured_outputs_config"]
        )
1279
        vllm_group.add_argument("--profiler-config", **vllm_kwargs["profiler_config"])
1280
1281
1282
        vllm_group.add_argument(
            "--optimization-level", **vllm_kwargs["optimization_level"]
        )
1283
        vllm_group.add_argument("--performance-mode", **vllm_kwargs["performance_mode"])
1284
1285
1286
        vllm_group.add_argument(
            "--weight-transfer-config", **vllm_kwargs["weight_transfer_config"]
        )
1287

1288
        # Other arguments
1289
1290
1291
1292
1293
        parser.add_argument(
            "--disable-log-stats",
            action="store_true",
            help="Disable logging statistics.",
        )
1294

1295
1296
1297
1298
1299
1300
        parser.add_argument(
            "--aggregate-engine-logging",
            action="store_true",
            help="Log aggregate rather than per-engine statistics "
            "when using data parallelism.",
        )
1301
1302
1303
1304
1305
1306
1307
1308

        parser.add_argument(
            "--fail-on-environ-validation",
            help="If set, the engine will raise an error if "
            "environment validation fails.",
            default=False,
            action=argparse.BooleanOptionalAction,
        )
1309
        return parser
1310
1311

    @classmethod
1312
    def from_cli_args(cls, args: argparse.Namespace):
1313
1314
1315
        # Get the list of attributes of this dataclass.
        attrs = [attr.name for attr in dataclasses.fields(cls)]
        # Set the attributes from the parsed arguments.
1316
1317
1318
        engine_args = cls(
            **{attr: getattr(args, attr) for attr in attrs if hasattr(args, attr)}
        )
Zhuohan Li's avatar
Zhuohan Li committed
1319
        return engine_args
1320

1321
    def create_model_config(self) -> ModelConfig:
1322
1323
        # gguf file needs a specific model loader
        if is_gguf(self.model):
1324
1325
            self.quantization = self.load_format = "gguf"

1326
1327
1328
1329
1330
1331
1332
        if not envs.VLLM_ENABLE_V1_MULTIPROCESSING:
            logger.warning(
                "The global random seed is set to %d. Since "
                "VLLM_ENABLE_V1_MULTIPROCESSING is set to False, this may "
                "affect the random state of the Python process that "
                "launched vLLM.",
                self.seed,
1333
1334
            )

1335
        return ModelConfig(
1336
            model=self.model,
1337
            model_weights=self.model_weights,
1338
            hf_config_path=self.hf_config_path,
1339
1340
            runner=self.runner,
            convert=self.convert,
1341
            tokenizer=self.tokenizer,  # type: ignore[arg-type]
1342
            tokenizer_mode=self.tokenizer_mode,
1343
            trust_remote_code=self.trust_remote_code,
1344
1345
            allowed_local_media_path=self.allowed_local_media_path,
            allowed_media_domains=self.allowed_media_domains,
1346
1347
1348
1349
            dtype=self.dtype,
            seed=self.seed,
            revision=self.revision,
            code_revision=self.code_revision,
1350
            hf_token=self.hf_token,
1351
            hf_overrides=self.hf_overrides,
1352
            tokenizer_revision=self.tokenizer_revision,
1353
1354
            max_model_len=self.max_model_len,
            quantization=self.quantization,
1355
            allow_deprecated_quantization=self.allow_deprecated_quantization,
1356
            enforce_eager=self.enforce_eager,
1357
            enable_return_routed_experts=self.enable_return_routed_experts,
1358
            max_logprobs=self.max_logprobs,
1359
            logprobs_mode=self.logprobs_mode,
1360
            disable_sliding_window=self.disable_sliding_window,
1361
            disable_cascade_attn=self.disable_cascade_attn,
1362
            skip_tokenizer_init=self.skip_tokenizer_init,
1363
            enable_prompt_embeds=self.enable_prompt_embeds,
1364
            served_model_name=self.served_model_name,
1365
            language_model_only=self.language_model_only,
1366
            limit_mm_per_prompt=self.limit_mm_per_prompt,
1367
            enable_mm_embeds=self.enable_mm_embeds,
1368
            interleave_mm_strings=self.interleave_mm_strings,
1369
            media_io_kwargs=self.media_io_kwargs,
1370
            skip_mm_profiling=self.skip_mm_profiling,
1371
            config_format=self.config_format,
1372
            mm_processor_kwargs=self.mm_processor_kwargs,
1373
            mm_processor_cache_gb=self.mm_processor_cache_gb,
1374
            mm_processor_cache_type=self.mm_processor_cache_type,
1375
            mm_shm_cache_max_object_size_mb=self.mm_shm_cache_max_object_size_mb,
1376
            mm_encoder_only=self.mm_encoder_only,
1377
            mm_encoder_tp_mode=self.mm_encoder_tp_mode,
1378
            mm_encoder_attn_backend=self.mm_encoder_attn_backend,
1379
            pooler_config=self.pooler_config,
1380
            generation_config=self.generation_config,
1381
            override_generation_config=self.override_generation_config,
1382
            enable_sleep_mode=self.enable_sleep_mode,
1383
            model_impl=self.model_impl,
1384
            override_attention_dtype=self.override_attention_dtype,
1385
            logits_processors=self.logits_processors,
1386
            video_pruning_rate=self.video_pruning_rate,
1387
            io_processor_plugin=self.io_processor_plugin,
1388
        )
1389

1390
    def validate_tensorizer_args(self):
1391
1392
        from vllm.model_executor.model_loader.tensorizer import TensorizerConfig

1393
1394
        for key in self.model_loader_extra_config:
            if key in TensorizerConfig._fields:
1395
1396
1397
                self.model_loader_extra_config["tensorizer_config"][key] = (
                    self.model_loader_extra_config[key]
                )
1398

1399
    def create_load_config(self) -> LoadConfig:
1400
1401
        if self.quantization == "bitsandbytes":
            self.load_format = "bitsandbytes"
1402

1403
1404
1405
        if self.load_format == "tensorizer":
            if hasattr(self.model_loader_extra_config, "to_serializable"):
                self.model_loader_extra_config = (
1406
1407
                    self.model_loader_extra_config.to_serializable()
                )
1408
            self.model_loader_extra_config["tensorizer_config"] = {}
1409
1410
1411
            self.model_loader_extra_config["tensorizer_config"]["tensorizer_dir"] = (
                self.model
            )
1412
            self.validate_tensorizer_args()
1413

1414
1415
1416
        return LoadConfig(
            load_format=self.load_format,
            download_dir=self.download_dir,
1417
            safetensors_load_strategy=self.safetensors_load_strategy,
1418
1419
            model_loader_extra_config=self.model_loader_extra_config,
            ignore_patterns=self.ignore_patterns,
1420
            use_tqdm_on_load=self.use_tqdm_on_load,
1421
            pt_load_map_location=self.pt_load_map_location,
1422
        )
1423

1424
1425
1426
1427
    def create_speculative_config(
        self,
        target_model_config: ModelConfig,
        target_parallel_config: ParallelConfig,
1428
    ) -> SpeculativeConfig | None:
1429
1430
1431
1432
1433
1434
        """Initializes and returns a SpeculativeConfig object based on
        `speculative_config`.

        This function utilizes `speculative_config` to create a
        SpeculativeConfig object. The `speculative_config` can either be
        provided as a JSON string input via CLI arguments or directly as a
1435
        dictionary from the engine.
1436
1437
        """
        if self.speculative_config is None:
1438
            return None
1439

1440
1441
1442
        # Note(Shangming): These parameters are not obtained from the cli arg
        # '--speculative-config' and must be passed in when creating the engine
        # config.
1443
1444
1445
1446
1447
1448
        self.speculative_config.update(
            {
                "target_model_config": target_model_config,
                "target_parallel_config": target_parallel_config,
            }
        )
1449
        return SpeculativeConfig(**self.speculative_config)
1450

1451
1452
    def create_engine_config(
        self,
1453
        usage_context: UsageContext | None = None,
1454
        headless: bool = False,
1455
1456
1457
1458
    ) -> VllmConfig:
        """
        Create the VllmConfig.

1459
        NOTE: If VllmConfig is incompatible, we raise an error.
1460
        """
1461
        current_platform.pre_register_and_update()
1462

1463
        device_config = DeviceConfig(device=cast(Device, current_platform.device_type))
1464

1465
1466
        envs.validate_environ(self.fail_on_environ_validation)

1467
1468
        # Check if the model is a speculator and override model/tokenizer/config
        # BEFORE creating ModelConfig, so the config is created with the target model
1469
1470
1471
1472
        # Skip speculator detection for cloud storage models (eg: S3, GCS) since
        # HuggingFace cannot load configs directly from S3 URLs. S3 models can still
        # use speculators with explicit --speculative-config.
        if not is_cloud_storage(self.model):
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
            (self.model, self.tokenizer, self.speculative_config) = (
                maybe_override_with_speculators(
                    model=self.model,
                    tokenizer=self.tokenizer,
                    revision=self.revision,
                    trust_remote_code=self.trust_remote_code,
                    vllm_speculative_config=self.speculative_config,
                )
            )

1483
        model_config = self.create_model_config()
1484
        self.model = model_config.model
1485
        self.model_weights = model_config.model_weights
1486
1487
        self.tokenizer = model_config.tokenizer

1488
        self._check_feature_supported()
1489
1490
1491
1492
        self._set_default_chunked_prefill_and_prefix_caching_args(model_config)
        self._set_default_max_num_seqs_and_batched_tokens_args(
            usage_context, model_config
        )
1493

1494
        sliding_window: int | None = None
1495
1496
1497
1498
1499
1500
        if not is_interleaved(model_config.hf_text_config):
            # Only set CacheConfig.sliding_window if the model is all sliding
            # window. Otherwise CacheConfig.sliding_window will override the
            # global layers in interleaved sliding window models.
            sliding_window = model_config.get_sliding_window()

1501
1502
1503
1504
1505
        # Resolve "auto" kv_cache_dtype to actual value from model config
        resolved_cache_dtype = resolve_kv_cache_dtype_string(
            self.kv_cache_dtype, model_config
        )

1506
1507
1508
1509
        assert self.enable_prefix_caching is not None, (
            "enable_prefix_caching must be set by this point"
        )

1510
        cache_config = CacheConfig(
1511
            block_size=self.block_size,
1512
            gpu_memory_utilization=self.gpu_memory_utilization,
1513
            kv_cache_memory_bytes=self.kv_cache_memory_bytes,
1514
            swap_space=self.swap_space,
1515
            cache_dtype=resolved_cache_dtype,  # type: ignore[arg-type]
1516
            is_attention_free=model_config.is_attention_free,
1517
            num_gpu_blocks_override=self.num_gpu_blocks_override,
1518
            sliding_window=sliding_window,
1519
            enable_prefix_caching=self.enable_prefix_caching,
1520
            prefix_caching_hash_algo=self.prefix_caching_hash_algo,
1521
            calculate_kv_scales=self.calculate_kv_scales,
1522
            kv_sharing_fast_prefill=self.kv_sharing_fast_prefill,
1523
1524
            mamba_cache_dtype=self.mamba_cache_dtype,
            mamba_ssm_cache_dtype=self.mamba_ssm_cache_dtype,
1525
            mamba_block_size=self.mamba_block_size,
1526
            mamba_cache_mode=self.mamba_cache_mode,
1527
1528
            kv_offloading_size=self.kv_offloading_size,
            kv_offloading_backend=self.kv_offloading_backend,
1529
        )
1530

1531
1532
1533
1534
1535
1536
        ray_runtime_env = None
        if is_ray_initialized():
            # Ray Serve LLM calls `create_engine_config` in the context
            # of a Ray task, therefore we check is_ray_initialized()
            # as opposed to is_in_ray_actor().
            import ray
1537

1538
            ray_runtime_env = ray.get_runtime_context().runtime_env
1539
1540
1541
1542
1543
1544
1545
            # Avoid logging sensitive environment variables
            sanitized_env = ray_runtime_env.to_dict() if ray_runtime_env else {}
            if "env_vars" in sanitized_env:
                sanitized_env["env_vars"] = {
                    k: "***" for k in sanitized_env["env_vars"]
                }
            logger.info("Using ray runtime env (env vars redacted): %s", sanitized_env)
1546

1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
        # Get the current placement group if Ray is initialized and
        # we are in a Ray actor. If so, then the placement group will be
        # passed to spawned processes.
        placement_group = None
        if is_in_ray_actor():
            import ray

            # This call initializes Ray automatically if it is not initialized,
            # but we should not do this here.
            placement_group = ray.util.get_current_placement_group()

1558
        assert not headless or not self.data_parallel_hybrid_lb, (
1559
1560
            "data_parallel_hybrid_lb is not applicable in headless mode"
        )
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
        assert not (self.data_parallel_hybrid_lb and self.data_parallel_external_lb), (
            "data_parallel_hybrid_lb and data_parallel_external_lb cannot both be True."
        )
        assert self.data_parallel_backend == "mp" or self.nnodes == 1, (
            "nnodes > 1 is only supported with data_parallel_backend=mp"
        )
        inferred_data_parallel_rank = 0
        if self.nnodes > 1:
            world_size = (
                self.data_parallel_size
                * self.pipeline_parallel_size
                * self.tensor_parallel_size
            )
            world_size_within_dp = (
                self.pipeline_parallel_size * self.tensor_parallel_size
            )
            local_world_size = world_size // self.nnodes
            assert world_size % self.nnodes == 0, (
                f"world_size={world_size} must be divisible by nnodes={self.nnodes}."
            )
            assert self.node_rank < self.nnodes, (
                f"node_rank={self.node_rank} must be less than nnodes={self.nnodes}."
            )
            inferred_data_parallel_rank = (
                self.node_rank * local_world_size
            ) // world_size_within_dp
            if self.data_parallel_size > 1 and self.data_parallel_external_lb:
                self.data_parallel_rank = inferred_data_parallel_rank
                logger.info(
                    "Inferred data_parallel_rank %d from node_rank %d for external lb",
                    self.data_parallel_rank,
                    self.node_rank,
                )
            elif self.data_parallel_size_local is None:
                # Infer data parallel size local for internal dplb:
                self.data_parallel_size_local = max(
                    local_world_size // world_size_within_dp, 1
                )
        data_parallel_external_lb = (
            self.data_parallel_external_lb or self.data_parallel_rank is not None
        )
1602
        # Local DP rank = 1, use pure-external LB.
1603
        if data_parallel_external_lb:
1604
            assert self.data_parallel_rank is not None, (
1605
                "data_parallel_rank or node_rank must be specified if "
1606
1607
                "data_parallel_external_lb is enable."
            )
1608
            assert self.data_parallel_size_local in (1, None), (
1609
1610
                "data_parallel_size_local must be 1 or None when data_parallel_rank "
                "is set"
1611
            )
1612
            data_parallel_size_local = 1
1613
1614
            # Use full external lb if we have local_size of 1.
            self.data_parallel_hybrid_lb = False
1615
1616
        elif self.data_parallel_size_local is not None:
            data_parallel_size_local = self.data_parallel_size_local
1617
1618
1619
1620
1621
1622
1623

            if self.data_parallel_start_rank and not headless:
                # Infer hybrid LB mode.
                self.data_parallel_hybrid_lb = True

            if self.data_parallel_hybrid_lb and data_parallel_size_local == 1:
                # Use full external lb if we have local_size of 1.
1624
1625
1626
1627
1628
                logger.warning(
                    "data_parallel_hybrid_lb is not eligible when "
                    "data_parallel_size_local = 1, autoswitch to "
                    "data_parallel_external_lb."
                )
1629
1630
1631
1632
1633
1634
1635
                data_parallel_external_lb = True
                self.data_parallel_hybrid_lb = False

            if data_parallel_size_local == self.data_parallel_size:
                # Disable hybrid LB mode if set for a single node
                self.data_parallel_hybrid_lb = False

1636
1637
1638
1639
1640
1641
1642
1643
1644
            self.data_parallel_rank = (
                self.data_parallel_start_rank or inferred_data_parallel_rank
            )
            if self.nnodes > 1:
                logger.info(
                    "Inferred data_parallel_rank %d from node_rank %d",
                    self.data_parallel_rank,
                    self.node_rank,
                )
1645
        else:
1646
            assert not self.data_parallel_hybrid_lb, (
1647
1648
                "data_parallel_size_local must be set to use data_parallel_hybrid_lb."
            )
1649

1650
1651
1652
1653
1654
1655
1656
1657
1658
            if self.data_parallel_backend == "ray" and (
                envs.VLLM_RAY_DP_PACK_STRATEGY == "span"
            ):
                # Data parallel size defaults to 1 if DP ranks are spanning
                # multiple nodes
                data_parallel_size_local = 1
            else:
                # Otherwise local DP size defaults to global DP size if not set
                data_parallel_size_local = self.data_parallel_size
1659
1660
1661

        # DP address, used in multi-node case for torch distributed group
        # and ZMQ sockets.
Rui Qiao's avatar
Rui Qiao committed
1662
1663
1664
1665
        if self.data_parallel_address is None:
            if self.data_parallel_backend == "ray":
                host_ip = get_ip()
                logger.info(
1666
1667
                    "Using host IP %s as ray-based data parallel address", host_ip
                )
Rui Qiao's avatar
Rui Qiao committed
1668
1669
1670
1671
                data_parallel_address = host_ip
            else:
                assert self.data_parallel_backend == "mp", (
                    "data_parallel_backend can only be ray or mp, got %s",
1672
1673
                    self.data_parallel_backend,
                )
1674
1675
1676
                data_parallel_address = (
                    self.master_addr or ParallelConfig.data_parallel_master_ip
                )
Rui Qiao's avatar
Rui Qiao committed
1677
1678
        else:
            data_parallel_address = self.data_parallel_address
1679
1680
1681

        # This port is only used when there are remote data parallel engines,
        # otherwise the local IPC transport is used.
1682
        data_parallel_rpc_port = (
1683
            self.data_parallel_rpc_port
1684
1685
1686
            if (self.data_parallel_rpc_port is not None)
            else ParallelConfig.data_parallel_rpc_port
        )
1687

1688
1689
1690
1691
        if self.tokens_only and not model_config.skip_tokenizer_init:
            model_config.skip_tokenizer_init = True
            logger.info("Skipping tokenizer initialization for tokens-only mode.")

1692
        parallel_config = ParallelConfig(
1693
1694
            pipeline_parallel_size=self.pipeline_parallel_size,
            tensor_parallel_size=self.tensor_parallel_size,
1695
            prefill_context_parallel_size=self.prefill_context_parallel_size,
1696
            data_parallel_size=self.data_parallel_size,
1697
1698
            data_parallel_rank=self.data_parallel_rank or 0,
            data_parallel_external_lb=data_parallel_external_lb,
1699
            data_parallel_size_local=data_parallel_size_local,
1700
1701
1702
1703
            master_addr=self.master_addr,
            master_port=self.master_port,
            nnodes=self.nnodes,
            node_rank=self.node_rank,
1704
1705
            data_parallel_master_ip=data_parallel_address,
            data_parallel_rpc_port=data_parallel_rpc_port,
1706
            data_parallel_backend=self.data_parallel_backend,
1707
            data_parallel_hybrid_lb=self.data_parallel_hybrid_lb,
1708
            is_moe_model=model_config.is_moe,
1709
            enable_expert_parallel=self.enable_expert_parallel,
1710
            all2all_backend=self.all2all_backend,
1711
            enable_elastic_ep=self.enable_elastic_ep,
1712
            enable_dbo=self.enable_dbo,
1713
            ubatch_size=self.ubatch_size,
1714
            dbo_decode_token_threshold=self.dbo_decode_token_threshold,
1715
            dbo_prefill_token_threshold=self.dbo_prefill_token_threshold,
1716
            disable_nccl_for_dp_synchronization=self.disable_nccl_for_dp_synchronization,
1717
            enable_eplb=self.enable_eplb,
1718
            eplb_config=self.eplb_config,
1719
            expert_placement_strategy=self.expert_placement_strategy,
1720
1721
1722
            max_parallel_loading_workers=self.max_parallel_loading_workers,
            disable_custom_all_reduce=self.disable_custom_all_reduce,
            ray_workers_use_nsight=self.ray_workers_use_nsight,
1723
            ray_runtime_env=ray_runtime_env,
1724
            placement_group=placement_group,
1725
1726
            distributed_executor_backend=self.distributed_executor_backend,
            worker_cls=self.worker_cls,
1727
            worker_extension_cls=self.worker_extension_cls,
1728
            decode_context_parallel_size=self.decode_context_parallel_size,
1729
            dcp_comm_backend=self.dcp_comm_backend,
1730
            dcp_kv_cache_interleave_size=self.dcp_kv_cache_interleave_size,
1731
            cp_kv_cache_interleave_size=self.cp_kv_cache_interleave_size,
1732
1733
            _api_process_count=self._api_process_count,
            _api_process_rank=self._api_process_rank,
1734
        )
1735

1736
        speculative_config = self.create_speculative_config(
1737
1738
1739
1740
            target_model_config=model_config,
            target_parallel_config=parallel_config,
        )

1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
        assert self.max_num_batched_tokens is not None, (
            "max_num_batched_tokens must be set by this point"
        )
        assert self.max_num_seqs is not None, "max_num_seqs must be set by this point"
        assert self.enable_chunked_prefill is not None, (
            "enable_chunked_prefill must be set by this point"
        )
        assert model_config.max_model_len is not None, (
            "max_model_len must be set by this point"
        )
1751
        scheduler_config = SchedulerConfig(
1752
            runner_type=model_config.runner_type,
1753
1754
1755
            max_num_batched_tokens=self.max_num_batched_tokens,
            max_num_seqs=self.max_num_seqs,
            max_model_len=model_config.max_model_len,
1756
            enable_chunked_prefill=self.enable_chunked_prefill,
1757
            disable_chunked_mm_input=self.disable_chunked_mm_input,
1758
            is_multimodal_model=model_config.is_multimodal_model,
1759
            is_encoder_decoder=model_config.is_encoder_decoder,
1760
            policy=self.scheduling_policy,
1761
            scheduler_cls=self.scheduler_cls,
1762
1763
1764
            max_num_partial_prefills=self.max_num_partial_prefills,
            max_long_partial_prefills=self.max_long_partial_prefills,
            long_prefill_token_threshold=self.long_prefill_token_threshold,
1765
            disable_hybrid_kv_cache_manager=self.disable_hybrid_kv_cache_manager,
1766
            async_scheduling=self.async_scheduling,
1767
            stream_interval=self.stream_interval,
1768
        )
1769

1770
1771
1772
        if not model_config.is_multimodal_model and self.default_mm_loras:
            raise ValueError(
                "Default modality-specific LoRA(s) were provided for a "
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
                "non multimodal model"
            )

        lora_config = (
            LoRAConfig(
                max_lora_rank=self.max_lora_rank,
                max_loras=self.max_loras,
                default_mm_loras=self.default_mm_loras,
                fully_sharded_loras=self.fully_sharded_loras,
                lora_dtype=self.lora_dtype,
1783
                enable_tower_connector_lora=self.enable_tower_connector_lora,
1784
                specialize_active_lora=self.specialize_active_lora,
1785
1786
1787
1788
1789
1790
1791
                max_cpu_loras=self.max_cpu_loras
                if self.max_cpu_loras and self.max_cpu_loras > 0
                else None,
            )
            if self.enable_lora
            else None
        )
1792

1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
        if (
            lora_config is not None
            and speculative_config is not None
            and scheduler_config.max_num_batched_tokens
            < (
                scheduler_config.max_num_seqs
                * (speculative_config.num_speculative_tokens + 1)
            )
        ):
            raise ValueError(
                "Consider increasing max_num_batched_tokens or "
                "decreasing num_speculative_tokens"
            )

1807
1808
1809
1810
        # bitsandbytes pre-quantized model need a specific model loader
        if model_config.quantization == "bitsandbytes":
            self.quantization = self.load_format = "bitsandbytes"

1811
1812
1813
1814
1815
1816
1817
1818
        # Attention config overrides
        attention_config = copy.deepcopy(self.attention_config)
        if self.attention_backend is not None:
            if attention_config.backend is not None:
                raise ValueError(
                    "attention_backend and attention_config.backend "
                    "are mutually exclusive"
                )
1819
1820
1821
1822
1823
1824
1825
            # Convert string to enum if needed (CLI parsing returns a string)
            if isinstance(self.attention_backend, str):
                attention_config.backend = AttentionBackendEnum[
                    self.attention_backend.upper()
                ]
            else:
                attention_config.backend = self.attention_backend
1826

1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
        # Kernel config overrides
        kernel_config = copy.deepcopy(self.kernel_config)
        if self.enable_flashinfer_autotune is not None:
            if kernel_config.enable_flashinfer_autotune is not None:
                raise ValueError(
                    "enable_flashinfer_autotune and "
                    "kernel_config.enable_flashinfer_autotune "
                    "are mutually exclusive"
                )
            kernel_config.enable_flashinfer_autotune = self.enable_flashinfer_autotune
1837
1838
        if self.moe_backend != "auto":
            kernel_config.moe_backend = self.moe_backend
1839

1840
        load_config = self.create_load_config()
1841

1842
1843
        # Pass reasoning_parser into StructuredOutputsConfig
        if self.reasoning_parser:
1844
            self.structured_outputs_config.reasoning_parser = self.reasoning_parser
1845

1846
1847
1848
1849
1850
        if self.reasoning_parser_plugin:
            self.structured_outputs_config.reasoning_parser_plugin = (
                self.reasoning_parser_plugin
            )

1851
        observability_config = ObservabilityConfig(
1852
            show_hidden_metrics_for_version=self.show_hidden_metrics_for_version,
1853
            otlp_traces_endpoint=self.otlp_traces_endpoint,
1854
            collect_detailed_traces=self.collect_detailed_traces,
1855
1856
            kv_cache_metrics=self.kv_cache_metrics,
            kv_cache_metrics_sample=self.kv_cache_metrics_sample,
1857
            cudagraph_metrics=self.cudagraph_metrics,
1858
            enable_layerwise_nvtx_tracing=self.enable_layerwise_nvtx_tracing,
1859
            enable_mfu_metrics=self.enable_mfu_metrics,
1860
            enable_mm_processor_stats=self.enable_mm_processor_stats,
1861
            enable_logging_iteration_details=self.enable_logging_iteration_details,
1862
        )
1863

1864
        # Compilation config overrides
1865
        compilation_config = copy.deepcopy(self.compilation_config)
1866
        if self.cudagraph_capture_sizes is not None:
1867
            if compilation_config.cudagraph_capture_sizes is not None:
1868
1869
1870
1871
                raise ValueError(
                    "cudagraph_capture_sizes and compilation_config."
                    "cudagraph_capture_sizes are mutually exclusive"
                )
1872
            compilation_config.cudagraph_capture_sizes = self.cudagraph_capture_sizes
1873
        if self.max_cudagraph_capture_size is not None:
1874
            if compilation_config.max_cudagraph_capture_size is not None:
1875
1876
1877
1878
                raise ValueError(
                    "max_cudagraph_capture_size and compilation_config."
                    "max_cudagraph_capture_size are mutually exclusive"
                )
1879
            compilation_config.max_cudagraph_capture_size = (
1880
1881
                self.max_cudagraph_capture_size
            )
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896

        offload_config = OffloadConfig(
            offload_backend=self.offload_backend,
            uva=UVAOffloadConfig(
                cpu_offload_gb=self.cpu_offload_gb,
                cpu_offload_params=self.cpu_offload_params,
            ),
            prefetch=PrefetchOffloadConfig(
                offload_group_size=self.offload_group_size,
                offload_num_in_group=self.offload_num_in_group,
                offload_prefetch_step=self.offload_prefetch_step,
                offload_params=self.offload_params,
            ),
        )

1897
        config = VllmConfig(
1898
1899
1900
1901
1902
            model_config=model_config,
            cache_config=cache_config,
            parallel_config=parallel_config,
            scheduler_config=scheduler_config,
            device_config=device_config,
1903
            load_config=load_config,
1904
            offload_config=offload_config,
1905
            attention_config=attention_config,
1906
            kernel_config=kernel_config,
1907
1908
            lora_config=lora_config,
            speculative_config=speculative_config,
1909
            structured_outputs_config=self.structured_outputs_config,
1910
            observability_config=observability_config,
1911
            compilation_config=compilation_config,
1912
            kv_transfer_config=self.kv_transfer_config,
1913
            kv_events_config=self.kv_events_config,
1914
            ec_transfer_config=self.ec_transfer_config,
1915
            profiler_config=self.profiler_config,
1916
            additional_config=self.additional_config,
1917
            optimization_level=self.optimization_level,
1918
            performance_mode=self.performance_mode,
1919
            weight_transfer_config=self.weight_transfer_config,
1920
        )
1921

1922
1923
        return config

1924
    def _check_feature_supported(self):
1925
        """Raise an error if the feature is not supported."""
1926
        # No Concurrent Partial Prefills so far.
1927
1928
1929
1930
1931
        if (
            self.max_num_partial_prefills != SchedulerConfig.max_num_partial_prefills
            or self.max_long_partial_prefills
            != SchedulerConfig.max_long_partial_prefills
        ):
1932
            _raise_unsupported_error(feature_name="Concurrent Partial Prefill")
1933

1934
        if self.pipeline_parallel_size > 1:
1935
1936
1937
            supports_pp = getattr(
                self.distributed_executor_backend, "supports_pp", False
            )
1938
            if not supports_pp and self.distributed_executor_backend not in (
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
                ParallelConfig.distributed_executor_backend,
                "ray",
                "mp",
                "external_launcher",
            ):
                name = (
                    "Pipeline Parallelism without Ray distributed "
                    "executor or multiprocessing executor or external "
                    "launcher"
                )
1949
                _raise_unsupported_error(feature_name=name)
1950

1951
1952
1953
1954
1955
1956
    @classmethod
    def get_batch_defaults(
        cls,
        world_size: int,
    ) -> tuple[dict[UsageContext | None, int], dict[UsageContext | None, int]]:
        from vllm.usage.usage_lib import UsageContext
1957

1958
1959
        default_max_num_batched_tokens: dict[UsageContext | None, int]
        default_max_num_seqs: dict[UsageContext | None, int]
1960

1961
1962
        # When no user override, set the default values based on the usage
        # context.
1963
        # Use different default values for different hardware.
1964
1965
1966
1967
1968
1969
1970

        # Try to query the device name on the current platform. If it fails,
        # it may be because the platform that imports vLLM is not the same
        # as the platform that vLLM is running on (e.g. the case of scaling
        # vLLM with Ray) and has no GPUs. In this case we use the default
        # values for non-H100/H200 GPUs.
        try:
1971
            device_memory = current_platform.get_device_total_memory()
1972
            device_name = current_platform.get_device_name().lower()
1973
1974
        except Exception:
            # This is only used to set default_max_num_batched_tokens
1975
            device_memory = 0
1976
            device_name = ""
1977

1978
1979
1980
1981
        # NOTE(Kuntai): Setting large `max_num_batched_tokens` for A100 reduces
        # throughput, see PR #17885 for more details.
        # So here we do an extra device name check to prevent such regression.
        if device_memory >= 70 * GiB_bytes and "a100" not in device_name:
1982
            # For GPUs like H100 and MI300x, use larger default values.
1983
1984
1985
1986
            default_max_num_batched_tokens = {
                UsageContext.LLM_CLASS: 16384,
                UsageContext.OPENAI_API_SERVER: 8192,
            }
1987
1988
1989
1990
            default_max_num_seqs = {
                UsageContext.LLM_CLASS: 1024,
                UsageContext.OPENAI_API_SERVER: 1024,
            }
1991
1992
1993
1994
1995
1996
        else:
            # TODO(woosuk): Tune the default values for other hardware.
            default_max_num_batched_tokens = {
                UsageContext.LLM_CLASS: 8192,
                UsageContext.OPENAI_API_SERVER: 2048,
            }
1997
1998
1999
2000
            default_max_num_seqs = {
                UsageContext.LLM_CLASS: 256,
                UsageContext.OPENAI_API_SERVER: 256,
            }
2001

2002
2003
        # tpu specific default values.
        if current_platform.is_tpu():
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
            chip_name = current_platform.get_device_name()

            if chip_name == "V6E":
                default_max_num_batched_tokens = {
                    UsageContext.LLM_CLASS: 2048,
                    UsageContext.OPENAI_API_SERVER: 1024,
                }
            elif chip_name == "V5E":
                default_max_num_batched_tokens = {
                    UsageContext.LLM_CLASS: 1024,
                    UsageContext.OPENAI_API_SERVER: 512,
                }
            elif chip_name == "V5P":
                default_max_num_batched_tokens = {
                    UsageContext.LLM_CLASS: 512,
                    UsageContext.OPENAI_API_SERVER: 256,
                }
2021

2022
2023
2024
        # cpu specific default values.
        if current_platform.is_cpu():
            default_max_num_batched_tokens = {
2025
2026
                UsageContext.LLM_CLASS: 4096 * world_size,
                UsageContext.OPENAI_API_SERVER: 2048 * world_size,
2027
2028
            }
            default_max_num_seqs = {
2029
2030
                UsageContext.LLM_CLASS: 256 * world_size,
                UsageContext.OPENAI_API_SERVER: 128 * world_size,
2031
2032
            }

2033
2034
        return default_max_num_batched_tokens, default_max_num_seqs

2035
2036
    def _set_default_chunked_prefill_and_prefix_caching_args(
        self, model_config: ModelConfig
2037
    ) -> None:
2038
2039
        default_chunked_prefill = model_config.is_chunked_prefill_supported
        default_prefix_caching = model_config.is_prefix_caching_supported
2040
2041
2042
2043
2044
2045
2046
2047

        if self.enable_chunked_prefill is None:
            self.enable_chunked_prefill = default_chunked_prefill

            logger.debug(
                "%s chunked prefill by default",
                "Enabling" if default_chunked_prefill else "Disabling",
            )
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
        elif (
            model_config.runner_type == "generate"
            and not self.enable_chunked_prefill
            and default_chunked_prefill
        ):
            logger.warning_once(
                "This model does not officially support disabling chunked prefill. "
                "Disabling this manually may cause the engine to crash "
                "or produce incorrect outputs.",
                scope="local",
            )
2059
2060
2061
2062
        elif (
            model_config.runner_type == "pooling"
            and self.enable_chunked_prefill
            and not default_chunked_prefill
2063
        ):
2064
            logger.warning_once(
2065
2066
2067
                "This model does not officially support chunked prefill. "
                "Enabling this manually may cause the engine to crash "
                "or produce incorrect outputs.",
2068
                scope="local",
2069
2070
2071
2072
2073
            )

        if self.enable_prefix_caching is None:
            self.enable_prefix_caching = default_prefix_caching

2074
            logger.debug(
2075
2076
2077
2078
2079
2080
2081
2082
                "%s prefix caching by default",
                "Enabling" if default_prefix_caching else "Disabling",
            )
        elif (
            model_config.runner_type == "pooling"
            and self.enable_prefix_caching
            and not default_prefix_caching
        ):
2083
            logger.warning_once(
2084
2085
2086
                "This model does not officially support prefix caching. "
                "Enabling this manually may cause the engine to crash "
                "or produce incorrect outputs.",
2087
                scope="local",
2088
2089
            )

2090
        # Disable chunked prefill and prefix caching for:
2091
        # RISCV CPUs in V1
2092
2093
2094
2095
        if current_platform.is_cpu() and current_platform.get_cpu_architecture() in (
            CpuArchEnum.RISCV,
        ):
            logger.info(
2096
2097
                "Chunked prefill is not supported for"
                "RISC-V CPUs; "
2098
2099
2100
2101
                "disabling it for V1 backend."
            )
            self.enable_chunked_prefill = False
            logger.info(
2102
2103
                "Prefix caching is not supported for "
                "RISC-V CPUs; "
2104
2105
2106
2107
2108
                "disabling it for V1 backend."
            )
            self.enable_prefix_caching = False

    def _set_default_max_num_seqs_and_batched_tokens_args(
2109
2110
2111
        self,
        usage_context: UsageContext | None,
        model_config: ModelConfig,
2112
    ):
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
        world_size = self.pipeline_parallel_size * self.tensor_parallel_size
        (
            default_max_num_batched_tokens,
            default_max_num_seqs,
        ) = self.get_batch_defaults(world_size)

        orig_max_num_batched_tokens = self.max_num_batched_tokens
        orig_max_num_seqs = self.max_num_seqs

        if self.max_num_batched_tokens is None:
            self.max_num_batched_tokens = default_max_num_batched_tokens.get(
                usage_context,
                SchedulerConfig.DEFAULT_MAX_NUM_BATCHED_TOKENS,
            )

        if self.max_num_seqs is None:
            self.max_num_seqs = default_max_num_seqs.get(
                usage_context,
                SchedulerConfig.DEFAULT_MAX_NUM_SEQS,
            )

2134
2135
2136
2137
2138
2139
2140
        # If throughput mode is set, double max_num_batched_tokens and max_num_seqs.
        if self.performance_mode == "throughput":
            if orig_max_num_batched_tokens is None:
                self.max_num_batched_tokens *= 2
            if orig_max_num_seqs is None:
                self.max_num_seqs *= 2

2141
        if orig_max_num_batched_tokens is None:
2142
2143
2144
            assert model_config.max_model_len is not None, (
                "max_model_len must be set by this point"
            )
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
            if not self.enable_chunked_prefill:
                # If max_model_len is too short, use the default for higher throughput.
                self.max_num_batched_tokens = max(
                    model_config.max_model_len,
                    self.max_num_batched_tokens,
                )

            # When using default settings,
            # Ensure max_num_batched_tokens does not exceed model limit.
            # Some models (e.g., Whisper) have embeddings tied to max length.
            self.max_num_batched_tokens = min(
                self.max_num_seqs * model_config.max_model_len,
2157
2158
                self.max_num_batched_tokens,
            )
2159

2160
2161
2162
2163
            logger.debug(
                "Defaulting max_num_batched_tokens to %d for %s usage context.",
                self.max_num_batched_tokens,
                usage_context.value if usage_context else None,
2164
            )
2165

2166
2167
2168
2169
        if orig_max_num_seqs is None:
            assert self.max_num_batched_tokens is not None  # For type checking
            self.max_num_seqs = min(self.max_num_seqs, self.max_num_batched_tokens)

2170
            logger.debug(
2171
                "Defaulting max_num_seqs to %d for %s usage context.",
2172
                self.max_num_seqs,
2173
                usage_context.value if usage_context else None,
2174
            )
2175

2176

2177
@dataclass
Zhuohan Li's avatar
Zhuohan Li committed
2178
class AsyncEngineArgs(EngineArgs):
Woosuk Kwon's avatar
Woosuk Kwon committed
2179
    """Arguments for asynchronous vLLM engine."""
2180

2181
2182
    enable_log_requests: bool = False

2183
    @staticmethod
2184
2185
2186
    def add_cli_args(
        parser: FlexibleArgumentParser, async_args_only: bool = False
    ) -> FlexibleArgumentParser:
2187
        # Initialize plugin to update the parser, for example, The plugin may
2188
        # add a new kind of quantization method to --quantization argument or
2189
2190
        # a new device to --device argument.
        load_general_plugins()
2191
2192
        if not async_args_only:
            parser = EngineArgs.add_cli_args(parser)
2193
2194
2195
2196
        parser.add_argument(
            "--enable-log-requests",
            action=argparse.BooleanOptionalAction,
            default=AsyncEngineArgs.enable_log_requests,
2197
2198
2199
2200
            help="Enable logging request information, dependant on log level:\n"
            "- INFO: Request ID, parameters and LoRA request.\n"
            "- DEBUG: Prompt inputs (e.g: text, token IDs).\n"
            "You can set the minimum log level via `VLLM_LOGGING_LEVEL`.",
2201
        )
2202
        current_platform.pre_register_and_update(parser)
2203
        return parser
2204
2205


2206
2207
2208
2209
2210
2211
def _raise_unsupported_error(feature_name: str):
    msg = (
        f"{feature_name} is not supported. We recommend to "
        f"remove {feature_name} from your config."
    )
    raise NotImplementedError(msg)
2212
2213


2214
def human_readable_int(value: str) -> int:
2215
2216
    """Parse human-readable integers like '1k', '2M', etc.
    Including decimal values with decimal multipliers.
2217

2218
2219
2220
2221
2222
2223
    Examples:
    - '1k' -> 1,000
    - '1K' -> 1,024
    - '25.6k' -> 25,600
    """
    value = value.strip()
2224

2225
    match = re.fullmatch(r"(\d+(?:\.\d+)?)([kKmMgGtT])", value)
2226
2227
    if match:
        decimal_multiplier = {
2228
2229
2230
            "k": 10**3,
            "m": 10**6,
            "g": 10**9,
2231
            "t": 10**12,
2232
2233
        }
        binary_multiplier = {
2234
2235
2236
            "K": 2**10,
            "M": 2**20,
            "G": 2**30,
2237
            "T": 2**40,
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
        }

        number, suffix = match.groups()
        if suffix in decimal_multiplier:
            mult = decimal_multiplier[suffix]
            return int(float(number) * mult)
        elif suffix in binary_multiplier:
            mult = binary_multiplier[suffix]
            # Do not allow decimals with binary multipliers
            try:
                return int(number) * mult
            except ValueError as e:
2250
2251
2252
2253
2254
                raise argparse.ArgumentTypeError(
                    "Decimals are not allowed "
                    f"with binary suffixes like {suffix}. Did you mean to use "
                    f"{number}{suffix.lower()} instead?"
                ) from e
2255
2256
2257

    # Regular plain number.
    return int(value)
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276


def human_readable_int_or_auto(value: str) -> int:
    """Parse human-readable integers like '1k', '2M', etc.
    Including decimal values with decimal multipliers.
    Also accepts -1 or 'auto' as a special value for auto-detection.

    Examples:
    - '1k' -> 1,000
    - '1K' -> 1,024
    - '25.6k' -> 25,600
    - '-1' or 'auto' -> -1 (special value for auto-detection)
    """
    value = value.strip()

    if value == "-1" or value.lower() == "auto":
        return -1

    return human_readable_int(value)