arg_utils.py 95.6 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.config import (
36
    AttentionConfig,
37
38
39
40
    CacheConfig,
    CompilationConfig,
    ConfigType,
    DeviceConfig,
41
    ECTransferConfig,
42
    EPLBConfig,
43
    KernelConfig,
44
45
46
47
48
    KVEventsConfig,
    KVTransferConfig,
    LoadConfig,
    LoRAConfig,
    ModelConfig,
49
    MultiModalConfig,
50
    ObservabilityConfig,
51
    OffloadConfig,
52
53
    ParallelConfig,
    PoolerConfig,
54
    PrefetchOffloadConfig,
55
    ProfilerConfig,
56
    ReasoningConfig,
57
58
59
    SchedulerConfig,
    SpeculativeConfig,
    StructuredOutputsConfig,
60
    UVAOffloadConfig,
61
    VllmConfig,
62
    WeightTransferConfig,
63
64
    get_attr_docs,
)
65
66
67
from vllm.config.cache import (
    CacheDType,
    KVOffloadingBackend,
68
    MambaCacheMode,
69
70
71
    MambaDType,
    PrefixCachingHashAlgo,
)
72
from vllm.config.device import Device
73
from vllm.config.kernel import MoEBackend
74
from vllm.config.lora import MaxLoRARanks
75
76
77
78
79
80
from vllm.config.model import (
    ConvertOption,
    HfOverrides,
    LogprobsMode,
    ModelDType,
    RunnerOption,
81
    TokenizerMode,
82
)
83
from vllm.config.multimodal import MMCacheType, MMEncoderTPMode, MMTensorIPC
84
from vllm.config.observability import DetailedTraceModules
85
86
87
from vllm.config.parallel import (
    All2AllBackend,
    DataParallelBackend,
88
    DCPCommBackend,
89
90
91
    DistributedExecutorBackend,
    ExpertPlacementStrategy,
)
92
from vllm.config.scheduler import SchedulerPolicy
93
from vllm.config.utils import get_field
94
from vllm.config.vllm import OptimizationLevel, PerformanceMode
95
from vllm.logger import init_logger, suppress_logging
96
from vllm.platforms import CpuArchEnum, current_platform
97
from vllm.plugins import load_general_plugins
98
from vllm.ray.lazy_utils import is_in_ray_actor, is_ray_initialized
99
100
101
102
from vllm.transformers_utils.config import (
    is_interleaved,
    maybe_override_with_speculators,
)
103
from vllm.transformers_utils.gguf_utils import is_gguf
104
from vllm.transformers_utils.repo_utils import get_model_path
105
from vllm.transformers_utils.utils import is_cloud_storage
106
from vllm.utils.argparse_utils import FlexibleArgumentParser
107
from vllm.utils.mem_constants import GiB_bytes
108
from vllm.utils.network_utils import get_ip
109
from vllm.utils.torch_utils import resolve_kv_cache_dtype_string
110
from vllm.v1.attention.backends.registry import AttentionBackendEnum
111
from vllm.v1.sample.logits_processor import LogitsProcessor
112
from vllm.version import __version__ as VLLM_VERSION
113

114
115
if TYPE_CHECKING:
    from vllm.model_executor.layers.quantization import QuantizationMethods
116
    from vllm.model_executor.model_loader import LoadFormats
117
    from vllm.usage.usage_lib import UsageContext
118
    from vllm.v1.executor import Executor
119
else:
120
    Executor = Any
121
    QuantizationMethods = Any
122
    LoadFormats = Any
123
124
    UsageContext = Any

125

126
127
logger = init_logger(__name__)

128
129
# object is used to allow for special typing forms
T = TypeVar("T")
130
131
TypeHint: TypeAlias = type[Any] | object
TypeHintT: TypeAlias = type[T] | object
132

133

134
135
def parse_type(return_type: Callable[[str], T]) -> Callable[[str], T]:
    def _parse_type(val: str) -> T:
136
137
138
139
        try:
            return return_type(val)
        except ValueError as e:
            raise argparse.ArgumentTypeError(
140
141
                f"Value {val} cannot be converted to {return_type}."
            ) from e
142

143
144
145
    return _parse_type


146
147
def optional_type(return_type: Callable[[str], T]) -> Callable[[str], T | None]:
    def _optional_type(val: str) -> T | None:
148
149
150
151
        if val == "" or val == "None":
            return None
        return parse_type(return_type)(val)

152
    return _optional_type
153
154


155
def union_dict_and_str(val: str) -> str | dict[str, str] | None:
156
    if not re.match(r"(?s)^\s*{.*}\s*$", val):
157
        return str(val)
158
    return optional_type(json.loads)(val)
159
160


161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
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)


176
def literal_to_kwargs(type_hints: set[TypeHint]) -> dict[str, Any]:
177
178
179
180
    """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`.
    """
181
    type_hint = get_type(type_hints, Literal)
182
183
184
    options = get_args(type_hint)
    option_type = type(options[0])
    if not all(isinstance(option, option_type) for option in options):
185
        raise ValueError(
186
            "All options must be of the same type. "
187
188
            f"Got {options} with types {[type(c) for c in options]}"
        )
189
190
    kwarg = "metavar" if contains_type(type_hints, str) else "choices"
    return {"type": option_type, kwarg: sorted(options)}
191
192


193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
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),
    }


218
219
220
221
222
def is_not_builtin(type_hint: TypeHint) -> bool:
    """Check if the class is not a built-in type."""
    return type_hint.__module__ != "builtins"


223
224
225
226
227
228
229
230
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]))
231
232
    elif origin in {Union, UnionType}:
        # Union for Union[X, Y] and UnionType for X | Y
233
234
235
236
237
238
239
240
        for arg in args:
            type_hints.update(get_type_hints(arg))
    else:
        type_hints.add(type_hint)

    return type_hints


241
NEEDS_HELP = (
242
243
    any("--help" in arg for arg in sys.argv)  # vllm SUBCOMMAND --help
    or (argv0 := sys.argv[0]).endswith("mkdocs")  # mkdocs SUBCOMMAND
244
245
246
247
    or argv0.endswith("mkdocs/__main__.py")  # python -m mkdocs SUBCOMMAND
)


248
249
250
251
252
253
254
255
def _maybe_add_docs_url(cls: Any) -> str:
    """Generate API docs URL for a vllm config class."""
    if not cls.__module__.startswith("vllm.config"):
        return ""
    version = f"v{VLLM_VERSION}" if "dev" not in VLLM_VERSION else "latest"
    return f"\n\nAPI docs: https://docs.vllm.ai/en/{version}/api/vllm/config/#vllm.config.{cls.__name__}"


256
@functools.lru_cache(maxsize=30)
257
def _compute_kwargs(cls: ConfigType) -> dict[str, dict[str, Any]]:
258
259
    # Save time only getting attr docs if we're generating help text
    cls_docs = get_attr_docs(cls) if NEEDS_HELP else {}
260
261
    kwargs = {}
    for field in fields(cls):
262
        # Get the set of possible types for the field
263
        type_hints: set[TypeHint] = get_type_hints(field.type)
264
265
266
267
268

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

269
        # Get the default value of the field
270
271
        if field.default is not MISSING:
            default = field.default
272
273
            # Handle pydantic.Field defaults
            if isinstance(default, FieldInfo):
274
275
276
277
278
279
                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():
280
                        default = default.default_factory()  # type: ignore[call-arg]
281
        elif field.default_factory is not MISSING:
282
            default = field.default_factory()
283
284
285

        # Get the help text for the field
        name = field.name
286
        help = cls_docs.get(name, "").strip()
287
288
289
290
291
292
293
        # 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
294
295
296
        json_tip = (
            "Should either be a valid JSON string or JSON keys passed individually."
        )
297
        if dataclass_cls is not None:
298
299
300
301
302
303
304
305

            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
306
            kwargs[name]["help"] += _maybe_add_docs_url(dataclass_cls)
307
            kwargs[name]["help"] += f"\n\n{json_tip}"
308
        elif contains_type(type_hints, bool):
309
310
311
            # Creates --no-<name> and --<name> flags
            kwargs[name]["action"] = argparse.BooleanOptionalAction
        elif contains_type(type_hints, Literal):
312
            kwargs[name].update(literal_to_kwargs(type_hints))
313
        elif contains_type(type_hints, tuple):
314
            kwargs[name].update(collection_to_kwargs(type_hints, tuple))
315
        elif contains_type(type_hints, list):
316
317
318
            kwargs[name].update(collection_to_kwargs(type_hints, list))
        elif contains_type(type_hints, set):
            kwargs[name].update(collection_to_kwargs(type_hints, set))
319
        elif contains_type(type_hints, int):
320
321
322
323
            if name == "max_model_len":
                kwargs[name]["type"] = human_readable_int_or_auto
                kwargs[name]["help"] += f"\n\n{human_readable_int_or_auto.__doc__}"
            elif name in ("max_num_batched_tokens", "kv_cache_memory_bytes"):
324
                kwargs[name]["type"] = human_readable_int
325
                kwargs[name]["help"] += f"\n\n{human_readable_int.__doc__}"
326
327
            else:
                kwargs[name]["type"] = int
328
329
        elif contains_type(type_hints, float):
            kwargs[name]["type"] = float
330
331
332
333
        elif contains_type(type_hints, dict) and (
            contains_type(type_hints, str)
            or any(is_not_builtin(th) for th in type_hints)
        ):
334
            kwargs[name]["type"] = union_dict_and_str
335
        elif contains_type(type_hints, dict):
336
            kwargs[name]["type"] = parse_type(json.loads)
337
            kwargs[name]["help"] += f"\n\n{json_tip}"
338
339
340
        elif contains_type(type_hints, str) or any(
            is_not_builtin(th) for th in type_hints
        ):
341
342
            kwargs[name]["type"] = str
        else:
343
            raise ValueError(f"Unsupported type {type_hints} for argument {name}.")
344

345
346
347
348
349
        # 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"]}))

350
351
352
353
354
355
356
        # 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
357
358


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

362
363
364
    If `--help` or `mkdocs` are not present in the command line command, the
    attribute documentation will not be included in the help output.

365
366
367
368
369
370
371
    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))


