arg_utils.py 94.6 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
65
66
from vllm.config.cache import (
    CacheDType,
    KVOffloadingBackend,
67
    MambaCacheMode,
68
69
70
    MambaDType,
    PrefixCachingHashAlgo,
)
71
from vllm.config.device import Device
72
from vllm.config.kernel import MoEBackend
73
from vllm.config.lora import MaxLoRARanks
74
75
76
77
78
79
from vllm.config.model import (
    ConvertOption,
    HfOverrides,
    LogprobsMode,
    ModelDType,
    RunnerOption,
80
    TokenizerMode,
81
82
83
)
from vllm.config.multimodal import MMCacheType, MMEncoderTPMode
from vllm.config.observability import DetailedTraceModules
84
85
86
from vllm.config.parallel import (
    All2AllBackend,
    DataParallelBackend,
87
    DCPCommBackend,
88
89
90
    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
from vllm.version import __version__ as VLLM_VERSION
112

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

124

125
126
logger = init_logger(__name__)

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

132

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

142
143
144
    return _parse_type


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

151
    return _optional_type
152
153


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


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


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


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


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

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


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

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

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

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


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


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

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

    return type_hints


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


247
248
249
250
251
252
253
254
def _maybe_add_docs_url(cls: Any) -> str:
    """Generate API docs URL for a vllm config class."""
    if not cls.__module__.startswith("vllm.config"):
        return ""
    version = f"v{VLLM_VERSION}" if "dev" not in VLLM_VERSION else "latest"
    return f"\n\nAPI docs: https://docs.vllm.ai/en/{version}/api/vllm/config/#vllm.config.{cls.__name__}"


255
@functools.lru_cache(maxsize=30)
256
def _compute_kwargs(cls: ConfigType) -> dict[str, dict[str, Any]]:
257
258
    # Save time only getting attr docs if we're generating help text
    cls_docs = get_attr_docs(cls) if NEEDS_HELP else {}
259
260
    kwargs = {}
    for field in fields(cls):
261
        # Get the set of possible types for the field
262
        type_hints: set[TypeHint] = get_type_hints(field.type)
263
264
265
266
267

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

268
        # Get the default value of the field
269
270
        if field.default is not MISSING:
            default = field.default
271
272
            # Handle pydantic.Field defaults
            if isinstance(default, FieldInfo):
273
274
275
276
277
278
                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():
279
                        default = default.default_factory()  # type: ignore[call-arg]
280
        elif field.default_factory is not MISSING:
281
            default = field.default_factory()
282
283
284

        # Get the help text for the field
        name = field.name
285
        help = cls_docs.get(name, "").strip()
286
287
288
289
290
291
292
        # 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
293
294
295
        json_tip = (
            "Should either be a valid JSON string or JSON keys passed individually."
        )
296
        if dataclass_cls is not None:
297
298
299
300
301
302
303
304

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

344
345
346
347
348
        # 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"]}))

349
350
351
352
353
354
355
        # 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
356
357


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

361
362
363
    If `--help` or `mkdocs` are not present in the command line command, the
    attribute documentation will not be included in the help output.

364
365
366
367
368
369
370
    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))


371
@dataclass
Zhuohan Li's avatar
Zhuohan Li committed
372
class EngineArgs:
Woosuk Kwon's avatar
Woosuk Kwon committed
373
    """Arguments for vLLM engine."""
374

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

524
    ray_workers_use_nsight: bool = ParallelConfig.ray_workers_use_nsight
525
    num_gpu_blocks_override: int | None = CacheConfig.num_gpu_blocks_override
526
    model_loader_extra_config: dict = get_field(LoadConfig, "model_loader_extra_config")
527
    ignore_patterns: str | list[str] = get_field(LoadConfig, "ignore_patterns")
528

529
    enable_chunked_prefill: bool | None = None
530
    disable_chunked_mm_input: bool = SchedulerConfig.disable_chunked_mm_input
531

532
    disable_hybrid_kv_cache_manager: bool | None = (
533
534
        SchedulerConfig.disable_hybrid_kv_cache_manager
    )
535

536
    structured_outputs_config: StructuredOutputsConfig = get_field(
537
538
        VllmConfig, "structured_outputs_config"
    )
539
    reasoning_parser: str = StructuredOutputsConfig.reasoning_parser
540
    reasoning_parser_plugin: str | None = None
541

542
    speculative_config: dict[str, Any] | None = None
543

544
    show_hidden_metrics_for_version: str | None = (
545
        ObservabilityConfig.show_hidden_metrics_for_version
546
    )
547
548
    otlp_traces_endpoint: str | None = ObservabilityConfig.otlp_traces_endpoint
    collect_detailed_traces: list[DetailedTraceModules] | None = (
549
        ObservabilityConfig.collect_detailed_traces
550
    )
551
552
553
554
    kv_cache_metrics: bool = ObservabilityConfig.kv_cache_metrics
    kv_cache_metrics_sample: float = get_field(
        ObservabilityConfig, "kv_cache_metrics_sample"
    )
555
    cudagraph_metrics: bool = ObservabilityConfig.cudagraph_metrics
556
557
558
    enable_layerwise_nvtx_tracing: bool = (
        ObservabilityConfig.enable_layerwise_nvtx_tracing
    )
559
    enable_mfu_metrics: bool = ObservabilityConfig.enable_mfu_metrics
560
561
562
    enable_logging_iteration_details: bool = (
        ObservabilityConfig.enable_logging_iteration_details
    )
563
    enable_mm_processor_stats: bool = ObservabilityConfig.enable_mm_processor_stats
564
    scheduling_policy: SchedulerPolicy = SchedulerConfig.policy
565
    scheduler_cls: str | type[object] | None = SchedulerConfig.scheduler_cls
566

567
    pooler_config: PoolerConfig | None = ModelConfig.pooler_config
568
    compilation_config: CompilationConfig = get_field(VllmConfig, "compilation_config")
569
    attention_config: AttentionConfig = get_field(VllmConfig, "attention_config")
570
571
572
573
    kernel_config: KernelConfig = get_field(VllmConfig, "kernel_config")
    enable_flashinfer_autotune: bool = get_field(
        KernelConfig, "enable_flashinfer_autotune"
    )
574
575
    worker_cls: str = ParallelConfig.worker_cls
    worker_extension_cls: str = ParallelConfig.worker_extension_cls
576

577
578
    profiler_config: ProfilerConfig = get_field(VllmConfig, "profiler_config")

579
580
    kv_transfer_config: KVTransferConfig | None = None
    kv_events_config: KVEventsConfig | None = None
581

582
583
    ec_transfer_config: ECTransferConfig | None = None

584
585
    generation_config: str = ModelConfig.generation_config
    enable_sleep_mode: bool = ModelConfig.enable_sleep_mode
586
587
588
    override_generation_config: dict[str, Any] = get_field(
        ModelConfig, "override_generation_config"
    )
589
    model_impl: str = ModelConfig.model_impl
590
    override_attention_dtype: str | None = ModelConfig.override_attention_dtype
