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

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

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

34
import vllm.envs as envs
35
from vllm.attention.backends.registry import _Backend
36
37
38
39
40
41
42
43
44
45
46
from vllm.config import (
    CacheConfig,
    CompilationConfig,
    ConfigType,
    DeviceConfig,
    EPLBConfig,
    KVEventsConfig,
    KVTransferConfig,
    LoadConfig,
    LoRAConfig,
    ModelConfig,
47
    MultiModalConfig,
48
49
50
51
52
53
54
55
56
    ObservabilityConfig,
    ParallelConfig,
    PoolerConfig,
    SchedulerConfig,
    SpeculativeConfig,
    StructuredOutputsConfig,
    VllmConfig,
    get_attr_docs,
)
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
from vllm.config.cache import BlockSize, CacheDType, MambaDType, PrefixCachingHashAlgo
from vllm.config.device import Device
from vllm.config.model import (
    ConvertOption,
    HfOverrides,
    LogprobsMode,
    ModelDType,
    RunnerOption,
    TaskOption,
    TokenizerMode,
)
from vllm.config.multimodal import MMCacheType, MMEncoderTPMode
from vllm.config.observability import DetailedTraceModules
from vllm.config.parallel import DistributedExecutorBackend, ExpertPlacementStrategy
from vllm.config.scheduler import SchedulerPolicy
72
from vllm.config.utils import get_field
73
from vllm.logger import init_logger
74
from vllm.platforms import CpuArchEnum, current_platform
75
from vllm.plugins import load_general_plugins
76
from vllm.ray.lazy_utils import is_in_ray_actor, is_ray_initialized
77
from vllm.reasoning import ReasoningParserManager
78
from vllm.test_utils import MODEL_WEIGHTS_S3_BUCKET, MODELS_ON_S3
79
80
81
82
83
from vllm.transformers_utils.config import (
    get_model_path,
    is_interleaved,
    maybe_override_with_speculators,
)
84
from vllm.transformers_utils.utils import check_gguf_file
85
from vllm.utils.argparse_utils import FlexibleArgumentParser
86
from vllm.utils.mem_constants import GiB_bytes
87
from vllm.utils.network_utils import get_ip
88
from vllm.v1.sample.logits_processor import LogitsProcessor
89

90
91
if TYPE_CHECKING:
    from vllm.model_executor.layers.quantization import QuantizationMethods
92
    from vllm.model_executor.model_loader import LoadFormats
93
    from vllm.usage.usage_lib import UsageContext
94
    from vllm.v1.executor import Executor
95
else:
96
    Executor = Any
97
    QuantizationMethods = Any
98
    LoadFormats = Any
99
100
    UsageContext = Any

101
102
logger = init_logger(__name__)

103
104
# object is used to allow for special typing forms
T = TypeVar("T")
105
106
TypeHint: TypeAlias = type[Any] | object
TypeHintT: TypeAlias = type[T] | object
107

108

109
110
def parse_type(return_type: Callable[[str], T]) -> Callable[[str], T]:
    def _parse_type(val: str) -> T:
111
112
113
114
        try:
            return return_type(val)
        except ValueError as e:
            raise argparse.ArgumentTypeError(
115
116
                f"Value {val} cannot be converted to {return_type}."
            ) from e
117

118
119
120
    return _parse_type


121
122
def optional_type(return_type: Callable[[str], T]) -> Callable[[str], T | None]:
    def _optional_type(val: str) -> T | None:
123
124
125
126
        if val == "" or val == "None":
            return None
        return parse_type(return_type)(val)

127
    return _optional_type
128
129


130
def union_dict_and_str(val: str) -> str | dict[str, str] | None:
131
    if not re.match(r"(?s)^\s*{.*}\s*$", val):
132
        return str(val)
133
    return optional_type(json.loads)(val)
134
135


136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
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)


151
def literal_to_kwargs(type_hints: set[TypeHint]) -> dict[str, Any]:
152
153
154
155
    """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`.
    """
156
    type_hint = get_type(type_hints, Literal)
157
158
159
    options = get_args(type_hint)
    option_type = type(options[0])
    if not all(isinstance(option, option_type) for option in options):
160
        raise ValueError(
161
            "All options must be of the same type. "
162
163
            f"Got {options} with types {[type(c) for c in options]}"
        )
164
165
    kwarg = "metavar" if contains_type(type_hints, str) else "choices"
    return {"type": option_type, kwarg: sorted(options)}
166
167


168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
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),
    }


193
194
195
196
197
def is_not_builtin(type_hint: TypeHint) -> bool:
    """Check if the class is not a built-in type."""
    return type_hint.__module__ != "builtins"


198
199
200
201
202
203
204
205
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]))
206
207
    elif origin in {Union, UnionType}:
        # Union for Union[X, Y] and UnionType for X | Y
208
209
210
211
212
213
214
215
        for arg in args:
            type_hints.update(get_type_hints(arg))
    else:
        type_hints.add(type_hint)

    return type_hints


216
217
218
219
def is_online_quantization(quantization: Any) -> bool:
    return quantization in ["inc"]


220
NEEDS_HELP = (
221
222
    any("--help" in arg for arg in sys.argv)  # vllm SUBCOMMAND --help
    or (argv0 := sys.argv[0]).endswith("mkdocs")  # mkdocs SUBCOMMAND
223
224
225
226
    or argv0.endswith("mkdocs/__main__.py")  # python -m mkdocs SUBCOMMAND
)


227
@functools.lru_cache(maxsize=30)
228
def _compute_kwargs(cls: ConfigType) -> dict[str, dict[str, Any]]:
229
230
    # Save time only getting attr docs if we're generating help text
    cls_docs = get_attr_docs(cls) if NEEDS_HELP else {}
231
232
    kwargs = {}
    for field in fields(cls):
233
        # Get the set of possible types for the field
234
        type_hints: set[TypeHint] = get_type_hints(field.type)
235
236
237
238
239

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

240
        # Get the default value of the field
241
242
        if field.default is not MISSING:
            default = field.default
243
244
245
246
247
248
249
            # Handle pydantic.Field defaults
            if isinstance(default, FieldInfo):
                default = (
                    default.default
                    if default.default_factory is None
                    else default.default_factory()
                )
250
        elif field.default_factory is not MISSING:
251
            default = field.default_factory()
252
253
254

        # Get the help text for the field
        name = field.name
255
        help = cls_docs.get(name, "").strip()
256
257
258
259
260
261
262
        # 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
263
264
265
        json_tip = (
            "Should either be a valid JSON string or JSON keys passed individually."
        )
266
        if dataclass_cls is not None:
267
268
269
270
271
272
273
274

            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
275
            kwargs[name]["help"] += f"\n\n{json_tip}"
276
        elif contains_type(type_hints, bool):
277
278
279
            # Creates --no-<name> and --<name> flags
            kwargs[name]["action"] = argparse.BooleanOptionalAction
        elif contains_type(type_hints, Literal):
280
            kwargs[name].update(literal_to_kwargs(type_hints))
281
        elif contains_type(type_hints, tuple):
282
            kwargs[name].update(collection_to_kwargs(type_hints, tuple))
283
        elif contains_type(type_hints, list):
284
285
286
            kwargs[name].update(collection_to_kwargs(type_hints, list))
        elif contains_type(type_hints, set):
            kwargs[name].update(collection_to_kwargs(type_hints, set))
287
288
        elif contains_type(type_hints, int):
            kwargs[name]["type"] = int
289
            # Special case for large integers
290
291
292
293
294
295
            human_readable_ints = {
                "max_model_len",
                "max_num_batched_tokens",
                "kv_cache_memory_bytes",
            }
            if name in human_readable_ints:
296
                kwargs[name]["type"] = human_readable_int
297
                kwargs[name]["help"] += f"\n\n{human_readable_int.__doc__}"
298
299
        elif contains_type(type_hints, float):
            kwargs[name]["type"] = float
300
301
302
303
        elif contains_type(type_hints, dict) and (
            contains_type(type_hints, str)
            or any(is_not_builtin(th) for th in type_hints)
        ):
304
            kwargs[name]["type"] = union_dict_and_str
305
        elif contains_type(type_hints, dict):
306
            kwargs[name]["type"] = parse_type(json.loads)
307
            kwargs[name]["help"] += f"\n\n{json_tip}"
308
309
310
        elif contains_type(type_hints, str) or any(
            is_not_builtin(th) for th in type_hints
        ):
311
312
            kwargs[name]["type"] = str
        else:
313
            raise ValueError(f"Unsupported type {type_hints} for argument {name}.")
314

315
316
317
318
319
        # 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"]}))

320
321
322
323
324
325
326
        # 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
327
328


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

332
333
334
    If `--help` or `mkdocs` are not present in the command line command, the
    attribute documentation will not be included in the help output.

335
336
337
338
339
340
341
    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))


342
@dataclass
Zhuohan Li's avatar
Zhuohan Li committed
343
class EngineArgs:
Woosuk Kwon's avatar
Woosuk Kwon committed
344
    """Arguments for vLLM engine."""
345

346
    model: str = ModelConfig.model
347
348
349
    served_model_name: str | list[str] | None = ModelConfig.served_model_name
    tokenizer: str | None = ModelConfig.tokenizer
    hf_config_path: str | None = ModelConfig.hf_config_path
350
351
    runner: RunnerOption = ModelConfig.runner
    convert: ConvertOption = ModelConfig.convert
352
    task: TaskOption | None = ModelConfig.task
353
    skip_tokenizer_init: bool = ModelConfig.skip_tokenizer_init
