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

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

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

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

95
96
if TYPE_CHECKING:
    from vllm.model_executor.layers.quantization import QuantizationMethods
97
    from vllm.model_executor.model_loader import LoadFormats
98
    from vllm.usage.usage_lib import UsageContext
99
    from vllm.v1.executor import Executor
100
else:
101
    Executor = Any
102
    QuantizationMethods = Any
103
    LoadFormats = Any
104
105
    UsageContext = Any

106
107
logger = init_logger(__name__)

108
109
# object is used to allow for special typing forms
T = TypeVar("T")
110
111
TypeHint: TypeAlias = type[Any] | object
TypeHintT: TypeAlias = type[T] | object
112

113

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

123
124
125
    return _parse_type


126
127
def optional_type(return_type: Callable[[str], T]) -> Callable[[str], T | None]:
    def _optional_type(val: str) -> T | None:
128
129
130
131
        if val == "" or val == "None":
            return None
        return parse_type(return_type)(val)

132
    return _optional_type
133
134


135
def union_dict_and_str(val: str) -> str | dict[str, str] | None:
136
    if not re.match(r"(?s)^\s*{.*}\s*$", val):
137
        return str(val)
138
    return optional_type(json.loads)(val)
139
140


141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
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)


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


173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
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),
    }


198
199
200
201
202
def is_not_builtin(type_hint: TypeHint) -> bool:
    """Check if the class is not a built-in type."""
    return type_hint.__module__ != "builtins"


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

    return type_hints


221
222
223
224
def is_online_quantization(quantization: Any) -> bool:
    return quantization in ["inc"]


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


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

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

245
        # Get the default value of the field
246
247
        if field.default is not MISSING:
            default = field.default
248
249
250
251
252
253
254
            # Handle pydantic.Field defaults
            if isinstance(default, FieldInfo):
                default = (
                    default.default
                    if default.default_factory is None
                    else default.default_factory()
                )
255
        elif field.default_factory is not MISSING:
256
            default = field.default_factory()
257
258
259

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

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

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

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


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

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

340
341
342
343
344
345
346
    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))


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

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

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

493
    enable_chunked_prefill: bool | None = None
494
    disable_chunked_mm_input: bool = SchedulerConfig.disable_chunked_mm_input
495

496
    disable_hybrid_kv_cache_manager: bool = (
497
498
        SchedulerConfig.disable_hybrid_kv_cache_manager
    )
499

500
    structured_outputs_config: StructuredOutputsConfig = get_field(
501
502
        VllmConfig, "structured_outputs_config"
    )
503
    reasoning_parser: str = StructuredOutputsConfig.reasoning_parser
504
    reasoning_parser_plugin: str | None = None
505
    # Deprecated guided decoding fields
506
507
508
509
    guided_decoding_backend: str | None = None
    guided_decoding_disable_fallback: bool | None = None
    guided_decoding_disable_any_whitespace: bool | None = None
    guided_decoding_disable_additional_properties: bool | None = None
510

511
    logits_processor_pattern: str | None = ModelConfig.logits_processor_pattern
512

513
    speculative_config: dict[str, Any] | None = None
514

515
    show_hidden_metrics_for_version: str | None = (
516
        ObservabilityConfig.show_hidden_metrics_for_version
517
    )
518
519
    otlp_traces_endpoint: str | None = ObservabilityConfig.otlp_traces_endpoint
    collect_detailed_traces: list[DetailedTraceModules] | None = (
520
        ObservabilityConfig.collect_detailed_traces
521
    )
522
    scheduling_policy: SchedulerPolicy = SchedulerConfig.policy
523
    scheduler_cls: str | type[object] | None = SchedulerConfig.scheduler_cls
524

525
526
    pooler_config: PoolerConfig | None = ModelConfig.pooler_config
    override_pooler_config: dict | PoolerConfig | None = (
527
        ModelConfig.override_pooler_config
528
529
    )
    compilation_config: CompilationConfig = get_field(VllmConfig, "compilation_config")
530
531
    worker_cls: str = ParallelConfig.worker_cls
    worker_extension_cls: str = ParallelConfig.worker_extension_cls
532

533
534
    kv_transfer_config: KVTransferConfig | None = None
    kv_events_config: KVEventsConfig | None = None
535

536
537
    ec_transfer_config: ECTransferConfig | None = None

538
539
    generation_config: str = ModelConfig.generation_config
    enable_sleep_mode: bool = ModelConfig.enable_sleep_mode
540
541
542
    override_generation_config: dict[str, Any] = get_field(
        ModelConfig, "override_generation_config"
    )
543
    model_impl: str = ModelConfig.model_impl
544
    override_attention_dtype: str = ModelConfig.override_attention_dtype
545

546
    calculate_kv_scales: bool = CacheConfig.calculate_kv_scales
547
548
    mamba_cache_dtype: MambaDType = CacheConfig.mamba_cache_dtype
    mamba_ssm_cache_dtype: MambaDType = CacheConfig.mamba_ssm_cache_dtype
549
    mamba_block_size: int | None = get_field(CacheConfig, "mamba_block_size")
550

551
    additional_config: dict[str, Any] = get_field(VllmConfig, "additional_config")
552

553
    use_tqdm_on_load: bool = LoadConfig.use_tqdm_on_load
554
    pt_load_map_location: str = LoadConfig.pt_load_map_location
555

556
557
    # DEPRECATED
    enable_multimodal_encoder_data_parallel: bool = False
558

559
    logits_processors: list[str | type[LogitsProcessor]] | None = (
560
561
        ModelConfig.logits_processors
    )
562
563
    """Custom logitproc types"""

564
    async_scheduling: bool | None = SchedulerConfig.async_scheduling
565

566
567
    stream_interval: int = SchedulerConfig.stream_interval

568
    kv_sharing_fast_prefill: bool = CacheConfig.kv_sharing_fast_prefill
569

570
571
572
573
    kv_offloading_size: float | None = CacheConfig.kv_offloading_size
    kv_offloading_backend: KVOffloadingBackend | None = (
        CacheConfig.kv_offloading_backend
    )
574
    tokens_only: bool = False
575

576
    def __post_init__(self):
577
578
579
        # support `EngineArgs(compilation_config={...})`
        # without having to manually construct a
        # CompilationConfig object
580
        if isinstance(self.compilation_config, dict):
581
            self.compilation_config = CompilationConfig(**self.compilation_config)
582
        if isinstance(self.eplb_config, dict):
583
            self.eplb_config = EPLBConfig(**self.eplb_config)
584
        # Setup plugins
585
        from vllm.plugins import load_general_plugins
586

587
        load_general_plugins()
588
589
590
591
592
        # when use hf offline,replace model id to local model path
        if huggingface_hub.constants.HF_HUB_OFFLINE:
            model_id = self.model
            self.model = get_model_path(self.model, self.revision)
            logger.info(
593
594
595
596
                "HF_HUB_OFFLINE is True, replace model_id [%s] to model_path [%s]",
                model_id,
                self.model,
            )
597
598

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

602
        # Model arguments
603
604
605
606
607
        model_kwargs = get_kwargs(ModelConfig)
        model_group = parser.add_argument_group(
            title="ModelConfig",
            description=ModelConfig.__doc__,
        )
