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

zhuwenwen's avatar
zhuwenwen committed
4
import os
5
import ast
6
import copy
7
import enum
8
import hashlib
9
import inspect
10
import json
11
import textwrap
Robert Shaw's avatar
Robert Shaw committed
12
import uuid
13
import warnings
14
from collections import Counter
15
from contextlib import contextmanager
16
from dataclasses import (MISSING, Field, asdict, field, fields, is_dataclass,
17
                         replace)
18
from functools import cached_property
19
from importlib.util import find_spec
20

zhuwenwen's avatar
zhuwenwen committed
21
from typing import (TYPE_CHECKING, Any, Callable, ClassVar, Literal, Optional, List,
22
                    Protocol, TypeVar, Union, cast, get_args)
23

24
import regex as re
25
import torch
26
27
28
from pydantic import (ConfigDict, SkipValidation, TypeAdapter, field_validator,
                      model_validator)
from pydantic.dataclasses import dataclass
29
from safetensors.torch import _TYPES as _SAFETENSORS_TO_TORCH_DTYPE
30
from torch.distributed import ProcessGroup, ReduceOp
31
from typing_extensions import Self, runtime_checkable
32

33
import vllm.envs as envs
34
from vllm import version
35
from vllm.compilation.inductor_pass import CallableInductorPass, InductorPass
Woosuk Kwon's avatar
Woosuk Kwon committed
36
from vllm.logger import init_logger
37
from vllm.model_executor.layers.quantization import QuantizationMethods
38
from vllm.platforms import current_platform
39
40
41
from vllm.transformers_utils.config import (
    ConfigFormat, get_config, get_hf_image_processor_config,
    get_hf_text_config, get_pooling_config,
42
    get_sentence_transformer_tokenizer_config, is_encoder_decoder,
43
44
    try_get_generation_config, try_get_safetensors_metadata,
    try_get_tokenizer_config, uses_mrope)
45
from vllm.transformers_utils.s3_utils import S3Model
46
from vllm.transformers_utils.utils import is_s3, maybe_model_redirect
zhuwenwen's avatar
zhuwenwen committed
47

48
49
# yapf conflicts with isort for this block
# yapf: disable
50
51
52
from vllm.utils import (DEFAULT_MAX_NUM_BATCHED_TOKENS,
                        MULTIMODAL_MODEL_MAX_NUM_BATCHED_TOKENS,
                        POOLING_MODEL_MAX_NUM_BATCHED_TOKENS, GiB_bytes,
53
                        LayerBlockType, LazyLoader, common_broadcastable_dtype,
54
55
56
                        cuda_device_count_stateless, get_cpu_memory,
                        get_open_port, is_torch_equal_or_newer, random_uuid,
                        resolve_obj_by_qualname)
zhuwenwen's avatar
zhuwenwen committed
57
from vllm.utils import SUPPORT_TC
58

59
60
# yapf: enable

61
if TYPE_CHECKING:
62
    from _typeshed import DataclassInstance
63
    from ray.util.placement_group import PlacementGroup
64
    from transformers.configuration_utils import PretrainedConfig
65

66
67
    import vllm.model_executor.layers.quantization as me_quant
    import vllm.model_executor.models as me_models
68
    from vllm.executor.executor_base import ExecutorBase
69
    from vllm.model_executor.layers.quantization import QuantizationMethods
70
71
    from vllm.model_executor.layers.quantization.base_config import (
        QuantizationConfig)
72
    from vllm.model_executor.model_loader import BaseModelLoader
73
    from vllm.model_executor.model_loader.tensorizer import TensorizerConfig
74

75
    ConfigType = type[DataclassInstance]
76
    HfOverrides = Union[dict, Callable[[type], type]]
77
else:
78
    DataclassInstance = Any
79
    PlacementGroup = Any
80
    PretrainedConfig = Any
81
    ExecutorBase = Any
82
    QuantizationConfig = Any
83
    QuantizationMethods = Any
84
85
    BaseModelLoader = Any
    TensorizerConfig = Any
86
    ConfigType = type
87
88
89
90
91
92
    HfOverrides = Union[dict[str, Any], Callable[[type], type]]

    me_quant = LazyLoader("model_executor", globals(),
                          "vllm.model_executor.layers.quantization")
    me_models = LazyLoader("model_executor", globals(),
                           "vllm.model_executor.models")
93

94
95
logger = init_logger(__name__)

zhuwenwen's avatar
zhuwenwen committed
96
models_path_prefix = os.getenv('VLLM_OPTEST_MODELS_PATH') or os.getenv("OPTEST_MODELS_PATH")
97

98
DataclassInstanceT = TypeVar("DataclassInstanceT", bound=DataclassInstance)
99
ConfigT = TypeVar("ConfigT", bound=ConfigType)
100

101
TaskOption = Literal["auto", "generate", "embedding", "embed", "classify",
102
                     "score", "reward", "transcription", "draft"]
103

104
_ResolvedTask = Literal["generate", "transcription", "encode", "embed",
105
                        "classify", "reward", "draft"]
106

107
RunnerOption = Literal["auto", "generate", "pooling", "draft"]
108

109
RunnerType = Literal["generate", "pooling", "draft"]
110

111
112
_RUNNER_TASKS: dict[RunnerType, list[_ResolvedTask]] = {
    "generate": ["generate", "transcription"],
113
    "pooling": ["encode", "embed", "classify", "reward"],
114
    "draft": [],
115
}
116

117

118
@runtime_checkable
119
120
121
122
123
124
class SupportsHash(Protocol):

    def compute_hash(self) -> str:
        ...


125
126
class SupportsMetricsInfo(Protocol):

127
    def metrics_info(self) -> dict[str, str]:
128
129
130
        ...


131
132
133
134
135
136
class ModelImpl(str, enum.Enum):
    AUTO = "auto"
    VLLM = "vllm"
    TRANSFORMERS = "transformers"


137
138
139
140
141
142
143
144
145
146
def get_attr_docs(cls: type[Any]) -> dict[str, str]:
    """
    Get any docstrings placed after attribute assignments in a class body.

    https://davidism.com/mit-license/
    """

    def pairwise(iterable):
        """
        Manually implement https://docs.python.org/3/library/itertools.html#itertools.pairwise
147

148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
        Can be removed when Python 3.9 support is dropped.
        """
        iterator = iter(iterable)
        a = next(iterator, None)

        for b in iterator:
            yield a, b
            a = b

    cls_node = ast.parse(textwrap.dedent(inspect.getsource(cls))).body[0]

    if not isinstance(cls_node, ast.ClassDef):
        raise TypeError("Given object was not a class.")

    out = {}

    # Consider each pair of nodes.
    for a, b in pairwise(cls_node.body):
        # Must be an assignment then a constant string.
        if (not isinstance(a, (ast.Assign, ast.AnnAssign))
                or not isinstance(b, ast.Expr)
                or not isinstance(b.value, ast.Constant)
                or not isinstance(b.value.value, str)):
            continue

        doc = inspect.cleandoc(b.value.value)

        # An assignment can have multiple targets (a = b = v), but an
        # annotated assignment only has one target.
        targets = a.targets if isinstance(a, ast.Assign) else [a.target]

        for target in targets:
            # Must be assigning to a plain name.
            if not isinstance(target, ast.Name):
                continue

            out[target.id] = doc

    return out


189
def config(cls: ConfigT) -> ConfigT:
190
191
192
    """
    A decorator that ensures all fields in a dataclass have default values
    and that each field has a docstring.
193
194
195
196
197
198

    If a `ConfigT` is used as a CLI argument itself, the default value provided
    by `get_kwargs` will be the result parsing a JSON string as the kwargs
    (i.e. `ConfigT(**json.loads(cli_arg))`). However, if a particular `ConfigT`
    requires custom construction from CLI (i.e. `CompilationConfig`), it can
    have a `from_cli` method, which will be called instead.
199

200
201
202
    Config validation is performed by the tools/validate_config.py
    script, which is invoked during the pre-commit checks.
    """
203
204
205
    return cls


206
def get_field(cls: ConfigType, name: str) -> Field:
207
208
209
210
211
212
213
    """Get the default factory field of a dataclass by name. Used for getting
    default factory fields in `EngineArgs`."""
    if not is_dataclass(cls):
        raise TypeError("The given class is not a dataclass.")
    cls_fields = {f.name: f for f in fields(cls)}
    if name not in cls_fields:
        raise ValueError(f"Field '{name}' not found in {cls.__name__}.")
214
    named_field: Field = cls_fields[name]
215
216
217
218
219
220
221
222
    if (default_factory := named_field.default_factory) is not MISSING:
        return field(default_factory=default_factory)
    if (default := named_field.default) is not MISSING:
        return field(default=default)
    raise ValueError(
        f"{cls.__name__}.{name} must have a default value or default factory.")


223
224
def is_init_field(cls: ConfigType, name: str) -> bool:
    return next(f for f in fields(cls) if f.name == name).init
225

226

zhuwenwen's avatar
zhuwenwen committed
227
TokenizerMode = Literal["auto", "cpm", "slow", "mistral", "custom"]
228
ModelDType = Literal["auto", "half", "float16", "bfloat16", "float", "float32"]
229
230
LogprobsMode = Literal["raw_logprobs", "raw_logits", "processed_logprobs",
                       "processed_logits"]
231
232
233


@config
234
@dataclass(config=ConfigDict(arbitrary_types_allowed=True))
235
class ModelConfig:
236
    """Configuration for the model."""
237
238
    
    model: str = os.path.join(models_path_prefix, "Qwen/Qwen3-0.6B") if models_path_prefix is not None else "Qwen/Qwen3-0.6B"
239
240
241
    """Name or path of the Hugging Face model to use. It is also used as the
    content for `model_name` tag in metrics output when `served_model_name` is
    not specified."""
242
243
244
245
246
247
248
249
    runner: RunnerOption = "auto"
    """The type of model runner to use. Each vLLM instance only supports one
    model runner, even if the same model can be used for multiple types."""
    task: TaskOption = "auto"
    """The task to use the model for. If the model supports more than one
    model runner, this is used to select which model runner to run.

    Note that the model may support other tasks using the same model runner."""
250
    tokenizer: SkipValidation[str] = None  # type: ignore
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
    """Name or path of the Hugging Face tokenizer to use. If unspecified, model
    name or path will be used."""
    tokenizer_mode: TokenizerMode = "auto"
    """Tokenizer mode:\n
    - "auto" will use the fast tokenizer if available.\n
    - "slow" will always use the slow tokenizer.\n
    - "mistral" will always use the tokenizer from `mistral_common`.\n
    - "custom" will use --tokenizer to select the preregistered tokenizer."""
    trust_remote_code: bool = False
    """Trust remote code (e.g., from HuggingFace) when downloading the model
    and tokenizer."""
    dtype: Union[ModelDType, torch.dtype] = "auto"
    """Data type for model weights and activations:\n
    - "auto" will use FP16 precision for FP32 and FP16 models, and BF16
    precision for BF16 models.\n
    - "half" for FP16. Recommended for AWQ quantization.\n
    - "float16" is the same as "half".\n
    - "bfloat16" for a balance between precision and range.\n
    - "float" is shorthand for FP32 precision.\n
    - "float32" for FP32 precision."""
    seed: Optional[int] = None
272
273
    """Random seed for reproducibility. Initialized to None in V0, but
    initialized to 0 in V1."""
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
    hf_config_path: Optional[str] = None
    """Name or path of the Hugging Face config to use. If unspecified, model
    name or path will be used."""
    allowed_local_media_path: str = ""
    """Allowing API requests to read local images or videos from directories
    specified by the server file system. This is a security risk. Should only
    be enabled in trusted environments."""
    revision: Optional[str] = None
    """The specific model version to use. It can be a branch name, a tag name,
    or a commit id. If unspecified, will use the default version."""
    code_revision: Optional[str] = None
    """The specific revision to use for the model code on the Hugging Face Hub.
    It can be a branch name, a tag name, or a commit id. If unspecified, will
    use the default version."""
    rope_scaling: dict[str, Any] = field(default_factory=dict)
289
    """RoPE scaling configuration. For example,
290
291
292
293
294
295
296
297
    `{"rope_type":"dynamic","factor":2.0}`."""
    rope_theta: Optional[float] = None
    """RoPE theta. Use with `rope_scaling`. In some cases, changing the RoPE
    theta improves the performance of the scaled model."""
    tokenizer_revision: Optional[str] = None
    """The specific revision to use for the tokenizer on the Hugging Face Hub.
    It can be a branch name, a tag name, or a commit id. If unspecified, will
    use the default version."""
298
    max_model_len: SkipValidation[int] = None  # type: ignore
299
300
    """Model context length (prompt and output). If unspecified, will be
    automatically derived from the model config.
301

302
303
304
305
306
307
    When passing via `--max-model-len`, supports k/m/g/K/M/G in human-readable
    format. Examples:\n
    - 1k -> 1000\n
    - 1K -> 1024\n
    - 25.6k -> 25,600"""
    spec_target_max_model_len: Optional[int] = None
omahs's avatar
omahs committed
308
    """Specify the maximum length for spec decoding draft models."""
309
    quantization: SkipValidation[Optional[QuantizationMethods]] = None
310
311
312
313
314
315
316
317
318
    """Method used to quantize the weights. If `None`, we first check the
    `quantization_config` attribute in the model config file. If that is
    `None`, we assume the model weights are not quantized and use `dtype` to
    determine the data type of the weights."""
    enforce_eager: bool = False
    """Whether to always use eager-mode PyTorch. If True, we will disable CUDA
    graph and always execute the model in eager mode. If False, we will use
    CUDA graph and eager execution in hybrid for maximal performance and
    flexibility."""
319
    max_seq_len_to_capture: Optional[int] = None # 8192
320
321
322
323
324
325
326
327
    """Maximum sequence len covered by CUDA graphs. When a sequence has context
    length larger than this, we fall back to eager mode. Additionally for
    encoder-decoder models, if the sequence length of the encoder input is
    larger than this, we fall back to the eager mode."""
    max_logprobs: int = 20
    """Maximum number of log probabilities to return when `logprobs` is
    specified in `SamplingParams`. The default value comes the default for the
    OpenAI Chat Completions API."""
328
329
330
331
332
333
334
    logprobs_mode: LogprobsMode = "raw_logprobs"
    """Indicates the content returned in the logprobs and prompt_logprobs.
    Supported mode:
    1) raw_logprobs, 2) processed_logprobs, 3) raw_logits, 4) processed_logits.
    Raw means the values before applying logit processors, like bad words.
    Processed means the values after applying such processors.
    """
335
336
337
338
339
340
341
342
343
344
345
346
347
348
    disable_sliding_window: bool = False
    """Whether to disable sliding window. If True, we will disable the sliding
    window functionality of the model, capping to sliding window size. If the
    model does not support sliding window, this argument is ignored."""
    disable_cascade_attn: bool = False
    """Disable cascade attention for V1. While cascade attention does not
    change the mathematical correctness, disabling it could be useful for
    preventing potential numerical issues. Note that even if this is set to
    False, cascade attention will be only used when the heuristic tells that
    it's beneficial."""
    skip_tokenizer_init: bool = False
    """Skip initialization of tokenizer and detokenizer. Expects valid
    `prompt_token_ids` and `None` for prompt from the input. The generated
    output will contain token ids."""
349
350
351
352
    enable_prompt_embeds: bool = False
    """If `True`, enables passing text embeddings as inputs via the
    `prompt_embeds` key. Note that enabling this will double the time required
    for graph compilation."""
353
354
355
356
357
358
359
360
361
362
363
    served_model_name: Optional[Union[str, list[str]]] = None
    """The model name(s) used in the API. If multiple names are provided, the
    server will respond to any of the provided names. The model name in the
    model field of a response will be the first name in this list. If not
    specified, the model name will be the same as the `--model` argument. Noted
    that this name(s) will also be used in `model_name` tag content of
    prometheus metrics, if multiple names provided, metrics tag will take the
    first one."""
    limit_mm_per_prompt: dict[str, int] = field(default_factory=dict)
    """Maximum number of data items per modality per prompt. Only applicable
    for multimodal models."""
364
    interleave_mm_strings: bool = False
365
    """Enable fully interleaved support for multimodal prompts, while using
366
    --chat-template-content-format=string. Defaults to False."""
367
    media_io_kwargs: dict[str, dict[str, Any]] = field(default_factory=dict)
368
369
    """Additional args passed to process media inputs, keyed by modalities.
    For example, to set num_frames for video, set
370
    `--media-io-kwargs '{"video": {"num_frames": 40} }'` """
371
372
373
374
375
376
377
378
379
380
381
382
383
384
    use_async_output_proc: bool = True
    """Whether to use async output processor."""
    config_format: Union[str, ConfigFormat] = ConfigFormat.AUTO.value
    """The format of the model config to load:\n
    - "auto" will try to load the config in hf format if available else it
    will try to load in mistral format.\n
    - "hf" will load the config in hf format.\n
    - "mistral" will load the config in mistral format."""
    hf_token: Optional[Union[bool, str]] = None
    """The token to use as HTTP bearer authorization for remote files . If
    `True`, will use the token generated when running `huggingface-cli login`
    (stored in `~/.huggingface`)."""
    hf_overrides: HfOverrides = field(default_factory=dict)
    """If a dictionary, contains arguments to be forwarded to the Hugging Face
385
    config. If a callable, it is called to update the HuggingFace config."""
386
387
388
389
390
    mm_processor_kwargs: Optional[dict[str, Any]] = None
    """Arguments to be forwarded to the model's processor for multi-modal data,
    e.g., image processor. Overrides for the multi-modal processor obtained
    from `AutoProcessor.from_pretrained`. The available overrides depend on the
    model that is being run. For example, for Phi-3-Vision: `{"num_crops": 4}`.
391
    """
392
393
394
395
396
397
398
    disable_mm_preprocessor_cache: bool = False
    """If `True`, disable caching of the multi-modal preprocessor/mapper (not
    recommended)."""
    override_neuron_config: dict[str, Any] = field(default_factory=dict)
    """Initialize non-default neuron config or override default neuron config
    that are specific to Neuron devices, this argument will be used to
    configure the neuron config that can not be gathered from the vllm
399
    arguments. e.g. `{"cast_logits_dtype": "bfloat16"}`."""
400
401
402
403
404
405
    pooler_config: Optional["PoolerConfig"] = field(init=False)
    """Pooler config which controls the behaviour of output pooling in pooling
    models."""
    override_pooler_config: Optional[Union[dict, "PoolerConfig"]] = None
    """Initialize non-default pooling config or override default pooling config
    for the pooling model. e.g. `{"pooling_type": "mean", "normalize": false}`.
406
    """
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
    logits_processor_pattern: Optional[str] = None
    """Optional regex pattern specifying valid logits processor qualified names
    that can be passed with the `logits_processors` extra completion argument.
    Defaults to `None`, which allows no processors."""
    generation_config: str = "auto"
    """The folder path to the generation config. Defaults to `"auto"`, the
    generation config will be loaded from model path. If set to `"vllm"`, no
    generation config is loaded, vLLM defaults will be used. If set to a folder
    path, the generation config will be loaded from the specified folder path.
    If `max_new_tokens` is specified in generation config, then it sets a
    server-wide limit on the number of output tokens for all requests."""
    override_generation_config: dict[str, Any] = field(default_factory=dict)
    """Overrides or sets generation config. e.g. `{"temperature": 0.5}`. If
    used with `--generation-config auto`, the override parameters will be
    merged with the default config from the model. If used with
422
    `--generation-config vllm`, only the override parameters are used."""
423
424
425
426
427
428
429
430
431
    enable_sleep_mode: bool = False
    """Enable sleep mode for the engine (only cuda platform is supported)."""
    model_impl: Union[str, ModelImpl] = ModelImpl.AUTO.value
    """Which implementation of the model to use:\n
    - "auto" will try to use the vLLM implementation, if it exists, and fall
    back to the Transformers implementation if no vLLM implementation is
    available.\n
    - "vllm" will use the vLLM model implementation.\n
    - "transformers" will use the Transformers model implementation."""
432
433
    override_attention_dtype: Optional[str] = None
    """Override dtype for attention"""
434

435
436
437
438
    enable_chunked_prefill: Optional[bool] = None
    """If True, prefill requests can be chunked based
    on the remaining max_num_batched_tokens."""

439
440
441
442
443
444
445
446
447
448
449
450
    def compute_hash(self) -> str:
        """
        WARNING: Whenever a new field is added to this config,
        ensure that it is included in the factors list if
        it affects the computation graph.

        Provide a hash that uniquely identifies all the configs
        that affect the structure of the computation
        graph from input ids/embeddings to the final hidden states,
        excluding anything before input ids/embeddings and after
        the final hidden states.
        """
451
        factors: list[Any] = []
452
453
454
455
456
        factors.append(self.model)
        factors.append(self.dtype)
        factors.append(self.quantization)
        factors.append(self.revision)
        factors.append(self.code_revision)
457
458
459
        factors.append(self.max_model_len)
        factors.append(self.max_logprobs)
        factors.append(self.disable_sliding_window)
460
        factors.append(self.trust_remote_code)
461
462
463
        factors.append(self.generation_config)
        factors.append(self.model_impl)
        factors.append(self.override_generation_config)
464
465
        factors.append(self.rope_scaling)
        factors.append(self.rope_theta)
466
467
        # hf_config can control how the model looks!
        factors.append(self.hf_config.to_json_string())
468
        factors.append(self.enable_chunked_prefill)
469
470
        str_factors = str(factors)
        assert_hashable(str_factors)
471
472
        return hashlib.sha256(str(factors).encode()).hexdigest()

473
    def __post_init__(self) -> None:
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
        # Set the default seed to 0 in V1.
        # NOTE(woosuk): In V0, we set the default seed to None because the
        # driver worker shares the same process as the user process, and thus
        # setting a seed affects the user process as well.
        # In V1, we use separate processes for workers (unless
        # VLLM_ENABLE_V1_MULTIPROCESSING=0), so setting a seed here
        # doesn't affect the user process. However, without a consistent seed,
        # different tensor parallel workers would sample different tokens,
        # leading to inconsistent results.
        if envs.VLLM_USE_V1 and self.seed is None:
            self.seed = 0
            if not envs.VLLM_ENABLE_V1_MULTIPROCESSING:
                logger.warning(
                    "The global random seed is set to %d. Since "
                    "VLLM_ENABLE_V1_MULTIPROCESSING is set to False, this may "
                    "affect the random state of the Python process that "
                    "launched vLLM.", self.seed)

492
493
494
        # Keep set served_model_name before maybe_model_redirect(self.model)
        self.served_model_name = get_served_model_name(self.model,
                                                       self.served_model_name)
495
496
497
498
499
500
501
502
503
504
505
506
        self.model = maybe_model_redirect(self.model)
        # The tokenizer is consistent with the model by default.
        if self.tokenizer is None:
            self.tokenizer = self.model
        if self.tokenizer_revision is None:
            self.tokenizer_revision = self.revision
        self.tokenizer = maybe_model_redirect(self.tokenizer)

        if isinstance(self.hf_config_path, str):
            self.hf_config_path = maybe_model_redirect(self.hf_config_path)

        if callable(self.hf_overrides):
507
            hf_overrides_kw = {}
508
            hf_overrides_fn = self.hf_overrides
509
        else:
510
            hf_overrides_kw = self.hf_overrides
511
            hf_overrides_fn = None
512

513
514
        if self.rope_scaling:
            hf_override: dict[str, Any] = {"rope_scaling": self.rope_scaling}
515
            hf_overrides_kw.update(hf_override)
516
            hf_overrides_str = json.dumps(hf_overrides_kw)
517
518
519
            msg = (
                "`--rope-scaling` will be removed in a future release. "
                f"'Please instead use `--hf-overrides '{hf_overrides_str}'`")
520
            warnings.warn(DeprecationWarning(msg), stacklevel=2)
521
522
        if self.rope_theta is not None:
            hf_override = {"rope_theta": self.rope_theta}
523
            hf_overrides_kw.update(hf_override)
524
            hf_overrides_str = json.dumps(hf_overrides_kw)
525
526
527
            msg = (
                "`--rope-theta` will be removed in a future release. "
                f"'Please instead use `--hf-overrides '{hf_overrides_str}'`")
528
529
            warnings.warn(DeprecationWarning(msg), stacklevel=2)

530
        self.maybe_pull_model_tokenizer_for_s3(self.model, self.tokenizer)
531

532
533
534
535
        if (backend := envs.VLLM_ATTENTION_BACKEND
            ) and backend == "FLASHINFER" and find_spec("flashinfer") is None:
            raise ValueError(
                "VLLM_ATTENTION_BACKEND is set to FLASHINFER, but flashinfer "
536
537
                "module was not found. See "
                "https://github.com/vllm-project/vllm/blob/main/docker/Dockerfile "  # noqa: E501
538
539
                "for instructions on how to install it.")

540
541
        from vllm.platforms import current_platform

542
543
544
545
546
547
        if (self.override_attention_dtype is not None
                and not current_platform.is_rocm()):
            warnings.warn(
                "override-attention-dtype is set but not using ROCm platform",
                stacklevel=2)

548
549
550
551
        if (self.enable_sleep_mode
                and not current_platform.is_sleep_mode_available()):
            raise ValueError(
                "Sleep mode is not supported on current platform.")
552

553
554
555
        if isinstance(self.config_format, str):
            self.config_format = ConfigFormat(self.config_format)

556
        hf_config = get_config(self.hf_config_path or self.model,
557
558
559
560
561
562
                               self.trust_remote_code,
                               self.revision,
                               self.code_revision,
                               self.config_format,
                               hf_overrides_kw=hf_overrides_kw,
                               hf_overrides_fn=hf_overrides_fn)
563
564
        self.hf_config = hf_config

565
        self.hf_text_config = get_hf_text_config(self.hf_config)
566
567
        self.attention_chunk_size = getattr(self.hf_text_config,
                                            "attention_chunk_size", None)
568
        self.encoder_config = self._get_encoder_config()
569
        self.hf_image_processor_config = get_hf_image_processor_config(
570
            self.model, hf_token=self.hf_token, revision=self.revision)
571

572
573
574
        # For pooling models, self.task is used to indicate the
        # user-selected task
        if self.task == "score":
575
            if self._is_classify_task(self.architectures):
576
577
578
579
580
581
582
583
584
                self.task = "classify"
            else:
                self.task = "embed"
        elif self.task == "embedding":
            msg = ("The 'embedding' task has been renamed to 'embed', please "
                   "use the new name. The old name will be removed in v1.0.")
            warnings.warn(msg, DeprecationWarning, stacklevel=2)

            self.task = "embed"
585

586
587
588
589
        model_info, arch = self.registry.inspect_model_cls(self.architectures)
        self._model_info = model_info
        self._architecture = arch

590
591
592
593
594
595
596
597
598
599
600
601
602
        all_supported_tasks = self._get_supported_tasks(self.task)
        logger.debug("Tasks supported by runner type: %s", all_supported_tasks)
        supported_runner_types = self._get_supported_runner_types(
            all_supported_tasks)
        runner_type = self._resolve_runner(self.runner, self.task,
                                           supported_runner_types,
                                           all_supported_tasks)

        logger.debug("Selected runner type: %s", runner_type)
        # For pooling models, self.task is used to indicate the
        # user-selected task
        if runner_type == "pooling" and self.task == "auto":
            selected_task = all_supported_tasks[runner_type][-1]
