arg_utils.py 92.5 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
88
89
90
from vllm.config.parallel import (
    All2AllBackend,
    DataParallelBackend,
    DistributedExecutorBackend,
    ExpertPlacementStrategy,
)
91
from vllm.config.scheduler import SchedulerPolicy
92
from vllm.config.utils import get_field
93
from vllm.config.vllm import OptimizationLevel, PerformanceMode
94
from vllm.logger import init_logger, suppress_logging
95
from vllm.platforms import CpuArchEnum, current_platform
96
from vllm.plugins import load_general_plugins
97
from vllm.ray.lazy_utils import is_in_ray_actor, is_ray_initialized
98
99
100
101
from vllm.transformers_utils.config import (
    is_interleaved,
    maybe_override_with_speculators,
)
102
from vllm.transformers_utils.gguf_utils import is_gguf
103
from vllm.transformers_utils.repo_utils import get_model_path
104
from vllm.transformers_utils.utils import is_cloud_storage
105
from vllm.utils.argparse_utils import FlexibleArgumentParser
106
from vllm.utils.mem_constants import GiB_bytes
107
from vllm.utils.network_utils import get_ip
108
from vllm.utils.torch_utils import resolve_kv_cache_dtype_string
109
from vllm.v1.attention.backends.registry import AttentionBackendEnum
110
from vllm.v1.sample.logits_processor import LogitsProcessor
111

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

123

124
125
logger = init_logger(__name__)

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

131

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

141
142
143
    return _parse_type


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

150
    return _optional_type
151
152


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


159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
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)


174
def literal_to_kwargs(type_hints: set[TypeHint]) -> dict[str, Any]:
175
176
177
178
    """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`.
    """
179
    type_hint = get_type(type_hints, Literal)
180
181
182
    options = get_args(type_hint)
    option_type = type(options[0])
    if not all(isinstance(option, option_type) for option in options):
183
        raise ValueError(
184
            "All options must be of the same type. "
185
186
            f"Got {options} with types {[type(c) for c in options]}"
        )
187
188
    kwarg = "metavar" if contains_type(type_hints, str) else "choices"
    return {"type": option_type, kwarg: sorted(options)}
189
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
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),
    }


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


221
222
223
224
225
226
227
228
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]))
229
230
    elif origin in {Union, UnionType}:
        # Union for Union[X, Y] and UnionType for X | Y
231
232
233
234
235
236
237
238
        for arg in args:
            type_hints.update(get_type_hints(arg))
    else:
        type_hints.add(type_hint)

    return type_hints


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


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

        # 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)

259
        # Get the default value of the field
260
261
        if field.default is not MISSING:
            default = field.default
262
263
            # Handle pydantic.Field defaults
            if isinstance(default, FieldInfo):
264
265
266
267
268
269
                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():
270
                        default = default.default_factory()  # type: ignore[call-arg]
271
        elif field.default_factory is not MISSING:
272
            default = field.default_factory()
273
274
275

        # Get the help text for the field
        name = field.name
276
        help = cls_docs.get(name, "").strip()
277
278
279
280
281
282
283
        # 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
284
285
286
        json_tip = (
            "Should either be a valid JSON string or JSON keys passed individually."
        )
287
        if dataclass_cls is not None:
288
289
290
291
292
293
294
295

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

334
335
336
337
338
        # 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"]}))

339
340
341
342
343
344
345
        # 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
346
347


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

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

354
355
356
357
358
359
360
    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))


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

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

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

515
    enable_chunked_prefill: bool | None = None
516
    disable_chunked_mm_input: bool = SchedulerConfig.disable_chunked_mm_input
517

518
    disable_hybrid_kv_cache_manager: bool | None = (
519
520
        SchedulerConfig.disable_hybrid_kv_cache_manager
    )
521

522
    structured_outputs_config: StructuredOutputsConfig = get_field(
523
524
        VllmConfig, "structured_outputs_config"
    )
525
    reasoning_parser: str = StructuredOutputsConfig.reasoning_parser
526
    reasoning_parser_plugin: str | None = None
527

528
    speculative_config: dict[str, Any] | None = None
529

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

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

563
564
    profiler_config: ProfilerConfig = get_field(VllmConfig, "profiler_config")

565
566
    kv_transfer_config: KVTransferConfig | None = None
    kv_events_config: KVEventsConfig | None = None
567

568
569
    ec_transfer_config: ECTransferConfig | None = None

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

579
    calculate_kv_scales: bool = CacheConfig.calculate_kv_scales
580
581
    mamba_cache_dtype: MambaDType = CacheConfig.mamba_cache_dtype
    mamba_ssm_cache_dtype: MambaDType = CacheConfig.mamba_ssm_cache_dtype
582
    mamba_block_size: int | None = get_field(CacheConfig, "mamba_block_size")
583
    mamba_cache_mode: MambaCacheMode = CacheConfig.mamba_cache_mode
584

585
    additional_config: dict[str, Any] = get_field(VllmConfig, "additional_config")
586

587
    use_tqdm_on_load: bool = LoadConfig.use_tqdm_on_load
588
    pt_load_map_location: str | dict[str, str] = LoadConfig.pt_load_map_location
589

590
    logits_processors: list[str | type[LogitsProcessor]] | None = (
591
592
        ModelConfig.logits_processors
    )
593
594
    """Custom logitproc types"""

595
    async_scheduling: bool | None = SchedulerConfig.async_scheduling
596

597
598
    stream_interval: int = SchedulerConfig.stream_interval

599
    kv_sharing_fast_prefill: bool = CacheConfig.kv_sharing_fast_prefill
600
    optimization_level: OptimizationLevel = VllmConfig.optimization_level
601
    performance_mode: PerformanceMode = VllmConfig.performance_mode
602

603
    kv_offloading_size: float | None = CacheConfig.kv_offloading_size
