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

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

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

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

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

100
101
logger = init_logger(__name__)

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

107

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

117
118
119
    return _parse_type


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

126
    return _optional_type
127
128


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


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


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


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


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


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

    return type_hints


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


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


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

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

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

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

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

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

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


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

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

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


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

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

467
    ray_workers_use_nsight: bool = ParallelConfig.ray_workers_use_nsight
468
    num_gpu_blocks_override: int | None = CacheConfig.num_gpu_blocks_override
469
    num_lookahead_slots: int = SchedulerConfig.num_lookahead_slots
470
    model_loader_extra_config: dict = get_field(LoadConfig, "model_loader_extra_config")
471
    ignore_patterns: str | list[str] = get_field(LoadConfig, "ignore_patterns")
472

473
    enable_chunked_prefill: bool | None = SchedulerConfig.enable_chunked_prefill
474
    disable_chunked_mm_input: bool = SchedulerConfig.disable_chunked_mm_input
475

476
    disable_hybrid_kv_cache_manager: bool = (
477
478
        SchedulerConfig.disable_hybrid_kv_cache_manager
    )
479

480
    structured_outputs_config: StructuredOutputsConfig = get_field(
481
482
        VllmConfig, "structured_outputs_config"
    )
483
    reasoning_parser: str = StructuredOutputsConfig.reasoning_parser
484

485
    # Deprecated guided decoding fields
486
487
488
489
    guided_decoding_backend: str | None = None
    guided_decoding_disable_fallback: bool | None = None
    guided_decoding_disable_any_whitespace: bool | None = None
    guided_decoding_disable_additional_properties: bool | None = None
490

491
    logits_processor_pattern: str | None = ModelConfig.logits_processor_pattern
492

493
    speculative_config: dict[str, Any] | None = None
494

495
    show_hidden_metrics_for_version: str | None = (
496
        ObservabilityConfig.show_hidden_metrics_for_version
497
    )
498
499
    otlp_traces_endpoint: str | None = ObservabilityConfig.otlp_traces_endpoint
    collect_detailed_traces: list[DetailedTraceModules] | None = (
500
        ObservabilityConfig.collect_detailed_traces
501
    )
502
    scheduling_policy: SchedulerPolicy = SchedulerConfig.policy
503
    scheduler_cls: str | type[object] = SchedulerConfig.scheduler_cls
504

505
506
    pooler_config: PoolerConfig | None = ModelConfig.pooler_config
    override_pooler_config: dict | PoolerConfig | None = (
507
        ModelConfig.override_pooler_config
508
509
    )
    compilation_config: CompilationConfig = get_field(VllmConfig, "compilation_config")
510
511
    worker_cls: str = ParallelConfig.worker_cls
    worker_extension_cls: str = ParallelConfig.worker_extension_cls
512

513
514
    kv_transfer_config: KVTransferConfig | None = None
    kv_events_config: KVEventsConfig | None = None
515

516
517
    generation_config: str = ModelConfig.generation_config
    enable_sleep_mode: bool = ModelConfig.enable_sleep_mode
518
519
520
    override_generation_config: dict[str, Any] = get_field(
        ModelConfig, "override_generation_config"
    )
521
    model_impl: str = ModelConfig.model_impl
522
    override_attention_dtype: str = ModelConfig.override_attention_dtype
523

524
    calculate_kv_scales: bool = CacheConfig.calculate_kv_scales
525
526
    mamba_cache_dtype: MambaDType = CacheConfig.mamba_cache_dtype
    mamba_ssm_cache_dtype: MambaDType = CacheConfig.mamba_ssm_cache_dtype
527

528
    additional_config: dict[str, Any] = get_field(VllmConfig, "additional_config")
529

530
    use_tqdm_on_load: bool = LoadConfig.use_tqdm_on_load
531
    pt_load_map_location: str = LoadConfig.pt_load_map_location
532

533
534
    # DEPRECATED
    enable_multimodal_encoder_data_parallel: bool = False
535

536
    logits_processors: list[str | type[LogitsProcessor]] | None = (
537
538
        ModelConfig.logits_processors
    )
539
540
    """Custom logitproc types"""

541
542
    async_scheduling: bool = SchedulerConfig.async_scheduling

543
    kv_sharing_fast_prefill: bool = CacheConfig.kv_sharing_fast_prefill
544

545
    def __post_init__(self):
546
547
548
        # support `EngineArgs(compilation_config={...})`
        # without having to manually construct a
        # CompilationConfig object
549
        if isinstance(self.compilation_config, dict):
550
            self.compilation_config = CompilationConfig(**self.compilation_config)
551
        if isinstance(self.eplb_config, dict):
552
            self.eplb_config = EPLBConfig(**self.eplb_config)
553
        # Setup plugins
554
        from vllm.plugins import load_general_plugins
555

556
        load_general_plugins()
557
558
559
560
561
        # 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(
562
563
564
565
                "HF_HUB_OFFLINE is True, replace model_id [%s] to model_path [%s]",
                model_id,
                self.model,
            )
566
567

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

571
        # Model arguments
572
573
574
575
576
        model_kwargs = get_kwargs(ModelConfig)
        model_group = parser.add_argument_group(
            title="ModelConfig",
            description=ModelConfig.__doc__,
        )
577
        if not ("serve" in sys.argv[1:] and "--help" in sys.argv[1:]):
578
            model_group.add_argument("--model", **model_kwargs["model"])
579
580
        model_group.add_argument("--runner", **model_kwargs["runner"])
        model_group.add_argument("--convert", **model_kwargs["convert"])
581
        model_group.add_argument("--task", **model_kwargs["task"], deprecated=True)
582
        model_group.add_argument("--tokenizer", **model_kwargs["tokenizer"])
583
584
585
586
        model_group.add_argument("--tokenizer-mode", **model_kwargs["tokenizer_mode"])
        model_group.add_argument(
            "--trust-remote-code", **model_kwargs["trust_remote_code"]
        )
587
588
        model_group.add_argument("--dtype", **model_kwargs["dtype"])
        model_group.add_argument("--seed", **model_kwargs["seed"])
589
590
591
592
593
594
595
        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"]
        )