608
        if not ("serve" in sys.argv[1:] and "--help" in sys.argv[1:]):
609
            model_group.add_argument("--model", **model_kwargs["model"])
610
611
        model_group.add_argument("--runner", **model_kwargs["runner"])
        model_group.add_argument("--convert", **model_kwargs["convert"])
612
        model_group.add_argument("--task", **model_kwargs["task"], deprecated=True)
613
        model_group.add_argument("--tokenizer", **model_kwargs["tokenizer"])
614
615
616
617
        model_group.add_argument("--tokenizer-mode", **model_kwargs["tokenizer_mode"])
        model_group.add_argument(
            "--trust-remote-code", **model_kwargs["trust_remote_code"]
        )
618
619
        model_group.add_argument("--dtype", **model_kwargs["dtype"])
        model_group.add_argument("--seed", **model_kwargs["seed"])
620
621
622
623
624
625
626
        model_group.add_argument("--hf-config-path", **model_kwargs["hf_config_path"])
        model_group.add_argument(
            "--allowed-local-media-path", **model_kwargs["allowed_local_media_path"]
        )
        model_group.add_argument(
            "--allowed-media-domains", **model_kwargs["allowed_media_domains"]
        )
627
        model_group.add_argument("--revision", **model_kwargs["revision"])
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
        model_group.add_argument("--code-revision", **model_kwargs["code_revision"])
        model_group.add_argument(
            "--tokenizer-revision", **model_kwargs["tokenizer_revision"]
        )
        model_group.add_argument("--max-model-len", **model_kwargs["max_model_len"])
        model_group.add_argument("--quantization", "-q", **model_kwargs["quantization"])
        model_group.add_argument("--enforce-eager", **model_kwargs["enforce_eager"])
        model_group.add_argument("--max-logprobs", **model_kwargs["max_logprobs"])
        model_group.add_argument("--logprobs-mode", **model_kwargs["logprobs_mode"])
        model_group.add_argument(
            "--disable-sliding-window", **model_kwargs["disable_sliding_window"]
        )
        model_group.add_argument(
            "--disable-cascade-attn", **model_kwargs["disable_cascade_attn"]
        )
        model_group.add_argument(
            "--skip-tokenizer-init", **model_kwargs["skip_tokenizer_init"]
        )
        model_group.add_argument(
            "--enable-prompt-embeds", **model_kwargs["enable_prompt_embeds"]
        )
        model_group.add_argument(
            "--served-model-name", **model_kwargs["served_model_name"]
        )
        model_group.add_argument("--config-format", **model_kwargs["config_format"])
653
654
        # This one is a special case because it can bool
        # or str. TODO: Handle this in get_kwargs
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
        model_group.add_argument(
            "--hf-token",
            type=str,
            nargs="?",
            const=True,
            default=model_kwargs["hf_token"]["default"],
            help=model_kwargs["hf_token"]["help"],
        )
        model_group.add_argument("--hf-overrides", **model_kwargs["hf_overrides"])
        model_group.add_argument("--pooler-config", **model_kwargs["pooler_config"])
        model_group.add_argument(
            "--override-pooler-config",
            **model_kwargs["override_pooler_config"],
            deprecated=True,
        )
        model_group.add_argument(
            "--logits-processor-pattern", **model_kwargs["logits_processor_pattern"]
        )
        model_group.add_argument(
            "--generation-config", **model_kwargs["generation_config"]
        )
        model_group.add_argument(
            "--override-generation-config", **model_kwargs["override_generation_config"]
        )
        model_group.add_argument(
            "--enable-sleep-mode", **model_kwargs["enable_sleep_mode"]
        )
682
        model_group.add_argument("--model-impl", **model_kwargs["model_impl"])
683
684
685
686
687
688
689
690
691
        model_group.add_argument(
            "--override-attention-dtype", **model_kwargs["override_attention_dtype"]
        )
        model_group.add_argument(
            "--logits-processors", **model_kwargs["logits_processors"]
        )
        model_group.add_argument(
            "--io-processor-plugin", **model_kwargs["io_processor_plugin"]
        )
692

693
694
695
696
697
698
        # Model loading arguments
        load_kwargs = get_kwargs(LoadConfig)
        load_group = parser.add_argument_group(
            title="LoadConfig",
            description=LoadConfig.__doc__,
        )
699
        load_group.add_argument("--load-format", **load_kwargs["load_format"])
700
701
702
703
704
705
706
707
708
709
710
711
        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"]
        )
712

713
714
715
716
717
        # Structured outputs arguments
        structured_outputs_kwargs = get_kwargs(StructuredOutputsConfig)
        structured_outputs_group = parser.add_argument_group(
            title="StructuredOutputsConfig",
            description=StructuredOutputsConfig.__doc__,
718
        )
719
        structured_outputs_group.add_argument(
720
            "--reasoning-parser",
721
            # Choices need to be validated after parsing to include plugins
722
723
            **structured_outputs_kwargs["reasoning_parser"],
        )
724
725
726
727
        structured_outputs_group.add_argument(
            "--reasoning-parser-plugin",
            **structured_outputs_kwargs["reasoning_parser_plugin"],
        )
728
729
730
731
732
733
734
735
736
737
738
        # Deprecated guided decoding arguments
        for arg, type in [
            ("--guided-decoding-backend", str),
            ("--guided-decoding-disable-fallback", bool),
            ("--guided-decoding-disable-any-whitespace", bool),
            ("--guided-decoding-disable-additional-properties", bool),
        ]:
            structured_outputs_group.add_argument(
                arg,
                type=type,
                help=(f"[DEPRECATED] {arg} will be removed in v0.12.0."),
739
740
                deprecated=True,
            )
741

742
        # Parallel arguments
743
744
745
746
747
748
        parallel_kwargs = get_kwargs(ParallelConfig)
        parallel_group = parser.add_argument_group(
            title="ParallelConfig",
            description=ParallelConfig.__doc__,
        )
        parallel_group.add_argument(
749
            "--distributed-executor-backend",
750
751
            **parallel_kwargs["distributed_executor_backend"],
        )
752
        parallel_group.add_argument(
753
754
755
756
            "--pipeline-parallel-size",
            "-pp",
            **parallel_kwargs["pipeline_parallel_size"],
        )
757
758
759
760
        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"])
761
        parallel_group.add_argument(
762
763
            "--tensor-parallel-size", "-tp", **parallel_kwargs["tensor_parallel_size"]
        )
764
        parallel_group.add_argument(
765
766
767
768
            "--decode-context-parallel-size",
            "-dcp",
            **parallel_kwargs["decode_context_parallel_size"],
        )
769
770
771
772
        parallel_group.add_argument(
            "--dcp-kv-cache-interleave-size",
            **parallel_kwargs["dcp_kv_cache_interleave_size"],
        )
773
774
775
776
777
778
779
780
781
        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"],
        )
782
783
784
785
786
787
        parallel_group.add_argument(
            "--data-parallel-size", "-dp", **parallel_kwargs["data_parallel_size"]
        )
        parallel_group.add_argument(
            "--data-parallel-rank",
            "-dpn",
788
            type=int,
789
790
791
            help="Data parallel rank of this instance. "
            "When set, enables external load balancer mode.",
        )
