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

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

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

34
import vllm.envs as envs
35
from vllm.config import (
36
    AttentionConfig,
37
38
39
40
    CacheConfig,
    CompilationConfig,
    ConfigType,
    DeviceConfig,
41
    ECTransferConfig,
42
43
44
45
46
47
    EPLBConfig,
    KVEventsConfig,
    KVTransferConfig,
    LoadConfig,
    LoRAConfig,
    ModelConfig,
48
    MultiModalConfig,
49
50
51
    ObservabilityConfig,
    ParallelConfig,
    PoolerConfig,
52
    ProfilerConfig,
53
54
55
56
57
58
    SchedulerConfig,
    SpeculativeConfig,
    StructuredOutputsConfig,
    VllmConfig,
    get_attr_docs,
)
59
60
61
62
from vllm.config.cache import (
    BlockSize,
    CacheDType,
    KVOffloadingBackend,
63
    MambaCacheMode,
64
65
66
    MambaDType,
    PrefixCachingHashAlgo,
)
67
68
69
70
71
72
73
from vllm.config.device import Device
from vllm.config.model import (
    ConvertOption,
    HfOverrides,
    LogprobsMode,
    ModelDType,
    RunnerOption,
74
    TokenizerMode,
75
76
77
78
79
)
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
80
from vllm.config.utils import get_field
81
from vllm.config.vllm import OptimizationLevel
82
from vllm.logger import init_logger, suppress_logging
83
from vllm.platforms import CpuArchEnum, current_platform
84
from vllm.plugins import load_general_plugins
85
from vllm.ray.lazy_utils import is_in_ray_actor, is_ray_initialized
86
87
88
89
from vllm.transformers_utils.config import (
    is_interleaved,
    maybe_override_with_speculators,
)
90
from vllm.transformers_utils.gguf_utils import is_gguf
91
from vllm.transformers_utils.repo_utils import get_model_path
92
from vllm.transformers_utils.utils import is_cloud_storage
93
from vllm.utils.argparse_utils import FlexibleArgumentParser
94
from vllm.utils.mem_constants import GiB_bytes
95
from vllm.utils.network_utils import get_ip
96
from vllm.utils.torch_utils import resolve_kv_cache_dtype_string
97
from vllm.v1.attention.backends.registry import AttentionBackendEnum
98
from vllm.v1.sample.logits_processor import LogitsProcessor
99

100
101
if TYPE_CHECKING:
    from vllm.model_executor.layers.quantization import QuantizationMethods
102
    from vllm.model_executor.model_loader import LoadFormats
103
    from vllm.usage.usage_lib import UsageContext
104
    from vllm.v1.executor import Executor
105
else:
106
    Executor = Any
107
    QuantizationMethods = Any
108
    LoadFormats = Any
109
110
    UsageContext = Any

111

112
113
logger = init_logger(__name__)

114
115
# object is used to allow for special typing forms
T = TypeVar("T")
116
117
TypeHint: TypeAlias = type[Any] | object
TypeHintT: TypeAlias = type[T] | object
118

119

120
121
def parse_type(return_type: Callable[[str], T]) -> Callable[[str], T]:
    def _parse_type(val: str) -> T:
122
123
124
125
        try:
            return return_type(val)
        except ValueError as e:
            raise argparse.ArgumentTypeError(
126
127
                f"Value {val} cannot be converted to {return_type}."
            ) from e
128

129
130
131
    return _parse_type


132
133
def optional_type(return_type: Callable[[str], T]) -> Callable[[str], T | None]:
    def _optional_type(val: str) -> T | None:
134
135
136
137
        if val == "" or val == "None":
            return None
        return parse_type(return_type)(val)

138
    return _optional_type
139
140


141
def union_dict_and_str(val: str) -> str | dict[str, str] | None:
142
    if not re.match(r"(?s)^\s*{.*}\s*$", val):
143
        return str(val)
144
    return optional_type(json.loads)(val)
145
146


147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
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)


162
def literal_to_kwargs(type_hints: set[TypeHint]) -> dict[str, Any]:
163
164
165
166
    """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`.
    """
167
    type_hint = get_type(type_hints, Literal)
168
169
170
    options = get_args(type_hint)
    option_type = type(options[0])
    if not all(isinstance(option, option_type) for option in options):
171
        raise ValueError(
172
            "All options must be of the same type. "
173
174
            f"Got {options} with types {[type(c) for c in options]}"
        )
175
176
    kwarg = "metavar" if contains_type(type_hints, str) else "choices"
    return {"type": option_type, kwarg: sorted(options)}
177
178


179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
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),
    }


204
205
206
207
208
def is_not_builtin(type_hint: TypeHint) -> bool:
    """Check if the class is not a built-in type."""
    return type_hint.__module__ != "builtins"


209
210
211
212
213
214
215
216
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]))
217
218
    elif origin in {Union, UnionType}:
        # Union for Union[X, Y] and UnionType for X | Y
219
220
221
222
223
224
225
226
        for arg in args:
            type_hints.update(get_type_hints(arg))
    else:
        type_hints.add(type_hint)

    return type_hints


227
NEEDS_HELP = (
228
229
    any("--help" in arg for arg in sys.argv)  # vllm SUBCOMMAND --help
    or (argv0 := sys.argv[0]).endswith("mkdocs")  # mkdocs SUBCOMMAND
230
231
232
233
    or argv0.endswith("mkdocs/__main__.py")  # python -m mkdocs SUBCOMMAND
)


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

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

247
        # Get the default value of the field
248
249
        if field.default is not MISSING:
            default = field.default
250
251
            # Handle pydantic.Field defaults
            if isinstance(default, FieldInfo):
252
253
254
255
256
257
258
                if default.default_factory is None:
                    default = default.default
                else:
                    # VllmConfig's Fields have default_factory set to config classes.
                    # These could emit logs on init, which would be confusing.
                    with suppress_logging():
                        default = default.default_factory()
259
        elif field.default_factory is not MISSING:
260
            default = field.default_factory()
261
262
263

        # Get the help text for the field
        name = field.name
264
        help = cls_docs.get(name, "").strip()
265
266
267
268
269
270
271
        # 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
272
273
274
        json_tip = (
            "Should either be a valid JSON string or JSON keys passed individually."
        )
275
        if dataclass_cls is not None:
276
277
278
279
280
281
282
283

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

322
323
324
325
326
        # 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"]}))

327
328
329
330
331
332
333
        # 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
334
335


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

339
340
341
    If `--help` or `mkdocs` are not present in the command line command, the
    attribute documentation will not be included in the help output.

342
343
344
345
346
347
348
    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))


349
@dataclass
Zhuohan Li's avatar
Zhuohan Li committed
350
class EngineArgs:
Woosuk Kwon's avatar
Woosuk Kwon committed
351
    """Arguments for vLLM engine."""
352

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

490
    ray_workers_use_nsight: bool = ParallelConfig.ray_workers_use_nsight
491
    num_gpu_blocks_override: int | None = CacheConfig.num_gpu_blocks_override
492
    model_loader_extra_config: dict = get_field(LoadConfig, "model_loader_extra_config")
493
    ignore_patterns: str | list[str] = get_field(LoadConfig, "ignore_patterns")
494

495
    enable_chunked_prefill: bool | None = None
496
    disable_chunked_mm_input: bool = SchedulerConfig.disable_chunked_mm_input
497

498
    disable_hybrid_kv_cache_manager: bool | None = (
499
500
        SchedulerConfig.disable_hybrid_kv_cache_manager
    )
501

502
    structured_outputs_config: StructuredOutputsConfig = get_field(
503
504
        VllmConfig, "structured_outputs_config"
    )
505
    reasoning_parser: str = StructuredOutputsConfig.reasoning_parser
506
    reasoning_parser_plugin: str | None = None
507

508
    logits_processor_pattern: str | None = ModelConfig.logits_processor_pattern
509

510
    speculative_config: dict[str, Any] | None = None
511

512
    show_hidden_metrics_for_version: str | None = (
513
        ObservabilityConfig.show_hidden_metrics_for_version
514
    )
515
516
    otlp_traces_endpoint: str | None = ObservabilityConfig.otlp_traces_endpoint
    collect_detailed_traces: list[DetailedTraceModules] | None = (
517
        ObservabilityConfig.collect_detailed_traces
518
    )