603
            assert selected_task != "encode"
604
605
606
607
608
609
610
            self.task = selected_task
        self.supported_runner_types = supported_runner_types
        self.runner_type = runner_type
        self.supported_tasks = all_supported_tasks[runner_type]

        if self.runner_type in ("draft",
                                "generate") and self.task != "transcription":
611
612
613
614
615
616
617
618
619
620
621
622
623
            self.truncation_side = "left"
        else:
            self.truncation_side = "right"

        self.pooler_config = self._init_pooler_config()

        self.dtype = _get_and_verify_dtype(
            self.model,
            self.hf_config,
            self.dtype,
            is_pooling_model=self.runner_type == "pooling",
            revision=self.revision,
        )
Woosuk Kwon's avatar
Woosuk Kwon committed
624

625
626
627
628
629
        # Workaround for Gemma 2 which uses interleaved sliding window
        # attention, but it's not specified in its config. TODO: remove this
        # when Gemma 2 is fixed in Transformers.
        if self.hf_text_config.model_type == "gemma2":
            self.hf_text_config.sliding_window_pattern = 2
630

631
        sliding_window = getattr(self.hf_text_config, "sliding_window", None)
632
633
        sliding_window_pattern = getattr(self.hf_text_config,
                                         "sliding_window_pattern", None)
634
635
        has_interleaved_attention = sliding_window_pattern is not None or (
            isinstance(sliding_window, list))
636

637
        if not self.disable_sliding_window and has_interleaved_attention:
638
639
            if (backend :=
                    envs.VLLM_ATTENTION_BACKEND) in ("XFORMERS", "FLASHINFER"):
640
641
                sliding_window_len_min = get_min_sliding_window(
                    self.hf_text_config.sliding_window)
642

643
                logger.warning_once(
644
645
646
647
648
                    "%s has interleaved attention, which is currently not supported by the %s backend. Disabling sliding window and capping the max length to the sliding window size (%d).",  # noqa: E501
                    self.hf_text_config.model_type,
                    backend,
                    sliding_window_len_min,
                )
649
650
651
652
653
654
655
656
                self.disable_sliding_window = True
            else:
                # for a model with interleaved attention,
                # the scheduler and the model treat it as full attention
                # (i.e., not dropping any tokens outside the window).
                # only the attention layer itself is aware of the sliding
                # window, and use the window size to compute the attention.
                self.hf_text_config.interleaved_sliding_window = sliding_window
657
658
659
660

                if hasattr(self.hf_text_config, "sliding_window"):
                    delattr(self.hf_text_config, "sliding_window")

661
                sliding_window = None
Woosuk Kwon's avatar
Woosuk Kwon committed
662

663
        self.original_max_model_len = self.max_model_len
664
        self.max_model_len = self.get_and_verify_max_len(self.max_model_len)
665
        self.multimodal_config = self._init_multimodal_config()
666
667
        self.model_supports_multimodal_raw_input = (
            self.registry.supports_multimodal_raw_input(self.architectures))
668
669
        if not self.skip_tokenizer_init:
            self._verify_tokenizer_mode()
670

671
        self.is_attention_free = self._init_attention_free()
672
        self.is_hybrid = self._init_is_hybrid()
673
        self.has_noops = self._init_has_noops()
674
675
        self.has_inner_state = self._init_has_inner_state()

676
677
678
        if (not current_platform.is_neuron() and self.override_neuron_config):
            raise ValueError(
                "`override_neuron_config` is only supported on Neuron.")
679

680
        self._verify_quantization()
681
        self._verify_cuda_graph()
682
        self._verify_bnb_config()
683

684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
    @field_validator("quantization", mode="before")
    @classmethod
    def validate_quantization_before(cls, value: Any) -> Any:
        if isinstance(value, str):
            return value.lower()
        return value

    @model_validator(mode="after")
    def validate_model_config_after(self: "ModelConfig") -> "ModelConfig":
        if not isinstance(self.tokenizer, str):
            raise ValueError("tokenizer must be a string after __post_init__.")
        if not isinstance(self.max_model_len, int):
            raise ValueError(
                "max_model_len must be an integer after __post_init__.")
        return self

700
701
702
703
704
705
706
707
708
709
    def _get_transformers_backend_cls(self) -> str:
        """Determine which Transformers backend class will be used if
        `model_impl` is set to `transformers` or `auto`."""
        if self.hf_config != self.hf_text_config:
            # If 'hf_text_config' is the same as 'hf_config'. If not, it is
            # probably a composite config, i.e. multimodal
            return "TransformersForMultimodalLM"
        else:
            return "TransformersForCausalLM"

710
711
    @property
    def registry(self):
712
        return me_models.ModelRegistry
713
714
715

    @property
    def architectures(self) -> list[str]:
716
        # architectures in the model config.
717
718
719
720
721
722
723
724
725
726
727
728
729
        architectures = getattr(self.hf_config, "architectures", [])
        # The registry assumes that it can always inspect the vLLM model class
        # for a given architecture. This assumption breaks down for the
        # Transformers backend, which may use a different class depending on
        # the model type. To work around this, we add the correct Transformers
        # backend class to the architectures list. We must do this here because
        # we need access to the `hf_config` to determine the backend class.
        transformers_backend_cls = self._get_transformers_backend_cls()
        if (self.model_impl != ModelImpl.VLLM.value
                and all(arch != transformers_backend_cls
                        for arch in architectures)):
            architectures.append(transformers_backend_cls)
        return architectures
730

731
732
733
734
735
736
    @property
    def architecture(self) -> str:
        # The architecture vllm actually used.
        return self._architecture

    @property
737
    def model_info(self):
738
739
        return self._model_info

740
741
    def maybe_pull_model_tokenizer_for_s3(self, model: str,
                                          tokenizer: str) -> None:
742
        """Pull model/tokenizer from S3 to temporary directory when needed.
743
744

        Args:
745
746
            model: Model name or path
            tokenizer: Tokenizer name or path
747
        """
748
749
        if not (is_s3(model) or is_s3(tokenizer)):
            return
750

751
752
753
754
755
756
757
758
759
        if is_s3(model):
            s3_model = S3Model()
            s3_model.pull_files(model,
                                allow_pattern=["*.model", "*.py", "*.json"])
            self.model_weights = model
            self.model = s3_model.dir

            # If tokenizer is same as model, download to same directory
            if model == tokenizer:
760
761
762
763
764
                s3_model.pull_files(model,
                                    ignore_pattern=[
                                        "*.pt", "*.safetensors", "*.bin",
                                        "*.tensors"
                                    ])
765
766
                self.tokenizer = s3_model.dir
                return
767

768
769
770
771
        # Only download tokenizer if needed and not already handled
        if is_s3(tokenizer):
            s3_tokenizer = S3Model()
            s3_tokenizer.pull_files(
772
773
                model,
                ignore_pattern=["*.pt", "*.safetensors", "*.bin", "*.tensors"])
774
            self.tokenizer = s3_tokenizer.dir
775

776
    def _init_multimodal_config(self) -> Optional["MultiModalConfig"]:
777
        if self.registry.is_multimodal_model(self.architectures):
778
            return MultiModalConfig(
779
                limit_per_prompt=self.limit_mm_per_prompt,
780
                media_io_kwargs=self.media_io_kwargs,
781
782
                mm_processor_kwargs=self.mm_processor_kwargs,
                disable_mm_preprocessor_cache=self.
783
784
                disable_mm_preprocessor_cache,
                interleave_mm_strings=self.interleave_mm_strings)
785

786
        if self.limit_mm_per_prompt:
787
788
            raise ValueError("`limit_mm_per_prompt` is only supported for "
                             "multimodal models.")
789
        if self.mm_processor_kwargs:
790
791
            raise ValueError("`mm_processor_kwargs` is only supported for "
                             "multimodal models.")
792
        if self.disable_mm_preprocessor_cache:
793
794
            raise ValueError("`disable_mm_preprocessor_cache` is only "
                             "supported for multimodal models.")
795
796
797
        if self.interleave_mm_strings:
            raise ValueError("`interleave_mm_strings` is only "
                             "supported for multimodal models.")
798
799

        return None
800

801
802
803
804
    def _get_encoder_config(self):
        return get_sentence_transformer_tokenizer_config(
            self.model, self.revision)

805
    def _init_pooler_config(self) -> Optional["PoolerConfig"]:
806
        if self.runner_type == "pooling":
807
808
809
810
811
            if isinstance(self.override_pooler_config, dict):
                self.override_pooler_config = PoolerConfig(
                    **self.override_pooler_config)

            pooler_config = self.override_pooler_config or PoolerConfig()
812
813
814
815
816

            base_config = get_pooling_config(self.model, self.revision)
            if base_config is not None:
                # Only set values that are not overridden by the user
                for k, v in base_config.items():
817
818
                    if getattr(pooler_config, k) is None:
                        setattr(pooler_config, k, v)
819

820
            if self.is_matryoshka:
821
822
823
                if pooler_config.normalize is None:
                    pooler_config.normalize = True
                elif not pooler_config.normalize:
824
825
826
827
828
                    raise ValueError(
                        "`normalize` must be enabled (set to True) "
                        "for models that are compatible with "
                        "Matryoshka Representation.")

829
            return pooler_config
830

831
832
        return None

833
    def _init_attention_free(self) -> bool:
834
        return self.registry.is_attention_free_model(self.architectures)
835

836
    def _init_is_hybrid(self) -> bool:
837
        return self.registry.is_hybrid_model(self.architectures)
838

839
840
841
842
    def _init_has_noops(self) -> bool:
        architectures = getattr(self.hf_config, "architectures", [])
        return self.registry.is_noops_model(architectures)

843
    def _init_has_inner_state(self) -> bool:
844
        return self.registry.model_has_inner_state(self.architectures)
845

846
    def _verify_tokenizer_mode(self) -> None:
847
848
        tokenizer_mode = cast(TokenizerMode, self.tokenizer_mode.lower())
        if tokenizer_mode not in get_args(TokenizerMode):
849
850
            raise ValueError(
                f"Unknown tokenizer mode: {self.tokenizer_mode}. Must be "
851
                f"one of {get_args(TokenizerMode)}.")
852
        self.tokenizer_mode = tokenizer_mode
853

854
855
856
857
858
859
    def _is_classify_task(self, architectures: list[str]):
        for arch in architectures:
            if arch.endswith("ForSequenceClassification"):
                return True
        return self.registry.is_cross_encoder_model(architectures)

860
    def _get_preferred_pooling_task(
861
        self,
862
        architectures: list[str],
863
    ) -> _ResolvedTask:
864
865
866
        model_id = self.model
        if get_pooling_config(model_id, self.revision):
            return "embed"
867
        if self.registry.is_transcription_model(architectures):
868
            return "transcription"
869

870
        suffix_to_preferred_task: list[tuple[str, _ResolvedTask]] = [
871
872
873
874
875
876
            # Other models follow this pattern
            ("EmbeddingModel", "embed"),
            ("RewardModel", "reward"),
        ]

        for suffix, pref_task in suffix_to_preferred_task:
877
            if self.architecture.endswith(suffix):
878
879
                return pref_task

880
        return "embed"
881

882
    def _get_supported_generation_tasks(
883
        self,
884
885
886
887
        task_option: TaskOption,
    ) -> list[_ResolvedTask]:
        registry = self.registry
        architectures = self.architectures
888

889
890
891
892
893
894
895
896
897
898
899
        if registry.is_transcription_only_model(architectures):
            return ["transcription"]

        supported_tasks = list[_ResolvedTask]()
        if registry.is_text_generation_model(architectures):
            supported_tasks.append("generate")

            if registry.is_transcription_model(architectures):
                supported_tasks.append("transcription")

        return supported_tasks
900

901
902
903
904
    def _get_supported_pooling_tasks(
        self,
        task_option: TaskOption,
    ) -> list[_ResolvedTask]:
905
906
        registry = self.registry
        architectures = self.architectures
907

908
909
        supported_tasks = list[_ResolvedTask]()
        if registry.is_pooling_model(architectures):
910
            supported_tasks.append("encode")
911

912
913
914
915
916
            # For now, users must specify the task (other than "pooling")
            # to use for pooling models
            if task_option == "auto":
                preferred_task = self._get_preferred_pooling_task(
                    architectures)
917

918
919
920
                supported_tasks.append(preferred_task)
            elif task_option in _RUNNER_TASKS["pooling"]:
                supported_tasks.append(cast(_ResolvedTask, task_option))
921

922
        return supported_tasks
923

924
925
926
927
    def _get_supported_tasks(
        self,
        task_option: TaskOption,
    ) -> dict[RunnerType, list[_ResolvedTask]]:
928
929
        if self._is_classify_task(self.architectures):
            return {"generate": [], "pooling": ["classify"], "draft": []}
930
        else:
931
932
933
934
935
            return {
                "generate": self._get_supported_generation_tasks(task_option),
                "pooling": self._get_supported_pooling_tasks(task_option),
                "draft": ["draft"]
            }
936

937
938
939
940
941
942
943
944
945
    def _get_supported_runner_types(
        self,
        supported_tasks: dict[RunnerType, list[_ResolvedTask]],
    ) -> set[RunnerType]:
        return {
            runner
            for runner, runner_tasks in supported_tasks.items()
            if len(runner_tasks) > 0
        }
946

947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
    def _resolve_runner(
        self,
        runner_option: RunnerOption,
        task_option: TaskOption,
        supported_runner_types: set[RunnerType],
        supported_tasks: dict[RunnerType, list[_ResolvedTask]],
    ) -> RunnerType:
        if not supported_runner_types:
            raise ValueError("This model does not support any model runners!")

        if runner_option != "auto":
            if runner_option not in supported_runner_types:
                raise ValueError(
                    f"This model does not support runner={runner_option!r}. "
                    f"Available runners: {supported_runner_types}")
962

963
            return runner_option
964

965
966
967
968
        if task_option != "auto":
            for runner, runner_tasks in supported_tasks.items():
                if task_option in runner_tasks:
                    return runner
969
            else:
970
971
972
973
974
975
976
                task_runner: RunnerType = next(
                    runner for runner, tasks in _RUNNER_TASKS.items()
                    if task_option in tasks)
                raise ValueError(
                    f"This model does not support task={task_option!r}. "
                    f"Available tasks for runner={task_runner!r}: "
                    f"{supported_tasks[task_runner]}")
977

978
979
980
981
        if "classify" in supported_tasks.get("pooling", []):
            # When multiple pooling tasks are present, default to
            # pooling (eg cross-encoder) for non-standard architectures.
            return "pooling"
982

983
984
985
986
987
988
989
990
        suffix_to_preferred_runner: list[tuple[str, RunnerType]] = [
            ("ForCausalLM", "generate"),
            ("ForConditionalGeneration", "generate"),
            ("ChatModel", "generate"),
            ("LMHeadModel", "generate"),
            ("EmbeddingModel", "pooling"),
            ("RewardModel", "pooling"),
        ]
991

992
        for suffix, pref_runner in suffix_to_preferred_runner:
993
994
            if self.architecture.endswith(
                    suffix) and pref_runner in supported_runner_types:
995
                return pref_runner
996

997
998
999
1000
        if "generate" in supported_runner_types:
            return "generate"
        if "pooling" in supported_runner_types:
            return "pooling"
1001

1002
        raise AssertionError("This line should not be reached")
1003

1004
1005
1006
    def _parse_quant_hf_config(self):
        quant_cfg = getattr(self.hf_config, "quantization_config", None)
        if quant_cfg is None:
1007
            # compressed-tensors uses a "compression_config" key
1008
            quant_cfg = getattr(self.hf_config, "compression_config", None)
1009
1010
        return quant_cfg

1011
    def _verify_quantization(self) -> None:
1012
        supported_quantization = me_quant.QUANTIZATION_METHODS
1013
        optimized_quantization_methods = [
1014
            "fp8", "marlin", "modelopt", "gptq_marlin_24", "gptq_marlin",
1015
            "awq_marlin", "fbgemm_fp8", "compressed-tensors", "experts_int8",
1016
            "quark", "modelopt_fp4", "bitblas", "gptq_bitblas", "inc"
1017
        ]
1018
        if self.quantization is not None:
1019
1020
            self.quantization = cast(me_quant.QuantizationMethods,
                                     self.quantization)
1021
1022

        # Parse quantization method from the HF model config, if available.
1023
1024
        quant_cfg = self._parse_quant_hf_config()

1025
        if quant_cfg is not None:
1026
            # Use the community standard 'quant_method'
1027
            quant_method = quant_cfg.get("quant_method", "").lower()
1028
1029

            # Normalize library names
1030
1031
            quant_method = quant_method.replace("compressed_tensors",
                                                "compressed-tensors")
1032

1033
            quant_cfg["quant_method"] = quant_method
1034

1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
            # Quantization methods which are overrides (i.e. they have a
            # `override_quantization_method` method) must be checked in order
            # of preference (this is particularly important for GPTQ).
            overrides = [
                "marlin",
                "bitblas",
                "gptq_marlin_24",
                "gptq_marlin",
                "gptq_bitblas",
                "awq_marlin",
                "ipex",
                "moe_wna16",
1047
1048
                "modelopt",
                "modelopt_fp4",
1049
1050
1051
1052
1053
1054
1055
1056
            ]
            quantization_methods = [
                q for q in supported_quantization if q not in overrides
            ]
            # Any custom overrides will be in quantization_methods so we place
            # them at the start of the list so custom overrides have preference
            # over the built in ones.
            quantization_methods = quantization_methods + overrides
1057
1058

            # Detect which checkpoint is it
1059
            for name in quantization_methods:
1060
                method = me_quant.get_quantization_config(name)
1061
1062
                quantization_override = method.override_quantization_method(
                    quant_cfg, self.quantization)
1063
1064
1065
1066
                if quantization_override is not None:
                    # Raise error if the override is not custom (custom would
                    # be in QUANTIZATION_METHODS but not QuantizationMethods)
                    # and hasn't been added to the overrides list.
1067
                    if (name in get_args(me_quant.QuantizationMethods)
1068
1069
1070
1071
1072
1073
                            and name not in overrides):
                        raise ValueError(
                            f"Quantization method {name} is an override but "
                            "is has not been added to the `overrides` list "
                            "above. This is necessary to ensure that the "
                            "overrides are checked in order of preference.")
1074
1075
1076
                    quant_method = quantization_override
                    self.quantization = quantization_override
                    break
1077

1078
            # Verify quantization configurations.
1079
            if self.quantization is None:
1080
1081
                self.quantization = quant_method
            elif self.quantization != quant_method:
1082
1083
                raise ValueError(
                    "Quantization method specified in the model config "
1084
                    f"({quant_method}) does not match the quantization "
1085
1086
1087
1088
1089
1090
1091
1092
                    f"method specified in the `quantization` argument "
                    f"({self.quantization}).")

        if self.quantization is not None:
            if self.quantization not in supported_quantization:
                raise ValueError(
                    f"Unknown quantization method: {self.quantization}. Must "
                    f"be one of {supported_quantization}.")
1093
            from vllm.platforms import current_platform
1094
            current_platform.verify_quantization(self.quantization)
1095
            if self.quantization not in optimized_quantization_methods:
1096
                logger.warning(
1097
                    "%s quantization is not fully "
1098
                    "optimized yet. The speed can be slower than "
1099
                    "non-quantized models.", self.quantization)
1100

1101
    def _verify_cuda_graph(self) -> None:
zhuwenwen's avatar
zhuwenwen committed
1102
1103
1104
1105
1106
        if self.max_seq_len_to_capture is None:
            self.max_seq_len_to_capture = self.max_model_len
        self.max_seq_len_to_capture = min(self.max_seq_len_to_capture,
                                          self.max_model_len)
        # self.max_seq_len_to_capture = self.max_model_len
1107
        # CUDAGraph capture not supported for enc-dec models and mllama on ROCm
1108
        ROCM_UNSUPPORTED_MODELS = ['mllama']
1109
1110
1111
1112
1113
1114
        unsupported_rocm = (self.hf_config.model_type
                            in ROCM_UNSUPPORTED_MODELS
                            or self.is_encoder_decoder)

        if (unsupported_rocm and not self.enforce_eager
                and current_platform.is_rocm()):
1115
1116
            logger.warning(
                "CUDA graph is not supported for %s on ROCm yet, fallback "
1117
                "to eager mode.", self.hf_config.model_type)
1118
            self.enforce_eager = True
1119

1120
1121
    def _verify_bnb_config(self) -> None:
        """
1122
        The current version of bitsandbytes (0.46.1) with 8-bit models does not
1123
        yet support CUDA graph.
1124
        # TODO Remove this when bitsandbytes supports.
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
        """
        is_bitsandbytes = self.quantization == "bitsandbytes"
        has_quantization_config = (getattr(self.hf_config,
                                           "quantization_config", None)
                                   is not None)
        is_8bit = (self.hf_config.quantization_config.get(
            "load_in_8bit", False) if has_quantization_config else False)
        if all([
                is_bitsandbytes,
                has_quantization_config,
                is_8bit,
                not self.enforce_eager,
        ]):
            logger.warning(
1139
                "CUDA graph is not supported on BitsAndBytes 8bit yet, "
1140
                "fallback to the eager mode.")
1141

1142
1143
            self.enforce_eager = True

1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
    def _verify_with_expert_parallelism(self) -> None:
        num_expert_names = [
            "moe_num_experts",  # Dbrx
            "num_experts",  # Jamba
            "n_routed_experts",  # DeepSeek
            "num_local_experts",  # Mixtral
        ]
        num_experts = 0
        for name in num_expert_names:
            num_experts = getattr(self.hf_text_config, name, 0)
            if num_experts > 0:
                break
        if num_experts < 1:
            raise ValueError(
                "Number of experts in the model must be greater than 0 "
                "when expert parallelism is enabled.")

1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
    def verify_dual_chunk_attention_config(
        self,
        load_config: "LoadConfig",
    ) -> None:
        if hasattr(self.hf_config, "dual_chunk_attention_config"):
            # Try loading the sparse attention config
            from vllm.model_executor.model_loader.weight_utils import (
                get_sparse_attention_config)
            sparse_attn_config = get_sparse_attention_config(self, load_config)
            if sparse_attn_config:
                self.hf_config.dual_chunk_attention_config[
                    "sparse_attention_config"] = sparse_attn_config
                if "sparse_attention_enabled" not in \
                        self.hf_config.dual_chunk_attention_config:
                    self.hf_config.dual_chunk_attention_config[
                        "sparse_attention_enabled"] = True

1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
    def verify_async_output_proc(self, parallel_config, speculative_config,
                                 device_config) -> None:
        if not self.use_async_output_proc:
            # Nothing to check
            return

        if parallel_config.pipeline_parallel_size > 1:
            self.use_async_output_proc = False
            return

1188
        # Reminder: Please update docs/features/compatibility_matrix.md
1189
        # If the feature combo become valid
1190
        from vllm.platforms import current_platform
1191
        if not current_platform.is_async_output_supported(self.enforce_eager):
1192
1193
1194
1195
1196
1197
1198
            self.use_async_output_proc = False
            return

        if envs.VLLM_USE_RAY_SPMD_WORKER:
            self.use_async_output_proc = False
            return

1199
        # Async postprocessor is not necessary for pooling models
1200
        # since there is no token generation
1201
        if self.runner_type == "pooling":
1202
1203
            self.use_async_output_proc = False

1204
        # Reminder: Please update docs/features/compatibility_matrix.md
1205
        # If the feature combo become valid
1206
1207
1208
        if speculative_config:
            self.use_async_output_proc = False

1209
1210
1211
1212
    def verify_with_parallel_config(
        self,
        parallel_config: "ParallelConfig",
    ) -> None:
1213
1214
1215
1216
1217
1218

        if parallel_config.distributed_executor_backend == "external_launcher":
            assert self.seed is not None, (
                "Seed must be set when using external launcher backend to "
                "make sure sampling results are the same across workers.")

1219
1220
        total_num_attention_heads = getattr(self.hf_text_config,
                                            "num_attention_heads", 0)
1221
1222
1223
1224
1225
1226
1227
        tensor_parallel_size = parallel_config.tensor_parallel_size
        if total_num_attention_heads % tensor_parallel_size != 0:
            raise ValueError(
                f"Total number of attention heads ({total_num_attention_heads})"
                " must be divisible by tensor parallel size "
                f"({tensor_parallel_size}).")

1228
        if parallel_config.enable_expert_parallel:
1229
1230
            self._verify_with_expert_parallelism()

1231
        pipeline_parallel_size = parallel_config.pipeline_parallel_size
1232
        if pipeline_parallel_size > 1:
1233
            if not self.registry.is_pp_supported_model(self.architectures):
1234
1235
1236
                raise NotImplementedError(
                    "Pipeline parallelism is not supported for this model. "
                    "Supported models implement the `SupportsPP` interface.")
1237

1238
1239
            if self.use_async_output_proc:
                self.use_async_output_proc = False
1240

1241
    def get_hf_config_sliding_window(
1242
            self) -> Union[Optional[int], list[Optional[int]]]:
Woosuk Kwon's avatar
Woosuk Kwon committed
1243
        """Get the sliding window size, or None if disabled."""
1244
1245
1246
1247

        # Some models, like Qwen2 and Qwen1.5, use `use_sliding_window` in
        # addition to sliding window size. We check if that field is present
        # and if it's False, return None.
1248
1249
        if (hasattr(self.hf_text_config, "use_sliding_window")
                and not self.hf_text_config.use_sliding_window):
1250
            return None
1251
        return getattr(self.hf_text_config, "sliding_window", None)
1252

1253
    def get_sliding_window(self) -> Optional[Union[int, list[Optional[int]]]]:
1254
1255
1256
1257
1258
1259
1260
1261
        """Get the sliding window size, or None if disabled.
        """
        # If user disables sliding window, return None.
        if self.disable_sliding_window:
            return None
        # Otherwise get the value from the hf config.
        return self.get_hf_config_sliding_window()

1262
    def get_vocab_size(self) -> int:
1263
        return getattr(self.hf_text_config, "vocab_size", 0)
1264

1265
    def get_hidden_size(self) -> int:
1266
        return getattr(self.hf_text_config, "hidden_size", 0)
1267

1268
1269
    @property
    def is_deepseek_mla(self) -> bool:
1270
1271
1272
        if not hasattr(self.hf_text_config, "model_type"):
            return False
        elif self.hf_text_config.model_type in \
bigmoyan's avatar
bigmoyan committed
1273
            ('deepseek_v2', 'deepseek_v3', 'deepseek_mtp', 'kimi_k2'):
1274
1275
1276
1277
1278
1279
1280
1281
            return self.hf_text_config.kv_lora_rank is not None
        elif self.hf_text_config.model_type == 'eagle':
            # if the model is an EAGLE module, check for the
            # underlying architecture
            return self.hf_text_config.model.model_type in \
                    ('deepseek_v2', 'deepseek_v3') \
                and self.hf_text_config.kv_lora_rank is not None
        return False
1282

1283
    def get_head_size(self) -> int:
wangding zeng's avatar
wangding zeng committed
1284
        # TODO remove hard code
1285
        if self.is_deepseek_mla:
1286
1287
            qk_rope_head_dim = getattr(self.hf_text_config, "qk_rope_head_dim",
                                       0)
1288
            if self.use_mla:
1289
                return self.hf_text_config.kv_lora_rank + qk_rope_head_dim