792
        parallel_group.add_argument(
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
            "--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".',
        )
823
        parallel_group.add_argument(
824
825
826
827
828
829
830
831
            "--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"],
832
833
834
835
        )
        parallel_group.add_argument(
            "--enable-expert-parallel", **parallel_kwargs["enable_expert_parallel"]
        )
836
837
838
        parallel_group.add_argument(
            "--all2all-backend", **parallel_kwargs["all2all_backend"]
        )
839
        parallel_group.add_argument("--enable-dbo", **parallel_kwargs["enable_dbo"])
840
841
        parallel_group.add_argument(
            "--dbo-decode-token-threshold",
842
843
            **parallel_kwargs["dbo_decode_token_threshold"],
        )
844
845
        parallel_group.add_argument(
            "--dbo-prefill-token-threshold",
846
847
            **parallel_kwargs["dbo_prefill_token_threshold"],
        )
848
849
850
851
        parallel_group.add_argument(
            "--disable-nccl-for-dp-synchronization",
            **parallel_kwargs["disable_nccl_for_dp_synchronization"],
        )
852
853
        parallel_group.add_argument("--enable-eplb", **parallel_kwargs["enable_eplb"])
        parallel_group.add_argument("--eplb-config", **parallel_kwargs["eplb_config"])
854
855
        parallel_group.add_argument(
            "--expert-placement-strategy",
856
857
            **parallel_kwargs["expert_placement_strategy"],
        )
858
859
860
        parallel_group.add_argument(
            "--num-redundant-experts",
            type=int,
861
862
863
            help="[DEPRECATED] --num-redundant-experts will be removed in v0.12.0.",
            deprecated=True,
        )
864
865
866
867
        parallel_group.add_argument(
            "--eplb-window-size",
            type=int,
            help="[DEPRECATED] --eplb-window-size will be removed in v0.12.0.",
868
869
            deprecated=True,
        )
870
871
872
        parallel_group.add_argument(
            "--eplb-step-interval",
            type=int,
873
874
875
            help="[DEPRECATED] --eplb-step-interval will be removed in v0.12.0.",
            deprecated=True,
        )
876
877
878
        parallel_group.add_argument(
            "--eplb-log-balancedness",
            action=argparse.BooleanOptionalAction,
879
880
881
            help="[DEPRECATED] --eplb-log-balancedness will be removed in v0.12.0.",
            deprecated=True,
        )
882

883
        parallel_group.add_argument(
884
            "--max-parallel-loading-workers",
885
886
            **parallel_kwargs["max_parallel_loading_workers"],
        )
887
        parallel_group.add_argument(
888
889
            "--ray-workers-use-nsight", **parallel_kwargs["ray_workers_use_nsight"]
        )
890
        parallel_group.add_argument(
891
            "--disable-custom-all-reduce",
892
893
894
895
896
897
            **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"]
        )
898
899
        parallel_group.add_argument(
            "--enable-multimodal-encoder-data-parallel",
900
            action="store_true",
901
902
            deprecated=True,
        )
903

904
905
906
907
908
        # KV cache arguments
        cache_kwargs = get_kwargs(CacheConfig)
        cache_group = parser.add_argument_group(
            title="CacheConfig",
            description=CacheConfig.__doc__,
909
        )
910
        cache_group.add_argument("--block-size", **cache_kwargs["block_size"])
911
912
913
914
915
916
        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"]
        )
917
        cache_group.add_argument("--swap-space", **cache_kwargs["swap_space"])
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
        cache_group.add_argument("--kv-cache-dtype", **cache_kwargs["cache_dtype"])
        cache_group.add_argument(
            "--num-gpu-blocks-override", **cache_kwargs["num_gpu_blocks_override"]
        )
        cache_group.add_argument(
            "--enable-prefix-caching", **cache_kwargs["enable_prefix_caching"]
        )
        cache_group.add_argument(
            "--prefix-caching-hash-algo", **cache_kwargs["prefix_caching_hash_algo"]
        )
        cache_group.add_argument("--cpu-offload-gb", **cache_kwargs["cpu_offload_gb"])
        cache_group.add_argument(
            "--calculate-kv-scales", **cache_kwargs["calculate_kv_scales"]
        )
        cache_group.add_argument(
            "--kv-sharing-fast-prefill", **cache_kwargs["kv_sharing_fast_prefill"]
        )
        cache_group.add_argument(
            "--mamba-cache-dtype", **cache_kwargs["mamba_cache_dtype"]
        )
        cache_group.add_argument(
            "--mamba-ssm-cache-dtype", **cache_kwargs["mamba_ssm_cache_dtype"]
        )
941
942
943
        cache_group.add_argument(
            "--mamba-block-size", **cache_kwargs["mamba_block_size"]
        )
944
945
946
947
948
949
        cache_group.add_argument(
            "--kv-offloading-size", **cache_kwargs["kv_offloading_size"]
        )
        cache_group.add_argument(
            "--kv-offloading-backend", **cache_kwargs["kv_offloading_backend"]
        )
950

951
        # Multimodal related configs
952
953
954
955
956
        multimodal_kwargs = get_kwargs(MultiModalConfig)
        multimodal_group = parser.add_argument_group(
            title="MultiModalConfig",
            description=MultiModalConfig.__doc__,
        )
957
        multimodal_group.add_argument(
958
959
            "--limit-mm-per-prompt", **multimodal_kwargs["limit_per_prompt"]
        )
960
961
962
        multimodal_group.add_argument(
            "--enable-mm-embeds", **multimodal_kwargs["enable_mm_embeds"]
        )
963
964
965
966
967
968
969
970
971
        multimodal_group.add_argument(
            "--media-io-kwargs", **multimodal_kwargs["media_io_kwargs"]
        )
        multimodal_group.add_argument(
            "--mm-processor-kwargs", **multimodal_kwargs["mm_processor_kwargs"]
        )
        multimodal_group.add_argument(
            "--mm-processor-cache-gb", **multimodal_kwargs["mm_processor_cache_gb"]
        )
972
        multimodal_group.add_argument(
973
974
            "--disable-mm-preprocessor-cache", action="store_true", deprecated=True
        )
975
        multimodal_group.add_argument(
976
977
            "--mm-processor-cache-type", **multimodal_kwargs["mm_processor_cache_type"]
        )
978
979
        multimodal_group.add_argument(
            "--mm-shm-cache-max-object-size-mb",
980
981
            **multimodal_kwargs["mm_shm_cache_max_object_size_mb"],
        )
982
        multimodal_group.add_argument(
983
984
            "--mm-encoder-tp-mode", **multimodal_kwargs["mm_encoder_tp_mode"]
        )
985
986
987
988
        multimodal_group.add_argument(
            "--mm-encoder-attn-backend",
            **multimodal_kwargs["mm_encoder_attn_backend"],
        )
989
990
991
        multimodal_group.add_argument(
            "--interleave-mm-strings", **multimodal_kwargs["interleave_mm_strings"]
        )