604
    kv_offloading_backend: KVOffloadingBackend = CacheConfig.kv_offloading_backend
605
    tokens_only: bool = False
606

607
608
609
610
    weight_transfer_config: WeightTransferConfig | None = get_field(
        VllmConfig,
        "weight_transfer_config",
    )
611

612
613
    fail_on_environ_validation: bool = False

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

633
        load_general_plugins()
634
        # when use hf offline,replace model and tokenizer id to local model path
635
636
637
        if huggingface_hub.constants.HF_HUB_OFFLINE:
            model_id = self.model
            self.model = get_model_path(self.model, self.revision)
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
            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,
                    )
654
655

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

659
        # Model arguments
660
661
662
663
664
        model_kwargs = get_kwargs(ModelConfig)
        model_group = parser.add_argument_group(
            title="ModelConfig",
            description=ModelConfig.__doc__,
        )
665
        if not ("serve" in sys.argv[1:] and "--help" in sys.argv[1:]):
666
            model_group.add_argument("--model", **model_kwargs["model"])
667
668
        model_group.add_argument("--runner", **model_kwargs["runner"])
        model_group.add_argument("--convert", **model_kwargs["convert"])
669
670
        model_group.add_argument("--tokenizer", **model_kwargs["tokenizer"])
        model_group.add_argument("--tokenizer-mode", **model_kwargs["tokenizer_mode"])
671
672
673
        model_group.add_argument(
            "--trust-remote-code", **model_kwargs["trust_remote_code"]
        )
674
675
        model_group.add_argument("--dtype", **model_kwargs["dtype"])
        model_group.add_argument("--seed", **model_kwargs["seed"])
676
        model_group.add_argument("--hf-config-path", **model_kwargs["hf_config_path"])
677
678
679
680
681
682
        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"]
        )
683
        model_group.add_argument("--revision", **model_kwargs["revision"])
684
        model_group.add_argument("--code-revision", **model_kwargs["code_revision"])
685
686
687
        model_group.add_argument(
            "--tokenizer-revision", **model_kwargs["tokenizer_revision"]
        )
688
689
        model_group.add_argument("--max-model-len", **model_kwargs["max_model_len"])
        model_group.add_argument("--quantization", "-q", **model_kwargs["quantization"])
690
691
692
693
        model_group.add_argument(
            "--allow-deprecated-quantization",
            **model_kwargs["allow_deprecated_quantization"],
        )
694
        model_group.add_argument("--enforce-eager", **model_kwargs["enforce_eager"])
695
696
697
698
        model_group.add_argument(
            "--enable-return-routed-experts",
            **model_kwargs["enable_return_routed_experts"],
        )
699
700
701
702
703
704
705
706
        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"]
        )
707
708
709
        model_group.add_argument(
            "--skip-tokenizer-init", **model_kwargs["skip_tokenizer_init"]
        )
710
711
712
713
714
715
716
        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"])
717
718
        # This one is a special case because it can bool
        # or str. TODO: Handle this in get_kwargs
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
        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"]
        )
738
        model_group.add_argument("--model-impl", **model_kwargs["model_impl"])
739
740
741
742
743
744
        model_group.add_argument(
            "--override-attention-dtype", **model_kwargs["override_attention_dtype"]
        )
        model_group.add_argument(
            "--logits-processors", **model_kwargs["logits_processors"]
        )
745
746
        model_group.add_argument(
            "--io-processor-plugin", **model_kwargs["io_processor_plugin"]
747
        )
748

749
750
751
752
753
754
        # Model loading arguments
        load_kwargs = get_kwargs(LoadConfig)
        load_group = parser.add_argument_group(
            title="LoadConfig",
            description=LoadConfig.__doc__,
        )
755
        load_group.add_argument("--load-format", **load_kwargs["load_format"])
756
757
758
759
760
761
762
763
764
765
766
767
        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"]
        )
768

769
770
771
772
773
774
775
776
777
778
        # 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"]
        )

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

795
        # Parallel arguments
796
797
798
799
800
801
        parallel_kwargs = get_kwargs(ParallelConfig)
        parallel_group = parser.add_argument_group(
            title="ParallelConfig",
            description=ParallelConfig.__doc__,
        )
        parallel_group.add_argument(
802
            "--distributed-executor-backend",
803
804
            **parallel_kwargs["distributed_executor_backend"],
        )
805
        parallel_group.add_argument(
806
807
808
809
            "--pipeline-parallel-size",
            "-pp",
            **parallel_kwargs["pipeline_parallel_size"],
        )
810
811
812
813
        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"])
814
        parallel_group.add_argument(
815
816
            "--tensor-parallel-size", "-tp", **parallel_kwargs["tensor_parallel_size"]
        )
817
        parallel_group.add_argument(
818
819
820
821
            "--decode-context-parallel-size",
            "-dcp",
            **parallel_kwargs["decode_context_parallel_size"],
        )
822
823
824
825
        parallel_group.add_argument(
            "--dcp-kv-cache-interleave-size",
            **parallel_kwargs["dcp_kv_cache_interleave_size"],
        )
826
827
828
829
830
831
832
833
834
        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"],
        )
835
836
837
838
839
840
        parallel_group.add_argument(
            "--data-parallel-size", "-dp", **parallel_kwargs["data_parallel_size"]
        )
        parallel_group.add_argument(
            "--data-parallel-rank",
            "-dpn",
841
            type=int,
842
843
844
            help="Data parallel rank of this instance. "
            "When set, enables external load balancer mode.",
        )
845
        parallel_group.add_argument(
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
            "--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".',
        )
876
        parallel_group.add_argument(
877
878
879
880
881
882
883
884
            "--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"],
885
886
        )
        parallel_group.add_argument(
887
888
889
            "--enable-expert-parallel",
            "-ep",
            **parallel_kwargs["enable_expert_parallel"],
890
        )
