arg_utils.py 87 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, suppress_logging
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
            # Handle pydantic.Field defaults
            if isinstance(default, FieldInfo):
250
251
252
253
254
255
256
                if default.default_factory is None:
                    default = default.default
                else:
                    # VllmConfig's Fields have default_factory set to config classes.
                    # These could emit logs on init, which would be confusing.
                    with suppress_logging():
                        default = default.default_factory()
257
        elif field.default_factory is not MISSING:
258
            default = field.default_factory()
259
260
261

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

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

322
323
324
325
326
        # If the type hint was a sequence of literals, use the helper function
        # to update the type and choices
        if get_origin(kwargs[name].get("type")) is Literal:
            kwargs[name].update(literal_to_kwargs({kwargs[name]["type"]}))

327
328
329
330
331
332
333
        # If None is in type_hints, make the argument optional.
        # But not if it's a bool, argparse will handle this better.
        if type(None) in type_hints and not contains_type(type_hints, bool):
            kwargs[name]["type"] = optional_type(kwargs[name]["type"])
            if kwargs[name].get("choices"):
                kwargs[name]["choices"].append("None")
    return kwargs
334
335


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

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

342
343
344
345
346
347
348
    The heavy computation is cached via functools.lru_cache, and a deep copy
    is returned so callers can mutate the dictionary without affecting the
    cached version.
    """
    return copy.deepcopy(_compute_kwargs(cls))


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

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

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

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

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

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

508
    logits_processor_pattern: str | None = ModelConfig.logits_processor_pattern
509

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

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

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

530
531
    kv_transfer_config: KVTransferConfig | None = None
    kv_events_config: KVEventsConfig | None = None
532

533
534
    ec_transfer_config: ECTransferConfig | None = None

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

543
    calculate_kv_scales: bool = CacheConfig.calculate_kv_scales
544
545
    mamba_cache_dtype: MambaDType = CacheConfig.mamba_cache_dtype
    mamba_ssm_cache_dtype: MambaDType = CacheConfig.mamba_ssm_cache_dtype
546
    mamba_block_size: int | None = get_field(CacheConfig, "mamba_block_size")
547

548
    additional_config: dict[str, Any] = get_field(VllmConfig, "additional_config")
549

550
    use_tqdm_on_load: bool = LoadConfig.use_tqdm_on_load
551
    pt_load_map_location: str = LoadConfig.pt_load_map_location
552

553
554
    # DEPRECATED
    enable_multimodal_encoder_data_parallel: bool = False
555

556
    logits_processors: list[str | type[LogitsProcessor]] | None = (
557
558
        ModelConfig.logits_processors
    )
559
560
    """Custom logitproc types"""

561
    async_scheduling: bool | None = SchedulerConfig.async_scheduling
562

563
564
    stream_interval: int = SchedulerConfig.stream_interval

565
    kv_sharing_fast_prefill: bool = CacheConfig.kv_sharing_fast_prefill
566

567
568
569
570
    kv_offloading_size: float | None = CacheConfig.kv_offloading_size
    kv_offloading_backend: KVOffloadingBackend | None = (
        CacheConfig.kv_offloading_backend
    )
571
    tokens_only: bool = False
572

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

584
        load_general_plugins()
585
586
587
588
589
        # 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(
590
591
592
593
                "HF_HUB_OFFLINE is True, replace model_id [%s] to model_path [%s]",
                model_id,
                self.model,
            )
594
595

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

599
        # Model arguments
600
601
602
603
604
        model_kwargs = get_kwargs(ModelConfig)
        model_group = parser.add_argument_group(
            title="ModelConfig",
            description=ModelConfig.__doc__,
        )
605
        if not ("serve" in sys.argv[1:] and "--help" in sys.argv[1:]):
606
            model_group.add_argument("--model", **model_kwargs["model"])
607
608
        model_group.add_argument("--runner", **model_kwargs["runner"])
        model_group.add_argument("--convert", **model_kwargs["convert"])
609
        model_group.add_argument("--task", **model_kwargs["task"], deprecated=True)
610
        model_group.add_argument("--tokenizer", **model_kwargs["tokenizer"])
611
612
613
614
        model_group.add_argument("--tokenizer-mode", **model_kwargs["tokenizer_mode"])
        model_group.add_argument(
            "--trust-remote-code", **model_kwargs["trust_remote_code"]
        )
615
616
        model_group.add_argument("--dtype", **model_kwargs["dtype"])
        model_group.add_argument("--seed", **model_kwargs["seed"])
617
618
619
620
621
622
623
        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"]
        )
624
        model_group.add_argument("--revision", **model_kwargs["revision"])
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
        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"])
650
651
        # This one is a special case because it can bool
        # or str. TODO: Handle this in get_kwargs
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
        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"]
        )
679
        model_group.add_argument("--model-impl", **model_kwargs["model_impl"])
680
681
682
683
684
685
686
687
688
        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"]
        )
689

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

710
711
712
713
714
        # Structured outputs arguments
        structured_outputs_kwargs = get_kwargs(StructuredOutputsConfig)
        structured_outputs_group = parser.add_argument_group(
            title="StructuredOutputsConfig",
            description=StructuredOutputsConfig.__doc__,
715
        )
716
        structured_outputs_group.add_argument(
717
            "--reasoning-parser",
718
            # Choices need to be validated after parsing to include plugins
719
720
            **structured_outputs_kwargs["reasoning_parser"],
        )
721
722
723
724
        structured_outputs_group.add_argument(
            "--reasoning-parser-plugin",
            **structured_outputs_kwargs["reasoning_parser_plugin"],
        )
725

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

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

864
865
866
867
868
        # KV cache arguments
        cache_kwargs = get_kwargs(CacheConfig)
        cache_group = parser.add_argument_group(
            title="CacheConfig",
            description=CacheConfig.__doc__,
869
        )
870
        cache_group.add_argument("--block-size", **cache_kwargs["block_size"])
871
872
873
874
875
876
        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"]
        )
877
        cache_group.add_argument("--swap-space", **cache_kwargs["swap_space"])
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
        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"]
        )
901
902
903
        cache_group.add_argument(
            "--mamba-block-size", **cache_kwargs["mamba_block_size"]
        )
904
905
906
907
908
909
        cache_group.add_argument(
            "--kv-offloading-size", **cache_kwargs["kv_offloading_size"]
        )
        cache_group.add_argument(
            "--kv-offloading-backend", **cache_kwargs["kv_offloading_backend"]
        )
910

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

956
        multimodal_group.add_argument(
957
958
            "--video-pruning-rate", **multimodal_kwargs["video_pruning_rate"]
        )
959

960
        # LoRA related configs
961
962
963
964
965
966
        lora_kwargs = get_kwargs(LoRAConfig)
        lora_group = parser.add_argument_group(
            title="LoRAConfig",
            description=LoRAConfig.__doc__,
        )
        lora_group.add_argument(
967
            "--enable-lora",
968
            action=argparse.BooleanOptionalAction,
969
970
            help="If True, enable handling of LoRA adapters.",
        )
971
        lora_group.add_argument("--max-loras", **lora_kwargs["max_loras"])
972
        lora_group.add_argument("--max-lora-rank", **lora_kwargs["max_lora_rank"])
973
        lora_group.add_argument(
974
            "--lora-dtype",
975
976
            **lora_kwargs["lora_dtype"],
        )
977
978
979
980
981
        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"])
982

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

1008
1009
1010
1011
1012
1013
1014
        # Scheduler arguments
        scheduler_kwargs = get_kwargs(SchedulerConfig)
        scheduler_group = parser.add_argument_group(
            title="SchedulerConfig",
            description=SchedulerConfig.__doc__,
        )
        scheduler_group.add_argument(
1015
1016
1017
1018
1019
            "--max-num-batched-tokens",
            **{
                **scheduler_kwargs["max_num_batched_tokens"],
                "default": None,
            },
1020
        )
1021
        scheduler_group.add_argument(
1022
1023
1024
1025
1026
            "--max-num-seqs",
            **{
                **scheduler_kwargs["max_num_seqs"],
                "default": None,
            },
1027
1028
1029
1030
        )
        scheduler_group.add_argument(
            "--max-num-partial-prefills", **scheduler_kwargs["max_num_partial_prefills"]
        )
1031
1032
        scheduler_group.add_argument(
            "--max-long-partial-prefills",
1033
1034
            **scheduler_kwargs["max_long_partial_prefills"],
        )
1035
1036
        scheduler_group.add_argument(
            "--long-prefill-token-threshold",
1037
1038
            **scheduler_kwargs["long_prefill_token_threshold"],
        )
1039
1040
        # multi-step scheduling has been removed; corresponding arguments
        # are no longer supported.
1041
        scheduler_group.add_argument(
1042
1043
            "--scheduling-policy", **scheduler_kwargs["policy"]
        )
1044
        scheduler_group.add_argument(
1045
1046
1047
1048
1049
            "--enable-chunked-prefill",
            **{
                **scheduler_kwargs["enable_chunked_prefill"],
                "default": None,
            },
1050
1051
1052
1053
1054
1055
1056
        )
        scheduler_group.add_argument(
            "--disable-chunked-mm-input", **scheduler_kwargs["disable_chunked_mm_input"]
        )
        scheduler_group.add_argument(
            "--scheduler-cls", **scheduler_kwargs["scheduler_cls"]
        )
1057
1058
        scheduler_group.add_argument(
            "--disable-hybrid-kv-cache-manager",
1059
1060
1061
1062
1063
            **scheduler_kwargs["disable_hybrid_kv_cache_manager"],
        )
        scheduler_group.add_argument(
            "--async-scheduling", **scheduler_kwargs["async_scheduling"]
        )
1064
1065
1066
        scheduler_group.add_argument(
            "--stream-interval", **scheduler_kwargs["stream_interval"]
        )
1067

1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
        # 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"],
        )

1091
        # vLLM arguments
1092
        vllm_kwargs = get_kwargs(VllmConfig)
1093
1094
1095
1096
        vllm_group = parser.add_argument_group(
            title="VllmConfig",
            description=VllmConfig.__doc__,
        )
1097
1098
1099
1100
        # 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)
1101
1102
1103
1104
1105
1106
1107
        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"])
1108
1109
1110
        vllm_group.add_argument(
            "--ec-transfer-config", **vllm_kwargs["ec_transfer_config"]
        )
1111
1112
1113
1114
1115
1116
1117
1118
1119
        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"]
        )
1120

1121
        # Other arguments
1122
1123
1124
1125
1126
        parser.add_argument(
            "--disable-log-stats",
            action="store_true",
            help="Disable logging statistics.",
        )
1127

1128
1129
1130
1131
1132
1133
        parser.add_argument(
            "--aggregate-engine-logging",
            action="store_true",
            help="Log aggregate rather than per-engine statistics "
            "when using data parallelism.",
        )
1134
        return parser
1135
1136

    @classmethod
1137
    def from_cli_args(cls, args: argparse.Namespace):
1138
1139
1140
        # Get the list of attributes of this dataclass.
        attrs = [attr.name for attr in dataclasses.fields(cls)]
        # Set the attributes from the parsed arguments.
1141
1142
1143
        engine_args = cls(
            **{attr: getattr(args, attr) for attr in attrs if hasattr(args, attr)}
        )
Zhuohan Li's avatar
Zhuohan Li committed
1144
        return engine_args
1145

1146
    def create_model_config(self) -> ModelConfig:
1147
1148
1149
1150
        # 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"

1151
1152
1153
1154
        # 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:
1155
1156
1157
1158
1159
1160
            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",
            )

1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
            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,
                )

1171
        if self.disable_mm_preprocessor_cache:
1172
            logger.warning_once(
1173
1174
                "`--disable-mm-preprocessor-cache` is deprecated "
                "and will be removed in v0.13. "
1175
                "Please use `--mm-processor-cache-gb 0` instead.",
1176
                scope="local",
1177
            )
1178
1179
1180

            self.mm_processor_cache_gb = 0
        elif envs.VLLM_MM_INPUT_CACHE_GIB != 4:
1181
            logger.warning_once(
1182
1183
1184
1185
                "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,
1186
                scope="local",
1187
1188
1189
1190
            )

            self.mm_processor_cache_gb = envs.VLLM_MM_INPUT_CACHE_GIB

1191
        if self.enable_multimodal_encoder_data_parallel:
1192
            logger.warning_once(
1193
1194
                "--enable-multimodal-encoder-data-parallel` is deprecated "
                "and will be removed in v0.13. "
1195
1196
                "Please use `--mm-encoder-tp-mode data` instead.",
                scope="local",
1197
            )
1198
1199
1200

            self.mm_encoder_tp_mode = "data"

1201
        return ModelConfig(
1202
            model=self.model,
1203
            hf_config_path=self.hf_config_path,
1204
1205
            runner=self.runner,
            convert=self.convert,
1206
            task=self.task,
1207
            tokenizer=self.tokenizer,
1208
1209
            tokenizer_mode=self.tokenizer_mode,
            trust_remote_code=self.trust_remote_code,
1210
            allowed_local_media_path=self.allowed_local_media_path,
1211
            allowed_media_domains=self.allowed_media_domains,
1212
1213
1214
1215
            dtype=self.dtype,
            seed=self.seed,
            revision=self.revision,
            code_revision=self.code_revision,
1216
            hf_token=self.hf_token,
1217
            hf_overrides=self.hf_overrides,
1218
1219
1220
1221
1222
            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,
1223
            logprobs_mode=self.logprobs_mode,
1224
            disable_sliding_window=self.disable_sliding_window,
1225
            disable_cascade_attn=self.disable_cascade_attn,
1226
            skip_tokenizer_init=self.skip_tokenizer_init,
1227
            enable_prompt_embeds=self.enable_prompt_embeds,
1228
            served_model_name=self.served_model_name,
1229
            limit_mm_per_prompt=self.limit_mm_per_prompt,
1230
            enable_mm_embeds=self.enable_mm_embeds,
1231
            interleave_mm_strings=self.interleave_mm_strings,
1232
            media_io_kwargs=self.media_io_kwargs,
1233
            skip_mm_profiling=self.skip_mm_profiling,
1234
            config_format=self.config_format,
1235
            mm_processor_kwargs=self.mm_processor_kwargs,
1236
            mm_processor_cache_gb=self.mm_processor_cache_gb,
1237
            mm_processor_cache_type=self.mm_processor_cache_type,
1238
            mm_shm_cache_max_object_size_mb=self.mm_shm_cache_max_object_size_mb,
1239
            mm_encoder_tp_mode=self.mm_encoder_tp_mode,
1240
            mm_encoder_attn_backend=self.mm_encoder_attn_backend,
1241
            pooler_config=self.pooler_config,
1242
            override_pooler_config=self.override_pooler_config,
1243
            logits_processor_pattern=self.logits_processor_pattern,
1244
            generation_config=self.generation_config,
1245
            override_generation_config=self.override_generation_config,
1246
            enable_sleep_mode=self.enable_sleep_mode,
1247
            model_impl=self.model_impl,
1248
            override_attention_dtype=self.override_attention_dtype,
1249
            logits_processors=self.logits_processors,
1250
            video_pruning_rate=self.video_pruning_rate,
1251
            io_processor_plugin=self.io_processor_plugin,
1252
        )
1253

1254
    def validate_tensorizer_args(self):
1255
1256
        from vllm.model_executor.model_loader.tensorizer import TensorizerConfig

1257
1258
        for key in self.model_loader_extra_config:
            if key in TensorizerConfig._fields:
1259
1260
1261
                self.model_loader_extra_config["tensorizer_config"][key] = (
                    self.model_loader_extra_config[key]
                )
1262

1263
    def create_load_config(self) -> LoadConfig:
1264
1265
        if self.quantization == "bitsandbytes":
            self.load_format = "bitsandbytes"
1266

1267
1268
1269
        if self.load_format == "tensorizer":
            if hasattr(self.model_loader_extra_config, "to_serializable"):
                self.model_loader_extra_config = (
1270
1271
                    self.model_loader_extra_config.to_serializable()
                )
1272
            self.model_loader_extra_config["tensorizer_config"] = {}
1273
1274
1275
            self.model_loader_extra_config["tensorizer_config"]["tensorizer_dir"] = (
                self.model
            )
1276
            self.validate_tensorizer_args()
1277

1278
1279
1280
        return LoadConfig(
            load_format=self.load_format,
            download_dir=self.download_dir,
1281
            safetensors_load_strategy=self.safetensors_load_strategy,
1282
            device="cpu" if is_online_quantization(self.quantization) else None,
1283
1284
            model_loader_extra_config=self.model_loader_extra_config,
            ignore_patterns=self.ignore_patterns,
1285
            use_tqdm_on_load=self.use_tqdm_on_load,
1286
            pt_load_map_location=self.pt_load_map_location,
1287
        )
1288

1289
1290
1291
1292
    def create_speculative_config(
        self,
        target_model_config: ModelConfig,
        target_parallel_config: ParallelConfig,
1293
    ) -> SpeculativeConfig | None:
1294
1295
1296
1297
1298
1299
        """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