591
    attention_backend: AttentionBackendEnum | None = AttentionConfig.backend
592

593
    calculate_kv_scales: bool = CacheConfig.calculate_kv_scales
594
595
    mamba_cache_dtype: MambaDType = CacheConfig.mamba_cache_dtype
    mamba_ssm_cache_dtype: MambaDType = CacheConfig.mamba_ssm_cache_dtype
596
    mamba_block_size: int | None = get_field(CacheConfig, "mamba_block_size")
597
    mamba_cache_mode: MambaCacheMode = CacheConfig.mamba_cache_mode
598

599
    additional_config: dict[str, Any] = get_field(VllmConfig, "additional_config")
600

601
    use_tqdm_on_load: bool = LoadConfig.use_tqdm_on_load
602
    pt_load_map_location: str | dict[str, str] = LoadConfig.pt_load_map_location
603

604
    logits_processors: list[str | type[LogitsProcessor]] | None = (
605
606
        ModelConfig.logits_processors
    )
607
608
    """Custom logitproc types"""

609
    async_scheduling: bool | None = SchedulerConfig.async_scheduling
610

611
612
    stream_interval: int = SchedulerConfig.stream_interval

613
    kv_sharing_fast_prefill: bool = CacheConfig.kv_sharing_fast_prefill
614
    optimization_level: OptimizationLevel = VllmConfig.optimization_level
615
    performance_mode: PerformanceMode = VllmConfig.performance_mode
616

617
    kv_offloading_size: float | None = CacheConfig.kv_offloading_size
618
    kv_offloading_backend: KVOffloadingBackend = CacheConfig.kv_offloading_backend
619
    tokens_only: bool = False
620

621
622
    shutdown_timeout: int = 0

623
624
625
626
    weight_transfer_config: WeightTransferConfig | None = get_field(
        VllmConfig,
        "weight_transfer_config",
    )
627

628
    fail_on_environ_validation: bool = False
629
    gdn_prefill_backend: Literal["flashinfer", "triton"] | None = None
630

631
    def __post_init__(self):
632
633
634
        # support `EngineArgs(compilation_config={...})`
        # without having to manually construct a
        # CompilationConfig object
635
        if isinstance(self.compilation_config, dict):
636
            self.compilation_config = CompilationConfig(**self.compilation_config)
637
638
        if isinstance(self.attention_config, dict):
            self.attention_config = AttentionConfig(**self.attention_config)
639
640
        if isinstance(self.kernel_config, dict):
            self.kernel_config = KernelConfig(**self.kernel_config)
641
        if isinstance(self.eplb_config, dict):
642
            self.eplb_config = EPLBConfig(**self.eplb_config)
643
644
645
646
        if isinstance(self.weight_transfer_config, dict):
            self.weight_transfer_config = WeightTransferConfig(
                **self.weight_transfer_config
            )
647
        # Setup plugins
648
        from vllm.plugins import load_general_plugins
649

650
        load_general_plugins()
651
        # when use hf offline,replace model and tokenizer id to local model path
652
653
654
        if huggingface_hub.constants.HF_HUB_OFFLINE:
            model_id = self.model
            self.model = get_model_path(self.model, self.revision)
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
            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,
                    )
671
672

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

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

766
767
768
769
770
771
        # Model loading arguments
        load_kwargs = get_kwargs(LoadConfig)
        load_group = parser.add_argument_group(
            title="LoadConfig",
            description=LoadConfig.__doc__,
        )
772
        load_group.add_argument("--load-format", **load_kwargs["load_format"])
773
774
775
776
777
778
779
780
781
782
783
784
        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"]
        )
785

786
787
788
789
790
791
792
793
794
795
        # 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"]
        )

796
797
798
799
800
        # Structured outputs arguments
        structured_outputs_kwargs = get_kwargs(StructuredOutputsConfig)
        structured_outputs_group = parser.add_argument_group(
            title="StructuredOutputsConfig",
            description=StructuredOutputsConfig.__doc__,
801
        )
802
        structured_outputs_group.add_argument(
803
            "--reasoning-parser",
804
            # Choices need to be validated after parsing to include plugins
805
806
            **structured_outputs_kwargs["reasoning_parser"],
        )
807
808
809
810
        structured_outputs_group.add_argument(
            "--reasoning-parser-plugin",
            **structured_outputs_kwargs["reasoning_parser_plugin"],
        )
811

812
        # Parallel arguments
813
814
815
816
817
818
        parallel_kwargs = get_kwargs(ParallelConfig)
        parallel_group = parser.add_argument_group(
            title="ParallelConfig",
            description=ParallelConfig.__doc__,
        )
        parallel_group.add_argument(
819
            "--distributed-executor-backend",
820
821
            **parallel_kwargs["distributed_executor_backend"],
        )
822
        parallel_group.add_argument(
823
824
825
826
            "--pipeline-parallel-size",
            "-pp",
            **parallel_kwargs["pipeline_parallel_size"],
        )
827
828
829
830
        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"])
831
832
833
834
        parallel_group.add_argument(
            "--distributed-timeout-seconds",
            **parallel_kwargs["distributed_timeout_seconds"],
        )
835
        parallel_group.add_argument(
836
837
            "--tensor-parallel-size", "-tp", **parallel_kwargs["tensor_parallel_size"]
        )
838
        parallel_group.add_argument(
839
840
841
842
            "--decode-context-parallel-size",
            "-dcp",
            **parallel_kwargs["decode_context_parallel_size"],
        )
843
844
845
846
        parallel_group.add_argument(
            "--dcp-comm-backend",
            **parallel_kwargs["dcp_comm_backend"],
        )
847
848
849
850
        parallel_group.add_argument(
            "--dcp-kv-cache-interleave-size",
            **parallel_kwargs["dcp_kv_cache_interleave_size"],
        )
851
852
853
854
855
856
857
858
859
        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"],
        )
860
861
862
863
864
865
        parallel_group.add_argument(
            "--data-parallel-size", "-dp", **parallel_kwargs["data_parallel_size"]
        )
        parallel_group.add_argument(
            "--data-parallel-rank",
            "-dpn",
866
            type=int,
867
868
869
            help="Data parallel rank of this instance. "
            "When set, enables external load balancer mode.",
        )
870
        parallel_group.add_argument(
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
            "--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".',
        )
901
        parallel_group.add_argument(
902
903
904
905
906
907
908
909
            "--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"],
910
911
        )
        parallel_group.add_argument(
912
913
914
            "--enable-expert-parallel",
            "-ep",
            **parallel_kwargs["enable_expert_parallel"],
915
        )
916
917
918
919
        parallel_group.add_argument(
            "--enable-ep-weight-filter",
            **parallel_kwargs["enable_ep_weight_filter"],
        )
920
921
922
        parallel_group.add_argument(
            "--all2all-backend", **parallel_kwargs["all2all_backend"]
        )
923
        parallel_group.add_argument("--enable-dbo", **parallel_kwargs["enable_dbo"])