891
892
893
        parallel_group.add_argument(
            "--all2all-backend", **parallel_kwargs["all2all_backend"]
        )
894
        parallel_group.add_argument("--enable-dbo", **parallel_kwargs["enable_dbo"])
895
896
897
898
        parallel_group.add_argument(
            "--ubatch-size",
            **parallel_kwargs["ubatch_size"],
        )
899
900
        parallel_group.add_argument(
            "--dbo-decode-token-threshold",
901
902
            **parallel_kwargs["dbo_decode_token_threshold"],
        )
903
904
        parallel_group.add_argument(
            "--dbo-prefill-token-threshold",
905
906
            **parallel_kwargs["dbo_prefill_token_threshold"],
        )
907
908
909
910
        parallel_group.add_argument(
            "--disable-nccl-for-dp-synchronization",
            **parallel_kwargs["disable_nccl_for_dp_synchronization"],
        )
911
912
        parallel_group.add_argument("--enable-eplb", **parallel_kwargs["enable_eplb"])
        parallel_group.add_argument("--eplb-config", **parallel_kwargs["eplb_config"])
913
914
        parallel_group.add_argument(
            "--expert-placement-strategy",
915
916
            **parallel_kwargs["expert_placement_strategy"],
        )
917

918
        parallel_group.add_argument(
919
            "--max-parallel-loading-workers",
920
921
            **parallel_kwargs["max_parallel_loading_workers"],
        )
922
        parallel_group.add_argument(
923
924
            "--ray-workers-use-nsight", **parallel_kwargs["ray_workers_use_nsight"]
        )
925
        parallel_group.add_argument(
926
            "--disable-custom-all-reduce",
927
928
929
930
931
932
            **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"]
        )
933

934
935
936
937
938
        # KV cache arguments
        cache_kwargs = get_kwargs(CacheConfig)
        cache_group = parser.add_argument_group(
            title="CacheConfig",
            description=CacheConfig.__doc__,
939
        )
940
        cache_group.add_argument("--block-size", **cache_kwargs["block_size"])
941
942
943
944
945
946
        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"]
        )
947
        cache_group.add_argument("--swap-space", **cache_kwargs["swap_space"])
948
949
950
951
952
        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(
953
954
955
956
957
            "--enable-prefix-caching",
            **{
                **cache_kwargs["enable_prefix_caching"],
                "default": None,
            },
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
        )
        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"]
        )
974
975
976
        cache_group.add_argument(
            "--mamba-block-size", **cache_kwargs["mamba_block_size"]
        )
977
978
979
        cache_group.add_argument(
            "--mamba-cache-mode", **cache_kwargs["mamba_cache_mode"]
        )
980
981
982
983
984
985
        cache_group.add_argument(
            "--kv-offloading-size", **cache_kwargs["kv_offloading_size"]
        )
        cache_group.add_argument(
            "--kv-offloading-backend", **cache_kwargs["kv_offloading_backend"]
        )
986

987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
        # 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"]
        )

1018
        # Multimodal related configs
1019
1020
1021
1022
1023
        multimodal_kwargs = get_kwargs(MultiModalConfig)
        multimodal_group = parser.add_argument_group(
            title="MultiModalConfig",
            description=MultiModalConfig.__doc__,
        )
1024
1025
1026
        multimodal_group.add_argument(
            "--language-model-only", **multimodal_kwargs["language_model_only"]
        )
1027
        multimodal_group.add_argument(
1028
1029
            "--limit-mm-per-prompt", **multimodal_kwargs["limit_per_prompt"]
        )
1030
1031
1032
        multimodal_group.add_argument(
            "--enable-mm-embeds", **multimodal_kwargs["enable_mm_embeds"]
        )
1033
1034
1035
        multimodal_group.add_argument(
            "--media-io-kwargs", **multimodal_kwargs["media_io_kwargs"]
        )
1036
1037
1038
1039
1040
1041
        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"]
        )
1042
        multimodal_group.add_argument(
1043
1044
            "--mm-processor-cache-type", **multimodal_kwargs["mm_processor_cache_type"]
        )
1045
1046
        multimodal_group.add_argument(
            "--mm-shm-cache-max-object-size-mb",
1047
1048
            **multimodal_kwargs["mm_shm_cache_max_object_size_mb"],
        )
1049
1050
1051
        multimodal_group.add_argument(
            "--mm-encoder-only", **multimodal_kwargs["mm_encoder_only"]
        )
1052
        multimodal_group.add_argument(
1053
1054
            "--mm-encoder-tp-mode", **multimodal_kwargs["mm_encoder_tp_mode"]
        )
1055
1056
1057
1058
        multimodal_group.add_argument(
            "--mm-encoder-attn-backend",
            **multimodal_kwargs["mm_encoder_attn_backend"],
        )
1059
1060
1061
        multimodal_group.add_argument(
            "--interleave-mm-strings", **multimodal_kwargs["interleave_mm_strings"]
        )
1062
        multimodal_group.add_argument(
1063
1064
            "--skip-mm-profiling", **multimodal_kwargs["skip_mm_profiling"]
        )
1065

1066
        multimodal_group.add_argument(
1067
1068
            "--video-pruning-rate", **multimodal_kwargs["video_pruning_rate"]
        )
1069

1070
        # LoRA related configs
1071
1072
1073
1074
1075
1076
        lora_kwargs = get_kwargs(LoRAConfig)
        lora_group = parser.add_argument_group(
            title="LoRAConfig",
            description=LoRAConfig.__doc__,
        )
        lora_group.add_argument(
1077
            "--enable-lora",
1078
            action=argparse.BooleanOptionalAction,
1079
1080
            help="If True, enable handling of LoRA adapters.",
        )
