"examples/vscode:/vscode.git/clone" did not exist on "40b69e33e796efdc75e774a1c38cc73397ea6e17"
arg_utils.py 86.7 KB
Newer Older
1
# SPDX-License-Identifier: Apache-2.0
2
# SPDX-FileCopyrightText: Copyright contributors to the vLLM project
3

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

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

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

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

108
109
logger = init_logger(__name__)

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

115

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

125
126
127
    return _parse_type


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

134
    return _optional_type
135
136


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


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


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


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


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


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

    return type_hints


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


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


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

        # If the field is a dataclass, we can use the model_validate_json
        generator = (th for th in type_hints if is_dataclass(th))
        dataclass_cls = next(generator, None)

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

        # Get the help text for the field
        name = field.name
264
        help = cls_docs.get(name, "").strip()
265
266
267
268
269
270
271
        # Escape % for argparse
        help = help.replace("%", "%%")

        # Initialise the kwargs dictionary for the field
        kwargs[name] = {"default": default, "help": help}

        # Set other kwargs based on the type hints
272
273
274
        json_tip = (
            "Should either be a valid JSON string or JSON keys passed individually."
        )
275
        if dataclass_cls is not None:
276
277
278
279
280
281
282
283

            def parse_dataclass(val: str, cls=dataclass_cls) -> Any:
                try:
                    return TypeAdapter(cls).validate_json(val)
                except ValidationError as e:
                    raise argparse.ArgumentTypeError(repr(e)) from e

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

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

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


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

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

344
345
346
347
348
349
350
    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))


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

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

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

497
    enable_chunked_prefill: bool | None = None
498
    disable_chunked_mm_input: bool = SchedulerConfig.disable_chunked_mm_input
499

500
    disable_hybrid_kv_cache_manager: bool = (
501
502
        SchedulerConfig.disable_hybrid_kv_cache_manager
    )
503

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

510
    logits_processor_pattern: str | None = ModelConfig.logits_processor_pattern
511

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

514
    show_hidden_metrics_for_version: str | None = (
515
        ObservabilityConfig.show_hidden_metrics_for_version
516
    )
517
518
    otlp_traces_endpoint: str | None = ObservabilityConfig.otlp_traces_endpoint
    collect_detailed_traces: list[DetailedTraceModules] | None = (
519
        ObservabilityConfig.collect_detailed_traces
520
    )
521
522
523
524
    kv_cache_metrics: bool = ObservabilityConfig.kv_cache_metrics
    kv_cache_metrics_sample: float = get_field(
        ObservabilityConfig, "kv_cache_metrics_sample"
    )
525
    scheduling_policy: SchedulerPolicy = SchedulerConfig.policy
526
    scheduler_cls: str | type[object] | None = SchedulerConfig.scheduler_cls
527

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

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

536
537
    ec_transfer_config: ECTransferConfig | None = None

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

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

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

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

556
557
    # DEPRECATED
    enable_multimodal_encoder_data_parallel: bool = False
558

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

564
    async_scheduling: bool | None = SchedulerConfig.async_scheduling
565

566
567
    stream_interval: int = SchedulerConfig.stream_interval

568
    kv_sharing_fast_prefill: bool = CacheConfig.kv_sharing_fast_prefill
569
    optimization_level: OptimizationLevel = VllmConfig.optimization_level
570

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

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

588
        load_general_plugins()
589
        # when use hf offline,replace model and tokenizer id to local model path
590
591
592
        if huggingface_hub.constants.HF_HUB_OFFLINE:
            model_id = self.model
            self.model = get_model_path(self.model, self.revision)
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
            if model_id is not self.model:
                logger.info(
                    "HF_HUB_OFFLINE is True, replace model_id [%s] to model_path [%s]",
                    model_id,
                    self.model,
                )
            if self.tokenizer is not None:
                tokenizer_id = self.tokenizer
                self.tokenizer = get_model_path(self.tokenizer, self.tokenizer_revision)
                if tokenizer_id is not self.tokenizer:
                    logger.info(
                        "HF_HUB_OFFLINE is True, replace tokenizer_id [%s] "
                        "to tokenizer_path [%s]",
                        tokenizer_id,
                        self.tokenizer,
                    )
609
610

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

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

700
701
702
703
704
705
        # Model loading arguments
        load_kwargs = get_kwargs(LoadConfig)
        load_group = parser.add_argument_group(
            title="LoadConfig",
            description=LoadConfig.__doc__,
        )
706
        load_group.add_argument("--load-format", **load_kwargs["load_format"])
707
708
709
710
711
712
713
714
715
716
717
718
        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"]
        )
719