519
520
521
522
    kv_cache_metrics: bool = ObservabilityConfig.kv_cache_metrics
    kv_cache_metrics_sample: float = get_field(
        ObservabilityConfig, "kv_cache_metrics_sample"
    )
523
    cudagraph_metrics: bool = ObservabilityConfig.cudagraph_metrics
524
525
526
    enable_layerwise_nvtx_tracing: bool = (
        ObservabilityConfig.enable_layerwise_nvtx_tracing
    )
527
    enable_mfu_metrics: bool = ObservabilityConfig.enable_mfu_metrics
528
529
530
    enable_logging_iteration_details: bool = (
        ObservabilityConfig.enable_logging_iteration_details
    )
531
    enable_mm_processor_stats: bool = ObservabilityConfig.enable_mm_processor_stats
532
    scheduling_policy: SchedulerPolicy = SchedulerConfig.policy
533
    scheduler_cls: str | type[object] | None = SchedulerConfig.scheduler_cls
534

535
    pooler_config: PoolerConfig | None = ModelConfig.pooler_config
536
    compilation_config: CompilationConfig = get_field(VllmConfig, "compilation_config")
537
    attention_config: AttentionConfig = get_field(VllmConfig, "attention_config")
538
539
    worker_cls: str = ParallelConfig.worker_cls
    worker_extension_cls: str = ParallelConfig.worker_extension_cls
540

541
542
    profiler_config: ProfilerConfig = get_field(VllmConfig, "profiler_config")

543
544
    kv_transfer_config: KVTransferConfig | None = None
    kv_events_config: KVEventsConfig | None = None
545

546
547
    ec_transfer_config: ECTransferConfig | None = None

548
549
    generation_config: str = ModelConfig.generation_config
    enable_sleep_mode: bool = ModelConfig.enable_sleep_mode
550
551
552
    override_generation_config: dict[str, Any] = get_field(
        ModelConfig, "override_generation_config"
    )
553
    model_impl: str = ModelConfig.model_impl
554
    override_attention_dtype: str = ModelConfig.override_attention_dtype
555
    attention_backend: AttentionBackendEnum | None = AttentionConfig.backend
556

557
    calculate_kv_scales: bool = CacheConfig.calculate_kv_scales
558
559
    mamba_cache_dtype: MambaDType = CacheConfig.mamba_cache_dtype
    mamba_ssm_cache_dtype: MambaDType = CacheConfig.mamba_ssm_cache_dtype
560
    mamba_block_size: int | None = get_field(CacheConfig, "mamba_block_size")
561
    mamba_cache_mode: MambaCacheMode = CacheConfig.mamba_cache_mode
562

563
    additional_config: dict[str, Any] = get_field(VllmConfig, "additional_config")
564

565
    use_tqdm_on_load: bool = LoadConfig.use_tqdm_on_load
566
    pt_load_map_location: str = LoadConfig.pt_load_map_location
567

568
    logits_processors: list[str | type[LogitsProcessor]] | None = (
569
570
        ModelConfig.logits_processors
    )
571
572
    """Custom logitproc types"""

573
    async_scheduling: bool | None = SchedulerConfig.async_scheduling
574

575
576
    stream_interval: int = SchedulerConfig.stream_interval

577
    kv_sharing_fast_prefill: bool = CacheConfig.kv_sharing_fast_prefill
578
    optimization_level: OptimizationLevel = VllmConfig.optimization_level
579

580
    kv_offloading_size: float | None = CacheConfig.kv_offloading_size
581
    kv_offloading_backend: KVOffloadingBackend = CacheConfig.kv_offloading_backend
582
    tokens_only: bool = False
583

584
    def __post_init__(self):
585
586
587
        # support `EngineArgs(compilation_config={...})`
        # without having to manually construct a
        # CompilationConfig object
588
        if isinstance(self.compilation_config, dict):
589
            self.compilation_config = CompilationConfig(**self.compilation_config)
590
591
        if isinstance(self.attention_config, dict):
            self.attention_config = AttentionConfig(**self.attention_config)
592
        if isinstance(self.eplb_config, dict):
593
            self.eplb_config = EPLBConfig(**self.eplb_config)
594
        # Setup plugins
595
        from vllm.plugins import load_general_plugins
596

597
        load_general_plugins()
598
        # when use hf offline,replace model and tokenizer id to local model path
599
600
601
        if huggingface_hub.constants.HF_HUB_OFFLINE:
            model_id = self.model
            self.model = get_model_path(self.model, self.revision)
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
            if model_id is not self.model:
                logger.info(
                    "HF_HUB_OFFLINE is True, replace model_id [%s] to model_path [%s]",
                    model_id,
                    self.model,
                )
            if self.tokenizer is not None:
                tokenizer_id = self.tokenizer
                self.tokenizer = get_model_path(self.tokenizer, self.tokenizer_revision)
                if tokenizer_id is not self.tokenizer:
                    logger.info(
                        "HF_HUB_OFFLINE is True, replace tokenizer_id [%s] "
                        "to tokenizer_path [%s]",
                        tokenizer_id,
                        self.tokenizer,
                    )
618
619

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

623
        # Model arguments
624
625
626
627
628
        model_kwargs = get_kwargs(ModelConfig)
        model_group = parser.add_argument_group(
            title="ModelConfig",
            description=ModelConfig.__doc__,
        )
629
        if not ("serve" in sys.argv[1:] and "--help" in sys.argv[1:]):
630
            model_group.add_argument("--model", **model_kwargs["model"])
631
632
        model_group.add_argument("--runner", **model_kwargs["runner"])
        model_group.add_argument("--convert", **model_kwargs["convert"])
633
634
        model_group.add_argument("--tokenizer", **model_kwargs["tokenizer"])
        model_group.add_argument("--tokenizer-mode", **model_kwargs["tokenizer_mode"])
635
636
637
        model_group.add_argument(
            "--trust-remote-code", **model_kwargs["trust_remote_code"]
        )
638
639
        model_group.add_argument("--dtype", **model_kwargs["dtype"])
        model_group.add_argument("--seed", **model_kwargs["seed"])
640
        model_group.add_argument("--hf-config-path", **model_kwargs["hf_config_path"])
641
642
643
644
645
646
        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"]
        )
647
        model_group.add_argument("--revision", **model_kwargs["revision"])
648
        model_group.add_argument("--code-revision", **model_kwargs["code_revision"])
649
650
651
        model_group.add_argument(
            "--tokenizer-revision", **model_kwargs["tokenizer_revision"]
        )
652
653
        model_group.add_argument("--max-model-len", **model_kwargs["max_model_len"])
        model_group.add_argument("--quantization", "-q", **model_kwargs["quantization"])
654
655
656
657
        model_group.add_argument(
            "--allow-deprecated-quantization",
            **model_kwargs["allow_deprecated_quantization"],
        )
658
        model_group.add_argument("--enforce-eager", **model_kwargs["enforce_eager"])
659
660
661
662
        model_group.add_argument(
            "--enable-return-routed-experts",
            **model_kwargs["enable_return_routed_experts"],
        )
663
664
665
666
667
668
669
670
        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"]
        )
671
672
673
        model_group.add_argument(
            "--skip-tokenizer-init", **model_kwargs["skip_tokenizer_init"]
        )
674
675
676
677
678
679
680
        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"])
681
682
        # This one is a special case because it can bool
        # or str. TODO: Handle this in get_kwargs
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
        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(
            "--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"]
        )
705
        model_group.add_argument("--model-impl", **model_kwargs["model_impl"])
706
707
708
709
710
711
        model_group.add_argument(
            "--override-attention-dtype", **model_kwargs["override_attention_dtype"]
        )
        model_group.add_argument(
            "--logits-processors", **model_kwargs["logits_processors"]
        )
712
713
        model_group.add_argument(
            "--io-processor-plugin", **model_kwargs["io_processor_plugin"]
714
        )
715

716
717
718
719
720
721
        # Model loading arguments
        load_kwargs = get_kwargs(LoadConfig)
        load_group = parser.add_argument_group(
            title="LoadConfig",
            description=LoadConfig.__doc__,
        )
722
        load_group.add_argument("--load-format", **load_kwargs["load_format"])
723
724
725
726
727
728
729
730
731
732
733
734
        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"]
        )
735