1081
        lora_group.add_argument("--max-loras", **lora_kwargs["max_loras"])
1082
        lora_group.add_argument("--max-lora-rank", **lora_kwargs["max_lora_rank"])
1083
        lora_group.add_argument(
1084
            "--lora-dtype",
1085
1086
            **lora_kwargs["lora_dtype"],
        )
1087
1088
1089
1090
        lora_group.add_argument(
            "--enable-tower-connector-lora",
            **lora_kwargs["enable_tower_connector_lora"],
        )
1091
1092
1093
1094
1095
        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"])
1096
1097
1098
        lora_group.add_argument(
            "--specialize-active-lora", **lora_kwargs["specialize_active_lora"]
        )
1099

1100
1101
1102
1103
1104
1105
1106
1107
        # 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",
1108
1109
            **observability_kwargs["show_hidden_metrics_for_version"],
        )
1110
        observability_group.add_argument(
1111
1112
            "--otlp-traces-endpoint", **observability_kwargs["otlp_traces_endpoint"]
        )
1113
1114
1115
1116
1117
        # 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"] += [
1118
            ",".join(p) for p in permutations(get_args(DetailedTraceModules), r=2)
1119
1120
1121
        ]
        observability_group.add_argument(
            "--collect-detailed-traces",
1122
1123
            **observability_kwargs["collect_detailed_traces"],
        )
1124
1125
1126
1127
1128
1129
1130
        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"],
        )
1131
1132
1133
1134
        observability_group.add_argument(
            "--cudagraph-metrics",
            **observability_kwargs["cudagraph_metrics"],
        )
1135
1136
1137
1138
        observability_group.add_argument(
            "--enable-layerwise-nvtx-tracing",
            **observability_kwargs["enable_layerwise_nvtx_tracing"],
        )
1139
1140
1141
1142
        observability_group.add_argument(
            "--enable-mfu-metrics",
            **observability_kwargs["enable_mfu_metrics"],
        )
1143
1144
1145
1146
        observability_group.add_argument(
            "--enable-logging-iteration-details",
            **observability_kwargs["enable_logging_iteration_details"],
        )
1147

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

1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
        # 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"],
        )

1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
        # 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"],
        )
1232
1233
1234
        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)
1235

1236
        # vLLM arguments
1237
        vllm_kwargs = get_kwargs(VllmConfig)
1238
1239
1240
1241
        vllm_group = parser.add_argument_group(
            title="VllmConfig",
            description=VllmConfig.__doc__,
        )
1242
1243
1244
1245
        # 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)
1246
1247
1248
1249
1250
1251
1252
        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"])
1253
1254
1255
        vllm_group.add_argument(
            "--ec-transfer-config", **vllm_kwargs["ec_transfer_config"]
        )
1256
        vllm_group.add_argument(
1257
            "--compilation-config", "-cc", **vllm_kwargs["compilation_config"]
1258
        )
1259
1260
1261
        vllm_group.add_argument(
            "--attention-config", "-ac", **vllm_kwargs["attention_config"]
        )
1262
        vllm_group.add_argument("--kernel-config", **vllm_kwargs["kernel_config"])
1263
1264
1265
1266
1267
1268
        vllm_group.add_argument(
            "--additional-config", **vllm_kwargs["additional_config"]
        )
        vllm_group.add_argument(
            "--structured-outputs-config", **vllm_kwargs["structured_outputs_config"]
        )
1269
        vllm_group.add_argument("--profiler-config", **vllm_kwargs["profiler_config"])
1270
1271
1272
        vllm_group.add_argument(
            "--optimization-level", **vllm_kwargs["optimization_level"]
        )
1273
        vllm_group.add_argument("--performance-mode", **vllm_kwargs["performance_mode"])
1274
1275
1276
        vllm_group.add_argument(
            "--weight-transfer-config", **vllm_kwargs["weight_transfer_config"]
        )
1277

1278
        # Other arguments
1279
1280
1281
1282
1283
        parser.add_argument(
            "--disable-log-stats",
            action="store_true",
            help="Disable logging statistics.",
        )
1284

1285
1286
1287
1288
1289
1290
        parser.add_argument(
            "--aggregate-engine-logging",
            action="store_true",
            help="Log aggregate rather than per-engine statistics "
            "when using data parallelism.",
        )
1291
1292
1293
1294
1295
1296
1297
1298

        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,
        )
1299
        return parser
1300
1301

    @classmethod
1302
    def from_cli_args(cls, args: argparse.Namespace):
1303
1304
1305
        # Get the list of attributes of this dataclass.
        attrs = [attr.name for attr in dataclasses.fields(cls)]
        # Set the attributes from the parsed arguments.
1306
1307
1308
        engine_args = cls(
            **{attr: getattr(args, attr) for attr in attrs if hasattr(args, attr)}
        )
Zhuohan Li's avatar
Zhuohan Li committed
1309
        return engine_args
1310

1311
    def create_model_config(self) -> ModelConfig:
1312
1313
        # gguf file needs a specific model loader
        if is_gguf(self.model):
1314
1315
            self.quantization = self.load_format = "gguf"

1316
1317
1318
1319
1320
1321
1322
        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,
1323
1324
            )

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

1380
    def validate_tensorizer_args(self):
1381
1382
        from vllm.model_executor.model_loader.tensorizer import TensorizerConfig

1383
1384
        for key in self.model_loader_extra_config:
            if key in TensorizerConfig._fields:
1385
1386
1387
                self.model_loader_extra_config["tensorizer_config"][key] = (
                    self.model_loader_extra_config[key]
                )
1388

1389
    def create_load_config(self) -> LoadConfig:
1390
1391
        if self.quantization == "bitsandbytes":
            self.load_format = "bitsandbytes"
1392