354
    enable_prompt_embeds: bool = ModelConfig.enable_prompt_embeds
355
356
357
    tokenizer_mode: TokenizerMode = ModelConfig.tokenizer_mode
    trust_remote_code: bool = ModelConfig.trust_remote_code
    allowed_local_media_path: str = ModelConfig.allowed_local_media_path
358
359
    allowed_media_domains: list[str] | None = ModelConfig.allowed_media_domains
    download_dir: str | None = LoadConfig.download_dir
360
    safetensors_load_strategy: str = LoadConfig.safetensors_load_strategy
361
    load_format: str | LoadFormats = LoadConfig.load_format
362
363
    config_format: str = ModelConfig.config_format
    dtype: ModelDType = ModelConfig.dtype
364
    kv_cache_dtype: CacheDType = CacheConfig.cache_dtype
365
366
    seed: int | None = ModelConfig.seed
    max_model_len: int | None = ModelConfig.max_model_len
367
368
369
370
371
372
373
    cuda_graph_sizes: list[int] | None = CompilationConfig.cudagraph_capture_sizes
    cudagraph_capture_sizes: list[int] | None = (
        CompilationConfig.cudagraph_capture_sizes
    )
    max_cudagraph_capture_size: int | None = get_field(
        CompilationConfig, "max_cudagraph_capture_size"
    )
374
375
376
    # Note: Specifying a custom executor backend by passing a class
    # is intended for expert use only. The API may change without
    # notice.
377
    distributed_executor_backend: (
378
        str | DistributedExecutorBackend | type[Executor] | None
379
    ) = ParallelConfig.distributed_executor_backend
380
    # number of P/D disaggregation (or other disaggregation) workers
381
382
    pipeline_parallel_size: int = ParallelConfig.pipeline_parallel_size
    tensor_parallel_size: int = ParallelConfig.tensor_parallel_size
383
    decode_context_parallel_size: int = ParallelConfig.decode_context_parallel_size
384
    data_parallel_size: int = ParallelConfig.data_parallel_size
385
386
387
388
389
    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
390
    data_parallel_hybrid_lb: bool = False
Rui Qiao's avatar
Rui Qiao committed
391
    data_parallel_backend: str = ParallelConfig.data_parallel_backend
392
    enable_expert_parallel: bool = ParallelConfig.enable_expert_parallel
393
    all2all_backend: str | None = ParallelConfig.all2all_backend
394
    enable_dbo: bool = ParallelConfig.enable_dbo
395
396
    dbo_decode_token_threshold: int = ParallelConfig.dbo_decode_token_threshold
    dbo_prefill_token_threshold: int = ParallelConfig.dbo_prefill_token_threshold
397
398
399
    disable_nccl_for_dp_synchronization: bool = (
        ParallelConfig.disable_nccl_for_dp_synchronization
    )
400
    eplb_config: EPLBConfig = get_field(ParallelConfig, "eplb_config")
401
    enable_eplb: bool = ParallelConfig.enable_eplb
402
    expert_placement_strategy: ExpertPlacementStrategy = (
403
        ParallelConfig.expert_placement_strategy
404
    )
405
406
    _api_process_count: int = ParallelConfig._api_process_count
    _api_process_rank: int = ParallelConfig._api_process_rank
407
408
409
410
    num_redundant_experts: int = EPLBConfig.num_redundant_experts
    eplb_window_size: int = EPLBConfig.window_size
    eplb_step_interval: int = EPLBConfig.step_interval
    eplb_log_balancedness: bool = EPLBConfig.log_balancedness
411
    max_parallel_loading_workers: int | None = (
412
413
        ParallelConfig.max_parallel_loading_workers
    )
414
415
    block_size: BlockSize | None = CacheConfig.block_size
    enable_prefix_caching: bool | None = CacheConfig.enable_prefix_caching
416
    prefix_caching_hash_algo: PrefixCachingHashAlgo = (
417
        CacheConfig.prefix_caching_hash_algo
418
    )
419
420
    disable_sliding_window: bool = ModelConfig.disable_sliding_window
    disable_cascade_attn: bool = ModelConfig.disable_cascade_attn
421
422
423
    swap_space: float = CacheConfig.swap_space
    cpu_offload_gb: float = CacheConfig.cpu_offload_gb
    gpu_memory_utilization: float = CacheConfig.gpu_memory_utilization
424
425
    kv_cache_memory_bytes: int | None = CacheConfig.kv_cache_memory_bytes
    max_num_batched_tokens: int | None = SchedulerConfig.max_num_batched_tokens
426
427
    max_num_partial_prefills: int = SchedulerConfig.max_num_partial_prefills
    max_long_partial_prefills: int = SchedulerConfig.max_long_partial_prefills
428
    long_prefill_token_threshold: int = SchedulerConfig.long_prefill_token_threshold
429
    max_num_seqs: int | None = SchedulerConfig.max_num_seqs
430
    max_logprobs: int = ModelConfig.max_logprobs
431
    logprobs_mode: LogprobsMode = ModelConfig.logprobs_mode
432
    disable_log_stats: bool = False
433
    aggregate_engine_logging: bool = False
434
435
    revision: str | None = ModelConfig.revision
    code_revision: str | None = ModelConfig.code_revision
436
    rope_scaling: dict[str, Any] = get_field(ModelConfig, "rope_scaling")
437
438
    rope_theta: float | None = ModelConfig.rope_theta
    hf_token: bool | str | None = ModelConfig.hf_token
439
    hf_overrides: HfOverrides = get_field(ModelConfig, "hf_overrides")
440
441
    tokenizer_revision: str | None = ModelConfig.tokenizer_revision
    quantization: QuantizationMethods | None = ModelConfig.quantization
442
    enforce_eager: bool = ModelConfig.enforce_eager
443
    disable_custom_all_reduce: bool = ParallelConfig.disable_custom_all_reduce
444
    limit_mm_per_prompt: dict[str, int | dict[str, int]] = get_field(
445
446
        MultiModalConfig, "limit_per_prompt"
    )
447
    enable_mm_embeds: bool = MultiModalConfig.enable_mm_embeds
448
    interleave_mm_strings: bool = MultiModalConfig.interleave_mm_strings
449
450
451
    media_io_kwargs: dict[str, dict[str, Any]] = get_field(
        MultiModalConfig, "media_io_kwargs"
    )
452
    mm_processor_kwargs: dict[str, Any] | None = MultiModalConfig.mm_processor_kwargs
453
    disable_mm_preprocessor_cache: bool = False  # DEPRECATED
454
    mm_processor_cache_gb: float = MultiModalConfig.mm_processor_cache_gb
455
    mm_processor_cache_type: MMCacheType | None = (
456
        MultiModalConfig.mm_processor_cache_type
457
458
    )
    mm_shm_cache_max_object_size_mb: int = (
459
        MultiModalConfig.mm_shm_cache_max_object_size_mb
460
    )
461
    mm_encoder_tp_mode: MMEncoderTPMode = MultiModalConfig.mm_encoder_tp_mode
462
463
464
    mm_encoder_attn_backend: _Backend | str | None = (
        MultiModalConfig.mm_encoder_attn_backend
    )
465
    io_processor_plugin: str | None = None
466
    skip_mm_profiling: bool = MultiModalConfig.skip_mm_profiling
467
    video_pruning_rate: float = MultiModalConfig.video_pruning_rate
468
    # LoRA fields
469
    enable_lora: bool = False
470
471
    max_loras: int = LoRAConfig.max_loras
    max_lora_rank: int = LoRAConfig.max_lora_rank
472
    default_mm_loras: dict[str, str] | None = LoRAConfig.default_mm_loras
473
    fully_sharded_loras: bool = LoRAConfig.fully_sharded_loras
474
475
    max_cpu_loras: int | None = LoRAConfig.max_cpu_loras
    lora_dtype: str | torch.dtype | None = LoRAConfig.lora_dtype
476
477
    lora_extra_vocab_size: int = LoRAConfig.lora_extra_vocab_size

478
    ray_workers_use_nsight: bool = ParallelConfig.ray_workers_use_nsight
479
    num_gpu_blocks_override: int | None = CacheConfig.num_gpu_blocks_override
480
    num_lookahead_slots: int = SchedulerConfig.num_lookahead_slots
481
    model_loader_extra_config: dict = get_field(LoadConfig, "model_loader_extra_config")
482
    ignore_patterns: str | list[str] = get_field(LoadConfig, "ignore_patterns")
483

484
    enable_chunked_prefill: bool | None = SchedulerConfig.enable_chunked_prefill
485
    disable_chunked_mm_input: bool = SchedulerConfig.disable_chunked_mm_input
486

487
    disable_hybrid_kv_cache_manager: bool = (
488
489
        SchedulerConfig.disable_hybrid_kv_cache_manager
    )
490

491
    structured_outputs_config: StructuredOutputsConfig = get_field(
492
493
        VllmConfig, "structured_outputs_config"
    )
494
    reasoning_parser: str = StructuredOutputsConfig.reasoning_parser
495

496
    # Deprecated guided decoding fields
497
498
499
500
    guided_decoding_backend: str | None = None
    guided_decoding_disable_fallback: bool | None = None
    guided_decoding_disable_any_whitespace: bool | None = None
    guided_decoding_disable_additional_properties: bool | None = None
501

502
    logits_processor_pattern: str | None = ModelConfig.logits_processor_pattern
503

504
    speculative_config: dict[str, Any] | None = None
505

506
    show_hidden_metrics_for_version: str | None = (
507
        ObservabilityConfig.show_hidden_metrics_for_version
508
    )