924
925
926
927
        parallel_group.add_argument(
            "--ubatch-size",
            **parallel_kwargs["ubatch_size"],
        )
928
929
930
        parallel_group.add_argument(
            "--enable-elastic-ep", **parallel_kwargs["enable_elastic_ep"]
        )
931
932
        parallel_group.add_argument(
            "--dbo-decode-token-threshold",
933
934
            **parallel_kwargs["dbo_decode_token_threshold"],
        )
935
936
        parallel_group.add_argument(
            "--dbo-prefill-token-threshold",
937
938
            **parallel_kwargs["dbo_prefill_token_threshold"],
        )
939
940
941
942
        parallel_group.add_argument(
            "--disable-nccl-for-dp-synchronization",
            **parallel_kwargs["disable_nccl_for_dp_synchronization"],
        )
943
944
        parallel_group.add_argument("--enable-eplb", **parallel_kwargs["enable_eplb"])
        parallel_group.add_argument("--eplb-config", **parallel_kwargs["eplb_config"])
945
946
        parallel_group.add_argument(
            "--expert-placement-strategy",
947
948
            **parallel_kwargs["expert_placement_strategy"],
        )
949

950
        parallel_group.add_argument(
951
            "--max-parallel-loading-workers",
952
953
            **parallel_kwargs["max_parallel_loading_workers"],
        )
954
        parallel_group.add_argument(
955
956
            "--ray-workers-use-nsight", **parallel_kwargs["ray_workers_use_nsight"]
        )
957
        parallel_group.add_argument(
958
            "--disable-custom-all-reduce",
959
960
961
962
963
964
            **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"]
        )
965

966
967
968
969
970
        # KV cache arguments
        cache_kwargs = get_kwargs(CacheConfig)
        cache_group = parser.add_argument_group(
            title="CacheConfig",
            description=CacheConfig.__doc__,
971
        )
972
        cache_group.add_argument("--block-size", **cache_kwargs["block_size"])
973
974
975
976
977
978
979
980
981
982
983
        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"]
        )
        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(
984
985
986
987
988
            "--enable-prefix-caching",
            **{
                **cache_kwargs["enable_prefix_caching"],
                "default": None,
            },
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
        )
        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"]
        )
1005
1006
1007
        cache_group.add_argument(
            "--mamba-block-size", **cache_kwargs["mamba_block_size"]
        )
1008
1009
1010
        cache_group.add_argument(
            "--mamba-cache-mode", **cache_kwargs["mamba_cache_mode"]
        )
1011
1012
1013
1014
1015
1016
        cache_group.add_argument(
            "--kv-offloading-size", **cache_kwargs["kv_offloading_size"]
        )
        cache_group.add_argument(
            "--kv-offloading-backend", **cache_kwargs["kv_offloading_backend"]
        )
1017

1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
        # 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"]
        )

1049
        # Multimodal related configs
1050
1051
1052
1053
1054
        multimodal_kwargs = get_kwargs(MultiModalConfig)
        multimodal_group = parser.add_argument_group(
            title="MultiModalConfig",
            description=MultiModalConfig.__doc__,
        )
1055
1056
1057
        multimodal_group.add_argument(
            "--language-model-only", **multimodal_kwargs["language_model_only"]
        )
1058
        multimodal_group.add_argument(
1059
1060
            "--limit-mm-per-prompt", **multimodal_kwargs["limit_per_prompt"]
        )
1061
1062
1063
        multimodal_group.add_argument(
            "--enable-mm-embeds", **multimodal_kwargs["enable_mm_embeds"]
        )
1064
1065
1066
        multimodal_group.add_argument(
            "--media-io-kwargs", **multimodal_kwargs["media_io_kwargs"]
        )
1067
1068
1069
1070
1071
1072
        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"]
        )
1073
        multimodal_group.add_argument(
1074
1075
            "--mm-processor-cache-type", **multimodal_kwargs["mm_processor_cache_type"]
        )
1076
1077
        multimodal_group.add_argument(
            "--mm-shm-cache-max-object-size-mb",
1078
1079
            **multimodal_kwargs["mm_shm_cache_max_object_size_mb"],
        )
1080
1081
1082
        multimodal_group.add_argument(
            "--mm-encoder-only", **multimodal_kwargs["mm_encoder_only"]
        )
1083
        multimodal_group.add_argument(
1084
1085
            "--mm-encoder-tp-mode", **multimodal_kwargs["mm_encoder_tp_mode"]
        )
1086
1087
1088
1089
        multimodal_group.add_argument(
            "--mm-encoder-attn-backend",
            **multimodal_kwargs["mm_encoder_attn_backend"],
        )
1090
1091
1092
        multimodal_group.add_argument(
            "--interleave-mm-strings", **multimodal_kwargs["interleave_mm_strings"]
        )
1093
        multimodal_group.add_argument(
1094
1095
            "--skip-mm-profiling", **multimodal_kwargs["skip_mm_profiling"]
        )
1096

1097
        multimodal_group.add_argument(
1098
1099
            "--video-pruning-rate", **multimodal_kwargs["video_pruning_rate"]
        )
1100

1101
        # LoRA related configs
1102
1103
1104
1105
1106
1107
        lora_kwargs = get_kwargs(LoRAConfig)
        lora_group = parser.add_argument_group(
            title="LoRAConfig",
            description=LoRAConfig.__doc__,
        )
        lora_group.add_argument(
1108
            "--enable-lora",
1109
            action=argparse.BooleanOptionalAction,
1110
1111
            help="If True, enable handling of LoRA adapters.",
        )
1112
        lora_group.add_argument("--max-loras", **lora_kwargs["max_loras"])
1113
        lora_group.add_argument("--max-lora-rank", **lora_kwargs["max_lora_rank"])
1114
        lora_group.add_argument(
1115
            "--lora-dtype",
1116
1117
            **lora_kwargs["lora_dtype"],
        )
1118
1119
1120
1121
        lora_group.add_argument(
            "--enable-tower-connector-lora",
            **lora_kwargs["enable_tower_connector_lora"],
        )
1122
1123
1124
1125
        lora_group.add_argument("--max-cpu-loras", **lora_kwargs["max_cpu_loras"])
        lora_group.add_argument(
            "--fully-sharded-loras", **lora_kwargs["fully_sharded_loras"]
        )
1126
1127
1128
        lora_group.add_argument(
            "--lora-target-modules", **lora_kwargs["target_modules"]
        )
1129
        lora_group.add_argument("--default-mm-loras", **lora_kwargs["default_mm_loras"])
1130
1131
1132
        lora_group.add_argument(
            "--specialize-active-lora", **lora_kwargs["specialize_active_lora"]
        )
1133

1134
1135
1136
1137
1138
1139
1140
1141
        # 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",
1142
1143
            **observability_kwargs["show_hidden_metrics_for_version"],
        )
1144
        observability_group.add_argument(
1145
1146
            "--otlp-traces-endpoint", **observability_kwargs["otlp_traces_endpoint"]
        )
1147
1148
1149
1150
1151
        # 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"] += [
