arg_utils.py 94.8 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
from vllm.config.multimodal import MMCacheType, MMEncoderTPMode, MMTensorIPC
83
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
    mm_tensor_ipc: MMTensorIPC = MultiModalConfig.mm_tensor_ipc
513
    # LoRA fields
514
    enable_lora: bool = False
515
    max_loras: int = LoRAConfig.max_loras
516
    max_lora_rank: MaxLoRARanks = LoRAConfig.max_lora_rank
517
    default_mm_loras: dict[str, str] | None = LoRAConfig.default_mm_loras
518
    fully_sharded_loras: bool = LoRAConfig.fully_sharded_loras
519
520
    max_cpu_loras: int | None = LoRAConfig.max_cpu_loras
    lora_dtype: str | torch.dtype | None = LoRAConfig.lora_dtype
521
    lora_target_modules: list[str] | None = LoRAConfig.target_modules
522
    enable_tower_connector_lora: bool = LoRAConfig.enable_tower_connector_lora
523
    specialize_active_lora: bool = LoRAConfig.specialize_active_lora
524

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

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

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

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

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

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

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

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

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

583
584
    ec_transfer_config: ECTransferConfig | None = None

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

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

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

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

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

610
    async_scheduling: bool | None = SchedulerConfig.async_scheduling
611

612
613
    stream_interval: int = SchedulerConfig.stream_interval

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

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

622
623
    shutdown_timeout: int = 0

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

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

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

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

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

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

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

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

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

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

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

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

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

1098
        multimodal_group.add_argument(
1099
1100
            "--video-pruning-rate", **multimodal_kwargs["video_pruning_rate"]
        )
1101
1102
1103
        multimodal_group.add_argument(
            "--mm-tensor-ipc", **multimodal_kwargs["mm_tensor_ipc"]
        )
1104

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

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

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

1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
        # 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"],
        )

1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
        # 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"],
        )
1270
1271
1272
        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)
1273

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

1316
        # Other arguments
1317
1318
1319
1320
1321
        parser.add_argument(
            "--disable-log-stats",
            action="store_true",
            help="Disable logging statistics.",
        )
1322

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

        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,
        )
1337
1338
1339
1340
1341
1342
1343
1344

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

1345
1346
1347
1348
1349
1350
1351
        parser.add_argument(
            "--gdn-prefill-backend",
            dest="gdn_prefill_backend",
            choices=["flashinfer", "triton"],
            default=None,
            help="Select GDN prefill backend.",
        )
1352
        return parser
1353
1354

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

1364
    def create_model_config(self) -> ModelConfig:
1365
1366
        # gguf file needs a specific model loader
        if is_gguf(self.model):
1367
1368
            self.quantization = self.load_format = "gguf"

1369
1370
1371
1372
1373
1374
1375
        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,
1376
1377
            )

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

1434
    def validate_tensorizer_args(self):
1435
1436
        from vllm.model_executor.model_loader.tensorizer import TensorizerConfig

1437
1438
        for key in self.model_loader_extra_config:
            if key in TensorizerConfig._fields:
1439
1440
1441
                self.model_loader_extra_config["tensorizer_config"][key] = (
                    self.model_loader_extra_config[key]
                )
1442

1443
    def create_load_config(self) -> LoadConfig:
1444
1445
        if self.quantization == "bitsandbytes":
            self.load_format = "bitsandbytes"
1446

1447
1448
1449
        if self.load_format == "tensorizer":
            if hasattr(self.model_loader_extra_config, "to_serializable"):
                self.model_loader_extra_config = (
1450
1451
                    self.model_loader_extra_config.to_serializable()
                )
1452
            self.model_loader_extra_config["tensorizer_config"] = {}
1453
1454
1455
            self.model_loader_extra_config["tensorizer_config"]["tensorizer_dir"] = (
                self.model
            )
1456
            self.validate_tensorizer_args()
1457

1458
1459
1460
        return LoadConfig(
            load_format=self.load_format,
            download_dir=self.download_dir,
1461
            safetensors_load_strategy=self.safetensors_load_strategy,
1462
1463
            model_loader_extra_config=self.model_loader_extra_config,
            ignore_patterns=self.ignore_patterns,
1464
            use_tqdm_on_load=self.use_tqdm_on_load,
1465
            pt_load_map_location=self.pt_load_map_location,
1466
        )
1467

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

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

1495
1496
    def create_engine_config(
        self,
1497
        usage_context: UsageContext | None = None,
1498
        headless: bool = False,
1499
1500
1501
1502
    ) -> VllmConfig:
        """
        Create the VllmConfig.

1503
        NOTE: If VllmConfig is incompatible, we raise an error.
1504
        """
1505
        current_platform.pre_register_and_update()
1506

1507
        device_config = DeviceConfig(device=cast(Device, current_platform.device_type))