372
@dataclass
Zhuohan Li's avatar
Zhuohan Li committed
373
class EngineArgs:
Woosuk Kwon's avatar
Woosuk Kwon committed
374
    """Arguments for vLLM engine."""
375

376
    model: str = ModelConfig.model
377
    enable_return_routed_experts: bool = ModelConfig.enable_return_routed_experts
378
    model_weights: str = ModelConfig.model_weights
379
    served_model_name: str | list[str] | None = ModelConfig.served_model_name
380
    tokenizer: str | None = ModelConfig.tokenizer
381
    hf_config_path: str | None = ModelConfig.hf_config_path
382
383
    runner: RunnerOption = ModelConfig.runner
    convert: ConvertOption = ModelConfig.convert
384
    skip_tokenizer_init: bool = ModelConfig.skip_tokenizer_init
385
    enable_prompt_embeds: bool = ModelConfig.enable_prompt_embeds
386
    tokenizer_mode: TokenizerMode | str = ModelConfig.tokenizer_mode
387
    trust_remote_code: bool = ModelConfig.trust_remote_code
388
389
    allowed_local_media_path: str = ModelConfig.allowed_local_media_path
    allowed_media_domains: list[str] | None = ModelConfig.allowed_media_domains
390
    download_dir: str | None = LoadConfig.download_dir
391
    safetensors_load_strategy: str | None = LoadConfig.safetensors_load_strategy
392
    load_format: str | LoadFormats = LoadConfig.load_format
393
394
    config_format: str = ModelConfig.config_format
    dtype: ModelDType = ModelConfig.dtype
395
    kv_cache_dtype: CacheDType = CacheConfig.cache_dtype
396
    seed: int = ModelConfig.seed
397
    max_model_len: int = ModelConfig.max_model_len
398
399
400
401
402
403
    cudagraph_capture_sizes: list[int] | None = (
        CompilationConfig.cudagraph_capture_sizes
    )
    max_cudagraph_capture_size: int | None = get_field(
        CompilationConfig, "max_cudagraph_capture_size"
    )
404
405
406
    # Note: Specifying a custom executor backend by passing a class
    # is intended for expert use only. The API may change without
    # notice.
407
    distributed_executor_backend: (
408
        str | DistributedExecutorBackend | type[Executor] | None
409
    ) = ParallelConfig.distributed_executor_backend
410
    # number of P/D disaggregation (or other disaggregation) workers
411
    pipeline_parallel_size: int = ParallelConfig.pipeline_parallel_size
412
413
414
415
    master_addr: str = ParallelConfig.master_addr
    master_port: int = ParallelConfig.master_port
    nnodes: int = ParallelConfig.nnodes
    node_rank: int = ParallelConfig.node_rank
416
    distributed_timeout_seconds: int | None = ParallelConfig.distributed_timeout_seconds
417
    tensor_parallel_size: int = ParallelConfig.tensor_parallel_size
418
    prefill_context_parallel_size: int = ParallelConfig.prefill_context_parallel_size
419
    decode_context_parallel_size: int = ParallelConfig.decode_context_parallel_size
420
    dcp_comm_backend: DCPCommBackend = ParallelConfig.dcp_comm_backend
421
    dcp_kv_cache_interleave_size: int = ParallelConfig.dcp_kv_cache_interleave_size
422
    cp_kv_cache_interleave_size: int = ParallelConfig.cp_kv_cache_interleave_size
423
    data_parallel_size: int = ParallelConfig.data_parallel_size
424
425
426
427
428
    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
429
    data_parallel_hybrid_lb: bool = False
430
    data_parallel_external_lb: bool = False
431
    data_parallel_backend: DataParallelBackend = ParallelConfig.data_parallel_backend
432
    enable_expert_parallel: bool = ParallelConfig.enable_expert_parallel
433
    enable_ep_weight_filter: bool = ParallelConfig.enable_ep_weight_filter
434
    moe_backend: MoEBackend = KernelConfig.moe_backend
435
    all2all_backend: All2AllBackend = ParallelConfig.all2all_backend
436
    enable_elastic_ep: bool = ParallelConfig.enable_elastic_ep
437
    enable_dbo: bool = ParallelConfig.enable_dbo
438
    ubatch_size: int = ParallelConfig.ubatch_size
439
440
    dbo_decode_token_threshold: int = ParallelConfig.dbo_decode_token_threshold
    dbo_prefill_token_threshold: int = ParallelConfig.dbo_prefill_token_threshold
441
    disable_nccl_for_dp_synchronization: bool | None = (
442
443
        ParallelConfig.disable_nccl_for_dp_synchronization
    )
444
    eplb_config: EPLBConfig = get_field(ParallelConfig, "eplb_config")
445
    enable_eplb: bool = ParallelConfig.enable_eplb
446
    expert_placement_strategy: ExpertPlacementStrategy = (
447
        ParallelConfig.expert_placement_strategy
448
    )
449
450
    _api_process_count: int = ParallelConfig._api_process_count
    _api_process_rank: int = ParallelConfig._api_process_rank
451
    max_parallel_loading_workers: int | None = (
452
453
        ParallelConfig.max_parallel_loading_workers
    )
454
    block_size: int | None = None
455
    enable_prefix_caching: bool | None = None
456
    prefix_caching_hash_algo: PrefixCachingHashAlgo = (
457
        CacheConfig.prefix_caching_hash_algo
458
    )
459
460
    disable_sliding_window: bool = ModelConfig.disable_sliding_window
    disable_cascade_attn: bool = ModelConfig.disable_cascade_attn
461
462
463
464
465
466
467
    offload_backend: str = OffloadConfig.offload_backend
    cpu_offload_gb: float = UVAOffloadConfig.cpu_offload_gb
    cpu_offload_params: set[str] = get_field(UVAOffloadConfig, "cpu_offload_params")
    offload_group_size: int = PrefetchOffloadConfig.offload_group_size
    offload_num_in_group: int = PrefetchOffloadConfig.offload_num_in_group
    offload_prefetch_step: int = PrefetchOffloadConfig.offload_prefetch_step
    offload_params: set[str] = get_field(PrefetchOffloadConfig, "offload_params")
468
    gpu_memory_utilization: float = CacheConfig.gpu_memory_utilization
469
    kv_cache_memory_bytes: int | None = CacheConfig.kv_cache_memory_bytes
470
    max_num_batched_tokens: int | None = None
471
472
    max_num_partial_prefills: int = SchedulerConfig.max_num_partial_prefills
    max_long_partial_prefills: int = SchedulerConfig.max_long_partial_prefills
473
    long_prefill_token_threshold: int = SchedulerConfig.long_prefill_token_threshold
474
    max_num_seqs: int | None = None
475
    max_logprobs: int = ModelConfig.max_logprobs
476
    logprobs_mode: LogprobsMode = ModelConfig.logprobs_mode
477
    disable_log_stats: bool = False
478
    aggregate_engine_logging: bool = False
479
480
481
    revision: str | None = ModelConfig.revision
    code_revision: str | None = ModelConfig.code_revision
    hf_token: bool | str | None = ModelConfig.hf_token
482
    hf_overrides: HfOverrides = get_field(ModelConfig, "hf_overrides")
483
    tokenizer_revision: str | None = ModelConfig.tokenizer_revision
484
    quantization: QuantizationMethods | str | None = ModelConfig.quantization
485
    allow_deprecated_quantization: bool = ModelConfig.allow_deprecated_quantization
486
    enforce_eager: bool = ModelConfig.enforce_eager
487
    disable_custom_all_reduce: bool = ParallelConfig.disable_custom_all_reduce
488
    language_model_only: bool = MultiModalConfig.language_model_only
489
    limit_mm_per_prompt: dict[str, int | dict[str, int]] = get_field(
490
491
        MultiModalConfig, "limit_per_prompt"
    )
492
    enable_mm_embeds: bool = MultiModalConfig.enable_mm_embeds
493
    interleave_mm_strings: bool = MultiModalConfig.interleave_mm_strings
494
495
496
    media_io_kwargs: dict[str, dict[str, Any]] = get_field(
        MultiModalConfig, "media_io_kwargs"
    )
497
    mm_processor_kwargs: dict[str, Any] | None = MultiModalConfig.mm_processor_kwargs
498
    mm_processor_cache_gb: float = MultiModalConfig.mm_processor_cache_gb
499
    mm_processor_cache_type: MMCacheType | None = (
500
        MultiModalConfig.mm_processor_cache_type
501
502
    )
    mm_shm_cache_max_object_size_mb: int = (
503
        MultiModalConfig.mm_shm_cache_max_object_size_mb
504
    )
505
    mm_encoder_only: bool = MultiModalConfig.mm_encoder_only
506
    mm_encoder_tp_mode: MMEncoderTPMode = MultiModalConfig.mm_encoder_tp_mode
507
    mm_encoder_attn_backend: AttentionBackendEnum | str | None = (
508
509
        MultiModalConfig.mm_encoder_attn_backend
    )
510
    io_processor_plugin: str | None = None
511
    renderer_num_workers: int = 1
512
    skip_mm_profiling: bool = MultiModalConfig.skip_mm_profiling
513
    video_pruning_rate: float | None = MultiModalConfig.video_pruning_rate
514
    mm_tensor_ipc: MMTensorIPC = MultiModalConfig.mm_tensor_ipc
515
    # LoRA fields
516
    enable_lora: bool = False
517
    max_loras: int = LoRAConfig.max_loras
518
    max_lora_rank: MaxLoRARanks = LoRAConfig.max_lora_rank
519
    default_mm_loras: dict[str, str] | None = LoRAConfig.default_mm_loras
520
    fully_sharded_loras: bool = LoRAConfig.fully_sharded_loras
521
522
    max_cpu_loras: int | None = LoRAConfig.max_cpu_loras
    lora_dtype: str | torch.dtype | None = LoRAConfig.lora_dtype
523
    lora_target_modules: list[str] | None = LoRAConfig.target_modules
524
    enable_tower_connector_lora: bool = LoRAConfig.enable_tower_connector_lora
525
    specialize_active_lora: bool = LoRAConfig.specialize_active_lora
526

527
    ray_workers_use_nsight: bool = ParallelConfig.ray_workers_use_nsight