1393
1394
1395
        if self.load_format == "tensorizer":
            if hasattr(self.model_loader_extra_config, "to_serializable"):
                self.model_loader_extra_config = (
1396
1397
                    self.model_loader_extra_config.to_serializable()
                )
1398
            self.model_loader_extra_config["tensorizer_config"] = {}
1399
1400
1401
            self.model_loader_extra_config["tensorizer_config"]["tensorizer_dir"] = (
                self.model
            )
1402
            self.validate_tensorizer_args()
1403

1404
1405
1406
        return LoadConfig(
            load_format=self.load_format,
            download_dir=self.download_dir,
1407
            safetensors_load_strategy=self.safetensors_load_strategy,
1408
1409
            model_loader_extra_config=self.model_loader_extra_config,
            ignore_patterns=self.ignore_patterns,
1410
            use_tqdm_on_load=self.use_tqdm_on_load,
1411
            pt_load_map_location=self.pt_load_map_location,
1412
        )
1413

1414
1415
1416
1417
    def create_speculative_config(
        self,
        target_model_config: ModelConfig,
        target_parallel_config: ParallelConfig,
1418
    ) -> SpeculativeConfig | None:
1419
1420
1421
1422
1423
1424
        """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
1425
        dictionary from the engine.
1426
1427
        """
        if self.speculative_config is None:
1428
            return None
1429

1430
1431
1432
        # Note(Shangming): These parameters are not obtained from the cli arg
        # '--speculative-config' and must be passed in when creating the engine
        # config.
1433
1434
1435
1436
1437
1438
        self.speculative_config.update(
            {
                "target_model_config": target_model_config,
                "target_parallel_config": target_parallel_config,
            }
        )
1439
        return SpeculativeConfig(**self.speculative_config)
1440

1441
1442
    def create_engine_config(
        self,
1443
        usage_context: UsageContext | None = None,
1444
        headless: bool = False,
1445
1446
1447
1448
    ) -> VllmConfig:
        """
        Create the VllmConfig.

1449
        NOTE: If VllmConfig is incompatible, we raise an error.
1450
        """
1451
        current_platform.pre_register_and_update()
1452

1453
        device_config = DeviceConfig(device=cast(Device, current_platform.device_type))
1454

1455
1456
        envs.validate_environ(self.fail_on_environ_validation)

1457
1458
        # Check if the model is a speculator and override model/tokenizer/config
        # BEFORE creating ModelConfig, so the config is created with the target model
1459
1460
1461
1462
        # 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):
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
            (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,
                )
            )

1473
        model_config = self.create_model_config()
1474
        self.model = model_config.model
1475
        self.model_weights = model_config.model_weights
1476
1477
        self.tokenizer = model_config.tokenizer

1478
        self._check_feature_supported()
1479
1480
1481
1482
        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
        )
1483

1484
        sliding_window: int | None = None
1485
1486
1487
1488
1489
1490
        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()

1491
1492
1493
1494
1495
        # 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
        )

1496
1497
1498
1499
        assert self.enable_prefix_caching is not None, (
            "enable_prefix_caching must be set by this point"
        )

1500
        cache_config = CacheConfig(
1501
            block_size=self.block_size,
1502
            gpu_memory_utilization=self.gpu_memory_utilization,
1503
            kv_cache_memory_bytes=self.kv_cache_memory_bytes,
1504
            swap_space=self.swap_space,
1505
            cache_dtype=resolved_cache_dtype,  # type: ignore[arg-type]
1506
            is_attention_free=model_config.is_attention_free,
1507
            num_gpu_blocks_override=self.num_gpu_blocks_override,
1508
            sliding_window=sliding_window,
1509
            enable_prefix_caching=self.enable_prefix_caching,
1510
            prefix_caching_hash_algo=self.prefix_caching_hash_algo,
1511
            calculate_kv_scales=self.calculate_kv_scales,
1512
            kv_sharing_fast_prefill=self.kv_sharing_fast_prefill,
1513
1514
            mamba_cache_dtype=self.mamba_cache_dtype,
            mamba_ssm_cache_dtype=self.mamba_ssm_cache_dtype,
1515
            mamba_block_size=self.mamba_block_size,
1516
            mamba_cache_mode=self.mamba_cache_mode,
1517
1518
            kv_offloading_size=self.kv_offloading_size,
            kv_offloading_backend=self.kv_offloading_backend,
1519
        )
1520

1521
1522
1523
1524
1525
1526
        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
1527

1528
            ray_runtime_env = ray.get_runtime_context().runtime_env
1529
1530
1531
1532
1533
1534
1535
            # 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)
1536

1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
        # 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()

1548
        assert not headless or not self.data_parallel_hybrid_lb, (
1549
1550
            "data_parallel_hybrid_lb is not applicable in headless mode"
        )
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
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
        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
        )
1592
        # Local DP rank = 1, use pure-external LB.
1593
        if data_parallel_external_lb:
1594
            assert self.data_parallel_rank is not None, (
1595
                "data_parallel_rank or node_rank must be specified if "
1596
1597
                "data_parallel_external_lb is enable."
            )
1598
            assert self.data_parallel_size_local in (1, None), (
1599
1600
                "data_parallel_size_local must be 1 or None when data_parallel_rank "
                "is set"
1601
            )
1602
            data_parallel_size_local = 1
1603
1604
            # Use full external lb if we have local_size of 1.
            self.data_parallel_hybrid_lb = False
1605
1606
        elif self.data_parallel_size_local is not None:
            data_parallel_size_local = self.data_parallel_size_local
1607
1608
1609
1610
1611
1612
1613

            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.
1614
1615
1616
1617
1618
                logger.warning(
                    "data_parallel_hybrid_lb is not eligible when "
                    "data_parallel_size_local = 1, autoswitch to "
                    "data_parallel_external_lb."
                )
1619
1620
1621
1622
1623
1624
1625
                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