1508

1509
1510
        envs.validate_environ(self.fail_on_environ_validation)

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

1527
        model_config = self.create_model_config()
1528
        self.model = model_config.model
1529
        self.model_weights = model_config.model_weights
1530
1531
        self.tokenizer = model_config.tokenizer

1532
        self._check_feature_supported()
1533
1534
1535
1536
        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
        )
1537

1538
        sliding_window: int | None = None
1539
1540
1541
1542
1543
1544
        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()

1545
1546
1547
1548
1549
        # 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
        )

1550
1551
1552
1553
        assert self.enable_prefix_caching is not None, (
            "enable_prefix_caching must be set by this point"
        )

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

1574
1575
1576
1577
1578
1579
        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
1580

1581
            ray_runtime_env = ray.get_runtime_context().runtime_env
1582
1583
1584
1585
1586
1587
1588
            # 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)
1589

1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
        # 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()

1601
        assert not headless or not self.data_parallel_hybrid_lb, (
1602
1603
            "data_parallel_hybrid_lb is not applicable in headless mode"
        )
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
1640
1641
1642
1643
1644
        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
        )
1645
        # Local DP rank = 1, use pure-external LB.
1646
        if data_parallel_external_lb:
1647
            assert self.data_parallel_rank is not None, (
1648
                "data_parallel_rank or node_rank must be specified if "
1649
1650
                "data_parallel_external_lb is enable."
            )
1651
            assert self.data_parallel_size_local in (1, None), (
1652
1653
                "data_parallel_size_local must be 1 or None when data_parallel_rank "
                "is set"
1654
            )
1655
            data_parallel_size_local = 1
1656
1657
            # Use full external lb if we have local_size of 1.
            self.data_parallel_hybrid_lb = False
1658
1659
        elif self.data_parallel_size_local is not None:
            data_parallel_size_local = self.data_parallel_size_local
1660
1661
1662
1663
1664
1665
1666

            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.
1667
1668
1669
1670
1671
                logger.warning(
                    "data_parallel_hybrid_lb is not eligible when "
                    "data_parallel_size_local = 1, autoswitch to "
                    "data_parallel_external_lb."
                )
1672
1673
1674
1675
1676
1677
1678
                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

1679
1680
1681
1682
1683
1684
1685
1686
1687
            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,
                )
1688
        else:
1689
            assert not self.data_parallel_hybrid_lb, (
1690
1691
                "data_parallel_size_local must be set to use data_parallel_hybrid_lb."
            )
1692

1693
1694
1695
1696
1697
1698
1699
1700
1701
            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
1702
1703
1704

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

        # This port is only used when there are remote data parallel engines,
        # otherwise the local IPC transport is used.
1725
        data_parallel_rpc_port = (
1726
            self.data_parallel_rpc_port
1727
1728
1729
            if (self.data_parallel_rpc_port is not None)
            else ParallelConfig.data_parallel_rpc_port
        )
1730

1731
1732
1733
1734
        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.")

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

1781
        speculative_config = self.create_speculative_config(
1782
1783
1784
1785
            target_model_config=model_config,
            target_parallel_config=parallel_config,
        )

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

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

1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
        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"
            )

1853
1854
1855
1856
        # bitsandbytes pre-quantized model need a specific model loader
        if model_config.quantization == "bitsandbytes":
            self.quantization = self.load_format = "bitsandbytes"

1857
1858
1859
1860
1861
1862
1863
1864
        # 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"
                )
1865
1866
1867
1868
            # Reuse the validator to handle "auto" and string-to-enum conversion
            attention_config.backend = AttentionConfig.validate_backend_before(
                self.attention_backend
            )
1869

1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
        # 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
1880
1881
        if self.moe_backend != "auto":
            kernel_config.moe_backend = self.moe_backend
1882

1883
        load_config = self.create_load_config()
1884

1885
1886
        # Pass reasoning_parser into StructuredOutputsConfig
        if self.reasoning_parser:
1887
            self.structured_outputs_config.reasoning_parser = self.reasoning_parser
1888

1889
1890
1891
1892
1893
        if self.reasoning_parser_plugin:
            self.structured_outputs_config.reasoning_parser_plugin = (
                self.reasoning_parser_plugin
            )

1894
        observability_config = ObservabilityConfig(
1895
            show_hidden_metrics_for_version=self.show_hidden_metrics_for_version,
1896
            otlp_traces_endpoint=self.otlp_traces_endpoint,
1897
            collect_detailed_traces=self.collect_detailed_traces,
1898
1899
            kv_cache_metrics=self.kv_cache_metrics,
            kv_cache_metrics_sample=self.kv_cache_metrics_sample,
1900
            cudagraph_metrics=self.cudagraph_metrics,
1901
            enable_layerwise_nvtx_tracing=self.enable_layerwise_nvtx_tracing,
1902
            enable_mfu_metrics=self.enable_mfu_metrics,
1903
            enable_mm_processor_stats=self.enable_mm_processor_stats,
1904
            enable_logging_iteration_details=self.enable_logging_iteration_details,
1905
        )