596
        model_group.add_argument("--revision", **model_kwargs["revision"])
597
598
        model_group.add_argument("--code-revision", **model_kwargs["code_revision"])
        model_group.add_argument("--rope-scaling", **model_kwargs["rope_scaling"])
599
        model_group.add_argument("--rope-theta", **model_kwargs["rope_theta"])
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
        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"])
624
625
        # This one is a special case because it can bool
        # or str. TODO: Handle this in get_kwargs
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
        model_group.add_argument(
            "--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"]
        )
653
        model_group.add_argument("--model-impl", **model_kwargs["model_impl"])
654
655
656
657
658
659
660
661
662
        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"]
        )
663

664
665
666
667
668
669
        # Model loading arguments
        load_kwargs = get_kwargs(LoadConfig)
        load_group = parser.add_argument_group(
            title="LoadConfig",
            description=LoadConfig.__doc__,
        )
670
        load_group.add_argument("--load-format", **load_kwargs["load_format"])
671
672
673
674
675
676
677
678
679
680
681
682
        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"]
        )
683

684
685
686
687
688
        # Structured outputs arguments
        structured_outputs_kwargs = get_kwargs(StructuredOutputsConfig)
        structured_outputs_group = parser.add_argument_group(
            title="StructuredOutputsConfig",
            description=StructuredOutputsConfig.__doc__,
689
        )
690
        structured_outputs_group.add_argument(
691
            "--reasoning-parser",
692
            # This choice is a special case because it's not static
693
            choices=list(ReasoningParserManager.reasoning_parsers),
694
695
            **structured_outputs_kwargs["reasoning_parser"],
        )
696
697
698
699
700
701
702
703
704
705
706
        # Deprecated guided decoding arguments
        for arg, type in [
            ("--guided-decoding-backend", str),
            ("--guided-decoding-disable-fallback", bool),
            ("--guided-decoding-disable-any-whitespace", bool),
            ("--guided-decoding-disable-additional-properties", bool),
        ]:
            structured_outputs_group.add_argument(
                arg,
                type=type,
                help=(f"[DEPRECATED] {arg} will be removed in v0.12.0."),
707
708
                deprecated=True,
            )
709

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

827
        parallel_group.add_argument(
828
            "--max-parallel-loading-workers",
829
830
            **parallel_kwargs["max_parallel_loading_workers"],
        )
831
        parallel_group.add_argument(
832
833
            "--ray-workers-use-nsight", **parallel_kwargs["ray_workers_use_nsight"]
        )
834
        parallel_group.add_argument(
835
            "--disable-custom-all-reduce",
836
837
838
839
840
841
            **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"]
        )
842
843
        parallel_group.add_argument(
            "--enable-multimodal-encoder-data-parallel",
844
            action="store_true",
845
846
            deprecated=True,
        )
847

848
849
850
851
852
        # KV cache arguments
        cache_kwargs = get_kwargs(CacheConfig)
        cache_group = parser.add_argument_group(
            title="CacheConfig",
            description=CacheConfig.__doc__,
853
        )
854
        cache_group.add_argument("--block-size", **cache_kwargs["block_size"])
855
856
857
858
859
860
        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"]
        )
861
        cache_group.add_argument("--swap-space", **cache_kwargs["swap_space"])
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
        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"]
        )
885

886
        # Multimodal related configs
887
888
889
890
891
        multimodal_kwargs = get_kwargs(MultiModalConfig)
        multimodal_group = parser.add_argument_group(
            title="MultiModalConfig",
            description=MultiModalConfig.__doc__,
        )
892
        multimodal_group.add_argument(
893
894
895
896
897
898
899
900
901
902
903
            "--limit-mm-per-prompt", **multimodal_kwargs["limit_per_prompt"]
        )
        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"]
        )
904
        multimodal_group.add_argument(
905
906
            "--disable-mm-preprocessor-cache", action="store_true", deprecated=True
        )
907
        multimodal_group.add_argument(
908
909
            "--mm-processor-cache-type", **multimodal_kwargs["mm_processor_cache_type"]
        )
910
911
        multimodal_group.add_argument(
            "--mm-shm-cache-max-object-size-mb",
912
913
            **multimodal_kwargs["mm_shm_cache_max_object_size_mb"],
        )
914
        multimodal_group.add_argument(
915
916
917
918
919
            "--mm-encoder-tp-mode", **multimodal_kwargs["mm_encoder_tp_mode"]
        )
        multimodal_group.add_argument(
            "--interleave-mm-strings", **multimodal_kwargs["interleave_mm_strings"]
        )
920
        multimodal_group.add_argument(
921
922
            "--skip-mm-profiling", **multimodal_kwargs["skip_mm_profiling"]
        )
923

924
        multimodal_group.add_argument(
925
926
            "--video-pruning-rate", **multimodal_kwargs["video_pruning_rate"]
        )
927

928
        # LoRA related configs
929
930
931
932
933
934
        lora_kwargs = get_kwargs(LoRAConfig)
        lora_group = parser.add_argument_group(
            title="LoRAConfig",
            description=LoRAConfig.__doc__,
        )
        lora_group.add_argument(
935
            "--enable-lora",
936
            action=argparse.BooleanOptionalAction,
937
938
            help="If True, enable handling of LoRA adapters.",
        )
939
        lora_group.add_argument("--max-loras", **lora_kwargs["max_loras"])
940
941
942
943
        lora_group.add_argument("--max-lora-rank", **lora_kwargs["max_lora_rank"])
        lora_group.add_argument(
            "--lora-extra-vocab-size", **lora_kwargs["lora_extra_vocab_size"]
        )
944
        lora_group.add_argument(
945
            "--lora-dtype",
946
947
            **lora_kwargs["lora_dtype"],
        )
948
949
950
951
952
        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"])
953

954
955
956
957
958
959
960
961
        # 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",
962
963
            **observability_kwargs["show_hidden_metrics_for_version"],
        )
964
        observability_group.add_argument(
965
966
            "--otlp-traces-endpoint", **observability_kwargs["otlp_traces_endpoint"]
        )
967
968
969
970
971
        # 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"] += [