720
721
722
723
724
        # Structured outputs arguments
        structured_outputs_kwargs = get_kwargs(StructuredOutputsConfig)
        structured_outputs_group = parser.add_argument_group(
            title="StructuredOutputsConfig",
            description=StructuredOutputsConfig.__doc__,
725
        )
726
        structured_outputs_group.add_argument(
727
            "--reasoning-parser",
728
            # Choices need to be validated after parsing to include plugins
729
730
            **structured_outputs_kwargs["reasoning_parser"],
        )
731
732
733
734
        structured_outputs_group.add_argument(
            "--reasoning-parser-plugin",
            **structured_outputs_kwargs["reasoning_parser_plugin"],
        )
735

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

853
        parallel_group.add_argument(
854
            "--max-parallel-loading-workers",
855
856
            **parallel_kwargs["max_parallel_loading_workers"],
        )
857
        parallel_group.add_argument(
858
859
            "--ray-workers-use-nsight", **parallel_kwargs["ray_workers_use_nsight"]
        )
860
        parallel_group.add_argument(
861
            "--disable-custom-all-reduce",
862
863
864
865
866
867
            **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"]
        )
868
869
        parallel_group.add_argument(
            "--enable-multimodal-encoder-data-parallel",
870
            action="store_true",
871
872
            deprecated=True,
        )
873

874
875
876
877
878
        # KV cache arguments
        cache_kwargs = get_kwargs(CacheConfig)
        cache_group = parser.add_argument_group(
            title="CacheConfig",
            description=CacheConfig.__doc__,
879
        )
880
        cache_group.add_argument("--block-size", **cache_kwargs["block_size"])
881
882
883
884
885
886
        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"]
        )
887
        cache_group.add_argument("--swap-space", **cache_kwargs["swap_space"])
888
889
890
891
892
        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(
893
894
895
896
897
            "--enable-prefix-caching",
            **{
                **cache_kwargs["enable_prefix_caching"],
                "default": None,
            },
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
        )
        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"]
        )
915
916
917
        cache_group.add_argument(
            "--mamba-block-size", **cache_kwargs["mamba_block_size"]
        )
918
919
920
921
922
923
        cache_group.add_argument(
            "--kv-offloading-size", **cache_kwargs["kv_offloading_size"]
        )
        cache_group.add_argument(
            "--kv-offloading-backend", **cache_kwargs["kv_offloading_backend"]
        )
924

925
        # Multimodal related configs
926
927
928
929
930
        multimodal_kwargs = get_kwargs(MultiModalConfig)
        multimodal_group = parser.add_argument_group(
            title="MultiModalConfig",
            description=MultiModalConfig.__doc__,
        )
931
        multimodal_group.add_argument(
932
933
            "--limit-mm-per-prompt", **multimodal_kwargs["limit_per_prompt"]
        )
934
935
936
        multimodal_group.add_argument(
            "--enable-mm-embeds", **multimodal_kwargs["enable_mm_embeds"]
        )
937
938
939
940
941
942
943
944
945
        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"]
        )
946
        multimodal_group.add_argument(
947
948
            "--disable-mm-preprocessor-cache", action="store_true", deprecated=True
        )
949
        multimodal_group.add_argument(
950
951
            "--mm-processor-cache-type", **multimodal_kwargs["mm_processor_cache_type"]
        )
952
953
        multimodal_group.add_argument(
            "--mm-shm-cache-max-object-size-mb",
954
955
            **multimodal_kwargs["mm_shm_cache_max_object_size_mb"],
        )
956
        multimodal_group.add_argument(
957
958
            "--mm-encoder-tp-mode", **multimodal_kwargs["mm_encoder_tp_mode"]
        )
959
960
961
962
        multimodal_group.add_argument(
            "--mm-encoder-attn-backend",
            **multimodal_kwargs["mm_encoder_attn_backend"],
        )
963
964
965
        multimodal_group.add_argument(
            "--interleave-mm-strings", **multimodal_kwargs["interleave_mm_strings"]
        )
966
        multimodal_group.add_argument(
967
968
            "--skip-mm-profiling", **multimodal_kwargs["skip_mm_profiling"]
        )
969

970
        multimodal_group.add_argument(
971
972
            "--video-pruning-rate", **multimodal_kwargs["video_pruning_rate"]
        )
973

974
        # LoRA related configs
975
976
977
978
979
980
        lora_kwargs = get_kwargs(LoRAConfig)
        lora_group = parser.add_argument_group(
            title="LoRAConfig",
            description=LoRAConfig.__doc__,
        )
        lora_group.add_argument(
981
            "--enable-lora",
982
            action=argparse.BooleanOptionalAction,
983
984
            help="If True, enable handling of LoRA adapters.",
        )
985
        lora_group.add_argument("--max-loras", **lora_kwargs["max_loras"])