736
737
738
739
740
741
742
743
744
745
        # Attention arguments
        attention_kwargs = get_kwargs(AttentionConfig)
        attention_group = parser.add_argument_group(
            title="AttentionConfig",
            description=AttentionConfig.__doc__,
        )
        attention_group.add_argument(
            "--attention-backend", **attention_kwargs["backend"]
        )

746
747
748
749
750
        # Structured outputs arguments
        structured_outputs_kwargs = get_kwargs(StructuredOutputsConfig)
        structured_outputs_group = parser.add_argument_group(
            title="StructuredOutputsConfig",
            description=StructuredOutputsConfig.__doc__,
751
        )
752
        structured_outputs_group.add_argument(
753
            "--reasoning-parser",
754
            # Choices need to be validated after parsing to include plugins
755
756
            **structured_outputs_kwargs["reasoning_parser"],
        )
757
758
759
760
        structured_outputs_group.add_argument(
            "--reasoning-parser-plugin",
            **structured_outputs_kwargs["reasoning_parser_plugin"],
        )
761

762
        # Parallel arguments
763
764
765
766
767
768
        parallel_kwargs = get_kwargs(ParallelConfig)
        parallel_group = parser.add_argument_group(
            title="ParallelConfig",
            description=ParallelConfig.__doc__,
        )
        parallel_group.add_argument(
769
            "--distributed-executor-backend",
770
771
            **parallel_kwargs["distributed_executor_backend"],
        )
772
        parallel_group.add_argument(
773
774
775
776
            "--pipeline-parallel-size",
            "-pp",
            **parallel_kwargs["pipeline_parallel_size"],
        )
777
778
779
780
        parallel_group.add_argument("--master-addr", **parallel_kwargs["master_addr"])
        parallel_group.add_argument("--master-port", **parallel_kwargs["master_port"])
        parallel_group.add_argument("--nnodes", "-n", **parallel_kwargs["nnodes"])
        parallel_group.add_argument("--node-rank", "-r", **parallel_kwargs["node_rank"])
781
        parallel_group.add_argument(
782
783
            "--tensor-parallel-size", "-tp", **parallel_kwargs["tensor_parallel_size"]
        )
784
        parallel_group.add_argument(
785
786
787
788
            "--decode-context-parallel-size",
            "-dcp",
            **parallel_kwargs["decode_context_parallel_size"],
        )
789
790
791
792
        parallel_group.add_argument(
            "--dcp-kv-cache-interleave-size",
            **parallel_kwargs["dcp_kv_cache_interleave_size"],
        )
793
794
795
796
797
798
799
800
801
        parallel_group.add_argument(
            "--cp-kv-cache-interleave-size",
            **parallel_kwargs["cp_kv_cache_interleave_size"],
        )
        parallel_group.add_argument(
            "--prefill-context-parallel-size",
            "-pcp",
            **parallel_kwargs["prefill_context_parallel_size"],
        )
802
803
804
805
806
807
        parallel_group.add_argument(
            "--data-parallel-size", "-dp", **parallel_kwargs["data_parallel_size"]
        )
        parallel_group.add_argument(
            "--data-parallel-rank",
            "-dpn",
808
            type=int,
809
810
811
            help="Data parallel rank of this instance. "
            "When set, enables external load balancer mode.",
        )
812
        parallel_group.add_argument(
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
            "--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".',
        )
843
        parallel_group.add_argument(
844
845
846
847
848
849
850
851
            "--data-parallel-hybrid-lb",
            "-dph",
            **parallel_kwargs["data_parallel_hybrid_lb"],
        )
        parallel_group.add_argument(
            "--data-parallel-external-lb",
            "-dpe",
            **parallel_kwargs["data_parallel_external_lb"],
852
853
        )
        parallel_group.add_argument(
854
855
856
            "--enable-expert-parallel",
            "-ep",
            **parallel_kwargs["enable_expert_parallel"],
857
        )
858
859
860
        parallel_group.add_argument(
            "--all2all-backend", **parallel_kwargs["all2all_backend"]
        )
861
        parallel_group.add_argument("--enable-dbo", **parallel_kwargs["enable_dbo"])
862
863
864
865
        parallel_group.add_argument(
            "--ubatch-size",
            **parallel_kwargs["ubatch_size"],
        )
866
867
        parallel_group.add_argument(
            "--dbo-decode-token-threshold",
868
869
            **parallel_kwargs["dbo_decode_token_threshold"],
        )
870
871
        parallel_group.add_argument(
            "--dbo-prefill-token-threshold",
872
873
            **parallel_kwargs["dbo_prefill_token_threshold"],
        )
874
875
876
877
        parallel_group.add_argument(
            "--disable-nccl-for-dp-synchronization",
            **parallel_kwargs["disable_nccl_for_dp_synchronization"],
        )
878
879
        parallel_group.add_argument("--enable-eplb", **parallel_kwargs["enable_eplb"])
        parallel_group.add_argument("--eplb-config", **parallel_kwargs["eplb_config"])
880
881
        parallel_group.add_argument(
            "--expert-placement-strategy",
882
883
            **parallel_kwargs["expert_placement_strategy"],
        )
884

885
        parallel_group.add_argument(
886
            "--max-parallel-loading-workers",
887
888
            **parallel_kwargs["max_parallel_loading_workers"],
        )
889
        parallel_group.add_argument(
890
891
            "--ray-workers-use-nsight", **parallel_kwargs["ray_workers_use_nsight"]
        )
892
        parallel_group.add_argument(
893
            "--disable-custom-all-reduce",
894
895
896
897
898
899
            **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"]
        )
900

901
902
903
904
905
        # KV cache arguments
        cache_kwargs = get_kwargs(CacheConfig)
        cache_group = parser.add_argument_group(
            title="CacheConfig",
            description=CacheConfig.__doc__,
906
        )
907
        cache_group.add_argument("--block-size", **cache_kwargs["block_size"])
908
909
910
911
912
913
        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"]
        )
914
        cache_group.add_argument("--swap-space", **cache_kwargs["swap_space"])
915
916
917
918
919
        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(
920
921
922
923
924
            "--enable-prefix-caching",
            **{
                **cache_kwargs["enable_prefix_caching"],
                "default": None,
            },
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
        )
        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"]
        )
942
943
944
        cache_group.add_argument(
            "--mamba-block-size", **cache_kwargs["mamba_block_size"]
        )
945
946
947
        cache_group.add_argument(
            "--mamba-cache-mode", **cache_kwargs["mamba_cache_mode"]
        )
948
949
950
951
952
953
        cache_group.add_argument(
            "--kv-offloading-size", **cache_kwargs["kv_offloading_size"]
        )
        cache_group.add_argument(
            "--kv-offloading-backend", **cache_kwargs["kv_offloading_backend"]
        )
954

955
        # Multimodal related configs
956
957
958
959
960
        multimodal_kwargs = get_kwargs(MultiModalConfig)
        multimodal_group = parser.add_argument_group(
            title="MultiModalConfig",
            description=MultiModalConfig.__doc__,
        )
961
        multimodal_group.add_argument(
962
963
            "--limit-mm-per-prompt", **multimodal_kwargs["limit_per_prompt"]
        )
964
965
966
        multimodal_group.add_argument(
            "--enable-mm-embeds", **multimodal_kwargs["enable_mm_embeds"]
        )
967
968
969
        multimodal_group.add_argument(
            "--media-io-kwargs", **multimodal_kwargs["media_io_kwargs"]
        )
970
971
972
973
974
975
        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"]
        )
976
        multimodal_group.add_argument(
977
978
            "--mm-processor-cache-type", **multimodal_kwargs["mm_processor_cache_type"]
        )
979
980
        multimodal_group.add_argument(
            "--mm-shm-cache-max-object-size-mb",
981
982
            **multimodal_kwargs["mm_shm_cache_max_object_size_mb"],
        )
983
984
985
        multimodal_group.add_argument(
            "--mm-encoder-only", **multimodal_kwargs["mm_encoder_only"]
        )
986
        multimodal_group.add_argument(
987
988
            "--mm-encoder-tp-mode", **multimodal_kwargs["mm_encoder_tp_mode"]
        )
989
990
991
992
        multimodal_group.add_argument(
            "--mm-encoder-attn-backend",
            **multimodal_kwargs["mm_encoder_attn_backend"],
        )