1906

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

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

1940
1941
1942
        if self.gdn_prefill_backend is not None:
            self.additional_config["gdn_prefill_backend"] = self.gdn_prefill_backend

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

1969
1970
        return config

1971
    def _check_feature_supported(self):
1972
        """Raise an error if the feature is not supported."""
1973
        # No Concurrent Partial Prefills so far.
1974
1975
1976
1977
1978
        if (
            self.max_num_partial_prefills != SchedulerConfig.max_num_partial_prefills
            or self.max_long_partial_prefills
            != SchedulerConfig.max_long_partial_prefills
        ):
1979
            _raise_unsupported_error(feature_name="Concurrent Partial Prefill")
1980

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

1998
1999
2000
2001
2002
2003
    @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
2004

2005
2006
        default_max_num_batched_tokens: dict[UsageContext | None, int]
        default_max_num_seqs: dict[UsageContext | None, int]
2007

2008
2009
        # When no user override, set the default values based on the usage
        # context.
2010
        # Use different default values for different hardware.
2011
2012
2013
2014
2015
2016
2017

        # 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:
2018
            device_memory = current_platform.get_device_total_memory()
2019
            device_name = current_platform.get_device_name().lower()
2020
2021
        except Exception:
            # This is only used to set default_max_num_batched_tokens
2022
            device_memory = 0
2023
            device_name = ""
2024

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

2049
2050
        # tpu specific default values.
        if current_platform.is_tpu():
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
            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,
                }
2068

2069
2070
2071
        # cpu specific default values.
        if current_platform.is_cpu():
            default_max_num_batched_tokens = {
2072
2073
                UsageContext.LLM_CLASS: 4096 * world_size,
                UsageContext.OPENAI_API_SERVER: 2048 * world_size,
2074
2075
            }
            default_max_num_seqs = {
2076
2077
                UsageContext.LLM_CLASS: 256 * world_size,
                UsageContext.OPENAI_API_SERVER: 128 * world_size,
2078
2079
            }

2080
2081
        return default_max_num_batched_tokens, default_max_num_seqs

2082
2083
    def _set_default_chunked_prefill_and_prefix_caching_args(
        self, model_config: ModelConfig
2084
    ) -> None:
2085
2086
        default_chunked_prefill = model_config.is_chunked_prefill_supported
        default_prefix_caching = model_config.is_prefix_caching_supported
2087
2088
2089
2090
2091
2092
2093
2094

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

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

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

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

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

2181
2182
2183
2184
2185
2186
2187
        # 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

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

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

2213
2214
2215
2216
        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)

2217
            logger.debug(
2218
                "Defaulting max_num_seqs to %d for %s usage context.",
2219
                self.max_num_seqs,
2220
                usage_context.value if usage_context else None,
2221
            )
2222

2223

2224
@dataclass
Zhuohan Li's avatar
Zhuohan Li committed
2225
class AsyncEngineArgs(EngineArgs):
Woosuk Kwon's avatar
Woosuk Kwon committed
2226
    """Arguments for asynchronous vLLM engine."""
2227

2228
2229
    enable_log_requests: bool = False

2230
    @staticmethod
2231
2232
2233
    def add_cli_args(
        parser: FlexibleArgumentParser, async_args_only: bool = False
    ) -> FlexibleArgumentParser:
2234
        # Initialize plugin to update the parser, for example, The plugin may
2235
        # add a new kind of quantization method to --quantization argument or
2236
2237
        # a new device to --device argument.
        load_general_plugins()
2238
2239
        if not async_args_only:
            parser = EngineArgs.add_cli_args(parser)
2240
2241
2242
2243
        parser.add_argument(
            "--enable-log-requests",
            action=argparse.BooleanOptionalAction,
            default=AsyncEngineArgs.enable_log_requests,
2244
            help="Enable logging request information, dependent on log level:\n"
2245
2246
2247
            "- 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`.",
2248
        )
2249
        current_platform.pre_register_and_update(parser)
2250
        return parser
2251
2252


2253
2254
2255
2256
2257
2258
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)
2259
2260


2261
def human_readable_int(value: str) -> int:
2262
2263
    """Parse human-readable integers like '1k', '2M', etc.
    Including decimal values with decimal multipliers.
2264

2265
2266
2267
2268
2269
2270
    Examples:
    - '1k' -> 1,000
    - '1K' -> 1,024
    - '25.6k' -> 25,600
    """
    value = value.strip()
2271

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

        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:
2297
2298
2299
2300
2301
                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
2302
2303
2304

    # Regular plain number.
    return int(value)
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323


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)