509
510
    otlp_traces_endpoint: str | None = ObservabilityConfig.otlp_traces_endpoint
    collect_detailed_traces: list[DetailedTraceModules] | None = (
511
        ObservabilityConfig.collect_detailed_traces
512
    )
513
    scheduling_policy: SchedulerPolicy = SchedulerConfig.policy
514
    scheduler_cls: str | type[object] = SchedulerConfig.scheduler_cls
515

516
517
    pooler_config: PoolerConfig | None = ModelConfig.pooler_config
    override_pooler_config: dict | PoolerConfig | None = (
518
        ModelConfig.override_pooler_config
519
520
    )
    compilation_config: CompilationConfig = get_field(VllmConfig, "compilation_config")
521
522
    worker_cls: str = ParallelConfig.worker_cls
    worker_extension_cls: str = ParallelConfig.worker_extension_cls
523

524
525
    kv_transfer_config: KVTransferConfig | None = None
    kv_events_config: KVEventsConfig | None = None
526

527
528
    generation_config: str = ModelConfig.generation_config
    enable_sleep_mode: bool = ModelConfig.enable_sleep_mode
529
530
531
    override_generation_config: dict[str, Any] = get_field(
        ModelConfig, "override_generation_config"
    )
532
    model_impl: str = ModelConfig.model_impl
533
    override_attention_dtype: str = ModelConfig.override_attention_dtype
534

535
    calculate_kv_scales: bool = CacheConfig.calculate_kv_scales
536
537
    mamba_cache_dtype: MambaDType = CacheConfig.mamba_cache_dtype
    mamba_ssm_cache_dtype: MambaDType = CacheConfig.mamba_ssm_cache_dtype
538
    mamba_block_size: int | None = get_field(CacheConfig, "mamba_block_size")
539

540
    additional_config: dict[str, Any] = get_field(VllmConfig, "additional_config")
541

542
    use_tqdm_on_load: bool = LoadConfig.use_tqdm_on_load
543
    pt_load_map_location: str = LoadConfig.pt_load_map_location
544

545
546
    # DEPRECATED
    enable_multimodal_encoder_data_parallel: bool = False
547

548
    logits_processors: list[str | type[LogitsProcessor]] | None = (
549
550
        ModelConfig.logits_processors
    )
551
552
    """Custom logitproc types"""

553
554
    async_scheduling: bool = SchedulerConfig.async_scheduling

555
    kv_sharing_fast_prefill: bool = CacheConfig.kv_sharing_fast_prefill
556

557
    def __post_init__(self):
558
559
560
        # support `EngineArgs(compilation_config={...})`
        # without having to manually construct a
        # CompilationConfig object
561
        if isinstance(self.compilation_config, dict):
562
            self.compilation_config = CompilationConfig(**self.compilation_config)
563
        if isinstance(self.eplb_config, dict):
564
            self.eplb_config = EPLBConfig(**self.eplb_config)
565
        # Setup plugins
566
        from vllm.plugins import load_general_plugins
567

568
        load_general_plugins()
569
570
571
572
573
        # when use hf offline,replace model id to local model path
        if huggingface_hub.constants.HF_HUB_OFFLINE:
            model_id = self.model
            self.model = get_model_path(self.model, self.revision)
            logger.info(
574
575
576
577
                "HF_HUB_OFFLINE is True, replace model_id [%s] to model_path [%s]",
                model_id,
                self.model,
            )
578
579

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

583
        # Model arguments
584
585
586
587
588
        model_kwargs = get_kwargs(ModelConfig)
        model_group = parser.add_argument_group(
            title="ModelConfig",
            description=ModelConfig.__doc__,
        )
589
        if not ("serve" in sys.argv[1:] and "--help" in sys.argv[1:]):
590
            model_group.add_argument("--model", **model_kwargs["model"])
591
592
        model_group.add_argument("--runner", **model_kwargs["runner"])
        model_group.add_argument("--convert", **model_kwargs["convert"])
593
        model_group.add_argument("--task", **model_kwargs["task"], deprecated=True)
594
        model_group.add_argument("--tokenizer", **model_kwargs["tokenizer"])
595
596
597
598
        model_group.add_argument("--tokenizer-mode", **model_kwargs["tokenizer_mode"])
        model_group.add_argument(
            "--trust-remote-code", **model_kwargs["trust_remote_code"]
        )
599
600
        model_group.add_argument("--dtype", **model_kwargs["dtype"])
        model_group.add_argument("--seed", **model_kwargs["seed"])
601
602
603
604
605
606
607
        model_group.add_argument("--hf-config-path", **model_kwargs["hf_config_path"])
        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"]
        )
608
        model_group.add_argument("--revision", **model_kwargs["revision"])
609
610
        model_group.add_argument("--code-revision", **model_kwargs["code_revision"])
        model_group.add_argument("--rope-scaling", **model_kwargs["rope_scaling"])
611
        model_group.add_argument("--rope-theta", **model_kwargs["rope_theta"])
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
        model_group.add_argument(
            "--tokenizer-revision", **model_kwargs["tokenizer_revision"]
        )
        model_group.add_argument("--max-model-len", **model_kwargs["max_model_len"])
        model_group.add_argument("--quantization", "-q", **model_kwargs["quantization"])
        model_group.add_argument("--enforce-eager", **model_kwargs["enforce_eager"])
        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"]
        )
        model_group.add_argument(
            "--skip-tokenizer-init", **model_kwargs["skip_tokenizer_init"]
        )
        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"])
636
637
        # This one is a special case because it can bool
        # or str. TODO: Handle this in get_kwargs
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
        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(
            "--override-pooler-config",
            **model_kwargs["override_pooler_config"],
            deprecated=True,
        )
        model_group.add_argument(
            "--logits-processor-pattern", **model_kwargs["logits_processor_pattern"]
        )
        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"]
        )
665
        model_group.add_argument("--model-impl", **model_kwargs["model_impl"])
666
667
668
669
670
671
672
673
674
        model_group.add_argument(
            "--override-attention-dtype", **model_kwargs["override_attention_dtype"]
        )
        model_group.add_argument(
            "--logits-processors", **model_kwargs["logits_processors"]
        )
        model_group.add_argument(
            "--io-processor-plugin", **model_kwargs["io_processor_plugin"]
        )
675

676
677
678
679
680
681
        # Model loading arguments
        load_kwargs = get_kwargs(LoadConfig)
        load_group = parser.add_argument_group(
            title="LoadConfig",
            description=LoadConfig.__doc__,
        )
682
        load_group.add_argument("--load-format", **load_kwargs["load_format"])
683
684
685
686
687
688
689
690
691
692
693
694
        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"]
        )
695

696
697
698
699
700
        # Structured outputs arguments
        structured_outputs_kwargs = get_kwargs(StructuredOutputsConfig)
        structured_outputs_group = parser.add_argument_group(
            title="StructuredOutputsConfig",
            description=StructuredOutputsConfig.__doc__,
701
        )
702
        structured_outputs_group.add_argument(
703
            "--reasoning-parser",
704
            # This choice is a special case because it's not static
705
            choices=list(ReasoningParserManager.reasoning_parsers),
706
707
            **structured_outputs_kwargs["reasoning_parser"],
        )
708
709
710
711
712
713
714
715
716
717
718
        # Deprecated guided decoding arguments
        for arg, type in [
            ("--guided-decoding-backend", str),
            ("--guided-decoding-disable-fallback", bool),
            ("--guided-decoding-disable-any-whitespace", bool),
            ("--guided-decoding-disable-additional-properties", bool),
        ]:
            structured_outputs_group.add_argument(
                arg,
                type=type,
                help=(f"[DEPRECATED] {arg} will be removed in v0.12.0."),
719
720
                deprecated=True,
            )
721

722
        # Parallel arguments
723
724
725
726
727
728
        parallel_kwargs = get_kwargs(ParallelConfig)
        parallel_group = parser.add_argument_group(
            title="ParallelConfig",
            description=ParallelConfig.__doc__,
        )
        parallel_group.add_argument(
729
            "--distributed-executor-backend",
730
731
            **parallel_kwargs["distributed_executor_backend"],
        )
732
        parallel_group.add_argument(
733
734
735
736
            "--pipeline-parallel-size",
            "-pp",
            **parallel_kwargs["pipeline_parallel_size"],
        )
737
        parallel_group.add_argument(
738
739
            "--tensor-parallel-size", "-tp", **parallel_kwargs["tensor_parallel_size"]
        )
740
        parallel_group.add_argument(
741
742
743
744
745
746
747
748
749
750
            "--decode-context-parallel-size",
            "-dcp",
            **parallel_kwargs["decode_context_parallel_size"],
        )
        parallel_group.add_argument(
            "--data-parallel-size", "-dp", **parallel_kwargs["data_parallel_size"]
        )
        parallel_group.add_argument(
            "--data-parallel-rank",
            "-dpn",
751
            type=int,
752
753
754
            help="Data parallel rank of this instance. "
            "When set, enables external load balancer mode.",
        )
755
        parallel_group.add_argument(
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
            "--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".',
        )
786
        parallel_group.add_argument(
787
788
789
790
791
            "--data-parallel-hybrid-lb", **parallel_kwargs["data_parallel_hybrid_lb"]
        )
        parallel_group.add_argument(
            "--enable-expert-parallel", **parallel_kwargs["enable_expert_parallel"]
        )
792
793
794
        parallel_group.add_argument(
            "--all2all-backend", **parallel_kwargs["all2all_backend"]
        )
795
        parallel_group.add_argument("--enable-dbo", **parallel_kwargs["enable_dbo"])