1152
            ",".join(p) for p in permutations(get_args(DetailedTraceModules), r=2)
1153
1154
1155
        ]
        observability_group.add_argument(
            "--collect-detailed-traces",
1156
1157
            **observability_kwargs["collect_detailed_traces"],
        )
1158
1159
1160
1161
1162
1163
1164
        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"],
        )
1165
1166
1167
1168
        observability_group.add_argument(
            "--cudagraph-metrics",
            **observability_kwargs["cudagraph_metrics"],
        )
1169
1170
1171
1172
        observability_group.add_argument(
            "--enable-layerwise-nvtx-tracing",
            **observability_kwargs["enable_layerwise_nvtx_tracing"],
        )
1173
1174
1175
1176
        observability_group.add_argument(
            "--enable-mfu-metrics",
            **observability_kwargs["enable_mfu_metrics"],
        )
1177
1178
1179
1180
        observability_group.add_argument(
            "--enable-logging-iteration-details",
            **observability_kwargs["enable_logging_iteration_details"],
        )
1181

1182
1183
1184
1185
1186
1187
1188
        # Scheduler arguments
        scheduler_kwargs = get_kwargs(SchedulerConfig)
        scheduler_group = parser.add_argument_group(
            title="SchedulerConfig",
            description=SchedulerConfig.__doc__,
        )
        scheduler_group.add_argument(
1189
1190
1191
1192
1193
            "--max-num-batched-tokens",
            **{
                **scheduler_kwargs["max_num_batched_tokens"],
                "default": None,
            },
1194
        )
1195
        scheduler_group.add_argument(
1196
1197
1198
1199
1200
            "--max-num-seqs",
            **{
                **scheduler_kwargs["max_num_seqs"],
                "default": None,
            },
1201
1202
1203
1204
        )
        scheduler_group.add_argument(
            "--max-num-partial-prefills", **scheduler_kwargs["max_num_partial_prefills"]
        )
1205
1206
        scheduler_group.add_argument(
            "--max-long-partial-prefills",
1207
1208
            **scheduler_kwargs["max_long_partial_prefills"],
        )
1209
1210
        scheduler_group.add_argument(
            "--long-prefill-token-threshold",
1211
1212
            **scheduler_kwargs["long_prefill_token_threshold"],
        )
1213
1214
        # multi-step scheduling has been removed; corresponding arguments
        # are no longer supported.
1215
        scheduler_group.add_argument(
1216
1217
            "--scheduling-policy", **scheduler_kwargs["policy"]
        )
1218
        scheduler_group.add_argument(
1219
1220
1221
1222
1223
            "--enable-chunked-prefill",
            **{
                **scheduler_kwargs["enable_chunked_prefill"],
                "default": None,
            },
1224
1225
1226
1227
1228
1229
1230
        )
        scheduler_group.add_argument(
            "--disable-chunked-mm-input", **scheduler_kwargs["disable_chunked_mm_input"]
        )
        scheduler_group.add_argument(
            "--scheduler-cls", **scheduler_kwargs["scheduler_cls"]
        )
1231
1232
        scheduler_group.add_argument(
            "--disable-hybrid-kv-cache-manager",
1233
1234
1235
1236
1237
            **scheduler_kwargs["disable_hybrid_kv_cache_manager"],
        )
        scheduler_group.add_argument(
            "--async-scheduling", **scheduler_kwargs["async_scheduling"]
        )
1238
1239
1240
        scheduler_group.add_argument(
            "--stream-interval", **scheduler_kwargs["stream_interval"]
        )
1241

1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
        # 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"],
        )

1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
        # 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"],
        )
1266
1267
1268
        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)
1269

1270
        # vLLM arguments
1271
        vllm_kwargs = get_kwargs(VllmConfig)
1272
1273
1274
1275
        vllm_group = parser.add_argument_group(
            title="VllmConfig",
            description=VllmConfig.__doc__,
        )
1276
1277
1278
1279
        # 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)
1280
1281
1282
1283
1284
1285
1286
        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"])
1287
1288
1289
        vllm_group.add_argument(
            "--ec-transfer-config", **vllm_kwargs["ec_transfer_config"]
        )
1290
        vllm_group.add_argument(
1291
            "--compilation-config", "-cc", **vllm_kwargs["compilation_config"]
1292
        )
1293
1294
1295
        vllm_group.add_argument(
            "--attention-config", "-ac", **vllm_kwargs["attention_config"]
        )
1296
        vllm_group.add_argument("--kernel-config", **vllm_kwargs["kernel_config"])
1297
1298
1299
1300
1301
1302
        vllm_group.add_argument(
            "--additional-config", **vllm_kwargs["additional_config"]
        )
        vllm_group.add_argument(
            "--structured-outputs-config", **vllm_kwargs["structured_outputs_config"]
        )
1303
        vllm_group.add_argument("--profiler-config", **vllm_kwargs["profiler_config"])
1304
1305
1306
        vllm_group.add_argument(
            "--optimization-level", **vllm_kwargs["optimization_level"]
        )
1307
        vllm_group.add_argument("--performance-mode", **vllm_kwargs["performance_mode"])
1308
1309
1310
        vllm_group.add_argument(
            "--weight-transfer-config", **vllm_kwargs["weight_transfer_config"]
        )
1311

1312
        # Other arguments
1313
1314
1315
1316
1317
        parser.add_argument(
            "--disable-log-stats",
            action="store_true",
            help="Disable logging statistics.",
        )
1318

1319
1320
1321
1322
1323
1324
        parser.add_argument(
            "--aggregate-engine-logging",
            action="store_true",
            help="Log aggregate rather than per-engine statistics "
            "when using data parallelism.",
        )
1325
1326
1327
1328
1329
1330
1331
1332

        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,
        )
1333
1334
1335
1336
1337
1338
1339
1340

        parser.add_argument(
            "--shutdown-timeout",
            type=int,
            default=0,
            help="Shutdown timeout in seconds. 0 = abort, >0 = wait.",
        )

1341
1342
1343
1344
1345
1346
1347
        parser.add_argument(
            "--gdn-prefill-backend",
            dest="gdn_prefill_backend",
            choices=["flashinfer", "triton"],
            default=None,
            help="Select GDN prefill backend.",
        )
1348
        return parser
1349
1350

    @classmethod
1351
    def from_cli_args(cls, args: argparse.Namespace):
1352
1353
1354
        # Get the list of attributes of this dataclass.
        attrs = [attr.name for attr in dataclasses.fields(cls)]
        # Set the attributes from the parsed arguments.
1355
1356
1357
        engine_args = cls(
            **{attr: getattr(args, attr) for attr in attrs if hasattr(args, attr)}
        )
Zhuohan Li's avatar
Zhuohan Li committed
1358
        return engine_args
1359

1360
    def create_model_config(self) -> ModelConfig:
1361
1362
        # gguf file needs a specific model loader
        if is_gguf(self.model):
1363
1364
            self.quantization = self.load_format = "gguf"

1365
1366
1367
1368
1369
1370
1371
        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,
1372
1373
            )