1626
1627
1628
1629
1630
1631
1632
1633
1634
            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,
                )
1635
        else:
1636
            assert not self.data_parallel_hybrid_lb, (
1637
1638
                "data_parallel_size_local must be set to use data_parallel_hybrid_lb."
            )
1639

1640
1641
1642
1643
1644
1645
1646
1647
1648
            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
1649
1650
1651

        # DP address, used in multi-node case for torch distributed group
        # and ZMQ sockets.
Rui Qiao's avatar
Rui Qiao committed
1652
1653
1654
1655
        if self.data_parallel_address is None:
            if self.data_parallel_backend == "ray":
                host_ip = get_ip()
                logger.info(
1656
1657
                    "Using host IP %s as ray-based data parallel address", host_ip
                )
Rui Qiao's avatar
Rui Qiao committed
1658
1659
1660
1661
                data_parallel_address = host_ip
            else:
                assert self.data_parallel_backend == "mp", (
                    "data_parallel_backend can only be ray or mp, got %s",
1662
1663
                    self.data_parallel_backend,
                )
1664
1665
1666
                data_parallel_address = (
                    self.master_addr or ParallelConfig.data_parallel_master_ip
                )
Rui Qiao's avatar
Rui Qiao committed
1667
1668
        else:
            data_parallel_address = self.data_parallel_address
1669
1670
1671

        # This port is only used when there are remote data parallel engines,
        # otherwise the local IPC transport is used.
1672
        data_parallel_rpc_port = (
1673
            self.data_parallel_rpc_port
1674
1675
1676
            if (self.data_parallel_rpc_port is not None)
            else ParallelConfig.data_parallel_rpc_port
        )
1677

1678
1679
1680
1681
        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.")

1682
        parallel_config = ParallelConfig(
1683
1684
            pipeline_parallel_size=self.pipeline_parallel_size,
            tensor_parallel_size=self.tensor_parallel_size,
1685
            prefill_context_parallel_size=self.prefill_context_parallel_size,
1686
            data_parallel_size=self.data_parallel_size,
1687
1688
            data_parallel_rank=self.data_parallel_rank or 0,
            data_parallel_external_lb=data_parallel_external_lb,
1689
            data_parallel_size_local=data_parallel_size_local,
1690
1691
1692
1693
            master_addr=self.master_addr,
            master_port=self.master_port,
            nnodes=self.nnodes,
            node_rank=self.node_rank,
1694
1695
            data_parallel_master_ip=data_parallel_address,
            data_parallel_rpc_port=data_parallel_rpc_port,
1696
            data_parallel_backend=self.data_parallel_backend,
1697
            data_parallel_hybrid_lb=self.data_parallel_hybrid_lb,
1698
            is_moe_model=model_config.is_moe,
1699
            enable_expert_parallel=self.enable_expert_parallel,
1700
            all2all_backend=self.all2all_backend,
1701
            enable_dbo=self.enable_dbo,
1702
            ubatch_size=self.ubatch_size,
1703
            dbo_decode_token_threshold=self.dbo_decode_token_threshold,
1704
            dbo_prefill_token_threshold=self.dbo_prefill_token_threshold,
1705
            disable_nccl_for_dp_synchronization=self.disable_nccl_for_dp_synchronization,
1706
            enable_eplb=self.enable_eplb,
1707
            eplb_config=self.eplb_config,
1708
            expert_placement_strategy=self.expert_placement_strategy,
1709
1710
1711
            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,
1712
            ray_runtime_env=ray_runtime_env,
1713
            placement_group=placement_group,
1714
1715
            distributed_executor_backend=self.distributed_executor_backend,
            worker_cls=self.worker_cls,
1716
            worker_extension_cls=self.worker_extension_cls,
1717
            decode_context_parallel_size=self.decode_context_parallel_size,
1718
            dcp_kv_cache_interleave_size=self.dcp_kv_cache_interleave_size,
1719
            cp_kv_cache_interleave_size=self.cp_kv_cache_interleave_size,
1720
1721
            _api_process_count=self._api_process_count,
            _api_process_rank=self._api_process_rank,
1722
        )
1723

1724
        speculative_config = self.create_speculative_config(
1725
1726
1727
1728
            target_model_config=model_config,
            target_parallel_config=parallel_config,
        )

1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
        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"
        )
1739
        scheduler_config = SchedulerConfig(
1740
            runner_type=model_config.runner_type,
1741
1742
1743
            max_num_batched_tokens=self.max_num_batched_tokens,
            max_num_seqs=self.max_num_seqs,
            max_model_len=model_config.max_model_len,
1744
            enable_chunked_prefill=self.enable_chunked_prefill,
1745
            disable_chunked_mm_input=self.disable_chunked_mm_input,
1746
            is_multimodal_model=model_config.is_multimodal_model,
1747
            is_encoder_decoder=model_config.is_encoder_decoder,
1748
            policy=self.scheduling_policy,
1749
            scheduler_cls=self.scheduler_cls,
1750
1751
1752
            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,
1753
            disable_hybrid_kv_cache_manager=self.disable_hybrid_kv_cache_manager,
1754
            async_scheduling=self.async_scheduling,
1755
            stream_interval=self.stream_interval,
1756
        )
1757

1758
1759
1760
        if not model_config.is_multimodal_model and self.default_mm_loras:
            raise ValueError(
                "Default modality-specific LoRA(s) were provided for a "
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
                "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,
1771
                enable_tower_connector_lora=self.enable_tower_connector_lora,
1772
                specialize_active_lora=self.specialize_active_lora,
1773
1774
1775
1776
1777
1778
1779
                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
        )
1780

1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
        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"
            )

1795
1796
1797
1798
        # bitsandbytes pre-quantized model need a specific model loader
        if model_config.quantization == "bitsandbytes":
            self.quantization = self.load_format = "bitsandbytes"