986
        lora_group.add_argument("--max-lora-rank", **lora_kwargs["max_lora_rank"])
987
        lora_group.add_argument(
988
            "--lora-dtype",
989
990
            **lora_kwargs["lora_dtype"],
        )
991
992
993
994
995
        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"])
996

997
998
999
1000
1001
1002
1003
1004
        # 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",
1005
1006
            **observability_kwargs["show_hidden_metrics_for_version"],
        )
1007
        observability_group.add_argument(
1008
1009
            "--otlp-traces-endpoint", **observability_kwargs["otlp_traces_endpoint"]
        )
1010
1011
1012
1013
1014
        # 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"] += [
1015
            ",".join(p) for p in permutations(get_args(DetailedTraceModules), r=2)
1016
1017
1018
        ]
        observability_group.add_argument(
            "--collect-detailed-traces",
1019
1020
            **observability_kwargs["collect_detailed_traces"],
        )
1021
1022
1023
1024
1025
1026
1027
        observability_group.add_argument(
            "--kv-cache-metrics", **observability_kwargs["kv_cache_metrics"]
        )
        observability_group.add_argument(
            "--kv-cache-metrics-sample",
            **observability_kwargs["kv_cache_metrics_sample"],
        )
1028

1029
1030
1031
1032
1033
1034
1035
        # Scheduler arguments
        scheduler_kwargs = get_kwargs(SchedulerConfig)
        scheduler_group = parser.add_argument_group(
            title="SchedulerConfig",
            description=SchedulerConfig.__doc__,
        )
        scheduler_group.add_argument(
1036
1037
1038
1039
1040
            "--max-num-batched-tokens",
            **{
                **scheduler_kwargs["max_num_batched_tokens"],
                "default": None,
            },
1041
        )
1042
        scheduler_group.add_argument(
1043
1044
1045
1046
1047
            "--max-num-seqs",
            **{
                **scheduler_kwargs["max_num_seqs"],
                "default": None,
            },
1048
1049
1050
1051
        )
        scheduler_group.add_argument(
            "--max-num-partial-prefills", **scheduler_kwargs["max_num_partial_prefills"]
        )
1052
1053
        scheduler_group.add_argument(
            "--max-long-partial-prefills",
1054
1055
            **scheduler_kwargs["max_long_partial_prefills"],
        )
1056
1057
        scheduler_group.add_argument(
            "--long-prefill-token-threshold",
1058
1059
            **scheduler_kwargs["long_prefill_token_threshold"],
        )
1060
1061
        # multi-step scheduling has been removed; corresponding arguments
        # are no longer supported.
1062
        scheduler_group.add_argument(
1063
1064
            "--scheduling-policy", **scheduler_kwargs["policy"]
        )
1065
        scheduler_group.add_argument(
1066
1067
1068
1069
1070
            "--enable-chunked-prefill",
            **{
                **scheduler_kwargs["enable_chunked_prefill"],
                "default": None,
            },
1071
1072
1073
1074
1075
1076
1077
        )
        scheduler_group.add_argument(
            "--disable-chunked-mm-input", **scheduler_kwargs["disable_chunked_mm_input"]
        )
        scheduler_group.add_argument(
            "--scheduler-cls", **scheduler_kwargs["scheduler_cls"]
        )
1078
1079
        scheduler_group.add_argument(
            "--disable-hybrid-kv-cache-manager",
1080
1081
1082
1083
1084
            **scheduler_kwargs["disable_hybrid_kv_cache_manager"],
        )
        scheduler_group.add_argument(
            "--async-scheduling", **scheduler_kwargs["async_scheduling"]
        )
1085
1086
1087
        scheduler_group.add_argument(
            "--stream-interval", **scheduler_kwargs["stream_interval"]
        )
1088

1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
        # Compilation arguments
        compilation_kwargs = get_kwargs(CompilationConfig)
        compilation_group = parser.add_argument_group(
            title="CompilationConfig",
            description=CompilationConfig.__doc__,
        )
        compilation_group.add_argument(
            "--cudagraph-capture-sizes", **compilation_kwargs["cudagraph_capture_sizes"]
        )
        compilation_kwargs["cudagraph_capture_sizes"]["help"] = (
            "--cuda-graph-sizes is deprecated and will be removed in v0.13.0 or v1.0.0,"
            " whichever is soonest. Please use --cudagraph-capture-sizes instead."
        )
        compilation_group.add_argument(
            "--cuda-graph-sizes",
            **compilation_kwargs["cudagraph_capture_sizes"],
            deprecated=True,
        )
        compilation_group.add_argument(
            "--max-cudagraph-capture-size",
            **compilation_kwargs["max_cudagraph_capture_size"],
        )