1374
        return ModelConfig(
1375
            model=self.model,
1376
            model_weights=self.model_weights,
1377
            hf_config_path=self.hf_config_path,
1378
1379
            runner=self.runner,
            convert=self.convert,
1380
            tokenizer=self.tokenizer,  # type: ignore[arg-type]
1381
            tokenizer_mode=self.tokenizer_mode,
1382
            trust_remote_code=self.trust_remote_code,
1383
1384
            allowed_local_media_path=self.allowed_local_media_path,
            allowed_media_domains=self.allowed_media_domains,
1385
1386
1387
1388
            dtype=self.dtype,
            seed=self.seed,
            revision=self.revision,
            code_revision=self.code_revision,
1389
            hf_token=self.hf_token,
1390
            hf_overrides=self.hf_overrides,
1391
            tokenizer_revision=self.tokenizer_revision,
1392
1393
            max_model_len=self.max_model_len,
            quantization=self.quantization,
1394
            allow_deprecated_quantization=self.allow_deprecated_quantization,
1395
            enforce_eager=self.enforce_eager,
1396
            enable_return_routed_experts=self.enable_return_routed_experts,
1397
            max_logprobs=self.max_logprobs,
1398
            logprobs_mode=self.logprobs_mode,
1399
            disable_sliding_window=self.disable_sliding_window,
1400
            disable_cascade_attn=self.disable_cascade_attn,
1401
            skip_tokenizer_init=self.skip_tokenizer_init,
1402
            enable_prompt_embeds=self.enable_prompt_embeds,
1403
            served_model_name=self.served_model_name,
1404
            language_model_only=self.language_model_only,
1405
            limit_mm_per_prompt=self.limit_mm_per_prompt,
1406
            enable_mm_embeds=self.enable_mm_embeds,
1407
            interleave_mm_strings=self.interleave_mm_strings,
1408
            media_io_kwargs=self.media_io_kwargs,
1409
            skip_mm_profiling=self.skip_mm_profiling,
1410
            config_format=self.config_format,
1411
            mm_processor_kwargs=self.mm_processor_kwargs,
1412
            mm_processor_cache_gb=self.mm_processor_cache_gb,
1413
            mm_processor_cache_type=self.mm_processor_cache_type,
1414
            mm_shm_cache_max_object_size_mb=self.mm_shm_cache_max_object_size_mb,
1415
            mm_encoder_only=self.mm_encoder_only,
1416
            mm_encoder_tp_mode=self.mm_encoder_tp_mode,
1417
            mm_encoder_attn_backend=self.mm_encoder_attn_backend,
1418
            pooler_config=self.pooler_config,
1419
            generation_config=self.generation_config,
1420
            override_generation_config=self.override_generation_config,
1421
            enable_sleep_mode=self.enable_sleep_mode,
1422
            model_impl=self.model_impl,
1423
            override_attention_dtype=self.override_attention_dtype,
1424
            logits_processors=self.logits_processors,
1425
            video_pruning_rate=self.video_pruning_rate,
1426
            io_processor_plugin=self.io_processor_plugin,
1427
        )
1428

1429
    def validate_tensorizer_args(self):
1430
1431
        from vllm.model_executor.model_loader.tensorizer import TensorizerConfig

1432
1433
        for key in self.model_loader_extra_config:
            if key in TensorizerConfig._fields:
1434
1435
1436
                self.model_loader_extra_config["tensorizer_config"][key] = (
                    self.model_loader_extra_config[key]
                )
1437

1438
    def create_load_config(self) -> LoadConfig:
1439
1440
        if self.quantization == "bitsandbytes":
            self.load_format = "bitsandbytes"
1441

1442
1443
1444
        if self.load_format == "tensorizer":
            if hasattr(self.model_loader_extra_config, "to_serializable"):
                self.model_loader_extra_config = (
1445
1446
                    self.model_loader_extra_config.to_serializable()
                )
1447
            self.model_loader_extra_config["tensorizer_config"] = {}
1448
1449
1450
            self.model_loader_extra_config["tensorizer_config"]["tensorizer_dir"] = (
                self.model
            )
1451
            self.validate_tensorizer_args()
1452

1453
1454
1455
        return LoadConfig(
            load_format=self.load_format,
            download_dir=self.download_dir,
1456
            safetensors_load_strategy=self.safetensors_load_strategy,
1457
1458
            model_loader_extra_config=self.model_loader_extra_config,
            ignore_patterns=self.ignore_patterns,
1459
            use_tqdm_on_load=self.use_tqdm_on_load,
1460
            pt_load_map_location=self.pt_load_map_location,
1461
        )
1462

1463
1464
1465
1466
    def create_speculative_config(
        self,
        target_model_config: ModelConfig,
        target_parallel_config: ParallelConfig,
1467
    ) -> SpeculativeConfig | None:
1468
1469
1470
1471
1472
1473
        """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
1474
        dictionary from the engine.
1475
1476
        """
        if self.speculative_config is None:
1477
            return None
1478

1479
1480
1481
        # Note(Shangming): These parameters are not obtained from the cli arg
        # '--speculative-config' and must be passed in when creating the engine
        # config.
1482
1483
1484
1485
1486
1487
        self.speculative_config.update(
            {
                "target_model_config": target_model_config,
                "target_parallel_config": target_parallel_config,
            }
        )
1488
        return SpeculativeConfig(**self.speculative_config)
1489

1490
1491
    def create_engine_config(
        self,
1492
        usage_context: UsageContext | None = None,
1493
        headless: bool = False,
1494
1495
1496
1497
    ) -> VllmConfig:
        """
        Create the VllmConfig.

1498
        NOTE: If VllmConfig is incompatible, we raise an error.
1499
        """
1500
        current_platform.pre_register_and_update()
1501

1502
        device_config = DeviceConfig(device=cast(Device, current_platform.device_type))
1503

1504
1505
        envs.validate_environ(self.fail_on_environ_validation)

1506
1507
        # Check if the model is a speculator and override model/tokenizer/config
        # BEFORE creating ModelConfig, so the config is created with the target model
1508
1509
1510
1511
        # 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):
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
            (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,
                )
            )

1522
        model_config = self.create_model_config()
1523
        self.model = model_config.model
1524
        self.model_weights = model_config.model_weights
1525
1526
        self.tokenizer = model_config.tokenizer

1527
        self._check_feature_supported()
1528
1529
1530
1531
        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
        )
1532

1533
        sliding_window: int | None = None
1534
1535
1536
1537
1538
1539
        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()

1540
1541
1542
1543
1544
        # 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
        )

1545
1546
1547
1548
        assert self.enable_prefix_caching is not None, (
            "enable_prefix_caching must be set by this point"
        )