1799
1800
1801
1802
1803
1804
1805
1806
        # 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"
                )
1807
1808
1809
1810
1811
1812
1813
            # 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
1814

1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
        # 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
1825
1826
        if self.moe_backend != "auto":
            kernel_config.moe_backend = self.moe_backend
1827

1828
        load_config = self.create_load_config()
1829

1830
1831
        # Pass reasoning_parser into StructuredOutputsConfig
        if self.reasoning_parser:
1832
            self.structured_outputs_config.reasoning_parser = self.reasoning_parser
1833

1834
1835
1836
1837
1838
        if self.reasoning_parser_plugin:
            self.structured_outputs_config.reasoning_parser_plugin = (
                self.reasoning_parser_plugin
            )

1839
        observability_config = ObservabilityConfig(
1840
            show_hidden_metrics_for_version=self.show_hidden_metrics_for_version,
1841
            otlp_traces_endpoint=self.otlp_traces_endpoint,
1842
            collect_detailed_traces=self.collect_detailed_traces,
1843
1844
            kv_cache_metrics=self.kv_cache_metrics,
            kv_cache_metrics_sample=self.kv_cache_metrics_sample,
1845
            cudagraph_metrics=self.cudagraph_metrics,
1846
            enable_layerwise_nvtx_tracing=self.enable_layerwise_nvtx_tracing,
1847
            enable_mfu_metrics=self.enable_mfu_metrics,
1848
            enable_mm_processor_stats=self.enable_mm_processor_stats,
1849
            enable_logging_iteration_details=self.enable_logging_iteration_details,
1850
        )
1851

1852
        # Compilation config overrides
1853
        compilation_config = copy.deepcopy(self.compilation_config)
1854
        if self.cudagraph_capture_sizes is not None:
1855
            if compilation_config.cudagraph_capture_sizes is not None:
1856
1857
1858
1859
                raise ValueError(
                    "cudagraph_capture_sizes and compilation_config."
                    "cudagraph_capture_sizes are mutually exclusive"
                )
1860
            compilation_config.cudagraph_capture_sizes = self.cudagraph_capture_sizes
1861
        if self.max_cudagraph_capture_size is not None:
1862
            if compilation_config.max_cudagraph_capture_size is not None:
1863
1864
1865
1866
                raise ValueError(
                    "max_cudagraph_capture_size and compilation_config."
                    "max_cudagraph_capture_size are mutually exclusive"
                )
1867
            compilation_config.max_cudagraph_capture_size = (
1868
1869
                self.max_cudagraph_capture_size
            )
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884

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

1885
        config = VllmConfig(
1886
1887
1888
1889
1890
            model_config=model_config,
            cache_config=cache_config,
            parallel_config=parallel_config,
            scheduler_config=scheduler_config,
            device_config=device_config,
1891
            load_config=load_config,
1892
            offload_config=offload_config,
1893
            attention_config=attention_config,
1894
            kernel_config=kernel_config,
1895
1896
            lora_config=lora_config,
            speculative_config=speculative_config,
1897
            structured_outputs_config=self.structured_outputs_config,
1898
            observability_config=observability_config,
1899
            compilation_config=compilation_config,
1900
            kv_transfer_config=self.kv_transfer_config,
1901
            kv_events_config=self.kv_events_config,
1902
            ec_transfer_config=self.ec_transfer_config,
1903
            profiler_config=self.profiler_config,
1904
            additional_config=self.additional_config,
1905
            optimization_level=self.optimization_level,
1906
            performance_mode=self.performance_mode,
1907
            weight_transfer_config=self.weight_transfer_config,
1908
        )
1909

1910
1911
        return config

1912
    def _check_feature_supported(self):
1913
        """Raise an error if the feature is not supported."""
1914
        # No Concurrent Partial Prefills so far.
1915
1916
1917
1918
1919
        if (
            self.max_num_partial_prefills != SchedulerConfig.max_num_partial_prefills
            or self.max_long_partial_prefills
            != SchedulerConfig.max_long_partial_prefills
        ):
1920
            _raise_unsupported_error(feature_name="Concurrent Partial Prefill")
1921

1922
        if self.pipeline_parallel_size > 1:
1923
1924
1925
            supports_pp = getattr(
                self.distributed_executor_backend, "supports_pp", False
            )
1926
            if not supports_pp and self.distributed_executor_backend not in (
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
                ParallelConfig.distributed_executor_backend,
                "ray",
                "mp",
                "external_launcher",
            ):
                name = (
                    "Pipeline Parallelism without Ray distributed "
                    "executor or multiprocessing executor or external "
                    "launcher"
                )
1937
                _raise_unsupported_error(feature_name=name)
1938

1939
1940
1941
1942
1943
1944
    @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
1945

1946
1947
        default_max_num_batched_tokens: dict[UsageContext | None, int]
        default_max_num_seqs: dict[UsageContext | None, int]
1948

1949
1950
        # When no user override, set the default values based on the usage
        # context.
1951
        # Use different default values for different hardware.
1952
1953
1954
1955
1956
1957
1958

        # 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:
1959
            device_memory = current_platform.get_device_total_memory()
1960
            device_name = current_platform.get_device_name().lower()
1961
1962
        except Exception:
            # This is only used to set default_max_num_batched_tokens
1963
            device_memory = 0
1964
            device_name = ""
1965

1966
1967
1968
1969
        # 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:
1970
            # For GPUs like H100 and MI300x, use larger default values.
1971
1972
1973
1974
            default_max_num_batched_tokens = {
                UsageContext.LLM_CLASS: 16384,
                UsageContext.OPENAI_API_SERVER: 8192,
            }
1975
1976
1977
1978
            default_max_num_seqs = {
                UsageContext.LLM_CLASS: 1024,
                UsageContext.OPENAI_API_SERVER: 1024,
            }