992
        multimodal_group.add_argument(
993
994
            "--skip-mm-profiling", **multimodal_kwargs["skip_mm_profiling"]
        )
995

996
        multimodal_group.add_argument(
997
998
            "--video-pruning-rate", **multimodal_kwargs["video_pruning_rate"]
        )
999

1000
        # LoRA related configs
1001
1002
1003
1004
1005
1006
        lora_kwargs = get_kwargs(LoRAConfig)
        lora_group = parser.add_argument_group(
            title="LoRAConfig",
            description=LoRAConfig.__doc__,
        )
        lora_group.add_argument(
1007
            "--enable-lora",
1008
            action=argparse.BooleanOptionalAction,
1009
1010
            help="If True, enable handling of LoRA adapters.",
        )
1011
        lora_group.add_argument("--max-loras", **lora_kwargs["max_loras"])
1012
        lora_group.add_argument("--max-lora-rank", **lora_kwargs["max_lora_rank"])
1013
        lora_group.add_argument(
1014
            "--lora-dtype",
1015
1016
            **lora_kwargs["lora_dtype"],
        )
1017
1018
1019
1020
1021
        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"])
1022

1023
1024
1025
1026
1027
1028
1029
1030
        # 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",
1031
1032
            **observability_kwargs["show_hidden_metrics_for_version"],
        )
1033
        observability_group.add_argument(
1034
1035
            "--otlp-traces-endpoint", **observability_kwargs["otlp_traces_endpoint"]
        )
1036
1037
1038
1039
1040
        # 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"] += [
1041
            ",".join(p) for p in permutations(get_args(DetailedTraceModules), r=2)
1042
1043
1044
        ]
        observability_group.add_argument(
            "--collect-detailed-traces",
1045
1046
            **observability_kwargs["collect_detailed_traces"],
        )
1047

1048
1049
1050
1051
1052
1053
1054
        # Scheduler arguments
        scheduler_kwargs = get_kwargs(SchedulerConfig)
        scheduler_group = parser.add_argument_group(
            title="SchedulerConfig",
            description=SchedulerConfig.__doc__,
        )
        scheduler_group.add_argument(
1055
1056
1057
1058
1059
            "--max-num-batched-tokens",
            **{
                **scheduler_kwargs["max_num_batched_tokens"],
                "default": None,
            },
1060
        )
1061
        scheduler_group.add_argument(
1062
1063
1064
1065
1066
            "--max-num-seqs",
            **{
                **scheduler_kwargs["max_num_seqs"],
                "default": None,
            },
1067
1068
1069
1070
        )
        scheduler_group.add_argument(
            "--max-num-partial-prefills", **scheduler_kwargs["max_num_partial_prefills"]
        )
1071
1072
        scheduler_group.add_argument(
            "--max-long-partial-prefills",
1073
1074
            **scheduler_kwargs["max_long_partial_prefills"],
        )
1075
1076
        scheduler_group.add_argument(
            "--long-prefill-token-threshold",
1077
1078
            **scheduler_kwargs["long_prefill_token_threshold"],
        )
1079
1080
        # multi-step scheduling has been removed; corresponding arguments
        # are no longer supported.
1081
        scheduler_group.add_argument(
1082
1083
            "--scheduling-policy", **scheduler_kwargs["policy"]
        )
1084
        scheduler_group.add_argument(
1085
1086
1087
1088
1089
            "--enable-chunked-prefill",
            **{
                **scheduler_kwargs["enable_chunked_prefill"],
                "default": None,
            },
1090
1091
1092
1093
1094
1095
1096
        )
        scheduler_group.add_argument(
            "--disable-chunked-mm-input", **scheduler_kwargs["disable_chunked_mm_input"]
        )
        scheduler_group.add_argument(
            "--scheduler-cls", **scheduler_kwargs["scheduler_cls"]
        )
1097
1098
        scheduler_group.add_argument(
            "--disable-hybrid-kv-cache-manager",
1099
1100
1101
1102
1103
            **scheduler_kwargs["disable_hybrid_kv_cache_manager"],
        )
        scheduler_group.add_argument(
            "--async-scheduling", **scheduler_kwargs["async_scheduling"]
        )
1104
1105
1106
        scheduler_group.add_argument(
            "--stream-interval", **scheduler_kwargs["stream_interval"]
        )
1107

1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
        # Compilation arguments
        compilation_kwargs = get_kwargs(CompilationConfig)
        compilation_group = parser.add_argument_group(
            title="CompilationConfig",
            description=CompilationConfig.__doc__,
        )
        compilation_group.add_argument(
            "--cudagraph-capture-sizes", **compilation_kwargs["cudagraph_capture_sizes"]
        )
        compilation_kwargs["cudagraph_capture_sizes"]["help"] = (
            "--cuda-graph-sizes is deprecated and will be removed in v0.13.0 or v1.0.0,"
            " whichever is soonest. Please use --cudagraph-capture-sizes instead."
        )
        compilation_group.add_argument(
            "--cuda-graph-sizes",
            **compilation_kwargs["cudagraph_capture_sizes"],
            deprecated=True,
        )
        compilation_group.add_argument(
            "--max-cudagraph-capture-size",
            **compilation_kwargs["max_cudagraph_capture_size"],
        )

1131
        # vLLM arguments
1132
        vllm_kwargs = get_kwargs(VllmConfig)
1133
1134
1135
1136
        vllm_group = parser.add_argument_group(
            title="VllmConfig",
            description=VllmConfig.__doc__,
        )
1137
1138
1139
1140
        # 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)
1141
1142
1143
1144
1145
1146
1147
        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"])
1148
1149
1150
        vllm_group.add_argument(
            "--ec-transfer-config", **vllm_kwargs["ec_transfer_config"]
        )
1151
1152
1153
1154
1155
1156
1157
1158
1159
        vllm_group.add_argument(
            "--compilation-config", "-O", **vllm_kwargs["compilation_config"]
        )
        vllm_group.add_argument(
            "--additional-config", **vllm_kwargs["additional_config"]
        )
        vllm_group.add_argument(
            "--structured-outputs-config", **vllm_kwargs["structured_outputs_config"]
        )
1160

1161
        # Other arguments
1162
1163
1164
1165
1166
        parser.add_argument(
            "--disable-log-stats",
            action="store_true",
            help="Disable logging statistics.",
        )
1167

1168
1169
1170
1171
1172
1173
        parser.add_argument(
            "--aggregate-engine-logging",
            action="store_true",
            help="Log aggregate rather than per-engine statistics "
            "when using data parallelism.",
        )
1174
        return parser
1175
1176

    @classmethod
1177
    def from_cli_args(cls, args: argparse.Namespace):
1178
1179
1180
        # Get the list of attributes of this dataclass.
        attrs = [attr.name for attr in dataclasses.fields(cls)]
        # Set the attributes from the parsed arguments.
1181
1182
1183
        engine_args = cls(
            **{attr: getattr(args, attr) for attr in attrs if hasattr(args, attr)}
        )
Zhuohan Li's avatar
Zhuohan Li committed
1184
        return engine_args
1185

1186
    def create_model_config(self) -> ModelConfig:
1187
1188
1189
1190
        # gguf file needs a specific model loader and doesn't use hf_repo
        if check_gguf_file(self.model):
            self.quantization = self.load_format = "gguf"

1191
1192
1193
1194
        # NOTE(woosuk): In V1, we use separate processes for workers (unless
        # VLLM_ENABLE_V1_MULTIPROCESSING=0), so setting a seed here
        # doesn't affect the user process.
        if self.seed is None:
1195
1196
1197
1198
1199
1200
            logger.warning_once(
                "`seed=None` is equivalent to `seed=0` in V1 Engine. "
                "You will no longer be allowed to pass `None` in v0.13.",
                scope="local",
            )

1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
            self.seed = 0
            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,
                )

1211
        if self.disable_mm_preprocessor_cache:
1212
            logger.warning_once(
1213
1214
                "`--disable-mm-preprocessor-cache` is deprecated "
                "and will be removed in v0.13. "
1215
                "Please use `--mm-processor-cache-gb 0` instead.",
1216
                scope="local",
1217
            )
1218
1219
1220

            self.mm_processor_cache_gb = 0
        elif envs.VLLM_MM_INPUT_CACHE_GIB != 4:
1221
            logger.warning_once(
1222
1223
1224
1225
                "VLLM_MM_INPUT_CACHE_GIB` is deprecated "
                "and will be removed in v0.13. "
                "Please use `--mm-processor-cache-gb %d` instead.",
                envs.VLLM_MM_INPUT_CACHE_GIB,
1226
                scope="local",
1227
1228
1229
1230
            )

            self.mm_processor_cache_gb = envs.VLLM_MM_INPUT_CACHE_GIB

1231
        if self.enable_multimodal_encoder_data_parallel:
1232
            logger.warning_once(
1233
1234
                "--enable-multimodal-encoder-data-parallel` is deprecated "
                "and will be removed in v0.13. "
1235
1236
                "Please use `--mm-encoder-tp-mode data` instead.",
                scope="local",
1237
            )
1238
1239
1240

            self.mm_encoder_tp_mode = "data"

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

1294
    def validate_tensorizer_args(self):
1295
1296
        from vllm.model_executor.model_loader.tensorizer import TensorizerConfig

1297
1298
        for key in self.model_loader_extra_config:
            if key in TensorizerConfig._fields:
1299
1300
1301
                self.model_loader_extra_config["tensorizer_config"][key] = (
                    self.model_loader_extra_config[key]
                )
1302

1303
    def create_load_config(self) -> LoadConfig:
1304
1305
        if self.quantization == "bitsandbytes":
            self.load_format = "bitsandbytes"
1306

1307
1308
1309
        if self.load_format == "tensorizer":
            if hasattr(self.model_loader_extra_config, "to_serializable"):
                self.model_loader_extra_config = (
1310
1311
                    self.model_loader_extra_config.to_serializable()
                )
1312
            self.model_loader_extra_config["tensorizer_config"] = {}
1313
1314
1315
            self.model_loader_extra_config["tensorizer_config"]["tensorizer_dir"] = (
                self.model
            )
1316
            self.validate_tensorizer_args()
1317

1318
1319
1320
        return LoadConfig(
            load_format=self.load_format,
            download_dir=self.download_dir,
1321
            safetensors_load_strategy=self.safetensors_load_strategy,
1322
            device="cpu" if is_online_quantization(self.quantization) else None,
1323
1324
            model_loader_extra_config=self.model_loader_extra_config,
            ignore_patterns=self.ignore_patterns,
1325
            use_tqdm_on_load=self.use_tqdm_on_load,
1326
            pt_load_map_location=self.pt_load_map_location,
1327
        )
1328

1329
1330
1331
1332
    def create_speculative_config(
        self,
        target_model_config: ModelConfig,
        target_parallel_config: ParallelConfig,
1333
    ) -> SpeculativeConfig | None:
1334
1335
1336
1337
1338
1339
        """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
1340
        dictionary from the engine.
1341
1342
        """
        if self.speculative_config is None:
1343
            return None
1344

1345
1346
1347
        # Note(Shangming): These parameters are not obtained from the cli arg
        # '--speculative-config' and must be passed in when creating the engine
        # config.
1348
1349
1350
1351
1352
1353
        self.speculative_config.update(
            {
                "target_model_config": target_model_config,
                "target_parallel_config": target_parallel_config,
            }
        )
1354
        return SpeculativeConfig(**self.speculative_config)
1355

1356
1357
    def create_engine_config(
        self,
1358
        usage_context: UsageContext | None = None,
1359
        headless: bool = False,
1360
1361
1362
1363
    ) -> VllmConfig:
        """
        Create the VllmConfig.

1364
        NOTE: If VllmConfig is incompatible, we raise an error.
1365
        """
1366
        current_platform.pre_register_and_update()
1367

1368
        device_config = DeviceConfig(device=cast(Device, current_platform.device_type))
1369

1370
1371
        # Check if the model is a speculator and override model/tokenizer/config
        # BEFORE creating ModelConfig, so the config is created with the target model
1372
1373
1374
1375
        # 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):
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
            (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,
                )
            )

1386
1387
1388
1389
        model_config = self.create_model_config()
        self.model = model_config.model
        self.tokenizer = model_config.tokenizer

1390
        self._check_feature_supported(model_config)
1391

1392
1393
        # Set default arguments for V1 Engine.
        self._set_default_args(usage_context, model_config)
1394
1395
        # Disable chunked prefill and prefix caching for:
        # POWER (ppc64le)/ARM/s390x/RISCV CPUs in V1
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
        if current_platform.is_cpu() and current_platform.get_cpu_architecture() in (
            CpuArchEnum.POWERPC,
            CpuArchEnum.S390X,
            CpuArchEnum.ARM,
            CpuArchEnum.RISCV,
        ):
            logger.info(
                "Chunked prefill is not supported for ARM and POWER, "
                "S390X and RISC-V CPUs; "
                "disabling it for V1 backend."
            )
1407
            self.enable_chunked_prefill = False
1408
1409
1410
1411
1412
1413
1414
            logger.info(
                "Prefix caching is not supported for ARM and POWER, "
                "S390X and RISC-V CPUs; "
                "disabling it for V1 backend."
            )
            self.enable_prefix_caching = False

1415
1416
        assert self.enable_chunked_prefill is not None

1417
        sliding_window: int | None = None
1418
1419
1420
1421
1422
1423
        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()

1424
1425
1426
        # Note(hc): In the current implementation of decode context
        # parallel(DCP), tp_size needs to be divisible by dcp_size,
        # because the world size does not change by dcp, it simply
1427
        # reuses the GPUs of TP group, and split one TP group into
1428
        # tp_size//dcp_size DCP groups.
1429
        assert self.tensor_parallel_size % self.decode_context_parallel_size == 0, (
1430
1431
1432
1433
            f"tp_size={self.tensor_parallel_size} must be divisible by"
            f"dcp_size={self.decode_context_parallel_size}."
        )