528
    num_gpu_blocks_override: int | None = CacheConfig.num_gpu_blocks_override
529
    model_loader_extra_config: dict = get_field(LoadConfig, "model_loader_extra_config")
530
    ignore_patterns: str | list[str] = get_field(LoadConfig, "ignore_patterns")
531

532
    enable_chunked_prefill: bool | None = None
533
    disable_chunked_mm_input: bool = SchedulerConfig.disable_chunked_mm_input
534

535
536
    scheduler_reserve_full_isl: bool = SchedulerConfig.scheduler_reserve_full_isl

537
    disable_hybrid_kv_cache_manager: bool | None = (
538
539
        SchedulerConfig.disable_hybrid_kv_cache_manager
    )
540

541
    structured_outputs_config: StructuredOutputsConfig = get_field(
542
543
        VllmConfig, "structured_outputs_config"
    )
544
    reasoning_parser: str = StructuredOutputsConfig.reasoning_parser
545
    reasoning_parser_plugin: str | None = None
546

547
    speculative_config: dict[str, Any] | None = None
548

549
    show_hidden_metrics_for_version: str | None = (
550
        ObservabilityConfig.show_hidden_metrics_for_version
551
    )
552
553
    otlp_traces_endpoint: str | None = ObservabilityConfig.otlp_traces_endpoint
    collect_detailed_traces: list[DetailedTraceModules] | None = (
554
        ObservabilityConfig.collect_detailed_traces
555
    )
556
557
558
559
    kv_cache_metrics: bool = ObservabilityConfig.kv_cache_metrics
    kv_cache_metrics_sample: float = get_field(
        ObservabilityConfig, "kv_cache_metrics_sample"
    )
560
    cudagraph_metrics: bool = ObservabilityConfig.cudagraph_metrics
561
562
563
    enable_layerwise_nvtx_tracing: bool = (
        ObservabilityConfig.enable_layerwise_nvtx_tracing
    )
564
    enable_mfu_metrics: bool = ObservabilityConfig.enable_mfu_metrics
565
566
567
    enable_logging_iteration_details: bool = (
        ObservabilityConfig.enable_logging_iteration_details
    )
568
    enable_mm_processor_stats: bool = ObservabilityConfig.enable_mm_processor_stats
569
    scheduling_policy: SchedulerPolicy = SchedulerConfig.policy
570
    scheduler_cls: str | type[object] | None = SchedulerConfig.scheduler_cls
571

572
    pooler_config: PoolerConfig | None = ModelConfig.pooler_config
573
    compilation_config: CompilationConfig = get_field(VllmConfig, "compilation_config")
574
    attention_config: AttentionConfig = get_field(VllmConfig, "attention_config")
575
576
577
578
    kernel_config: KernelConfig = get_field(VllmConfig, "kernel_config")
    enable_flashinfer_autotune: bool = get_field(
        KernelConfig, "enable_flashinfer_autotune"
    )
579
580
    worker_cls: str = ParallelConfig.worker_cls
    worker_extension_cls: str = ParallelConfig.worker_extension_cls
581

582
583
    profiler_config: ProfilerConfig = get_field(VllmConfig, "profiler_config")

584
585
    kv_transfer_config: KVTransferConfig | None = None
    kv_events_config: KVEventsConfig | None = None
586

587
    ec_transfer_config: ECTransferConfig | None = None
588
    reasoning_config: ReasoningConfig = get_field(VllmConfig, "reasoning_config")
589

590
591
    generation_config: str = ModelConfig.generation_config
    enable_sleep_mode: bool = ModelConfig.enable_sleep_mode
592
593
594
    override_generation_config: dict[str, Any] = get_field(
        ModelConfig, "override_generation_config"
    )
595
    model_impl: str = ModelConfig.model_impl
596
    override_attention_dtype: str | None = ModelConfig.override_attention_dtype
597
    attention_backend: AttentionBackendEnum | None = AttentionConfig.backend
598

599
    calculate_kv_scales: bool = CacheConfig.calculate_kv_scales
600
601
    mamba_cache_dtype: MambaDType = CacheConfig.mamba_cache_dtype
    mamba_ssm_cache_dtype: MambaDType = CacheConfig.mamba_ssm_cache_dtype
602
    mamba_block_size: int | None = get_field(CacheConfig, "mamba_block_size")
603
    mamba_cache_mode: MambaCacheMode = CacheConfig.mamba_cache_mode
604

605
    additional_config: dict[str, Any] = get_field(VllmConfig, "additional_config")
606

607
    use_tqdm_on_load: bool = LoadConfig.use_tqdm_on_load
608
    pt_load_map_location: str | dict[str, str] = LoadConfig.pt_load_map_location
609

610
    logits_processors: list[str | type[LogitsProcessor]] | None = (
611
612
        ModelConfig.logits_processors
    )
613
614
    """Custom logitproc types"""

615
    async_scheduling: bool | None = SchedulerConfig.async_scheduling
616

617
618
    stream_interval: int = SchedulerConfig.stream_interval

619
    kv_sharing_fast_prefill: bool = CacheConfig.kv_sharing_fast_prefill
620
    optimization_level: OptimizationLevel = VllmConfig.optimization_level
621
    performance_mode: PerformanceMode = VllmConfig.performance_mode
622

623
    kv_offloading_size: float | None = CacheConfig.kv_offloading_size
624
    kv_offloading_backend: KVOffloadingBackend = CacheConfig.kv_offloading_backend
625
    tokens_only: bool = False
626

627
628
    shutdown_timeout: int = 0

629
630
631
632
    weight_transfer_config: WeightTransferConfig | None = get_field(
        VllmConfig,
        "weight_transfer_config",
    )
633

634
    fail_on_environ_validation: bool = False
635
    gdn_prefill_backend: Literal["flashinfer", "triton"] | None = None
636

637
    def __post_init__(self):
638
639
640
        # support `EngineArgs(compilation_config={...})`
        # without having to manually construct a
        # CompilationConfig object
641
        if isinstance(self.compilation_config, dict):
642
            self.compilation_config = CompilationConfig(**self.compilation_config)
643
644
        if isinstance(self.attention_config, dict):
            self.attention_config = AttentionConfig(**self.attention_config)
645
646
        if isinstance(self.kernel_config, dict):
            self.kernel_config = KernelConfig(**self.kernel_config)
647
        if isinstance(self.eplb_config, dict):
648
            self.eplb_config = EPLBConfig(**self.eplb_config)
649
650
651
652
        if isinstance(self.weight_transfer_config, dict):
            self.weight_transfer_config = WeightTransferConfig(
                **self.weight_transfer_config
            )
653
        # Setup plugins
654
        from vllm.plugins import load_general_plugins
655

656
        load_general_plugins()
657
        # when use hf offline,replace model and tokenizer id to local model path
658
659
660
        if huggingface_hub.constants.HF_HUB_OFFLINE:
            model_id = self.model
            self.model = get_model_path(self.model, self.revision)
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
            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,
                    )
677
678

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

682
        # Model arguments
683
684
685
686
687
        model_kwargs = get_kwargs(ModelConfig)
        model_group = parser.add_argument_group(
            title="ModelConfig",
            description=ModelConfig.__doc__,
        )
688
        if not ("serve" in sys.argv[1:] and "--help" in sys.argv[1:]):
689
            model_group.add_argument("--model", **model_kwargs["model"])
690
691
        model_group.add_argument("--runner", **model_kwargs["runner"])
        model_group.add_argument("--convert", **model_kwargs["convert"])
692
693
        model_group.add_argument("--tokenizer", **model_kwargs["tokenizer"])
        model_group.add_argument("--tokenizer-mode", **model_kwargs["tokenizer_mode"])
694
695
696
        model_group.add_argument(
            "--trust-remote-code", **model_kwargs["trust_remote_code"]
        )
697
698
        model_group.add_argument("--dtype", **model_kwargs["dtype"])
        model_group.add_argument("--seed", **model_kwargs["seed"])
699
        model_group.add_argument("--hf-config-path", **model_kwargs["hf_config_path"])
700
701
702
703
704
705
        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"]
        )
706
        model_group.add_argument("--revision", **model_kwargs["revision"])
707
        model_group.add_argument("--code-revision", **model_kwargs["code_revision"])
708
709
710
        model_group.add_argument(
            "--tokenizer-revision", **model_kwargs["tokenizer_revision"]
        )
711
712
        model_group.add_argument("--max-model-len", **model_kwargs["max_model_len"])
        model_group.add_argument("--quantization", "-q", **model_kwargs["quantization"])
713
714
715
716
        model_group.add_argument(
            "--allow-deprecated-quantization",
            **model_kwargs["allow_deprecated_quantization"],
        )
717
        model_group.add_argument("--enforce-eager", **model_kwargs["enforce_eager"])
718
719
720
721
        model_group.add_argument(
            "--enable-return-routed-experts",
            **model_kwargs["enable_return_routed_experts"],
        )
722
723
724
725
726
727
728
729
        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"]
        )
730
731
732
        model_group.add_argument(
            "--skip-tokenizer-init", **model_kwargs["skip_tokenizer_init"]
        )
733
734
735
736
737
738
739
        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"])
740
741
        # This one is a special case because it can bool
        # or str. TODO: Handle this in get_kwargs
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
        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(
            "--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"]
        )
761
        model_group.add_argument("--model-impl", **model_kwargs["model_impl"])
762
763
764
765
766
767
        model_group.add_argument(
            "--override-attention-dtype", **model_kwargs["override_attention_dtype"]
        )
        model_group.add_argument(
            "--logits-processors", **model_kwargs["logits_processors"]
        )
768
769
        model_group.add_argument(
            "--io-processor-plugin", **model_kwargs["io_processor_plugin"]
770
        )
771
772
773
774
        model_group.add_argument(
            "--renderer-num-workers",
            **model_kwargs["renderer_num_workers"],
        )
775

776
777
778
779
780
781
        # Model loading arguments
        load_kwargs = get_kwargs(LoadConfig)
        load_group = parser.add_argument_group(
            title="LoadConfig",
            description=LoadConfig.__doc__,
        )
782
        load_group.add_argument("--load-format", **load_kwargs["load_format"])
783
784
785
786
787
788
789
790
791
792
793
794
        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"]
        )