1549
        cache_config = CacheConfig(
1550
            block_size=self.block_size,  # type: ignore[arg-type]
1551
            gpu_memory_utilization=self.gpu_memory_utilization,
1552
            kv_cache_memory_bytes=self.kv_cache_memory_bytes,
1553
            cache_dtype=resolved_cache_dtype,  # type: ignore[arg-type]
1554
            is_attention_free=model_config.is_attention_free,
1555
            num_gpu_blocks_override=self.num_gpu_blocks_override,
1556
            sliding_window=sliding_window,
1557
            enable_prefix_caching=self.enable_prefix_caching,
1558
            prefix_caching_hash_algo=self.prefix_caching_hash_algo,
1559
            calculate_kv_scales=self.calculate_kv_scales,
1560
            kv_sharing_fast_prefill=self.kv_sharing_fast_prefill,
1561
1562
            mamba_cache_dtype=self.mamba_cache_dtype,
            mamba_ssm_cache_dtype=self.mamba_ssm_cache_dtype,
1563
            mamba_block_size=self.mamba_block_size,
1564
            mamba_cache_mode=self.mamba_cache_mode,
1565
1566
            kv_offloading_size=self.kv_offloading_size,
            kv_offloading_backend=self.kv_offloading_backend,
1567
        )
1568

1569
1570
1571
1572
1573
1574
        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
1575

1576
            ray_runtime_env = ray.get_runtime_context().runtime_env
1577
1578
1579
1580
1581
1582
1583
            # 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)
1584

1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
        # 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()

1596
        assert not headless or not self.data_parallel_hybrid_lb, (
1597
1598
            "data_parallel_hybrid_lb is not applicable in headless mode"
        )
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
        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
        )
1640
        # Local DP rank = 1, use pure-external LB.
1641
        if data_parallel_external_lb:
1642
            assert self.data_parallel_rank is not None, (
1643
                "data_parallel_rank or node_rank must be specified if "
1644
1645
                "data_parallel_external_lb is enable."
            )
1646
            assert self.data_parallel_size_local in (1, None), (
1647
1648
                "data_parallel_size_local must be 1 or None when data_parallel_rank "
                "is set"
1649
            )
1650
            data_parallel_size_local = 1
1651
1652
            # Use full external lb if we have local_size of 1.
            self.data_parallel_hybrid_lb = False
1653
1654
        elif self.data_parallel_size_local is not None:
            data_parallel_size_local = self.data_parallel_size_local
1655
1656
1657
1658
1659
1660
1661

            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.
1662
1663
1664
1665
1666
                logger.warning(
                    "data_parallel_hybrid_lb is not eligible when "
                    "data_parallel_size_local = 1, autoswitch to "
                    "data_parallel_external_lb."
                )
1667
1668
1669
1670
1671
1672
1673
                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

1674
1675
1676
1677
1678
1679
1680
1681
1682
            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,
                )
1683
        else:
1684
            assert not self.data_parallel_hybrid_lb, (
1685
1686
                "data_parallel_size_local must be set to use data_parallel_hybrid_lb."
            )
1687

1688
1689
1690
1691
1692
1693
1694
1695
1696
            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
1697
1698
1699

        # DP address, used in multi-node case for torch distributed group
        # and ZMQ sockets.
Rui Qiao's avatar
Rui Qiao committed
1700
1701
1702
1703
        if self.data_parallel_address is None:
            if self.data_parallel_backend == "ray":
                host_ip = get_ip()
                logger.info(
1704
1705
                    "Using host IP %s as ray-based data parallel address", host_ip
                )
Rui Qiao's avatar
Rui Qiao committed
1706
1707
1708
1709
                data_parallel_address = host_ip
            else:
                assert self.data_parallel_backend == "mp", (
                    "data_parallel_backend can only be ray or mp, got %s",
1710
1711
                    self.data_parallel_backend,
                )
1712
1713
1714
                data_parallel_address = (
                    self.master_addr or ParallelConfig.data_parallel_master_ip
                )
Rui Qiao's avatar
Rui Qiao committed
1715
1716
        else:
            data_parallel_address = self.data_parallel_address
1717
1718
1719

        # This port is only used when there are remote data parallel engines,
        # otherwise the local IPC transport is used.
1720
        data_parallel_rpc_port = (
1721
            self.data_parallel_rpc_port
1722
1723
1724
            if (self.data_parallel_rpc_port is not None)
            else ParallelConfig.data_parallel_rpc_port
        )
1725

1726
1727
1728
1729
        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.")

1730
        parallel_config = ParallelConfig(
1731
1732
            pipeline_parallel_size=self.pipeline_parallel_size,
            tensor_parallel_size=self.tensor_parallel_size,
1733
            prefill_context_parallel_size=self.prefill_context_parallel_size,
1734
            data_parallel_size=self.data_parallel_size,
1735
1736
            data_parallel_rank=self.data_parallel_rank or 0,
            data_parallel_external_lb=data_parallel_external_lb,
1737
            data_parallel_size_local=data_parallel_size_local,
1738
1739
1740
1741
            master_addr=self.master_addr,
            master_port=self.master_port,
            nnodes=self.nnodes,
            node_rank=self.node_rank,
1742
            distributed_timeout_seconds=self.distributed_timeout_seconds,
1743
1744
            data_parallel_master_ip=data_parallel_address,
            data_parallel_rpc_port=data_parallel_rpc_port,
1745
            data_parallel_backend=self.data_parallel_backend,
1746
            data_parallel_hybrid_lb=self.data_parallel_hybrid_lb,
1747
            is_moe_model=model_config.is_moe,
1748
            enable_expert_parallel=self.enable_expert_parallel,
1749
            enable_ep_weight_filter=self.enable_ep_weight_filter,
1750
            all2all_backend=self.all2all_backend,
1751
            enable_elastic_ep=self.enable_elastic_ep,
1752
            enable_dbo=self.enable_dbo,
1753
            ubatch_size=self.ubatch_size,
1754
            dbo_decode_token_threshold=self.dbo_decode_token_threshold,
1755
            dbo_prefill_token_threshold=self.dbo_prefill_token_threshold,
1756
            disable_nccl_for_dp_synchronization=self.disable_nccl_for_dp_synchronization,
1757
            enable_eplb=self.enable_eplb,
1758
            eplb_config=self.eplb_config,
1759
            expert_placement_strategy=self.expert_placement_strategy,
1760
1761
1762
            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,
1763
            ray_runtime_env=ray_runtime_env,
1764
            placement_group=placement_group,
1765
1766
            distributed_executor_backend=self.distributed_executor_backend,
            worker_cls=self.worker_cls,
1767
            worker_extension_cls=self.worker_extension_cls,
1768
            decode_context_parallel_size=self.decode_context_parallel_size,
1769
            dcp_comm_backend=self.dcp_comm_backend,
1770
            dcp_kv_cache_interleave_size=self.dcp_kv_cache_interleave_size,
1771
            cp_kv_cache_interleave_size=self.cp_kv_cache_interleave_size,
1772
1773
            _api_process_count=self._api_process_count,
            _api_process_rank=self._api_process_rank,
1774
        )
1775

1776
        speculative_config = self.create_speculative_config(
1777
1778
1779
1780
            target_model_config=model_config,
            target_parallel_config=parallel_config,
        )

1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
        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"
        )