1434
        cache_config = CacheConfig(
1435
            block_size=self.block_size,
1436
            gpu_memory_utilization=self.gpu_memory_utilization,
1437
            kv_cache_memory_bytes=self.kv_cache_memory_bytes,
1438
1439
            swap_space=self.swap_space,
            cache_dtype=self.kv_cache_dtype,
1440
            is_attention_free=model_config.is_attention_free,
1441
            num_gpu_blocks_override=self.num_gpu_blocks_override,
1442
            sliding_window=sliding_window,
1443
            enable_prefix_caching=self.enable_prefix_caching,
1444
            prefix_caching_hash_algo=self.prefix_caching_hash_algo,
1445
            cpu_offload_gb=self.cpu_offload_gb,
1446
            calculate_kv_scales=self.calculate_kv_scales,
1447
            kv_sharing_fast_prefill=self.kv_sharing_fast_prefill,
1448
1449
            mamba_cache_dtype=self.mamba_cache_dtype,
            mamba_ssm_cache_dtype=self.mamba_ssm_cache_dtype,
1450
            mamba_block_size=self.mamba_block_size,
1451
1452
            kv_offloading_size=self.kv_offloading_size,
            kv_offloading_backend=self.kv_offloading_backend,
1453
        )
1454

1455
1456
1457
1458
1459
1460
        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
1461

1462
            ray_runtime_env = ray.get_runtime_context().runtime_env
1463
1464
1465
1466
1467
1468
1469
            # 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)
1470

1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
        # 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()

1482
        assert not headless or not self.data_parallel_hybrid_lb, (
1483
1484
            "data_parallel_hybrid_lb is not applicable in headless mode"
        )
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
        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
        )
1526
        # Local DP rank = 1, use pure-external LB.
1527
        if data_parallel_external_lb:
1528
            assert self.data_parallel_rank is not None, (
1529
                "data_parallel_rank or node_rank must be specified if "
1530
1531
                "data_parallel_external_lb is enable."
            )
1532
            assert self.data_parallel_size_local in (1, None), (
1533
1534
                "data_parallel_size_local must be 1 or None when data_parallel_rank "
                "is set"
1535
            )
1536
            data_parallel_size_local = 1
1537
1538
            # Use full external lb if we have local_size of 1.
            self.data_parallel_hybrid_lb = False
1539
1540
        elif self.data_parallel_size_local is not None:
            data_parallel_size_local = self.data_parallel_size_local
1541
1542
1543
1544
1545
1546
1547

            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.
1548
1549
1550
1551
1552
                logger.warning(
                    "data_parallel_hybrid_lb is not eligible when "
                    "data_parallel_size_local = 1, autoswitch to "
                    "data_parallel_external_lb."
                )
1553
1554
1555
1556
1557
1558
1559
                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

1560
1561
1562
1563
1564
1565
1566
1567
1568
            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,
                )
1569
        else:
1570
            assert not self.data_parallel_hybrid_lb, (
1571
1572
                "data_parallel_size_local must be set to use data_parallel_hybrid_lb."
            )
1573

1574
1575
1576
1577
1578
1579
1580
1581
1582
            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
1583
1584
1585

        # DP address, used in multi-node case for torch distributed group
        # and ZMQ sockets.
Rui Qiao's avatar
Rui Qiao committed
1586
1587
1588
1589
        if self.data_parallel_address is None:
            if self.data_parallel_backend == "ray":
                host_ip = get_ip()
                logger.info(
1590
1591
                    "Using host IP %s as ray-based data parallel address", host_ip
                )
Rui Qiao's avatar
Rui Qiao committed
1592
1593
1594
1595
                data_parallel_address = host_ip
            else:
                assert self.data_parallel_backend == "mp", (
                    "data_parallel_backend can only be ray or mp, got %s",
1596
1597
                    self.data_parallel_backend,
                )
1598
1599
1600
                data_parallel_address = (
                    self.master_addr or ParallelConfig.data_parallel_master_ip
                )
Rui Qiao's avatar
Rui Qiao committed
1601
1602
        else:
            data_parallel_address = self.data_parallel_address
1603
1604
1605

        # This port is only used when there are remote data parallel engines,
        # otherwise the local IPC transport is used.
1606
        data_parallel_rpc_port = (
1607
            self.data_parallel_rpc_port
1608
1609
1610
            if (self.data_parallel_rpc_port is not None)
            else ParallelConfig.data_parallel_rpc_port
        )
1611

1612
1613
1614
1615
        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.")

1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
        # Forward the deprecated CLI args to the EPLB config.
        if self.num_redundant_experts is not None:
            self.eplb_config.num_redundant_experts = self.num_redundant_experts
        if self.eplb_window_size is not None:
            self.eplb_config.window_size = self.eplb_window_size
        if self.eplb_step_interval is not None:
            self.eplb_config.step_interval = self.eplb_step_interval
        if self.eplb_log_balancedness is not None:
            self.eplb_config.log_balancedness = self.eplb_log_balancedness

1626
        parallel_config = ParallelConfig(
1627
1628
            pipeline_parallel_size=self.pipeline_parallel_size,
            tensor_parallel_size=self.tensor_parallel_size,
1629
            prefill_context_parallel_size=self.prefill_context_parallel_size,
1630
            data_parallel_size=self.data_parallel_size,
1631
1632
            data_parallel_rank=self.data_parallel_rank or 0,
            data_parallel_external_lb=data_parallel_external_lb,
1633
            data_parallel_size_local=data_parallel_size_local,
1634
1635
1636
1637
            master_addr=self.master_addr,
            master_port=self.master_port,
            nnodes=self.nnodes,
            node_rank=self.node_rank,
1638
1639
            data_parallel_master_ip=data_parallel_address,
            data_parallel_rpc_port=data_parallel_rpc_port,
1640
            data_parallel_backend=self.data_parallel_backend,
1641
            data_parallel_hybrid_lb=self.data_parallel_hybrid_lb,
1642
            enable_expert_parallel=self.enable_expert_parallel,
1643
            all2all_backend=self.all2all_backend,
1644
1645
            enable_dbo=self.enable_dbo,
            dbo_decode_token_threshold=self.dbo_decode_token_threshold,
1646
            dbo_prefill_token_threshold=self.dbo_prefill_token_threshold,
1647
            disable_nccl_for_dp_synchronization=self.disable_nccl_for_dp_synchronization,
1648
            enable_eplb=self.enable_eplb,
1649
            eplb_config=self.eplb_config,
1650
            expert_placement_strategy=self.expert_placement_strategy,
1651
1652
1653
            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,
1654
            ray_runtime_env=ray_runtime_env,
1655
            placement_group=placement_group,
1656
1657
            distributed_executor_backend=self.distributed_executor_backend,
            worker_cls=self.worker_cls,
1658
            worker_extension_cls=self.worker_extension_cls,
1659
            decode_context_parallel_size=self.decode_context_parallel_size,
1660
            dcp_kv_cache_interleave_size=self.dcp_kv_cache_interleave_size,
1661
            cp_kv_cache_interleave_size=self.cp_kv_cache_interleave_size,
1662
1663
            _api_process_count=self._api_process_count,
            _api_process_rank=self._api_process_rank,
1664
        )
1665

1666
        speculative_config = self.create_speculative_config(
1667
1668
1669
1670
            target_model_config=model_config,
            target_parallel_config=parallel_config,
        )