796
797
        parallel_group.add_argument(
            "--dbo-decode-token-threshold",
798
799
            **parallel_kwargs["dbo_decode_token_threshold"],
        )
800
801
        parallel_group.add_argument(
            "--dbo-prefill-token-threshold",
802
803
            **parallel_kwargs["dbo_prefill_token_threshold"],
        )
804
805
806
807
        parallel_group.add_argument(
            "--disable-nccl-for-dp-synchronization",
            **parallel_kwargs["disable_nccl_for_dp_synchronization"],
        )
808
809
        parallel_group.add_argument("--enable-eplb", **parallel_kwargs["enable_eplb"])
        parallel_group.add_argument("--eplb-config", **parallel_kwargs["eplb_config"])
810
811
        parallel_group.add_argument(
            "--expert-placement-strategy",
812
813
            **parallel_kwargs["expert_placement_strategy"],
        )
814
815
816
        parallel_group.add_argument(
            "--num-redundant-experts",
            type=int,
817
818
819
            help="[DEPRECATED] --num-redundant-experts will be removed in v0.12.0.",
            deprecated=True,
        )
820
821
822
823
        parallel_group.add_argument(
            "--eplb-window-size",
            type=int,
            help="[DEPRECATED] --eplb-window-size will be removed in v0.12.0.",
824
825
            deprecated=True,
        )
826
827
828
        parallel_group.add_argument(
            "--eplb-step-interval",
            type=int,
829
830
831
            help="[DEPRECATED] --eplb-step-interval will be removed in v0.12.0.",
            deprecated=True,
        )
832
833
834
        parallel_group.add_argument(
            "--eplb-log-balancedness",
            action=argparse.BooleanOptionalAction,
835
836
837
            help="[DEPRECATED] --eplb-log-balancedness will be removed in v0.12.0.",
            deprecated=True,
        )
838

839
        parallel_group.add_argument(
840
            "--max-parallel-loading-workers",
841
842
            **parallel_kwargs["max_parallel_loading_workers"],
        )
843
        parallel_group.add_argument(
844
845
            "--ray-workers-use-nsight", **parallel_kwargs["ray_workers_use_nsight"]
        )
846
        parallel_group.add_argument(
847
            "--disable-custom-all-reduce",
848
849
850
851
852
853
            **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"]
        )
854
855
        parallel_group.add_argument(
            "--enable-multimodal-encoder-data-parallel",
856
            action="store_true",
857
858
            deprecated=True,
        )
859

860
861
862
863
864
        # KV cache arguments
        cache_kwargs = get_kwargs(CacheConfig)
        cache_group = parser.add_argument_group(
            title="CacheConfig",
            description=CacheConfig.__doc__,
865
        )
866
        cache_group.add_argument("--block-size", **cache_kwargs["block_size"])
867
868
869
870
871
872
        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"]
        )
873
        cache_group.add_argument("--swap-space", **cache_kwargs["swap_space"])
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
        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(
            "--enable-prefix-caching", **cache_kwargs["enable_prefix_caching"]
        )
        cache_group.add_argument(
            "--prefix-caching-hash-algo", **cache_kwargs["prefix_caching_hash_algo"]
        )
        cache_group.add_argument("--cpu-offload-gb", **cache_kwargs["cpu_offload_gb"])
        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"]
        )
897
898
899
        cache_group.add_argument(
            "--mamba-block-size", **cache_kwargs["mamba_block_size"]
        )
900

901
        # Multimodal related configs
902
903
904
905
906
        multimodal_kwargs = get_kwargs(MultiModalConfig)
        multimodal_group = parser.add_argument_group(
            title="MultiModalConfig",
            description=MultiModalConfig.__doc__,
        )
907
        multimodal_group.add_argument(
908
909
            "--limit-mm-per-prompt", **multimodal_kwargs["limit_per_prompt"]
        )
910
911
912
        multimodal_group.add_argument(
            "--enable-mm-embeds", **multimodal_kwargs["enable_mm_embeds"]
        )
913
914
915
916
917
918
919
920
921
        multimodal_group.add_argument(
            "--media-io-kwargs", **multimodal_kwargs["media_io_kwargs"]
        )
        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"]
        )
922
        multimodal_group.add_argument(
923
924
            "--disable-mm-preprocessor-cache", action="store_true", deprecated=True
        )
925
        multimodal_group.add_argument(
926
927
            "--mm-processor-cache-type", **multimodal_kwargs["mm_processor_cache_type"]
        )
928
929
        multimodal_group.add_argument(
            "--mm-shm-cache-max-object-size-mb",
930
931
            **multimodal_kwargs["mm_shm_cache_max_object_size_mb"],
        )
932
        multimodal_group.add_argument(
933
934
            "--mm-encoder-tp-mode", **multimodal_kwargs["mm_encoder_tp_mode"]
        )
935
936
937
938
        multimodal_group.add_argument(
            "--mm-encoder-attn-backend",
            **multimodal_kwargs["mm_encoder_attn_backend"],
        )
939
940
941
        multimodal_group.add_argument(
            "--interleave-mm-strings", **multimodal_kwargs["interleave_mm_strings"]
        )
942
        multimodal_group.add_argument(
943
944
            "--skip-mm-profiling", **multimodal_kwargs["skip_mm_profiling"]
        )
945

946
        multimodal_group.add_argument(
947
948
            "--video-pruning-rate", **multimodal_kwargs["video_pruning_rate"]
        )
949

950
        # LoRA related configs
951
952
953
954
955
956
        lora_kwargs = get_kwargs(LoRAConfig)
        lora_group = parser.add_argument_group(
            title="LoRAConfig",
            description=LoRAConfig.__doc__,
        )
        lora_group.add_argument(
957
            "--enable-lora",
958
            action=argparse.BooleanOptionalAction,
959
960
            help="If True, enable handling of LoRA adapters.",
        )
961
        lora_group.add_argument("--max-loras", **lora_kwargs["max_loras"])
962
963
964
965
        lora_group.add_argument("--max-lora-rank", **lora_kwargs["max_lora_rank"])
        lora_group.add_argument(
            "--lora-extra-vocab-size", **lora_kwargs["lora_extra_vocab_size"]
        )
966
        lora_group.add_argument(
967
            "--lora-dtype",
968
969
            **lora_kwargs["lora_dtype"],
        )
970
971
972
973
974
        lora_group.add_argument("--max-cpu-loras", **lora_kwargs["max_cpu_loras"])
        lora_group.add_argument(
            "--fully-sharded-loras", **lora_kwargs["fully_sharded_loras"]
        )
        lora_group.add_argument("--default-mm-loras", **lora_kwargs["default_mm_loras"])
975

976
977
978
979
980
981
982
983
        # 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",
984
985
            **observability_kwargs["show_hidden_metrics_for_version"],
        )
986
        observability_group.add_argument(
987
988
            "--otlp-traces-endpoint", **observability_kwargs["otlp_traces_endpoint"]
        )
989
990
991
992
993
        # 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"] += [
994
            ",".join(p) for p in permutations(get_args(DetailedTraceModules), r=2)
995
996
997
        ]
        observability_group.add_argument(
            "--collect-detailed-traces",
998
999
            **observability_kwargs["collect_detailed_traces"],
        )
1000

1001
1002
1003
1004
1005
1006
1007
        # Scheduler arguments
        scheduler_kwargs = get_kwargs(SchedulerConfig)
        scheduler_group = parser.add_argument_group(
            title="SchedulerConfig",
            description=SchedulerConfig.__doc__,
        )
        scheduler_group.add_argument(
1008
1009
            "--max-num-batched-tokens", **scheduler_kwargs["max_num_batched_tokens"]
        )
1010
        scheduler_group.add_argument(
1011
1012
1013
1014
1015
            "--max-num-seqs", **scheduler_kwargs["max_num_seqs"]
        )
        scheduler_group.add_argument(
            "--max-num-partial-prefills", **scheduler_kwargs["max_num_partial_prefills"]
        )
1016
1017
        scheduler_group.add_argument(
            "--max-long-partial-prefills",
1018
1019
            **scheduler_kwargs["max_long_partial_prefills"],
        )
1020
1021
        scheduler_group.add_argument(
            "--long-prefill-token-threshold",
1022
1023
1024
1025
1026
            **scheduler_kwargs["long_prefill_token_threshold"],
        )
        scheduler_group.add_argument(
            "--num-lookahead-slots", **scheduler_kwargs["num_lookahead_slots"]
        )
1027
1028
        # multi-step scheduling has been removed; corresponding arguments
        # are no longer supported.
1029
        scheduler_group.add_argument(
1030
1031
            "--scheduling-policy", **scheduler_kwargs["policy"]
        )
1032
        scheduler_group.add_argument(
1033
1034
1035
1036
1037
1038
1039
1040
            "--enable-chunked-prefill", **scheduler_kwargs["enable_chunked_prefill"]
        )
        scheduler_group.add_argument(
            "--disable-chunked-mm-input", **scheduler_kwargs["disable_chunked_mm_input"]
        )
        scheduler_group.add_argument(
            "--scheduler-cls", **scheduler_kwargs["scheduler_cls"]
        )
1041
1042
        scheduler_group.add_argument(
            "--disable-hybrid-kv-cache-manager",
1043
1044
1045
1046
1047
            **scheduler_kwargs["disable_hybrid_kv_cache_manager"],
        )
        scheduler_group.add_argument(
            "--async-scheduling", **scheduler_kwargs["async_scheduling"]
        )
1048