993
994
995
        multimodal_group.add_argument(
            "--interleave-mm-strings", **multimodal_kwargs["interleave_mm_strings"]
        )
996
        multimodal_group.add_argument(
997
998
            "--skip-mm-profiling", **multimodal_kwargs["skip_mm_profiling"]
        )
999

1000
        multimodal_group.add_argument(
1001
1002
            "--video-pruning-rate", **multimodal_kwargs["video_pruning_rate"]
        )
1003

1004
        # LoRA related configs
1005
1006
1007
1008
1009
1010
        lora_kwargs = get_kwargs(LoRAConfig)
        lora_group = parser.add_argument_group(
            title="LoRAConfig",
            description=LoRAConfig.__doc__,
        )
        lora_group.add_argument(
1011
            "--enable-lora",
1012
            action=argparse.BooleanOptionalAction,
1013
1014
            help="If True, enable handling of LoRA adapters.",
        )
1015
        lora_group.add_argument("--max-loras", **lora_kwargs["max_loras"])
1016
        lora_group.add_argument("--max-lora-rank", **lora_kwargs["max_lora_rank"])
1017
        lora_group.add_argument(
1018
            "--lora-dtype",
1019
1020
            **lora_kwargs["lora_dtype"],
        )
1021
1022
1023
1024
        lora_group.add_argument(
            "--enable-tower-connector-lora",
            **lora_kwargs["enable_tower_connector_lora"],
        )
1025
1026
1027
1028
1029
        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"])
1030
1031
1032
        lora_group.add_argument(
            "--specialize-active-lora", **lora_kwargs["specialize_active_lora"]
        )
1033

1034
1035
1036
1037
1038
1039
1040
1041
        # 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",
1042
1043
            **observability_kwargs["show_hidden_metrics_for_version"],
        )
1044
        observability_group.add_argument(
1045
1046
            "--otlp-traces-endpoint", **observability_kwargs["otlp_traces_endpoint"]
        )
1047
1048
1049
1050
1051
        # 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"] += [
1052
            ",".join(p) for p in permutations(get_args(DetailedTraceModules), r=2)
1053
1054
1055
        ]
        observability_group.add_argument(
            "--collect-detailed-traces",
1056
1057
            **observability_kwargs["collect_detailed_traces"],
        )
1058
1059
1060
1061
1062
1063
1064
        observability_group.add_argument(
            "--kv-cache-metrics", **observability_kwargs["kv_cache_metrics"]
        )
        observability_group.add_argument(
            "--kv-cache-metrics-sample",
            **observability_kwargs["kv_cache_metrics_sample"],
        )
1065
1066
1067
1068
        observability_group.add_argument(
            "--cudagraph-metrics",
            **observability_kwargs["cudagraph_metrics"],
        )
1069
1070
1071
1072
        observability_group.add_argument(
            "--enable-layerwise-nvtx-tracing",
            **observability_kwargs["enable_layerwise_nvtx_tracing"],
        )
1073
1074
1075
1076
        observability_group.add_argument(
            "--enable-mfu-metrics",
            **observability_kwargs["enable_mfu_metrics"],
        )
1077
1078
1079
1080
        observability_group.add_argument(
            "--enable-logging-iteration-details",
            **observability_kwargs["enable_logging_iteration_details"],
        )
1081

1082
1083
1084
1085
1086
1087
1088
        # Scheduler arguments
        scheduler_kwargs = get_kwargs(SchedulerConfig)
        scheduler_group = parser.add_argument_group(
            title="SchedulerConfig",
            description=SchedulerConfig.__doc__,
        )
        scheduler_group.add_argument(
1089
1090
1091
1092
1093
            "--max-num-batched-tokens",
            **{
                **scheduler_kwargs["max_num_batched_tokens"],
                "default": None,
            },
1094
        )
1095
        scheduler_group.add_argument(
1096
1097
1098
1099
1100
            "--max-num-seqs",
            **{
                **scheduler_kwargs["max_num_seqs"],
                "default": None,
            },
1101
1102
1103
1104
        )
        scheduler_group.add_argument(
            "--max-num-partial-prefills", **scheduler_kwargs["max_num_partial_prefills"]
        )
1105
1106
        scheduler_group.add_argument(
            "--max-long-partial-prefills",
1107
1108
            **scheduler_kwargs["max_long_partial_prefills"],
        )
1109
1110
        scheduler_group.add_argument(
            "--long-prefill-token-threshold",
1111
1112
            **scheduler_kwargs["long_prefill_token_threshold"],
        )
1113
1114
        # multi-step scheduling has been removed; corresponding arguments
        # are no longer supported.
1115
        scheduler_group.add_argument(
1116
1117
            "--scheduling-policy", **scheduler_kwargs["policy"]
        )
1118
        scheduler_group.add_argument(
1119
1120
1121
1122
1123
            "--enable-chunked-prefill",
            **{
                **scheduler_kwargs["enable_chunked_prefill"],
                "default": None,
            },
1124
1125
1126
1127
1128
1129
1130
        )
        scheduler_group.add_argument(
            "--disable-chunked-mm-input", **scheduler_kwargs["disable_chunked_mm_input"]
        )
        scheduler_group.add_argument(
            "--scheduler-cls", **scheduler_kwargs["scheduler_cls"]
        )
1131
1132
        scheduler_group.add_argument(
            "--disable-hybrid-kv-cache-manager",
1133
1134
1135
1136
1137
            **scheduler_kwargs["disable_hybrid_kv_cache_manager"],
        )
        scheduler_group.add_argument(
            "--async-scheduling", **scheduler_kwargs["async_scheduling"]
        )
1138
1139
1140
        scheduler_group.add_argument(
            "--stream-interval", **scheduler_kwargs["stream_interval"]
        )
1141

1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
        # Compilation arguments
        compilation_kwargs = get_kwargs(CompilationConfig)
        compilation_group = parser.add_argument_group(
            title="CompilationConfig",
            description=CompilationConfig.__doc__,
        )
        compilation_group.add_argument(
            "--cudagraph-capture-sizes", **compilation_kwargs["cudagraph_capture_sizes"]
        )
        compilation_group.add_argument(
            "--max-cudagraph-capture-size",
            **compilation_kwargs["max_cudagraph_capture_size"],
        )

1156
        # vLLM arguments
1157
        vllm_kwargs = get_kwargs(VllmConfig)
1158
1159
1160
1161
        vllm_group = parser.add_argument_group(
            title="VllmConfig",
            description=VllmConfig.__doc__,
        )
1162
1163
1164
1165
        # 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)
1166
1167
1168
1169
1170
1171
1172
        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"])
1173
1174
1175
        vllm_group.add_argument(
            "--ec-transfer-config", **vllm_kwargs["ec_transfer_config"]
        )
1176
        vllm_group.add_argument(
1177
            "--compilation-config", "-cc", **vllm_kwargs["compilation_config"]
1178
        )
1179
1180
1181
        vllm_group.add_argument(
            "--attention-config", "-ac", **vllm_kwargs["attention_config"]
        )
1182
1183
1184
1185
1186
1187
        vllm_group.add_argument(
            "--additional-config", **vllm_kwargs["additional_config"]
        )
        vllm_group.add_argument(
            "--structured-outputs-config", **vllm_kwargs["structured_outputs_config"]
        )
1188
        vllm_group.add_argument("--profiler-config", **vllm_kwargs["profiler_config"])
1189
1190
1191
1192
        vllm_group.add_argument(
            "--optimization-level", **vllm_kwargs["optimization_level"]
        )

1193
        # Other arguments
1194
1195
1196
1197
1198
        parser.add_argument(
            "--disable-log-stats",
            action="store_true",
            help="Disable logging statistics.",
        )
1199

1200
1201
1202
1203
1204
1205
        parser.add_argument(
            "--aggregate-engine-logging",
            action="store_true",
            help="Log aggregate rather than per-engine statistics "
            "when using data parallelism.",
        )
1206
        return parser
1207
1208

    @classmethod
1209
    def from_cli_args(cls, args: argparse.Namespace):
1210
1211
1212
        # Get the list of attributes of this dataclass.
        attrs = [attr.name for attr in dataclasses.fields(cls)]
        # Set the attributes from the parsed arguments.