1979
1980
1981
1982
1983
1984
        else:
            # TODO(woosuk): Tune the default values for other hardware.
            default_max_num_batched_tokens = {
                UsageContext.LLM_CLASS: 8192,
                UsageContext.OPENAI_API_SERVER: 2048,
            }
1985
1986
1987
1988
            default_max_num_seqs = {
                UsageContext.LLM_CLASS: 256,
                UsageContext.OPENAI_API_SERVER: 256,
            }
1989

1990
1991
        # tpu specific default values.
        if current_platform.is_tpu():
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
            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,
                }
2009

2010
2011
2012
        # cpu specific default values.
        if current_platform.is_cpu():
            default_max_num_batched_tokens = {
2013
2014
                UsageContext.LLM_CLASS: 4096 * world_size,
                UsageContext.OPENAI_API_SERVER: 2048 * world_size,
2015
2016
            }
            default_max_num_seqs = {
2017
2018
                UsageContext.LLM_CLASS: 256 * world_size,
                UsageContext.OPENAI_API_SERVER: 128 * world_size,
2019
2020
            }

2021
2022
        return default_max_num_batched_tokens, default_max_num_seqs

2023
2024
    def _set_default_chunked_prefill_and_prefix_caching_args(
        self, model_config: ModelConfig
2025
    ) -> None:
2026
2027
        default_chunked_prefill = model_config.is_chunked_prefill_supported
        default_prefix_caching = model_config.is_prefix_caching_supported
2028
2029
2030
2031
2032
2033
2034
2035

        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",
            )
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
        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",
            )
2047
2048
2049
2050
        elif (
            model_config.runner_type == "pooling"
            and self.enable_chunked_prefill
            and not default_chunked_prefill
2051
        ):
2052
            logger.warning_once(
2053
2054
2055
                "This model does not officially support chunked prefill. "
                "Enabling this manually may cause the engine to crash "
                "or produce incorrect outputs.",
2056
                scope="local",
2057
2058
2059
2060
2061
            )

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

2062
            logger.debug(
2063
2064
2065
2066
2067
2068
2069
2070
                "%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
        ):
2071
            logger.warning_once(
2072
2073
2074
                "This model does not officially support prefix caching. "
                "Enabling this manually may cause the engine to crash "
                "or produce incorrect outputs.",
2075
                scope="local",
2076
2077
            )

2078
        # Disable chunked prefill and prefix caching for:
2079
        # POWER (ppc64le)/RISCV CPUs in V1
2080
2081
2082
2083
2084
        if current_platform.is_cpu() and current_platform.get_cpu_architecture() in (
            CpuArchEnum.POWERPC,
            CpuArchEnum.RISCV,
        ):
            logger.info(
2085
                "Chunked prefill is not supported for POWER, "
2086
                "and RISC-V CPUs; "
2087
2088
2089
2090
                "disabling it for V1 backend."
            )
            self.enable_chunked_prefill = False
            logger.info(
2091
                "Prefix caching is not supported for POWER, "
2092
                "and RISC-V CPUs; "
2093
2094
2095
2096
2097
                "disabling it for V1 backend."
            )
            self.enable_prefix_caching = False

    def _set_default_max_num_seqs_and_batched_tokens_args(
2098
2099
2100
        self,
        usage_context: UsageContext | None,
        model_config: ModelConfig,
2101
    ):
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
        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,
            )

2123
2124
2125
2126
2127
2128
2129
        # 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

2130
        if orig_max_num_batched_tokens is None:
2131
2132
2133
            assert model_config.max_model_len is not None, (
                "max_model_len must be set by this point"
            )
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
            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,
2146
2147
                self.max_num_batched_tokens,
            )
2148

2149
2150
2151
2152
            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,
2153
            )
2154

2155
2156
2157
2158
        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)

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

2165

2166
@dataclass
Zhuohan Li's avatar
Zhuohan Li committed
2167
class AsyncEngineArgs(EngineArgs):
Woosuk Kwon's avatar
Woosuk Kwon committed
2168
    """Arguments for asynchronous vLLM engine."""
2169

2170
2171
    enable_log_requests: bool = False

2172
    @staticmethod
2173
2174
2175
    def add_cli_args(
        parser: FlexibleArgumentParser, async_args_only: bool = False
    ) -> FlexibleArgumentParser:
2176
        # Initialize plugin to update the parser, for example, The plugin may
2177
        # add a new kind of quantization method to --quantization argument or
2178
2179
        # a new device to --device argument.
        load_general_plugins()
2180
2181
        if not async_args_only:
            parser = EngineArgs.add_cli_args(parser)
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
        parser.add_argument(
            "--enable-log-requests",
            action=argparse.BooleanOptionalAction,
            default=AsyncEngineArgs.enable_log_requests,
            help="Enable logging requests.",
        )
        parser.add_argument(
            "--disable-log-requests",
            action=argparse.BooleanOptionalAction,
            default=not AsyncEngineArgs.enable_log_requests,
            help="[DEPRECATED] Disable logging requests.",
            deprecated=True,
        )
2195
        current_platform.pre_register_and_update(parser)
2196
        return parser
2197
2198


2199
2200
2201
2202
2203
2204
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)
2205
2206


2207
def human_readable_int(value: str) -> int:
2208
2209
    """Parse human-readable integers like '1k', '2M', etc.
    Including decimal values with decimal multipliers.
2210

2211
2212
2213
2214
2215
2216
    Examples:
    - '1k' -> 1,000
    - '1K' -> 1,024
    - '25.6k' -> 25,600
    """
    value = value.strip()
2217

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

        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:
2243
2244
2245
2246
2247
                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
2248
2249
2250

    # Regular plain number.
    return int(value)
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269


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)