1290
1291
1292
1293
1294
            else:
                qk_nope_head_dim = getattr(self.hf_text_config,
                                           "qk_nope_head_dim", 0)
                if qk_rope_head_dim and qk_nope_head_dim:
                    return qk_rope_head_dim + qk_nope_head_dim
1295

1296
1297
1298
1299
1300
        if hasattr(self.hf_text_config,
                   "model_type") and (self.hf_text_config.model_type
                                      == "zamba2"):
            return self.hf_text_config.attention_head_dim

1301
1302
1303
        if self.is_attention_free:
            return 0

1304
1305
        # NOTE: Some configs may set head_dim=None in the config
        if getattr(self.hf_text_config, "head_dim", None) is not None:
1306
            return self.hf_text_config.head_dim
1307

1308
        # FIXME(woosuk): This may not be true for all models.
1309
1310
        return (self.hf_text_config.hidden_size //
                self.hf_text_config.num_attention_heads)
1311

1312
1313
    def get_total_num_kv_heads(self) -> int:
        """Returns the total number of KV heads."""
Zhuohan Li's avatar
Zhuohan Li committed
1314
        # For GPTBigCode & Falcon:
1315
        # NOTE: for falcon, when new_decoder_architecture is True, the
Zhuohan Li's avatar
Zhuohan Li committed
1316
1317
        # multi_query flag is ignored and we use n_head_kv for the number of
        # KV heads.
1318
        falcon_model_types = ["falcon", "RefinedWeb", "RefinedWebModel"]
1319
        new_decoder_arch_falcon = (
1320
            self.hf_config.model_type in falcon_model_types
1321
            and getattr(self.hf_config, "new_decoder_architecture", False))
1322
        if not new_decoder_arch_falcon and getattr(self.hf_text_config,
1323
                                                   "multi_query", False):
Zhuohan Li's avatar
Zhuohan Li committed
1324
            # Multi-query attention, only one KV head.
Woosuk Kwon's avatar
Woosuk Kwon committed
1325
            # Currently, tensor parallelism is not supported in this case.
Zhuohan Li's avatar
Zhuohan Li committed
1326
            return 1
1327

1328
        # For DBRX and MPT
1329
1330
1331
1332
1333
        if self.hf_config.model_type == "mpt":
            if "kv_n_heads" in self.hf_config.attn_config:
                return self.hf_config.attn_config["kv_n_heads"]
            return self.hf_config.num_attention_heads
        if self.hf_config.model_type == "dbrx":
1334
1335
1336
            return getattr(self.hf_config.attn_config, "kv_n_heads",
                           self.hf_config.num_attention_heads)

1337
1338
1339
1340
1341
1342
1343
1344
        if self.hf_config.model_type == "nemotron-nas":
            for block in self.hf_config.block_configs:
                if not block.attention.no_op:
                    return self.hf_config.num_attention_heads \
                        // block.attention.n_heads_in_group

            raise RuntimeError("Couldn't determine number of kv heads")

1345
1346
1347
        if self.is_attention_free:
            return 0

1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
        attributes = [
            # For Falcon:
            "n_head_kv",
            "num_kv_heads",
            # For LLaMA-2:
            "num_key_value_heads",
            # For ChatGLM:
            "multi_query_group_num",
        ]
        for attr in attributes:
1358
            num_kv_heads = getattr(self.hf_text_config, attr, None)
1359
1360
1361
1362
1363
            if num_kv_heads is not None:
                return num_kv_heads

        # For non-grouped-query attention models, the number of KV heads is
        # equal to the number of attention heads.
1364
        return self.hf_text_config.num_attention_heads
1365
1366
1367

    def get_num_kv_heads(self, parallel_config: "ParallelConfig") -> int:
        """Returns the number of KV heads per GPU."""
1368
1369
1370
1371
        if self.use_mla:
            # When using MLA during decode it becomes MQA
            return 1