795

796
797
798
799
800
801
802
803
804
805
        # Attention arguments
        attention_kwargs = get_kwargs(AttentionConfig)
        attention_group = parser.add_argument_group(
            title="AttentionConfig",
            description=AttentionConfig.__doc__,
        )
        attention_group.add_argument(
            "--attention-backend", **attention_kwargs["backend"]
        )

806
807
808
809
810
        # Structured outputs arguments
        structured_outputs_kwargs = get_kwargs(StructuredOutputsConfig)
        structured_outputs_group = parser.add_argument_group(
            title="StructuredOutputsConfig",
            description=StructuredOutputsConfig.__doc__,
811
        )
812
        structured_outputs_group.add_argument(
813
            "--reasoning-parser",
814
            # Choices need to be validated after parsing to include plugins
815
816
            **structured_outputs_kwargs["reasoning_parser"],
        )
817
818
819
820
        structured_outputs_group.add_argument(
            "--reasoning-parser-plugin",
            **structured_outputs_kwargs["reasoning_parser_plugin"],
        )
821

822
        # Parallel arguments
823
824
825
826
827
828
        parallel_kwargs = get_kwargs(ParallelConfig)
        parallel_group = parser.add_argument_group(
            title="ParallelConfig",
            description=ParallelConfig.__doc__,
        )
        parallel_group.add_argument(
829
            "--distributed-executor-backend",
830
831
            **parallel_kwargs["distributed_executor_backend"],
        )
832
        parallel_group.add_argument(
833
834
835
836
            "--pipeline-parallel-size",
            "-pp",
            **parallel_kwargs["pipeline_parallel_size"],
        )
837
838
839
840
        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"])
841
842
843
844
        parallel_group.add_argument(
            "--distributed-timeout-seconds",
            **parallel_kwargs["distributed_timeout_seconds"],
        )
845
        parallel_group.add_argument(
846
847
            "--tensor-parallel-size", "-tp", **parallel_kwargs["tensor_parallel_size"]
        )
848
        parallel_group.add_argument(
849
850
851
852
            "--decode-context-parallel-size",
            "-dcp",
            **parallel_kwargs["decode_context_parallel_size"],
        )
853
854
855
856
        parallel_group.add_argument(
            "--dcp-comm-backend",
            **parallel_kwargs["dcp_comm_backend"],
        )
857
858
859
860
        parallel_group.add_argument(
            "--dcp-kv-cache-interleave-size",
            **parallel_kwargs["dcp_kv_cache_interleave_size"],
        )
861
862
863
864
865
866
867
868
869
        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"],
        )
870
871
872
873
874
875
        parallel_group.add_argument(
            "--data-parallel-size", "-dp", **parallel_kwargs["data_parallel_size"]
        )
        parallel_group.add_argument(
            "--data-parallel-rank",
            "-dpn",
876
            type=int,
877
878
879
            help="Data parallel rank of this instance. "
            "When set, enables external load balancer mode.",
        )
880
        parallel_group.add_argument(
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
            "--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".',
        )
911
        parallel_group.add_argument(
912
913
914
915
916
917
918
919
            "--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"],
920
921
        )
        parallel_group.add_argument(
922
923
924
            "--enable-expert-parallel",
            "-ep",
            **parallel_kwargs["enable_expert_parallel"],
925
        )
926
927
928
929
        parallel_group.add_argument(
            "--enable-ep-weight-filter",
            **parallel_kwargs["enable_ep_weight_filter"],
        )
930
931
932
        parallel_group.add_argument(
            "--all2all-backend", **parallel_kwargs["all2all_backend"]
        )
933
        parallel_group.add_argument("--enable-dbo", **parallel_kwargs["enable_dbo"])
934
935
936
937
        parallel_group.add_argument(
            "--ubatch-size",
            **parallel_kwargs["ubatch_size"],
        )
938
939
940
        parallel_group.add_argument(
            "--enable-elastic-ep", **parallel_kwargs["enable_elastic_ep"]
        )
941
942
        parallel_group.add_argument(
            "--dbo-decode-token-threshold",
943
944
            **parallel_kwargs["dbo_decode_token_threshold"],
        )
945
946
        parallel_group.add_argument(
            "--dbo-prefill-token-threshold",
947
948
            **parallel_kwargs["dbo_prefill_token_threshold"],
        )
949
950
951
952
        parallel_group.add_argument(
            "--disable-nccl-for-dp-synchronization",
            **parallel_kwargs["disable_nccl_for_dp_synchronization"],
        )
953
954
        parallel_group.add_argument("--enable-eplb", **parallel_kwargs["enable_eplb"])
        parallel_group.add_argument("--eplb-config", **parallel_kwargs["eplb_config"])
955
956
        parallel_group.add_argument(
            "--expert-placement-strategy",
957
958
            **parallel_kwargs["expert_placement_strategy"],
        )
959

960
        parallel_group.add_argument(
961
            "--max-parallel-loading-workers",
962
963
            **parallel_kwargs["max_parallel_loading_workers"],
        )
964
        parallel_group.add_argument(
965
966
            "--ray-workers-use-nsight", **parallel_kwargs["ray_workers_use_nsight"]
        )
967
        parallel_group.add_argument(
968
            "--disable-custom-all-reduce",
969
970
971
972
973
974
            **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"]
        )
975

976
977
978
979
980
        # KV cache arguments
        cache_kwargs = get_kwargs(CacheConfig)
        cache_group = parser.add_argument_group(
            title="CacheConfig",
            description=CacheConfig.__doc__,
981
        )
982
        cache_group.add_argument("--block-size", **cache_kwargs["block_size"])
983
984
985
986
987
988
989
990
991
992
993
        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"]
        )
        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(
994
995
996
997
998
            "--enable-prefix-caching",
            **{
                **cache_kwargs["enable_prefix_caching"],
                "default": None,
            },
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
        )
        cache_group.add_argument(
            "--prefix-caching-hash-algo", **cache_kwargs["prefix_caching_hash_algo"]
        )
        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"]
        )
1015
1016
1017
        cache_group.add_argument(
            "--mamba-block-size", **cache_kwargs["mamba_block_size"]
        )
1018
1019
1020
        cache_group.add_argument(
            "--mamba-cache-mode", **cache_kwargs["mamba_cache_mode"]
        )
1021
1022
1023
1024
1025
1026
        cache_group.add_argument(
            "--kv-offloading-size", **cache_kwargs["kv_offloading_size"]
        )
        cache_group.add_argument(
            "--kv-offloading-backend", **cache_kwargs["kv_offloading_backend"]
        )
1027

1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
        # Model weight offload related configs
        offload_kwargs = get_kwargs(OffloadConfig)
        uva_kwargs = get_kwargs(UVAOffloadConfig)
        prefetch_kwargs = get_kwargs(PrefetchOffloadConfig)
        offload_group = parser.add_argument_group(
            title="OffloadConfig",
            description=OffloadConfig.__doc__,
        )
        offload_group.add_argument(
            "--offload-backend", **offload_kwargs["offload_backend"]
        )
        offload_group.add_argument("--cpu-offload-gb", **uva_kwargs["cpu_offload_gb"])
        offload_group.add_argument(
            "--cpu-offload-params", **uva_kwargs["cpu_offload_params"]
        )
        offload_group.add_argument(
            "--offload-group-size",
            **prefetch_kwargs["offload_group_size"],
        )
        offload_group.add_argument(
            "--offload-num-in-group",
            **prefetch_kwargs["offload_num_in_group"],
        )
        offload_group.add_argument(
            "--offload-prefetch-step",
            **prefetch_kwargs["offload_prefetch_step"],
        )
        offload_group.add_argument(
            "--offload-params", **prefetch_kwargs["offload_params"]
        )

1059
        # Multimodal related configs
1060
1061
1062
1063
1064
        multimodal_kwargs = get_kwargs(MultiModalConfig)
        multimodal_group = parser.add_argument_group(
            title="MultiModalConfig",
            description=MultiModalConfig.__doc__,
        )
1065
1066
1067
        multimodal_group.add_argument(
            "--language-model-only", **multimodal_kwargs["language_model_only"]
        )
1068
        multimodal_group.add_argument(
1069
1070
            "--limit-mm-per-prompt", **multimodal_kwargs["limit_per_prompt"]
        )
1071
1072
1073
        multimodal_group.add_argument(
            "--enable-mm-embeds", **multimodal_kwargs["enable_mm_embeds"]
        )
1074
1075
1076
        multimodal_group.add_argument(
            "--media-io-kwargs", **multimodal_kwargs["media_io_kwargs"]
        )
1077
1078
1079
1080
1081
1082
        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"]
        )
1083
        multimodal_group.add_argument(
1084
1085
            "--mm-processor-cache-type", **multimodal_kwargs["mm_processor_cache_type"]
        )
1086
1087
        multimodal_group.add_argument(
            "--mm-shm-cache-max-object-size-mb",
1088
1089
            **multimodal_kwargs["mm_shm_cache_max_object_size_mb"],
        )
1090
1091
1092
        multimodal_group.add_argument(
            "--mm-encoder-only", **multimodal_kwargs["mm_encoder_only"]
        )
1093
        multimodal_group.add_argument(
1094
1095
            "--mm-encoder-tp-mode", **multimodal_kwargs["mm_encoder_tp_mode"]
        )
1096
1097
1098
1099
        multimodal_group.add_argument(
            "--mm-encoder-attn-backend",
            **multimodal_kwargs["mm_encoder_attn_backend"],
        )
1100
1101
1102
        multimodal_group.add_argument(
            "--interleave-mm-strings", **multimodal_kwargs["interleave_mm_strings"]
        )
1103
        multimodal_group.add_argument(
1104
1105
            "--skip-mm-profiling", **multimodal_kwargs["skip_mm_profiling"]
        )
1106

1107
        multimodal_group.add_argument(
1108
1109
            "--video-pruning-rate", **multimodal_kwargs["video_pruning_rate"]
        )
1110
1111
1112
        multimodal_group.add_argument(
            "--mm-tensor-ipc", **multimodal_kwargs["mm_tensor_ipc"]
        )
1113

1114
        # LoRA related configs