1213
1214
1215
        engine_args = cls(
            **{attr: getattr(args, attr) for attr in attrs if hasattr(args, attr)}
        )
Zhuohan Li's avatar
Zhuohan Li committed
1216
        return engine_args
1217

1218
    def create_model_config(self) -> ModelConfig:
1219
1220
        # gguf file needs a specific model loader
        if is_gguf(self.model):
1221
1222
            self.quantization = self.load_format = "gguf"

1223
1224
1225
1226
1227
1228
1229
        if not envs.VLLM_ENABLE_V1_MULTIPROCESSING:
            logger.warning(
                "The global random seed is set to %d. Since "
                "VLLM_ENABLE_V1_MULTIPROCESSING is set to False, this may "
                "affect the random state of the Python process that "
                "launched vLLM.",
                self.seed,
1230
1231
            )

1232
        return ModelConfig(
1233
            model=self.model,
1234
            model_weights=self.model_weights,
1235
            hf_config_path=self.hf_config_path,
1236
1237
            runner=self.runner,
            convert=self.convert,
1238
1239
            tokenizer=self.tokenizer,
            tokenizer_mode=self.tokenizer_mode,
1240
            trust_remote_code=self.trust_remote_code,
1241
1242
            allowed_local_media_path=self.allowed_local_media_path,
            allowed_media_domains=self.allowed_media_domains,
1243
1244
1245
1246
            dtype=self.dtype,
            seed=self.seed,
            revision=self.revision,
            code_revision=self.code_revision,
1247
            hf_token=self.hf_token,
1248
            hf_overrides=self.hf_overrides,
1249
            tokenizer_revision=self.tokenizer_revision,
1250
1251
            max_model_len=self.max_model_len,
            quantization=self.quantization,
1252
            allow_deprecated_quantization=self.allow_deprecated_quantization,
1253
            enforce_eager=self.enforce_eager,
1254
            enable_return_routed_experts=self.enable_return_routed_experts,
1255
            max_logprobs=self.max_logprobs,
1256
            logprobs_mode=self.logprobs_mode,
1257
            disable_sliding_window=self.disable_sliding_window,
1258
            disable_cascade_attn=self.disable_cascade_attn,
1259
            skip_tokenizer_init=self.skip_tokenizer_init,
1260
            enable_prompt_embeds=self.enable_prompt_embeds,
1261
            served_model_name=self.served_model_name,
1262
            limit_mm_per_prompt=self.limit_mm_per_prompt,
1263
            enable_mm_embeds=self.enable_mm_embeds,
1264
            interleave_mm_strings=self.interleave_mm_strings,
1265
            media_io_kwargs=self.media_io_kwargs,
1266
            skip_mm_profiling=self.skip_mm_profiling,
1267
            config_format=self.config_format,
1268
            mm_processor_kwargs=self.mm_processor_kwargs,
1269
            mm_processor_cache_gb=self.mm_processor_cache_gb,
1270
            mm_processor_cache_type=self.mm_processor_cache_type,
1271
            mm_shm_cache_max_object_size_mb=self.mm_shm_cache_max_object_size_mb,
1272
            mm_encoder_only=self.mm_encoder_only,
1273
            mm_encoder_tp_mode=self.mm_encoder_tp_mode,
1274
            mm_encoder_attn_backend=self.mm_encoder_attn_backend,
1275
            pooler_config=self.pooler_config,
1276
            logits_processor_pattern=self.logits_processor_pattern,
1277
            generation_config=self.generation_config,
1278
            override_generation_config=self.override_generation_config,
1279
            enable_sleep_mode=self.enable_sleep_mode,
1280
            model_impl=self.model_impl,
1281
            override_attention_dtype=self.override_attention_dtype,
1282
            logits_processors=self.logits_processors,
1283
            video_pruning_rate=self.video_pruning_rate,
1284
            io_processor_plugin=self.io_processor_plugin,
1285
        )
1286

1287
    def validate_tensorizer_args(self):
1288
1289
        from vllm.model_executor.model_loader.tensorizer import TensorizerConfig

1290
1291
        for key in self.model_loader_extra_config:
            if key in TensorizerConfig._fields:
1292
1293
1294
                self.model_loader_extra_config["tensorizer_config"][key] = (
                    self.model_loader_extra_config[key]
                )
1295

1296
    def create_load_config(self) -> LoadConfig:
1297
1298
        if self.quantization == "bitsandbytes":
            self.load_format = "bitsandbytes"
1299

1300
1301
1302
        if self.load_format == "tensorizer":
            if hasattr(self.model_loader_extra_config, "to_serializable"):
                self.model_loader_extra_config = (
1303
1304
                    self.model_loader_extra_config.to_serializable()
                )
1305
            self.model_loader_extra_config["tensorizer_config"] = {}
1306
1307
1308
            self.model_loader_extra_config["tensorizer_config"]["tensorizer_dir"] = (
                self.model
            )
1309
            self.validate_tensorizer_args()
1310

1311
1312
1313
        return LoadConfig(
            load_format=self.load_format,
            download_dir=self.download_dir,
1314
            safetensors_load_strategy=self.safetensors_load_strategy,
1315
1316
            model_loader_extra_config=self.model_loader_extra_config,
            ignore_patterns=self.ignore_patterns,
1317
            use_tqdm_on_load=self.use_tqdm_on_load,
1318
            pt_load_map_location=self.pt_load_map_location,
1319
        )
1320

1321
1322
1323
1324
    def create_speculative_config(
        self,
        target_model_config: ModelConfig,
        target_parallel_config: ParallelConfig,
1325
    ) -> SpeculativeConfig | None:
1326
1327
1328
1329
1330
1331
        """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
1332
        dictionary from the engine.
1333
1334
        """
        if self.speculative_config is None:
1335
            return None
1336

1337
1338
1339
        # Note(Shangming): These parameters are not obtained from the cli arg
        # '--speculative-config' and must be passed in when creating the engine
        # config.
1340
1341
1342
1343
1344
1345
        self.speculative_config.update(
            {
                "target_model_config": target_model_config,
                "target_parallel_config": target_parallel_config,
            }
        )
1346
        return SpeculativeConfig(**self.speculative_config)
1347

1348
1349
    def create_engine_config(
        self,
1350
        usage_context: UsageContext | None = None,
1351
        headless: bool = False,
1352
1353
1354
1355
    ) -> VllmConfig:
        """
        Create the VllmConfig.

1356
        NOTE: If VllmConfig is incompatible, we raise an error.
1357
        """
1358
        current_platform.pre_register_and_update()
1359

1360
        device_config = DeviceConfig(device=cast(Device, current_platform.device_type))
1361

1362
1363
        # Check if the model is a speculator and override model/tokenizer/config
        # BEFORE creating ModelConfig, so the config is created with the target model
1364
1365
1366
1367
        # Skip speculator detection for cloud storage models (eg: S3, GCS) since
        # HuggingFace cannot load configs directly from S3 URLs. S3 models can still
        # use speculators with explicit --speculative-config.
        if not is_cloud_storage(self.model):
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
            (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,
                )
            )

1378
        model_config = self.create_model_config()
1379
        self.model = model_config.model
1380
        self.model_weights = model_config.model_weights
1381
1382
        self.tokenizer = model_config.tokenizer

1383
        self._check_feature_supported(model_config)
1384
1385
1386
1387
        self._set_default_chunked_prefill_and_prefix_caching_args(model_config)
        self._set_default_max_num_seqs_and_batched_tokens_args(
            usage_context, model_config
        )
1388

1389
        sliding_window: int | None = None
1390
1391
1392
1393
1394
1395
        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()

1396
1397
1398
1399
1400
        # Resolve "auto" kv_cache_dtype to actual value from model config
        resolved_cache_dtype = resolve_kv_cache_dtype_string(
            self.kv_cache_dtype, model_config
        )