1372
1373
1374
1375
1376
1377
1378
        total_num_kv_heads = self.get_total_num_kv_heads()
        # If tensor parallelism is used, we divide the number of KV heads by
        # the tensor parallel size. We will replicate the KV heads in the
        # case where the number of KV heads is smaller than the tensor
        # parallel size so each GPU has at least one KV head.
        return max(1,
                   total_num_kv_heads // parallel_config.tensor_parallel_size)
1379

1380
1381
    def get_num_attention_heads(self,
                                parallel_config: "ParallelConfig") -> int:
1382
1383
        num_heads = getattr(self.hf_text_config, "num_attention_heads", 0)
        return num_heads // parallel_config.tensor_parallel_size
1384

1385
    def get_layers_start_end_indices(
1386
            self, parallel_config: "ParallelConfig") -> tuple[int, int]:
1387
        from vllm.distributed.utils import get_pp_indices
1388
        if (self.hf_text_config.model_type == "deepseek_mtp"
zhuwenwen's avatar
zhuwenwen committed
1389
1390
                or self.hf_config.model_type == "mimo_mtp"
                or self.hf_config.model_type == "glm4_moe_mtp"):
1391
1392
1393
1394
1395
            total_num_hidden_layers = getattr(self.hf_text_config,
                                              "num_nextn_predict_layers", 0)
        else:
            total_num_hidden_layers = getattr(self.hf_text_config,
                                              "num_hidden_layers", 0)
1396
1397
1398
        # the layout order is: DP x PP x TP
        pp_rank = (parallel_config.rank // parallel_config.tensor_parallel_size
                   ) % parallel_config.pipeline_parallel_size
1399
1400
        pp_size = parallel_config.pipeline_parallel_size
        start, end = get_pp_indices(total_num_hidden_layers, pp_rank, pp_size)
1401
        return start, end
Mor Zusman's avatar
Mor Zusman committed
1402

1403
1404
    def get_num_layers(self, parallel_config: "ParallelConfig") -> int:
        start, end = self.get_layers_start_end_indices(parallel_config)
1405
        return end - start
1406

1407
1408
1409
1410
1411
1412
1413
1414
    def get_num_layers_by_block_type(
        self,
        parallel_config: "ParallelConfig",
        block_type: LayerBlockType = LayerBlockType.attention,
    ) -> int:
        # This function relies on 'layers_block_type' in hf_config,
        # for w/o this attribute, we will need to have workarounds like so
        attn_block_type = block_type == LayerBlockType.attention
1415
1416
1417
        is_transformer = not self.is_hybrid and \
                            not self.has_noops and \
                            not self.is_attention_free
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
        start, end = self.get_layers_start_end_indices(parallel_config)

        if is_transformer:
            # Handle the basic case first
            return end - start if attn_block_type else 0
        elif self.is_attention_free:
            # Attention free
            # Note that this code assumes there
            # is only one type of attention-free block type.
            return 0 if attn_block_type else end - start
1428
1429
1430
1431
        elif self.has_noops:
            block_configs = self.hf_config.block_configs
            return sum(not bc.attention.no_op
                       for bc in block_configs[start:end])
1432
        else:
1433
            # Hybrid model Jamba
1434
1435
            layers_block_type_value = getattr(self.hf_config,
                                              "layers_block_type", None)
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
            if layers_block_type_value is not None:
                if hasattr(self.hf_text_config,
                           "model_type") and (self.hf_text_config.model_type
                                              == "zamba2"):
                    if attn_block_type:
                        return sum(t == "hybrid"
                                   for t in layers_block_type_value[start:end])
                    else:
                        return self.get_num_layers(parallel_config)
                return sum(t == block_type.value
                           for t in layers_block_type_value[start:end])

            # Hybrid model Minimax
            attn_type_list = getattr(self.hf_config, "attn_type_list", None)
            if attn_type_list:
                return sum(t == 1 for t in attn_type_list[start:end])

            if layers_block_type_value is None and attn_type_list is None:
                raise ValueError(
                    "The model is an hybrid without a"
                    "layers_block_type or an attn_type_list in the hf_config,"
                    "cannot determine the num of "
                    f"{block_type.value} layers")
1459

1460
            return sum(t == 1 for t in attn_type_list[start:end])
Mor Zusman's avatar
Mor Zusman committed
1461

1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
    def get_mamba_chunk_size(self) -> Optional[int]:
        """
        Returns the mamba chunk size if it exists
        """
        # used by e.g. Bamba, FalconH1, Granite, PLaMo2
        chunk_size = getattr(self.hf_text_config, "mamba_chunk_size", None)
        if chunk_size is None:
            # used by e.g. Mamba2, NemotronH, Zamba
            chunk_size = getattr(self.hf_text_config, "chunk_size", None)
        return chunk_size

1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
    def get_multimodal_config(self) -> "MultiModalConfig":
        """
        Get the multimodal configuration of the model.

        Raises:
            ValueError: If the model is not multimodal.
        """
        if self.multimodal_config is None:
            raise ValueError("The model is not multimodal.")

        return self.multimodal_config

1485
    def try_get_generation_config(self) -> dict[str, Any]:
1486
        if self.generation_config in ("auto", "vllm"):
1487
            config = try_get_generation_config(
1488
                self.hf_config_path or self.model,
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
                trust_remote_code=self.trust_remote_code,
                revision=self.revision,
            )
        else:
            config = try_get_generation_config(
                self.generation_config,
                trust_remote_code=self.trust_remote_code,
            )

        if config is None:
            return {}

        return config.to_diff_dict()

1503
    def get_diff_sampling_param(self) -> dict[str, Any]:
1504
        """
1505
        This method returns a dictionary containing the parameters
1506
1507
        that differ from the default sampling parameters. If
        `generation_config` is `"vllm"`, an empty dictionary is returned.
1508
1509

        Returns:
1510
            dict[str, Any]: A dictionary with the differing sampling
1511
            parameters, if `generation_config` is `"vllm"` an empty dictionary.
1512
        """
1513
        if self.generation_config == "vllm":
1514
1515
1516
1517
1518
1519
1520
            config = {}
        else:
            config = self.try_get_generation_config()

        # Overriding with given generation config
        config.update(self.override_generation_config)

1521
1522
1523
1524
1525
1526
        available_params = [
            "repetition_penalty",
            "temperature",
            "top_k",
            "top_p",
            "min_p",
1527
            "max_new_tokens",
1528
1529
1530
1531
1532
1533
        ]
        if any(p in config for p in available_params):
            diff_sampling_param = {
                p: config.get(p)
                for p in available_params if config.get(p) is not None
            }
1534
1535
1536
1537
1538
            # Huggingface definition of max_new_tokens is equivalent
            # to vLLM's max_tokens
            if "max_new_tokens" in diff_sampling_param:
                diff_sampling_param["max_tokens"] = diff_sampling_param.pop(
                    "max_new_tokens")
1539
1540
        else:
            diff_sampling_param = {}
1541
1542
1543
1544
1545
1546
1547

        if diff_sampling_param:
            logger.warning_once(
                "Default sampling parameters have been overridden by the "
                "model's Hugging Face generation config recommended from the "
                "model creator. If this is not intended, please relaunch "
                "vLLM instance with `--generation-config vllm`.")
1548
1549
        return diff_sampling_param

1550
    @property
1551
    def is_encoder_decoder(self) -> bool:
1552
        """Extract the HF encoder/decoder model flag."""
1553
        """
1554
        For Mllama, VLLM overrides HF's is_encoder_decoder flag and sets it to
1555
        True to enable cross-attention
1556
        Neuron needs all multimodal data to be in the decoder and does not
1557
1558
1559
1560
1561
1562
        need to explicitly enable cross-attention
        """
        if (current_platform.is_neuron()
                and self.hf_config.model_type == "mllama"):
            return False

1563
        return is_encoder_decoder(self.hf_config)
1564
1565

    @property
1566
1567
    def uses_mrope(self) -> bool:
        return uses_mrope(self.hf_config)
1568

1569
1570
1571
1572
    @property
    def is_multimodal_model(self) -> bool:
        return self.multimodal_config is not None

1573
1574
    @property
    def is_cross_encoder(self) -> bool:
1575
        return self.task == "classify"
1576

1577
1578
    @property
    def use_mla(self) -> bool:
zhuwenwen's avatar
zhuwenwen committed
1579
        return self.is_deepseek_mla and not envs.VLLM_MLA_DISABLE and SUPPORT_TC
1580

1581
1582
1583
    @property
    def is_v1_compatible(self) -> bool:
        architectures = getattr(self.hf_config, "architectures", [])
1584
        return me_models.ModelRegistry.is_v1_compatible(architectures)
1585

1586
1587
    @property
    def is_matryoshka(self) -> bool:
1588
        return (bool(getattr(self.hf_config, "matryoshka_dimensions", None))
1589
1590
                or getattr(self.hf_config, "is_matryoshka", False))

1591
1592
1593
    @property
    def matryoshka_dimensions(self):
        return getattr(self.hf_config, "matryoshka_dimensions", None)
1594

1595
1596
1597
1598
1599
1600
    @property
    def use_pad_token(self) -> bool:
        # cross_encoder models defaults to using pad_token.
        # `llm as reranker` models defaults to not using pad_token.
        return getattr(self.hf_config, "use_pad_token", True)

1601
    def get_and_verify_max_len(self, max_model_len: int):
1602
1603
        # Consider max_model_len in tokenizer_config only when
        # pooling models use absolute position_embedding.
1604
        tokenizer_config = None
1605
1606
        if (self.runner_type == "pooling" and getattr(
                self.hf_config, "position_embedding_type", "") == "absolute"):
1607
1608
1609
1610
            tokenizer_config = try_get_tokenizer_config(
                self.tokenizer,
                trust_remote_code=self.trust_remote_code,
                revision=self.tokenizer_revision)
1611
1612
        max_model_len = _get_and_verify_max_len(
            hf_config=self.hf_text_config,
1613
            tokenizer_config=tokenizer_config,
1614
1615
1616
1617
1618
            max_model_len=max_model_len,
            disable_sliding_window=self.disable_sliding_window,
            sliding_window_len=self.get_hf_config_sliding_window(),
            spec_target_max_model_len=self.spec_target_max_model_len,
            encoder_config=self.encoder_config)
1619
        logger.info("Using max model len %s", max_model_len)
1620
1621
        return max_model_len

1622

1623
BlockSize = Literal[1, 8, 16, 32, 64, 128]
1624
CacheDType = Literal["auto", "fp8", "fp8_e4m3", "fp8_e5m2", "fp8_inc", "int8"]
1625
PrefixCachingHashAlgo = Literal["builtin", "sha256", "sha256_cbor_64bit"]
1626
1627
1628
1629


@config
@dataclass
1630
class CacheConfig:
1631
    """Configuration for the KV cache."""
1632

1633
    block_size: BlockSize = 16 if not envs.VLLM_USE_FLASH_ATTN_PA else 64  # type: ignore
1634
1635
1636
    """Size of a contiguous cache block in number of tokens. This is ignored on
    neuron devices and set to `--max-model-len`. On CUDA devices, only block
    sizes up to 32 are supported. On HPU devices, block size defaults to 128.
1637
1638

    This config has no static default. If left unspecified by the user, it will
1639
    be set in `Platform.check_and_update_config()` based on the current
1640
    platform."""
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
    gpu_memory_utilization: float = 0.9
    """The fraction of GPU memory to be used for the model executor, which can
    range from 0 to 1. For example, a value of 0.5 would imply 50% GPU memory
    utilization. If unspecified, will use the default value of 0.9. This is a
    per-instance limit, and only applies to the current vLLM instance. It does
    not matter if you have another vLLM instance running on the same GPU. For
    example, if you have two vLLM instances running on the same GPU, you can
    set the GPU memory utilization to 0.5 for each instance."""
    swap_space: float = 4
    """Size of the CPU swap space per GPU (in GiB)."""
    cache_dtype: CacheDType = "auto"
    """Data type for kv cache storage. If "auto", will use model data type.
    CUDA 11.8+ supports fp8 (=fp8_e4m3) and fp8_e5m2. ROCm (AMD GPU) supports
1654
    fp8 (=fp8_e4m3). Intel Gaudi (HPU) supports fp8 (using fp8_inc)."""
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
    is_attention_free: bool = False
    """Whether the model is attention-free. This is primarily set in
    `ModelConfig` and that value should be manually duplicated here."""
    num_gpu_blocks_override: Optional[int] = None
    """Number of GPU blocks to use. This overrides the profiled `num_gpu_blocks`
    if specified. Does nothing if `None`. Used for testing preemption."""
    sliding_window: Optional[int] = None
    """Sliding window size for the KV cache. This is primarily set in
    `ModelConfig` and that value should be manually duplicated here."""
    enable_prefix_caching: Optional[bool] = None
    """Whether to enable prefix caching. Disabled by default for V0. Enabled by
    default for V1."""
    prefix_caching_hash_algo: PrefixCachingHashAlgo = "builtin"
    """Set the hash algorithm for prefix caching:\n
    - "builtin" is Python's built-in hash.\n
1670
1671
1672
1673
1674
1675
    - "sha256" is collision resistant but with certain overheads.
    This option uses Pickle for object serialization before hashing.\n
    - "sha256_cbor_64bit" provides a reproducible, cross-language compatible 
    hash. It serializes objects using canonical CBOR and hashes them with 
    SHA-256. The resulting hash consists of the lower 64 bits of the SHA-256
    digest."""
1676
1677
1678
1679
1680
1681
1682
1683
    cpu_offload_gb: float = 0
    """The space in GiB to offload to CPU, per GPU. Default is 0, which means
    no offloading. Intuitively, this argument can be seen as a virtual way to
    increase the GPU memory size. For example, if you have one 24 GB GPU and
    set this to 10, virtually you can think of it as a 34 GB GPU. Then you can
    load a 13B model with BF16 weight, which requires at least 26GB GPU memory.
    Note that this requires fast CPU-GPU interconnect, as part of the model is
    loaded from CPU memory to GPU memory on the fly in each model forward pass.
1684
    """
1685
1686
1687
1688
    calculate_kv_scales: bool = False
    """This enables dynamic calculation of `k_scale` and `v_scale` when
    kv_cache_dtype is fp8. If `False`, the scales will be loaded from the model
    checkpoint if available. Otherwise, the scales will default to 1.0."""
1689
1690
    cpu_kvcache_space_bytes: Optional[int] = None
    """(CPU backend only) CPU key-value cache space."""
1691
1692
1693
    mamba_page_size_padded: Optional[int] = None
    """ Optional override for mamba page size; used by hybrid mamba/attention
    models to ensure exact alignment with attention page size."""
1694
1695
1696
1697
1698
1699

    # Will be set after profiling.
    num_gpu_blocks: Optional[int] = field(default=None, init=False)
    """The number of blocks to allocate for GPU memory."""
    num_cpu_blocks: Optional[int] = field(default=None, init=False)
    """The number of blocks to allocate for CPU memory."""
1700

1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
    def compute_hash(self) -> str:
        """
        WARNING: Whenever a new field is added to this config,
        ensure that it is included in the factors list if
        it affects the computation graph.

        Provide a hash that uniquely identifies all the configs
        that affect the structure of the computation
        graph from input ids/embeddings to the final hidden states,
        excluding anything before input ids/embeddings and after
        the final hidden states.
        """
1713
        factors: list[Any] = []
1714
1715
        factors.append(self.cache_dtype)
        # `cpu_offload_gb` does not use `torch.compile` yet.
1716
1717
        hash_str = hashlib.md5(str(factors).encode(),
                               usedforsecurity=False).hexdigest()
1718
1719
        return hash_str

1720
1721
1722
    def __post_init__(self) -> None:
        self.swap_space_bytes = self.swap_space * GiB_bytes

1723
        self._verify_cache_dtype()
1724
        self._verify_prefix_caching()
1725

1726
    def metrics_info(self):
1727
1728
        # convert cache_config to dict(key: str, value: str) for prometheus
        # metrics info
1729
1730
        return {key: str(value) for key, value in self.__dict__.items()}

1731
1732
    @model_validator(mode='after')
    def _verify_args(self) -> Self:
1733
1734
1735
1736
        if self.cpu_offload_gb < 0:
            raise ValueError("CPU offload space must be non-negative"
                             f", but got {self.cpu_offload_gb}")

1737
1738
1739
1740
1741
        if self.gpu_memory_utilization > 1.0:
            raise ValueError(
                "GPU memory utilization must be less than 1.0. Got "
                f"{self.gpu_memory_utilization}.")

1742
1743
        return self

1744
1745
1746
    def _verify_cache_dtype(self) -> None:
        if self.cache_dtype == "auto":
            pass
1747
        elif self.cache_dtype in get_args(CacheDType):
1748
            logger.info(
1749
1750
                "Using fp8 data type to store kv cache. It reduces the GPU "
                "memory footprint and boosts the performance. "
1751
                "Meanwhile, it may cause accuracy drop without a proper "
1752
                "scaling factor.")
1753
1754
1755
        else:
            raise ValueError(f"Unknown kv cache dtype: {self.cache_dtype}")

1756
1757
1758
1759
    def _verify_prefix_caching(self) -> None:
        if not self.enable_prefix_caching:
            return

1760
        if self.sliding_window is not None and not envs.VLLM_USE_V1:
1761
1762
1763
1764
            raise NotImplementedError(
                "Prefix caching is not supported with sliding window. "
                "Run with --disable-sliding-window to use prefix caching.")

1765
1766
        if (self.enable_prefix_caching and self.prefix_caching_hash_algo
                not in get_args(PrefixCachingHashAlgo)):
1767
1768
            raise ValueError(
                "Unknown prefix caching hash algorithm: "
1769
1770
                f"{self.prefix_caching_hash_algo}. Must be one of "
                f"{get_args(PrefixCachingHashAlgo)}.")
1771

1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
    def verify_with_parallel_config(
        self,
        parallel_config: "ParallelConfig",
    ) -> None:
        total_cpu_memory = get_cpu_memory()
        # FIXME(woosuk): Here, it is assumed that the GPUs in a tensor parallel
        # group are in the same node. However, the GPUs may span multiple nodes.
        num_gpus_per_node = parallel_config.tensor_parallel_size
        cpu_memory_usage = self.swap_space_bytes * num_gpus_per_node

1782
1783
1784
        msg = (f"{cpu_memory_usage / GiB_bytes:.2f} GiB out of the "
               f"{total_cpu_memory / GiB_bytes:.2f} GiB total CPU memory "
               "is allocated for the swap space.")
1785
1786
1787
        if cpu_memory_usage > 0.7 * total_cpu_memory:
            raise ValueError("Too large swap space. " + msg)
        elif cpu_memory_usage > 0.4 * total_cpu_memory:
1788
            logger.warning("Possibly too large swap space. %s", msg)
1789

1790

1791
1792
1793
1794
1795
1796
1797
class LoadFormat(str, enum.Enum):
    AUTO = "auto"
    PT = "pt"
    SAFETENSORS = "safetensors"
    NPCACHE = "npcache"
    DUMMY = "dummy"
    TENSORIZER = "tensorizer"
1798
    SHARDED_STATE = "sharded_state"
1799
    GGUF = "gguf"
1800
    BITSANDBYTES = "bitsandbytes"
1801
    MISTRAL = "mistral"
1802
    RUNAI_STREAMER = "runai_streamer"
1803
    RUNAI_STREAMER_SHARDED = "runai_streamer_sharded"
1804
    FASTSAFETENSORS = "fastsafetensors"
1805
1806


1807
@config
1808
1809
@dataclass
class LoadConfig:
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
    """Configuration for loading the model weights."""

    load_format: Union[str, LoadFormat,
                       "BaseModelLoader"] = LoadFormat.AUTO.value
    """The format of the model weights to load:\n
    - "auto" will try to load the weights in the safetensors format and fall
    back to the pytorch bin format if safetensors format is not available.\n
    - "pt" will load the weights in the pytorch bin format.\n
    - "safetensors" will load the weights in the safetensors format.\n
    - "npcache" will load the weights in pytorch format and store a numpy cache
    to speed up the loading.\n
    - "dummy" will initialize the weights with random values, which is mainly
    for profiling.\n
    - "tensorizer" will use CoreWeave's tensorizer library for fast weight
    loading. See the Tensorize vLLM Model script in the Examples section for
    more information.\n
    - "runai_streamer" will load the Safetensors weights using Run:ai Model
    Streamer.\n
    - "bitsandbytes" will load the weights using bitsandbytes quantization.\n
    - "sharded_state" will load weights from pre-sharded checkpoint files,
    supporting efficient loading of tensor-parallel models.\n
    - "gguf" will load weights from GGUF format files (details specified in
    https://github.com/ggml-org/ggml/blob/master/docs/gguf.md).\n
    - "mistral" will load weights from consolidated safetensors files used by
    Mistral models."""
1835
    download_dir: Optional[str] = None
1836
1837
    """Directory to download and load the weights, default to the default
    cache directory of Hugging Face."""
1838
1839
    model_loader_extra_config: Union[dict, TensorizerConfig] = field(
        default_factory=dict)
1840
    """Extra config for model loader. This will be passed to the model loader
1841
    corresponding to the chosen load_format."""
1842
1843
1844
    device: Optional[str] = None
    """Device to which model weights will be loaded, default to
    device_config.device"""
1845
    ignore_patterns: Optional[Union[list[str], str]] = None
1846
1847
    """The list of patterns to ignore when loading the model. Default to
    "original/**/*" to avoid repeated loading of llama's checkpoints."""
1848
    use_tqdm_on_load: bool = True
1849
1850
    """Whether to enable tqdm for showing progress bar when loading model
    weights."""
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
    pt_load_map_location: Union[str, dict[str, str]] = "cpu"
    """
    pt_load_map_location: the map location for loading pytorch checkpoint, to
    support loading checkpoints can only be loaded on certain devices like
    "cuda", this is equivalent to {"": "cuda"}. Another supported format is
    mapping from different devices like from GPU 1 to GPU 0:
    {"cuda:1": "cuda:0"}. Note that when passed from command line, the strings
    in dictionary needs to be double quoted for json parsing. For more details,
    see original doc for `map_location` in https://pytorch.org/docs/stable/generated/torch.load.html
    """
1861

1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
    def compute_hash(self) -> str:
        """
        WARNING: Whenever a new field is added to this config,
        ensure that it is included in the factors list if
        it affects the computation graph.

        Provide a hash that uniquely identifies all the configs
        that affect the structure of the computation
        graph from input ids/embeddings to the final hidden states,
        excluding anything before input ids/embeddings and after
        the final hidden states.
        """
        # no factors to consider.
        # this config will not affect the computation graph.
1876
        factors: list[Any] = []
1877
1878
        hash_str = hashlib.md5(str(factors).encode(),
                               usedforsecurity=False).hexdigest()
1879
1880
        return hash_str

1881
    def __post_init__(self):
1882
1883
1884
        if isinstance(self.load_format, str):
            load_format = self.load_format.lower()
            self.load_format = LoadFormat(load_format)
1885

1886
1887
1888
1889
1890
1891
1892
        if self.ignore_patterns is not None and len(self.ignore_patterns) > 0:
            logger.info(
                "Ignoring the following patterns when downloading weights: %s",
                self.ignore_patterns)
        else:
            self.ignore_patterns = ["original/**/*"]

1893

1894
1895
1896
DistributedExecutorBackend = Literal["ray", "mp", "uni", "external_launcher"]


1897
@config
1898
@dataclass
1899
class ParallelConfig:
1900
    """Configuration for the distributed execution."""
1901

1902
1903
1904
1905
1906
1907
1908
    pipeline_parallel_size: int = 1
    """Number of pipeline parallel groups."""
    tensor_parallel_size: int = 1
    """Number of tensor parallel groups."""
    data_parallel_size: int = 1
    """Number of data parallel groups. MoE layers will be sharded according to
    the product of the tensor parallel size and data parallel size."""
1909
1910
    data_parallel_size_local: int = 1
    """Number of local data parallel groups."""
1911
1912
    data_parallel_rank: int = 0
    """Rank of the data parallel group."""
1913
1914
1915
    data_parallel_rank_local: Optional[int] = None
    """Local rank of the data parallel group,
    set only in SPMD mode."""
1916
    data_parallel_master_ip: str = "127.0.0.1"
1917
    """IP of the data parallel master."""
1918
1919
    data_parallel_rpc_port: int = 29550
    """Port for data parallel messaging."""
1920
1921
    data_parallel_master_port: int = 29500
    """Port of the data parallel master."""
Rui Qiao's avatar
Rui Qiao committed
1922
1923
    data_parallel_backend: str = "mp"
    """Backend to use for data parallel, either "mp" or "ray"."""
1924
1925
    data_parallel_external_lb: bool = False
    """Whether to use "external" DP LB mode. Applies only to online serving
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
    and when data_parallel_size > 0. This is useful for a "one-pod-per-rank"
    wide-EP setup in Kuberentes. Set implicitly when --data-parallel-rank
    is provided explicitly to vllm serve."""
    data_parallel_hybrid_lb: bool = False
    """Whether to use "hybrid" DP LB mode. Applies only to online serving
    and when data_parallel_size > 0. Enables running an AsyncLLM
    and API server on a "per-node" basis where vLLM load balances
    between local data parallel ranks, but an external LB balances
    between vLLM nodes/replicas. Set explicitly in conjunction with 
    --data-parallel-start-rank."""
1936
1937
    enable_expert_parallel: bool = False
    """Use expert parallelism instead of tensor parallelism for MoE layers."""
1938
1939
1940
1941
1942
1943
1944
1945
1946
    enable_eplb: bool = False
    """Enable expert parallelism load balancing for MoE layers."""
    num_redundant_experts: int = 0
    """Number of redundant experts to use for expert parallelism."""
    eplb_window_size: int = 1000
    """Window size for expert load recording."""
    eplb_step_interval: int = 3000
    """
    Interval for rearranging experts in expert parallelism.
1947

1948
1949
1950
1951
1952
1953
1954
1955
1956
    Note that if this is greater than the EPLB window size, only the metrics
    of the last `eplb_window_size` steps will be used for rearranging experts.
    """
    eplb_log_balancedness: bool = False
    """
    Log the balancedness each step of expert parallelism.
    This is turned off by default since it will cause communication overhead.
    """

1957
    max_parallel_loading_workers: Optional[int] = None
1958
    """Maximum number of parallel loading workers when loading model
1959
1960
    sequentially in multiple batches. To avoid RAM OOM when using tensor
    parallel and large models."""
1961

1962
    disable_custom_all_reduce: bool = False
1963
    """Disable the custom all-reduce kernel and fall back to NCCL."""
1964

1965
    ray_workers_use_nsight: bool = False
1966
    """Whether to profile Ray workers with nsight, see https://docs.ray.io/en/latest/ray-observability/user-guides/profiling.html#profiling-nsight-profiler."""
1967
1968

    placement_group: Optional["PlacementGroup"] = None
1969
    """ray distributed model workers placement group."""
1970

1971
    distributed_executor_backend: Optional[Union[DistributedExecutorBackend,
1972
                                                 type["ExecutorBase"]]] = None
1973
1974
1975
1976
1977
1978
    """Backend to use for distributed model
    workers, either "ray" or "mp" (multiprocessing). If the product
    of pipeline_parallel_size and tensor_parallel_size is less than
    or equal to the number of GPUs available, "mp" will be used to
    keep processing on a single host. Otherwise, this will default
    to "ray" if Ray is installed and fail otherwise. Note that tpu
1979
    only support Ray for distributed inference."""
1980
1981

    worker_cls: str = "auto"
1982
1983
    """The full name of the worker class to use. If "auto", the worker class
    will be determined based on the platform."""
1984
    sd_worker_cls: str = "auto"
Ning Xie's avatar
Ning Xie committed
1985
    """The full name of the worker class to use for speculative decoding.
1986
    If "auto", the worker class will be determined based on the platform."""
1987
    worker_extension_cls: str = ""
1988
1989
1990
1991
    """The full name of the worker extension class to use. The worker extension
    class is dynamically inherited by the worker class. This is used to inject
    new attributes and methods to the worker class for use in collective_rpc
    calls."""
1992
1993

    world_size: int = field(init=False)
1994
    """world_size is TPxPP, it affects the number of workers we create."""
1995
1996

    rank: int = 0
1997
    """Global rank in distributed setup."""
1998

1999
    enable_multimodal_encoder_data_parallel: bool = False
2000
    """ Use data parallelism instead of tensor parallelism for vision encoder.
2001
2002
    Only support LLama4 for now"""

2003
2004
2005
2006
2007
2008
    @property
    def world_size_across_dp(self) -> int:
        """world_size_across_dp is TPxPPxDP, it is the size of the world
        including data parallelism."""
        return self.world_size * self.data_parallel_size

2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
    def get_next_dp_init_port(self) -> int:
        """
        We might need to initialize process groups in multiple
        processes that is related to data parallelism,
        e.g. both in the worker and in the engine, which
        can live in different processes. To avoid port conflicts, we
        increment the port number each time we need to initialize a
        new process group related to data parallelism.
        """
        answer = self.data_parallel_master_port
        self.data_parallel_master_port += 1
        return answer

    def stateless_init_dp_group(self) -> "ProcessGroup":
2023
2024
2025
2026
2027
2028
2029
2030
2031
        # NOTE: In high-concurrency scenarios multiple processes
        # can pick the same (currently free) port through a race
        # condition when calling `get_open_port()`. When the first
        # process binds the port the others will subsequently fail
        # with `torch.distributed.DistNetworkError: EADDRINUSE`.
        # To make the initialization more robust we retry a few times
        # with a fresh port whenever this specific error is observed.
        from torch.distributed import DistNetworkError

2032
2033
2034
        from vllm.distributed.utils import (
            stateless_init_torch_distributed_process_group)

2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
        max_retries = 5
        last_exc: Optional[Exception] = None
        for _ in range(max_retries):
            try:
                # use gloo since the engine process might not have cuda device
                return stateless_init_torch_distributed_process_group(
                    self.data_parallel_master_ip,
                    self.get_next_dp_init_port(),
                    self.data_parallel_rank,
                    self.data_parallel_size,
                    backend="gloo")
            except DistNetworkError as e:
                # We only want to retry when the root cause is EADDRINUSE.
                if "EADDRINUSE" in str(e):
                    logger.warning(
                        "Address already in use. Retrying with a new port.")
                    last_exc = e
                    continue  # try again with a new port
                raise e
2054

2055
2056
2057
        # If we get here all retries have failed.
        assert last_exc is not None
        raise last_exc
2058
2059
2060

    @staticmethod
    def has_unfinished_dp(dp_group: "ProcessGroup",
youkaichao's avatar
youkaichao committed
2061
                          has_unfinished: bool) -> bool:
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
        tensor = torch.tensor([has_unfinished],
                              dtype=torch.int32,
                              device="cpu")
        # dp rank 0: has_unfinished_seqs=True
        # dp rank 1: has_unfinished_seqs=False
        # aggregated: has_unfinished_seqs=True
        # so this is an OR operation, i.e. MAX in integers
        torch.distributed.all_reduce(tensor, op=ReduceOp.MAX, group=dp_group)
        aggregated_has_unfinished = bool(tensor.item())
        return aggregated_has_unfinished

2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
    @staticmethod
    def sync_kv_cache_memory_size(dp_group: "ProcessGroup",
                                  kv_cache_memory: int) -> int:
        if kv_cache_memory == -1:
            kv_cache_memory = torch.iinfo(torch.int64).max
        tensor = torch.tensor([kv_cache_memory],
                              dtype=torch.int64,
                              device="cpu")
        # we cannot use broadcast for stateless dp group since it depends
        # on global rank
        torch.distributed.all_reduce(tensor, op=ReduceOp.MIN, group=dp_group)
        return tensor.item()

2086
2087
2088
2089
2090
2091
2092
2093
    def compute_hash(self):
        """
        Provide a hash that uniquely identifies all the configs
        that affect the structure of the computation
        graph from input ids/embeddings to the final hidden states,
        excluding anything before input ids/embeddings and after
        the final hidden states.
        """
2094
        factors: list[Any] = []
2095
2096
        factors.append(self.pipeline_parallel_size)
        factors.append(self.tensor_parallel_size)
2097
        factors.append(self.enable_expert_parallel)
2098
2099
        factors.append(self.data_parallel_size)
        factors.append(envs.VLLM_ALL2ALL_BACKEND)
2100
2101
        return hashlib.sha256(str(factors).encode()).hexdigest()

2102
2103
2104
2105
    def __post_init__(self) -> None:
        self.world_size = self.pipeline_parallel_size * \
            self.tensor_parallel_size

2106
2107
2108
2109
2110
2111
        if self.data_parallel_size_local > self.data_parallel_size:
            raise ValueError(
                f"data_parallel_size_local ({self.data_parallel_size_local}) "
                f"must be <= data_parallel_size ({self.data_parallel_size})")

        if self.data_parallel_size > 1 or self.data_parallel_size_local == 0:
2112
2113
            # Data parallel was specified in the engine args.
            self.data_parallel_master_port = get_open_port()
2114
2115
2116
2117
2118

            if not (0 <= self.data_parallel_rank < self.data_parallel_size):
                raise ValueError(
                    f"data_parallel_rank ({self.data_parallel_rank})"
                    f" must be in the range [0, {self.data_parallel_size})")
2119
2120
2121
2122
2123
2124
2125
2126
        else:
            # Otherwise fall back to env vars (e.g. for offline SPMD case).
            self.data_parallel_size = envs.VLLM_DP_SIZE
            self.data_parallel_rank = envs.VLLM_DP_RANK
            self.data_parallel_rank_local = envs.VLLM_DP_RANK_LOCAL
            self.data_parallel_master_ip = envs.VLLM_DP_MASTER_IP
            self.data_parallel_master_port = envs.VLLM_DP_MASTER_PORT

2127
2128
2129
2130
            if self.data_parallel_external_lb:
                raise ValueError("data_parallel_external_lb can only "
                                 "be set when data_parallel_size > 1")

2131
2132
2133
2134
2135
        if self.distributed_executor_backend == "external_launcher":
            import os
            os.environ["VLLM_ENABLE_V1_MULTIPROCESSING"] = "0"
            logger.info("Disabling V1 multiprocessing for external launcher.")

2136
2137
        if self.enable_eplb:
            if not current_platform.is_cuda():
2138
                raise ValueError(
2139
2140
2141
2142
2143
2144
                    "Expert parallelism load balancing is only supported on "
                    "CUDA devices now.")
            if self.num_redundant_experts < 0:
                raise ValueError(
                    "num_redundant_experts must be non-negative, but got "
                    f"{self.num_redundant_experts}.")
2145
2146
2147
2148
2149
2150
2151
2152
2153
            if not self.enable_expert_parallel:
                raise ValueError(
                    "enable_expert_parallel must be True to use EPLB.")
            if self.tensor_parallel_size * self.data_parallel_size <= 1:
                raise ValueError(
                    "EPLB requires tensor_parallel_size or data_parallel_size "
                    f"to be greater than 1, but got "
                    f"TP={self.tensor_parallel_size},DP={self.data_parallel_size}."
                )
2154
2155
2156
2157
2158
        else:
            if self.num_redundant_experts != 0:
                raise ValueError(
                    "num_redundant_experts should be used with EPLB."
                    f"{self.num_redundant_experts}.")
2159
        if self.distributed_executor_backend is None and self.world_size > 1:
2160
2161
2162
            # We use multiprocessing by default if world_size fits on the
            # current node and we aren't in a ray placement group.

2163
            from vllm.executor import ray_utils
2164
            backend: DistributedExecutorBackend = "mp"
2165
            ray_found = ray_utils.ray_is_available()
2166
2167
2168
            if current_platform.is_neuron():
                # neuron uses single process to control multiple devices
                backend = "uni"
2169
            elif current_platform.is_tpu() and envs.VLLM_XLA_USE_SPMD:
2170
2171
2172
                backend = "uni"
            elif (current_platform.is_cuda()
                  and cuda_device_count_stateless() < self.world_size):
2173
                if not ray_found:
2174
2175
                    raise ValueError("Unable to load Ray: "
                                     f"{ray_utils.ray_import_err}. Ray is "
2176
2177
                                     "required for multi-node inference, "
                                     "please install Ray with `pip install "
2178
                                     "ray`.")
2179
                backend = "ray"
Rui Qiao's avatar
Rui Qiao committed
2180
2181
2182
2183
            elif self.data_parallel_backend == "ray":
                logger.info("Using ray distributed inference because "
                            "data_parallel_backend is ray")
                backend = "ray"
2184
            elif ray_found:
2185
                if self.placement_group:
2186
                    backend = "ray"
2187
2188
2189
2190
2191
2192
                else:
                    from ray import is_initialized as ray_is_initialized
                    if ray_is_initialized():
                        from ray.util import get_current_placement_group
                        if get_current_placement_group():
                            backend = "ray"
2193
            self.distributed_executor_backend = backend
2194
2195
            logger.debug("Defaulting to use %s for distributed inference",
                         backend)
2196

2197
2198
2199
        if self.distributed_executor_backend is None and self.world_size == 1:
            self.distributed_executor_backend = "uni"

2200
2201
2202
2203
2204
2205
    @property
    def use_ray(self) -> bool:
        return self.distributed_executor_backend == "ray" or (
            isinstance(self.distributed_executor_backend, type)
            and self.distributed_executor_backend.uses_ray)

2206
2207
    @model_validator(mode='after')
    def _verify_args(self) -> Self:
2208
2209
        # Lazy import to avoid circular import
        from vllm.executor.executor_base import ExecutorBase
2210
        from vllm.platforms import current_platform
2211
        if self.distributed_executor_backend not in (
2212
2213
                "ray", "mp", "uni",
                "external_launcher", None) and not (isinstance(
2214
2215
                    self.distributed_executor_backend, type) and issubclass(
                        self.distributed_executor_backend, ExecutorBase)):
2216
            raise ValueError(
2217
2218
                "Unrecognized distributed executor backend "
                f"{self.distributed_executor_backend}. Supported "
2219
2220
                "values are 'ray', 'mp' 'uni', 'external_launcher' or"
                " custom ExecutorBase subclass.")
2221
        if self.use_ray:
2222
2223
            from vllm.executor import ray_utils
            ray_utils.assert_ray_available()
2224

zhuwenwen's avatar
zhuwenwen committed
2225
        # if not current_platform.use_custom_allreduce():
zhuwenwen's avatar
zhuwenwen committed
2226
        #     self.disable_custom_all_reduce = True
zhuwenwen's avatar
zhuwenwen committed
2227
        #     logger.debug(
zhuwenwen's avatar
zhuwenwen committed
2228
        #         "Disabled the custom all-reduce kernel because it is not "
zhuwenwen's avatar
zhuwenwen committed
2229
        #         "supported on current platform.")
2230
        if self.ray_workers_use_nsight and not self.use_ray:
2231
2232
            raise ValueError("Unable to use nsight profiling unless workers "
                             "run with Ray.")
2233

2234
        return self
2235

2236

2237
PreemptionMode = Literal["swap", "recompute"]
2238
2239
2240
2241
SchedulerPolicy = Literal["fcfs", "priority"]


@config
2242
@dataclass
2243
class SchedulerConfig:
2244
    """Scheduler configuration."""
2245

2246
2247
    runner_type: RunnerType = "generate"
    """The runner type to launch for the model."""
2248

2249
    max_num_batched_tokens: SkipValidation[int] = None  # type: ignore
2250
    """Maximum number of tokens to be processed in a single iteration.
2251

2252
2253
    This config has no static default. If left unspecified by the user, it will
    be set in `EngineArgs.create_engine_config` based on the usage context."""
2254

2255
    max_num_seqs: SkipValidation[int] = None  # type: ignore
2256
    """Maximum number of sequences to be processed in a single iteration.
2257

2258
2259
    This config has no static default. If left unspecified by the user, it will
    be set in `EngineArgs.create_engine_config` based on the usage context."""
2260

2261
    max_model_len: SkipValidation[int] = None  # type: ignore
2262
2263
2264
    """Maximum length of a sequence (including prompt and generated text). This
    is primarily set in `ModelConfig` and that value should be manually
    duplicated here."""
2265

2266
    max_num_partial_prefills: int = 1
2267
2268
    """For chunked prefill, the maximum number of sequences that can be
    partially prefilled concurrently."""
2269
2270

    max_long_partial_prefills: int = 1
2271
2272
2273
2274
    """For chunked prefill, the maximum number of prompts longer than
    long_prefill_token_threshold that will be prefilled concurrently. Setting
    this less than max_num_partial_prefills will allow shorter prompts to jump
    the queue in front of longer prompts in some cases, improving latency."""
2275
2276

    long_prefill_token_threshold: int = 0
2277
2278
    """For chunked prefill, a request is considered long if the prompt is
    longer than this number of tokens."""
2279

2280
    num_lookahead_slots: int = 0
2281
2282
2283
2284
2285
2286
2287
    """The number of slots to allocate per sequence per
    step, beyond the known token ids. This is used in speculative
    decoding to store KV activations of tokens which may or may not be
    accepted.

    NOTE: This will be replaced by speculative config in the future; it is
    present to enable correctness tests until then."""
2288

2289
2290
2291
2292
    cuda_graph_sizes: list[int] = field(default_factory=list)
    """Cuda graph capture sizes
    1. if none provided, then default set to [min(max_num_seqs * 2, 512)]
    2. if one value is provided, then the capture list would follow the
2293
    pattern: [1, 2, 4] + [i for i in range(8, cuda_graph_sizes + 1, 8)]
2294
    3. more than one value (e.g. 1 2 128) is provided, then the capture list
2295
    will follow the provided list."""
2296

2297
    delay_factor: float = 0.0
2298
2299
    """Apply a delay (of delay factor multiplied by previous
    prompt latency) before scheduling next prompt."""
2300

2301
    enable_chunked_prefill: SkipValidation[bool] = None  # type: ignore
2302
2303
    """If True, prefill requests can be chunked based
    on the remaining max_num_batched_tokens."""
2304
2305

    is_multimodal_model: bool = False
2306
2307
2308
2309
2310
    """True if the model is multimodal."""

    # TODO (ywang96): Make this configurable.
    max_num_encoder_input_tokens: int = field(init=False)
    """Multimodal encoder compute budget, only used in V1.
2311

2312
2313
    NOTE: This is not currently configurable. It will be overridden by
    max_num_batched_tokens in case max multimodal embedding size is larger."""
2314

2315
2316
2317
    # TODO (ywang96): Make this configurable.
    encoder_cache_size: int = field(init=False)
    """Multimodal encoder cache size, only used in V1.
2318

2319
2320
    NOTE: This is not currently configurable. It will be overridden by
    max_num_batched_tokens in case max multimodal embedding size is larger."""
2321

2322
    preemption_mode: Optional[PreemptionMode] = None
2323
2324
2325
2326
2327
2328
    """Whether to perform preemption by swapping or
    recomputation. If not specified, we determine the mode as follows:
    We use recomputation by default since it incurs lower overhead than
    swapping. However, when the sequence group has multiple sequences
    (e.g., beam search), recomputation is not currently supported. In
    such a case, we use swapping instead."""
2329
2330

    num_scheduler_steps: int = 1
2331
    """Maximum number of forward steps per scheduler call."""
2332

2333
2334
    multi_step_stream_outputs: bool = True
    """If False, then multi-step will stream outputs at the end of all steps"""
2335
2336

    send_delta_data: bool = False
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
    """Private API. If used, scheduler sends delta data to
    workers instead of an entire data. It should be enabled only
    when SPMD worker architecture is enabled. I.e.,
    VLLM_USE_RAY_SPMD_WORKER=1"""

    policy: SchedulerPolicy = "fcfs"
    """The scheduling policy to use:\n
    - "fcfs" means first come first served, i.e. requests are handled in order
    of arrival.\n
    - "priority" means requests are handled based on given priority (lower
    value means earlier handling) and time of arrival deciding any ties)."""
2348
2349

    chunked_prefill_enabled: bool = field(init=False)
2350
    """True if chunked prefill is enabled."""
2351

2352
    disable_chunked_mm_input: bool = False
2353
2354
2355
2356
2357
2358
    """If set to true and chunked prefill is enabled, we do not want to
    partially schedule a multimodal item. Only used in V1
    This ensures that if a request has a mixed prompt
    (like text tokens TTTT followed by image tokens IIIIIIIIII) where only
    some image tokens can be scheduled (like TTTTIIIII, leaving IIIII),
    it will be scheduled as TTTT in one step and IIIIIIIIII in the next."""
2359

2360
2361
    # scheduler class or path. "vllm.core.scheduler.Scheduler" (default)
    # or "mod.custom_class".
2362
    scheduler_cls: Union[str, type[object]] = "vllm.core.scheduler.Scheduler"
2363
2364
2365
    """The scheduler class to use. "vllm.core.scheduler.Scheduler" is the
    default scheduler. Can be a class directly or the path to a class of form
    "mod.custom_class"."""
2366

2367
2368
2369
2370
2371
2372
    disable_hybrid_kv_cache_manager: bool = False
    """If set to True, KV cache manager will allocate the same size of KV cache
    for all attention layers even if there are multiple type of attention layers
    like full attention and sliding window attention.
    """

2373
2374
2375
2376
2377
2378
2379
    async_scheduling: bool = False
    """EXPERIMENTAL: If set to True, perform async scheduling. This may help
    reduce the CPU overheads, leading to better latency and throughput. However,
    async scheduling is currently not supported with some features such as
    structured outputs, speculative decoding, and pipeline parallelism.
    """

2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
    def compute_hash(self) -> str:
        """
        WARNING: Whenever a new field is added to this config,
        ensure that it is included in the factors list if
        it affects the computation graph.

        Provide a hash that uniquely identifies all the configs
        that affect the structure of the computation
        graph from input ids/embeddings to the final hidden states,
        excluding anything before input ids/embeddings and after
        the final hidden states.
        """
        # no factors to consider.
        # this config will not affect the computation graph.
2394
        factors: list[Any] = []
2395
2396
        hash_str = hashlib.md5(str(factors).encode(),
                               usedforsecurity=False).hexdigest()
2397
2398
        return hash_str

2399
    def __post_init__(self) -> None:
2400
2401
2402
2403
2404
2405
        if self.max_model_len is None:
            self.max_model_len = 8192

        if self.max_num_seqs is None:
            self.max_num_seqs = 128

2406
2407
2408
        if self.max_num_batched_tokens is None:
            if self.enable_chunked_prefill:
                if self.num_scheduler_steps > 1:
2409
2410
2411
2412
                    # Multi-step Chunked-Prefill doesn't allow prompt-chunking
                    # for now. Have max_num_batched_tokens set to max_model_len
                    # so we don't reject sequences on account of a short
                    # max_num_batched_tokens.
2413
                    self.max_num_batched_tokens = max(
2414
                        self.max_model_len, DEFAULT_MAX_NUM_BATCHED_TOKENS)
2415
                else:
2416
                    self.max_num_batched_tokens = (
2417
                        DEFAULT_MAX_NUM_BATCHED_TOKENS)
2418
            else:
2419
                # If max_model_len is too short, use
2420
                # DEFAULT_MAX_NUM_BATCHED_TOKENS as the default value
2421
                # for higher throughput.
2422
                self.max_num_batched_tokens = max(
2423
                    self.max_model_len, DEFAULT_MAX_NUM_BATCHED_TOKENS)
2424

2425
2426
            if self.runner_type == "pooling":
                # Choose specific value for higher throughput
2427
2428
                self.max_num_batched_tokens = max(
                    self.max_num_batched_tokens,
2429
                    POOLING_MODEL_MAX_NUM_BATCHED_TOKENS,
2430
                )
2431
            if self.is_multimodal_model:
2432
                # The value needs to be at least the number of multimodal tokens
2433
2434
                self.max_num_batched_tokens = max(
                    self.max_num_batched_tokens,
2435
                    MULTIMODAL_MODEL_MAX_NUM_BATCHED_TOKENS,
2436
2437
                )

2438
2439
2440
2441
2442
2443
2444
            # 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 * self.max_model_len,
                self.max_num_batched_tokens)

2445
2446
2447
        self.max_num_encoder_input_tokens = self.max_num_batched_tokens
        self.encoder_cache_size = self.max_num_batched_tokens

2448
        if self.enable_chunked_prefill:
2449
2450
            logger.info(
                "Chunked prefill is enabled with max_num_batched_tokens=%d.",
2451
                self.max_num_batched_tokens)
2452

2453
        self.chunked_prefill_enabled = self.enable_chunked_prefill
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
        if self.max_num_partial_prefills > 1:
            if self.long_prefill_token_threshold == 0:
                self.long_prefill_token_threshold = int(self.max_model_len *
                                                        0.04)

            logger.info(
                "Concurrent partial prefills enabled with "
                "max_num_partial_prefills=%d, max_long_partial_prefills=%d, "
                "long_prefill_token_threshold=%d",
                self.max_num_partial_prefills, self.max_long_partial_prefills,
                self.long_prefill_token_threshold)

2466
2467
2468
2469
2470
2471
2472
        # NOTE: Default set cuda_graph_sizes to [min(max_num_seqs * 2, 512)].
        # This avoids OOM in tight memory scenarios with small max_num_seqs,
        # and prevents capture of many large graphs (>512) that would greatly
        # increase startup time with limited performance benefit.
        if not self.cuda_graph_sizes:
            self.cuda_graph_sizes = [min(self.max_num_seqs * 2, 512)]

2473
2474
2475
2476
        if self.async_scheduling:
            self.scheduler_cls = (
                "vllm.v1.core.sched.async_scheduler.AsyncScheduler")

2477
2478
    @model_validator(mode='after')
    def _verify_args(self) -> Self:
2479
2480
        if (self.max_num_batched_tokens < self.max_model_len
                and not self.chunked_prefill_enabled):
2481
2482
2483
2484
2485
2486
2487
            raise ValueError(
                f"max_num_batched_tokens ({self.max_num_batched_tokens}) is "
                f"smaller than max_model_len ({self.max_model_len}). "
                "This effectively limits the maximum sequence length to "
                "max_num_batched_tokens and makes vLLM reject longer "
                "sequences. Please increase max_num_batched_tokens or "
                "decrease max_model_len.")
2488

2489
2490
2491
2492
2493
        if self.max_num_batched_tokens < self.max_num_seqs:
            raise ValueError(
                f"max_num_batched_tokens ({self.max_num_batched_tokens}) must "
                "be greater than or equal to max_num_seqs "
                f"({self.max_num_seqs}).")
2494

2495
2496
        if self.max_num_batched_tokens > self.max_num_seqs * self.max_model_len:
            logger.warning(
2497
                "max_num_batched_tokens (%d) exceeds max_num_seqs "
2498
2499
2500
2501
                "* max_model_len (%d). This may lead to unexpected behavior.",
                self.max_num_batched_tokens,
                self.max_num_seqs * self.max_model_len)