1115
1116
1117
1118
1119
1120
        lora_kwargs = get_kwargs(LoRAConfig)
        lora_group = parser.add_argument_group(
            title="LoRAConfig",
            description=LoRAConfig.__doc__,
        )
        lora_group.add_argument(
1121
            "--enable-lora",
1122
            action=argparse.BooleanOptionalAction,
1123
1124
            help="If True, enable handling of LoRA adapters.",
        )
1125
        lora_group.add_argument("--max-loras", **lora_kwargs["max_loras"])
1126
        lora_group.add_argument("--max-lora-rank", **lora_kwargs["max_lora_rank"])
1127
        lora_group.add_argument(
1128
            "--lora-dtype",
1129
1130
            **lora_kwargs["lora_dtype"],
        )
1131
1132
1133
1134
        lora_group.add_argument(
            "--enable-tower-connector-lora",
            **lora_kwargs["enable_tower_connector_lora"],
        )
1135
1136
1137
1138
        lora_group.add_argument("--max-cpu-loras", **lora_kwargs["max_cpu_loras"])
        lora_group.add_argument(
            "--fully-sharded-loras", **lora_kwargs["fully_sharded_loras"]
        )
1139
1140
1141
        lora_group.add_argument(
            "--lora-target-modules", **lora_kwargs["target_modules"]
        )
1142
        lora_group.add_argument("--default-mm-loras", **lora_kwargs["default_mm_loras"])
1143
1144
1145
        lora_group.add_argument(
            "--specialize-active-lora", **lora_kwargs["specialize_active_lora"]
        )
1146

1147
1148
1149
1150
1151
1152
1153
1154
        # 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",
1155
1156
            **observability_kwargs["show_hidden_metrics_for_version"],
        )
1157
        observability_group.add_argument(
1158
1159
            "--otlp-traces-endpoint", **observability_kwargs["otlp_traces_endpoint"]
        )
1160
1161
1162
1163
1164
        # 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"] += [
1165
            ",".join(p) for p in permutations(get_args(DetailedTraceModules), r=2)
1166
1167
1168
        ]
        observability_group.add_argument(
            "--collect-detailed-traces",
1169
1170
            **observability_kwargs["collect_detailed_traces"],
        )
1171
1172
1173
1174
1175
1176
1177
        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"],
        )
1178
1179
1180
1181
        observability_group.add_argument(
            "--cudagraph-metrics",
            **observability_kwargs["cudagraph_metrics"],
        )
1182
1183
1184
1185
        observability_group.add_argument(
            "--enable-layerwise-nvtx-tracing",
            **observability_kwargs["enable_layerwise_nvtx_tracing"],
        )
1186
1187
1188
1189
        observability_group.add_argument(
            "--enable-mfu-metrics",
            **observability_kwargs["enable_mfu_metrics"],
        )
1190
1191
1192
1193
        observability_group.add_argument(
            "--enable-logging-iteration-details",
            **observability_kwargs["enable_logging_iteration_details"],
        )
1194

1195
1196
1197
1198
1199
1200
1201
        # Scheduler arguments
        scheduler_kwargs = get_kwargs(SchedulerConfig)
        scheduler_group = parser.add_argument_group(
            title="SchedulerConfig",
            description=SchedulerConfig.__doc__,
        )
        scheduler_group.add_argument(
1202
1203
1204
1205
1206
            "--max-num-batched-tokens",
            **{
                **scheduler_kwargs["max_num_batched_tokens"],
                "default": None,
            },
1207
        )
1208
        scheduler_group.add_argument(
1209
1210
1211
1212
1213
            "--max-num-seqs",
            **{
                **scheduler_kwargs["max_num_seqs"],
                "default": None,
            },
1214
1215
1216
1217
        )
        scheduler_group.add_argument(
            "--max-num-partial-prefills", **scheduler_kwargs["max_num_partial_prefills"]
        )
1218
1219
        scheduler_group.add_argument(
            "--max-long-partial-prefills",
1220
1221
            **scheduler_kwargs["max_long_partial_prefills"],
        )
1222
1223
        scheduler_group.add_argument(
            "--long-prefill-token-threshold",
1224
1225
            **scheduler_kwargs["long_prefill_token_threshold"],
        )
1226
1227
        # multi-step scheduling has been removed; corresponding arguments
        # are no longer supported.
1228
        scheduler_group.add_argument(
1229
1230
            "--scheduling-policy", **scheduler_kwargs["policy"]
        )
1231
        scheduler_group.add_argument(
1232
1233
1234
1235
1236
            "--enable-chunked-prefill",
            **{
                **scheduler_kwargs["enable_chunked_prefill"],
                "default": None,
            },
1237
1238
1239
1240
1241
1242
1243
        )
        scheduler_group.add_argument(
            "--disable-chunked-mm-input", **scheduler_kwargs["disable_chunked_mm_input"]
        )
        scheduler_group.add_argument(
            "--scheduler-cls", **scheduler_kwargs["scheduler_cls"]
        )
1244
1245
1246
1247
        scheduler_group.add_argument(
            "--scheduler-reserve-full-isl",
            **scheduler_kwargs["scheduler_reserve_full_isl"],
        )
1248
1249
        scheduler_group.add_argument(
            "--disable-hybrid-kv-cache-manager",
1250
1251
1252
1253
1254
            **scheduler_kwargs["disable_hybrid_kv_cache_manager"],
        )
        scheduler_group.add_argument(
            "--async-scheduling", **scheduler_kwargs["async_scheduling"]
        )
1255
1256
1257
        scheduler_group.add_argument(
            "--stream-interval", **scheduler_kwargs["stream_interval"]
        )
1258

1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
        # 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_group.add_argument(
            "--max-cudagraph-capture-size",
            **compilation_kwargs["max_cudagraph_capture_size"],
        )

1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
        # Kernel arguments
        kernel_kwargs = get_kwargs(KernelConfig)
        kernel_group = parser.add_argument_group(
            title="KernelConfig",
            description=KernelConfig.__doc__,
        )
        kernel_group.add_argument(
            "--enable-flashinfer-autotune",
            **kernel_kwargs["enable_flashinfer_autotune"],
        )
1283
1284
1285
        moe_backend_kwargs = kernel_kwargs["moe_backend"]
        moe_backend_kwargs["type"] = lambda s: s.lower().replace("-", "_")
        kernel_group.add_argument("--moe-backend", **moe_backend_kwargs)
1286

1287
        # vLLM arguments
1288
        vllm_kwargs = get_kwargs(VllmConfig)
1289
1290
1291
1292
        vllm_group = parser.add_argument_group(
            title="VllmConfig",
            description=VllmConfig.__doc__,
        )
1293
1294
1295
1296
        # 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)
1297
1298
1299
1300
1301
1302
1303
        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"])
1304
1305
1306
        vllm_group.add_argument(
            "--ec-transfer-config", **vllm_kwargs["ec_transfer_config"]
        )
1307
        vllm_group.add_argument(
1308
            "--compilation-config", "-cc", **vllm_kwargs["compilation_config"]
1309
        )
1310
1311
1312
        vllm_group.add_argument(
            "--attention-config", "-ac", **vllm_kwargs["attention_config"]
        )
1313
        vllm_group.add_argument("--reasoning-config", **vllm_kwargs["reasoning_config"])
1314
        vllm_group.add_argument("--kernel-config", **vllm_kwargs["kernel_config"])
1315
1316
1317
1318
1319
1320
        vllm_group.add_argument(
            "--additional-config", **vllm_kwargs["additional_config"]
        )
        vllm_group.add_argument(
            "--structured-outputs-config", **vllm_kwargs["structured_outputs_config"]
        )
1321
        vllm_group.add_argument("--profiler-config", **vllm_kwargs["profiler_config"])
1322
1323
1324
        vllm_group.add_argument(
            "--optimization-level", **vllm_kwargs["optimization_level"]
        )
1325
        vllm_group.add_argument("--performance-mode", **vllm_kwargs["performance_mode"])
1326
1327
1328
        vllm_group.add_argument(
            "--weight-transfer-config", **vllm_kwargs["weight_transfer_config"]
        )
1329

1330
        # Other arguments
1331
1332
1333
1334
1335
        parser.add_argument(
            "--disable-log-stats",
            action="store_true",
            help="Disable logging statistics.",
        )
1336

1337
1338
1339
1340
1341
1342
        parser.add_argument(
            "--aggregate-engine-logging",
            action="store_true",
            help="Log aggregate rather than per-engine statistics "
            "when using data parallelism.",
        )
1343
1344
1345
1346
1347
1348
1349
1350

        parser.add_argument(
            "--fail-on-environ-validation",
            help="If set, the engine will raise an error if "
            "environment validation fails.",
            default=False,
            action=argparse.BooleanOptionalAction,
        )
1351
1352
1353
1354
1355
1356
1357
1358

        parser.add_argument(
            "--shutdown-timeout",
            type=int,
            default=0,
            help="Shutdown timeout in seconds. 0 = abort, >0 = wait.",
        )

1359
1360
1361
1362
1363
1364
1365
        parser.add_argument(
            "--gdn-prefill-backend",
            dest="gdn_prefill_backend",
            choices=["flashinfer", "triton"],
            default=None,
            help="Select GDN prefill backend.",
        )
1366
        return parser
1367
1368

    @classmethod
1369
    def from_cli_args(cls, args: argparse.Namespace):
1370
1371
1372
        # Get the list of attributes of this dataclass.
        attrs = [attr.name for attr in dataclasses.fields(cls)]
        # Set the attributes from the parsed arguments.
1373
1374
1375
        engine_args = cls(
            **{attr: getattr(args, attr) for attr in attrs if hasattr(args, attr)}
        )
Zhuohan Li's avatar
Zhuohan Li committed
1376
        return engine_args
1377

1378
    def create_model_config(self) -> ModelConfig:
1379
1380
        # gguf file needs a specific model loader
        if is_gguf(self.model):
1381
1382
            self.quantization = self.load_format = "gguf"

1383
1384
1385
1386
1387
1388
1389
        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,
1390
1391
            )

