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
85
from vllm.utils import FlexibleArgumentParser, get_ip, is_in_ray_actor
from vllm.utils.mem_constants import GiB_bytes
86
from vllm.v1.sample.logits_processor import LogitsProcessor
87

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

99
100
logger = init_logger(__name__)

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

106

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

116
117
118
    return _parse_type


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

125
    return _optional_type
126
127


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


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


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


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


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

    return type_hints


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


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


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

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

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

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

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

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

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


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

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

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


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

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

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

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

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

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

484
    # Deprecated guided decoding fields
485
486
487
488
    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
489

490
    logits_processor_pattern: str | None = ModelConfig.logits_processor_pattern
491

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

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

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

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

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

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

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

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

532
533
    # DEPRECATED
    enable_multimodal_encoder_data_parallel: bool = False
534

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

540
541
    async_scheduling: bool = SchedulerConfig.async_scheduling

542
    kv_sharing_fast_prefill: bool = CacheConfig.kv_sharing_fast_prefill
543

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

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

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

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

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

683
684
685
686
687
        # Structured outputs arguments
        structured_outputs_kwargs = get_kwargs(StructuredOutputsConfig)
        structured_outputs_group = parser.add_argument_group(
            title="StructuredOutputsConfig",
            description=StructuredOutputsConfig.__doc__,
688
        )
689
        structured_outputs_group.add_argument(
690
            "--reasoning-parser",
691
            # This choice is a special case because it's not static
692
            choices=list(ReasoningParserManager.reasoning_parsers),
693
694
            **structured_outputs_kwargs["reasoning_parser"],
        )
695
696
697
698
699
700
701
702
703
704
705
        # 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."),
706
707
                deprecated=True,
            )
708

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

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

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

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

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

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

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

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

        # vLLM arguments
1030
        vllm_kwargs = get_kwargs(VllmConfig)
1031
1032
1033
1034
        vllm_group = parser.add_argument_group(
            title="VllmConfig",
            description=VllmConfig.__doc__,
        )
1035
1036
1037
1038
        # 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)
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
        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"]
        )
1055

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

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

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

1081
    def create_model_config(self) -> ModelConfig:
1082
1083
1084
1085
1086
        # 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
1087
1088
1089
1090
1091
1092
        if (
            not isinstance(self, AsyncEngineArgs)
            and envs.VLLM_CI_USE_S3
            and self.model in MODELS_ON_S3
            and self.load_format == "auto"
        ):
1093
1094
            self.model = f"{MODEL_WEIGHTS_S3_BUCKET}/{self.model}"

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

            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

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

            self.mm_encoder_tp_mode = "data"

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

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

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

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

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

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

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

1228
1229
1230
        # Note(Shangming): These parameters are not obtained from the cli arg
        # '--speculative-config' and must be passed in when creating the engine
        # config.
1231
1232
1233
1234
1235
1236
1237
1238
        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,
            }
        )
1239
        return SpeculativeConfig(**self.speculative_config)
1240

1241
1242
    def create_engine_config(
        self,
1243
        usage_context: UsageContext | None = None,
1244
        headless: bool = False,
1245
1246
1247
1248
1249
1250
1251
    ) -> 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
1252

1253
1254
1255
1256
1257
1258
        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.
        """
1259
        current_platform.pre_register_and_update()
1260

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

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

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

1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
        # * 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)

1294
1295
        # Set default arguments for V1 Engine.
        self._set_default_args(usage_context, model_config)
1296
1297
        # Disable chunked prefill and prefix caching for:
        # POWER (ppc64le)/ARM/s390x/RISCV CPUs in V1
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
        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."
            )
1309
            self.enable_chunked_prefill = False
1310
1311
1312
1313
1314
1315
1316
            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

1317
1318
        assert self.enable_chunked_prefill is not None

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

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

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

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

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

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

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

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

            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
1411
        else:
1412
            assert not self.data_parallel_hybrid_lb, (
1413
1414
                "data_parallel_size_local must be set to use data_parallel_hybrid_lb."
            )
1415

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

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

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

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

            # 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 "
1463
1464
                    "async scheduling."
                )
1465

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

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

1509
1510
1511
1512
1513
1514
1515
1516
1517
        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}`."
            )

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

1525
1526
1527
1528
1529
        # 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
1530

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

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

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

1578
        load_config = self.create_load_config()
1579

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

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

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

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

1624
1625
        return config

1626
1627
1628
1629
1630
1631
    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.

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

        # No Concurrent Partial Prefills so far.
1639
1640
1641
1642
1643
1644
1645
1646
        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
            )
1647
1648
            return False

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

        V1_BACKENDS = [
1665
1666
            "FLASH_ATTN",
            "PALLAS",
1667
            "TRITON_ATTN",
1668
            "TRITON_MLA",
1669
            "CUTLASS_MLA",
1670
            "FLASHMLA",
1671
            "FLASH_ATTN_MLA",
1672
            "FLASHINFER",
1673
            "FLASHINFER_MLA",
1674
            "ROCM_AITER_MLA",
1675
            "TORCH_SDPA",
1676
            "FLEX_ATTENTION",
1677
            "TREE_ATTN",
1678
1679
            "XFORMERS",
            "ROCM_ATTN",
1680
            "ROCM_AITER_UNIFIED_ATTN",
1681
        ]
1682
1683
1684
1685
        if (
            envs.is_set("VLLM_ATTENTION_BACKEND")
            and envs.VLLM_ATTENTION_BACKEND not in V1_BACKENDS
        ):
1686
1687
1688
1689
1690
1691
1692
            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.

1693
        if self.pipeline_parallel_size > 1:
1694
1695
1696
            supports_pp = getattr(
                self.distributed_executor_backend, "supports_pp", False
            )
1697
            if not supports_pp and self.distributed_executor_backend not in (
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
                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)
1709
                return False
1710

1711
1712
1713
1714
        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
            )
1715
1716
            return False

1717
1718
1719
1720
        #############################################################

        return True

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

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

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

1742
            if self.enable_prefix_caching is None:
1743
1744
1745
1746
1747
1748
                # 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
1749
1750
        else:
            pooling_type = model_config.pooler_config.pooling_type
1751
            is_causal = getattr(model_config.hf_config, "is_causal", True)
1752
1753
1754
1755
1756
            incremental_prefill_supported = (
                pooling_type is not None
                and pooling_type.lower() == "last"
                and is_causal
            )
1757

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

            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)

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

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

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

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

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

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

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

1864
1865
1866
1867
1868
        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,
            )
1869

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

1876

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

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

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


1928
1929
1930
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(
1931
1932
            f"VLLM_USE_V1=1 is not supported with {feature_name}."
        )
1933
1934
1935
1936
1937
1938
1939
1940
    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)


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

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

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

    # Regular plain number.
    return int(value)