2502
2503
2504
2505
2506
2507
        if self.num_lookahead_slots < 0:
            raise ValueError(
                "num_lookahead_slots "
                f"({self.num_lookahead_slots}) must be greater than or "
                "equal to 0.")

2508
2509
2510
2511
2512
2513
        if self.num_scheduler_steps < 1:
            raise ValueError(
                "num_scheduler_steps "
                f"({self.num_scheduler_steps}) must be greater than or "
                "equal to 1.")

2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
        if self.max_num_partial_prefills < 1:
            raise ValueError(
                f"max_num_partial_prefills ({self.max_num_partial_prefills}) "
                "must be greater than or equal to 1.")
        elif self.max_num_partial_prefills > 1:
            if not self.chunked_prefill_enabled:
                raise ValueError("Chunked prefill must be enabled to set "
                                 "max_num_partial_prefills > 1.")

            if self.long_prefill_token_threshold > self.max_model_len:
                raise ValueError(
                    "long_prefill_token_threshold "
                    f"({self.long_prefill_token_threshold}) cannot be greater "
                    f"than the max_model_len ({self.max_model_len}).")

        if (self.max_long_partial_prefills
                < 1) or (self.max_long_partial_prefills
                         > self.max_num_partial_prefills):
            raise ValueError(
                f"max_long_partial_prefills ({self.max_long_partial_prefills}) "
                "must be greater than or equal to 1 and less than or equal to "
                f"max_num_partial_prefills ({self.max_num_partial_prefills}).")

2537
2538
        return self

2539
2540
2541
2542
    @property
    def is_multi_step(self) -> bool:
        return self.num_scheduler_steps > 1

2543

2544
Device = Literal["auto", "cuda", "neuron", "cpu", "tpu", "xpu"]
2545
2546
2547


@config
2548
@dataclass(config=ConfigDict(arbitrary_types_allowed=True))
2549
class DeviceConfig:
2550
2551
    """Configuration for the device to use for vLLM execution."""

2552
    device: SkipValidation[Optional[Union[Device, torch.device]]] = "auto"
2553
    """Device type for vLLM execution.
2554
2555
2556
    This parameter is deprecated and will be
    removed in a future release.
    It will now be set automatically based
2557
    on the current platform."""
2558
2559
2560
    device_type: str = field(init=False)
    """Device type from the current platform. This is set in
    `__post_init__`."""
2561

2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
    def compute_hash(self) -> str:
        """
        WARNING: Whenever a new field is added to this config,
        ensure that it is included in the factors list if
        it affects the computation graph.

        Provide a hash that uniquely identifies all the configs
        that affect the structure of the computation
        graph from input ids/embeddings to the final hidden states,
        excluding anything before input ids/embeddings and after
        the final hidden states.
        """
        # no factors to consider.
        # the device/platform information will be summarized
        # by torch/vllm automatically.
2577
        factors: list[Any] = []
2578
2579
        hash_str = hashlib.md5(str(factors).encode(),
                               usedforsecurity=False).hexdigest()
2580
        return hash_str
2581

2582
2583
    def __post_init__(self):
        if self.device == "auto":
2584
            # Automated device type detection
2585
            from vllm.platforms import current_platform
2586
            self.device_type = current_platform.device_type
2587
            if not self.device_type:
2588
2589
2590
2591
                raise RuntimeError(
                    "Failed to infer device type, please set "
                    "the environment variable `VLLM_LOGGING_LEVEL=DEBUG` "
                    "to turn on verbose logging to help debug the issue.")
2592
2593
        else:
            # Device type is assigned explicitly
2594
2595
2596
2597
            if isinstance(self.device, str):
                self.device_type = self.device
            elif isinstance(self.device, torch.device):
                self.device_type = self.device.type
2598
2599

        # Some device types require processing inputs on CPU
2600
        if self.device_type in ["neuron"]:
2601
            self.device = torch.device("cpu")
2602
2603
        elif self.device_type in ["tpu"]:
            self.device = None
2604
2605
2606
2607
        else:
            # Set device with device type
            self.device = torch.device(self.device_type)

2608

2609
2610
SpeculativeMethod = Literal["ngram", "eagle", "eagle3", "medusa",
                            "mlp_speculator", "draft_model", "deepseek_mtp"]
2611
2612
2613


@config
2614
@dataclass
2615
class SpeculativeConfig:
2616
    """Configuration for speculative decoding."""
2617

2618
    # General speculative decoding control
2619
    num_speculative_tokens: SkipValidation[int] = None  # type: ignore
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
    """The number of speculative tokens, if provided. It will default to the
    number in the draft model config if present, otherwise, it is required."""
    model: Optional[str] = None
    """The name of the draft model, eagle head, or additional weights, if
    provided."""
    method: Optional[SpeculativeMethod] = None
    """The name of the speculative method to use. If users provide and set the
    `model` param, the speculative method type will be detected automatically
    if possible, if `model` param is not provided, the method name must be
    provided.

    If using `ngram` method, the related configuration `prompt_lookup_max` and
    `prompt_lookup_min` should be considered."""
2633
    draft_tensor_parallel_size: Optional[int] = None
2634
2635
    """The degree of the tensor parallelism for the draft model. Can only be 1
    or the same as the target model's tensor parallel size."""
2636
    disable_logprobs: bool = True
2637
2638
2639
    """If set to True, token log probabilities are not returned during
    speculative decoding. If set to False, token log probabilities are returned
    according to the log probability settings in SamplingParams."""
2640

2641
    # Draft model configuration
2642
    quantization: Optional[me_quant.QuantizationMethods] = None
2643
2644
2645
    """Quantization method that was used to quantize the draft model weights.
    If `None`, we assume the model weights are not quantized. Note that it only
    takes effect when using the draft model-based speculative method."""
2646
    max_model_len: Optional[int] = None
2647
2648
    """The maximum model length of the draft model. Used when testing the
    ability to skip speculation for some sequences."""
2649
    revision: Optional[str] = None
2650
2651
2652
    """The specific model version to use for the draft model. It can be a
    branch name, a tag name, or a commit id. If unspecified, will use the
    default version."""
2653
    code_revision: Optional[str] = None
2654
2655
2656
    """The specific revision to use for the draft model code on Hugging Face
    Hub. It can be a branch name, a tag name, or a commit id. If unspecified,
    will use the default version."""
2657

2658
    # Advanced control
2659
    disable_by_batch_size: Optional[int] = None
2660
2661
2662
2663
    """Disable speculative decoding for new incoming requests when the number
    of enqueued requests is larger than this value, if provided."""

    # Ngram proposer configuration
2664
    prompt_lookup_max: Optional[int] = None
2665
2666
    """Maximum size of ngram token window when using Ngram proposer, required
    when method is set to ngram."""
2667
    prompt_lookup_min: Optional[int] = None
2668
2669
2670
    """Minimum size of ngram token window when using Ngram proposer, if
    provided. Defaults to 1."""

2671
    speculative_token_tree: Optional[str] = None
2672
    """Specifies the tree structure for speculative token generation.
2673
    """
2674
    # required configuration params passed from engine
2675
    target_model_config: SkipValidation[ModelConfig] = None  # type: ignore
2676
    """The configuration of the target model."""
2677
2678
    target_parallel_config: SkipValidation[
        ParallelConfig] = None  # type: ignore
2679
    """The parallel configuration for the target model."""
2680
    enable_chunked_prefill: SkipValidation[bool] = None  # type: ignore
2681
2682
    """Whether vLLM is configured to use chunked prefill or not. Used for
    raising an error since it's not yet compatible with speculative decode."""
2683
    disable_log_stats: SkipValidation[bool] = None  # type: ignore
2684
2685
    """Whether to disable the periodic printing of stage times in speculative
    decoding."""
2686
2687

    # params generated in the post-init stage
2688
    draft_model_config: SkipValidation[ModelConfig] = None  # type: ignore
2689
    """The configuration of the draft model initialized internal."""
2690
2691
    draft_parallel_config: SkipValidation[
        ParallelConfig] = None  # type: ignore
2692
    """The parallel configuration for the draft model initialized internal."""
2693

2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
    def compute_hash(self) -> str:
        """
        WARNING: Whenever a new field is added to this config,
        ensure that it is included in the factors list if
        it affects the computation graph.

        Provide a hash that uniquely identifies all the configs
        that affect the structure of the computation
        graph from input ids/embeddings to the final hidden states,
        excluding anything before input ids/embeddings and after
        the final hidden states.
        """
2706
        factors: list[Any] = []
2707
2708
2709
        # Eagle3 affects the computation graph because it returns intermediate
        # hidden states in addition to the final hidden state.
        factors.append(self.method == "eagle3")
2710
2711
        hash_str = hashlib.md5(str(factors).encode(),
                               usedforsecurity=False).hexdigest()
2712
2713
        return hash_str

2714
2715
2716
2717
2718
    @classmethod
    def from_dict(cls, dict_value: dict) -> "SpeculativeConfig":
        """Parse the CLI value for the speculative config."""
        return cls(**dict_value)

2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
    @staticmethod
    def hf_config_override(hf_config: PretrainedConfig) -> PretrainedConfig:
        if hf_config.model_type == "deepseek_v3":
            hf_config.model_type = "deepseek_mtp"
        if hf_config.model_type == "deepseek_mtp":
            n_predict = getattr(hf_config, "num_nextn_predict_layers", None)
            hf_config.update({
                "n_predict": n_predict,
                "architectures": ["DeepSeekMTPModel"]
            })
2729
2730
2731
2732
2733
2734
2735
2736
2737

        if hf_config.architectures[0] == "MiMoForCausalLM":
            hf_config.model_type = "mimo_mtp"
            n_predict = getattr(hf_config, "num_nextn_predict_layers", None)
            hf_config.update({
                "num_hidden_layers": 0,
                "n_predict": n_predict,
                "architectures": ["MiMoMTPModel"]
            })
Yuxuan Zhang's avatar
Yuxuan Zhang committed
2738

zhuwenwen's avatar
zhuwenwen committed
2739
2740
2741
2742
2743
2744
2745
2746
        if hf_config.architectures[0] == "Glm4MoeForCausalLM":
            hf_config.model_type = "glm4_moe_mtp"
            n_predict = getattr(hf_config, "num_nextn_predict_layers", None)
            hf_config.update({
                "num_hidden_layers": 0,
                "n_predict": n_predict,
                "architectures": ["Glm4MoeMTPModel"]
            })
2747

2748
2749
        return hf_config

2750
    def __post_init__(self):
2751

2752
2753
2754
2755
2756
2757
2758
        # Note: "method" is a new parameter that helps to extend the
        # configuration of non-model-based proposers, and the "model" parameter
        # will be used to set the draft model, eagle head, or additional weight
        # when needed. If users do not specify "method", the speculative method
        # will be detected automatically if possible. If the speculative method
        # can not be detected, it will be considered as the "draft_model" by
        # default.
2759
2760
2761
2762

        if self.model is None and self.num_speculative_tokens is not None:
            # TODO(Shangming): Refactor mtp configuration logic when supporting
            # mtp acceleration for more models besides deepseek_v3
2763
            if self.target_model_config and \
2764
2765
2766
2767
                (self.target_model_config.hf_text_config.model_type \
                        == "deepseek_v3" or
                    self.target_model_config.hf_text_config.model_type \
                        == "mimo"):
2768
2769
2770
2771
                # use the draft model from the same model:
                self.model = self.target_model_config.model
            elif self.method in ("ngram", "[ngram]"):
                self.model = "ngram"
2772
            else:
2773
2774
2775
                raise ValueError("num_speculative_tokens was provided without "
                                 "speculative model.")

2776
2777
        # Automatically configure the method for ngram when "model" is used
        # instead of "method"
2778
2779
2780
2781
2782
2783
2784
        if self.method is None and (self.model is not None
                                    and self.model in ("ngram", "[ngram]")):
            self.method = "ngram"

        if self.method in ("ngram", "[ngram]"):
            # Unified to "ngram" internally
            self.method = "ngram"
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
            # Set default values if not provided
            if (self.prompt_lookup_min is None
                    and self.prompt_lookup_max is None):
                # TODO(woosuk): Tune these values. They are arbitrarily chosen.
                self.prompt_lookup_min = 5
                self.prompt_lookup_max = 5
            elif self.prompt_lookup_min is None:
                assert self.prompt_lookup_max is not None
                self.prompt_lookup_min = self.prompt_lookup_max
            elif self.prompt_lookup_max is None:
                assert self.prompt_lookup_min is not None
                self.prompt_lookup_max = self.prompt_lookup_min

            # Validate values
2799
            if self.prompt_lookup_min < 1:
2800
2801
2802
2803
2804
                raise ValueError(
                    f"prompt_lookup_min={self.prompt_lookup_min} must be > 0")
            if self.prompt_lookup_max < 1:
                raise ValueError(
                    f"prompt_lookup_max={self.prompt_lookup_max} must be > 0")
2805
            if self.prompt_lookup_min > self.prompt_lookup_max:
2806
2807
2808
                raise ValueError(
                    f"prompt_lookup_min={self.prompt_lookup_min} must "
                    f"be <= prompt_lookup_max={self.prompt_lookup_max}")
2809

2810
2811
2812
            # TODO: current we still need extract vocab_size from target model
            # config, in future, we may try refactor it out, and set
            # draft related config as None here.
2813
2814
            self.draft_model_config = self.target_model_config
            self.draft_parallel_config = self.target_parallel_config
2815
        else:
2816
2817
2818
2819
2820
2821
            self.prompt_lookup_max = 0
            self.prompt_lookup_min = 0

            if self.model is not None:
                self.draft_model_config = ModelConfig(
                    model=self.model,
2822
                    runner="draft",
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
                    tokenizer=self.target_model_config.tokenizer,
                    tokenizer_mode=self.target_model_config.tokenizer_mode,
                    trust_remote_code=self.target_model_config.
                    trust_remote_code,
                    allowed_local_media_path=self.target_model_config.
                    allowed_local_media_path,
                    dtype=self.target_model_config.dtype,
                    seed=self.target_model_config.seed,
                    revision=self.revision,
                    code_revision=self.code_revision,
                    tokenizer_revision=self.target_model_config.
                    tokenizer_revision,
                    spec_target_max_model_len=self.target_model_config.
                    max_model_len,
                    quantization=self.quantization,
2838
                    enforce_eager=True if envs.VLLM_SPEC_DECODE_EAGER else self.target_model_config.enforce_eager,
2839
2840
2841
2842
2843
                    max_seq_len_to_capture=self.target_model_config.
                    max_seq_len_to_capture,
                    max_logprobs=self.target_model_config.max_logprobs,
                    hf_overrides=SpeculativeConfig.hf_config_override,
                )
2844

2845
                # Automatically detect the method
2846
                if self.method in ('eagle', 'eagle3'):
2847
                    pass
2848
2849
                elif "eagle-" in self.draft_model_config.model.lower() or \
                        "eagle3-" in self.draft_model_config.model.lower():
2850
2851
2852
2853
2854
2855
                    self.method = "eagle"
                elif self.draft_model_config.hf_config.model_type == "medusa":
                    self.method = "medusa"
                elif (self.draft_model_config.hf_config.model_type ==
                      "mlp_speculator"):
                    self.method = "mlp_speculator"
2856
                elif (self.draft_model_config.hf_config.model_type
Yuxuan Zhang's avatar
Yuxuan Zhang committed
2857
                      in ("deepseek_mtp", "mimo_mtp", "glm4_moe_mtp")):
Jiayi Yao's avatar
Jiayi Yao committed
2858
2859
2860
2861
2862
2863
2864
                    self.method = "deepseek_mtp"
                    if self.num_speculative_tokens > 1:
                        logger.warning(
                                "All Deepseek MTP models only have " \
                                "one layer. Might need some code changes " \
                                "to support multiple layers."
                            )
2865
                else:
2866
                    self.method = "draft_model"
2867
2868
2869
2870
2871
                    raise NotImplementedError(
                        "Speculative decoding with draft model is not "
                        "supported yet. Please consider using other "
                        "speculative decoding methods such as ngram, medusa, "
                        "eagle, or deepseek_mtp.")
2872
2873

                # Replace hf_config for EAGLE draft_model
2874
                if self.method in ("eagle", "eagle3"):
2875
                    if self.enable_chunked_prefill and not envs.VLLM_USE_V1:
2876
                        raise ValueError(
2877
2878
                            "Chunked prefill and EAGLE are not compatible "
                            "when using V0.")
2879
2880
2881
2882
2883
2884
2885
2886

                    from vllm.transformers_utils.configs.eagle import (
                        EAGLEConfig)
                    if isinstance(self.draft_model_config.hf_config,
                                  EAGLEConfig):
                        pass
                    else:
                        eagle_config = EAGLEConfig(
2887
                            self.draft_model_config.hf_config,
2888
2889
                            method=self.method,
                            model_type="eagle")
2890
2891
2892
2893
2894
2895
2896
                        self.draft_model_config.hf_config = eagle_config

                if (self.num_speculative_tokens is not None
                        and hasattr(self.draft_model_config.hf_config,
                                    "num_lookahead_tokens")):
                    self.draft_model_config.hf_config.num_lookahead_tokens = \
                    self.num_speculative_tokens
zhuwenwen's avatar
zhuwenwen committed
2897
2898
2899
2900
                    
                # if (self.num_speculative_heads is not None
                #     and hasattr(self.draft_model_config.hf_config, "num_lookahead_heads")):
                #     self.draft_model_config.hf_config.num_lookahead_heads = self.num_speculative_heads
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920

                n_predict = getattr(self.draft_model_config.hf_config,
                                    "n_predict", None)
                if n_predict is not None:
                    if self.num_speculative_tokens is None:
                        # Default to max value defined in draft model config.
                        self.num_speculative_tokens = n_predict
                    elif self.num_speculative_tokens > n_predict and \
                            self.num_speculative_tokens % n_predict != 0:
                        # Ensure divisibility for MTP module reuse.
                        raise ValueError(
                            f"num_speculative_tokens:{self.num_speculative_tokens}"
                            f" must be divisible by {n_predict=}")

                self.draft_tensor_parallel_size = \
                    SpeculativeConfig._verify_and_get_draft_tp(
                        self.target_parallel_config,
                        self.draft_tensor_parallel_size,
                        self.draft_model_config.hf_config
                )
2921

2922
2923
2924
2925
2926
2927
                self.draft_model_config.max_model_len = (
                    SpeculativeConfig._maybe_override_draft_max_model_len(
                        self.max_model_len,
                        self.draft_model_config.max_model_len,
                        self.target_model_config.max_model_len,
                    ))
2928

2929
2930
2931
2932
                self.draft_parallel_config = (
                    SpeculativeConfig.create_draft_parallel_config(
                        self.target_parallel_config,
                        self.draft_tensor_parallel_size))
2933

2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
    @staticmethod
    def _maybe_override_draft_max_model_len(
        speculative_max_model_len: Optional[int],
        draft_max_model_len: int,
        target_max_model_len: int,
    ) -> int:
        """Determine the max sequence len for the draft model. This is usually
        the draft_max_model_len, but may be the target_max_model_len if it is
        less than the draft_max_model_len, or may be speculative_max_model_len
        if it is specified.

        This is necessary so that sequences do not exceed the capacity of the
        draft model or the target model.

        speculative_max_model_len is mainly used for testing that sequences can
        skip speculation.
        """

        if speculative_max_model_len is not None:

            if speculative_max_model_len > draft_max_model_len:
                raise ValueError(f"{speculative_max_model_len=} cannot be "
                                 f"larger than {draft_max_model_len=}")

            if speculative_max_model_len > target_max_model_len:
                raise ValueError(f"{speculative_max_model_len=} cannot be "
                                 f"larger than {target_max_model_len=}")

            return speculative_max_model_len

        return min(
            draft_max_model_len,
            target_max_model_len,
        )

2969
    @staticmethod
2970
    def _verify_and_get_draft_tp(
2971
2972
2973
2974
2975
2976
            target_parallel_config: ParallelConfig,
            speculative_draft_tensor_parallel_size: Optional[int],
            draft_hf_config: PretrainedConfig) -> int:
        """
        Verifies and adjusts the tensor parallel size for a draft model
        specified using speculative_draft_tensor_parallel_size.
2977
        """
2978
2979
        # If speculative_draft_tensor_parallel_size is unset then set it
        # appropriately else verify that it is set correctly.
2980
        if speculative_draft_tensor_parallel_size is None:
2981
2982
2983
2984
            if draft_hf_config.model_type == "mlp_speculator":
                speculative_draft_tensor_parallel_size = 1
                if target_parallel_config.tensor_parallel_size > 1:
                    logger.warning(
2985
2986
2987
                        "%s cannot currently be run with tp>1; "
                        "setting speculative_draft_tensor_parallel_size=1",
                        draft_hf_config.model_type)
2988
2989
2990
            else:
                speculative_draft_tensor_parallel_size = \
                    target_parallel_config.tensor_parallel_size
2991
2992
        elif speculative_draft_tensor_parallel_size not in (
                1, target_parallel_config.tensor_parallel_size):
2993
            raise ValueError(
2994
                f"{speculative_draft_tensor_parallel_size=} cannot be "
2995
                f"other value than 1 or target model tensor_parallel_size")
2996
        return speculative_draft_tensor_parallel_size
2997

2998
2999
3000
3001
3002
3003
3004
3005
3006
    @staticmethod
    def create_draft_parallel_config(
        target_parallel_config: ParallelConfig,
        speculative_draft_tensor_parallel_size: int,
    ) -> ParallelConfig:
        """Create a parallel config for use by the draft worker.

        This is mostly a copy of the target parallel config, except the tp_size.
        """
3007
3008
3009
        draft_parallel_config = ParallelConfig(
            pipeline_parallel_size=target_parallel_config.
            pipeline_parallel_size,
3010
            tensor_parallel_size=speculative_draft_tensor_parallel_size,
3011
3012
            distributed_executor_backend=target_parallel_config.
            distributed_executor_backend,
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
            max_parallel_loading_workers=target_parallel_config.
            max_parallel_loading_workers,
            disable_custom_all_reduce=target_parallel_config.
            disable_custom_all_reduce,
            ray_workers_use_nsight=target_parallel_config.
            ray_workers_use_nsight,
            placement_group=target_parallel_config.placement_group,
        )

        return draft_parallel_config

3024
3025
    @model_validator(mode='after')
    def _verify_args(self) -> Self:
3026
3027
3028
3029
3030
3031
        if self.num_speculative_tokens is None:
            raise ValueError(
                "num_speculative_tokens must be provided with "
                "speculative model unless the draft model config contains an "
                "n_predict parameter.")

3032
3033
3034
3035
3036
3037
3038
        if self.num_speculative_tokens <= 0:
            raise ValueError("Expected num_speculative_tokens to be greater "
                             f"than zero ({self.num_speculative_tokens}).")

        if self.draft_model_config:
            self.draft_model_config.verify_with_parallel_config(
                self.draft_parallel_config)
3039
3040
3041
3042
3043
3044

        if (self.disable_by_batch_size is not None
                and self.disable_by_batch_size < 2):
            raise ValueError("Expect the batch size threshold of disabling "
                             "speculative decoding is > 1, but got "
                             f"{self.disable_by_batch_size=}")
3045

3046
3047
3048
3049
3050
3051
        if self.method == "eagle3" and self.target_model_config and \
            "llama" not in self.target_model_config.hf_text_config.model_type:
            raise ValueError(
                "Eagle3 is only supported for Llama models. "
                f"Got {self.target_model_config.hf_text_config.model_type=}")

3052
3053
        return self

3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
    @property
    def num_lookahead_slots(self) -> int:
        """The number of additional slots the scheduler should allocate per
        step, in addition to the slots allocated for each known token.

        This is equal to the number of speculative tokens, as each speculative
        token must be scored.
        """
        return self.num_speculative_tokens

3064
    def use_eagle(self) -> bool:
Jiayi Yao's avatar
Jiayi Yao committed
3065
        return self.method in ("eagle", "eagle3", "deepseek_mtp")
3066

3067
    def __repr__(self) -> str:
3068
3069
        method = self.method
        model = None if method == "ngram" else self.draft_model_config.model
3070
        num_spec_tokens = self.num_speculative_tokens
3071
        return f"SpeculativeConfig({method=}, {model=}, {num_spec_tokens=})"
3072
3073


3074
3075
3076
3077
LoRADType = Literal["auto", "float16", "bfloat16"]


@config
3078
@dataclass(config=ConfigDict(arbitrary_types_allowed=True))
3079
class LoRAConfig:
3080
3081
3082
3083
3084
3085
    """Configuration for LoRA."""

    max_lora_rank: int = 16
    """Max LoRA rank."""
    max_loras: int = 1
    """Max number of LoRAs in a single batch."""
3086
    fully_sharded_loras: bool = False
3087
3088
3089
3090
    """By default, only half of the LoRA computation is sharded with tensor
    parallelism. Enabling this will use the fully sharded layers. At high
    sequence length, max rank or tensor parallel size, this is likely faster.
    """
3091
    max_cpu_loras: Optional[int] = None
3092
3093
    """Maximum number of LoRAs to store in CPU memory. Must be >= than
    `max_loras`."""
zhuwenwen's avatar
zhuwenwen committed
3094
3095
3096
3097
    lora_target_modules: Optional[List[str]] = None
    """List of lora module name, If not specified, 
    modules will be chosen according to the model architecture.
    """
3098
3099
    lora_dtype: Union[torch.dtype, LoRADType] = "auto"
    """Data type for LoRA. If auto, will default to base model dtype."""
3100
    lora_extra_vocab_size: int = 256
3101
3102
    """Maximum size of extra vocabulary that can be present in a LoRA adapter
    (added to the base model vocabulary)."""
3103
3104
    lora_vocab_padding_size: ClassVar[int] = current_platform\
        .get_lora_vocab_padding_size()
3105

3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
    default_mm_loras: Optional[dict[str, str]] = None
    """Dictionary mapping specific modalities to LoRA model paths; this field
    is only applicable to multimodal models and should be leveraged when a
    model always expects a LoRA to be active when a given modality is present.
    Note that currently, if a request provides multiple additional
    modalities, each of which have their own LoRA, we do NOT apply
    default_mm_loras because we currently only support one lora adapter
    per prompt. When run in offline mode, the lora IDs for n modalities
    will be automatically assigned to 1-n with the names of the modalities
    in alphabetic order."""
3116
    bias_enabled: bool = False
3117
    """Enable bias for LoRA adapters."""
3118

3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
    def compute_hash(self) -> str:
        """
        WARNING: Whenever a new field is added to this config,
        ensure that it is included in the factors list if
        it affects the computation graph.

        Provide a hash that uniquely identifies all the configs
        that affect the structure of the computation
        graph from input ids/embeddings to the final hidden states,
        excluding anything before input ids/embeddings and after
        the final hidden states.
        """
3131
        factors: list[Any] = []
3132
3133
3134
3135
3136
        factors.append(self.max_lora_rank)
        factors.append(self.max_loras)
        factors.append(self.fully_sharded_loras)
        factors.append(self.lora_dtype)
        factors.append(self.lora_extra_vocab_size)
3137
        factors.append(self.lora_vocab_padding_size)
3138
        factors.append(self.bias_enabled)
3139
3140
        hash_str = hashlib.md5(str(factors).encode(),
                               usedforsecurity=False).hexdigest()