1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
        # 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_kwargs["cudagraph_capture_sizes"]["help"] = (
            "--cuda-graph-sizes is deprecated and will be removed in v0.13.0 or v1.0.0,"
            " whichever is soonest. Please use --cudagraph-capture-sizes instead."
        )
        compilation_group.add_argument(
            "--cuda-graph-sizes",
            **compilation_kwargs["cudagraph_capture_sizes"],
            deprecated=True,
        )
        compilation_group.add_argument(
            "--max-cudagraph-capture-size",
            **compilation_kwargs["max_cudagraph_capture_size"],
        )

1072
        # vLLM arguments
1073
        vllm_kwargs = get_kwargs(VllmConfig)
1074
1075
1076
1077
        vllm_group = parser.add_argument_group(
            title="VllmConfig",
            description=VllmConfig.__doc__,
        )
1078
1079
1080
1081
        # 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)
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
        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"])
        vllm_group.add_argument(
            "--compilation-config", "-O", **vllm_kwargs["compilation_config"]
        )
        vllm_group.add_argument(
            "--additional-config", **vllm_kwargs["additional_config"]
        )
        vllm_group.add_argument(
            "--structured-outputs-config", **vllm_kwargs["structured_outputs_config"]
        )
1098

1099
        # Other arguments
1100
1101
1102
1103
1104
        parser.add_argument(
            "--disable-log-stats",
            action="store_true",
            help="Disable logging statistics.",
        )
1105

1106
1107
1108
1109
1110
1111
        parser.add_argument(
            "--aggregate-engine-logging",
            action="store_true",
            help="Log aggregate rather than per-engine statistics "
            "when using data parallelism.",
        )
1112
        return parser
1113
1114

    @classmethod
1115
    def from_cli_args(cls, args: argparse.Namespace):
1116
1117
1118
        # Get the list of attributes of this dataclass.
        attrs = [attr.name for attr in dataclasses.fields(cls)]
        # Set the attributes from the parsed arguments.
1119
1120
1121
        engine_args = cls(
            **{attr: getattr(args, attr) for attr in attrs if hasattr(args, attr)}
        )
Zhuohan Li's avatar
Zhuohan Li committed
1122
        return engine_args
1123

1124
    def create_model_config(self) -> ModelConfig:
1125
1126
1127
1128
1129
        # gguf file needs a specific model loader and doesn't use hf_repo
        if check_gguf_file(self.model):
            self.quantization = self.load_format = "gguf"

        # NOTE: This is to allow model loading from S3 in CI
1130
1131
1132
1133
1134
1135
        if (
            not isinstance(self, AsyncEngineArgs)
            and envs.VLLM_CI_USE_S3
            and self.model in MODELS_ON_S3
            and self.load_format == "auto"
        ):
1136
1137
            self.model = f"{MODEL_WEIGHTS_S3_BUCKET}/{self.model}"

1138
1139
1140
1141
        if self.disable_mm_preprocessor_cache:
            logger.warning(
                "`--disable-mm-preprocessor-cache` is deprecated "
                "and will be removed in v0.13. "
1142
1143
                "Please use `--mm-processor-cache-gb 0` instead.",
            )
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155

            self.mm_processor_cache_gb = 0
        elif envs.VLLM_MM_INPUT_CACHE_GIB != 4:
            logger.warning(
                "VLLM_MM_INPUT_CACHE_GIB` is deprecated "
                "and will be removed in v0.13. "
                "Please use `--mm-processor-cache-gb %d` instead.",
                envs.VLLM_MM_INPUT_CACHE_GIB,
            )

            self.mm_processor_cache_gb = envs.VLLM_MM_INPUT_CACHE_GIB

1156
1157
1158
1159
        if self.enable_multimodal_encoder_data_parallel:
            logger.warning(
                "--enable-multimodal-encoder-data-parallel` is deprecated "
                "and will be removed in v0.13. "
1160
1161
                "Please use `--mm-encoder-tp-mode data` instead."
            )
1162
1163
1164

            self.mm_encoder_tp_mode = "data"

1165
        return ModelConfig(
1166
            model=self.model,
1167
            hf_config_path=self.hf_config_path,
1168
1169
            runner=self.runner,
            convert=self.convert,
1170
            task=self.task,
1171
            tokenizer=self.tokenizer,
1172
1173
            tokenizer_mode=self.tokenizer_mode,
            trust_remote_code=self.trust_remote_code,
1174
            allowed_local_media_path=self.allowed_local_media_path,
1175
            allowed_media_domains=self.allowed_media_domains,
1176
1177
1178
1179
1180
            dtype=self.dtype,
            seed=self.seed,
            revision=self.revision,
            code_revision=self.code_revision,
            rope_scaling=self.rope_scaling,
1181
            rope_theta=self.rope_theta,
1182
            hf_token=self.hf_token,
1183
            hf_overrides=self.hf_overrides,
1184
1185
1186
1187
1188
            tokenizer_revision=self.tokenizer_revision,
            max_model_len=self.max_model_len,
            quantization=self.quantization,
            enforce_eager=self.enforce_eager,
            max_logprobs=self.max_logprobs,
1189
            logprobs_mode=self.logprobs_mode,
1190
            disable_sliding_window=self.disable_sliding_window,
1191
            disable_cascade_attn=self.disable_cascade_attn,
1192
            skip_tokenizer_init=self.skip_tokenizer_init,
1193
            enable_prompt_embeds=self.enable_prompt_embeds,
1194
            served_model_name=self.served_model_name,
1195
            limit_mm_per_prompt=self.limit_mm_per_prompt,
1196
            enable_mm_embeds=self.enable_mm_embeds,
1197
            interleave_mm_strings=self.interleave_mm_strings,
1198
            media_io_kwargs=self.media_io_kwargs,
1199
            skip_mm_profiling=self.skip_mm_profiling,
1200
            config_format=self.config_format,
1201
            mm_processor_kwargs=self.mm_processor_kwargs,
1202
            mm_processor_cache_gb=self.mm_processor_cache_gb,
1203
            mm_processor_cache_type=self.mm_processor_cache_type,
1204
            mm_shm_cache_max_object_size_mb=self.mm_shm_cache_max_object_size_mb,
1205
            mm_encoder_tp_mode=self.mm_encoder_tp_mode,
1206
            mm_encoder_attn_backend=self.mm_encoder_attn_backend,
1207
            pooler_config=self.pooler_config,
1208
            override_pooler_config=self.override_pooler_config,
1209
            logits_processor_pattern=self.logits_processor_pattern,
1210
            generation_config=self.generation_config,
1211
            override_generation_config=self.override_generation_config,
1212
            enable_sleep_mode=self.enable_sleep_mode,
1213
            model_impl=self.model_impl,
1214
            override_attention_dtype=self.override_attention_dtype,
1215
            logits_processors=self.logits_processors,
1216
            video_pruning_rate=self.video_pruning_rate,
1217
            io_processor_plugin=self.io_processor_plugin,
1218
        )
1219

1220
    def validate_tensorizer_args(self):
1221
1222
        from vllm.model_executor.model_loader.tensorizer import TensorizerConfig

1223
1224
        for key in self.model_loader_extra_config:
            if key in TensorizerConfig._fields:
1225
1226
1227
                self.model_loader_extra_config["tensorizer_config"][key] = (
                    self.model_loader_extra_config[key]
                )
1228

1229
    def create_load_config(self) -> LoadConfig:
1230
1231
        if self.quantization == "bitsandbytes":
            self.load_format = "bitsandbytes"
1232

1233
1234
1235
        if self.load_format == "tensorizer":
            if hasattr(self.model_loader_extra_config, "to_serializable"):
                self.model_loader_extra_config = (
1236
1237
                    self.model_loader_extra_config.to_serializable()
                )
1238
            self.model_loader_extra_config["tensorizer_config"] = {}
1239
1240
1241
            self.model_loader_extra_config["tensorizer_config"]["tensorizer_dir"] = (
                self.model
            )
1242
            self.validate_tensorizer_args()
1243

1244
1245
1246
        return LoadConfig(
            load_format=self.load_format,
            download_dir=self.download_dir,
1247
            safetensors_load_strategy=self.safetensors_load_strategy,
1248
            device="cpu" if is_online_quantization(self.quantization) else None,
1249
1250
            model_loader_extra_config=self.model_loader_extra_config,
            ignore_patterns=self.ignore_patterns,
1251
            use_tqdm_on_load=self.use_tqdm_on_load,
1252
            pt_load_map_location=self.pt_load_map_location,
1253
        )
1254

1255
1256
1257
1258
1259
1260
    def create_speculative_config(
        self,
        target_model_config: ModelConfig,
        target_parallel_config: ParallelConfig,
        enable_chunked_prefill: bool,
        disable_log_stats: bool,
1261
    ) -> SpeculativeConfig | None:
1262
1263
1264
1265
1266
1267
        """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
1268
        dictionary from the engine.
1269
1270
        """
        if self.speculative_config is None:
1271
            return None
1272

1273
1274
1275
        # Note(Shangming): These parameters are not obtained from the cli arg
        # '--speculative-config' and must be passed in when creating the engine
        # config.
1276
1277
1278
1279
1280
1281
1282
1283
        self.speculative_config.update(
            {
                "target_model_config": target_model_config,
                "target_parallel_config": target_parallel_config,
                "enable_chunked_prefill": enable_chunked_prefill,
                "disable_log_stats": disable_log_stats,
            }
        )
1284
        return SpeculativeConfig(**self.speculative_config)
1285