972
            ",".join(p) for p in permutations(get_args(DetailedTraceModules), r=2)
973
974
975
        ]
        observability_group.add_argument(
            "--collect-detailed-traces",
976
977
            **observability_kwargs["collect_detailed_traces"],
        )
978

979
980
981
982
983
984
985
        # Scheduler arguments
        scheduler_kwargs = get_kwargs(SchedulerConfig)
        scheduler_group = parser.add_argument_group(
            title="SchedulerConfig",
            description=SchedulerConfig.__doc__,
        )
        scheduler_group.add_argument(
986
987
            "--max-num-batched-tokens", **scheduler_kwargs["max_num_batched_tokens"]
        )
988
        scheduler_group.add_argument(
989
990
991
992
993
            "--max-num-seqs", **scheduler_kwargs["max_num_seqs"]
        )
        scheduler_group.add_argument(
            "--max-num-partial-prefills", **scheduler_kwargs["max_num_partial_prefills"]
        )
994
995
        scheduler_group.add_argument(
            "--max-long-partial-prefills",
996
997
998
999
1000
            **scheduler_kwargs["max_long_partial_prefills"],
        )
        scheduler_group.add_argument(
            "--cuda-graph-sizes", **scheduler_kwargs["cuda_graph_sizes"]
        )
1001
1002
        scheduler_group.add_argument(
            "--long-prefill-token-threshold",
1003
1004
1005
1006
1007
            **scheduler_kwargs["long_prefill_token_threshold"],
        )
        scheduler_group.add_argument(
            "--num-lookahead-slots", **scheduler_kwargs["num_lookahead_slots"]
        )
1008
1009
        # multi-step scheduling has been removed; corresponding arguments
        # are no longer supported.
1010
        scheduler_group.add_argument(
1011
1012
            "--scheduling-policy", **scheduler_kwargs["policy"]
        )
1013
        scheduler_group.add_argument(
1014
1015
1016
1017
1018
1019
1020
1021
            "--enable-chunked-prefill", **scheduler_kwargs["enable_chunked_prefill"]
        )
        scheduler_group.add_argument(
            "--disable-chunked-mm-input", **scheduler_kwargs["disable_chunked_mm_input"]
        )
        scheduler_group.add_argument(
            "--scheduler-cls", **scheduler_kwargs["scheduler_cls"]
        )
1022
1023
        scheduler_group.add_argument(
            "--disable-hybrid-kv-cache-manager",
1024
1025
1026
1027
1028
            **scheduler_kwargs["disable_hybrid_kv_cache_manager"],
        )
        scheduler_group.add_argument(
            "--async-scheduling", **scheduler_kwargs["async_scheduling"]
        )
1029
1030

        # vLLM arguments
1031
        vllm_kwargs = get_kwargs(VllmConfig)
1032
1033
1034
1035
        vllm_group = parser.add_argument_group(
            title="VllmConfig",
            description=VllmConfig.__doc__,
        )
1036
1037
1038
1039
        # 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)
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
        vllm_group.add_argument(
            "--speculative-config", **vllm_kwargs["speculative_config"]
        )
        vllm_group.add_argument(
            "--kv-transfer-config", **vllm_kwargs["kv_transfer_config"]
        )
        vllm_group.add_argument("--kv-events-config", **vllm_kwargs["kv_events_config"])
        vllm_group.add_argument(
            "--compilation-config", "-O", **vllm_kwargs["compilation_config"]
        )
        vllm_group.add_argument(
            "--additional-config", **vllm_kwargs["additional_config"]
        )
        vllm_group.add_argument(
            "--structured-outputs-config", **vllm_kwargs["structured_outputs_config"]
        )
1056

1057
        # Other arguments
1058
1059
1060
1061
1062
        parser.add_argument(
            "--disable-log-stats",
            action="store_true",
            help="Disable logging statistics.",
        )
1063

1064
1065
1066
1067
1068
1069
        parser.add_argument(
            "--aggregate-engine-logging",
            action="store_true",
            help="Log aggregate rather than per-engine statistics "
            "when using data parallelism.",
        )
1070
        return parser
1071
1072

    @classmethod
1073
    def from_cli_args(cls, args: argparse.Namespace):
1074
1075
1076
        # Get the list of attributes of this dataclass.
        attrs = [attr.name for attr in dataclasses.fields(cls)]
        # Set the attributes from the parsed arguments.
1077
1078
1079
        engine_args = cls(
            **{attr: getattr(args, attr) for attr in attrs if hasattr(args, attr)}
        )
Zhuohan Li's avatar
Zhuohan Li committed
1080
        return engine_args
1081

1082
    def create_model_config(self) -> ModelConfig:
1083
1084
1085
1086
1087
        # gguf file needs a specific model loader and doesn't use hf_repo
        if check_gguf_file(self.model):
            self.quantization = self.load_format = "gguf"

        # NOTE: This is to allow model loading from S3 in CI
1088
1089
1090
1091
1092
1093
        if (
            not isinstance(self, AsyncEngineArgs)
            and envs.VLLM_CI_USE_S3
            and self.model in MODELS_ON_S3
            and self.load_format == "auto"
        ):
1094
1095
            self.model = f"{MODEL_WEIGHTS_S3_BUCKET}/{self.model}"

1096
1097
1098
1099
        if self.disable_mm_preprocessor_cache:
            logger.warning(
                "`--disable-mm-preprocessor-cache` is deprecated "
                "and will be removed in v0.13. "
1100
1101
                "Please use `--mm-processor-cache-gb 0` instead.",
            )
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113

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

            self.mm_processor_cache_gb = envs.VLLM_MM_INPUT_CACHE_GIB

1114
1115
1116
1117
        if self.enable_multimodal_encoder_data_parallel:
            logger.warning(
                "--enable-multimodal-encoder-data-parallel` is deprecated "
                "and will be removed in v0.13. "
1118
1119
                "Please use `--mm-encoder-tp-mode data` instead."
            )
1120
1121
1122

            self.mm_encoder_tp_mode = "data"