1671
        scheduler_config = SchedulerConfig(
1672
            runner_type=model_config.runner_type,
1673
1674
1675
            max_num_batched_tokens=self.max_num_batched_tokens,
            max_num_seqs=self.max_num_seqs,
            max_model_len=model_config.max_model_len,
1676
            enable_chunked_prefill=self.enable_chunked_prefill,
1677
            disable_chunked_mm_input=self.disable_chunked_mm_input,
1678
            is_multimodal_model=model_config.is_multimodal_model,
1679
            is_encoder_decoder=model_config.is_encoder_decoder,
1680
            policy=self.scheduling_policy,
1681
            scheduler_cls=self.scheduler_cls,
1682
1683
1684
            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,
1685
            disable_hybrid_kv_cache_manager=self.disable_hybrid_kv_cache_manager,
1686
            async_scheduling=self.async_scheduling,
1687
            stream_interval=self.stream_interval,
1688
        )
1689

1690
1691
1692
        if not model_config.is_multimodal_model and self.default_mm_loras:
            raise ValueError(
                "Default modality-specific LoRA(s) were provided for a "
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
                "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,
                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
        )
1710

1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
        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"
            )

1725
1726
1727
1728
        # bitsandbytes pre-quantized model need a specific model loader
        if model_config.quantization == "bitsandbytes":
            self.quantization = self.load_format = "bitsandbytes"

1729
        load_config = self.create_load_config()
1730

1731
1732
        # Pass reasoning_parser into StructuredOutputsConfig
        if self.reasoning_parser:
1733
            self.structured_outputs_config.reasoning_parser = self.reasoning_parser
1734

1735
1736
1737
1738
1739
        if self.reasoning_parser_plugin:
            self.structured_outputs_config.reasoning_parser_plugin = (
                self.reasoning_parser_plugin
            )

1740
1741
1742
        # Forward the deprecated CLI args to the StructuredOutputsConfig
        so_config = self.structured_outputs_config
        if self.guided_decoding_backend is not None:
1743
            so_config.guided_decoding_backend = self.guided_decoding_backend
1744
        if self.guided_decoding_disable_fallback is not None:
1745
            so_config.disable_fallback = self.guided_decoding_disable_fallback
1746
        if self.guided_decoding_disable_any_whitespace is not None:
1747
            so_config.disable_any_whitespace = (
1748
1749
                self.guided_decoding_disable_any_whitespace
            )
1750
        if self.guided_decoding_disable_additional_properties is not None:
1751
            so_config.disable_additional_properties = (
1752
1753
                self.guided_decoding_disable_additional_properties
            )
1754

1755
        observability_config = ObservabilityConfig(
1756
            show_hidden_metrics_for_version=self.show_hidden_metrics_for_version,
1757
            otlp_traces_endpoint=self.otlp_traces_endpoint,
1758
            collect_detailed_traces=self.collect_detailed_traces,
1759
        )
1760

1761
        # Compilation config overrides
1762
        compilation_config = copy.deepcopy(self.compilation_config)
1763
1764
1765
1766
1767
1768
        if self.cuda_graph_sizes is not None:
            logger.warning(
                "--cuda-graph-sizes is deprecated and will be removed in v0.13.0 or "
                "v1.0.0, whichever is soonest. Please use --cudagraph-capture-sizes "
                "instead."
            )
1769
            if compilation_config.cudagraph_capture_sizes is not None:
1770
1771
1772
1773
                raise ValueError(
                    "cuda_graph_sizes and compilation_config."
                    "cudagraph_capture_sizes are mutually exclusive"
                )
1774
            compilation_config.cudagraph_capture_sizes = self.cuda_graph_sizes
1775
        if self.cudagraph_capture_sizes is not None:
1776
            if compilation_config.cudagraph_capture_sizes is not None:
1777
1778
1779
1780
                raise ValueError(
                    "cudagraph_capture_sizes and compilation_config."
                    "cudagraph_capture_sizes are mutually exclusive"
                )
1781
            compilation_config.cudagraph_capture_sizes = self.cudagraph_capture_sizes
1782
        if self.max_cudagraph_capture_size is not None:
1783
            if compilation_config.max_cudagraph_capture_size is not None:
1784
1785
1786
1787
                raise ValueError(
                    "max_cudagraph_capture_size and compilation_config."
                    "max_cudagraph_capture_size are mutually exclusive"
                )
1788
            compilation_config.max_cudagraph_capture_size = (
1789
1790
1791
                self.max_cudagraph_capture_size
            )

1792
        config = VllmConfig(
1793
1794
1795
1796
1797
1798
1799
1800
            model_config=model_config,
            cache_config=cache_config,
            parallel_config=parallel_config,
            scheduler_config=scheduler_config,
            device_config=device_config,
            lora_config=lora_config,
            speculative_config=speculative_config,
            load_config=load_config,
1801
            structured_outputs_config=self.structured_outputs_config,
1802
            observability_config=observability_config,
1803
            compilation_config=compilation_config,
1804
            kv_transfer_config=self.kv_transfer_config,
1805
            kv_events_config=self.kv_events_config,
1806
            ec_transfer_config=self.ec_transfer_config,
1807
            additional_config=self.additional_config,
1808
        )
1809

1810
1811
        return config

1812
1813
    def _check_feature_supported(self, model_config: ModelConfig):
        """Raise an error if the feature is not supported."""
1814
        if self.logits_processor_pattern != EngineArgs.logits_processor_pattern:
1815
            _raise_unsupported_error(feature_name="--logits-processor-pattern")
1816
1817

        # No Concurrent Partial Prefills so far.
1818
1819
1820
1821
1822
        if (
            self.max_num_partial_prefills != SchedulerConfig.max_num_partial_prefills
            or self.max_long_partial_prefills
            != SchedulerConfig.max_long_partial_prefills
        ):
1823
            _raise_unsupported_error(feature_name="Concurrent Partial Prefill")
1824

1825
        # N-gram, Medusa, and Eagle are supported for speculative decoding.
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
        if self.speculative_config is not None:
            # speculative_config could still be a dict at this point
            if isinstance(self.speculative_config, dict):
                method = self.speculative_config.get("method", None)
            else:
                method = self.speculative_config.method

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

1840
        if self.pipeline_parallel_size > 1:
1841
1842
1843
            supports_pp = getattr(
                self.distributed_executor_backend, "supports_pp", False
            )
1844
            if not supports_pp and self.distributed_executor_backend not in (
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
                ParallelConfig.distributed_executor_backend,
                "ray",
                "mp",
                "external_launcher",
            ):
                name = (
                    "Pipeline Parallelism without Ray distributed "
                    "executor or multiprocessing executor or external "
                    "launcher"
                )
1855
                _raise_unsupported_error(feature_name=name)
1856

1857
1858
1859
1860
1861
    @classmethod
    def get_chunked_prefill_prefix_caching_defaults(
        cls,
        model_config: ModelConfig,
    ) -> tuple[bool, bool]:
1862
        if model_config.runner_type != "pooling":