1300
        dictionary from the engine.
1301
1302
        """
        if self.speculative_config is None:
1303
            return None
1304

1305
1306
1307
        # Note(Shangming): These parameters are not obtained from the cli arg
        # '--speculative-config' and must be passed in when creating the engine
        # config.
1308
1309
1310
1311
1312
1313
        self.speculative_config.update(
            {
                "target_model_config": target_model_config,
                "target_parallel_config": target_parallel_config,
            }
        )
1314
        return SpeculativeConfig(**self.speculative_config)
1315

1316
1317
    def create_engine_config(
        self,
1318
        usage_context: UsageContext | None = None,
1319
        headless: bool = False,
1320
1321
1322
1323
    ) -> VllmConfig:
        """
        Create the VllmConfig.

1324
        NOTE: If VllmConfig is incompatible, we raise an error.
1325
        """
1326
        current_platform.pre_register_and_update()
1327

1328
        device_config = DeviceConfig(device=cast(Device, current_platform.device_type))
1329

1330
1331
        # Check if the model is a speculator and override model/tokenizer/config
        # BEFORE creating ModelConfig, so the config is created with the target model
1332
1333
1334
1335
        # 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):
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
            (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,
                )
            )

1346
1347
1348
1349
        model_config = self.create_model_config()
        self.model = model_config.model
        self.tokenizer = model_config.tokenizer

1350
        self._check_feature_supported(model_config)
1351

1352
1353
        # Set default arguments for V1 Engine.
        self._set_default_args(usage_context, model_config)
1354
        # Disable chunked prefill and prefix caching for:
1355
        # POWER (ppc64le)/s390x/RISCV CPUs in V1
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
        if current_platform.is_cpu() and current_platform.get_cpu_architecture() in (
            CpuArchEnum.POWERPC,
            CpuArchEnum.S390X,
            CpuArchEnum.RISCV,
        ):
            logger.info(
                "Chunked prefill is not supported for ARM and POWER, "
                "S390X and RISC-V CPUs; "
                "disabling it for V1 backend."
            )
1366
            self.enable_chunked_prefill = False
1367
1368
1369
1370
1371
1372
1373
            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

1374
1375
        assert self.enable_chunked_prefill is not None

1376
        sliding_window: int | None = None
1377
1378
1379
1380
1381
1382
        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()

1383
1384
1385
        # 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
1386
        # reuses the GPUs of TP group, and split one TP group into
1387
        # tp_size//dcp_size DCP groups.
1388
        assert self.tensor_parallel_size % self.decode_context_parallel_size == 0, (
1389
1390
1391
1392
            f"tp_size={self.tensor_parallel_size} must be divisible by"
            f"dcp_size={self.decode_context_parallel_size}."
        )

1393
        cache_config = CacheConfig(
1394
            block_size=self.block_size,
1395
            gpu_memory_utilization=self.gpu_memory_utilization,
1396
            kv_cache_memory_bytes=self.kv_cache_memory_bytes,
1397
1398
            swap_space=self.swap_space,
            cache_dtype=self.kv_cache_dtype,
1399
            is_attention_free=model_config.is_attention_free,
1400
            num_gpu_blocks_override=self.num_gpu_blocks_override,
1401
            sliding_window=sliding_window,
1402
            enable_prefix_caching=self.enable_prefix_caching,
1403
            prefix_caching_hash_algo=self.prefix_caching_hash_algo,
1404
            cpu_offload_gb=self.cpu_offload_gb,
1405
            calculate_kv_scales=self.calculate_kv_scales,
1406
            kv_sharing_fast_prefill=self.kv_sharing_fast_prefill,
1407
1408
            mamba_cache_dtype=self.mamba_cache_dtype,
            mamba_ssm_cache_dtype=self.mamba_ssm_cache_dtype,
1409
            mamba_block_size=self.mamba_block_size,
1410
1411
            kv_offloading_size=self.kv_offloading_size,
            kv_offloading_backend=self.kv_offloading_backend,
1412
        )
1413

1414
1415
1416
1417
1418
1419
        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
1420

1421
            ray_runtime_env = ray.get_runtime_context().runtime_env
1422
1423
1424
1425
1426
1427
1428
            # 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)
1429

1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
        # 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()

1441
        assert not headless or not self.data_parallel_hybrid_lb, (
1442
1443
            "data_parallel_hybrid_lb is not applicable in headless mode"
        )
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
        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
        )
1485
        # Local DP rank = 1, use pure-external LB.
1486
        if data_parallel_external_lb:
1487
            assert self.data_parallel_rank is not None, (
1488
                "data_parallel_rank or node_rank must be specified if "
1489
1490
                "data_parallel_external_lb is enable."
            )
1491
            assert self.data_parallel_size_local in (1, None), (
1492
1493
                "data_parallel_size_local must be 1 or None when data_parallel_rank "
                "is set"
1494
            )
1495
            data_parallel_size_local = 1
1496
1497
            # Use full external lb if we have local_size of 1.
            self.data_parallel_hybrid_lb = False
1498
1499
        elif self.data_parallel_size_local is not None:
            data_parallel_size_local = self.data_parallel_size_local
1500
1501
1502
1503
1504
1505
1506

            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.
1507
1508
1509
1510
1511
                logger.warning(
                    "data_parallel_hybrid_lb is not eligible when "
                    "data_parallel_size_local = 1, autoswitch to "
                    "data_parallel_external_lb."
                )
1512
1513
1514
1515
1516
1517
1518
                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

1519
1520
1521
1522
1523
1524
1525
1526
1527
            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,
                )
1528
        else:
1529
            assert not self.data_parallel_hybrid_lb, (
1530
1531
                "data_parallel_size_local must be set to use data_parallel_hybrid_lb."
            )
1532

1533
1534
1535
1536
1537
1538
1539
1540
1541
            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
1542
1543
1544

        # DP address, used in multi-node case for torch distributed group
        # and ZMQ sockets.
Rui Qiao's avatar
Rui Qiao committed
1545
1546
1547
1548
        if self.data_parallel_address is None:
            if self.data_parallel_backend == "ray":
                host_ip = get_ip()
                logger.info(
1549
1550
                    "Using host IP %s as ray-based data parallel address", host_ip
                )
Rui Qiao's avatar
Rui Qiao committed
1551
1552
1553
1554
                data_parallel_address = host_ip
            else:
                assert self.data_parallel_backend == "mp", (
                    "data_parallel_backend can only be ray or mp, got %s",
1555
1556
                    self.data_parallel_backend,
                )
1557
1558
1559
                data_parallel_address = (
                    self.master_addr or ParallelConfig.data_parallel_master_ip
                )
Rui Qiao's avatar
Rui Qiao committed
1560
1561
        else:
            data_parallel_address = self.data_parallel_address
1562
1563
1564

        # This port is only used when there are remote data parallel engines,
        # otherwise the local IPC transport is used.
1565
        data_parallel_rpc_port = (
1566
            self.data_parallel_rpc_port
1567
1568
1569
            if (self.data_parallel_rpc_port is not None)
            else ParallelConfig.data_parallel_rpc_port
        )
1570

1571
1572
1573
1574
        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.")

1575
1576
1577
1578
1579
1580
        if self.async_scheduling and not self.disable_nccl_for_dp_synchronization:
            logger.info(
                "Disabling NCCL for DP synchronization when using async scheduling."
            )
            self.disable_nccl_for_dp_synchronization = True

1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
        # 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

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

1631
        speculative_config = self.create_speculative_config(
1632
1633
1634
1635
            target_model_config=model_config,
            target_parallel_config=parallel_config,
        )

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

1655
1656
1657
        if not model_config.is_multimodal_model and self.default_mm_loras:
            raise ValueError(
                "Default modality-specific LoRA(s) were provided for a "
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
                "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
        )
1675

1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
        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"
            )

1690
1691
1692
1693
        # bitsandbytes pre-quantized model need a specific model loader
        if model_config.quantization == "bitsandbytes":
            self.quantization = self.load_format = "bitsandbytes"

1694
        load_config = self.create_load_config()
1695

1696
1697
        # Pass reasoning_parser into StructuredOutputsConfig
        if self.reasoning_parser:
1698
            self.structured_outputs_config.reasoning_parser = self.reasoning_parser
1699

1700
1701
1702
1703
1704
        if self.reasoning_parser_plugin:
            self.structured_outputs_config.reasoning_parser_plugin = (
                self.reasoning_parser_plugin
            )

1705
        observability_config = ObservabilityConfig(
1706
            show_hidden_metrics_for_version=self.show_hidden_metrics_for_version,
1707
            otlp_traces_endpoint=self.otlp_traces_endpoint,
1708
            collect_detailed_traces=self.collect_detailed_traces,
1709
        )
1710

1711
        # Compilation config overrides
1712
        compilation_config = copy.deepcopy(self.compilation_config)
1713
1714
1715
1716
1717
1718
        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."
            )
1719
            if compilation_config.cudagraph_capture_sizes is not None:
1720
1721
1722
1723
                raise ValueError(
                    "cuda_graph_sizes and compilation_config."
                    "cudagraph_capture_sizes are mutually exclusive"
                )
1724
            compilation_config.cudagraph_capture_sizes = self.cuda_graph_sizes
1725
        if self.cudagraph_capture_sizes is not None:
1726
            if compilation_config.cudagraph_capture_sizes is not None:
1727
1728
1729
1730
                raise ValueError(
                    "cudagraph_capture_sizes and compilation_config."
                    "cudagraph_capture_sizes are mutually exclusive"
                )
1731
            compilation_config.cudagraph_capture_sizes = self.cudagraph_capture_sizes
1732
        if self.max_cudagraph_capture_size is not None:
1733
            if compilation_config.max_cudagraph_capture_size is not None:
1734
1735
1736
1737
                raise ValueError(
                    "max_cudagraph_capture_size and compilation_config."
                    "max_cudagraph_capture_size are mutually exclusive"
                )
1738
            compilation_config.max_cudagraph_capture_size = (
1739
1740
1741
                self.max_cudagraph_capture_size
            )

1742
        config = VllmConfig(
1743
1744
1745
1746
1747
1748
1749
1750
            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,
1751
            structured_outputs_config=self.structured_outputs_config,
1752
            observability_config=observability_config,
1753
            compilation_config=compilation_config,
1754
            kv_transfer_config=self.kv_transfer_config,
1755
            kv_events_config=self.kv_events_config,
1756
            ec_transfer_config=self.ec_transfer_config,
1757
            additional_config=self.additional_config,
1758
        )
1759

1760
1761
        return config

1762
1763
    def _check_feature_supported(self, model_config: ModelConfig):
        """Raise an error if the feature is not supported."""
1764
        if self.logits_processor_pattern != EngineArgs.logits_processor_pattern:
1765
            _raise_unsupported_error(feature_name="--logits-processor-pattern")
1766
1767

        # No Concurrent Partial Prefills so far.
1768
1769
1770
1771
1772
        if (
            self.max_num_partial_prefills != SchedulerConfig.max_num_partial_prefills
            or self.max_long_partial_prefills
            != SchedulerConfig.max_long_partial_prefills
        ):
1773
            _raise_unsupported_error(feature_name="Concurrent Partial Prefill")
1774

1775
        # N-gram, Medusa, and Eagle are supported for speculative decoding.
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
        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 "
1787
1788
                    "such as ngram, medusa, eagle, or mtp."
                )
1789

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

1807
1808
1809
1810
1811
    @classmethod
    def get_chunked_prefill_prefix_caching_defaults(
        cls,
        model_config: ModelConfig,
    ) -> tuple[bool, bool]:
1812
        if model_config.runner_type != "pooling":
1813
1814
1815
1816
1817
            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
1818
        else:
1819
1820
            assert model_config.pooler_config is not None

1821
            pooling_type = model_config.pooler_config.pooling_type
1822
1823
1824
            incremental_prefill_supported = (
                pooling_type is not None
                and pooling_type.lower() == "last"
1825
                and getattr(model_config.hf_config, "is_causal", True)
1826
            )
1827

1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
            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
1839

1840
1841
        default_max_num_batched_tokens: dict[UsageContext | None, int]
        default_max_num_seqs: dict[UsageContext | None, int]
1842

1843
1844
        # When no user override, set the default values based on the usage
        # context.
1845
        # Use different default values for different hardware.
1846
1847
1848
1849
1850
1851
1852

        # 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:
1853
            device_memory = current_platform.get_device_total_memory()
1854
            device_name = current_platform.get_device_name().lower()
1855
1856
        except Exception:
            # This is only used to set default_max_num_batched_tokens
1857
            device_memory = 0
1858

1859
1860
1861
1862
        # 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:
1863
            # For GPUs like H100 and MI300x, use larger default values.
1864
1865
1866
1867
            default_max_num_batched_tokens = {
                UsageContext.LLM_CLASS: 16384,
                UsageContext.OPENAI_API_SERVER: 8192,
            }
1868
1869
1870
1871
            default_max_num_seqs = {
                UsageContext.LLM_CLASS: 1024,
                UsageContext.OPENAI_API_SERVER: 1024,
            }
1872
1873
1874
1875
1876
1877
        else:
            # TODO(woosuk): Tune the default values for other hardware.
            default_max_num_batched_tokens = {
                UsageContext.LLM_CLASS: 8192,
                UsageContext.OPENAI_API_SERVER: 2048,
            }
1878
1879
1880
1881
            default_max_num_seqs = {
                UsageContext.LLM_CLASS: 256,
                UsageContext.OPENAI_API_SERVER: 256,
            }
1882

1883
1884
        # tpu specific default values.
        if current_platform.is_tpu():
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
            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,
                }
1902

1903
1904
1905
        # cpu specific default values.
        if current_platform.is_cpu():
            default_max_num_batched_tokens = {
1906
1907
                UsageContext.LLM_CLASS: 4096 * world_size,
                UsageContext.OPENAI_API_SERVER: 2048 * world_size,
1908
1909
            }
            default_max_num_seqs = {
1910
1911
                UsageContext.LLM_CLASS: 256 * world_size,
                UsageContext.OPENAI_API_SERVER: 128 * world_size,
1912
1913
            }

1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
        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)

1925
1926
1927
        if self.prefill_context_parallel_size > 1:
            default_chunked_prefill = False
            default_prefix_caching = False
1928
            logger.warning_once(
1929
1930
                "--prefill-context-parallel-size > 1 is not compatible with "
                "chunked prefill and prefix caching now. Chunked prefill "
1931
1932
                "and prefix caching have been disabled by default.",
                scope="local",
1933
1934
            )

1935
1936
1937
1938
1939
1940
1941
        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",
            )
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
        elif (
            model_config.runner_type == "generate"
            and not self.enable_chunked_prefill
            and default_chunked_prefill
        ):
            logger.warning_once(
                "This model does not officially support disabling chunked prefill. "
                "Disabling this manually may cause the engine to crash "
                "or produce incorrect outputs.",
                scope="local",
            )
1953
1954
1955
1956
        elif (
            model_config.runner_type == "pooling"
            and self.enable_chunked_prefill
            and not default_chunked_prefill
1957
        ):
1958
            logger.warning_once(
1959
1960
1961
                "This model does not officially support chunked prefill. "
                "Enabling this manually may cause the engine to crash "
                "or produce incorrect outputs.",
1962
                scope="local",
1963
1964
1965
1966
1967
            )

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

1968
            logger.debug(
1969
1970
1971
1972
1973
1974
1975
1976
                "%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
        ):
1977
            logger.warning_once(
1978
1979
1980
                "This model does not officially support prefix caching. "
                "Enabling this manually may cause the engine to crash "
                "or produce incorrect outputs.",
1981
                scope="local",
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
            )

        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,
2018
2019
                self.max_num_batched_tokens,
            )
2020

2021
2022
2023
2024
            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,
2025
            )
2026

2027
2028
2029
2030
        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)

2031
            logger.debug(
2032
                "Defaulting max_num_seqs to %d for %s usage context.",
2033
                self.max_num_seqs,
2034
                usage_context.value if usage_context else None,
2035
            )
2036

2037

2038
@dataclass
Zhuohan Li's avatar
Zhuohan Li committed
2039
class AsyncEngineArgs(EngineArgs):
Woosuk Kwon's avatar
Woosuk Kwon committed
2040
    """Arguments for asynchronous vLLM engine."""
2041

2042
2043
2044
2045
2046
2047
    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 "
2048
2049
        "`enable_log_requests` instead."
    )
2050
2051
2052
2053
2054
2055
2056
    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 "
2057
2058
        "`enable_log_requests` instead."
    )
2059
2060
    def disable_log_requests(self, value: bool):
        self.enable_log_requests = not value
2061
2062

    @staticmethod
2063
2064
2065
    def add_cli_args(
        parser: FlexibleArgumentParser, async_args_only: bool = False
    ) -> FlexibleArgumentParser:
2066
        # Initialize plugin to update the parser, for example, The plugin may
2067
        # add a new kind of quantization method to --quantization argument or
2068
2069
        # a new device to --device argument.
        load_general_plugins()
2070
2071
        if not async_args_only:
            parser = EngineArgs.add_cli_args(parser)
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
        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,
        )
2085
        current_platform.pre_register_and_update(parser)
2086
        return parser
2087
2088


2089
2090
2091
2092
2093
2094
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)
2095
2096


2097
2098
2099
def human_readable_int(value):
    """Parse human-readable integers like '1k', '2M', etc.
    Including decimal values with decimal multipliers.
2100

2101
2102
2103
2104
2105
2106
    Examples:
    - '1k' -> 1,000
    - '1K' -> 1,024
    - '25.6k' -> 25,600
    """
    value = value.strip()
2107
    match = re.fullmatch(r"(\d+(?:\.\d+)?)([kKmMgGtT])", value)
2108
2109
    if match:
        decimal_multiplier = {
2110
2111
2112
            "k": 10**3,
            "m": 10**6,
            "g": 10**9,
2113
2114
        }
        binary_multiplier = {
2115
2116
2117
            "K": 2**10,
            "M": 2**20,
            "G": 2**30,
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
        }

        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:
2130
2131
2132
2133
2134
                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
2135
2136
2137

    # Regular plain number.
    return int(value)