3141
        return hash_str
3142
3143

    def __post_init__(self):
3144
        # Setting the maximum rank to 512 should be able to satisfy the vast
3145
        # majority of applications.
3146
        possible_max_ranks = (8, 16, 32, 64, 128, 256, 320, 512)
3147
        possible_lora_extra_vocab_size = (256, 512)
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
        if self.max_lora_rank not in possible_max_ranks:
            raise ValueError(
                f"max_lora_rank ({self.max_lora_rank}) must be one of "
                f"{possible_max_ranks}.")
        if self.lora_extra_vocab_size not in possible_lora_extra_vocab_size:
            raise ValueError(
                f"lora_extra_vocab_size ({self.lora_extra_vocab_size}) "
                f"must be one of {possible_lora_extra_vocab_size}.")
        if self.max_loras < 1:
            raise ValueError(f"max_loras ({self.max_loras}) must be >= 1.")
        if self.max_cpu_loras is None:
            self.max_cpu_loras = self.max_loras
        elif self.max_cpu_loras < self.max_loras:
            raise ValueError(
                f"max_cpu_loras ({self.max_cpu_loras}) must be >= "
zspo's avatar
zspo committed
3163
                f"max_loras ({self.max_loras})")
3164

3165
    def verify_with_cache_config(self, cache_config: CacheConfig):
3166
3167
3168
        if cache_config.cpu_offload_gb > 0 and not envs.VLLM_USE_V1:
            raise ValueError(
                "V0 LoRA does not support CPU offload, please use V1.")
3169

3170
3171
3172
3173
3174
3175
    def verify_with_model_config(self, model_config: ModelConfig):
        if self.lora_dtype in (None, "auto"):
            self.lora_dtype = model_config.dtype
        elif isinstance(self.lora_dtype, str):
            self.lora_dtype = getattr(torch, self.lora_dtype)

3176

3177
@config
3178
@dataclass
3179
class MultiModalConfig:
3180
3181
    """Controls the behavior of multimodal models."""

3182
3183
    limit_per_prompt: dict[str, int] = \
        cast(dict[str, int], get_field(ModelConfig, "limit_mm_per_prompt"))
3184
    """
3185
    The maximum number of input items allowed per prompt for each modality.
3186
    Defaults to 1 (V0) or 999 (V1) for each modality.
3187
3188

    For example, to allow up to 16 images and 2 videos per prompt:
3189
    `{"images": 16, "videos": 2}`
3190
3191
    """

3192
    media_io_kwargs: dict[str, dict[str, Any]] = field(default_factory=dict)
3193
3194
    """Additional args passed to process media inputs, keyed by modalities.
    For example, to set num_frames for video, set
3195
3196
    `--media-io-kwargs '{"video": {"num_frames": 40} }'` """

3197
3198
3199
    mm_processor_kwargs: Optional[dict[str, object]] = None
    """
    Overrides for the multi-modal processor obtained from
3200
    `transformers.AutoProcessor.from_pretrained`.
3201
3202
3203
3204

    The available overrides depend on the model that is being run.

    For example, for Phi-3-Vision:
3205
    `{"num_crops": 4}`.
3206
3207
3208
3209
    """

    disable_mm_preprocessor_cache: bool = False
    """
3210
    If `True`, disable caching of the processed multi-modal inputs.
3211
3212
    """

3213
3214
3215
3216
3217
    interleave_mm_strings: bool = False
    """
    Enable fully interleaved support for multimodal prompts.
    """

3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
3228
3229
3230
3231
    def compute_hash(self) -> str:
        """
        WARNING: Whenever a new field is added to this config,
        ensure that it is included in the factors list if
        it affects the computation graph.

        Provide a hash that uniquely identifies all the configs
        that affect the structure of the computation
        graph from input ids/embeddings to the final hidden states,
        excluding anything before input ids/embeddings and after
        the final hidden states.
        """
        # no factors to consider.
        # this config will not affect the computation graph.
3232
        factors: list[Any] = []
3233
3234
        hash_str = hashlib.md5(str(factors).encode(),
                               usedforsecurity=False).hexdigest()
3235
3236
        return hash_str

3237
3238
3239
3240
3241
    def get_limit_per_prompt(self, modality: str) -> int:
        """
        Get the maximum number of input items allowed per prompt
        for the given modality.
        """
3242
3243
3244
3245
        return self.limit_per_prompt.get(
            modality,
            999 if envs.VLLM_USE_V1 else 1,
        )
3246

3247
    # TODO: Add configs to init vision tower or not.
3248

3249

3250
@config
3251
3252
@dataclass
class PoolerConfig:
3253
    """Controls the behavior of output pooling in pooling models."""
3254
3255

    pooling_type: Optional[str] = None
3256
    """
3257
    The pooling method of the pooling model. This should be a key in
3258
    [`vllm.model_executor.layers.pooler.PoolingType`][].
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
    """

    normalize: Optional[bool] = None
    """
    Whether to normalize the pooled outputs. Usually, this should be set to
    ``True`` for embedding outputs.
    """

    softmax: Optional[bool] = None
    """
    Whether to apply softmax to the pooled outputs. Usually, this should be set
    to ``True`` for classification outputs.
    """

    step_tag_id: Optional[int] = None
    """
3275
    If set, only the score corresponding to the ``step_tag_id`` in the
3276
3277
3278
3279
    generated sentence should be returned. Otherwise, the scores for all tokens
    are returned.
    """

3280
    returned_token_ids: Optional[list[int]] = None
3281
    """
3282
3283
    A list of indices for the vocabulary dimensions to be extracted,
    such as the token IDs of ``good_token`` and ``bad_token`` in the
3284
3285
3286
    ``math-shepherd-mistral-7b-prm`` model.
    """

3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
    def compute_hash(self) -> str:
        """
        WARNING: Whenever a new field is added to this config,
        ensure that it is included in the factors list if
        it affects the computation graph.

        Provide a hash that uniquely identifies all the configs
        that affect the structure of the computation
        graph from input ids/embeddings to the final hidden states,
        excluding anything before input ids/embeddings and after
        the final hidden states.
        """
        # no factors to consider.
        # this config will not affect the computation graph.
3301
        factors: list[Any] = []
3302
3303
        hash_str = hashlib.md5(str(factors).encode(),
                               usedforsecurity=False).hexdigest()
3304
3305
        return hash_str

3306

3307
3308
3309
3310
3311
3312
3313
3314
_STR_DTYPE_TO_TORCH_DTYPE = {
    "half": torch.float16,
    "float16": torch.float16,
    "float": torch.float32,
    "float32": torch.float32,
    "bfloat16": torch.bfloat16,
}

3315
3316
3317
3318
3319
3320
3321
# model_type -> reason
_FLOAT16_NOT_SUPPORTED_MODELS = {
    "gemma2": "Numerical instability. Please use bfloat16 or float32 instead.",
    "gemma3": "Numerical instability. Please use bfloat16 or float32 instead.",
    "plamo2": "Numerical instability. Please use bfloat16 or float32 instead.",
    "glm4": "Numerical instability. Please use bfloat16 or float32 instead.",
}
3322

3323

3324
3325
3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
def _is_valid_dtype(model_type: str, dtype: torch.dtype):
    if model_type in _FLOAT16_NOT_SUPPORTED_MODELS and dtype == torch.float16:  # noqa: E501, SIM103
        return False

    return True


def _check_valid_dtype(model_type: str, dtype: torch.dtype):
    if model_type in _FLOAT16_NOT_SUPPORTED_MODELS and dtype == torch.float16:
        reason = _FLOAT16_NOT_SUPPORTED_MODELS[model_type]
        raise ValueError(f"The model type {model_type!r} "
                         f"does not support float16. Reason: {reason}")

    return True


def _find_dtype(
    model_id: str,
3342
    config: PretrainedConfig,
3343
3344
3345
    *,
    revision: Optional[str],
):
3346
3347
    # NOTE: getattr(config, "torch_dtype", torch.float32) is not correct
    # because config.torch_dtype can be None.
3348
    config_dtype = getattr(config, "torch_dtype", None)
3349

3350
    # Fallbacks for multi-modal models if the root config
3351
    # does not define torch_dtype
3352
3353
    if config_dtype is None:
        config_dtype = getattr(config.get_text_config(), "torch_dtype", None)
3354
3355
    if config_dtype is None and hasattr(config, "vision_config"):
        config_dtype = getattr(config.vision_config, "torch_dtype", None)
3356
3357
    if config_dtype is None and hasattr(config, "encoder_config"):
        config_dtype = getattr(config.encoder_config, "torch_dtype", None)
3358

3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
    # Try to read the dtype of the weights if they are in safetensors format
    if config_dtype is None:
        repo_mt = try_get_safetensors_metadata(model_id, revision=revision)

        if repo_mt and (files_mt := repo_mt.files_metadata):
            param_dtypes: set[torch.dtype] = {
                _SAFETENSORS_TO_TORCH_DTYPE[dtype_str]
                for file_mt in files_mt.values()
                for dtype_str in file_mt.parameter_count
                if dtype_str in _SAFETENSORS_TO_TORCH_DTYPE
            }

            if param_dtypes:
                return common_broadcastable_dtype(param_dtypes)
3373

3374
3375
3376
    if config_dtype is None:
        config_dtype = torch.float32

3377
    return config_dtype
3378

Shinichi Hemmi's avatar
Shinichi Hemmi committed
3379

3380
3381
3382
3383
3384
3385
3386
def _resolve_auto_dtype(
    model_type: str,
    config_dtype: torch.dtype,
    *,
    is_pooling_model: bool,
):
    from vllm.platforms import current_platform
3387

3388
3389
3390
3391
    supported_dtypes = [
        dtype for dtype in current_platform.supported_dtypes
        if _is_valid_dtype(model_type, dtype)
    ]
3392

3393
3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
    if is_pooling_model and torch.float16 in supported_dtypes:
        preferred_dtype = torch.float16
    else:
        preferred_dtype = supported_dtypes[0]

    # Downcast for float32 models
    if config_dtype == torch.float32:
        config_dtype = preferred_dtype

    if config_dtype in supported_dtypes:
        return config_dtype

    # Ensure device compatibility
    device_name = current_platform.get_device_name()
    device_capability = current_platform.get_device_capability()

    if device_capability is None:
        device_str = f"{device_name!r}"
    else:
        version_str = device_capability.as_version_str()
        device_str = f"{device_name!r} (with compute capability {version_str})"

    logger.warning(
        "Your device %s doesn't support %s. "
        "Falling back to %s for compatibility.",
        device_str,
        config_dtype,
        preferred_dtype,
    )

    return preferred_dtype


def _get_and_verify_dtype(
    model_id: str,
    config: PretrainedConfig,
    dtype: Union[str, torch.dtype],
    *,
    is_pooling_model: bool,
    revision: Optional[str] = None,
) -> torch.dtype:
    config_dtype = _find_dtype(model_id, config, revision=revision)
    model_type = config.model_type

3437
3438
3439
    if isinstance(dtype, str):
        dtype = dtype.lower()
        if dtype == "auto":
3440
3441
3442
3443
3444
3445
            # Set default dtype from model config
            torch_dtype = _resolve_auto_dtype(
                model_type,
                config_dtype,
                is_pooling_model=is_pooling_model,
            )
3446
        else:
3447
            if dtype not in _STR_DTYPE_TO_TORCH_DTYPE:
3448
                raise ValueError(f"Unknown dtype: {dtype!r}")
3449
3450
3451
            torch_dtype = _STR_DTYPE_TO_TORCH_DTYPE[dtype]
    elif isinstance(dtype, torch.dtype):
        torch_dtype = dtype
3452
    else:
3453
        raise ValueError(f"Unknown dtype: {dtype}")
3454

3455
3456
    _check_valid_dtype(model_type, torch_dtype)

3457
3458
3459
    if torch_dtype != config_dtype:
        if torch_dtype == torch.float32:
            # Upcasting to float32 is allowed.
3460
            logger.info("Upcasting %s to %s.", config_dtype, torch_dtype)
3461
3462
        elif config_dtype == torch.float32:
            # Downcasting from float32 to float16 or bfloat16 is allowed.
3463
            logger.info("Downcasting %s to %s.", config_dtype, torch_dtype)
3464
        else:
Woosuk Kwon's avatar
Woosuk Kwon committed
3465
            # Casting between float16 and bfloat16 is allowed with a warning.
3466
            logger.warning("Casting %s to %s.", config_dtype, torch_dtype)
3467
3468

    return torch_dtype
3469
3470
3471
3472


def _get_and_verify_max_len(
    hf_config: PretrainedConfig,
3473
    tokenizer_config: Optional[dict],
3474
    max_model_len: Optional[int],
3475
    disable_sliding_window: bool,
3476
    sliding_window_len: Optional[Union[int, list[Optional[int]]]],
3477
    spec_target_max_model_len: Optional[int] = None,
3478
    encoder_config: Optional[Any] = None,
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
) -> int:
    """Get and verify the model's maximum length."""
    derived_max_model_len = float("inf")
    possible_keys = [
        # OPT
        "max_position_embeddings",
        # GPT-2
        "n_positions",
        # MPT
        "max_seq_len",
3489
3490
        # ChatGLM2
        "seq_length",
3491
3492
        # Command-R
        "model_max_length",
3493
3494
        # Whisper
        "max_target_positions",
3495
3496
3497
3498
3499
        # Others
        "max_sequence_length",
        "max_seq_length",
        "seq_len",
    ]
3500
    # Choose the smallest "max_length" from the possible keys
3501
    max_len_key = None
3502
    for key in possible_keys:
3503
3504
3505
3506
3507
        max_len = getattr(hf_config, key, None)
        if max_len is not None:
            max_len_key = key if max_len < derived_max_model_len \
                else max_len_key
            derived_max_model_len = min(derived_max_model_len, max_len)
Jennifer Zhao's avatar
Jennifer Zhao committed
3508
3509
3510
3511
    # For Command-R / Cohere, Cohere2 / Aya Vision models
    if tmp_max_len := getattr(hf_config, "model_max_length", None):
        max_len_key = "model_max_length"
        derived_max_model_len = tmp_max_len
3512
3513
3514
3515

    # If sliding window is manually disabled, max_length should be less
    # than the sliding window length in the model config.
    if disable_sliding_window and sliding_window_len is not None:
3516
3517

        sliding_window_len_min = get_min_sliding_window(sliding_window_len)
3518
        max_len_key = "sliding_window" \
3519
3520
3521
            if sliding_window_len_min < derived_max_model_len else max_len_key
        derived_max_model_len = min(derived_max_model_len,
                                    sliding_window_len_min)
3522

3523
3524
3525
3526
3527
3528
3529
    # Consider model_max_length in tokenizer_config
    if tokenizer_config:
        tokenizer_model_max_length = tokenizer_config.get(
            "model_max_length", derived_max_model_len)
        derived_max_model_len = min(derived_max_model_len,
                                    tokenizer_model_max_length)

3530
3531
    # If none of the keys were found in the config, use a default and
    # log a warning.
3532
    if derived_max_model_len == float("inf"):
3533
3534
3535
3536
        if max_model_len is not None:
            # If max_model_len is specified, we use it.
            return max_model_len

3537
3538
3539
3540
3541
        if spec_target_max_model_len is not None:
            # If this is a speculative draft model, we use the max model len
            # from the target model.
            return spec_target_max_model_len

3542
3543
3544
3545
        default_max_len = 2048
        logger.warning(
            "The model's config.json does not contain any of the following "
            "keys to determine the original maximum length of the model: "
3546
            "%s. Assuming the model's maximum length is %d.", possible_keys,
3547
            default_max_len)
3548
        derived_max_model_len = default_max_len
3549

3550
    rope_scaling = getattr(hf_config, "rope_scaling", None)
3551
3552
3553
    # NOTE(woosuk): Gemma3's max_model_len (128K) is already scaled by RoPE
    # scaling, so we skip applying the scaling factor again.
    if rope_scaling is not None and "gemma3" not in hf_config.model_type:
3554
3555
3556
        # No need to consider "type" key because of patch_rope_scaling when
        # loading HF config
        rope_type = rope_scaling["rope_type"]
3557
3558
3559
3560
3561
3562
3563
3564
3565
3566

        if rope_type not in ("su", "longrope", "llama3"):
            if disable_sliding_window:
                # TODO(robertgshaw): Find a model that supports rope_scaling
                # with sliding window to see if this case should be allowed.
                raise NotImplementedError(
                    "Disabling sliding window is not supported for models "
                    "with rope_scaling. Please raise an issue so we can "
                    "investigate.")

3567
3568
3569
3570
            # NOTE: rope_type == "default" does not define factor
            # https://github.com/huggingface/transformers/blob/v4.45.2/src/transformers/modeling_rope_utils.py
            scaling_factor = rope_scaling.get("factor", 1.0)

3571
3572
3573
3574
            if rope_type == "yarn":
                derived_max_model_len = rope_scaling[
                    "original_max_position_embeddings"]
            derived_max_model_len *= scaling_factor
3575

3576
3577
3578
    if encoder_config and "max_seq_length" in encoder_config:
        derived_max_model_len = encoder_config["max_seq_length"]

3579
3580
    # If the user specified a max length, make sure it is smaller than the
    # derived length from the HF model config.
3581
    if max_model_len is None:
3582
        max_model_len = int(derived_max_model_len)
3583
3584
3585
3586
3587
3588
3589
3590
        if current_platform.is_tpu():
            logger.warning(
                "--max-model-len is not specified, "
                "it's currently using model's default length %s, "
                "which might be too large."
                "Please input with --max-model-len based on your "
                "request input length and output length, to avoid "
                "unnecessary degradation.", max_model_len)
3591
    elif max_model_len > derived_max_model_len:
3592
3593
3594
3595
3596
        # Some models might have a separate key for specifying model_max_length
        # that will be bigger than derived_max_model_len. We compare user input
        # with model_max_length and allow this override when it's smaller.
        model_max_length = getattr(hf_config, "model_max_length", None)
        if model_max_length is not None and max_model_len <= model_max_length:
3597
3598
3599
3600
3601
3602
3603
            if disable_sliding_window:
                # TODO(robertgshaw): Find a model that has model_max_length
                # with sliding window to see if this case should be allowed.
                raise NotImplementedError(
                    "Disabling sliding window is not supported for models "
                    "model_max_length in the config. Please raise an issue "
                    "so we can investigate.")
3604
        else:
3605
            msg = (
3606
                f"User-specified max_model_len ({max_model_len}) is greater "
3607
3608
                f"than the derived max_model_len ({max_len_key}="
                f"{derived_max_model_len} or model_max_length="
3609
                f"{model_max_length} in model's config.json). This may lead "
3610
3611
3612
3613
3614
3615
3616
3617
3618
                "to incorrect model outputs or CUDA errors.")
            if envs.VLLM_ALLOW_LONG_MAX_MODEL_LEN:
                logger.warning(
                    "%s Make sure the value is correct and within the "
                    "model context size.", msg)
            else:
                raise ValueError(
                    f"{msg} To allow overriding this maximum, set "
                    "the env var VLLM_ALLOW_LONG_MAX_MODEL_LEN=1")
3619
    return int(max_model_len)
3620
3621


3622
def get_min_sliding_window(
3623
        sliding_window: Union[int, list[Optional[int]]]) -> int:
3624
3625
3626
3627
3628
3629
    if isinstance(sliding_window, list):
        return min(s for s in sliding_window if s is not None)

    return sliding_window


3630
def get_served_model_name(model: str,
3631
                          served_model_name: Optional[Union[str, list[str]]]):
3632
    """
3633
3634
3635
3636
    If the input is a non-empty list, the first model_name in
    `served_model_name` is taken.
    If the input is a non-empty string, it is used directly.
    For cases where the input is either an empty string or an
3637
3638
3639
3640
3641
3642
3643
3644
3645
    empty list, the fallback is to use `self.model`.
    """
    if not served_model_name:
        return model
    if isinstance(served_model_name, list):
        return served_model_name[0]
    return served_model_name


3646
GuidedDecodingBackendV0 = Literal["auto", "outlines", "lm-format-enforcer",
3647
                                  "xgrammar", "guidance"]
3648
3649

GuidedDecodingBackendV1 = Literal["auto", "xgrammar", "guidance", "outlines"]
3650
3651
GuidedDecodingBackend = Literal[GuidedDecodingBackendV0,
                                GuidedDecodingBackendV1]
3652
3653
3654


@config
3655
3656
@dataclass
class DecodingConfig:
3657
    """Dataclass which contains the decoding strategy of the engine."""
3658

3659
    backend: GuidedDecodingBackend = "auto" if envs.VLLM_USE_V1 else "xgrammar"
3660
3661
3662
3663
    """Which engine will be used for guided decoding (JSON schema / regex etc)
    by default. With "auto", we will make opinionated choices based on request
    contents and what the backend libraries currently support, so the behavior
    is subject to change in each release."""
3664

3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
    disable_fallback: bool = False
    """If `True`, vLLM will not fallback to a different backend on error."""

    disable_any_whitespace: bool = False
    """If `True`, the model will not generate any whitespace during guided
    decoding. This is only supported for xgrammar and guidance backends."""

    disable_additional_properties: bool = False
    """If `True`, the `guidance` backend will not use `additionalProperties`
    in the JSON schema. This is only supported for the `guidance` backend and
    is used to better align its behaviour with `outlines` and `xgrammar`."""

3677
    reasoning_backend: str = ""
3678
    """Select the reasoning parser depending on the model that you're using.
3679
    This is used to parse the reasoning content into OpenAI API format."""
3680

3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
    def compute_hash(self) -> str:
        """
        WARNING: Whenever a new field is added to this config,
        ensure that it is included in the factors list if
        it affects the computation graph.

        Provide a hash that uniquely identifies all the configs
        that affect the structure of the computation
        graph from input ids/embeddings to the final hidden states,
        excluding anything before input ids/embeddings and after
        the final hidden states.
        """
        # no factors to consider.
        # this config will not affect the computation graph.
3695
        factors: list[Any] = []
3696
3697
        hash_str = hashlib.md5(str(factors).encode(),
                               usedforsecurity=False).hexdigest()
3698
        return hash_str
3699
3700

    def __post_init__(self):
3701
        if envs.VLLM_USE_V1:
3702
            valid_guided_backends = get_args(GuidedDecodingBackendV1)
3703
        else:
3704
            valid_guided_backends = get_args(GuidedDecodingBackendV0)
3705
3706
        if self.backend not in valid_guided_backends:
            raise ValueError(f"Invalid backend '{self.backend}',"
3707
                             f" must be one of {valid_guided_backends}")
3708
3709
3710
3711
3712
3713
3714
3715
        if (self.disable_any_whitespace
                and self.backend not in ("xgrammar", "guidance")):
            raise ValueError("disable_any_whitespace is only supported for "
                             "xgrammar and guidance backends.")
        if (self.disable_additional_properties and self.backend != "guidance"):
            raise ValueError("disable_additional_properties is only supported "
                             "for the guidance backend.")

3716

3717
DetailedTraceModules = Literal["model", "worker", "all"]
3718
3719


3720
@config
3721
3722
@dataclass
class ObservabilityConfig:
3723
3724
    """Configuration for observability - metrics and tracing."""

3725
3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
    show_hidden_metrics_for_version: Optional[str] = None
    """Enable deprecated Prometheus metrics that have been hidden since the
    specified version. For example, if a previously deprecated metric has been
    hidden since the v0.7.0 release, you use
    `--show-hidden-metrics-for-version=0.7` as a temporary escape hatch while
    you migrate to new metrics. The metric is likely to be removed completely
    in an upcoming release."""

    @cached_property
    def show_hidden_metrics(self) -> bool:
        """Check if the hidden metrics should be shown."""
        if self.show_hidden_metrics_for_version is None:
            return False
        return version._prev_minor_version_was(
            self.show_hidden_metrics_for_version)
3740

3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
3762
3763
3764
3765
    otlp_traces_endpoint: Optional[str] = None
    """Target URL to which OpenTelemetry traces will be sent."""

    collect_detailed_traces: Optional[list[DetailedTraceModules]] = None
    """It makes sense to set this only if `--otlp-traces-endpoint` is set. If
    set, it will collect detailed traces for the specified modules. This
    involves use of possibly costly and or blocking operations and hence might
    have a performance impact.

    Note that collecting detailed timing information for each request can be
    expensive."""

    @cached_property
    def collect_model_forward_time(self) -> bool:
        """Whether to collect model forward time for the request."""
        return (self.collect_detailed_traces is not None
                and ("model" in self.collect_detailed_traces
                     or "all" in self.collect_detailed_traces))

    @cached_property
    def collect_model_execute_time(self) -> bool:
        """Whether to collect model execute time for the request."""
        return (self.collect_detailed_traces is not None
                and ("worker" in self.collect_detailed_traces
                     or "all" in self.collect_detailed_traces))
3766

3767
3768
3769
3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
    def compute_hash(self) -> str:
        """
        WARNING: Whenever a new field is added to this config,
        ensure that it is included in the factors list if
        it affects the computation graph.

        Provide a hash that uniquely identifies all the configs
        that affect the structure of the computation
        graph from input ids/embeddings to the final hidden states,
        excluding anything before input ids/embeddings and after
        the final hidden states.
        """
        # no factors to consider.
        # this config will not affect the computation graph.
3781
        factors: list[Any] = []
3782
3783
        hash_str = hashlib.md5(str(factors).encode(),
                               usedforsecurity=False).hexdigest()
3784
3785
        return hash_str

3786
    def __post_init__(self):
3787
3788
3789
3790
3791
        if (self.collect_detailed_traces is not None
                and len(self.collect_detailed_traces) == 1
                and "," in self.collect_detailed_traces[0]):
            self._parse_collect_detailed_traces()

3792
        from vllm.tracing import is_otel_available, otel_import_error_traceback
3793
3794
3795
3796
3797
        if not is_otel_available() and self.otlp_traces_endpoint is not None:
            raise ValueError(
                "OpenTelemetry is not available. Unable to configure "
                "'otlp_traces_endpoint'. Ensure OpenTelemetry packages are "
                f"installed. Original error:\n{otel_import_error_traceback}")
3798

3799
3800
3801
3802
3803
3804
    def _parse_collect_detailed_traces(self):
        assert isinstance(self.collect_detailed_traces, list)
        self.collect_detailed_traces = cast(
            list[DetailedTraceModules],
            self.collect_detailed_traces[0].split(","))

3805

3806
3807
3808
3809
KVProducer = Literal["kv_producer", "kv_both"]
KVConsumer = Literal["kv_consumer", "kv_both"]
KVRole = Literal[KVProducer, KVConsumer]

3810

3811
3812
3813
@config
@dataclass
class KVTransferConfig:
3814
3815
3816
    """Configuration for distributed KV cache transfer."""

    kv_connector: Optional[str] = None
3817
3818
    """The KV connector for vLLM to transmit KV caches between vLLM instances.
    """
3819

3820
    engine_id: Optional[str] = None
Robert Shaw's avatar
Robert Shaw committed
3821
    """The engine id for KV transfers."""
3822
3823

    kv_buffer_device: Optional[str] = "cuda"
3824
3825
    """The device used by kv connector to buffer the KV cache.
    Currently only support 'cuda'."""
3826
3827

    kv_buffer_size: float = 1e9
3828
3829
    """The buffer size for TorchDistributedConnector. Measured in number of
    bytes. Recommended value: 1e9 (about 1GB)."""