1401
        cache_config = CacheConfig(
1402
            block_size=self.block_size,
1403
            gpu_memory_utilization=self.gpu_memory_utilization,
1404
            kv_cache_memory_bytes=self.kv_cache_memory_bytes,
1405
            swap_space=self.swap_space,
1406
            cache_dtype=resolved_cache_dtype,
1407
            is_attention_free=model_config.is_attention_free,
1408
            num_gpu_blocks_override=self.num_gpu_blocks_override,
1409
            sliding_window=sliding_window,
1410
            enable_prefix_caching=self.enable_prefix_caching,
1411
            prefix_caching_hash_algo=self.prefix_caching_hash_algo,
1412
            cpu_offload_gb=self.cpu_offload_gb,
1413
            calculate_kv_scales=self.calculate_kv_scales,
1414
            kv_sharing_fast_prefill=self.kv_sharing_fast_prefill,
1415
1416
            mamba_cache_dtype=self.mamba_cache_dtype,
            mamba_ssm_cache_dtype=self.mamba_ssm_cache_dtype,
1417
            mamba_block_size=self.mamba_block_size,
1418
            mamba_cache_mode=self.mamba_cache_mode,
1419
1420
            kv_offloading_size=self.kv_offloading_size,
            kv_offloading_backend=self.kv_offloading_backend,
1421
        )
1422

1423
1424
1425
1426
1427
1428
        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
1429

1430
            ray_runtime_env = ray.get_runtime_context().runtime_env
1431
1432
1433
1434
1435
1436
1437
            # 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)
1438

1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
        # 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()

1450
        assert not headless or not self.data_parallel_hybrid_lb, (
1451
1452
            "data_parallel_hybrid_lb is not applicable in headless mode"
        )
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
        assert not (self.data_parallel_hybrid_lb and self.data_parallel_external_lb), (
            "data_parallel_hybrid_lb and data_parallel_external_lb cannot both be True."
        )
        assert self.data_parallel_backend == "mp" or self.nnodes == 1, (
            "nnodes > 1 is only supported with data_parallel_backend=mp"
        )
        inferred_data_parallel_rank = 0
        if self.nnodes > 1:
            world_size = (
                self.data_parallel_size
                * self.pipeline_parallel_size
                * self.tensor_parallel_size
            )
            world_size_within_dp = (
                self.pipeline_parallel_size * self.tensor_parallel_size
            )
            local_world_size = world_size // self.nnodes
            assert world_size % self.nnodes == 0, (
                f"world_size={world_size} must be divisible by nnodes={self.nnodes}."
            )
            assert self.node_rank < self.nnodes, (
                f"node_rank={self.node_rank} must be less than nnodes={self.nnodes}."
            )
            inferred_data_parallel_rank = (
                self.node_rank * local_world_size
            ) // world_size_within_dp
            if self.data_parallel_size > 1 and self.data_parallel_external_lb:
                self.data_parallel_rank = inferred_data_parallel_rank
                logger.info(
                    "Inferred data_parallel_rank %d from node_rank %d for external lb",
                    self.data_parallel_rank,
                    self.node_rank,
                )
            elif self.data_parallel_size_local is None:
                # Infer data parallel size local for internal dplb:
                self.data_parallel_size_local = max(
                    local_world_size // world_size_within_dp, 1
                )
        data_parallel_external_lb = (
            self.data_parallel_external_lb or self.data_parallel_rank is not None
        )
1494
        # Local DP rank = 1, use pure-external LB.
1495
        if data_parallel_external_lb:
1496
            assert self.data_parallel_rank is not None, (
1497
                "data_parallel_rank or node_rank must be specified if "
1498
1499
                "data_parallel_external_lb is enable."
            )
1500
            assert self.data_parallel_size_local in (1, None), (
1501
1502
                "data_parallel_size_local must be 1 or None when data_parallel_rank "
                "is set"
1503
            )
1504
            data_parallel_size_local = 1
1505
1506
            # Use full external lb if we have local_size of 1.
            self.data_parallel_hybrid_lb = False
1507
1508
        elif self.data_parallel_size_local is not None:
            data_parallel_size_local = self.data_parallel_size_local
1509
1510
1511
1512
1513
1514
1515

            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.
1516
1517
1518
1519
1520
                logger.warning(
                    "data_parallel_hybrid_lb is not eligible when "
                    "data_parallel_size_local = 1, autoswitch to "
                    "data_parallel_external_lb."
                )
1521
1522
1523
1524
1525
1526
1527
                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

1528
1529
1530
1531
1532
1533
1534
1535
1536
            self.data_parallel_rank = (
                self.data_parallel_start_rank or inferred_data_parallel_rank
            )
            if self.nnodes > 1:
                logger.info(
                    "Inferred data_parallel_rank %d from node_rank %d",
                    self.data_parallel_rank,
                    self.node_rank,
                )
1537
        else:
1538
            assert not self.data_parallel_hybrid_lb, (
1539
1540
                "data_parallel_size_local must be set to use data_parallel_hybrid_lb."
            )
1541

1542
1543
1544
1545
1546
1547
1548
1549
1550
            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
1551
1552
1553

        # DP address, used in multi-node case for torch distributed group
        # and ZMQ sockets.
Rui Qiao's avatar
Rui Qiao committed
1554
1555
1556
1557
        if self.data_parallel_address is None:
            if self.data_parallel_backend == "ray":
                host_ip = get_ip()
                logger.info(
1558
1559
                    "Using host IP %s as ray-based data parallel address", host_ip
                )
Rui Qiao's avatar
Rui Qiao committed
1560
1561
1562
1563
                data_parallel_address = host_ip
            else:
                assert self.data_parallel_backend == "mp", (
                    "data_parallel_backend can only be ray or mp, got %s",
1564
1565
                    self.data_parallel_backend,
                )
1566
1567
1568
                data_parallel_address = (
                    self.master_addr or ParallelConfig.data_parallel_master_ip
                )
Rui Qiao's avatar
Rui Qiao committed
1569
1570
        else:
            data_parallel_address = self.data_parallel_address
1571
1572
1573

        # This port is only used when there are remote data parallel engines,
        # otherwise the local IPC transport is used.
1574
        data_parallel_rpc_port = (
1575
            self.data_parallel_rpc_port
1576
1577
1578
            if (self.data_parallel_rpc_port is not None)
            else ParallelConfig.data_parallel_rpc_port
        )
1579

1580
1581
1582
1583
        if self.tokens_only and not model_config.skip_tokenizer_init:
            model_config.skip_tokenizer_init = True
            logger.info("Skipping tokenizer initialization for tokens-only mode.")

1584
        parallel_config = ParallelConfig(
1585
1586
            pipeline_parallel_size=self.pipeline_parallel_size,
            tensor_parallel_size=self.tensor_parallel_size,
1587
            prefill_context_parallel_size=self.prefill_context_parallel_size,
1588
            data_parallel_size=self.data_parallel_size,
1589
1590
            data_parallel_rank=self.data_parallel_rank or 0,
            data_parallel_external_lb=data_parallel_external_lb,
1591
            data_parallel_size_local=data_parallel_size_local,
1592
1593
1594
1595
            master_addr=self.master_addr,
            master_port=self.master_port,
            nnodes=self.nnodes,
            node_rank=self.node_rank,
1596
1597
            data_parallel_master_ip=data_parallel_address,
            data_parallel_rpc_port=data_parallel_rpc_port,
1598
            data_parallel_backend=self.data_parallel_backend,
1599
            data_parallel_hybrid_lb=self.data_parallel_hybrid_lb,
1600
            is_moe_model=model_config.is_moe,
1601
            enable_expert_parallel=self.enable_expert_parallel,
1602
            all2all_backend=self.all2all_backend,
1603
            enable_dbo=self.enable_dbo,
1604
            ubatch_size=self.ubatch_size,
1605
            dbo_decode_token_threshold=self.dbo_decode_token_threshold,
1606
            dbo_prefill_token_threshold=self.dbo_prefill_token_threshold,
1607
            disable_nccl_for_dp_synchronization=self.disable_nccl_for_dp_synchronization,
1608
            enable_eplb=self.enable_eplb,
1609
            eplb_config=self.eplb_config,
1610
            expert_placement_strategy=self.expert_placement_strategy,
1611
1612
1613
            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,
1614
            ray_runtime_env=ray_runtime_env,
1615
            placement_group=placement_group,
1616
1617
            distributed_executor_backend=self.distributed_executor_backend,
            worker_cls=self.worker_cls,
1618
            worker_extension_cls=self.worker_extension_cls,
1619
            decode_context_parallel_size=self.decode_context_parallel_size,
1620
            dcp_kv_cache_interleave_size=self.dcp_kv_cache_interleave_size,
1621
            cp_kv_cache_interleave_size=self.cp_kv_cache_interleave_size,
1622
1623
            _api_process_count=self._api_process_count,
            _api_process_rank=self._api_process_rank,
1624
        )