1112
        # vLLM arguments
1113
        vllm_kwargs = get_kwargs(VllmConfig)
1114
1115
1116
1117
        vllm_group = parser.add_argument_group(
            title="VllmConfig",
            description=VllmConfig.__doc__,
        )
1118
1119
1120
1121
        # 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)
1122
1123
1124
1125
1126
1127
1128
        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"])
1129
1130
1131
        vllm_group.add_argument(
            "--ec-transfer-config", **vllm_kwargs["ec_transfer_config"]
        )
1132
        vllm_group.add_argument(
1133
            "--compilation-config", "-cc", **vllm_kwargs["compilation_config"]
1134
1135
1136
1137
1138
1139
1140
        )
        vllm_group.add_argument(
            "--additional-config", **vllm_kwargs["additional_config"]
        )
        vllm_group.add_argument(
            "--structured-outputs-config", **vllm_kwargs["structured_outputs_config"]
        )
1141

1142
1143
1144
1145
        vllm_group.add_argument(
            "--optimization-level", **vllm_kwargs["optimization_level"]
        )

1146
        # Other arguments
1147
1148
1149
1150
1151
        parser.add_argument(
            "--disable-log-stats",
            action="store_true",
            help="Disable logging statistics.",
        )
1152

1153
1154
1155
1156
1157
1158
        parser.add_argument(
            "--aggregate-engine-logging",
            action="store_true",
            help="Log aggregate rather than per-engine statistics "
            "when using data parallelism.",
        )
1159
        return parser
1160
1161

    @classmethod
1162
    def from_cli_args(cls, args: argparse.Namespace):
1163
1164
1165
        # Get the list of attributes of this dataclass.
        attrs = [attr.name for attr in dataclasses.fields(cls)]
        # Set the attributes from the parsed arguments.
1166
1167
1168
        engine_args = cls(
            **{attr: getattr(args, attr) for attr in attrs if hasattr(args, attr)}
        )
Zhuohan Li's avatar
Zhuohan Li committed
1169
        return engine_args
1170

1171
    def create_model_config(self) -> ModelConfig:
1172
1173
        # gguf file needs a specific model loader
        if is_gguf(self.model):
1174
1175
            self.quantization = self.load_format = "gguf"

1176
1177
1178
1179
        # NOTE(woosuk): In V1, we use separate processes for workers (unless
        # VLLM_ENABLE_V1_MULTIPROCESSING=0), so setting a seed here
        # doesn't affect the user process.
        if self.seed is None:
1180
1181
1182
1183
1184
1185
            logger.warning_once(
                "`seed=None` is equivalent to `seed=0` in V1 Engine. "
                "You will no longer be allowed to pass `None` in v0.13.",
                scope="local",
            )

1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
            self.seed = 0
            if not envs.VLLM_ENABLE_V1_MULTIPROCESSING:
                logger.warning(
                    "The global random seed is set to %d. Since "
                    "VLLM_ENABLE_V1_MULTIPROCESSING is set to False, this may "
                    "affect the random state of the Python process that "
                    "launched vLLM.",
                    self.seed,
                )

1196
        if self.disable_mm_preprocessor_cache:
1197
            logger.warning_once(
1198
1199
                "`--disable-mm-preprocessor-cache` is deprecated "
                "and will be removed in v0.13. "
1200
                "Please use `--mm-processor-cache-gb 0` instead.",
1201
                scope="local",
1202
            )
1203
1204
1205

            self.mm_processor_cache_gb = 0
        elif envs.VLLM_MM_INPUT_CACHE_GIB != 4:
1206
            logger.warning_once(
1207
1208
1209
1210
                "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,
1211
                scope="local",
1212
1213
1214
1215
            )

            self.mm_processor_cache_gb = envs.VLLM_MM_INPUT_CACHE_GIB

1216
        if self.enable_multimodal_encoder_data_parallel:
1217
            logger.warning_once(
1218
1219
                "--enable-multimodal-encoder-data-parallel` is deprecated "
                "and will be removed in v0.13. "
1220
1221
                "Please use `--mm-encoder-tp-mode data` instead.",
                scope="local",
1222
            )
1223
1224
1225

            self.mm_encoder_tp_mode = "data"