1791
        scheduler_config = SchedulerConfig(
1792
            runner_type=model_config.runner_type,
1793
1794
1795
            max_num_batched_tokens=self.max_num_batched_tokens,
            max_num_seqs=self.max_num_seqs,
            max_model_len=model_config.max_model_len,
1796
            enable_chunked_prefill=self.enable_chunked_prefill,
1797
            disable_chunked_mm_input=self.disable_chunked_mm_input,
1798
            is_multimodal_model=model_config.is_multimodal_model,
1799
            is_encoder_decoder=model_config.is_encoder_decoder,
1800
            policy=self.scheduling_policy,
1801
            scheduler_cls=self.scheduler_cls,
1802
1803
1804
            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,
1805
            disable_hybrid_kv_cache_manager=self.disable_hybrid_kv_cache_manager,
1806
            async_scheduling=self.async_scheduling,
1807
            stream_interval=self.stream_interval,
1808
        )
1809

1810
1811
1812
        if not model_config.is_multimodal_model and self.default_mm_loras:
            raise ValueError(
                "Default modality-specific LoRA(s) were provided for a "
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
                "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,
1823
                target_modules=self.lora_target_modules,
1824
                enable_tower_connector_lora=self.enable_tower_connector_lora,
1825
                specialize_active_lora=self.specialize_active_lora,
1826
1827
1828
1829
1830
1831
1832
                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
        )
1833

1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
        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"
            )

1848
1849
1850
1851
        # bitsandbytes pre-quantized model need a specific model loader
        if model_config.quantization == "bitsandbytes":
            self.quantization = self.load_format = "bitsandbytes"

1852
1853
1854
1855
1856
1857
1858
1859
        # 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"
                )
1860
1861
1862
1863
            # Reuse the validator to handle "auto" and string-to-enum conversion
            attention_config.backend = AttentionConfig.validate_backend_before(
                self.attention_backend
            )
1864

1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
        # 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
1875
1876
        if self.moe_backend != "auto":
            kernel_config.moe_backend = self.moe_backend
1877

1878
        load_config = self.create_load_config()
1879

1880
1881
        # Pass reasoning_parser into StructuredOutputsConfig
        if self.reasoning_parser:
1882
            self.structured_outputs_config.reasoning_parser = self.reasoning_parser
1883

1884
1885
1886
1887
1888
        if self.reasoning_parser_plugin:
            self.structured_outputs_config.reasoning_parser_plugin = (
                self.reasoning_parser_plugin
            )

1889
        observability_config = ObservabilityConfig(
1890
            show_hidden_metrics_for_version=self.show_hidden_metrics_for_version,
1891
            otlp_traces_endpoint=self.otlp_traces_endpoint,
1892
            collect_detailed_traces=self.collect_detailed_traces,
1893
1894
            kv_cache_metrics=self.kv_cache_metrics,
            kv_cache_metrics_sample=self.kv_cache_metrics_sample,
1895
            cudagraph_metrics=self.cudagraph_metrics,
1896
            enable_layerwise_nvtx_tracing=self.enable_layerwise_nvtx_tracing,
1897
            enable_mfu_metrics=self.enable_mfu_metrics,
1898
            enable_mm_processor_stats=self.enable_mm_processor_stats,
1899
            enable_logging_iteration_details=self.enable_logging_iteration_details,
1900
        )
1901

1902
        # Compilation config overrides
1903
        compilation_config = copy.deepcopy(self.compilation_config)
1904
        if self.cudagraph_capture_sizes is not None:
1905
            if compilation_config.cudagraph_capture_sizes is not None:
1906
1907
1908
1909
                raise ValueError(
                    "cudagraph_capture_sizes and compilation_config."
                    "cudagraph_capture_sizes are mutually exclusive"
                )
1910
            compilation_config.cudagraph_capture_sizes = self.cudagraph_capture_sizes
1911
        if self.max_cudagraph_capture_size is not None:
1912
            if compilation_config.max_cudagraph_capture_size is not None:
1913
1914
1915
1916
                raise ValueError(
                    "max_cudagraph_capture_size and compilation_config."
                    "max_cudagraph_capture_size are mutually exclusive"
                )
1917
            compilation_config.max_cudagraph_capture_size = (
1918
1919
                self.max_cudagraph_capture_size
            )
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934

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

1935
1936
1937
        if self.gdn_prefill_backend is not None:
            self.additional_config["gdn_prefill_backend"] = self.gdn_prefill_backend

1938
        config = VllmConfig(
1939
1940
1941
1942
1943
            model_config=model_config,
            cache_config=cache_config,
            parallel_config=parallel_config,
            scheduler_config=scheduler_config,
            device_config=device_config,
1944
            load_config=load_config,
1945
            offload_config=offload_config,
1946
            attention_config=attention_config,
1947
            kernel_config=kernel_config,
1948
1949
            lora_config=lora_config,
            speculative_config=speculative_config,
1950
            structured_outputs_config=self.structured_outputs_config,
1951
            observability_config=observability_config,
1952
            compilation_config=compilation_config,
1953
            kv_transfer_config=self.kv_transfer_config,
1954
            kv_events_config=self.kv_events_config,
1955
            ec_transfer_config=self.ec_transfer_config,
1956
            profiler_config=self.profiler_config,
1957
            additional_config=self.additional_config,
1958
            optimization_level=self.optimization_level,
1959
            performance_mode=self.performance_mode,
1960
            weight_transfer_config=self.weight_transfer_config,
1961
            shutdown_timeout=self.shutdown_timeout,
1962
        )
1963

1964
1965
        return config

1966
    def _check_feature_supported(self):
1967
        """Raise an error if the feature is not supported."""
1968
        # No Concurrent Partial Prefills so far.
1969
1970
1971
1972
1973
        if (
            self.max_num_partial_prefills != SchedulerConfig.max_num_partial_prefills
            or self.max_long_partial_prefills
            != SchedulerConfig.max_long_partial_prefills
        ):
1974
            _raise_unsupported_error(feature_name="Concurrent Partial Prefill")
1975

1976
        if self.pipeline_parallel_size > 1:
1977
1978
1979
            supports_pp = getattr(
                self.distributed_executor_backend, "supports_pp", False
            )
1980
            if not supports_pp and self.distributed_executor_backend not in (
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
                ParallelConfig.distributed_executor_backend,
                "ray",
                "mp",
                "external_launcher",
            ):
                name = (
                    "Pipeline Parallelism without Ray distributed "
                    "executor or multiprocessing executor or external "
                    "launcher"
                )
1991
                _raise_unsupported_error(feature_name=name)
1992

1993
1994
1995
1996
1997
1998
    @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
1999

2000
2001
        default_max_num_batched_tokens: dict[UsageContext | None, int]
        default_max_num_seqs: dict[UsageContext | None, int]
2002

2003
2004
        # When no user override, set the default values based on the usage
        # context.
2005
        # Use different default values for different hardware.
2006
2007
2008
2009
2010
2011
2012

        # 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:
2013
            device_memory = current_platform.get_device_total_memory()