1392
        return ModelConfig(
1393
            model=self.model,
1394
            model_weights=self.model_weights,
1395
            hf_config_path=self.hf_config_path,
1396
1397
            runner=self.runner,
            convert=self.convert,
1398
            tokenizer=self.tokenizer,  # type: ignore[arg-type]
1399
            tokenizer_mode=self.tokenizer_mode,
1400
            trust_remote_code=self.trust_remote_code,
1401
1402
            allowed_local_media_path=self.allowed_local_media_path,
            allowed_media_domains=self.allowed_media_domains,
1403
1404
1405
1406
            dtype=self.dtype,
            seed=self.seed,
            revision=self.revision,
            code_revision=self.code_revision,
1407
            hf_token=self.hf_token,
1408
            hf_overrides=self.hf_overrides,
1409
            tokenizer_revision=self.tokenizer_revision,
1410
1411
            max_model_len=self.max_model_len,
            quantization=self.quantization,
1412
            allow_deprecated_quantization=self.allow_deprecated_quantization,
1413
            enforce_eager=self.enforce_eager,
1414
            enable_return_routed_experts=self.enable_return_routed_experts,
1415
            max_logprobs=self.max_logprobs,
1416
            logprobs_mode=self.logprobs_mode,
1417
            disable_sliding_window=self.disable_sliding_window,
1418
            disable_cascade_attn=self.disable_cascade_attn,
1419
            skip_tokenizer_init=self.skip_tokenizer_init,
1420
            enable_prompt_embeds=self.enable_prompt_embeds,
1421
            served_model_name=self.served_model_name,
1422
            language_model_only=self.language_model_only,
1423
            limit_mm_per_prompt=self.limit_mm_per_prompt,
1424
            enable_mm_embeds=self.enable_mm_embeds,
1425
            interleave_mm_strings=self.interleave_mm_strings,
1426
            media_io_kwargs=self.media_io_kwargs,
1427
            skip_mm_profiling=self.skip_mm_profiling,
1428
            config_format=self.config_format,
1429
            mm_processor_kwargs=self.mm_processor_kwargs,
1430
            mm_processor_cache_gb=self.mm_processor_cache_gb,
1431
            mm_processor_cache_type=self.mm_processor_cache_type,
1432
            mm_shm_cache_max_object_size_mb=self.mm_shm_cache_max_object_size_mb,
1433
            mm_encoder_only=self.mm_encoder_only,
1434
            mm_encoder_tp_mode=self.mm_encoder_tp_mode,
1435
            mm_encoder_attn_backend=self.mm_encoder_attn_backend,
1436
            pooler_config=self.pooler_config,
1437
            generation_config=self.generation_config,
1438
            override_generation_config=self.override_generation_config,
1439
            enable_sleep_mode=self.enable_sleep_mode,
1440
            model_impl=self.model_impl,
1441
            override_attention_dtype=self.override_attention_dtype,
1442
            logits_processors=self.logits_processors,
1443
            video_pruning_rate=self.video_pruning_rate,
1444
            mm_tensor_ipc=self.mm_tensor_ipc,
1445
            io_processor_plugin=self.io_processor_plugin,
1446
            renderer_num_workers=self.renderer_num_workers,
1447
        )
1448

1449
    def validate_tensorizer_args(self):
1450
1451
        from vllm.model_executor.model_loader.tensorizer import TensorizerConfig

1452
1453
        for key in self.model_loader_extra_config:
            if key in TensorizerConfig._fields:
1454
1455
1456
                self.model_loader_extra_config["tensorizer_config"][key] = (
                    self.model_loader_extra_config[key]
                )
1457

1458
    def create_load_config(self) -> LoadConfig:
1459
1460
        if self.quantization == "bitsandbytes":
            self.load_format = "bitsandbytes"
1461

1462
1463
1464
        if self.load_format == "tensorizer":
            if hasattr(self.model_loader_extra_config, "to_serializable"):
                self.model_loader_extra_config = (
1465
1466
                    self.model_loader_extra_config.to_serializable()
                )
1467
            self.model_loader_extra_config["tensorizer_config"] = {}
1468
1469
1470
            self.model_loader_extra_config["tensorizer_config"]["tensorizer_dir"] = (
                self.model
            )
1471
            self.validate_tensorizer_args()
1472

1473
1474
1475
        return LoadConfig(
            load_format=self.load_format,
            download_dir=self.download_dir,
1476
            safetensors_load_strategy=self.safetensors_load_strategy,
1477
1478
            model_loader_extra_config=self.model_loader_extra_config,
            ignore_patterns=self.ignore_patterns,
1479
            use_tqdm_on_load=self.use_tqdm_on_load,
1480
            pt_load_map_location=self.pt_load_map_location,
1481
        )
1482

1483
1484
1485
1486
    def create_speculative_config(
        self,
        target_model_config: ModelConfig,
        target_parallel_config: ParallelConfig,
1487
    ) -> SpeculativeConfig | None:
1488
1489
1490
1491
1492
1493
        """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
1494
        dictionary from the engine.
1495
1496
        """
        if self.speculative_config is None:
1497
            return None
1498

1499
1500
1501
        # Note(Shangming): These parameters are not obtained from the cli arg
        # '--speculative-config' and must be passed in when creating the engine
        # config.
1502
1503
1504
1505
1506
1507
        self.speculative_config.update(
            {
                "target_model_config": target_model_config,
                "target_parallel_config": target_parallel_config,
            }
        )
1508
        return SpeculativeConfig(**self.speculative_config)
1509

1510
1511
    def create_engine_config(
        self,
1512
        usage_context: UsageContext | None = None,
1513
        headless: bool = False,
1514
1515
1516
1517
    ) -> VllmConfig:
        """
        Create the VllmConfig.

1518
        NOTE: If VllmConfig is incompatible, we raise an error.
1519
        """
1520
        current_platform.pre_register_and_update()
1521

1522
        device_config = DeviceConfig(device=cast(Device, current_platform.device_type))
1523

1524
1525
        envs.validate_environ(self.fail_on_environ_validation)

1526
1527
        # Check if the model is a speculator and override model/tokenizer/config
        # BEFORE creating ModelConfig, so the config is created with the target model
1528
1529
1530
1531
        # 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):
1532
1533
1534
1535
1536
1537
1538
            (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,
1539
                    hf_token=self.hf_token,
1540
1541
1542
                )
            )

1543
        model_config = self.create_model_config()
1544
        self.model = model_config.model
1545
        self.model_weights = model_config.model_weights
1546
1547
        self.tokenizer = model_config.tokenizer

1548
        self._check_feature_supported()
1549
1550
1551
1552
        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
        )
1553

1554
        sliding_window: int | None = None
1555
1556
1557
1558
1559
1560
        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()

1561
1562
1563
1564
1565
        # Resolve "auto" kv_cache_dtype to actual value from model config
        resolved_cache_dtype = resolve_kv_cache_dtype_string(
            self.kv_cache_dtype, model_config
        )

1566
1567
1568
1569
        assert self.enable_prefix_caching is not None, (
            "enable_prefix_caching must be set by this point"
        )

1570
        cache_config = CacheConfig(
1571
            block_size=self.block_size,  # type: ignore[arg-type]
1572
            gpu_memory_utilization=self.gpu_memory_utilization,
1573
            kv_cache_memory_bytes=self.kv_cache_memory_bytes,
1574
            cache_dtype=resolved_cache_dtype,  # type: ignore[arg-type]
1575
            is_attention_free=model_config.is_attention_free,
1576
            num_gpu_blocks_override=self.num_gpu_blocks_override,
1577
            sliding_window=sliding_window,
1578
            enable_prefix_caching=self.enable_prefix_caching,
1579
            prefix_caching_hash_algo=self.prefix_caching_hash_algo,
1580
            calculate_kv_scales=self.calculate_kv_scales,
1581
            kv_sharing_fast_prefill=self.kv_sharing_fast_prefill,
1582
1583
            mamba_cache_dtype=self.mamba_cache_dtype,
            mamba_ssm_cache_dtype=self.mamba_ssm_cache_dtype,
1584
            mamba_block_size=self.mamba_block_size,
1585
            mamba_cache_mode=self.mamba_cache_mode,
1586
1587
            kv_offloading_size=self.kv_offloading_size,
            kv_offloading_backend=self.kv_offloading_backend,
1588
        )
1589

1590
1591
1592
1593
1594
1595
        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
1596

1597
            ray_runtime_env = ray.get_runtime_context().runtime_env
1598
1599
1600
1601
1602
1603
1604
            # 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)
1605

1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
        # 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()

1617
        assert not headless or not self.data_parallel_hybrid_lb, (
1618
1619
            "data_parallel_hybrid_lb is not applicable in headless mode"
        )
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
        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
        )
1661
        # Local DP rank = 1, use pure-external LB.
1662
        if data_parallel_external_lb:
1663
            assert self.data_parallel_rank is not None, (
1664
                "data_parallel_rank or node_rank must be specified if "
1665
1666
                "data_parallel_external_lb is enable."
            )
1667
            assert self.data_parallel_size_local in (1, None), (
1668
1669
                "data_parallel_size_local must be 1 or None when data_parallel_rank "
                "is set"
1670
            )
1671
            data_parallel_size_local = 1
1672
1673
            # Use full external lb if we have local_size of 1.
            self.data_parallel_hybrid_lb = False
1674
1675
        elif self.data_parallel_size_local is not None:
            data_parallel_size_local = self.data_parallel_size_local
1676
1677
1678
1679
1680
1681
1682

            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.
1683
1684
1685
1686
1687
                logger.warning(
                    "data_parallel_hybrid_lb is not eligible when "
                    "data_parallel_size_local = 1, autoswitch to "
                    "data_parallel_external_lb."
                )
1688
1689
1690
1691
1692
1693
1694
                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

1695
1696
1697
1698
1699
1700
1701
1702
1703
            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,
                )
1704
        else:
1705
            assert not self.data_parallel_hybrid_lb, (
1706
1707
                "data_parallel_size_local must be set to use data_parallel_hybrid_lb."
            )
1708

1709
1710
1711
1712
1713
1714
1715
1716
1717
            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
1718
1719
1720

        # DP address, used in multi-node case for torch distributed group
        # and ZMQ sockets.