1123
        return ModelConfig(
1124
            model=self.model,
1125
            hf_config_path=self.hf_config_path,
1126
1127
            runner=self.runner,
            convert=self.convert,
1128
            task=self.task,
1129
            tokenizer=self.tokenizer,
1130
1131
            tokenizer_mode=self.tokenizer_mode,
            trust_remote_code=self.trust_remote_code,
1132
            allowed_local_media_path=self.allowed_local_media_path,
1133
            allowed_media_domains=self.allowed_media_domains,
1134
1135
1136
1137
1138
            dtype=self.dtype,
            seed=self.seed,
            revision=self.revision,
            code_revision=self.code_revision,
            rope_scaling=self.rope_scaling,
1139
            rope_theta=self.rope_theta,
1140
            hf_token=self.hf_token,
1141
            hf_overrides=self.hf_overrides,
1142
1143
1144
1145
1146
            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,
1147
            logprobs_mode=self.logprobs_mode,
1148
            disable_sliding_window=self.disable_sliding_window,
1149
            disable_cascade_attn=self.disable_cascade_attn,
1150
            skip_tokenizer_init=self.skip_tokenizer_init,
1151
            enable_prompt_embeds=self.enable_prompt_embeds,
1152
            served_model_name=self.served_model_name,
1153
            limit_mm_per_prompt=self.limit_mm_per_prompt,
1154
            interleave_mm_strings=self.interleave_mm_strings,
1155
            media_io_kwargs=self.media_io_kwargs,
1156
            skip_mm_profiling=self.skip_mm_profiling,
1157
            config_format=self.config_format,
1158
            mm_processor_kwargs=self.mm_processor_kwargs,
1159
            mm_processor_cache_gb=self.mm_processor_cache_gb,
1160
            mm_processor_cache_type=self.mm_processor_cache_type,
1161
            mm_shm_cache_max_object_size_mb=self.mm_shm_cache_max_object_size_mb,
1162
            mm_encoder_tp_mode=self.mm_encoder_tp_mode,
1163
            pooler_config=self.pooler_config,
1164
            override_pooler_config=self.override_pooler_config,
1165
            logits_processor_pattern=self.logits_processor_pattern,
1166
            generation_config=self.generation_config,
1167
            override_generation_config=self.override_generation_config,
1168
            enable_sleep_mode=self.enable_sleep_mode,
1169
            model_impl=self.model_impl,
1170
            override_attention_dtype=self.override_attention_dtype,
1171
            logits_processors=self.logits_processors,
1172
            video_pruning_rate=self.video_pruning_rate,
1173
            io_processor_plugin=self.io_processor_plugin,
1174
        )
1175

1176
    def validate_tensorizer_args(self):
1177
1178
        from vllm.model_executor.model_loader.tensorizer import TensorizerConfig

1179
1180
        for key in self.model_loader_extra_config:
            if key in TensorizerConfig._fields:
1181
1182
1183
                self.model_loader_extra_config["tensorizer_config"][key] = (
                    self.model_loader_extra_config[key]
                )
1184

1185
    def create_load_config(self) -> LoadConfig:
1186
1187
        if self.quantization == "bitsandbytes":
            self.load_format = "bitsandbytes"
1188

1189
1190
1191
        if self.load_format == "tensorizer":
            if hasattr(self.model_loader_extra_config, "to_serializable"):
                self.model_loader_extra_config = (
1192
1193
                    self.model_loader_extra_config.to_serializable()
                )
1194
            self.model_loader_extra_config["tensorizer_config"] = {}
1195
1196
1197
            self.model_loader_extra_config["tensorizer_config"]["tensorizer_dir"] = (
                self.model
            )
1198
            self.validate_tensorizer_args()
1199

1200
1201
1202
        return LoadConfig(
            load_format=self.load_format,
            download_dir=self.download_dir,
1203
            safetensors_load_strategy=self.safetensors_load_strategy,
1204
            device="cpu" if is_online_quantization(self.quantization) else None,
1205
1206
            model_loader_extra_config=self.model_loader_extra_config,
            ignore_patterns=self.ignore_patterns,
1207
            use_tqdm_on_load=self.use_tqdm_on_load,
1208
            pt_load_map_location=self.pt_load_map_location,
1209
        )
1210

1211
1212
1213
1214
1215
1216
    def create_speculative_config(
        self,
        target_model_config: ModelConfig,
        target_parallel_config: ParallelConfig,
        enable_chunked_prefill: bool,
        disable_log_stats: bool,
1217
    ) -> SpeculativeConfig | None:
1218
1219
1220
1221
1222
1223
        """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
1224
        dictionary from the engine.
1225
1226
        """
        if self.speculative_config is None:
1227
            return None
1228

1229
1230
1231
        # Note(Shangming): These parameters are not obtained from the cli arg
        # '--speculative-config' and must be passed in when creating the engine
        # config.
1232
1233
1234
1235
1236
1237
1238
1239
        self.speculative_config.update(
            {
                "target_model_config": target_model_config,
                "target_parallel_config": target_parallel_config,
                "enable_chunked_prefill": enable_chunked_prefill,
                "disable_log_stats": disable_log_stats,
            }
        )
1240
        return SpeculativeConfig(**self.speculative_config)
1241