3830

3831
3832
    kv_role: Optional[KVRole] = None
    """Whether this vLLM instance produces, consumes KV cache, or both. Choices
Robert Shaw's avatar
Robert Shaw committed
3833
    are 'kv_producer', 'kv_consumer', and 'kv_both'."""
3834
3835

    kv_rank: Optional[int] = None
3836
3837
3838
    """The rank of this vLLM instance in the KV cache transfer. Typical value:
    0 for prefill instance, 1 for decode instance.
    Currently only 1P1D is supported."""
3839
3840

    kv_parallel_size: int = 1
3841
3842
    """The number of parallel instances for KV cache transfer. For
    PyNcclConnector, this should be 2."""
3843
3844

    kv_ip: str = "127.0.0.1"
3845
    """The KV connector ip, used to build distributed connection."""
3846
3847

    kv_port: int = 14579
3848
    """The KV connector port, used to build distributed connection."""
3849

3850
3851
    kv_connector_extra_config: dict[str, Any] = field(default_factory=dict)
    """any extra config that the connector may need."""
3852

3853
3854
3855
    kv_connector_module_path: Optional[str] = None
    """The Python module path to dynamically load the KV connector from.
    Only supported in V1."""
3856

3857
3858
3859
3860
3861
3862
3863
3864
3865
3866
3867
3868
3869
3870
    def compute_hash(self) -> str:
        """
        WARNING: Whenever a new field is added to this config,
        ensure that it is included in the factors list if
        it affects the computation graph.

        Provide a hash that uniquely identifies all the configs
        that affect the structure of the computation
        graph from input ids/embeddings to the final hidden states,
        excluding anything before input ids/embeddings and after
        the final hidden states.
        """
        # no factors to consider.
        # this config will not affect the computation graph.
3871
        factors: list[Any] = []
3872
3873
        hash_str = hashlib.md5(str(factors).encode(),
                               usedforsecurity=False).hexdigest()
3874
3875
        return hash_str

3876
    def __post_init__(self) -> None:
3877
3878
        if self.engine_id is None:
            self.engine_id = str(uuid.uuid4())
3879

3880
3881
3882
        if self.kv_role is not None and self.kv_role not in get_args(KVRole):
            raise ValueError(f"Unsupported kv_role: {self.kv_role}. "
                             f"Supported roles are {get_args(KVRole)}")
3883
3884
3885

        if self.kv_connector is not None and self.kv_role is None:
            raise ValueError("Please specify kv_disagg_role when kv_connector "
3886
                             f"is set, supported roles are {get_args(KVRole)}")
3887

3888
3889
3890
    @property
    def is_kv_transfer_instance(self) -> bool:
        return self.kv_connector is not None and \
3891
            self.kv_role in get_args(KVRole)
3892
3893
3894
3895

    @property
    def is_kv_producer(self) -> bool:
        return self.kv_connector is not None and \
3896
            self.kv_role in get_args(KVProducer)
3897
3898
3899
3900

    @property
    def is_kv_consumer(self) -> bool:
        return self.kv_connector is not None and \
3901
            self.kv_role in get_args(KVConsumer)
3902

3903
3904
3905
    def get_from_extra_config(self, key, default) -> Any:
        return self.kv_connector_extra_config.get(key, default)

3906

3907
3908
3909
@config
@dataclass
class KVEventsConfig:
3910
3911
3912
3913
3914
3915
3916
3917
3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
3945
3946
3947
3948
    """Configuration for KV event publishing."""

    enable_kv_cache_events: bool = False
    """If True, enable KV cache events for tracking block storage and removal.
    Events can be published externally by zmq using the event publisher config.
    """

    publisher: str = "null"
    """The publisher to use for publishing kv events. Can be "null", "zmq".
    """

    endpoint: str = "tcp://*:5557"
    """The zmq endpoint to use for publishing kv events.
    """

    replay_endpoint: Optional[str] = None
    """The zmq endpoint to use for replaying kv events.
    """

    buffer_steps: int = 10_000
    """The number of steps to cache for replay endpoint. Will only save
    events from the last N steps for the replay endpoint.
    """

    hwm: int = 100_000
    """The zmq high water mark for the event publisher. After queueing N events,
    events will start dropping if the consumer is not keeping up.
    """

    max_queue_size: int = 100_000
    """The maximum number of events to queue while waiting for publishing.
    """

    topic: str = ""
    """The topic to use for the event publisher. Consumers can subscribe to
    this topic to receive events.
    """


3949
3950
3951
3952
3953
3954
3955
3956
class CompilationLevel:
    # constants for the levels of the compilation process
    NO_COMPILATION = 0
    DYNAMO_AS_IS = 1
    DYNAMO_ONCE = 2
    PIECEWISE = 3


3957
3958
3959
3960
3961
3962
3963
3964
3965
@config
@dataclass
class PassConfig:
    """Configuration for custom Inductor passes.

    This is separate from general `CompilationConfig` so that inductor passes
    don't all have access to full configuration - that would create a cycle as
    the `PassManager` is set as a property of config."""

3966
    enable_fusion: bool = field(default_factory=lambda: not envs.VLLM_USE_V1)
3967
3968
3969
    """Whether to enable the custom fusion (RMSNorm/SiluMul+quant) pass."""
    enable_attn_fusion: bool = False
    """Whether to enable the custom attention+quant fusion pass."""
3970
    enable_noop: bool = field(default_factory=lambda: not envs.VLLM_USE_V1)
3971
3972
3973
    """Whether to enable the custom no-op elimination pass."""
    enable_sequence_parallelism: bool = False
    """Whether to enable sequence parallelism."""
3974
3975
    enable_async_tp: bool = False
    """Whether to enable async TP."""
3976
3977
3978
3979
    enable_fi_allreduce_fusion: bool = False
    """Whether to enable flashinfer allreduce fusion."""
    fi_allreduce_fusion_max_token_num: int = 1024
    """Max number of tokens to used in flashinfer allreduce fusion."""
3980

3981
3982
    # TODO(luka) better pass enabling system.

3983
3984
3985
3986
    def uuid(self):
        """
        Produces a hash unique to the pass configuration.
        Any new fields that affect compilation should be added to the hash.
3987
        Any future fields that don't affect compilation should be excluded.
3988
        """
3989
        return InductorPass.hash_dict(asdict(self))
3990
3991

    def __post_init__(self) -> None:
3992
3993
3994
3995
3996
3997
3998
3999
4000
        if not self.enable_noop:
            if self.enable_fusion:
                logger.warning_once(
                    "Fusion enabled but reshape elimination disabled. "
                    "RMSNorm/SiluMul + quant (fp8) fusion might not work")
            if self.enable_attn_fusion:
                logger.warning_once(
                    "Fusion enabled but reshape elimination disabled. "
                    "Attention + quant (fp8) fusion might not work")
4001
4002
4003
4004
4005
4006
4007


@config
@dataclass
class CompilationConfig:
    """Configuration for compilation. It has three parts:

4008
    - Top-level Compilation control:
4009
4010
4011
4012
4013
4014
        - [`level`][vllm.config.CompilationConfig.level]
        - [`debug_dump_path`][vllm.config.CompilationConfig.debug_dump_path]
        - [`cache_dir`][vllm.config.CompilationConfig.cache_dir]
        - [`backend`][vllm.config.CompilationConfig.backend]
        - [`custom_ops`][vllm.config.CompilationConfig.custom_ops]
        - [`splitting_ops`][vllm.config.CompilationConfig.splitting_ops]
4015
    - CudaGraph capture:
4016
4017
4018
4019
4020
4021
4022
4023
        - [`use_cudagraph`][vllm.config.CompilationConfig.use_cudagraph]
        - [`cudagraph_capture_sizes`]
        [vllm.config.CompilationConfig.cudagraph_capture_sizes]
        - [`cudagraph_num_of_warmups`]
        [vllm.config.CompilationConfig.cudagraph_num_of_warmups]
        - [`cudagraph_copy_inputs`]
        [vllm.config.CompilationConfig.cudagraph_copy_inputs]
        - [`full_cuda_graph`][vllm.config.CompilationConfig.full_cuda_graph]
4024
    - Inductor compilation:
4025
4026
4027
4028
4029
        - [`use_inductor`][vllm.config.CompilationConfig.use_inductor]
        - [`compile_sizes`][vllm.config.CompilationConfig.compile_sizes]
        - [`inductor_compile_config`]
        [vllm.config.CompilationConfig.inductor_compile_config]
        - [`inductor_passes`][vllm.config.CompilationConfig.inductor_passes]
4030
        - custom inductor passes
4031

4032
4033
4034
4035
4036
4037
4038
4039
4040
    Why we have different sizes for cudagraph and inductor:
    - cudagraph: a cudagraph captured for a specific size can only be used
        for the same size. We need to capture all the sizes we want to use.
    - inductor: a graph compiled by inductor for a general shape can be used
        for different sizes. Inductor can also compile for specific sizes,
        where it can have more information to optimize the graph with fully
        static shapes. However, we find the general shape compilation is
        sufficient for most cases. It might be beneficial to compile for
        certain small batchsizes, where inductor is good at optimizing.
4041
4042
    """
    # Top-level Compilation control
4043
    level: int = 0
4044
4045
4046
4047
4048
4049
    """The level of compilation:

    - 0: no compilation.
    - 1: dynamo as is.
    - 2: dynamo once.
    - 3: piecewise compilation."""
4050
    debug_dump_path: str = ""
4051
    """The path to dump the debug information."""
4052
    cache_dir: str = ""
4053
4054
4055
    """The directory to store the compiled graph, to accelerate Inductor
    compilation. By default, it will use model-related information to generate
    a cache directory."""
4056
    backend: str = ""
4057
4058
4059
4060
4061
4062
4063
4064
4065
4066
4067
4068
4069
4070
4071
4072
4073
4074
4075
4076
4077
4078
    """The backend for compilation. It needs to be a string:

    - "" (empty string): use the default backend.
    - "eager"/"openxla"/...: use the specified backend registered in PyTorch.
    - "full.module.name": a qualified name which can be used to import the

    backend function.
    We use string to avoid serialization issues when using compilation in a
    distributed setting. When the compilation level is 1 or 2, the backend is
    used for the compilation directly (it sees the whole graph). When the
    compilation level is 3, the backend is used for the piecewise compilation
    (it sees a part of the graph)."""
    custom_ops: list[str] = field(default_factory=list)
    """Fine-grained control over which custom ops to enable/disable. Use 'all'
    to enable all, 'none' to disable all. Also specify a list of custom op
    names to enable (prefixed with a '+'), or disable (prefixed with a '-').
    Examples:

    - 'all,-op1' to enable all except op1
    - 'none,+op1,+op2' to enable only op1 and op2

    By default, all custom ops are enabled when running without Inductor and
4079
4080
    disabled when running with Inductor: level>=PIECEWISE and use_inductor=True.
    Inductor generates (fused) Triton kernels for disabled custom ops."""
4081
4082
4083
4084
4085
    splitting_ops: list[str] = field(default_factory=list)
    """A list of ops to split the full graph into subgraphs, used in piecewise
    compilation."""

    # Inductor capture
4086
    use_inductor: bool = True
4087
4088
    """Whether to use inductor compilation:

4089
4090
4091
4092
4093
    - False: inductor compilation is not used. graph runs in eager
        (custom_ops enabled by default).
    - True: inductor compilation is used (custom_ops disabled by default).
        One graph for symbolic shape and one graph per size in compile_sizes
        are compiled using configurations in inductor_compile_config.
4094

4095
    This setting is ignored if level<PIECEWISE."""
4096
4097
4098
4099
4100
4101
4102
4103
4104
4105
4106
4107
4108
4109
4110
    compile_sizes: Optional[list[Union[int, str]]] = None
    """Sizes to compile for inductor. In addition
    to integers, it also supports "cudagraph_capture_sizes" to
    specify the sizes for cudagraph capture."""
    inductor_compile_config: dict = field(default_factory=dict)
    """Additional configurations for inductor.
    - None: use default configurations."""
    inductor_passes: dict[str, str] = field(default_factory=dict)
    """Additional passes for inductor. It is a dictionary
    from pass name to pass function qualified name. We use function
    name because the config uses JSON format. If we pass the config
    from Python, functions can also be passed directly via Python object
    constructor, e.g. `CompilationConfig(inductor_passes={"a": func})`."""

    # CudaGraph compilation
4111
    use_cudagraph: bool = field(default_factory=lambda: envs.VLLM_USE_V1)
4112
4113
4114
4115
4116
    """Whether to use cudagraph inside compilation.
    - False: cudagraph inside compilation is not used.
    - True: cudagraph inside compilation is used. It requires
        that all input buffers have fixed addresses, and all
        splitting ops write their outputs to input buffers.
4117
4118
    In the vLLM V1 Engine, this flag only applies for
    CompilationLevel.PIECEWISE (aka -O3).
4119
4120
4121
4122
    Note that this is orthogonal to the cudagraph capture logic
    outside of compilation.
    TODO: move outside cudagraph logic into compilation.
    torch.compile will handle cudagraph capture logic in the future."""
4123
    cudagraph_num_of_warmups: int = 0
4124
4125
4126
4127
    """Number of warmup runs for cudagraph.
    It means the first several runs will be treated as warmup runs.
    Only after that, the execution will be recorded, and the recorded
    cudagraph will be used for subsequent runs."""
4128
    cudagraph_capture_sizes: Optional[list[int]] = None
4129
4130
4131
    """Sizes to capture cudagraph.
    - None (default): capture sizes are inferred from vllm config.
    - list[int]: capture sizes are specified as given."""
4132
    cudagraph_copy_inputs: bool = False
4133
4134
4135
4136
4137
    """Whether to copy input tensors for
    cudagraph. If the caller can guarantee that the same input buffers
    are always used, it can set this to False. Otherwise, it should
    set this to True, and the compiler will copy the input to an
    internally managed buffer. Default is False."""
4138
    full_cuda_graph: bool = False
4139
4140
4141
4142
4143
4144
4145
4146
4147
4148
4149
4150
4151
4152
4153
4154
4155
4156
4157
    """whether to use a full cuda graph for the entire forward pass rather than
    splitting certain operations such as attention into subgraphs. Thus this
    flag cannot be used together with splitting_ops. This may provide
    performance benefits for smaller models."""

    pass_config: PassConfig = field(default_factory=PassConfig)
    """Custom inductor passes, see PassConfig for more details"""

    max_capture_size: int = field(default=None, init=False)  # type: ignore
    """not configurable, computed after init"""
    local_cache_dir: str = field(default=None, init=False)  # type: ignore
    """local cache dir for each rank"""
    bs_to_padded_graph_size: list[int] = field(
        default=None,  # type: ignore
        init=False)
    """optimization:
    Intuitively, bs_to_padded_graph_size should be dict[int, int].
    since we know all keys are in a range [0, max_capture_size],
    we can optimize it to list[int] for better lookup performance."""
4158

4159
    # keep track of enabled and disabled custom ops
4160
4161
4162
4163
4164
4165
4166
4167
4168
4169
4170
4171
4172
4173
4174
4175
    enabled_custom_ops: Counter[str] = field(default_factory=Counter,
                                             init=False)
    """custom ops that are enabled"""
    disabled_custom_ops: Counter[str] = field(default_factory=Counter,
                                              init=False)
    """custom ops that are disabled"""
    traced_files: set[str] = field(default_factory=set, init=False)
    """files that are traced for compilation"""
    compilation_time: float = field(default=0.0, init=False)
    """time taken for compilation"""

    static_forward_context: dict[str, Any] = field(default_factory=dict,
                                                   init=False)
    """Per-model forward context
    Map from layer name to layer objects that need to be accessed outside
    model code, e.g., Attention, FusedMOE when dp_size>1."""
4176

4177
4178
4179
4180
4181
4182
4183
4184
4185
4186
4187
4188
    def compute_hash(self) -> str:
        """
        WARNING: Whenever a new field is added to this config,
        ensure that it is included in the factors list if
        it affects the computation graph.

        Provide a hash that uniquely identifies all the configs
        that affect the structure of the computation
        graph from input ids/embeddings to the final hidden states,
        excluding anything before input ids/embeddings and after
        the final hidden states.
        """
4189
        factors: list[Any] = []
4190
4191
4192
4193
4194
4195
4196
4197
4198
4199
        factors.append(self.level)
        factors.append(self.backend)
        factors.append(self.custom_ops)
        factors.append(self.splitting_ops)
        factors.append(self.use_inductor)
        factors.append(self.inductor_compile_config)
        factors.append(self.inductor_passes)
        factors.append(self.pass_config.uuid())
        return hashlib.sha256(str(factors).encode()).hexdigest()

4200
4201
    def __repr__(self) -> str:
        exclude = {
4202
4203
4204
4205
4206
4207
4208
4209
4210
4211
            "static_forward_context": True,
            "enabled_custom_ops": True,
            "disabled_custom_ops": True,
            "compilation_time": True,
            "bs_to_padded_graph_size": True,
            "pass_config": True,
            "traced_files": True,
            "inductor_compile_config": {
                "post_grad_custom_post_pass": True,
            },
4212
        }
4213
4214
4215
4216
        # The cast to string is necessary because Pydantic is mocked in docs
        # builds and sphinx-argparse doesn't know the return type of decode()
        return str(
            TypeAdapter(CompilationConfig).dump_json(
4217
4218
4219
                self,
                exclude=exclude,  # type: ignore[arg-type]
                exclude_unset=True).decode())
4220
4221
4222

    __str__ = __repr__

4223
4224
    @classmethod
    def from_cli(cls, cli_value: str) -> "CompilationConfig":
4225
4226
4227
        """Parse the CLI value for the compilation config.
        -O1, -O2, -O3, etc. is handled in FlexibleArgumentParser.
        """
4228
        return TypeAdapter(CompilationConfig).validate_json(cli_value)
4229

4230
    def __post_init__(self) -> None:
4231
4232
4233
4234
        count_none = self.custom_ops.count("none")
        count_all = self.custom_ops.count("all")
        assert count_none + count_all <= 1, "Can only specify 'none' or 'all'"

Michael Goin's avatar
Michael Goin committed
4235
4236
4237
4238
4239
4240
4241
4242
        # TODO(zou3519/luka): There are 2 issues with auto-functionalization V2:
        # 1. A bug in PyTorch, fixed in 2.7:
        #    https://github.com/pytorch/pytorch/issues/147924
        # 2. Custom passes (fusion) rely on auto-functionalization V1 and don't
        #    work with V2. Addressing this will take extra engineering effort
        #    and it is not yet a priority. RFC here:
        #    https://github.com/vllm-project/vllm/issues/14703

4243
        if is_torch_equal_or_newer("2.6"):
Michael Goin's avatar
Michael Goin committed
4244
4245
4246
4247
            KEY = 'enable_auto_functionalized_v2'
            if KEY not in self.inductor_compile_config:
                self.inductor_compile_config[KEY] = False

4248
4249
4250
        for k, v in self.inductor_passes.items():
            if not isinstance(v, str):
                assert callable(v), (
4251
4252
4253
                    f"pass {k} should be callable or a qualified name")
                self.inductor_compile_config[k] = v if isinstance(
                    v, InductorPass) else CallableInductorPass(v)
4254
4255
4256
4257
4258
4259
4260
                continue

            # resolve function from qualified name
            names = v.split(".")
            module = ".".join(names[:-1])
            func_name = names[-1]
            func = __import__(module).__dict__[func_name]
4261
4262
            self.inductor_compile_config[k] = func if isinstance(
                func, InductorPass) else CallableInductorPass(func)
4263

4264
4265
        if isinstance(self.pass_config, dict):
            self.pass_config = PassConfig(**self.pass_config)
4266

4267
    def init_backend(self, vllm_config: "VllmConfig") -> Union[str, Callable]:
4268
4269
4270
4271
4272
4273
4274
4275
4276
4277
4278
4279
4280
4281
4282
4283
4284
        if self.level == CompilationLevel.NO_COMPILATION:
            raise ValueError("No compilation level is set.")

        from torch._dynamo.backends.registry import list_backends
        torch_backends = list_backends(exclude_tags=tuple())
        if self.level in [
                CompilationLevel.DYNAMO_AS_IS, CompilationLevel.DYNAMO_ONCE
        ]:
            if self.backend == "":
                return "eager"
            if self.backend in torch_backends:
                return self.backend
            return resolve_obj_by_qualname(self.backend)

        # TODO: pass user-specified backend to piecewise compilation
        # merge with the config use_inductor
        assert self.level == CompilationLevel.PIECEWISE
4285

4286
        from vllm.compilation.backends import VllmBackend
4287
        return VllmBackend(vllm_config)
4288

4289
    def init_with_cudagraph_sizes(self,
4290
                                  cudagraph_capture_sizes: list[int]) -> None:
4291
        """To complete the initialization of config,
4292
4293
        we need to know the cudagraph sizes."""

4294
        if self.cudagraph_capture_sizes is None:
4295
            self.cudagraph_capture_sizes = cudagraph_capture_sizes
4296
        else:
4297
            # de-duplicate the sizes provided by the config
4298
4299
4300
4301
4302
4303
            dedup_sizes = list(set(self.cudagraph_capture_sizes))
            if len(dedup_sizes) < len(self.cudagraph_capture_sizes):
                logger.info(("cudagraph sizes specified by model runner"
                             " %s is overridden by config %s"),
                            cudagraph_capture_sizes, dedup_sizes)
            self.cudagraph_capture_sizes = dedup_sizes
4304
4305
4306
4307
4308
4309
4310
4311
4312
4313
4314
4315
4316
4317
4318

        computed_compile_sizes = []
        if self.compile_sizes is not None:
            # de-duplicate the sizes provided by the config
            self.compile_sizes = list(set(self.compile_sizes))
            for x in self.compile_sizes:
                if isinstance(x, str):
                    assert x == "cudagraph_capture_sizes", \
                    "Unrecognized size type in compile_sizes, " \
                    f"expect 'cudagraph_capture_sizes', got {x}"
                    computed_compile_sizes.extend(self.cudagraph_capture_sizes)
                else:
                    assert isinstance(x, int)
                    computed_compile_sizes.append(x)
        self.compile_sizes = computed_compile_sizes  # type: ignore
4319

4320
        # sort to make sure cudagraph capture sizes are in descending order
4321
4322
4323
        self.cudagraph_capture_sizes.sort(reverse=True)
        self.max_capture_size = self.cudagraph_capture_sizes[
            0] if self.cudagraph_capture_sizes else 0
4324

4325
4326
4327
4328
        # pre-compute the mapping from batch size to padded graph size
        self.bs_to_padded_graph_size = [
            0 for i in range(self.max_capture_size + 1)
        ]
4329
4330
        for end, start in zip(self.cudagraph_capture_sizes,
                              self.cudagraph_capture_sizes[1:] + [0]):
4331
4332
4333
4334
4335
4336
4337
            for bs in range(start, end):
                if bs == start:
                    self.bs_to_padded_graph_size[bs] = start
                else:
                    self.bs_to_padded_graph_size[bs] = end
        self.bs_to_padded_graph_size[
            self.max_capture_size] = self.max_capture_size
4338

4339
4340
    def set_splitting_ops_for_v1(self):
        # NOTE: this function needs to be called
4341
4342
4343
4344
4345
        if self.splitting_ops and self.full_cuda_graph:
            raise ValueError("full_cuda_graph cannot be used together with "
                             "splitting_ops, as Full CUDA graph will override "
                             f"the splitting_ops: {self.splitting_ops}")

4346
        if not self.splitting_ops:
4347
            self.splitting_ops = [] if self.full_cuda_graph else [
4348
4349
                "vllm.unified_attention",
                "vllm.unified_attention_with_output",
4350
                "vllm.mamba_mixer2",
4351
4352
            ]

4353

4354
@config
4355
@dataclass(config=ConfigDict(arbitrary_types_allowed=True))
4356
4357
class VllmConfig:
    """Dataclass which contains all vllm-related configuration. This
4358
4359
4360
    simplifies passing around the distinct configurations in the codebase.
    """

4361
4362
4363
    # TODO: use default_factory once default constructing ModelConfig doesn't
    # try to download a model
    model_config: ModelConfig = None  # type: ignore
4364
4365
4366
4367
4368
4369
4370
4371
4372
4373
4374
    """Model configuration."""
    cache_config: CacheConfig = field(default_factory=CacheConfig)
    """Cache configuration."""
    parallel_config: ParallelConfig = field(default_factory=ParallelConfig)
    """Parallel configuration."""
    scheduler_config: SchedulerConfig = field(default_factory=SchedulerConfig)
    """Scheduler configuration."""
    device_config: DeviceConfig = field(default_factory=DeviceConfig)
    """Device configuration."""
    load_config: LoadConfig = field(default_factory=LoadConfig)
    """Load configuration."""
4375
    lora_config: Optional[LoRAConfig] = None
4376
4377
4378
    """LoRA configuration."""
    speculative_config: Optional[SpeculativeConfig] = None
    """Speculative decoding configuration."""
4379
    decoding_config: DecodingConfig = field(default_factory=DecodingConfig)
4380
    """Decoding configuration."""
4381
    observability_config: Optional[ObservabilityConfig] = None
4382
    """Observability configuration."""
4383
    quant_config: Optional[QuantizationConfig] = None
4384
4385
4386
    """Quantization configuration."""
    compilation_config: CompilationConfig = field(
        default_factory=CompilationConfig)
4387
    """`torch.compile` and cudagraph capture configuration for the model.
4388

4389
4390
    As a shorthand, `-O<n>` can be used to directly specify the compilation
    level `n`: `-O3` is equivalent to `-O.level=3` (same as `-O='{"level":3}'`).
4391
    Currently, -O <n> and -O=<n> are supported as well but this will likely be
4392
    removed in favor of clearer -O<n> syntax in the future.
4393
4394
4395

    NOTE: level 0 is the default level without any optimization. level 1 and 2
    are for internal testing only. level 3 is the recommended level for
4396
    production, also default in V1.
4397
4398
4399
4400
4401
4402

    You can specify the full compilation config like so:
    `{"level": 3, "cudagraph_capture_sizes": [1, 2, 4, 8]}`
    """
    kv_transfer_config: Optional[KVTransferConfig] = None
    """The configurations for distributed KV cache transfer."""
4403
    kv_events_config: Optional[KVEventsConfig] = None
4404
    """The configurations for event publishing."""
4405
    # some opaque config, only used to provide additional information
4406
4407
    # for the hash computation, mainly used for testing, debugging or out of
    # tree config registration.
4408
4409
4410
4411
    additional_config: Union[dict, SupportsHash] = field(default_factory=dict)
    """Additional config for specified platform. Different platforms may
    support different configs. Make sure the configs are valid for the platform
    you are using. Contents must be hashable."""
4412
    instance_id: str = ""
4413
    """The ID of the vLLM instance."""
4414

4415
4416
4417
4418
4419
4420
4421
4422
4423
4424
4425
4426
    def compute_hash(self) -> str:
        """
        WARNING: Whenever a new field is added to this config,
        ensure that it is included in the factors list if
        it affects the computation graph.

        Provide a hash that uniquely identifies all the configs
        that affect the structure of the computation
        graph from input ids/embeddings to the final hidden states,
        excluding anything before input ids/embeddings and after
        the final hidden states.
        """
4427
        factors: list[Any] = []
4428
4429

        # summarize vllm config