1625

1626
        speculative_config = self.create_speculative_config(
1627
1628
1629
1630
            target_model_config=model_config,
            target_parallel_config=parallel_config,
        )

1631
        scheduler_config = SchedulerConfig(
1632
            runner_type=model_config.runner_type,
1633
1634
1635
            max_num_batched_tokens=self.max_num_batched_tokens,
            max_num_seqs=self.max_num_seqs,
            max_model_len=model_config.max_model_len,
1636
            enable_chunked_prefill=self.enable_chunked_prefill,
1637
            disable_chunked_mm_input=self.disable_chunked_mm_input,
1638
            is_multimodal_model=model_config.is_multimodal_model,
1639
            is_encoder_decoder=model_config.is_encoder_decoder,
1640
            policy=self.scheduling_policy,
1641
            scheduler_cls=self.scheduler_cls,
1642
1643
1644
            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,
1645
            disable_hybrid_kv_cache_manager=self.disable_hybrid_kv_cache_manager,
1646
            async_scheduling=self.async_scheduling,
1647
            stream_interval=self.stream_interval,
1648
        )
1649

1650
1651
1652
        if not model_config.is_multimodal_model and self.default_mm_loras:
            raise ValueError(
                "Default modality-specific LoRA(s) were provided for a "
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
                "non multimodal model"
            )

        lora_config = (
            LoRAConfig(
                max_lora_rank=self.max_lora_rank,
                max_loras=self.max_loras,
                default_mm_loras=self.default_mm_loras,
                fully_sharded_loras=self.fully_sharded_loras,
                lora_dtype=self.lora_dtype,
1663
                enable_tower_connector_lora=self.enable_tower_connector_lora,
1664
                specialize_active_lora=self.specialize_active_lora,
1665
1666
1667
1668
1669
1670
1671
                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
        )
1672

1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
        if (
            lora_config is not None
            and speculative_config is not None
            and scheduler_config.max_num_batched_tokens
            < (
                scheduler_config.max_num_seqs
                * (speculative_config.num_speculative_tokens + 1)
            )
        ):
            raise ValueError(
                "Consider increasing max_num_batched_tokens or "
                "decreasing num_speculative_tokens"
            )

1687
1688
1689
1690
        # bitsandbytes pre-quantized model need a specific model loader
        if model_config.quantization == "bitsandbytes":
            self.quantization = self.load_format = "bitsandbytes"

1691
1692
1693
1694
1695
1696
1697
1698
        # Attention config overrides
        attention_config = copy.deepcopy(self.attention_config)
        if self.attention_backend is not None:
            if attention_config.backend is not None:
                raise ValueError(
                    "attention_backend and attention_config.backend "
                    "are mutually exclusive"
                )
1699
1700
1701
1702
1703
1704
1705
            # Convert string to enum if needed (CLI parsing returns a string)
            if isinstance(self.attention_backend, str):
                attention_config.backend = AttentionBackendEnum[
                    self.attention_backend.upper()
                ]
            else:
                attention_config.backend = self.attention_backend
1706

1707
        load_config = self.create_load_config()
1708

1709
1710
        # Pass reasoning_parser into StructuredOutputsConfig
        if self.reasoning_parser:
1711
            self.structured_outputs_config.reasoning_parser = self.reasoning_parser
1712

1713
1714
1715
1716
1717
        if self.reasoning_parser_plugin:
            self.structured_outputs_config.reasoning_parser_plugin = (
                self.reasoning_parser_plugin
            )

1718
        observability_config = ObservabilityConfig(
1719
            show_hidden_metrics_for_version=self.show_hidden_metrics_for_version,
1720
            otlp_traces_endpoint=self.otlp_traces_endpoint,
1721
            collect_detailed_traces=self.collect_detailed_traces,
1722
1723
            kv_cache_metrics=self.kv_cache_metrics,
            kv_cache_metrics_sample=self.kv_cache_metrics_sample,
1724
            cudagraph_metrics=self.cudagraph_metrics,
1725
            enable_layerwise_nvtx_tracing=self.enable_layerwise_nvtx_tracing,
1726
            enable_mfu_metrics=self.enable_mfu_metrics,
1727
            enable_mm_processor_stats=self.enable_mm_processor_stats,
1728
            enable_logging_iteration_details=self.enable_logging_iteration_details,
1729
        )
1730

1731
        # Compilation config overrides
1732
        compilation_config = copy.deepcopy(self.compilation_config)
1733
        if self.cudagraph_capture_sizes is not None:
1734
            if compilation_config.cudagraph_capture_sizes is not None:
1735
1736
1737
1738
                raise ValueError(
                    "cudagraph_capture_sizes and compilation_config."
                    "cudagraph_capture_sizes are mutually exclusive"
                )
1739
            compilation_config.cudagraph_capture_sizes = self.cudagraph_capture_sizes
1740
        if self.max_cudagraph_capture_size is not None:
1741
            if compilation_config.max_cudagraph_capture_size is not None:
1742
1743
1744
1745
                raise ValueError(
                    "max_cudagraph_capture_size and compilation_config."
                    "max_cudagraph_capture_size are mutually exclusive"
                )
1746
            compilation_config.max_cudagraph_capture_size = (
1747
1748
                self.max_cudagraph_capture_size
            )
1749
        config = VllmConfig(
1750
1751
1752
1753
1754
            model_config=model_config,
            cache_config=cache_config,
            parallel_config=parallel_config,
            scheduler_config=scheduler_config,
            device_config=device_config,
1755
1756
            load_config=load_config,
            attention_config=attention_config,
1757
1758
            lora_config=lora_config,
            speculative_config=speculative_config,
1759
            structured_outputs_config=self.structured_outputs_config,
1760
            observability_config=observability_config,
1761
            compilation_config=compilation_config,
1762
            kv_transfer_config=self.kv_transfer_config,
1763
            kv_events_config=self.kv_events_config,
1764
            ec_transfer_config=self.ec_transfer_config,
1765
            profiler_config=self.profiler_config,
1766
            additional_config=self.additional_config,
1767
            optimization_level=self.optimization_level,
1768
        )
1769

1770
1771
        return config

1772
1773
    def _check_feature_supported(self, model_config: ModelConfig):
        """Raise an error if the feature is not supported."""
1774
        if self.logits_processor_pattern != EngineArgs.logits_processor_pattern:
1775
            _raise_unsupported_error(feature_name="--logits-processor-pattern")
1776
1777

        # No Concurrent Partial Prefills so far.
1778
1779
1780
1781
1782
        if (
            self.max_num_partial_prefills != SchedulerConfig.max_num_partial_prefills
            or self.max_long_partial_prefills
            != SchedulerConfig.max_long_partial_prefills
        ):
1783
            _raise_unsupported_error(feature_name="Concurrent Partial Prefill")
1784

1785
        if self.pipeline_parallel_size > 1:
1786
1787
1788
            supports_pp = getattr(
                self.distributed_executor_backend, "supports_pp", False
            )
1789
            if not supports_pp and self.distributed_executor_backend not in (
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
                ParallelConfig.distributed_executor_backend,
                "ray",
                "mp",
                "external_launcher",
            ):
                name = (
                    "Pipeline Parallelism without Ray distributed "
                    "executor or multiprocessing executor or external "
                    "launcher"
                )
1800
                _raise_unsupported_error(feature_name=name)
1801

1802
1803
1804
1805
1806
1807
    @classmethod
    def get_batch_defaults(
        cls,
        world_size: int,
    ) -> tuple[dict[UsageContext | None, int], dict[UsageContext | None, int]]:
        from vllm.usage.usage_lib import UsageContext
1808

1809
1810
        default_max_num_batched_tokens: dict[UsageContext | None, int]
        default_max_num_seqs: dict[UsageContext | None, int]
1811

1812
1813
        # When no user override, set the default values based on the usage
        # context.
1814
        # Use different default values for different hardware.
1815
1816
1817
1818
1819
1820
1821

        # 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:
1822
            device_memory = current_platform.get_device_total_memory()
1823
            device_name = current_platform.get_device_name().lower()
1824
1825
        except Exception:
            # This is only used to set default_max_num_batched_tokens
1826
            device_memory = 0
1827
            device_name = ""
1828

1829
1830
1831
1832
        # NOTE(Kuntai): Setting large `max_num_batched_tokens` for A100 reduces
        # throughput, see PR #17885 for more details.
        # So here we do an extra device name check to prevent such regression.
        if device_memory >= 70 * GiB_bytes and "a100" not in device_name:
1833
            # For GPUs like H100 and MI300x, use larger default values.
1834
1835
1836
1837
            default_max_num_batched_tokens = {
                UsageContext.LLM_CLASS: 16384,
                UsageContext.OPENAI_API_SERVER: 8192,
            }
1838
1839
1840
1841
            default_max_num_seqs = {
                UsageContext.LLM_CLASS: 1024,
                UsageContext.OPENAI_API_SERVER: 1024,
            }
1842
1843
1844
1845
1846
1847
        else:
            # TODO(woosuk): Tune the default values for other hardware.
            default_max_num_batched_tokens = {
                UsageContext.LLM_CLASS: 8192,
                UsageContext.OPENAI_API_SERVER: 2048,
            }
1848
1849
1850
1851
            default_max_num_seqs = {
                UsageContext.LLM_CLASS: 256,
                UsageContext.OPENAI_API_SERVER: 256,
            }
1852

1853
1854
        # tpu specific default values.
        if current_platform.is_tpu():
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
            chip_name = current_platform.get_device_name()

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

1873
1874
1875
        # cpu specific default values.
        if current_platform.is_cpu():
            default_max_num_batched_tokens = {
1876
1877
                UsageContext.LLM_CLASS: 4096 * world_size,
                UsageContext.OPENAI_API_SERVER: 2048 * world_size,
1878
1879
            }
            default_max_num_seqs = {
1880
1881
                UsageContext.LLM_CLASS: 256 * world_size,
                UsageContext.OPENAI_API_SERVER: 128 * world_size,
1882
1883
            }

1884
1885
        return default_max_num_batched_tokens, default_max_num_seqs

1886
1887
    def _set_default_chunked_prefill_and_prefix_caching_args(
        self, model_config: ModelConfig
1888
    ) -> None:
1889
1890
        default_chunked_prefill = model_config.is_chunked_prefill_supported
        default_prefix_caching = model_config.is_prefix_caching_supported
1891
1892
1893
1894
1895
1896
1897
1898

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

            logger.debug(
                "%s chunked prefill by default",
                "Enabling" if default_chunked_prefill else "Disabling",
            )
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
        elif (
            model_config.runner_type == "generate"
            and not self.enable_chunked_prefill
            and default_chunked_prefill
        ):
            logger.warning_once(
                "This model does not officially support disabling chunked prefill. "
                "Disabling this manually may cause the engine to crash "
                "or produce incorrect outputs.",
                scope="local",
            )
1910
1911
1912
1913
        elif (
            model_config.runner_type == "pooling"
            and self.enable_chunked_prefill
            and not default_chunked_prefill
1914
        ):
1915
            logger.warning_once(
1916
1917
1918
                "This model does not officially support chunked prefill. "
                "Enabling this manually may cause the engine to crash "
                "or produce incorrect outputs.",
1919
                scope="local",
1920
1921
1922
1923
1924
            )

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

1925
            logger.debug(
1926
1927
1928
1929
1930
1931
1932
1933
                "%s prefix caching by default",
                "Enabling" if default_prefix_caching else "Disabling",
            )
        elif (
            model_config.runner_type == "pooling"
            and self.enable_prefix_caching
            and not default_prefix_caching
        ):
1934
            logger.warning_once(
1935
1936
1937
                "This model does not officially support prefix caching. "
                "Enabling this manually may cause the engine to crash "
                "or produce incorrect outputs.",
1938
                scope="local",
1939
1940
            )

1941
1942
1943
1944
1945
1946
1947
1948
        # Disable chunked prefill and prefix caching for:
        # POWER (ppc64le)/s390x/RISCV CPUs in V1
        if current_platform.is_cpu() and current_platform.get_cpu_architecture() in (
            CpuArchEnum.POWERPC,
            CpuArchEnum.S390X,
            CpuArchEnum.RISCV,
        ):
            logger.info(
1949
                "Chunked prefill is not supported for POWER, "
1950
1951
1952
1953
1954
                "S390X and RISC-V CPUs; "
                "disabling it for V1 backend."
            )
            self.enable_chunked_prefill = False
            logger.info(
1955
                "Prefix caching is not supported for POWER, "
1956
1957
1958
1959
1960
1961
                "S390X and RISC-V CPUs; "
                "disabling it for V1 backend."
            )
            self.enable_prefix_caching = False

    def _set_default_max_num_seqs_and_batched_tokens_args(
1962
1963
1964
        self,
        usage_context: UsageContext | None,
        model_config: ModelConfig,
1965
    ):
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
        world_size = self.pipeline_parallel_size * self.tensor_parallel_size
        (
            default_max_num_batched_tokens,
            default_max_num_seqs,
        ) = self.get_batch_defaults(world_size)

        orig_max_num_batched_tokens = self.max_num_batched_tokens
        orig_max_num_seqs = self.max_num_seqs

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

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

        if orig_max_num_batched_tokens is None:
            if not self.enable_chunked_prefill:
                # If max_model_len is too short, use the default for higher throughput.
                self.max_num_batched_tokens = max(
                    model_config.max_model_len,
                    self.max_num_batched_tokens,
                )

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

2003
2004
2005
2006
            logger.debug(
                "Defaulting max_num_batched_tokens to %d for %s usage context.",
                self.max_num_batched_tokens,
                usage_context.value if usage_context else None,
2007
            )
2008

2009
2010
2011
2012
        if orig_max_num_seqs is None:
            assert self.max_num_batched_tokens is not None  # For type checking
            self.max_num_seqs = min(self.max_num_seqs, self.max_num_batched_tokens)

2013
            logger.debug(
2014
                "Defaulting max_num_seqs to %d for %s usage context.",
2015
                self.max_num_seqs,
2016
                usage_context.value if usage_context else None,
2017
            )
2018

2019

2020
@dataclass
Zhuohan Li's avatar
Zhuohan Li committed
2021
class AsyncEngineArgs(EngineArgs):
Woosuk Kwon's avatar
Woosuk Kwon committed
2022
    """Arguments for asynchronous vLLM engine."""
2023

2024
2025
    enable_log_requests: bool = False

2026
    @staticmethod
2027
2028
2029
    def add_cli_args(
        parser: FlexibleArgumentParser, async_args_only: bool = False
    ) -> FlexibleArgumentParser:
2030
        # Initialize plugin to update the parser, for example, The plugin may
2031
        # add a new kind of quantization method to --quantization argument or
2032
2033
        # a new device to --device argument.
        load_general_plugins()
2034
2035
        if not async_args_only:
            parser = EngineArgs.add_cli_args(parser)
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
        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,
        )