1242
1243
    def create_engine_config(
        self,
1244
        usage_context: UsageContext | None = None,
1245
        headless: bool = False,
1246
1247
1248
1249
1250
1251
1252
    ) -> VllmConfig:
        """
        Create the VllmConfig.

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

1254
1255
1256
1257
1258
1259
        This function set VLLM_USE_V1=X if VLLM_USE_V1 is
        unspecified by the user.

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

1262
        device_config = DeviceConfig(device=cast(Device, current_platform.device_type))
1263

1264
1265
1266
1267
        model_config = self.create_model_config()
        self.model = model_config.model
        self.tokenizer = model_config.tokenizer

1268
1269
1270
1271
1272
1273
1274
1275
1276
        (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,
            )
        )
1277

1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
        # * If VLLM_USE_V1 is unset, we enable V1 for "supported features"
        #   and fall back to V0 for experimental or unsupported features.
        # * If VLLM_USE_V1=1, we enable V1 for supported + experimental
        #   features and raise error for unsupported features.
        # * If VLLM_USE_V1=0, we disable V1.
        use_v1 = False
        try_v1 = envs.VLLM_USE_V1 or not envs.is_set("VLLM_USE_V1")
        if try_v1 and self._is_v1_supported_oracle(model_config):
            use_v1 = True

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

1295
1296
        # Set default arguments for V1 Engine.
        self._set_default_args(usage_context, model_config)
1297
1298
        # Disable chunked prefill and prefix caching for:
        # POWER (ppc64le)/ARM/s390x/RISCV CPUs in V1
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
        if current_platform.is_cpu() and current_platform.get_cpu_architecture() in (
            CpuArchEnum.POWERPC,
            CpuArchEnum.S390X,
            CpuArchEnum.ARM,
            CpuArchEnum.RISCV,
        ):
            logger.info(
                "Chunked prefill is not supported for ARM and POWER, "
                "S390X and RISC-V CPUs; "
                "disabling it for V1 backend."
            )
1310
            self.enable_chunked_prefill = False
1311
1312
1313
1314
1315
1316
1317
            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

1318
1319
        assert self.enable_chunked_prefill is not None

1320
        sliding_window: int | None = None
1321
1322
1323
1324
1325
1326
        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()

1327
1328
1329
        # 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
1330
        # reuses the GPUs of TP group, and split one TP group into
1331
        # tp_size//dcp_size DCP groups.
1332
        assert self.tensor_parallel_size % self.decode_context_parallel_size == 0, (
1333
1334
1335
1336
            f"tp_size={self.tensor_parallel_size} must be divisible by"
            f"dcp_size={self.decode_context_parallel_size}."
        )

1337
        cache_config = CacheConfig(
1338
            block_size=self.block_size,
1339
            gpu_memory_utilization=self.gpu_memory_utilization,
1340
            kv_cache_memory_bytes=self.kv_cache_memory_bytes,
1341
1342
            swap_space=self.swap_space,
            cache_dtype=self.kv_cache_dtype,
1343
            is_attention_free=model_config.is_attention_free,
1344
            num_gpu_blocks_override=self.num_gpu_blocks_override,
1345
            sliding_window=sliding_window,
1346
            enable_prefix_caching=self.enable_prefix_caching,
1347
            prefix_caching_hash_algo=self.prefix_caching_hash_algo,
1348
            cpu_offload_gb=self.cpu_offload_gb,
1349
            calculate_kv_scales=self.calculate_kv_scales,
1350
            kv_sharing_fast_prefill=self.kv_sharing_fast_prefill,
1351
1352
            mamba_cache_dtype=self.mamba_cache_dtype,
            mamba_ssm_cache_dtype=self.mamba_ssm_cache_dtype,
1353
        )
1354

1355
1356
1357
1358
1359
1360
        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
1361

1362
            ray_runtime_env = ray.get_runtime_context().runtime_env
1363
1364
1365
1366
1367
1368
1369
            # 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)
1370

1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
        # 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()

1382
        assert not headless or not self.data_parallel_hybrid_lb, (
1383
1384
            "data_parallel_hybrid_lb is not applicable in headless mode"
        )
1385

1386
        data_parallel_external_lb = self.data_parallel_rank is not None
1387
        # Local DP rank = 1, use pure-external LB.
1388
1389
        if data_parallel_external_lb:
            assert self.data_parallel_size_local in (1, None), (
1390
1391
                "data_parallel_size_local must be 1 when data_parallel_rank is set"
            )
1392
            data_parallel_size_local = 1
1393
1394
            # Use full external lb if we have local_size of 1.
            self.data_parallel_hybrid_lb = False
1395
1396
        elif self.data_parallel_size_local is not None:
            data_parallel_size_local = self.data_parallel_size_local
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411

            if self.data_parallel_start_rank and not headless:
                # Infer hybrid LB mode.
                self.data_parallel_hybrid_lb = True

            if self.data_parallel_hybrid_lb and data_parallel_size_local == 1:
                # Use full external lb if we have local_size of 1.
                data_parallel_external_lb = True
                self.data_parallel_hybrid_lb = False

            if data_parallel_size_local == self.data_parallel_size:
                # Disable hybrid LB mode if set for a single node
                self.data_parallel_hybrid_lb = False

            self.data_parallel_rank = self.data_parallel_start_rank or 0
1412
        else:
1413
            assert not self.data_parallel_hybrid_lb, (
1414
1415
                "data_parallel_size_local must be set to use data_parallel_hybrid_lb."
            )
1416

1417
1418
1419
1420
1421
1422
1423
1424
1425
            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
1426
1427
1428

        # DP address, used in multi-node case for torch distributed group
        # and ZMQ sockets.
Rui Qiao's avatar
Rui Qiao committed
1429
1430
1431
1432
        if self.data_parallel_address is None:
            if self.data_parallel_backend == "ray":
                host_ip = get_ip()
                logger.info(
1433
1434
                    "Using host IP %s as ray-based data parallel address", host_ip
                )
Rui Qiao's avatar
Rui Qiao committed
1435
1436
1437
1438
                data_parallel_address = host_ip
            else:
                assert self.data_parallel_backend == "mp", (
                    "data_parallel_backend can only be ray or mp, got %s",
1439
1440
                    self.data_parallel_backend,
                )
Rui Qiao's avatar
Rui Qiao committed
1441
1442
1443
                data_parallel_address = ParallelConfig.data_parallel_master_ip
        else:
            data_parallel_address = self.data_parallel_address
1444
1445
1446

        # This port is only used when there are remote data parallel engines,
        # otherwise the local IPC transport is used.
1447
        data_parallel_rpc_port = (
1448
            self.data_parallel_rpc_port
1449
1450
1451
            if (self.data_parallel_rpc_port is not None)
            else ParallelConfig.data_parallel_rpc_port
        )
1452

1453
1454
        if self.async_scheduling:
            if self.pipeline_parallel_size > 1:
1455
1456
1457
                raise ValueError(
                    "Async scheduling is not supported with pipeline-parallel-size > 1."
                )
1458
1459
1460
1461
1462
1463

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

1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
        # 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

1477
        parallel_config = ParallelConfig(
1478
1479
            pipeline_parallel_size=self.pipeline_parallel_size,
            tensor_parallel_size=self.tensor_parallel_size,
1480
            data_parallel_size=self.data_parallel_size,
1481
1482
            data_parallel_rank=self.data_parallel_rank or 0,
            data_parallel_external_lb=data_parallel_external_lb,
1483
1484
1485
            data_parallel_size_local=data_parallel_size_local,
            data_parallel_master_ip=data_parallel_address,
            data_parallel_rpc_port=data_parallel_rpc_port,
1486
            data_parallel_backend=self.data_parallel_backend,
1487
            data_parallel_hybrid_lb=self.data_parallel_hybrid_lb,
1488
            enable_expert_parallel=self.enable_expert_parallel,
1489
            all2all_backend=self.all2all_backend,
1490
1491
            enable_dbo=self.enable_dbo,
            dbo_decode_token_threshold=self.dbo_decode_token_threshold,
1492
            dbo_prefill_token_threshold=self.dbo_prefill_token_threshold,
1493
            disable_nccl_for_dp_synchronization=self.disable_nccl_for_dp_synchronization,
1494
            enable_eplb=self.enable_eplb,
1495
            eplb_config=self.eplb_config,
1496
            expert_placement_strategy=self.expert_placement_strategy,
1497
1498
1499
            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,
1500
            ray_runtime_env=ray_runtime_env,
1501
            placement_group=placement_group,
1502
1503
            distributed_executor_backend=self.distributed_executor_backend,
            worker_cls=self.worker_cls,
1504
            worker_extension_cls=self.worker_extension_cls,
1505
            decode_context_parallel_size=self.decode_context_parallel_size,
1506
1507
            _api_process_count=self._api_process_count,
            _api_process_rank=self._api_process_rank,
1508
        )
1509

1510
1511
1512
1513
1514
1515
1516
1517
1518
        if self.async_scheduling and (
            parallel_config.distributed_executor_backend not in ("mp", "uni")
        ):
            raise ValueError(
                "Currently, async scheduling only supports `mp` or `uni` "
                "distributed executor backend, but you choose "
                f"`{parallel_config.distributed_executor_backend}`."
            )

1519
        speculative_config = self.create_speculative_config(
1520
1521
            target_model_config=model_config,
            target_parallel_config=parallel_config,
1522
            enable_chunked_prefill=self.enable_chunked_prefill,
1523
            disable_log_stats=self.disable_log_stats,
1524
1525
        )

1526
1527
1528
1529
1530
        # make sure num_lookahead_slots is set appropriately depending on
        # whether speculative decoding is enabled
        num_lookahead_slots = self.num_lookahead_slots
        if speculative_config is not None:
            num_lookahead_slots = speculative_config.num_lookahead_slots
1531

1532
        scheduler_config = SchedulerConfig(
1533
            runner_type=model_config.runner_type,
1534
1535
1536
            max_num_batched_tokens=self.max_num_batched_tokens,
            max_num_seqs=self.max_num_seqs,
            max_model_len=model_config.max_model_len,
1537
            cuda_graph_sizes=self.cuda_graph_sizes,
1538
            num_lookahead_slots=num_lookahead_slots,
1539
            enable_chunked_prefill=self.enable_chunked_prefill,
1540
            disable_chunked_mm_input=self.disable_chunked_mm_input,
1541
            is_multimodal_model=model_config.is_multimodal_model,
1542
            is_encoder_decoder=model_config.is_encoder_decoder,
1543
            send_delta_data=(envs.VLLM_USE_RAY_SPMD_WORKER and parallel_config.use_ray),
1544
            policy=self.scheduling_policy,
1545
            scheduler_cls=self.scheduler_cls,
1546
1547
1548
            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,
1549
            disable_hybrid_kv_cache_manager=self.disable_hybrid_kv_cache_manager,
1550
            async_scheduling=self.async_scheduling,
1551
        )
1552

1553
1554
1555
        if not model_config.is_multimodal_model and self.default_mm_loras:
            raise ValueError(
                "Default modality-specific LoRA(s) were provided for a "
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
                "non multimodal model"
            )

        lora_config = (
            LoRAConfig(
                max_lora_rank=self.max_lora_rank,
                max_loras=self.max_loras,
                default_mm_loras=self.default_mm_loras,
                fully_sharded_loras=self.fully_sharded_loras,
                lora_extra_vocab_size=self.lora_extra_vocab_size,
                lora_dtype=self.lora_dtype,
                max_cpu_loras=self.max_cpu_loras
                if self.max_cpu_loras and self.max_cpu_loras > 0
                else None,
            )
            if self.enable_lora
            else None
        )
1574

1575
1576
1577
1578
        # bitsandbytes pre-quantized model need a specific model loader
        if model_config.quantization == "bitsandbytes":
            self.quantization = self.load_format = "bitsandbytes"

1579
        load_config = self.create_load_config()
1580

1581
1582
        # Pass reasoning_parser into StructuredOutputsConfig
        if self.reasoning_parser:
1583
            self.structured_outputs_config.reasoning_parser = self.reasoning_parser
1584
1585
1586
1587

        # Forward the deprecated CLI args to the StructuredOutputsConfig
        so_config = self.structured_outputs_config
        if self.guided_decoding_backend is not None:
1588
            so_config.guided_decoding_backend = self.guided_decoding_backend
1589
        if self.guided_decoding_disable_fallback is not None:
1590
1591
1592
            so_config.guided_decoding_disable_fallback = (
                self.guided_decoding_disable_fallback
            )
1593
        if self.guided_decoding_disable_any_whitespace is not None:
1594
1595
1596
            so_config.guided_decoding_disable_any_whitespace = (
                self.guided_decoding_disable_any_whitespace
            )
1597
        if self.guided_decoding_disable_additional_properties is not None:
1598
1599
1600
            so_config.guided_decoding_disable_additional_properties = (
                self.guided_decoding_disable_additional_properties
            )
1601

1602
        observability_config = ObservabilityConfig(
1603
            show_hidden_metrics_for_version=(self.show_hidden_metrics_for_version),
1604
            otlp_traces_endpoint=self.otlp_traces_endpoint,
1605
            collect_detailed_traces=self.collect_detailed_traces,
1606
        )
1607

1608
        config = VllmConfig(
1609
1610
1611
1612
1613
1614
1615
1616
            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,
1617
            structured_outputs_config=self.structured_outputs_config,
1618
            observability_config=observability_config,
1619
            compilation_config=self.compilation_config,
1620
            kv_transfer_config=self.kv_transfer_config,
1621
            kv_events_config=self.kv_events_config,
1622
            additional_config=self.additional_config,
1623
        )
1624

1625
1626
        return config

1627
1628
1629
1630
1631
1632
    def _is_v1_supported_oracle(self, model_config: ModelConfig) -> bool:
        """Oracle for whether to use V0 or V1 Engine by default."""

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

1633
1634
1635
1636
        if self.logits_processor_pattern != EngineArgs.logits_processor_pattern:
            _raise_or_fallback(
                feature_name="--logits-processor-pattern", recommend_to_remove=False
            )
1637
1638
1639
            return False

        # No Concurrent Partial Prefills so far.
1640
1641
1642
1643
1644
1645
1646
1647
        if (
            self.max_num_partial_prefills != SchedulerConfig.max_num_partial_prefills
            or self.max_long_partial_prefills
            != SchedulerConfig.max_long_partial_prefills
        ):
            _raise_or_fallback(
                feature_name="Concurrent Partial Prefill", recommend_to_remove=False
            )
1648
1649
            return False

1650
        # V1 supports N-gram, Medusa, and Eagle speculative decoding.
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
        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 "
1662
1663
                    "such as ngram, medusa, eagle, or mtp."
                )
1664
1665

        V1_BACKENDS = [
1666
1667
            "FLASH_ATTN",
            "PALLAS",
1668
            "TRITON_ATTN",
1669
            "TRITON_MLA",
1670
            "CUTLASS_MLA",
1671
            "FLASHMLA",
1672
            "FLASH_ATTN_MLA",
1673
            "FLASHINFER",
1674
            "FLASHINFER_MLA",
1675
            "ROCM_AITER_MLA",
1676
            "TORCH_SDPA",
1677
            "FLEX_ATTENTION",
1678
            "TREE_ATTN",
1679
1680
            "XFORMERS",
            "ROCM_ATTN",
1681
            "ROCM_AITER_UNIFIED_ATTN",
1682
        ]
1683
1684
1685
1686
        if (
            envs.is_set("VLLM_ATTENTION_BACKEND")
            and envs.VLLM_ATTENTION_BACKEND not in V1_BACKENDS
        ):
1687
1688
1689
1690
1691
1692
1693
            name = f"VLLM_ATTENTION_BACKEND={envs.VLLM_ATTENTION_BACKEND}"
            _raise_or_fallback(feature_name=name, recommend_to_remove=True)
            return False

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

1694
        if self.pipeline_parallel_size > 1:
1695
1696
1697
            supports_pp = getattr(
                self.distributed_executor_backend, "supports_pp", False
            )
1698
            if not supports_pp and self.distributed_executor_backend not in (
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
                ParallelConfig.distributed_executor_backend,
                "ray",
                "mp",
                "external_launcher",
            ):
                name = (
                    "Pipeline Parallelism without Ray distributed "
                    "executor or multiprocessing executor or external "
                    "launcher"
                )
                _raise_or_fallback(feature_name=name, recommend_to_remove=False)
1710
                return False
1711

1712
1713
1714
1715
        if current_platform.is_cpu() and model_config.get_sliding_window() is not None:
            _raise_or_fallback(
                feature_name="sliding window (CPU backend)", recommend_to_remove=False
            )
1716
1717
            return False

1718
1719
1720
1721
        #############################################################

        return True

1722
1723
1724
    def _set_default_args(
        self, usage_context: UsageContext, model_config: ModelConfig
    ) -> None:
1725
        """Set Default Arguments for V1 Engine."""
1726

1727
        # V1 uses chunked prefills and prefix caching by default
1728
1729
1730
1731
        # for non-pooling tasks.
        # For pooling tasks the default is False
        if model_config.runner_type != "pooling":
            self.enable_chunked_prefill = True
1732
1733
1734

            # TODO: When prefix caching supports prompt embeds inputs, this
            # check can be removed.
1735
            if self.enable_prompt_embeds and self.enable_prefix_caching is not False:
1736
1737
1738
                logger.warning(
                    "--enable-prompt-embeds and --enable-prefix-caching "
                    "are not supported together in V1. Prefix caching has "
1739
1740
                    "been disabled."
                )
1741
1742
                self.enable_prefix_caching = False

1743
            if self.enable_prefix_caching is None:
1744
1745
1746
1747
1748
1749
                # Disable prefix caching default for hybrid models
                # since the feature is still experimental.
                if model_config.is_hybrid:
                    self.enable_prefix_caching = False
                else:
                    self.enable_prefix_caching = True
1750
1751
        else:
            pooling_type = model_config.pooler_config.pooling_type
1752
            is_causal = getattr(model_config.hf_config, "is_causal", True)
1753
1754
1755
1756
1757
            incremental_prefill_supported = (
                pooling_type is not None
                and pooling_type.lower() == "last"
                and is_causal
            )
1758

1759
            action = "Enabling" if incremental_prefill_supported else "Disabling"
1760
1761
1762
1763
1764
1765
1766
1767

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

1768
1769
        # When no user override, set the default values based on the usage
        # context.
1770
        # Use different default values for different hardware.
1771
1772
1773
1774
1775
1776
1777

        # 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:
1778
            device_memory = current_platform.get_device_total_memory()
1779
            device_name = current_platform.get_device_name().lower()
1780
1781
        except Exception:
            # This is only used to set default_max_num_batched_tokens
1782
            device_memory = 0
1783

1784
1785
1786
        # 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.
1787
        from vllm.usage.usage_lib import UsageContext
1788

1789
        if device_memory >= 70 * GiB_bytes and "a100" not in device_name:
1790
            # For GPUs like H100 and MI300x, use larger default values.
1791
1792
1793
1794
            default_max_num_batched_tokens = {
                UsageContext.LLM_CLASS: 16384,
                UsageContext.OPENAI_API_SERVER: 8192,
            }
1795
1796
1797
1798
            default_max_num_seqs = {
                UsageContext.LLM_CLASS: 1024,
                UsageContext.OPENAI_API_SERVER: 1024,
            }
1799
1800
1801
1802
1803
1804
        else:
            # TODO(woosuk): Tune the default values for other hardware.
            default_max_num_batched_tokens = {
                UsageContext.LLM_CLASS: 8192,
                UsageContext.OPENAI_API_SERVER: 2048,
            }
1805
1806
1807
1808
            default_max_num_seqs = {
                UsageContext.LLM_CLASS: 256,
                UsageContext.OPENAI_API_SERVER: 256,
            }
1809

1810
1811
1812
1813
        # tpu specific default values.
        if current_platform.is_tpu():
            default_max_num_batched_tokens_tpu = {
                UsageContext.LLM_CLASS: {
1814
1815
1816
                    "V6E": 2048,
                    "V5E": 1024,
                    "V5P": 512,
1817
1818
                },
                UsageContext.OPENAI_API_SERVER: {
1819
1820
1821
1822
                    "V6E": 1024,
                    "V5E": 512,
                    "V5P": 256,
                },
1823
1824
            }

1825
1826
        # cpu specific default values.
        if current_platform.is_cpu():
1827
            world_size = self.pipeline_parallel_size * self.tensor_parallel_size
1828
            default_max_num_batched_tokens = {
1829
1830
                UsageContext.LLM_CLASS: 4096 * world_size,
                UsageContext.OPENAI_API_SERVER: 2048 * world_size,
1831
1832
            }
            default_max_num_seqs = {
1833
1834
                UsageContext.LLM_CLASS: 256 * world_size,
                UsageContext.OPENAI_API_SERVER: 128 * world_size,
1835
1836
            }

1837
        use_context_value = usage_context.value if usage_context else None
1838
1839
1840
1841
        if (
            self.max_num_batched_tokens is None
            and usage_context in default_max_num_batched_tokens
        ):
1842
1843
            if current_platform.is_tpu():
                chip_name = current_platform.get_device_name()
1844
1845
1846
1847
                if chip_name in default_max_num_batched_tokens_tpu[usage_context]:
                    self.max_num_batched_tokens = default_max_num_batched_tokens_tpu[
                        usage_context
                    ][chip_name]
1848
                else:
1849
1850
1851
                    self.max_num_batched_tokens = default_max_num_batched_tokens[
                        usage_context
                    ]
1852
            else:
1853
1854
1855
                if not self.enable_chunked_prefill:
                    self.max_num_batched_tokens = model_config.max_model_len
                else:
1856
1857
1858
                    self.max_num_batched_tokens = default_max_num_batched_tokens[
                        usage_context
                    ]
1859
            logger.debug(
1860
                "Setting max_num_batched_tokens to %d for %s usage context.",
1861
1862
1863
                self.max_num_batched_tokens,
                use_context_value,
            )
1864

1865
1866
1867
1868
1869
        if self.max_num_seqs is None and usage_context in default_max_num_seqs:
            self.max_num_seqs = min(
                default_max_num_seqs[usage_context],
                self.max_num_batched_tokens or sys.maxsize,
            )
1870

1871
1872
1873
1874
1875
            logger.debug(
                "Setting max_num_seqs to %d for %s usage context.",
                self.max_num_seqs,
                use_context_value,
            )
1876

1877

1878
@dataclass
Zhuohan Li's avatar
Zhuohan Li committed
1879
class AsyncEngineArgs(EngineArgs):
Woosuk Kwon's avatar
Woosuk Kwon committed
1880
    """Arguments for asynchronous vLLM engine."""
1881

1882
1883
1884
1885
1886
1887
    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 "
1888
1889
        "`enable_log_requests` instead."
    )
1890
1891
1892
1893
1894
1895
1896
    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 "
1897
1898
        "`enable_log_requests` instead."
    )
1899
1900
    def disable_log_requests(self, value: bool):
        self.enable_log_requests = not value
1901
1902

    @staticmethod
1903
1904
1905
    def add_cli_args(
        parser: FlexibleArgumentParser, async_args_only: bool = False
    ) -> FlexibleArgumentParser:
1906
        # Initialize plugin to update the parser, for example, The plugin may
1907
        # add a new kind of quantization method to --quantization argument or
1908
1909
        # a new device to --device argument.
        load_general_plugins()
1910
1911
        if not async_args_only:
            parser = EngineArgs.add_cli_args(parser)
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
        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,
        )
1925
        current_platform.pre_register_and_update(parser)
1926
        return parser
1927
1928


1929
1930
1931
def _raise_or_fallback(feature_name: str, recommend_to_remove: bool):
    if envs.is_set("VLLM_USE_V1") and envs.VLLM_USE_V1:
        raise NotImplementedError(
1932
1933
            f"VLLM_USE_V1=1 is not supported with {feature_name}."
        )
1934
1935
1936
1937
1938
1939
1940
1941
    msg = f"{feature_name} is not supported by the V1 Engine. "
    msg += "Falling back to V0. "
    if recommend_to_remove:
        msg += f"We recommend to remove {feature_name} from your config "
        msg += "in favor of the V1 Engine."
    logger.warning(msg)


1942
1943
1944
def human_readable_int(value):
    """Parse human-readable integers like '1k', '2M', etc.
    Including decimal values with decimal multipliers.
1945

1946
1947
1948
1949
1950
1951
    Examples:
    - '1k' -> 1,000
    - '1K' -> 1,024
    - '25.6k' -> 25,600
    """
    value = value.strip()
1952
    match = re.fullmatch(r"(\d+(?:\.\d+)?)([kKmMgGtT])", value)
1953
1954
    if match:
        decimal_multiplier = {
1955
1956
1957
            "k": 10**3,
            "m": 10**6,
            "g": 10**9,
1958
1959
        }
        binary_multiplier = {
1960
1961
1962
            "K": 2**10,
            "M": 2**20,
            "G": 2**30,
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
        }

        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:
1975
1976
1977
1978
1979
                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
1980
1981
1982

    # Regular plain number.
    return int(value)