1226
        return ModelConfig(
1227
            model=self.model,
1228
            hf_config_path=self.hf_config_path,
1229
1230
            runner=self.runner,
            convert=self.convert,
1231
            task=self.task,
1232
            tokenizer=self.tokenizer,
1233
1234
            tokenizer_mode=self.tokenizer_mode,
            trust_remote_code=self.trust_remote_code,
1235
            allowed_local_media_path=self.allowed_local_media_path,
1236
            allowed_media_domains=self.allowed_media_domains,
1237
1238
1239
1240
            dtype=self.dtype,
            seed=self.seed,
            revision=self.revision,
            code_revision=self.code_revision,
1241
            hf_token=self.hf_token,
1242
            hf_overrides=self.hf_overrides,
1243
1244
1245
1246
1247
            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,
1248
            logprobs_mode=self.logprobs_mode,
1249
            disable_sliding_window=self.disable_sliding_window,
1250
            disable_cascade_attn=self.disable_cascade_attn,
1251
            skip_tokenizer_init=self.skip_tokenizer_init,
1252
            enable_prompt_embeds=self.enable_prompt_embeds,
1253
            served_model_name=self.served_model_name,
1254
            limit_mm_per_prompt=self.limit_mm_per_prompt,
1255
            enable_mm_embeds=self.enable_mm_embeds,
1256
            interleave_mm_strings=self.interleave_mm_strings,
1257
            media_io_kwargs=self.media_io_kwargs,
1258
            skip_mm_profiling=self.skip_mm_profiling,
1259
            config_format=self.config_format,
1260
            mm_processor_kwargs=self.mm_processor_kwargs,
1261
            mm_processor_cache_gb=self.mm_processor_cache_gb,
1262
            mm_processor_cache_type=self.mm_processor_cache_type,
1263
            mm_shm_cache_max_object_size_mb=self.mm_shm_cache_max_object_size_mb,
1264
            mm_encoder_tp_mode=self.mm_encoder_tp_mode,
1265
            mm_encoder_attn_backend=self.mm_encoder_attn_backend,
1266
            pooler_config=self.pooler_config,
1267
            logits_processor_pattern=self.logits_processor_pattern,
1268
            generation_config=self.generation_config,
1269
            override_generation_config=self.override_generation_config,
1270
            enable_sleep_mode=self.enable_sleep_mode,
1271
            model_impl=self.model_impl,
1272
            override_attention_dtype=self.override_attention_dtype,
1273
            logits_processors=self.logits_processors,
1274
            video_pruning_rate=self.video_pruning_rate,
1275
            io_processor_plugin=self.io_processor_plugin,
1276
        )
1277

1278
    def validate_tensorizer_args(self):
1279
1280
        from vllm.model_executor.model_loader.tensorizer import TensorizerConfig

1281
1282
        for key in self.model_loader_extra_config:
            if key in TensorizerConfig._fields:
1283
1284
1285
                self.model_loader_extra_config["tensorizer_config"][key] = (
                    self.model_loader_extra_config[key]
                )
1286

1287
    def create_load_config(self) -> LoadConfig:
1288
1289
        if self.quantization == "bitsandbytes":
            self.load_format = "bitsandbytes"
1290

1291
1292
1293
        if self.load_format == "tensorizer":
            if hasattr(self.model_loader_extra_config, "to_serializable"):
                self.model_loader_extra_config = (
1294
1295
                    self.model_loader_extra_config.to_serializable()
                )
1296
            self.model_loader_extra_config["tensorizer_config"] = {}
1297
1298
1299
            self.model_loader_extra_config["tensorizer_config"]["tensorizer_dir"] = (
                self.model
            )
1300
            self.validate_tensorizer_args()
1301

1302
1303
1304
        return LoadConfig(
            load_format=self.load_format,
            download_dir=self.download_dir,
1305
            safetensors_load_strategy=self.safetensors_load_strategy,
1306
            device="cpu" if is_online_quantization(self.quantization) else None,
1307
1308
            model_loader_extra_config=self.model_loader_extra_config,
            ignore_patterns=self.ignore_patterns,
1309
            use_tqdm_on_load=self.use_tqdm_on_load,
1310
            pt_load_map_location=self.pt_load_map_location,
1311
        )
1312

1313
1314
1315
1316
    def create_speculative_config(
        self,
        target_model_config: ModelConfig,
        target_parallel_config: ParallelConfig,
1317
    ) -> SpeculativeConfig | None:
1318
1319
1320
1321
1322
1323
        """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
1324
        dictionary from the engine.
1325
1326
        """
        if self.speculative_config is None:
1327
            return None
1328

1329
1330
1331
        # Note(Shangming): These parameters are not obtained from the cli arg
        # '--speculative-config' and must be passed in when creating the engine
        # config.
1332
1333
1334
1335
1336
1337
        self.speculative_config.update(
            {
                "target_model_config": target_model_config,
                "target_parallel_config": target_parallel_config,
            }
        )
1338
        return SpeculativeConfig(**self.speculative_config)
1339

1340
1341
    def create_engine_config(
        self,
1342
        usage_context: UsageContext | None = None,
1343
        headless: bool = False,
1344
1345
1346
1347
    ) -> VllmConfig:
        """
        Create the VllmConfig.

1348
        NOTE: If VllmConfig is incompatible, we raise an error.
1349
        """