1286
1287
    def create_engine_config(
        self,
1288
        usage_context: UsageContext | None = None,
1289
        headless: bool = False,
1290
1291
1292
1293
1294
1295
1296
    ) -> VllmConfig:
        """
        Create the VllmConfig.

        NOTE: for autoselection of V0 vs V1 engine, we need to
        create the ModelConfig first, since ModelConfig's attrs
        (e.g. the model arch) are needed to make the decision.
Simon Mo's avatar
Simon Mo committed
1297

1298
1299
1300
1301
1302
1303
        This function set VLLM_USE_V1=X if VLLM_USE_V1 is
        unspecified by the user.

        If VLLM_USE_V1 is specified by the user but the VllmConfig
        is incompatible, we raise an error.
        """
1304
        current_platform.pre_register_and_update()
1305

1306
        device_config = DeviceConfig(device=cast(Device, current_platform.device_type))
1307

1308
1309
1310
1311
        model_config = self.create_model_config()
        self.model = model_config.model
        self.tokenizer = model_config.tokenizer

1312
1313
1314
1315
1316
1317
1318
1319
1320
        (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,
            )
        )
1321

1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
        # * If VLLM_USE_V1 is unset, we enable V1 for "supported features"
        #   and fall back to V0 for experimental or unsupported features.
        # * If VLLM_USE_V1=1, we enable V1 for supported + experimental
        #   features and raise error for unsupported features.
        # * If VLLM_USE_V1=0, we disable V1.
        use_v1 = False
        try_v1 = envs.VLLM_USE_V1 or not envs.is_set("VLLM_USE_V1")
        if try_v1 and self._is_v1_supported_oracle(model_config):
            use_v1 = True

        # If user explicitly set VLLM_USE_V1, sanity check we respect it.
        if envs.is_set("VLLM_USE_V1"):
            assert use_v1 == envs.VLLM_USE_V1
        # Otherwise, set the VLLM_USE_V1 variable globally.
        else:
            envs.set_vllm_use_v1(use_v1)

1339
1340
        # Set default arguments for V1 Engine.
        self._set_default_args(usage_context, model_config)
1341
1342
        # Disable chunked prefill and prefix caching for:
        # POWER (ppc64le)/ARM/s390x/RISCV CPUs in V1
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
        if current_platform.is_cpu() and current_platform.get_cpu_architecture() in (
            CpuArchEnum.POWERPC,
            CpuArchEnum.S390X,
            CpuArchEnum.ARM,
            CpuArchEnum.RISCV,
        ):
            logger.info(
                "Chunked prefill is not supported for ARM and POWER, "
                "S390X and RISC-V CPUs; "
                "disabling it for V1 backend."
            )
1354
            self.enable_chunked_prefill = False
1355
1356
1357
1358
1359
1360
1361
            logger.info(
                "Prefix caching is not supported for ARM and POWER, "
                "S390X and RISC-V CPUs; "
                "disabling it for V1 backend."
            )
            self.enable_prefix_caching = False

1362
1363
        assert self.enable_chunked_prefill is not None

1364
        sliding_window: int | None = None
1365
1366
1367
1368
1369
1370
        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()

1371
1372
1373
        # Note(hc): In the current implementation of decode context
        # parallel(DCP), tp_size needs to be divisible by dcp_size,
        # because the world size does not change by dcp, it simply
1374
        # reuses the GPUs of TP group, and split one TP group into
1375
        # tp_size//dcp_size DCP groups.
1376
        assert self.tensor_parallel_size % self.decode_context_parallel_size == 0, (
1377
1378
1379
1380
            f"tp_size={self.tensor_parallel_size} must be divisible by"
            f"dcp_size={self.decode_context_parallel_size}."
        )

1381
        cache_config = CacheConfig(
1382
            block_size=self.block_size,
1383
            gpu_memory_utilization=self.gpu_memory_utilization,
1384
            kv_cache_memory_bytes=self.kv_cache_memory_bytes,
1385
1386
            swap_space=self.swap_space,
            cache_dtype=self.kv_cache_dtype,
1387
            is_attention_free=model_config.is_attention_free,
1388
            num_gpu_blocks_override=self.num_gpu_blocks_override,
1389
            sliding_window=sliding_window,
1390
            enable_prefix_caching=self.enable_prefix_caching,
1391
            prefix_caching_hash_algo=self.prefix_caching_hash_algo,
1392
            cpu_offload_gb=self.cpu_offload_gb,
1393
            calculate_kv_scales=self.calculate_kv_scales,
1394
            kv_sharing_fast_prefill=self.kv_sharing_fast_prefill,
1395
1396
            mamba_cache_dtype=self.mamba_cache_dtype,
            mamba_ssm_cache_dtype=self.mamba_ssm_cache_dtype,
1397
            mamba_block_size=self.mamba_block_size,
1398
        )
1399

1400
1401
1402
1403
1404
1405
        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
1406

1407
            ray_runtime_env = ray.get_runtime_context().runtime_env
1408
1409
1410
1411
1412
1413
1414
            # 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)
1415

1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
        # 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()

1427
        assert not headless or not self.data_parallel_hybrid_lb, (
1428
1429
            "data_parallel_hybrid_lb is not applicable in headless mode"
        )
1430

1431
        data_parallel_external_lb = self.data_parallel_rank is not None
1432
        # Local DP rank = 1, use pure-external LB.
1433
1434
        if data_parallel_external_lb:
            assert self.data_parallel_size_local in (1, None), (
1435
1436
                "data_parallel_size_local must be 1 when data_parallel_rank is set"
            )
1437
            data_parallel_size_local = 1
1438
1439
            # Use full external lb if we have local_size of 1.
            self.data_parallel_hybrid_lb = False
1440
1441
        elif self.data_parallel_size_local is not None:
            data_parallel_size_local = self.data_parallel_size_local
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456

            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.
                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

            self.data_parallel_rank = self.data_parallel_start_rank or 0
1457
        else:
1458
            assert not self.data_parallel_hybrid_lb, (
1459
1460
                "data_parallel_size_local must be set to use data_parallel_hybrid_lb."
            )
1461

1462
1463
1464
1465
1466
1467
1468
1469
1470
            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
1471
1472
1473

        # DP address, used in multi-node case for torch distributed group
        # and ZMQ sockets.
Rui Qiao's avatar
Rui Qiao committed
1474
1475
1476
1477
        if self.data_parallel_address is None:
            if self.data_parallel_backend == "ray":
                host_ip = get_ip()
                logger.info(
1478
1479
                    "Using host IP %s as ray-based data parallel address", host_ip
                )
Rui Qiao's avatar
Rui Qiao committed
1480
1481
1482
1483
                data_parallel_address = host_ip
            else:
                assert self.data_parallel_backend == "mp", (
                    "data_parallel_backend can only be ray or mp, got %s",
1484
1485
                    self.data_parallel_backend,
                )
Rui Qiao's avatar
Rui Qiao committed
1486
1487
1488
                data_parallel_address = ParallelConfig.data_parallel_master_ip
        else:
            data_parallel_address = self.data_parallel_address
1489
1490
1491

        # This port is only used when there are remote data parallel engines,
        # otherwise the local IPC transport is used.
1492
        data_parallel_rpc_port = (
1493
            self.data_parallel_rpc_port
1494
1495
1496
            if (self.data_parallel_rpc_port is not None)
            else ParallelConfig.data_parallel_rpc_port
        )
1497

1498
1499
        if self.async_scheduling:
            if self.pipeline_parallel_size > 1:
1500
1501
1502
                raise ValueError(
                    "Async scheduling is not supported with pipeline-parallel-size > 1."
                )
1503
1504
1505
1506
1507
1508

            # Currently, async scheduling does not support speculative decoding.
            # TODO(woosuk): Support it.
            if self.speculative_config is not None:
                raise ValueError(
                    "Currently, speculative decoding is not supported with "
1509
1510
                    "async scheduling."
                )
1511

1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
        # Forward the deprecated CLI args to the EPLB config.
        if self.num_redundant_experts is not None:
            self.eplb_config.num_redundant_experts = self.num_redundant_experts
        if self.eplb_window_size is not None:
            self.eplb_config.window_size = self.eplb_window_size
        if self.eplb_step_interval is not None:
            self.eplb_config.step_interval = self.eplb_step_interval
        if self.eplb_log_balancedness is not None:
            self.eplb_config.log_balancedness = self.eplb_log_balancedness

1522
        parallel_config = ParallelConfig(
1523
1524
            pipeline_parallel_size=self.pipeline_parallel_size,
            tensor_parallel_size=self.tensor_parallel_size,
1525
            data_parallel_size=self.data_parallel_size,
1526
1527
            data_parallel_rank=self.data_parallel_rank or 0,
            data_parallel_external_lb=data_parallel_external_lb,
1528
1529
1530
            data_parallel_size_local=data_parallel_size_local,
            data_parallel_master_ip=data_parallel_address,
            data_parallel_rpc_port=data_parallel_rpc_port,
1531
            data_parallel_backend=self.data_parallel_backend,
1532
            data_parallel_hybrid_lb=self.data_parallel_hybrid_lb,
1533
            enable_expert_parallel=self.enable_expert_parallel,
1534
            all2all_backend=self.all2all_backend,
1535
1536
            enable_dbo=self.enable_dbo,
            dbo_decode_token_threshold=self.dbo_decode_token_threshold,
1537
            dbo_prefill_token_threshold=self.dbo_prefill_token_threshold,
1538
            disable_nccl_for_dp_synchronization=self.disable_nccl_for_dp_synchronization,
1539
            enable_eplb=self.enable_eplb,
1540
            eplb_config=self.eplb_config,
1541
            expert_placement_strategy=self.expert_placement_strategy,
1542
1543
1544
            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,
1545
            ray_runtime_env=ray_runtime_env,
1546
            placement_group=placement_group,
1547
1548
            distributed_executor_backend=self.distributed_executor_backend,
            worker_cls=self.worker_cls,
1549
            worker_extension_cls=self.worker_extension_cls,
1550
            decode_context_parallel_size=self.decode_context_parallel_size,
1551
1552
            _api_process_count=self._api_process_count,
            _api_process_rank=self._api_process_rank,
1553
        )