4430
        vllm_factors: list[Any] = []
4431
4432
        from vllm import __version__
        vllm_factors.append(__version__)
4433
        vllm_factors.append(envs.VLLM_USE_V1)
4434
4435
        if self.model_config:
            vllm_factors.append(self.model_config.compute_hash())
4436
4437
        else:
            vllm_factors.append("None")
4438
4439
        if self.cache_config:
            vllm_factors.append(self.cache_config.compute_hash())
4440
4441
        else:
            vllm_factors.append("None")
4442
4443
        if self.parallel_config:
            vllm_factors.append(self.parallel_config.compute_hash())
4444
4445
        else:
            vllm_factors.append("None")
4446
4447
        if self.scheduler_config:
            vllm_factors.append(self.scheduler_config.compute_hash())
4448
4449
        else:
            vllm_factors.append("None")
4450
4451
        if self.device_config:
            vllm_factors.append(self.device_config.compute_hash())
4452
4453
        else:
            vllm_factors.append("None")
4454
4455
        if self.load_config:
            vllm_factors.append(self.load_config.compute_hash())
4456
4457
        else:
            vllm_factors.append("None")
4458
4459
        if self.lora_config:
            vllm_factors.append(self.lora_config.compute_hash())
4460
4461
4462
4463
4464
            # LoRA creates static buffers based on max_num_batched_tokens.
            # The tensor sizes and strides get captured in the torch.compile
            # graph explicitly.
            vllm_factors.append(
                str(self.scheduler_config.max_num_batched_tokens))
4465
4466
        else:
            vllm_factors.append("None")
4467
4468
        if self.speculative_config:
            vllm_factors.append(self.speculative_config.compute_hash())
4469
4470
        else:
            vllm_factors.append("None")
4471
4472
        if self.decoding_config:
            vllm_factors.append(self.decoding_config.compute_hash())
4473
4474
        else:
            vllm_factors.append("None")
4475
4476
        if self.observability_config:
            vllm_factors.append(self.observability_config.compute_hash())
4477
4478
        else:
            vllm_factors.append("None")
4479
4480
4481
4482
        if self.quant_config:
            pass  # should be captured by model_config.quantization
        if self.compilation_config:
            vllm_factors.append(self.compilation_config.compute_hash())
4483
4484
        else:
            vllm_factors.append("None")
4485
4486
        if self.kv_transfer_config:
            vllm_factors.append(self.kv_transfer_config.compute_hash())
4487
4488
4489
        else:
            vllm_factors.append("None")
        if self.additional_config:
4490
4491
4492
4493
4494
4495
4496
4497
            if isinstance(additional_config := self.additional_config, dict):
                additional_config_hash = hashlib.md5(
                    json.dumps(additional_config, sort_keys=True).encode(),
                    usedforsecurity=False,
                ).hexdigest()
            else:
                additional_config_hash = additional_config.compute_hash()
            vllm_factors.append(additional_config_hash)
4498
4499
        else:
            vllm_factors.append("None")
4500
4501
        factors.append(vllm_factors)

4502
4503
        hash_str = hashlib.md5(str(factors).encode(),
                               usedforsecurity=False).hexdigest()[:10]
4504
4505
        return hash_str

4506
4507
4508
4509
4510
4511
    def pad_for_cudagraph(self, batch_size: int) -> int:
        # if batch_size > self.compilation_config.max_capture_size,
        # it should raise an IndexError.
        # the caller should make sure the batch_size is within the range,
        # i.e., batch_size <= self.compilation_config.max_capture_size
        return self.compilation_config.bs_to_padded_graph_size[batch_size]
4512

4513
4514
4515
4516
4517
    @staticmethod
    def _get_quantization_config(
            model_config: ModelConfig,
            load_config: LoadConfig) -> Optional[QuantizationConfig]:
        """Get the quantization config."""
4518
        from vllm.platforms import current_platform
4519
4520
4521
4522
4523
4524
4525
4526
4527
4528
4529
4530
4531
4532
4533
4534
4535
4536
4537
4538
4539
4540
        if model_config.quantization is not None:
            from vllm.model_executor.model_loader.weight_utils import (
                get_quant_config)
            quant_config = get_quant_config(model_config, load_config)
            capability_tuple = current_platform.get_device_capability()

            if capability_tuple is not None:
                capability = capability_tuple.to_int()
                if capability < quant_config.get_min_capability():
                    raise ValueError(
                        f"The quantization method {model_config.quantization} "
                        "is not supported for the current GPU. Minimum "
                        f"capability: {quant_config.get_min_capability()}. "
                        f"Current capability: {capability}.")
            supported_dtypes = quant_config.get_supported_act_dtypes()
            if model_config.dtype not in supported_dtypes:
                raise ValueError(
                    f"{model_config.dtype} is not supported for quantization "
                    f"method {model_config.quantization}. Supported dtypes: "
                    f"{supported_dtypes}")
            return quant_config
        return None
4541

4542
4543
4544
4545
4546
4547
4548
4549
4550
4551
4552
    @staticmethod
    def get_quantization_config(
            model_config: ModelConfig,
            load_config: LoadConfig) -> Optional[QuantizationConfig]:
        import copy

        # For some reason, the _ version of this modifies the model_config
        # object, so using deepcopy to avoid this problem.
        return VllmConfig._get_quantization_config(copy.deepcopy(model_config),
                                                   load_config)

4553
4554
4555
4556
4557
4558
4559
4560
4561
    def with_hf_config(
        self,
        hf_config: PretrainedConfig,
        architectures: Optional[list[str]] = None,
    ) -> "VllmConfig":
        if architectures is not None:
            hf_config = copy.deepcopy(hf_config)
            hf_config.architectures = architectures

4562
4563
4564
4565
        model_config = copy.deepcopy(self.model_config)
        model_config.hf_config = hf_config

        return replace(self, model_config=model_config)
4566
4567
4568
4569

    def __post_init__(self):
        """Verify configs are valid & consistent with each other.
        """
4570
4571
4572

        self.try_verify_and_update_config()

4573
4574
4575
4576
4577
        if self.model_config is not None:
            self.model_config.verify_async_output_proc(self.parallel_config,
                                                       self.speculative_config,
                                                       self.device_config)
            self.model_config.verify_with_parallel_config(self.parallel_config)
4578
4579
            self.model_config.verify_dual_chunk_attention_config(
                self.load_config)
4580

4581
        self.cache_config.verify_with_parallel_config(self.parallel_config)
4582

4583
        if self.lora_config is not None:
4584
            self.lora_config.verify_with_cache_config(self.cache_config)
4585
4586
            self.lora_config.verify_with_model_config(self.model_config)

4587
        if self.quant_config is None and self.model_config is not None:
4588
4589
            self.quant_config = VllmConfig._get_quantization_config(
                self.model_config, self.load_config)
4590

4591
        from vllm.platforms import current_platform
4592
        if self.model_config is not None and \
4593
4594
4595
            self.scheduler_config.chunked_prefill_enabled and \
            self.model_config.dtype == torch.float32 and \
            current_platform.get_device_capability() == (7, 5):
4596
            logger.warning_once(
4597
4598
4599
4600
                "Turing devices tensor cores do not support float32 matmul. "
                "To workaround this limitation, vLLM will set 'ieee' input "
                "precision for chunked prefill triton kernels.")

4601
4602
4603
4604
4605
        # async tp is built on top of sequence parallelism
        # and requires it to be enabled.
        if self.compilation_config.pass_config.enable_async_tp:
            self.compilation_config.pass_config.enable_sequence_parallelism = \
                True
4606
4607
        if self.compilation_config.pass_config.enable_sequence_parallelism:
            self.compilation_config.custom_ops.append("+rms_norm")
4608
4609
        if envs.VLLM_USE_V1 and self.model_config is not None and \
            not self.model_config.enforce_eager:
4610
4611
            # By default, V1 uses piecewise CUDA graphs. If full_cuda_graph
            # is set to True, full CUDA graphs will be used.
4612
            self.compilation_config.cudagraph_num_of_warmups = 1
zhuwenwen's avatar
zhuwenwen committed
4613
            self.compilation_config.level = CompilationLevel.PIECEWISE
4614
            self.compilation_config.set_splitting_ops_for_v1()
4615

4616
        self._set_cudagraph_sizes()
4617

4618
        if self.cache_config.cpu_offload_gb > 0 and \
4619
4620
            self.compilation_config.level != CompilationLevel.NO_COMPILATION \
                and not envs.VLLM_USE_V1:
4621
            logger.warning(
4622
                "CPU offload is not supported with `torch.compile` in v0 yet."
4623
4624
4625
                " Disabling `torch.compile`.")
            self.compilation_config.level = CompilationLevel.NO_COMPILATION

4626
4627
4628
4629
4630
4631
        if ((not envs.VLLM_USE_V1) and self.lora_config is not None
                and self.compilation_config.level
                != CompilationLevel.NO_COMPILATION):
            logger.warning(
                "LoRA for V0 is not supported with `torch.compile` yet. "
                "Disabling `torch.compile`.")
4632
4633
            self.compilation_config.level = CompilationLevel.NO_COMPILATION

4634
4635
        if self.compilation_config.full_cuda_graph and \
            not self.model_config.disable_cascade_attn:
4636
4637
            logger.info("full_cuda_graph is not supported with "
                        "cascade attention. Disabling cascade attention.")
4638
            self.model_config.disable_cascade_attn = True
4639

4640
4641
4642
4643
4644
4645
4646
4647
4648
4649
4650
4651
4652
4653
4654
4655
4656
4657
4658
4659
        disable_chunked_prefill_reasons: list[str] = []

        if self.model_config and self.model_config.pooler_config:
            pooling_type = self.model_config.pooler_config.pooling_type
            if pooling_type is None or pooling_type.lower() != "last":
                disable_chunked_prefill_reasons.append(
                    "Only \"last\" pooling supports chunked "
                    "prefill and prefix caching; disabling both.")

        if disable_chunked_prefill_reasons:
            for reason in disable_chunked_prefill_reasons:
                logger.info(reason)
            self.scheduler_config.chunked_prefill_enabled = False
            self.scheduler_config.long_prefill_token_threshold = 0
            self.scheduler_config.max_num_batched_tokens = max(
                self.scheduler_config.max_model_len,
                DEFAULT_MAX_NUM_BATCHED_TOKENS)

            if self.cache_config is not None:
                self.cache_config.enable_prefix_caching = False
4660

4661
        if (self.kv_events_config is not None
4662
4663
4664
4665
4666
                and self.kv_events_config.enable_kv_cache_events
                and not self.cache_config.enable_prefix_caching):
            logger.warning(
                "KV cache events are on, but prefix caching is not enabled."
                "Use --enable-prefix-caching to enable.")
4667
4668
        if (self.kv_events_config is not None
                and self.kv_events_config.publisher != "null"
4669
4670
4671
4672
4673
                and not self.kv_events_config.enable_kv_cache_events):
            logger.warning("KV cache events are disabled,"
                           "but the scheduler is configured to publish them."
                           "Modify KVEventsConfig.enable_kv_cache_events"
                           "to True to enable.")
4674
4675
        current_platform.check_and_update_config(self)

4676
4677
4678
        if not self.instance_id:
            self.instance_id = random_uuid()[:5]

4679
4680
4681
4682
4683
4684
4685
        if (envs.VLLM_USE_V1
                and not self.scheduler_config.disable_hybrid_kv_cache_manager):
            # logger should only print warning message for hybrid models. As we
            # can't know whether the model is hybrid or not now, so we don't log
            # warning message here and will log it later.
            if not (current_platform.is_cuda() or current_platform.is_rocm()):
                # Hybrid KV cache manager is not supported on non-GPU platforms.
4686
                self.scheduler_config.disable_hybrid_kv_cache_manager = True
4687
4688
            if self.kv_transfer_config is not None:
                # Hybrid KV cache manager is not compatible with KV transfer.
4689
                self.scheduler_config.disable_hybrid_kv_cache_manager = True
4690
4691
            if self.kv_events_config is not None:
                # Hybrid KV cache manager is not compatible with KV events.
4692
                self.scheduler_config.disable_hybrid_kv_cache_manager = True
4693
4694
4695
4696
4697
4698
4699
            if self.model_config is not None and \
                self.model_config.attention_chunk_size is not None and \
                self.speculative_config is not None and \
                self.speculative_config.use_eagle():
                # Hybrid KV cache manager is not yet supported with chunked
                # local attention + eagle.
                self.scheduler_config.disable_hybrid_kv_cache_manager = True
4700

4701
4702
4703
4704
4705
4706
4707
4708
4709
4710
4711
4712
4713
4714
4715
4716
4717
4718
4719
4720
    def update_sizes_for_sequence_parallelism(self,
                                              possible_sizes: list) -> list:
        # remove the sizes that not multiple of tp_size when
        # enable sequence parallelism
        removed_sizes = [
            size for size in possible_sizes
            if size % self.parallel_config.tensor_parallel_size != 0
        ]
        if removed_sizes:
            logger.warning(
                "Batch sizes %s are removed because they are not "
                "multiple of tp_size %d when "
                "sequence parallelism is enabled", removed_sizes,
                self.parallel_config.tensor_parallel_size)

        return [
            size for size in possible_sizes
            if size % self.parallel_config.tensor_parallel_size == 0
        ]

4721
4722
4723
4724
4725
4726
4727
4728
4729
4730
4731
4732
4733
4734
4735
4736
    def _set_cudagraph_sizes(self):
        """
        cudagraph batchsize padding logic:

        `[1, 2, 4] + [8 * i for i in range(1, 1025)]` is a list of all possible
        batch sizes that cudagraph will capture.

        Depending on the engine's configuration of `max_num_seqs`, the
        candidate batch sizes to capture cudagraph will shrink to the subset
        which just cover the range of `[1, max_num_seqs]`. In the common case,
        `max_num_seqs` is 256, and the cudagraph batch sizes will be
        `[1, 2, 4, 8, 16, 24, 32, 40, ..., 256]`.

        However, if users specify the cudagraph capture sizes through
        compilation config, we will use the specified sizes instead.

4737
4738
        In the end, `vllm_config.compilation_config.cudagraph_capture_sizes`
        will be the final sizes to capture cudagraph (in descending order).
4739
4740

        During runtime, if batchsize is larger than
4741
        `vllm_config.compilation_config.cudagraph_capture_sizes`,
4742
4743
        no cudagraph will be used.
        If the batch size is no larger than
4744
        `vllm_config.compilation_config.cudagraph_capture_sizes`,
4745
4746
        we can quickly find the padded graph size for a given batch size by
        looking up `vllm_config.compilation_config.bs_to_padded_graph_size`.
4747
        """
4748
4749
4750
4751
4752
4753
4754
4755
4756

        # calculate the default `batch_size_capture_list`
        if not envs.VLLM_USE_V1:
            batch_size_capture_list = []
            if self.scheduler_config is not None and \
                self.model_config is not None and \
                    not self.model_config.enforce_eager:

                possible_sizes = [1, 2, 4] + [8 * i for i in range(1, 1025)]
4757
4758
4759
4760
4761
                if self.parallel_config.tensor_parallel_size > 1 and \
                    self.compilation_config.pass_config.enable_sequence_parallelism:
                    possible_sizes = self.update_sizes_for_sequence_parallelism(
                        possible_sizes)

4762
4763
4764
4765
4766
4767
4768
4769
4770
4771
4772
4773
4774
4775
4776
4777
4778
4779
4780
4781
4782
                # find the minimum size that is larger than max_num_seqs,
                # which then becomes the max_batchsize_to_capture
                larger_sizes = [
                    x for x in possible_sizes
                    if x >= self.scheduler_config.max_num_seqs
                ]
                if larger_sizes:
                    max_batchsize_to_capture = larger_sizes[0]
                else:
                    max_batchsize_to_capture = possible_sizes[-1]

                # filter out the sizes that are
                # larger than max_batchsize_to_capture
                batch_size_capture_list = [
                    size for size in possible_sizes
                    if size <= max_batchsize_to_capture
                ]
        else:
            batch_size_capture_list = []
            if self.model_config is not None and \
                not self.model_config.enforce_eager:
4783
4784
4785
4786
                if self.model_config.use_mla and self.compilation_config.full_cuda_graph:
                    cuda_graph_sizes = [256]
                else:
                    cuda_graph_sizes = self.scheduler_config.cuda_graph_sizes 
4787
4788
4789
4790
4791
4792
4793
                if len(cuda_graph_sizes) == 1:
                    batch_size_capture_list = [1, 2, 4] + [
                        i for i in range(8, cuda_graph_sizes[0] + 1, 8)
                    ]
                elif len(cuda_graph_sizes) > 1:
                    batch_size_capture_list = sorted(cuda_graph_sizes)
                else:
Cyrus Leung's avatar
Cyrus Leung committed
4794
                    raise TypeError(f"Invalid value for {cuda_graph_sizes=}.")
4795
4796
4797
4798
                if self.parallel_config.tensor_parallel_size > 1 and \
                    self.compilation_config.pass_config.enable_sequence_parallelism:
                    batch_size_capture_list = \
                        self.update_sizes_for_sequence_parallelism(batch_size_capture_list)
4799
4800
4801
4802
4803
                max_num_tokens = self.scheduler_config.max_num_batched_tokens
                batch_size_capture_list = [
                    size for size in batch_size_capture_list
                    if size <= max_num_tokens
                ]
4804
4805
4806
4807
4808
                
                # add for spec decode
                if self.speculative_config is not None and self.speculative_config.num_lookahead_slots > 0:
                    batch_size_capture_list = list(map(lambda x: x * (1 + self.speculative_config.num_lookahead_slots),
                                                        batch_size_capture_list))
4809
4810
4811
4812

        self.compilation_config.init_with_cudagraph_sizes(
            batch_size_capture_list)

4813
    def recalculate_max_model_len(self, max_model_len: int):
4814
        # Can only be called in try_verify_and_update_config
4815
        model_config = self.model_config
4816
        max_model_len = model_config.get_and_verify_max_len(max_model_len)
4817
4818
        self.model_config.max_model_len = max_model_len
        self.scheduler_config.max_model_len = max_model_len
4819
4820
4821
4822
4823
4824

    def try_verify_and_update_config(self):
        architecture = getattr(self.model_config, "architecture", None)
        if architecture is None:
            return

4825
4826
        from vllm.model_executor.models.config import (
            MODELS_CONFIG_MAP, HybridAttentionMambaModelConfig)
4827
4828
4829
        cls = MODELS_CONFIG_MAP.get(architecture, None)
        if cls is not None:
            cls.verify_and_update_config(self)
4830

4831
4832
4833
        if self.model_config.is_hybrid:
            HybridAttentionMambaModelConfig.verify_and_update_config(self)

4834
4835
4836
4837
4838
        if self.model_config.task == "classify":
            # Maybe convert ForCausalLM into ForSequenceClassification model.
            from vllm.model_executor.models.adapters import (
                SequenceClassificationConfig)
            SequenceClassificationConfig.verify_and_update_config(self)
4839

4840
    def __str__(self):
4841
4842
4843
4844
4845
4846
4847
4848
4849
4850
4851
4852
4853
4854
4855
4856
4857
4858
4859
4860
4861
4862
4863
4864
4865
4866
4867
4868
4869
4870
        return (
            f"model={self.model_config.model!r},"
            f" speculative_config={self.speculative_config!r},"
            f" tokenizer={self.model_config.tokenizer!r}, "
            f"skip_tokenizer_init={self.model_config.skip_tokenizer_init},"
            f" tokenizer_mode={self.model_config.tokenizer_mode}, "
            f"revision={self.model_config.revision}, "
            f"override_neuron_config={self.model_config.override_neuron_config},"
            f" tokenizer_revision={self.model_config.tokenizer_revision}, "
            f"trust_remote_code={self.model_config.trust_remote_code}, "
            f"dtype={self.model_config.dtype}, "
            f"max_seq_len={self.model_config.max_model_len},"
            f" download_dir={self.load_config.download_dir!r}, "
            f"load_format={self.load_config.load_format}, "
            f"tensor_parallel_size={self.parallel_config.tensor_parallel_size},"
            f" pipeline_parallel_size={self.parallel_config.pipeline_parallel_size}, "  # noqa
            f"disable_custom_all_reduce={self.parallel_config.disable_custom_all_reduce}, "  # noqa
            f"quantization={self.model_config.quantization}, "
            f"enforce_eager={self.model_config.enforce_eager}, "
            f"kv_cache_dtype={self.cache_config.cache_dtype}, "
            f" device_config={self.device_config.device}, "
            f"decoding_config={self.decoding_config!r}, "
            f"observability_config={self.observability_config!r}, "
            f"seed={self.model_config.seed}, "
            f"served_model_name={self.model_config.served_model_name}, "
            f"num_scheduler_steps={self.scheduler_config.num_scheduler_steps}, "
            f"multi_step_stream_outputs={self.scheduler_config.multi_step_stream_outputs}, "  # noqa
            f"enable_prefix_caching={self.cache_config.enable_prefix_caching}, "
            f"chunked_prefill_enabled={self.scheduler_config.chunked_prefill_enabled}, "  # noqa
            f"use_async_output_proc={self.model_config.use_async_output_proc}, "
4871
4872
            f"pooler_config={self.model_config.pooler_config!r}, "
            f"compilation_config={self.compilation_config!r}")
4873
4874
4875


_current_vllm_config: Optional[VllmConfig] = None
4876
_current_prefix: Optional[str] = None
4877
4878
4879


@contextmanager
4880
4881
4882
def set_current_vllm_config(vllm_config: VllmConfig,
                            check_compile=False,
                            prefix: Optional[str] = None):
4883
    """
4884
    Temporarily set the current vLLM config.
4885
    Used during model initialization.
4886
    We save the current vLLM config in a global variable,
4887
    so that all modules can access it, e.g. custom ops
4888
    can access the vLLM config to determine how to dispatch.
4889
    """
4890
    global _current_vllm_config, _current_prefix
4891
    old_vllm_config = _current_vllm_config
4892
    old_prefix = _current_prefix
4893
4894
4895
4896
    from vllm.compilation.counter import compilation_counter
    num_models_seen = compilation_counter.num_models_seen
    try:
        _current_vllm_config = vllm_config
4897
        _current_prefix = prefix
4898
        yield
4899
4900
4901
    except Exception:
        raise
    else:
4902
4903
4904
4905
        logger.debug("enabled custom ops: %s",
                     vllm_config.compilation_config.enabled_custom_ops)
        logger.debug("disabled custom ops: %s",
                     vllm_config.compilation_config.disabled_custom_ops)
4906
4907
        if check_compile and \
            vllm_config.compilation_config.level == CompilationLevel.PIECEWISE \
4908
4909
4910
4911
4912
4913
4914
4915
4916
            and compilation_counter.num_models_seen == num_models_seen:
            # If the model supports compilation,
            # compilation_counter.num_models_seen should be increased
            # by at least 1.
            # If it is not increased, it means the model does not support
            # compilation (does not have @support_torch_compile decorator).
            logger.warning(
                "`torch.compile` is turned on, but the model %s"
                " does not support it. Please open an issue on GitHub"
4917
                " if you want it to be supported.",
4918
                vllm_config.model_config.model)
4919
    finally:
4920
        _current_vllm_config = old_vllm_config
4921
        _current_prefix = old_prefix
4922
4923
4924
4925
4926
4927
4928


def get_current_vllm_config() -> VllmConfig:
    if _current_vllm_config is None:
        # in ci, usually when we test custom ops/modules directly,
        # we don't set the vllm config. In that case, we set a default
        # config.
4929
        logger.warning("Current vLLM config is not set.")
4930
4931
4932
        from vllm.config import VllmConfig
        return VllmConfig()
    return _current_vllm_config
4933
4934


4935
4936
4937
4938
4939
4940
4941
4942
4943
def get_current_model_prefix() -> str:
    """
    Get the prefix of the model that's currently being initialized.
    """
    assert _current_prefix is not None, \
        "Current model prefix is not set. "
    return _current_prefix


4944
4945
4946
4947
4948
4949
4950
4951
4952
4953
4954
def contains_object_print(text):
    """
    Check if the text looks like a printed Python object, e.g.
    contains any substring matching the pattern: "at 0xFFFFFFF>"
    We match against 0x followed by 2-16 hex chars (there's
    a max of 16 on a 64 bit system).

    Args:
        text (str): The text to check

    Returns:
4955
        result (bool): `True` if a match is found, `False` otherwise.
4956
4957
4958
4959
4960
4961
4962
4963
4964
4965
4966
4967
4968
    """
    pattern = r'at 0x[a-fA-F0-9]{2,16}>'
    match = re.search(pattern, text)
    return match is not None


def assert_hashable(text):
    if not contains_object_print(text):
        return True
    raise AssertionError(
        f"vLLM tried to hash some configs that may have Python objects ids "
        f"in them. This is a bug, please file an issue. "
        f"Text being hashed: {text}")
4969
4970
4971
4972
4973
4974
4975
4976
4977
4978
4979
4980
4981


T = TypeVar("T")


def get_layers_from_vllm_config(vllm_config: VllmConfig,
                                layer_type: type[T]) -> dict[str, T]:
    return {
        layer_name: layer
        for layer_name, layer in
        vllm_config.compilation_config.static_forward_context.items()
        if isinstance(layer, layer_type)
    }
4982
4983
4984
4985
4986
4987
4988
4989
4990
4991
4992
4993
4994
4995
4996
4997
4998
4999
5000
5001
5002
5003
5004
5005
5006
5007
5008
5009
5010
5011


@config
@dataclass
class SpeechToTextConfig:
    """Configuration for speech-to-text models."""

    sample_rate: float = 16_000
    """Sample rate (Hz) to resample input audio to. Most speech models expect
    16kHz audio input. The input audio will be automatically resampled to this
    rate before processing."""

    max_audio_clip_s: int = 30
    """Maximum duration in seconds for a single audio clip without chunking.
    Audio longer than this will be split into smaller chunks if
    `allow_audio_chunking` evaluates to True, otherwise it will be rejected."""

    overlap_chunk_second: int = 1
    """Overlap duration in seconds between consecutive audio chunks when
    splitting long audio. This helps maintain context across chunk boundaries
    and improves transcription quality at split points."""

    min_energy_split_window_size: Optional[int] = 1600
    """Window size in samples for finding low-energy (quiet) regions to split
    audio chunks. The algorithm looks for the quietest moment within this
    window to minimize cutting through speech. Default 1600 samples ≈ 100ms
    at 16kHz. If None, no chunking will be done."""

    @property
    def allow_audio_chunking(self) -> bool:
5012
        return self.min_energy_split_window_size is not None
5013
5014
5015
5016
5017
5018
5019
5020
5021
5022
5023
5024
5025
5026
5027
5028
5029
5030


def update_config(config: DataclassInstanceT,
                  overrides: dict[str, Any]) -> DataclassInstanceT:
    processed_overrides = {}
    for field_name, value in overrides.items():
        assert hasattr(
            config, field_name), f"{type(config)} has no field `{field_name}`"
        current_value = getattr(config, field_name)
        if is_dataclass(current_value) and not is_dataclass(value):
            assert isinstance(value, dict), (
                f"Overrides to {type(config)}.{field_name} must be a dict"
                f"  or {type(current_value)}, but got {type(value)}")
            value = update_config(
                current_value,  # type: ignore[type-var]
                value)
        processed_overrides[field_name] = value
    return replace(config, **processed_overrides)