1350
        current_platform.pre_register_and_update()
1351

1352
        device_config = DeviceConfig(device=cast(Device, current_platform.device_type))
1353

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

1370
1371
1372
1373
        model_config = self.create_model_config()
        self.model = model_config.model
        self.tokenizer = model_config.tokenizer

1374
        self._check_feature_supported(model_config)
1375
1376
1377
1378
        self._set_default_chunked_prefill_and_prefix_caching_args(model_config)
        self._set_default_max_num_seqs_and_batched_tokens_args(
            usage_context, model_config
        )
1379

1380
        sliding_window: int | None = None
1381
1382
1383
1384
1385
1386
        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()

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

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

1418
1419
1420
1421
1422
1423
        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
1424

1425
            ray_runtime_env = ray.get_runtime_context().runtime_env
1426
1427
1428
1429
1430
1431
1432
            # 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)
1433

1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
        # 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()

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

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

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

1537
1538
1539
1540
1541
1542
1543
1544
1545
            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
1546
1547
1548

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

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

1575
1576
1577
1578
        if self.tokens_only and not model_config.skip_tokenizer_init:
            model_config.skip_tokenizer_init = True
            logger.info("Skipping tokenizer initialization for tokens-only mode.")

1579
1580
1581
1582
1583
1584
        if self.async_scheduling and not self.disable_nccl_for_dp_synchronization:
            logger.info(
                "Disabling NCCL for DP synchronization when using async scheduling."
            )
            self.disable_nccl_for_dp_synchronization = True

1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
        # 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

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

1635
        speculative_config = self.create_speculative_config(
1636
1637
1638
1639
            target_model_config=model_config,
            target_parallel_config=parallel_config,
        )

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

1659
1660
1661
        if not model_config.is_multimodal_model and self.default_mm_loras:
            raise ValueError(
                "Default modality-specific LoRA(s) were provided for a "
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
                "non multimodal model"
            )

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

1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
        if (
            lora_config is not None
            and speculative_config is not None
            and scheduler_config.max_num_batched_tokens
            < (
                scheduler_config.max_num_seqs
                * (speculative_config.num_speculative_tokens + 1)
            )
        ):
            raise ValueError(
                "Consider increasing max_num_batched_tokens or "
                "decreasing num_speculative_tokens"
            )

1694
1695
1696
1697
        # bitsandbytes pre-quantized model need a specific model loader
        if model_config.quantization == "bitsandbytes":
            self.quantization = self.load_format = "bitsandbytes"

1698
        load_config = self.create_load_config()
1699

1700
1701
        # Pass reasoning_parser into StructuredOutputsConfig
        if self.reasoning_parser:
1702
            self.structured_outputs_config.reasoning_parser = self.reasoning_parser
1703

1704
1705
1706
1707
1708
        if self.reasoning_parser_plugin:
            self.structured_outputs_config.reasoning_parser_plugin = (
                self.reasoning_parser_plugin
            )

1709
        observability_config = ObservabilityConfig(
1710
            show_hidden_metrics_for_version=self.show_hidden_metrics_for_version,
1711
            otlp_traces_endpoint=self.otlp_traces_endpoint,
1712
            collect_detailed_traces=self.collect_detailed_traces,
1713
1714
            kv_cache_metrics=self.kv_cache_metrics,
            kv_cache_metrics_sample=self.kv_cache_metrics_sample,
1715
        )
1716

1717
        # Compilation config overrides
1718
        compilation_config = copy.deepcopy(self.compilation_config)
1719
1720
1721
1722
1723
1724
        if self.cuda_graph_sizes is not None:
            logger.warning(
                "--cuda-graph-sizes is deprecated and will be removed in v0.13.0 or "
                "v1.0.0, whichever is soonest. Please use --cudagraph-capture-sizes "
                "instead."
            )
1725
            if compilation_config.cudagraph_capture_sizes is not None:
1726
1727
1728
1729
                raise ValueError(
                    "cuda_graph_sizes and compilation_config."
                    "cudagraph_capture_sizes are mutually exclusive"
                )
1730
            compilation_config.cudagraph_capture_sizes = self.cuda_graph_sizes
1731
        if self.cudagraph_capture_sizes is not None:
1732
            if compilation_config.cudagraph_capture_sizes is not None:
1733
1734
1735
1736
                raise ValueError(
                    "cudagraph_capture_sizes and compilation_config."
                    "cudagraph_capture_sizes are mutually exclusive"
                )
1737
            compilation_config.cudagraph_capture_sizes = self.cudagraph_capture_sizes