1554

1555
        if self.async_scheduling and (
1556
1557
            parallel_config.distributed_executor_backend
            not in ("mp", "uni", "external_launcher")
1558
1559
        ):
            raise ValueError(
1560
1561
                "Currently, async scheduling only supports `mp`, `uni` or "
                "`external_launcher` distributed executor backend, but you choose "
1562
1563
1564
                f"`{parallel_config.distributed_executor_backend}`."
            )

1565
        speculative_config = self.create_speculative_config(
1566
1567
            target_model_config=model_config,
            target_parallel_config=parallel_config,
1568
            enable_chunked_prefill=self.enable_chunked_prefill,
1569
            disable_log_stats=self.disable_log_stats,
1570
1571
        )

1572
1573
1574
1575
1576
        # make sure num_lookahead_slots is set appropriately depending on
        # whether speculative decoding is enabled
        num_lookahead_slots = self.num_lookahead_slots
        if speculative_config is not None:
            num_lookahead_slots = speculative_config.num_lookahead_slots
1577

1578
        scheduler_config = SchedulerConfig(
1579
            runner_type=model_config.runner_type,
1580
1581
1582
            max_num_batched_tokens=self.max_num_batched_tokens,
            max_num_seqs=self.max_num_seqs,
            max_model_len=model_config.max_model_len,
1583
            num_lookahead_slots=num_lookahead_slots,
1584
            enable_chunked_prefill=self.enable_chunked_prefill,
1585
            disable_chunked_mm_input=self.disable_chunked_mm_input,
1586
            is_multimodal_model=model_config.is_multimodal_model,
1587
            is_encoder_decoder=model_config.is_encoder_decoder,
1588
            policy=self.scheduling_policy,
1589
            scheduler_cls=self.scheduler_cls,
1590
1591
1592
            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,
1593
            disable_hybrid_kv_cache_manager=self.disable_hybrid_kv_cache_manager,
1594
            async_scheduling=self.async_scheduling,
1595
        )
1596

1597
1598
1599
        if not model_config.is_multimodal_model and self.default_mm_loras:
            raise ValueError(
                "Default modality-specific LoRA(s) were provided for a "
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
                "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_extra_vocab_size=self.lora_extra_vocab_size,
                lora_dtype=self.lora_dtype,
                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
        )
1618

1619
1620
1621
1622
        # bitsandbytes pre-quantized model need a specific model loader
        if model_config.quantization == "bitsandbytes":
            self.quantization = self.load_format = "bitsandbytes"

1623
        load_config = self.create_load_config()
1624

1625
1626
        # Pass reasoning_parser into StructuredOutputsConfig
        if self.reasoning_parser:
1627
            self.structured_outputs_config.reasoning_parser = self.reasoning_parser
1628
1629
1630
1631

        # Forward the deprecated CLI args to the StructuredOutputsConfig
        so_config = self.structured_outputs_config
        if self.guided_decoding_backend is not None:
1632
            so_config.guided_decoding_backend = self.guided_decoding_backend
1633
        if self.guided_decoding_disable_fallback is not None:
1634
            so_config.disable_fallback = self.guided_decoding_disable_fallback
1635
        if self.guided_decoding_disable_any_whitespace is not None:
1636
            so_config.disable_any_whitespace = (
1637
1638
                self.guided_decoding_disable_any_whitespace
            )
1639
        if self.guided_decoding_disable_additional_properties is not None:
1640
            so_config.disable_additional_properties = (
1641
1642
                self.guided_decoding_disable_additional_properties
            )
1643

1644
        observability_config = ObservabilityConfig(
1645
            show_hidden_metrics_for_version=(self.show_hidden_metrics_for_version),
1646
            otlp_traces_endpoint=self.otlp_traces_endpoint,
1647
            collect_detailed_traces=self.collect_detailed_traces,
1648
        )
1649

1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
        # Compilation config overrides
        if self.cuda_graph_sizes is not None:
            logger.warning(
                "--cuda-graph-sizes is deprecated and will be removed in v0.13.0 or "
                "v1.0.0, whichever is soonest. Please use --cudagraph-capture-sizes "
                "instead."
            )
            if self.compilation_config.cudagraph_capture_sizes is not None:
                raise ValueError(
                    "cuda_graph_sizes and compilation_config."
                    "cudagraph_capture_sizes are mutually exclusive"
                )
            self.compilation_config.cudagraph_capture_sizes = self.cuda_graph_sizes
        if self.cudagraph_capture_sizes is not None:
            if self.compilation_config.cudagraph_capture_sizes is not None:
                raise ValueError(
                    "cudagraph_capture_sizes and compilation_config."
                    "cudagraph_capture_sizes are mutually exclusive"
                )
            self.compilation_config.cudagraph_capture_sizes = (
                self.cudagraph_capture_sizes
            )
        if self.max_cudagraph_capture_size is not None:
            if self.compilation_config.max_cudagraph_capture_size is not None:
                raise ValueError(
                    "max_cudagraph_capture_size and compilation_config."
                    "max_cudagraph_capture_size are mutually exclusive"
                )
            self.compilation_config.max_cudagraph_capture_size = (
                self.max_cudagraph_capture_size
            )

1682
        config = VllmConfig(
1683
1684
1685
1686
1687
1688
1689
1690
            model_config=model_config,
            cache_config=cache_config,
            parallel_config=parallel_config,
            scheduler_config=scheduler_config,
            device_config=device_config,
            lora_config=lora_config,
            speculative_config=speculative_config,
            load_config=load_config,
1691
            structured_outputs_config=self.structured_outputs_config,
1692
            observability_config=observability_config,
1693
            compilation_config=self.compilation_config,
1694
            kv_transfer_config=self.kv_transfer_config,
1695
            kv_events_config=self.kv_events_config,
1696
            additional_config=self.additional_config,
1697
        )
1698

1699
1700
        return config

1701
1702
1703
1704
1705
1706
    def _is_v1_supported_oracle(self, model_config: ModelConfig) -> bool:
        """Oracle for whether to use V0 or V1 Engine by default."""

        #############################################################
        # Unsupported Feature Flags on V1.

1707
1708
1709
1710
        if self.logits_processor_pattern != EngineArgs.logits_processor_pattern:
            _raise_or_fallback(
                feature_name="--logits-processor-pattern", recommend_to_remove=False
            )
1711
1712
1713
            return False

        # No Concurrent Partial Prefills so far.
1714
1715
1716
1717
1718
1719
1720
1721
        if (
            self.max_num_partial_prefills != SchedulerConfig.max_num_partial_prefills
            or self.max_long_partial_prefills
            != SchedulerConfig.max_long_partial_prefills
        ):
            _raise_or_fallback(
                feature_name="Concurrent Partial Prefill", recommend_to_remove=False
            )
1722
1723
            return False

1724
        # V1 supports N-gram, Medusa, and Eagle speculative decoding.
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
        if self.speculative_config is not None:
            # speculative_config could still be a dict at this point
            if isinstance(self.speculative_config, dict):
                method = self.speculative_config.get("method", None)
            else:
                method = self.speculative_config.method

            if method == "draft_model":
                raise NotImplementedError(
                    "Draft model speculative decoding is not supported yet. "
                    "Please consider using other speculative decoding methods "
1736
1737
                    "such as ngram, medusa, eagle, or mtp."
                )
1738
1739

        V1_BACKENDS = [
1740
1741
            "FLASH_ATTN",
            "PALLAS",
1742
            "TRITON_ATTN",
1743
            "TRITON_MLA",
1744
            "CUTLASS_MLA",
1745
            "FLASHMLA",
1746
            "FLASH_ATTN_MLA",
1747
            "FLASHINFER",
1748
            "FLASHINFER_MLA",
1749
            "ROCM_AITER_MLA",
1750
            "TORCH_SDPA",
1751
            "FLEX_ATTENTION",
1752
            "TREE_ATTN",
1753
1754
            "XFORMERS",
            "ROCM_ATTN",
1755
            "ROCM_AITER_UNIFIED_ATTN",
1756
        ]
1757
1758
1759
1760
        if (
            envs.is_set("VLLM_ATTENTION_BACKEND")
            and envs.VLLM_ATTENTION_BACKEND not in V1_BACKENDS
        ):
1761
1762
1763
1764
1765
1766
1767
            name = f"VLLM_ATTENTION_BACKEND={envs.VLLM_ATTENTION_BACKEND}"
            _raise_or_fallback(feature_name=name, recommend_to_remove=True)
            return False

        #############################################################
        # Experimental Features - allow users to opt in.

1768
        if self.pipeline_parallel_size > 1:
1769
1770
1771
            supports_pp = getattr(
                self.distributed_executor_backend, "supports_pp", False
            )
1772
            if not supports_pp and self.distributed_executor_backend not in (
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
                ParallelConfig.distributed_executor_backend,
                "ray",
                "mp",
                "external_launcher",
            ):
                name = (
                    "Pipeline Parallelism without Ray distributed "
                    "executor or multiprocessing executor or external "
                    "launcher"
                )
                _raise_or_fallback(feature_name=name, recommend_to_remove=False)
1784
                return False
1785