1863
1864
1865
1866
1867
            default_chunked_prefill = True

            # Disable prefix caching default for hybrid models
            # since the feature is still experimental.
            default_prefix_caching = not model_config.is_hybrid
1868
        else:
1869
1870
            assert model_config.pooler_config is not None

1871
            pooling_type = model_config.pooler_config.pooling_type
1872
1873
1874
            incremental_prefill_supported = (
                pooling_type is not None
                and pooling_type.lower() == "last"
1875
                and getattr(model_config.hf_config, "is_causal", True)
1876
            )
1877

1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
            default_chunked_prefill = incremental_prefill_supported
            default_prefix_caching = incremental_prefill_supported

        return default_chunked_prefill, default_prefix_caching

    @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
1889

1890
1891
        default_max_num_batched_tokens: dict[UsageContext | None, int]
        default_max_num_seqs: dict[UsageContext | None, int]
1892

1893
1894
        # When no user override, set the default values based on the usage
        # context.
1895
        # Use different default values for different hardware.
1896
1897
1898
1899
1900
1901
1902

        # 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:
1903
            device_memory = current_platform.get_device_total_memory()
1904
            device_name = current_platform.get_device_name().lower()
1905
1906
        except Exception:
            # This is only used to set default_max_num_batched_tokens
1907
            device_memory = 0
1908

1909
1910
1911
1912
        # 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:
1913
            # For GPUs like H100 and MI300x, use larger default values.
1914
1915
1916
1917
            default_max_num_batched_tokens = {
                UsageContext.LLM_CLASS: 16384,
                UsageContext.OPENAI_API_SERVER: 8192,
            }
1918
1919
1920
1921
            default_max_num_seqs = {
                UsageContext.LLM_CLASS: 1024,
                UsageContext.OPENAI_API_SERVER: 1024,
            }
1922
1923
1924
1925
1926
1927
        else:
            # TODO(woosuk): Tune the default values for other hardware.
            default_max_num_batched_tokens = {
                UsageContext.LLM_CLASS: 8192,
                UsageContext.OPENAI_API_SERVER: 2048,
            }
1928
1929
1930
1931
            default_max_num_seqs = {
                UsageContext.LLM_CLASS: 256,
                UsageContext.OPENAI_API_SERVER: 256,
            }
1932

1933
1934
        # tpu specific default values.
        if current_platform.is_tpu():
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
            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,
                }
1952

1953
1954
1955
        # cpu specific default values.
        if current_platform.is_cpu():
            default_max_num_batched_tokens = {
1956
1957
                UsageContext.LLM_CLASS: 4096 * world_size,
                UsageContext.OPENAI_API_SERVER: 2048 * world_size,
1958
1959
            }
            default_max_num_seqs = {
1960
1961
                UsageContext.LLM_CLASS: 256 * world_size,
                UsageContext.OPENAI_API_SERVER: 128 * world_size,
1962
1963
            }

1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
        return default_max_num_batched_tokens, default_max_num_seqs

    def _set_default_args(
        self, usage_context: UsageContext, model_config: ModelConfig
    ) -> None:
        """Set Default Arguments for V1 Engine."""
        (
            default_chunked_prefill,
            default_prefix_caching,
        ) = self.get_chunked_prefill_prefix_caching_defaults(model_config)

1975
1976
1977
1978
1979
1980
1981
1982
1983
        if self.prefill_context_parallel_size > 1:
            default_chunked_prefill = False
            default_prefix_caching = False
            logger.warning(
                "--prefill-context-parallel-size > 1 is not compatible with "
                "chunked prefill and prefix caching now. Chunked prefill "
                "and prefix caching have been disabled by default."
            )

1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
        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",
            )
        elif (
            model_config.runner_type == "pooling"
            and self.enable_chunked_prefill
            and not default_chunked_prefill
1995
        ):
1996
1997
1998
1999
2000
2001
2002
2003
2004
            logger.warning(
                "This model does not officially support chunked prefill. "
                "Enabling this manually may cause the engine to crash "
                "or produce incorrect outputs.",
            )

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

2005
            logger.debug(
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
                "%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
        ):
            logger.warning(
                "This model does not officially support prefix caching. "
                "Enabling this manually may cause the engine to crash "
                "or produce incorrect outputs.",
            )

        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,
2054
2055
                self.max_num_batched_tokens,
            )
2056

2057
2058
2059
2060
            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,
2061
            )
2062

2063
2064
2065
2066
        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)

2067
            logger.debug(
2068
                "Defaulting max_num_seqs to %d for %s usage context.",
2069
                self.max_num_seqs,
2070
                usage_context.value if usage_context else None,
2071
            )
2072

2073

2074
@dataclass
Zhuohan Li's avatar
Zhuohan Li committed
2075
class AsyncEngineArgs(EngineArgs):
Woosuk Kwon's avatar
Woosuk Kwon committed
2076
    """Arguments for asynchronous vLLM engine."""
2077

2078
2079
2080
2081
2082
2083
    enable_log_requests: bool = False

    @property
    @deprecated(
        "`disable_log_requests` is deprecated and has been replaced with "
        "`enable_log_requests`. This will be removed in v0.12.0. Please use "
2084
2085
        "`enable_log_requests` instead."
    )
2086
2087
2088
2089
2090
2091
2092
    def disable_log_requests(self) -> bool:
        return not self.enable_log_requests

    @disable_log_requests.setter
    @deprecated(
        "`disable_log_requests` is deprecated and has been replaced with "
        "`enable_log_requests`. This will be removed in v0.12.0. Please use "
2093
2094
        "`enable_log_requests` instead."
    )
2095
2096
    def disable_log_requests(self, value: bool):
        self.enable_log_requests = not value
2097
2098

    @staticmethod
2099
2100
2101
    def add_cli_args(
        parser: FlexibleArgumentParser, async_args_only: bool = False
    ) -> FlexibleArgumentParser:
2102
        # Initialize plugin to update the parser, for example, The plugin may
2103
        # add a new kind of quantization method to --quantization argument or
2104
2105
        # a new device to --device argument.
        load_general_plugins()
2106
2107
        if not async_args_only:
            parser = EngineArgs.add_cli_args(parser)
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
        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,
        )
2121
        current_platform.pre_register_and_update(parser)
2122
        return parser
2123
2124


2125
2126
2127
2128
2129
2130
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)
2131
2132


2133
2134
2135
def human_readable_int(value):
    """Parse human-readable integers like '1k', '2M', etc.
    Including decimal values with decimal multipliers.
2136

2137
2138
2139
2140
2141
2142
    Examples:
    - '1k' -> 1,000
    - '1K' -> 1,024
    - '25.6k' -> 25,600
    """
    value = value.strip()
2143
    match = re.fullmatch(r"(\d+(?:\.\d+)?)([kKmMgGtT])", value)
2144
2145
    if match:
        decimal_multiplier = {
2146
2147
2148
            "k": 10**3,
            "m": 10**6,
            "g": 10**9,
2149
2150
        }
        binary_multiplier = {
2151
2152
2153
            "K": 2**10,
            "M": 2**20,
            "G": 2**30,
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
        }

        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:
2166
2167
2168
2169
2170
                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
2171
2172
2173

    # Regular plain number.
    return int(value)