1738
        if self.max_cudagraph_capture_size is not None:
1739
            if compilation_config.max_cudagraph_capture_size is not None:
1740
1741
1742
1743
                raise ValueError(
                    "max_cudagraph_capture_size and compilation_config."
                    "max_cudagraph_capture_size are mutually exclusive"
                )
1744
            compilation_config.max_cudagraph_capture_size = (
1745
1746
                self.max_cudagraph_capture_size
            )
1747
        config = VllmConfig(
1748
1749
1750
1751
1752
1753
1754
1755
            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,
1756
            structured_outputs_config=self.structured_outputs_config,
1757
            observability_config=observability_config,
1758
            compilation_config=compilation_config,
1759
            kv_transfer_config=self.kv_transfer_config,
1760
            kv_events_config=self.kv_events_config,
1761
            ec_transfer_config=self.ec_transfer_config,
1762
            additional_config=self.additional_config,
1763
            optimization_level=self.optimization_level,
1764
        )
1765

1766
1767
        return config

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

        # No Concurrent Partial Prefills so far.
1774
1775
1776
1777
1778
        if (
            self.max_num_partial_prefills != SchedulerConfig.max_num_partial_prefills
            or self.max_long_partial_prefills
            != SchedulerConfig.max_long_partial_prefills
        ):
1779
            _raise_unsupported_error(feature_name="Concurrent Partial Prefill")
1780

1781
        # N-gram, Medusa, and Eagle are supported for speculative decoding.
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
        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 "
1793
1794
                    "such as ngram, medusa, eagle, or mtp."
                )
1795

1796
        if self.pipeline_parallel_size > 1:
1797
1798
1799
            supports_pp = getattr(
                self.distributed_executor_backend, "supports_pp", False
            )
1800
            if not supports_pp and self.distributed_executor_backend not in (
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
                ParallelConfig.distributed_executor_backend,
                "ray",
                "mp",
                "external_launcher",
            ):
                name = (
                    "Pipeline Parallelism without Ray distributed "
                    "executor or multiprocessing executor or external "
                    "launcher"
                )
1811
                _raise_unsupported_error(feature_name=name)
1812

1813
1814
1815
1816
1817
1818
    @classmethod
    def get_batch_defaults(
        cls,
        world_size: int,
    ) -> tuple[dict[UsageContext | None, int], dict[UsageContext | None, int]]:
        from vllm.usage.usage_lib import UsageContext
1819

1820
1821
        default_max_num_batched_tokens: dict[UsageContext | None, int]
        default_max_num_seqs: dict[UsageContext | None, int]
1822

1823
1824
        # When no user override, set the default values based on the usage
        # context.
1825
        # Use different default values for different hardware.
1826
1827
1828
1829
1830
1831
1832

        # 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:
1833
            device_memory = current_platform.get_device_total_memory()
1834
            device_name = current_platform.get_device_name().lower()
1835
1836
        except Exception:
            # This is only used to set default_max_num_batched_tokens
1837
            device_memory = 0
1838

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

1863
1864
        # tpu specific default values.
        if current_platform.is_tpu():
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
            chip_name = current_platform.get_device_name()

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

1883
1884
1885
        # cpu specific default values.
        if current_platform.is_cpu():
            default_max_num_batched_tokens = {
1886
1887
                UsageContext.LLM_CLASS: 4096 * world_size,
                UsageContext.OPENAI_API_SERVER: 2048 * world_size,
1888
1889
            }
            default_max_num_seqs = {
1890
1891
                UsageContext.LLM_CLASS: 256 * world_size,
                UsageContext.OPENAI_API_SERVER: 128 * world_size,
1892
1893
            }

1894
1895
        return default_max_num_batched_tokens, default_max_num_seqs

1896
1897
    def _set_default_chunked_prefill_and_prefix_caching_args(
        self, model_config: ModelConfig
1898
    ) -> None:
1899
1900
        default_chunked_prefill = model_config.is_chunked_prefill_supported
        default_prefix_caching = model_config.is_prefix_caching_supported
1901

1902
1903
1904
        if self.prefill_context_parallel_size > 1:
            default_chunked_prefill = False
            default_prefix_caching = False
1905
            logger.warning_once(
1906
1907
                "--prefill-context-parallel-size > 1 is not compatible with "
                "chunked prefill and prefix caching now. Chunked prefill "
1908
1909
                "and prefix caching have been disabled by default.",
                scope="local",
1910
1911
            )