1786
1787
1788
1789
        if current_platform.is_cpu() and model_config.get_sliding_window() is not None:
            _raise_or_fallback(
                feature_name="sliding window (CPU backend)", recommend_to_remove=False
            )
1790
1791
            return False

1792
1793
1794
1795
        #############################################################

        return True

1796
1797
1798
    def _set_default_args(
        self, usage_context: UsageContext, model_config: ModelConfig
    ) -> None:
1799
        """Set Default Arguments for V1 Engine."""
1800

1801
        # V1 uses chunked prefills and prefix caching by default
1802
1803
1804
1805
        # for non-pooling tasks.
        # For pooling tasks the default is False
        if model_config.runner_type != "pooling":
            self.enable_chunked_prefill = True
1806

1807
            if self.enable_prefix_caching is None:
1808
1809
1810
1811
1812
1813
                # Disable prefix caching default for hybrid models
                # since the feature is still experimental.
                if model_config.is_hybrid:
                    self.enable_prefix_caching = False
                else:
                    self.enable_prefix_caching = True
1814
1815
        else:
            pooling_type = model_config.pooler_config.pooling_type
1816
            is_causal = getattr(model_config.hf_config, "is_causal", True)
1817
1818
1819
1820
1821
            incremental_prefill_supported = (
                pooling_type is not None
                and pooling_type.lower() == "last"
                and is_causal
            )
1822

1823
            action = "Enabling" if incremental_prefill_supported else "Disabling"
1824
1825
1826
1827
1828
1829
1830
1831

            if self.enable_chunked_prefill is None:
                self.enable_chunked_prefill = incremental_prefill_supported
                logger.info("(%s) chunked prefill by default", action)
            if self.enable_prefix_caching is None:
                self.enable_prefix_caching = incremental_prefill_supported
                logger.info("(%s) prefix caching by default", action)

1832
1833
        # When no user override, set the default values based on the usage
        # context.
1834
        # Use different default values for different hardware.
1835
1836
1837
1838
1839
1840
1841

        # 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:
1842
            device_memory = current_platform.get_device_total_memory()
1843
            device_name = current_platform.get_device_name().lower()
1844
1845
        except Exception:
            # This is only used to set default_max_num_batched_tokens
1846
            device_memory = 0
1847

1848
1849
1850
        # 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.
1851
        from vllm.usage.usage_lib import UsageContext
1852

1853
        if device_memory >= 70 * GiB_bytes and "a100" not in device_name:
1854
            # For GPUs like H100 and MI300x, use larger default values.
1855
1856
1857
1858
            default_max_num_batched_tokens = {
                UsageContext.LLM_CLASS: 16384,
                UsageContext.OPENAI_API_SERVER: 8192,
            }
1859
1860
1861
1862
            default_max_num_seqs = {
                UsageContext.LLM_CLASS: 1024,
                UsageContext.OPENAI_API_SERVER: 1024,
            }
1863
1864
1865
1866
1867
1868
        else:
            # TODO(woosuk): Tune the default values for other hardware.
            default_max_num_batched_tokens = {
                UsageContext.LLM_CLASS: 8192,
                UsageContext.OPENAI_API_SERVER: 2048,
            }
1869
1870
1871
1872
            default_max_num_seqs = {
                UsageContext.LLM_CLASS: 256,
                UsageContext.OPENAI_API_SERVER: 256,
            }
1873

1874
1875
1876
1877
        # tpu specific default values.
        if current_platform.is_tpu():
            default_max_num_batched_tokens_tpu = {
                UsageContext.LLM_CLASS: {
1878
1879
1880
                    "V6E": 2048,
                    "V5E": 1024,
                    "V5P": 512,
1881
1882
                },
                UsageContext.OPENAI_API_SERVER: {
1883
1884
1885
1886
                    "V6E": 1024,
                    "V5E": 512,
                    "V5P": 256,
                },
1887
1888
            }

1889
1890
        # cpu specific default values.
        if current_platform.is_cpu():
1891
            world_size = self.pipeline_parallel_size * self.tensor_parallel_size
1892
            default_max_num_batched_tokens = {
1893
1894
                UsageContext.LLM_CLASS: 4096 * world_size,
                UsageContext.OPENAI_API_SERVER: 2048 * world_size,
1895
1896
            }
            default_max_num_seqs = {
1897
1898
                UsageContext.LLM_CLASS: 256 * world_size,
                UsageContext.OPENAI_API_SERVER: 128 * world_size,
1899
1900
            }

1901
        use_context_value = usage_context.value if usage_context else None
1902
1903
1904
1905
        if (
            self.max_num_batched_tokens is None
            and usage_context in default_max_num_batched_tokens
        ):
1906
1907
            if current_platform.is_tpu():
                chip_name = current_platform.get_device_name()
1908
1909
1910
1911
                if chip_name in default_max_num_batched_tokens_tpu[usage_context]:
                    self.max_num_batched_tokens = default_max_num_batched_tokens_tpu[
                        usage_context
                    ][chip_name]
1912
                else:
1913
1914
1915
                    self.max_num_batched_tokens = default_max_num_batched_tokens[
                        usage_context
                    ]
1916
            else:
1917
1918
1919
                if not self.enable_chunked_prefill:
                    self.max_num_batched_tokens = model_config.max_model_len
                else:
1920
1921
1922
                    self.max_num_batched_tokens = default_max_num_batched_tokens[
                        usage_context
                    ]
1923
            logger.debug(
1924
                "Setting max_num_batched_tokens to %d for %s usage context.",
1925
1926
1927
                self.max_num_batched_tokens,
                use_context_value,
            )
1928

1929
1930
1931
1932
1933
        if self.max_num_seqs is None and usage_context in default_max_num_seqs:
            self.max_num_seqs = min(
                default_max_num_seqs[usage_context],
                self.max_num_batched_tokens or sys.maxsize,
            )
1934

1935
1936
1937
1938
1939
            logger.debug(
                "Setting max_num_seqs to %d for %s usage context.",
                self.max_num_seqs,
                use_context_value,
            )
1940

1941

1942
@dataclass
Zhuohan Li's avatar
Zhuohan Li committed
1943
class AsyncEngineArgs(EngineArgs):
Woosuk Kwon's avatar
Woosuk Kwon committed
1944
    """Arguments for asynchronous vLLM engine."""
1945

1946
1947
1948
1949
1950
1951
    enable_log_requests: bool = False

    @property
    @deprecated(
        "`disable_log_requests` is deprecated and has been replaced with "
        "`enable_log_requests`. This will be removed in v0.12.0. Please use "
1952
1953
        "`enable_log_requests` instead."
    )
1954
1955
1956
1957
1958
1959
1960
    def disable_log_requests(self) -> bool:
        return not self.enable_log_requests

    @disable_log_requests.setter
    @deprecated(
        "`disable_log_requests` is deprecated and has been replaced with "
        "`enable_log_requests`. This will be removed in v0.12.0. Please use "
1961
1962
        "`enable_log_requests` instead."
    )
1963
1964
    def disable_log_requests(self, value: bool):
        self.enable_log_requests = not value
1965
1966

    @staticmethod
1967
1968
1969
    def add_cli_args(
        parser: FlexibleArgumentParser, async_args_only: bool = False
    ) -> FlexibleArgumentParser:
1970
        # Initialize plugin to update the parser, for example, The plugin may
1971
        # add a new kind of quantization method to --quantization argument or
1972
1973
        # a new device to --device argument.
        load_general_plugins()
1974
1975
        if not async_args_only:
            parser = EngineArgs.add_cli_args(parser)
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
        parser.add_argument(
            "--enable-log-requests",
            action=argparse.BooleanOptionalAction,
            default=AsyncEngineArgs.enable_log_requests,
            help="Enable logging requests.",
        )
        parser.add_argument(
            "--disable-log-requests",
            action=argparse.BooleanOptionalAction,
            default=not AsyncEngineArgs.enable_log_requests,
            help="[DEPRECATED] Disable logging requests.",
            deprecated=True,
        )
1989
        current_platform.pre_register_and_update(parser)
1990
        return parser
1991
1992


1993
1994
1995
def _raise_or_fallback(feature_name: str, recommend_to_remove: bool):
    if envs.is_set("VLLM_USE_V1") and envs.VLLM_USE_V1:
        raise NotImplementedError(
1996
1997
            f"VLLM_USE_V1=1 is not supported with {feature_name}."
        )
1998
1999
2000
2001
2002
2003
2004
2005
    msg = f"{feature_name} is not supported by the V1 Engine. "
    msg += "Falling back to V0. "
    if recommend_to_remove:
        msg += f"We recommend to remove {feature_name} from your config "
        msg += "in favor of the V1 Engine."
    logger.warning(msg)


2006
2007
2008
def human_readable_int(value):
    """Parse human-readable integers like '1k', '2M', etc.
    Including decimal values with decimal multipliers.
2009

2010
2011
2012
2013
2014
2015
    Examples:
    - '1k' -> 1,000
    - '1K' -> 1,024
    - '25.6k' -> 25,600
    """
    value = value.strip()
2016
    match = re.fullmatch(r"(\d+(?:\.\d+)?)([kKmMgGtT])", value)
2017
2018
    if match:
        decimal_multiplier = {
2019
2020
2021
            "k": 10**3,
            "m": 10**6,
            "g": 10**9,
2022
2023
        }
        binary_multiplier = {
2024
2025
2026
            "K": 2**10,
            "M": 2**20,
            "G": 2**30,
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
        }

        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:
2039
2040
2041
2042
2043
                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
2044
2045
2046

    # Regular plain number.
    return int(value)