Rui Qiao's avatar
Rui Qiao committed
1721
1722
1723
1724
        if self.data_parallel_address is None:
            if self.data_parallel_backend == "ray":
                host_ip = get_ip()
                logger.info(
1725
1726
                    "Using host IP %s as ray-based data parallel address", host_ip
                )
Rui Qiao's avatar
Rui Qiao committed
1727
1728
1729
1730
                data_parallel_address = host_ip
            else:
                assert self.data_parallel_backend == "mp", (
                    "data_parallel_backend can only be ray or mp, got %s",
1731
1732
                    self.data_parallel_backend,
                )
1733
1734
1735
                data_parallel_address = (
                    self.master_addr or ParallelConfig.data_parallel_master_ip
                )
Rui Qiao's avatar
Rui Qiao committed
1736
1737
        else:
            data_parallel_address = self.data_parallel_address
1738
1739
1740

        # This port is only used when there are remote data parallel engines,
        # otherwise the local IPC transport is used.
1741
        data_parallel_rpc_port = (
1742
            self.data_parallel_rpc_port
1743
1744
1745
            if (self.data_parallel_rpc_port is not None)
            else ParallelConfig.data_parallel_rpc_port
        )
1746

1747
1748
1749
1750
        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.")

1751
        parallel_config = ParallelConfig(
1752
1753
            pipeline_parallel_size=self.pipeline_parallel_size,
            tensor_parallel_size=self.tensor_parallel_size,
1754
            prefill_context_parallel_size=self.prefill_context_parallel_size,
1755
            data_parallel_size=self.data_parallel_size,
1756
1757
            data_parallel_rank=self.data_parallel_rank or 0,
            data_parallel_external_lb=data_parallel_external_lb,
1758
            data_parallel_size_local=data_parallel_size_local,
1759
1760
1761
1762
            master_addr=self.master_addr,
            master_port=self.master_port,
            nnodes=self.nnodes,
            node_rank=self.node_rank,
1763
            distributed_timeout_seconds=self.distributed_timeout_seconds,
1764
1765
            data_parallel_master_ip=data_parallel_address,
            data_parallel_rpc_port=data_parallel_rpc_port,
1766
            data_parallel_backend=self.data_parallel_backend,
1767
            data_parallel_hybrid_lb=self.data_parallel_hybrid_lb,
1768
            is_moe_model=model_config.is_moe,
1769
            enable_expert_parallel=self.enable_expert_parallel,
1770
            enable_ep_weight_filter=self.enable_ep_weight_filter,
1771
            all2all_backend=self.all2all_backend,
1772
            enable_elastic_ep=self.enable_elastic_ep,
1773
            enable_dbo=self.enable_dbo,
1774
            ubatch_size=self.ubatch_size,
1775
            dbo_decode_token_threshold=self.dbo_decode_token_threshold,
1776
            dbo_prefill_token_threshold=self.dbo_prefill_token_threshold,
1777
            disable_nccl_for_dp_synchronization=self.disable_nccl_for_dp_synchronization,
1778
            enable_eplb=self.enable_eplb,
1779
            eplb_config=self.eplb_config,
1780
            expert_placement_strategy=self.expert_placement_strategy,
1781
1782
1783
            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,
1784
            ray_runtime_env=ray_runtime_env,
1785
            placement_group=placement_group,
1786
1787
            distributed_executor_backend=self.distributed_executor_backend,
            worker_cls=self.worker_cls,
1788
            worker_extension_cls=self.worker_extension_cls,
1789
            decode_context_parallel_size=self.decode_context_parallel_size,
1790
            dcp_comm_backend=self.dcp_comm_backend,
1791
            dcp_kv_cache_interleave_size=self.dcp_kv_cache_interleave_size,
1792
            cp_kv_cache_interleave_size=self.cp_kv_cache_interleave_size,
1793
1794
            _api_process_count=self._api_process_count,
            _api_process_rank=self._api_process_rank,
1795
        )
1796

1797
        speculative_config = self.create_speculative_config(
1798
1799
1800
1801
            target_model_config=model_config,
            target_parallel_config=parallel_config,
        )

1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
        assert self.max_num_batched_tokens is not None, (
            "max_num_batched_tokens must be set by this point"
        )
        assert self.max_num_seqs is not None, "max_num_seqs must be set by this point"
        assert self.enable_chunked_prefill is not None, (
            "enable_chunked_prefill must be set by this point"
        )
        assert model_config.max_model_len is not None, (
            "max_model_len must be set by this point"
        )
1812
        scheduler_config = SchedulerConfig(
1813
            runner_type=model_config.runner_type,
1814
1815
1816
            max_num_batched_tokens=self.max_num_batched_tokens,
            max_num_seqs=self.max_num_seqs,
            max_model_len=model_config.max_model_len,
1817
            enable_chunked_prefill=self.enable_chunked_prefill,
1818
            disable_chunked_mm_input=self.disable_chunked_mm_input,
1819
            is_multimodal_model=model_config.is_multimodal_model,
1820
            is_encoder_decoder=model_config.is_encoder_decoder,
1821
            policy=self.scheduling_policy,
1822
            scheduler_cls=self.scheduler_cls,
1823
1824
1825
            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,
1826
            scheduler_reserve_full_isl=self.scheduler_reserve_full_isl,
1827
            disable_hybrid_kv_cache_manager=self.disable_hybrid_kv_cache_manager,
1828
            async_scheduling=self.async_scheduling,
1829
            stream_interval=self.stream_interval,
1830
        )
1831

1832
1833
1834
        if not model_config.is_multimodal_model and self.default_mm_loras:
            raise ValueError(
                "Default modality-specific LoRA(s) were provided for a "
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
                "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,
1845
                target_modules=self.lora_target_modules,
1846
                enable_tower_connector_lora=self.enable_tower_connector_lora,
1847
                specialize_active_lora=self.specialize_active_lora,
1848
1849
1850
1851
1852
1853
1854
                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
        )
1855

1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
        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"
            )

1870
1871
1872
1873
        # bitsandbytes pre-quantized model need a specific model loader
        if model_config.quantization == "bitsandbytes":
            self.quantization = self.load_format = "bitsandbytes"

1874
1875
1876
1877
1878
1879
1880
1881
        # Attention config overrides
        attention_config = copy.deepcopy(self.attention_config)
        if self.attention_backend is not None:
            if attention_config.backend is not None:
                raise ValueError(
                    "attention_backend and attention_config.backend "
                    "are mutually exclusive"
                )
1882
1883
1884
1885
            # Reuse the validator to handle "auto" and string-to-enum conversion
            attention_config.backend = AttentionConfig.validate_backend_before(
                self.attention_backend
            )
1886

1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
        # Kernel config overrides
        kernel_config = copy.deepcopy(self.kernel_config)
        if self.enable_flashinfer_autotune is not None:
            if kernel_config.enable_flashinfer_autotune is not None:
                raise ValueError(
                    "enable_flashinfer_autotune and "
                    "kernel_config.enable_flashinfer_autotune "
                    "are mutually exclusive"
                )
            kernel_config.enable_flashinfer_autotune = self.enable_flashinfer_autotune
1897
1898
        if self.moe_backend != "auto":
            kernel_config.moe_backend = self.moe_backend
1899

1900
        load_config = self.create_load_config()
1901

1902
1903
        # Pass reasoning_parser into StructuredOutputsConfig
        if self.reasoning_parser:
1904
            self.structured_outputs_config.reasoning_parser = self.reasoning_parser
1905

1906
1907
1908
1909
1910
        if self.reasoning_parser_plugin:
            self.structured_outputs_config.reasoning_parser_plugin = (
                self.reasoning_parser_plugin
            )

1911
        observability_config = ObservabilityConfig(
1912
            show_hidden_metrics_for_version=self.show_hidden_metrics_for_version,
1913
            otlp_traces_endpoint=self.otlp_traces_endpoint,
1914
            collect_detailed_traces=self.collect_detailed_traces,
1915
1916
            kv_cache_metrics=self.kv_cache_metrics,
            kv_cache_metrics_sample=self.kv_cache_metrics_sample,
1917
            cudagraph_metrics=self.cudagraph_metrics,
1918
            enable_layerwise_nvtx_tracing=self.enable_layerwise_nvtx_tracing,
1919
            enable_mfu_metrics=self.enable_mfu_metrics,
1920
            enable_mm_processor_stats=self.enable_mm_processor_stats,
1921
            enable_logging_iteration_details=self.enable_logging_iteration_details,
1922
        )
1923

1924
        # Compilation config overrides
1925
        compilation_config = copy.deepcopy(self.compilation_config)
1926
        if self.cudagraph_capture_sizes is not None:
1927
            if compilation_config.cudagraph_capture_sizes is not None:
1928
1929
1930
1931
                raise ValueError(
                    "cudagraph_capture_sizes and compilation_config."
                    "cudagraph_capture_sizes are mutually exclusive"
                )
1932
            compilation_config.cudagraph_capture_sizes = self.cudagraph_capture_sizes
1933
        if self.max_cudagraph_capture_size is not None:
1934
            if compilation_config.max_cudagraph_capture_size is not None:
1935
1936
1937
1938
                raise ValueError(
                    "max_cudagraph_capture_size and compilation_config."
                    "max_cudagraph_capture_size are mutually exclusive"
                )
1939
            compilation_config.max_cudagraph_capture_size = (
1940
1941
                self.max_cudagraph_capture_size
            )
1942
1943

        offload_config = OffloadConfig(
1944
            offload_backend=self.offload_backend,
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
            uva=UVAOffloadConfig(
                cpu_offload_gb=self.cpu_offload_gb,
                cpu_offload_params=self.cpu_offload_params,
            ),
            prefetch=PrefetchOffloadConfig(
                offload_group_size=self.offload_group_size,
                offload_num_in_group=self.offload_num_in_group,
                offload_prefetch_step=self.offload_prefetch_step,
                offload_params=self.offload_params,
            ),
        )

1957
1958
1959
        if self.gdn_prefill_backend is not None:
            self.additional_config["gdn_prefill_backend"] = self.gdn_prefill_backend