2049
        current_platform.pre_register_and_update(parser)
2050
        return parser
2051
2052


2053
2054
2055
2056
2057
2058
def _raise_unsupported_error(feature_name: str):
    msg = (
        f"{feature_name} is not supported. We recommend to "
        f"remove {feature_name} from your config."
    )
    raise NotImplementedError(msg)
2059
2060


2061
def human_readable_int(value: str) -> int:
2062
2063
    """Parse human-readable integers like '1k', '2M', etc.
    Including decimal values with decimal multipliers.
2064

2065
2066
2067
2068
2069
2070
    Examples:
    - '1k' -> 1,000
    - '1K' -> 1,024
    - '25.6k' -> 25,600
    """
    value = value.strip()
2071

2072
    match = re.fullmatch(r"(\d+(?:\.\d+)?)([kKmMgGtT])", value)
2073
2074
    if match:
        decimal_multiplier = {
2075
2076
2077
            "k": 10**3,
            "m": 10**6,
            "g": 10**9,
2078
            "t": 10**12,
2079
2080
        }
        binary_multiplier = {
2081
2082
2083
            "K": 2**10,
            "M": 2**20,
            "G": 2**30,
2084
            "T": 2**40,
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
        }

        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:
2097
2098
2099
2100
2101
                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
2102
2103
2104

    # Regular plain number.
    return int(value)
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123


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

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

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

    return human_readable_int(value)