2014
            device_name = current_platform.get_device_name().lower()
2015
2016
        except Exception:
            # This is only used to set default_max_num_batched_tokens
2017
            device_memory = 0
2018
            device_name = ""
2019

2020
2021
2022
2023
        # 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:
2024
            # For GPUs like H100 and MI300x, use larger default values.
2025
2026
2027
2028
            default_max_num_batched_tokens = {
                UsageContext.LLM_CLASS: 16384,
                UsageContext.OPENAI_API_SERVER: 8192,
            }
2029
2030
2031
2032
            default_max_num_seqs = {
                UsageContext.LLM_CLASS: 1024,
                UsageContext.OPENAI_API_SERVER: 1024,
            }
2033
2034
2035
2036
2037
2038
        else:
            # TODO(woosuk): Tune the default values for other hardware.
            default_max_num_batched_tokens = {
                UsageContext.LLM_CLASS: 8192,
                UsageContext.OPENAI_API_SERVER: 2048,
            }
2039
2040
2041
2042
            default_max_num_seqs = {
                UsageContext.LLM_CLASS: 256,
                UsageContext.OPENAI_API_SERVER: 256,
            }
2043

2044
2045
        # tpu specific default values.
        if current_platform.is_tpu():
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
            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,
                }
2063

2064
2065
2066
        # cpu specific default values.
        if current_platform.is_cpu():
            default_max_num_batched_tokens = {
2067
2068
                UsageContext.LLM_CLASS: 4096 * world_size,
                UsageContext.OPENAI_API_SERVER: 2048 * world_size,
2069
2070
            }
            default_max_num_seqs = {
2071
2072
                UsageContext.LLM_CLASS: 256 * world_size,
                UsageContext.OPENAI_API_SERVER: 128 * world_size,
2073
2074
            }

2075
2076
        return default_max_num_batched_tokens, default_max_num_seqs

2077
2078
    def _set_default_chunked_prefill_and_prefix_caching_args(
        self, model_config: ModelConfig
2079
    ) -> None:
2080
2081
        default_chunked_prefill = model_config.is_chunked_prefill_supported
        default_prefix_caching = model_config.is_prefix_caching_supported
2082
2083
2084
2085
2086
2087
2088
2089

        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",
            )
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
        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",
            )
2101
2102
2103
2104
        elif (
            model_config.runner_type == "pooling"
            and self.enable_chunked_prefill
            and not default_chunked_prefill
2105
        ):
2106
            logger.warning_once(
2107
2108
2109
                "This model does not officially support chunked prefill. "
                "Enabling this manually may cause the engine to crash "
                "or produce incorrect outputs.",
2110
                scope="local",
2111
2112
2113
2114
2115
            )

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

2116
            logger.debug(
2117
2118
2119
2120
2121
2122
2123
2124
                "%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
        ):
2125
            logger.warning_once(
2126
2127
2128
                "This model does not officially support prefix caching. "
                "Enabling this manually may cause the engine to crash "
                "or produce incorrect outputs.",
2129
                scope="local",
2130
2131
            )

2132
        # Disable chunked prefill and prefix caching for:
2133
        # RISCV CPUs in V1
2134
2135
2136
2137
        if current_platform.is_cpu() and current_platform.get_cpu_architecture() in (
            CpuArchEnum.RISCV,
        ):
            logger.info(
2138
2139
                "Chunked prefill is not supported for"
                "RISC-V CPUs; "
2140
2141
2142
2143
                "disabling it for V1 backend."
            )
            self.enable_chunked_prefill = False
            logger.info(
2144
2145
                "Prefix caching is not supported for "
                "RISC-V CPUs; "
2146
2147
2148
2149
2150
                "disabling it for V1 backend."
            )
            self.enable_prefix_caching = False

    def _set_default_max_num_seqs_and_batched_tokens_args(
2151
2152
2153
        self,
        usage_context: UsageContext | None,
        model_config: ModelConfig,
2154
    ):
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
        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,
            )

2176
2177
2178
2179
2180
2181
2182
        # 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

2183
        if orig_max_num_batched_tokens is None:
2184
2185
2186
            assert model_config.max_model_len is not None, (
                "max_model_len must be set by this point"
            )
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
            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,
2199
2200
                self.max_num_batched_tokens,
            )
2201

2202
2203
2204
2205
            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,
2206
            )
2207

2208
2209
2210
2211
        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)

2212
            logger.debug(
2213
                "Defaulting max_num_seqs to %d for %s usage context.",
2214
                self.max_num_seqs,
2215
                usage_context.value if usage_context else None,
2216
            )
2217

2218

2219
@dataclass
Zhuohan Li's avatar
Zhuohan Li committed
2220
class AsyncEngineArgs(EngineArgs):
Woosuk Kwon's avatar
Woosuk Kwon committed
2221
    """Arguments for asynchronous vLLM engine."""
2222

2223
2224
    enable_log_requests: bool = False

2225
    @staticmethod
2226
2227
2228
    def add_cli_args(
        parser: FlexibleArgumentParser, async_args_only: bool = False
    ) -> FlexibleArgumentParser:
2229
        # Initialize plugin to update the parser, for example, The plugin may
2230
        # add a new kind of quantization method to --quantization argument or
2231
2232
        # a new device to --device argument.
        load_general_plugins()
2233
2234
        if not async_args_only:
            parser = EngineArgs.add_cli_args(parser)
2235
2236
2237
2238
        parser.add_argument(
            "--enable-log-requests",
            action=argparse.BooleanOptionalAction,
            default=AsyncEngineArgs.enable_log_requests,
2239
            help="Enable logging request information, dependent on log level:\n"
2240
2241
2242
            "- INFO: Request ID, parameters and LoRA request.\n"
            "- DEBUG: Prompt inputs (e.g: text, token IDs).\n"
            "You can set the minimum log level via `VLLM_LOGGING_LEVEL`.",
2243
        )
2244
        current_platform.pre_register_and_update(parser)
2245
        return parser
2246
2247


2248
2249
2250
2251
2252
2253
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)
2254
2255


2256
def human_readable_int(value: str) -> int:
2257
2258
    """Parse human-readable integers like '1k', '2M', etc.
    Including decimal values with decimal multipliers.
2259

2260
2261
2262
2263
2264
2265
    Examples:
    - '1k' -> 1,000
    - '1K' -> 1,024
    - '25.6k' -> 25,600
    """
    value = value.strip()
2266

2267
    match = re.fullmatch(r"(\d+(?:\.\d+)?)([kKmMgGtT])", value)
2268
2269
    if match:
        decimal_multiplier = {
2270
2271
2272
            "k": 10**3,
            "m": 10**6,
            "g": 10**9,
2273
            "t": 10**12,
2274
2275
        }
        binary_multiplier = {
2276
2277
2278
            "K": 2**10,
            "M": 2**20,
            "G": 2**30,
2279
            "T": 2**40,
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
        }

        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:
2292
2293
2294
2295
2296
                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
2297
2298
2299

    # Regular plain number.
    return int(value)
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318


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)