1960
        config = VllmConfig(
1961
1962
1963
1964
1965
            model_config=model_config,
            cache_config=cache_config,
            parallel_config=parallel_config,
            scheduler_config=scheduler_config,
            device_config=device_config,
1966
            load_config=load_config,
1967
            offload_config=offload_config,
1968
            attention_config=attention_config,
1969
            kernel_config=kernel_config,
1970
1971
            lora_config=lora_config,
            speculative_config=speculative_config,
1972
            structured_outputs_config=self.structured_outputs_config,
1973
            observability_config=observability_config,
1974
            compilation_config=compilation_config,
1975
            kv_transfer_config=self.kv_transfer_config,
1976
            kv_events_config=self.kv_events_config,
1977
            ec_transfer_config=self.ec_transfer_config,
1978
            reasoning_config=self.reasoning_config,
1979
            profiler_config=self.profiler_config,
1980
            additional_config=self.additional_config,
1981
            optimization_level=self.optimization_level,
1982
            performance_mode=self.performance_mode,
1983
            weight_transfer_config=self.weight_transfer_config,
1984
            shutdown_timeout=self.shutdown_timeout,
1985
        )
1986

1987
1988
        return config

1989
    def _check_feature_supported(self):
1990
        """Raise an error if the feature is not supported."""
1991
        # No Concurrent Partial Prefills so far.
1992
1993
1994
1995
1996
        if (
            self.max_num_partial_prefills != SchedulerConfig.max_num_partial_prefills
            or self.max_long_partial_prefills
            != SchedulerConfig.max_long_partial_prefills
        ):
1997
            _raise_unsupported_error(feature_name="Concurrent Partial Prefill")
1998

1999
        if self.pipeline_parallel_size > 1:
2000
2001
2002
            supports_pp = getattr(
                self.distributed_executor_backend, "supports_pp", False
            )
2003
            if not supports_pp and self.distributed_executor_backend not in (
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
                ParallelConfig.distributed_executor_backend,
                "ray",
                "mp",
                "external_launcher",
            ):
                name = (
                    "Pipeline Parallelism without Ray distributed "
                    "executor or multiprocessing executor or external "
                    "launcher"
                )
2014
                _raise_unsupported_error(feature_name=name)
2015

2016
2017
2018
2019
2020
2021
    @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
2022

2023
2024
        default_max_num_batched_tokens: dict[UsageContext | None, int]
        default_max_num_seqs: dict[UsageContext | None, int]
2025

2026
2027
        # When no user override, set the default values based on the usage
        # context.
2028
        # Use different default values for different hardware.
2029
2030
2031
2032
2033
2034
2035

        # 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:
2036
            device_memory = current_platform.get_device_total_memory()
2037
            device_name = current_platform.get_device_name().lower()
2038
2039
        except Exception:
            # This is only used to set default_max_num_batched_tokens
2040
            device_memory = 0
2041
            device_name = ""
2042

2043
2044
2045
2046
        # 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:
2047
            # For GPUs like H100 and MI300x, use larger default values.
2048
2049
2050
2051
            default_max_num_batched_tokens = {
                UsageContext.LLM_CLASS: 16384,
                UsageContext.OPENAI_API_SERVER: 8192,
            }
2052
2053
2054
2055
            default_max_num_seqs = {
                UsageContext.LLM_CLASS: 1024,
                UsageContext.OPENAI_API_SERVER: 1024,
            }
2056
2057
2058
2059
2060
2061
        else:
            # TODO(woosuk): Tune the default values for other hardware.
            default_max_num_batched_tokens = {
                UsageContext.LLM_CLASS: 8192,
                UsageContext.OPENAI_API_SERVER: 2048,
            }
2062
2063
2064
2065
            default_max_num_seqs = {
                UsageContext.LLM_CLASS: 256,
                UsageContext.OPENAI_API_SERVER: 256,
            }
2066

2067
2068
        # tpu specific default values.
        if current_platform.is_tpu():
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
            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,
                }
2086

2087
2088
2089
        # cpu specific default values.
        if current_platform.is_cpu():
            default_max_num_batched_tokens = {
2090
2091
                UsageContext.LLM_CLASS: 4096 * world_size,
                UsageContext.OPENAI_API_SERVER: 2048 * world_size,
2092
2093
            }
            default_max_num_seqs = {
2094
2095
                UsageContext.LLM_CLASS: 256 * world_size,
                UsageContext.OPENAI_API_SERVER: 128 * world_size,
2096
2097
            }

2098
2099
        return default_max_num_batched_tokens, default_max_num_seqs

2100
2101
    def _set_default_chunked_prefill_and_prefix_caching_args(
        self, model_config: ModelConfig
2102
    ) -> None:
2103
2104
        default_chunked_prefill = model_config.is_chunked_prefill_supported
        default_prefix_caching = model_config.is_prefix_caching_supported
2105
2106
2107
2108
2109
2110
2111
2112

        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",
            )
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
        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",
            )
2124
2125
2126
2127
        elif (
            model_config.runner_type == "pooling"
            and self.enable_chunked_prefill
            and not default_chunked_prefill
2128
        ):
2129
            logger.warning_once(
2130
2131
2132
                "This model does not officially support chunked prefill. "
                "Enabling this manually may cause the engine to crash "
                "or produce incorrect outputs.",
2133
                scope="local",
2134
2135
2136
2137
2138
            )

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

2139
            logger.debug(
2140
2141
2142
2143
2144
2145
2146
2147
                "%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
        ):
2148
            logger.warning_once(
2149
2150
2151
                "This model does not officially support prefix caching. "
                "Enabling this manually may cause the engine to crash "
                "or produce incorrect outputs.",
2152
                scope="local",
2153
2154
            )

2155
        # Disable chunked prefill and prefix caching for:
2156
        # RISCV CPUs in V1
2157
2158
2159
2160
        if current_platform.is_cpu() and current_platform.get_cpu_architecture() in (
            CpuArchEnum.RISCV,
        ):
            logger.info(
2161
2162
                "Chunked prefill is not supported for"
                "RISC-V CPUs; "
2163
2164
2165
2166
                "disabling it for V1 backend."
            )
            self.enable_chunked_prefill = False
            logger.info(
2167
2168
                "Prefix caching is not supported for "
                "RISC-V CPUs; "
2169
2170
2171
2172
2173
                "disabling it for V1 backend."
            )
            self.enable_prefix_caching = False

    def _set_default_max_num_seqs_and_batched_tokens_args(
2174
2175
2176
        self,
        usage_context: UsageContext | None,
        model_config: ModelConfig,
2177
    ):
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
        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,
            )

2199
2200
2201
2202
2203
2204
2205
        # If throughput mode is set, double max_num_batched_tokens and max_num_seqs.
        if self.performance_mode == "throughput":
            if orig_max_num_batched_tokens is None:
                self.max_num_batched_tokens *= 2
            if orig_max_num_seqs is None:
                self.max_num_seqs *= 2

2206
        if orig_max_num_batched_tokens is None:
2207
2208
2209
            assert model_config.max_model_len is not None, (
                "max_model_len must be set by this point"
            )
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
            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,
2222
2223
                self.max_num_batched_tokens,
            )
2224

2225
2226
2227
2228
            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,
2229
            )
2230

2231
2232
2233
2234
        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)

2235
            logger.debug(
2236
                "Defaulting max_num_seqs to %d for %s usage context.",
2237
                self.max_num_seqs,
2238
                usage_context.value if usage_context else None,
2239
            )
2240

2241

2242
@dataclass
Zhuohan Li's avatar
Zhuohan Li committed
2243
class AsyncEngineArgs(EngineArgs):
Woosuk Kwon's avatar
Woosuk Kwon committed
2244
    """Arguments for asynchronous vLLM engine."""
2245

2246
2247
    enable_log_requests: bool = False

2248
    @staticmethod
2249
2250
2251
    def add_cli_args(
        parser: FlexibleArgumentParser, async_args_only: bool = False
    ) -> FlexibleArgumentParser:
2252
        # Initialize plugin to update the parser, for example, The plugin may
2253
        # add a new kind of quantization method to --quantization argument or
2254
2255
        # a new device to --device argument.
        load_general_plugins()
2256
2257
        if not async_args_only:
            parser = EngineArgs.add_cli_args(parser)
2258
2259
2260
2261
        parser.add_argument(
            "--enable-log-requests",
            action=argparse.BooleanOptionalAction,
            default=AsyncEngineArgs.enable_log_requests,
2262
            help="Enable logging request information, dependent on log level:\n"
2263
2264
2265
            "- INFO: Request ID, parameters and LoRA request.\n"
            "- DEBUG: Prompt inputs (e.g: text, token IDs).\n"
            "You can set the minimum log level via `VLLM_LOGGING_LEVEL`.",
2266
        )
2267
        current_platform.pre_register_and_update(parser)
2268
        return parser
2269
2270


2271
2272
2273
2274
2275
2276
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)
2277
2278


2279
def human_readable_int(value: str) -> int:
2280
2281
    """Parse human-readable integers like '1k', '2M', etc.
    Including decimal values with decimal multipliers.
2282

2283
2284
2285
2286
2287
2288
    Examples:
    - '1k' -> 1,000
    - '1K' -> 1,024
    - '25.6k' -> 25,600
    """
    value = value.strip()
2289

2290
    match = re.fullmatch(r"(\d+(?:\.\d+)?)([kKmMgGtT])", value)
2291
2292
    if match:
        decimal_multiplier = {
2293
2294
2295
            "k": 10**3,
            "m": 10**6,
            "g": 10**9,
2296
            "t": 10**12,
2297
2298
        }
        binary_multiplier = {
2299
2300
2301
            "K": 2**10,
            "M": 2**20,
            "G": 2**30,
2302
            "T": 2**40,
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
        }

        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:
2315
2316
2317
2318
2319
                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
2320
2321
2322

    # Regular plain number.
    return int(value)
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341


def human_readable_int_or_auto(value: str) -> int:
    """Parse human-readable integers like '1k', '2M', etc.
    Including decimal values with decimal multipliers.
    Also accepts -1 or 'auto' as a special value for auto-detection.

    Examples:
    - '1k' -> 1,000
    - '1K' -> 1,024
    - '25.6k' -> 25,600
    - '-1' or 'auto' -> -1 (special value for auto-detection)
    """
    value = value.strip()

    if value == "-1" or value.lower() == "auto":
        return -1

    return human_readable_int(value)