1912
1913
1914
1915
1916
1917
1918
        if self.enable_chunked_prefill is None:
            self.enable_chunked_prefill = default_chunked_prefill

            logger.debug(
                "%s chunked prefill by default",
                "Enabling" if default_chunked_prefill else "Disabling",
            )
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
        elif (
            model_config.runner_type == "generate"
            and not self.enable_chunked_prefill
            and default_chunked_prefill
        ):
            logger.warning_once(
                "This model does not officially support disabling chunked prefill. "
                "Disabling this manually may cause the engine to crash "
                "or produce incorrect outputs.",
                scope="local",
            )
1930
1931
1932
1933
        elif (
            model_config.runner_type == "pooling"
            and self.enable_chunked_prefill
            and not default_chunked_prefill
1934
        ):
1935
            logger.warning_once(
1936
1937
1938
                "This model does not officially support chunked prefill. "
                "Enabling this manually may cause the engine to crash "
                "or produce incorrect outputs.",
1939
                scope="local",
1940
1941
1942
1943
1944
            )

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

1945
            logger.debug(
1946
1947
1948
1949
1950
1951
1952
1953
                "%s prefix caching by default",
                "Enabling" if default_prefix_caching else "Disabling",
            )
        elif (
            model_config.runner_type == "pooling"
            and self.enable_prefix_caching
            and not default_prefix_caching
        ):
1954
            logger.warning_once(
1955
1956
1957
                "This model does not officially support prefix caching. "
                "Enabling this manually may cause the engine to crash "
                "or produce incorrect outputs.",
1958
                scope="local",
1959
1960
            )

1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
        # Disable chunked prefill and prefix caching for:
        # POWER (ppc64le)/s390x/RISCV CPUs in V1
        if current_platform.is_cpu() and current_platform.get_cpu_architecture() in (
            CpuArchEnum.POWERPC,
            CpuArchEnum.S390X,
            CpuArchEnum.RISCV,
        ):
            logger.info(
                "Chunked prefill is not supported for ARM and POWER, "
                "S390X and RISC-V CPUs; "
                "disabling it for V1 backend."
            )
            self.enable_chunked_prefill = False
            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

    def _set_default_max_num_seqs_and_batched_tokens_args(
1982
1983
1984
        self,
        usage_context: UsageContext | None,
        model_config: ModelConfig,
1985
    ):
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
        world_size = self.pipeline_parallel_size * self.tensor_parallel_size
        (
            default_max_num_batched_tokens,
            default_max_num_seqs,
        ) = self.get_batch_defaults(world_size)

        orig_max_num_batched_tokens = self.max_num_batched_tokens
        orig_max_num_seqs = self.max_num_seqs

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

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

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

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

2023
2024
2025
2026
            logger.debug(
                "Defaulting max_num_batched_tokens to %d for %s usage context.",
                self.max_num_batched_tokens,
                usage_context.value if usage_context else None,
2027
            )
2028

2029
2030
2031
2032
        if orig_max_num_seqs is None:
            assert self.max_num_batched_tokens is not None  # For type checking
            self.max_num_seqs = min(self.max_num_seqs, self.max_num_batched_tokens)

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

2039

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

2044
2045
    enable_log_requests: bool = False

2046
    @staticmethod
2047
2048
2049
    def add_cli_args(
        parser: FlexibleArgumentParser, async_args_only: bool = False
    ) -> FlexibleArgumentParser:
2050
        # Initialize plugin to update the parser, for example, The plugin may
2051
        # add a new kind of quantization method to --quantization argument or
2052
2053
        # a new device to --device argument.
        load_general_plugins()
2054
2055
        if not async_args_only:
            parser = EngineArgs.add_cli_args(parser)
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
        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,
        )
2069
        current_platform.pre_register_and_update(parser)
2070
        return parser
2071
2072


2073
2074
2075
2076
2077
2078
def _raise_unsupported_error(feature_name: str):
    msg = (
        f"{feature_name} is not supported. We recommend to "
        f"remove {feature_name} from your config."
    )
    raise NotImplementedError(msg)
2079
2080


2081
2082
2083
def human_readable_int(value):
    """Parse human-readable integers like '1k', '2M', etc.
    Including decimal values with decimal multipliers.
2084

2085
2086
2087
2088
2089
2090
    Examples:
    - '1k' -> 1,000
    - '1K' -> 1,024
    - '25.6k' -> 25,600
    """
    value = value.strip()
2091
    match = re.fullmatch(r"(\d+(?:\.\d+)?)([kKmMgGtT])", value)
2092
2093
    if match:
        decimal_multiplier = {
2094
2095
2096
            "k": 10**3,
            "m": 10**6,
            "g": 10**9,
2097
2098
        }
        binary_multiplier = {
2099
2100
2101
            "K": 2**10,
            "M": 2**20,
            "G": 2**30,
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
        }

        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:
2114
2115
2116
2117
2118
                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
2119
2120
2121

    # Regular plain number.
    return int(value)