config.py 174 KB
Newer Older
1
2
# SPDX-License-Identifier: Apache-2.0

3
import ast
4
import copy
5
import enum
6
import hashlib
7
import inspect
8
import json
9
import re
10
import sys
11
import textwrap
12
import warnings
13
from collections import Counter
14
from contextlib import contextmanager
15
16
from dataclasses import (MISSING, dataclass, field, fields, is_dataclass,
                         replace)
17
from importlib.util import find_spec
18
from pathlib import Path
19
from typing import (TYPE_CHECKING, Any, Callable, ClassVar, Final, Literal,
20
                    Optional, Protocol, TypeVar, Union, get_args)
21
22

import torch
23
from pydantic import BaseModel, Field, PrivateAttr
24
from torch.distributed import ProcessGroup, ReduceOp
25
from transformers import PretrainedConfig
26

27
import vllm.envs as envs
28
from vllm.compilation.inductor_pass import CallableInductorPass, InductorPass
Woosuk Kwon's avatar
Woosuk Kwon committed
29
from vllm.logger import init_logger
30
31
from vllm.model_executor.layers.quantization import (QUANTIZATION_METHODS,
                                                     get_quantization_config)
32
from vllm.model_executor.models import ModelRegistry
33
from vllm.platforms import CpuArchEnum, current_platform
34
from vllm.sampling_params import GuidedDecodingParams
35
from vllm.tracing import is_otel_available, otel_import_error_traceback
36
37
38
from vllm.transformers_utils.config import (
    ConfigFormat, get_config, get_hf_image_processor_config,
    get_hf_text_config, get_pooling_config,
39
40
    get_sentence_transformer_tokenizer_config, is_encoder_decoder,
    try_get_generation_config, uses_mrope)
41
from vllm.transformers_utils.s3_utils import S3Model
42
from vllm.transformers_utils.utils import is_s3, maybe_model_redirect
43
from vllm.utils import (GiB_bytes, LayerBlockType, cuda_device_count_stateless,
44
45
                        get_cpu_memory, get_open_port, is_torch_equal_or_newer,
                        random_uuid, resolve_obj_by_qualname)
46

47
if TYPE_CHECKING:
48
    from _typeshed import DataclassInstance
49
50
    from ray.util.placement_group import PlacementGroup

51
    from vllm.executor.executor_base import ExecutorBase
52
53
    from vllm.model_executor.layers.quantization.base_config import (
        QuantizationConfig)
54
    from vllm.model_executor.model_loader.loader import BaseModelLoader
55
56
    from vllm.transformers_utils.tokenizer_group.base_tokenizer_group import (
        BaseTokenizerGroup)
57

58
    ConfigType = type[DataclassInstance]
59
60
else:
    QuantizationConfig = None
61
    ConfigType = type
62

63
64
logger = init_logger(__name__)

65
66
ConfigT = TypeVar("ConfigT", bound=ConfigType)

67
68
69
# This value is chosen to have a balance between ITL and TTFT. Note it is
# not optimized for throughput.
_DEFAULT_MAX_NUM_BATCHED_TOKENS = 2048
70
_POOLING_MODEL_MAX_NUM_BATCHED_TOKENS = 32768
71
_MULTIMODAL_MODEL_MAX_NUM_BATCHED_TOKENS = 5120
72

73
TaskOption = Literal["auto", "generate", "embedding", "embed", "classify",
74
                     "score", "reward", "transcription"]
75

76
_ResolvedTask = Literal["generate", "embed", "classify", "score", "reward",
77
                        "draft", "transcription"]
78

79
RunnerType = Literal["generate", "pooling", "draft", "transcription"]
80

81
_RUNNER_TASKS: dict[RunnerType, list[_ResolvedTask]] = {
82
83
84
    "generate": ["generate"],
    "pooling": ["embed", "classify", "score", "reward"],
    "draft": ["draft"],
85
    "transcription": ["transcription"],
86
87
}

88
_TASK_RUNNER: dict[_ResolvedTask, RunnerType] = {
89
    task: runner
90
91
    for runner, tasks in _RUNNER_TASKS.items()
    for task in tasks
92
}
93

94
HfOverrides = Union[dict[str, Any], Callable[[PretrainedConfig],
95
96
                                             PretrainedConfig]]

97

98
99
100
101
102
103
class SupportsHash(Protocol):

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


104
105
class SupportsMetricsInfo(Protocol):

106
    def metrics_info(self) -> dict[str, str]:
107
108
109
        ...


110
111
112
113
114
115
class ModelImpl(str, enum.Enum):
    AUTO = "auto"
    VLLM = "vllm"
    TRANSFORMERS = "transformers"


116
117
118
119
120
121
122
123
124
125
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
126

127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
        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


168
def config(cls: ConfigT) -> ConfigT:
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
    """
    A decorator that ensures all fields in a dataclass have default values
    and that each field has a docstring.
    """
    if not is_dataclass(cls):
        raise TypeError("The decorated class must be a dataclass.")
    attr_docs = get_attr_docs(cls)
    for f in fields(cls):
        if f.init and f.default is MISSING and f.default_factory is MISSING:
            raise ValueError(
                f"Field '{f.name}' in {cls.__name__} must have a default value."
            )
        if f.name not in attr_docs:
            raise ValueError(
                f"Field '{f.name}' in {cls.__name__} must have a docstring.")
    return cls


187
def get_field(cls: ConfigType, name: str) -> Field:
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
    """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__}.")
    named_field: Field = cls_fields.get(name)
    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.")


204
class ModelConfig:
205
206
207
208
    """Configuration for the model.

    Args:
        model: Name or path of the huggingface model to use.
209
            It is also used as the content for `model_name` tag in metrics
210
211
212
213
214
            output when `served_model_name` is not specified.
        task: The task to use the model for. Each vLLM instance only supports
            one task, even if the same model can be used for multiple tasks.
            When the model only supports one task, "auto" can be used to select
            it; otherwise, you must specify explicitly which task to use.
215
        tokenizer: Name or path of the huggingface tokenizer to use.
216
        tokenizer_mode: Tokenizer mode. "auto" will use the fast tokenizer if
217
218
219
            available, "slow" will always use the slow tokenizer,
            "mistral" will always use the tokenizer from `mistral_common`, and
            "custom" will use --tokenizer to select the preregistered tokenizer.
220
221
        trust_remote_code: Trust remote code (e.g., from HuggingFace) when
            downloading the model and tokenizer.
222
223
224
225
        allowed_local_media_path: 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.
226
227
228
229
        dtype: Data type for model weights and activations. The "auto" option
            will use FP16 precision for FP32 and FP16 models, and BF16 precision
            for BF16 models.
        seed: Random seed for reproducibility.
Jasmond L's avatar
Jasmond L committed
230
231
232
        revision: 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.
233
        code_revision: The specific revision to use for the model code on
234
            Hugging Face Hub. It can be a branch name, a tag name, or a
235
            commit id. If unspecified, will use the default version.
236
237
238
        tokenizer_revision: The specific tokenizer version to use. It can be a
            branch name, a tag name, or a commit id. If unspecified, will use
            the default version.
239
240
        max_model_len: Maximum length of a sequence (including prompt and
            output). If None, will be derived from the model.
241
242
        spec_target_max_model_len: Specify the the maximum length for spec
            decoding draft models.
243
244
        quantization: Quantization method that was used to quantize the model
            weights. If None, we assume the model weights are not quantized.
245
246
247
        enforce_eager: Whether to enforce eager execution. 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.
248
            If None, the user did not specify, so default to False.
249
250
        max_seq_len_to_capture: Maximum sequence len covered by CUDA graphs.
            When a sequence has context length larger than this, we fall back
251
252
253
            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.
254
        max_logprobs: Maximum number of log probabilities. Defaults to 20.
255
256
257
258
        disable_sliding_window: Whether to disable sliding window. If True,
            we will disable the sliding window functionality of the model.
            If the model does not support sliding window, this argument is
            ignored.
259
260
        skip_tokenizer_init: If true, skip initialization of tokenizer and
            detokenizer.
261
        served_model_name: The model name used in metrics tag `model_name`,
262
263
            matches the model name exposed via the APIs. If multiple model
            names provided, the first name will be used. If not specified,
264
            the model name will be the same as `model`.
265
        limit_mm_per_prompt: Maximum number of data items per modality
266
            per prompt. Only applicable for multimodal models.
267
268
        use_async_output_proc: Whether to use async output processor.
            Defaults to True.
269
270
        config_format: The config format which shall be loaded.
            Defaults to 'auto' which defaults to 'hf'.
271
        hf_token: The token to use as HTTP bearer authorization for remote files
272
            . If `True`, will use the token generated when running
273
            `huggingface-cli login` (stored in `~/.huggingface`).
274
275
276
        hf_overrides: If a dictionary, contains arguments to be forwarded to the
            HuggingFace config. If a callable, it is called to update the
            HuggingFace config.
277
278
        mm_processor_kwargs: Arguments to be forwarded to the model's processor
            for multi-modal data, e.g., image processor.
279
280
        disable_mm_preprocessor_cache: If true, then disables caching of the
            multi-modal preprocessor/mapper. (not recommended)
281
282
283
284
        override_neuron_config: 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 arguments.
285
        override_pooler_config: Initialize non default pooling config or
286
            override default pooling config for the pooling model.
287
288
        logits_processor_pattern: Optional regex pattern specifying valid
            logits processor qualified names that can be passed with the
289
            `logits_processors` extra completion argument. Defaults to None,
290
            which allows no processors.
291
        generation_config: Configuration parameter file for generation.
292
293
294
295
296
297
        model_impl: Which implementation of the model to use:
            "auto" will try to use the vLLM implementation if it exists and
                fall back to the Transformers implementation if no vLLM
                implementation is available.
            "vllm" will use the vLLM model implementation.
            "transformers" will use the Transformers model implementation.
298
299
        override_generation_config: Override the generation config with the
            given config.
300
    """
301

302
303
304
305
306
307
308
309
310
311
312
313
    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.
        """
314
        factors: list[Any] = []
315
316
317
318
319
        factors.append(self.model)
        factors.append(self.dtype)
        factors.append(self.quantization)
        factors.append(self.revision)
        factors.append(self.code_revision)
320
321
322
        factors.append(self.max_model_len)
        factors.append(self.max_logprobs)
        factors.append(self.disable_sliding_window)
323
        factors.append(self.trust_remote_code)
324
325
326
327
        factors.append(self.mm_processor_kwargs)
        factors.append(self.generation_config)
        factors.append(self.model_impl)
        factors.append(self.override_generation_config)
328
329
        factors.append(self.rope_scaling)
        factors.append(self.rope_theta)
330
331
        # hf_config can control how the model looks!
        factors.append(self.hf_config.to_json_string())
332
333
        str_factors = str(factors)
        assert_hashable(str_factors)
334
335
        return hashlib.sha256(str(factors).encode()).hexdigest()

336
337
338
339
340
341
342
343
344
    def __init__(
        self,
        model: str,
        task: Union[TaskOption, Literal["draft"]],
        tokenizer: str,
        tokenizer_mode: str,
        trust_remote_code: bool,
        dtype: Union[str, torch.dtype],
        seed: int,
345
        hf_config_path: Optional[str] = None,
346
347
348
        allowed_local_media_path: str = "",
        revision: Optional[str] = None,
        code_revision: Optional[str] = None,
349
        rope_scaling: Optional[dict[str, Any]] = None,
350
351
352
353
354
355
356
357
358
        rope_theta: Optional[float] = None,
        tokenizer_revision: Optional[str] = None,
        max_model_len: Optional[int] = None,
        spec_target_max_model_len: Optional[int] = None,
        quantization: Optional[str] = None,
        enforce_eager: Optional[bool] = None,
        max_seq_len_to_capture: Optional[int] = None,
        max_logprobs: int = 20,
        disable_sliding_window: bool = False,
359
        disable_cascade_attn: bool = False,
360
        skip_tokenizer_init: bool = False,
361
        served_model_name: Optional[Union[str, list[str]]] = None,
362
        limit_mm_per_prompt: Optional[dict[str, int]] = None,
363
364
        use_async_output_proc: bool = True,
        config_format: ConfigFormat = ConfigFormat.AUTO,
365
        hf_token: Optional[Union[bool, str]] = None,
366
        hf_overrides: Optional[HfOverrides] = None,
367
        mm_processor_kwargs: Optional[dict[str, Any]] = None,
368
        disable_mm_preprocessor_cache: bool = False,
369
        override_neuron_config: Optional[dict[str, Any]] = None,
370
371
        override_pooler_config: Optional["PoolerConfig"] = None,
        logits_processor_pattern: Optional[str] = None,
372
        generation_config: str = "auto",
373
        enable_sleep_mode: bool = False,
374
        override_generation_config: Optional[dict[str, Any]] = None,
375
        model_impl: Union[str, ModelImpl] = ModelImpl.AUTO,
376
    ) -> None:
377
378
379
        self.model = maybe_model_redirect(model)
        self.tokenizer = maybe_model_redirect(tokenizer)

380
        self.hf_config_path = hf_config_path
381
382
383
        if isinstance(hf_config_path, str):
            self.hf_config_path = maybe_model_redirect(hf_config_path)

384
        self.tokenizer_mode = tokenizer_mode
385
        self.trust_remote_code = trust_remote_code
386
        self.allowed_local_media_path = allowed_local_media_path
387
        self.seed = seed
Jasmond L's avatar
Jasmond L committed
388
        self.revision = revision
389
        self.code_revision = code_revision
390
391
        self.rope_scaling = rope_scaling
        self.rope_theta = rope_theta
392
        self.model_impl = model_impl
393
394
395

        if hf_overrides is None:
            hf_overrides = {}
396
397
398
399
400
401

        if callable(hf_overrides):
            hf_overrides_kw = {}
            hf_overrides_fn = hf_overrides
        else:
            hf_overrides_kw = hf_overrides
402
            hf_overrides_fn = None
403

404
        if rope_scaling is not None:
405
            hf_override: dict[str, Any] = {"rope_scaling": rope_scaling}
406
            hf_overrides_kw.update(hf_override)
407
408
409
410
            hf_overrides_str = json.dumps(hf_overrides)
            msg = (
                "`--rope-scaling` will be removed in a future release. "
                f"'Please instead use `--hf-overrides '{hf_overrides_str}'`")
411
412
413
            warnings.warn(DeprecationWarning(msg), stacklevel=2)
        if rope_theta is not None:
            hf_override = {"rope_theta": rope_theta}
414
            hf_overrides_kw.update(hf_override)
415
416
417
418
            hf_overrides_str = json.dumps(hf_overrides)
            msg = (
                "`--rope-theta` will be removed in a future release. "
                f"'Please instead use `--hf-overrides '{hf_overrides_str}'`")
419
420
            warnings.warn(DeprecationWarning(msg), stacklevel=2)

421
422
        self.maybe_pull_model_tokenizer_for_s3(model, tokenizer)

423
424
425
426
        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 "
427
428
                "module was not found. See "
                "https://github.com/vllm-project/vllm/blob/main/docker/Dockerfile "  # noqa: E501
429
430
                "for instructions on how to install it.")

431
432
433
434
435
        # The tokenizer version is consistent with the model version by default.
        if tokenizer_revision is None:
            self.tokenizer_revision = revision
        else:
            self.tokenizer_revision = tokenizer_revision
436
        self.quantization = quantization
437
        self.enforce_eager = enforce_eager
438
        self.max_seq_len_to_capture = max_seq_len_to_capture
439
        self.max_logprobs = max_logprobs
440
        self.disable_sliding_window = disable_sliding_window
441
        self.disable_cascade_attn = disable_cascade_attn
442
        self.skip_tokenizer_init = skip_tokenizer_init
443
444
445
446
        self.enable_sleep_mode = enable_sleep_mode

        from vllm.platforms import current_platform

447
448
449
450
        if (self.enable_sleep_mode
                and not current_platform.is_sleep_mode_available()):
            raise ValueError(
                "Sleep mode is not supported on current platform.")
451

452
453
454
        hf_config = get_config(self.hf_config_path or self.model,
                               trust_remote_code, revision, code_revision,
                               config_format)
455
456
457
458
459
460
461
462

        if hf_overrides_kw:
            logger.info("Overriding HF config with %s", hf_overrides_kw)
            hf_config.update(hf_overrides_kw)
        if hf_overrides_fn:
            logger.info("Overriding HF config with %s", hf_overrides_fn)
            hf_config = hf_overrides_fn(hf_config)

463
464
        self.hf_config = hf_config

465
        self.hf_text_config = get_hf_text_config(self.hf_config)
466
467
        self.attention_chunk_size = getattr(self.hf_text_config,
                                            "attention_chunk_size", None)
468
        self.encoder_config = self._get_encoder_config()
469
        self.hf_image_processor_config = get_hf_image_processor_config(
470
            self.model, hf_token=hf_token, revision=revision)
471
        self.dtype = _get_and_verify_dtype(self.hf_config, dtype)
472
        self.use_async_output_proc = use_async_output_proc
473
        self.mm_processor_kwargs = mm_processor_kwargs
474
        self.disable_mm_preprocessor_cache = disable_mm_preprocessor_cache
Woosuk Kwon's avatar
Woosuk Kwon committed
475

476
477
        # Set enforce_eager to False if the value is unset.
        if self.enforce_eager is None:
478
479
            self.enforce_eager = False

480
        interleaved_attn_models = ["gemma2", "gemma3_text", "cohere2"]
481
482
483
        sliding_window = getattr(self.hf_text_config, "sliding_window", None)
        has_interleaved_attention = (sliding_window is not None) and (
            isinstance(sliding_window, list) or
484
            (self.hf_text_config.model_type in interleaved_attn_models))
485
486

        if (not self.disable_sliding_window and has_interleaved_attention):
487
488
            if (backend :=
                    envs.VLLM_ATTENTION_BACKEND) in ("XFORMERS", "FLASHINFER"):
489
490
                sliding_window_len_min = get_min_sliding_window(
                    self.hf_text_config.sliding_window)
491

492
                logger.warning_once(
493
494
                    f"{self.hf_text_config.model_type} has interleaved "
                    "attention, which is currently not supported by the "
495
                    f"{backend} backend. Disabling sliding window and capping "
496
497
498
499
500
501
502
503
504
505
506
507
                    "the max length to the sliding window size "
                    f"({sliding_window_len_min}).")
                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
                delattr(self.hf_text_config, "sliding_window")
                sliding_window = None
Woosuk Kwon's avatar
Woosuk Kwon committed
508

509
510
511
512
        self.max_model_len = _get_and_verify_max_len(
            hf_config=self.hf_text_config,
            max_model_len=max_model_len,
            disable_sliding_window=self.disable_sliding_window,
513
            sliding_window_len=self.get_hf_config_sliding_window(),
514
515
            spec_target_max_model_len=spec_target_max_model_len,
            encoder_config=self.encoder_config)
516
517
        self.served_model_name = get_served_model_name(model,
                                                       served_model_name)
518
519
        self.multimodal_config = self._init_multimodal_config(
            limit_mm_per_prompt)
520
521
        if not self.skip_tokenizer_init:
            self._verify_tokenizer_mode()
522

523
        self.is_attention_free = self._init_attention_free()
524
        self.is_hybrid = self._init_is_hybrid()
525
        self.has_noops = self._init_has_noops()
526
527
        self.has_inner_state = self._init_has_inner_state()

528
529
530
531
        if current_platform.is_neuron():
            self.override_neuron_config = override_neuron_config
        else:
            self.override_neuron_config = None
532

533
        supported_tasks, task = self._resolve_task(task)
534
535
        self.supported_tasks = supported_tasks
        self.task: Final = task
536
537
538
539
        if self.task in ("draft", "generate"):
            self.truncation_side = "left"
        else:
            self.truncation_side = "right"
540

541
        self.pooler_config = self._init_pooler_config(override_pooler_config)
542
        self.logits_processor_pattern = logits_processor_pattern
543

544
        self.generation_config = generation_config
545
        self.override_generation_config = override_generation_config or {}
546

547
        self._verify_quantization()
548
        self._verify_cuda_graph()
549
        self._verify_bnb_config()
550

551
552
553
554
555
556
557
558
    @property
    def registry(self):
        return ModelRegistry

    @property
    def architectures(self) -> list[str]:
        return getattr(self.hf_config, "architectures", [])

559
560
561
    def maybe_pull_model_tokenizer_for_s3(self, model: str,
                                          tokenizer: str) -> None:
        """
562
        Pull the model config or tokenizer to a temporary
563
564
565
566
567
568
569
570
571
        directory in case of S3.

        Args:
            model: The model name or path.
            tokenizer: The tokenizer name or path.

        """
        if is_s3(model) or is_s3(tokenizer):
            if is_s3(model):
572
                s3_model = S3Model()
573
574
                s3_model.pull_files(
                    model, allow_pattern=["*.model", "*.py", "*.json"])
575
                self.model_weights = self.model
576
                self.model = s3_model.dir
577
578

            if is_s3(tokenizer):
579
580
                s3_tokenizer = S3Model()
                s3_tokenizer.pull_files(
581
                    model, ignore_pattern=["*.pt", "*.safetensors", "*.bin"])
582
                self.tokenizer = s3_tokenizer.dir
583

584
    def _init_multimodal_config(
585
        self, limit_mm_per_prompt: Optional[dict[str, int]]
586
    ) -> Optional["MultiModalConfig"]:
587
        if self.registry.is_multimodal_model(self.architectures):
588
            return MultiModalConfig(limit_per_prompt=limit_mm_per_prompt or {})
589
590
591
592
593
594

        if limit_mm_per_prompt:
            raise ValueError("`limit_mm_per_prompt` is only supported for "
                             "multimodal models.")

        return None
595

596
597
598
599
    def _get_encoder_config(self):
        return get_sentence_transformer_tokenizer_config(
            self.model, self.revision)

600
601
    def _init_pooler_config(
        self,
602
        override_pooler_config: Optional["PoolerConfig"],
603
    ) -> Optional["PoolerConfig"]:
604

605
        if self.runner_type == "pooling":
606
607
608
609
610
611
612
613
614
            user_config = override_pooler_config or PoolerConfig()

            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():
                    if getattr(user_config, k) is None:
                        setattr(user_config, k, v)

615
616
617
618
619
620
621
622
623
            if self.is_matryoshka:
                if user_config.normalize is None:
                    user_config.normalize = True
                elif not user_config.normalize:
                    raise ValueError(
                        "`normalize` must be enabled (set to True) "
                        "for models that are compatible with "
                        "Matryoshka Representation.")

624
625
            return user_config

626
627
        return None

628
    def _init_attention_free(self) -> bool:
629
        return self.registry.is_attention_free_model(self.architectures)
630

631
    def _init_is_hybrid(self) -> bool:
632
        return self.registry.is_hybrid_model(self.architectures)
633

634
635
636
637
    def _init_has_noops(self) -> bool:
        architectures = getattr(self.hf_config, "architectures", [])
        return self.registry.is_noops_model(architectures)

638
    def _init_has_inner_state(self) -> bool:
639
        return self.registry.model_has_inner_state(self.architectures)
640

641
642
    def _verify_tokenizer_mode(self) -> None:
        tokenizer_mode = self.tokenizer_mode.lower()
643
        if tokenizer_mode not in ["auto", "slow", "mistral", "custom"]:
644
645
            raise ValueError(
                f"Unknown tokenizer mode: {self.tokenizer_mode}. Must be "
646
                "either 'auto', 'slow', 'mistral' or 'custom'.")
647
        self.tokenizer_mode = tokenizer_mode
648

649
650
    def _get_preferred_task(
        self,
651
652
        architectures: list[str],
        supported_tasks: set[_ResolvedTask],
653
654
655
656
    ) -> Optional[_ResolvedTask]:
        model_id = self.model
        if get_pooling_config(model_id, self.revision):
            return "embed"
657
        if self.registry.is_cross_encoder_model(architectures):
658
            return "score"
659
        if self.registry.is_transcription_model(architectures):
660
            return "transcription"
661

662
        suffix_to_preferred_task: list[tuple[str, _ResolvedTask]] = [
663
664
665
666
667
668
669
670
671
            # Other models follow this pattern
            ("ForCausalLM", "generate"),
            ("ForConditionalGeneration", "generate"),
            ("ForSequenceClassification", "classify"),
            ("ChatModel", "generate"),
            ("LMHeadModel", "generate"),
            ("EmbeddingModel", "embed"),
            ("RewardModel", "reward"),
        ]
672
        _, arch = self.registry.inspect_model_cls(architectures)
673
674
675
676
677
678
679

        for suffix, pref_task in suffix_to_preferred_task:
            if arch.endswith(suffix) and pref_task in supported_tasks:
                return pref_task

        return None

680
681
    def _resolve_task(
        self,
682
        task_option: Union[TaskOption, Literal["draft"]],
683
    ) -> tuple[set[_ResolvedTask], _ResolvedTask]:
684
685
686
        if task_option == "draft":
            return {"draft"}, "draft"

687
688
        registry = self.registry
        architectures = self.architectures
689

690
        runner_support: dict[RunnerType, bool] = {
691
692
            # NOTE: Listed from highest to lowest priority,
            # in case the model supports multiple of them
693
694
695
            "transcription": registry.is_transcription_model(architectures),
            "generate": registry.is_text_generation_model(architectures),
            "pooling": registry.is_pooling_model(architectures),
696
        }
697
        supported_runner_types_lst: list[RunnerType] = [
698
699
700
701
702
            runner_type
            for runner_type, is_supported in runner_support.items()
            if is_supported
        ]

703
        supported_tasks_lst: list[_ResolvedTask] = [
704
705
            task for runner_type in supported_runner_types_lst
            for task in _RUNNER_TASKS[runner_type]
706
707
708
709
710
        ]
        supported_tasks = set(supported_tasks_lst)

        if task_option == "auto":
            selected_task = next(iter(supported_tasks_lst))
711

712
713
714
715
716
            if len(supported_tasks_lst) > 1:
                preferred_task = self._get_preferred_task(
                    architectures, supported_tasks)
                if preferred_task is not None:
                    selected_task = preferred_task
717

718
719
720
                logger.info(
                    "This model supports multiple tasks: %s. "
                    "Defaulting to '%s'.", supported_tasks, selected_task)
721
        else:
722
723
724
725
726
727
728
729
730
731
732
733
734
735
            # Aliases
            if task_option == "embedding":
                preferred_task = self._get_preferred_task(
                    architectures, supported_tasks)
                if preferred_task != "embed":
                    msg = ("The 'embedding' task will be restricted to "
                           "embedding models in a future release. Please "
                           "pass `--task classify`, `--task score`, or "
                           "`--task reward` explicitly for other pooling "
                           "models.")
                    warnings.warn(msg, DeprecationWarning, stacklevel=2)

                task_option = preferred_task or "embed"

736
737
738
739
740
741
742
            if task_option not in supported_tasks:
                msg = (
                    f"This model does not support the '{task_option}' task. "
                    f"Supported tasks: {supported_tasks}")
                raise ValueError(msg)

            selected_task = task_option
743

744
        return supported_tasks, selected_task
745

746
747
748
    def _parse_quant_hf_config(self):
        quant_cfg = getattr(self.hf_config, "quantization_config", None)
        if quant_cfg is None:
749
            # compressed-tensors uses a "compression_config" key
750
            quant_cfg = getattr(self.hf_config, "compression_config", None)
751
752
        return quant_cfg

753
    def _verify_quantization(self) -> None:
754
        supported_quantization = QUANTIZATION_METHODS
755
        optimized_quantization_methods = [
756
757
            "fp8", "marlin", "modelopt", "gptq_marlin_24", "gptq_marlin",
            "awq_marlin", "fbgemm_fp8", "compressed_tensors",
758
759
            "compressed-tensors", "experts_int8", "quark", "nvfp4", "bitblas",
            "gptq_bitblas"
760
        ]
761
762
763
764
        if self.quantization is not None:
            self.quantization = self.quantization.lower()

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

767
768
        if quant_cfg is not None:
            quant_method = quant_cfg.get("quant_method", "").lower()
769
770

            # Detect which checkpoint is it
771
772
            for name in QUANTIZATION_METHODS:
                method = get_quantization_config(name)
773
774
775
776
777
778
                quantization_override = method.override_quantization_method(
                    quant_cfg, self.quantization)
                if quantization_override:
                    quant_method = quantization_override
                    self.quantization = quantization_override
                    break
779

780
            # Verify quantization configurations.
781
            if self.quantization is None:
782
783
                self.quantization = quant_method
            elif self.quantization != quant_method:
784
785
                raise ValueError(
                    "Quantization method specified in the model config "
786
                    f"({quant_method}) does not match the quantization "
787
788
789
790
791
792
793
794
                    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}.")
795
            from vllm.platforms import current_platform
796
            current_platform.verify_quantization(self.quantization)
797
            if self.quantization not in optimized_quantization_methods:
798
                logger.warning(
799
                    "%s quantization is not fully "
800
                    "optimized yet. The speed can be slower than "
801
                    "non-quantized models.", self.quantization)
802

803
    def _verify_cuda_graph(self) -> None:
804
805
806
807
        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)
808
809
810
811
812
813
814
        ROCM_UNSUPPORTED_MODELS = ['mllama']
        if (self.hf_config.model_type in ROCM_UNSUPPORTED_MODELS
                and not self.enforce_eager and current_platform.is_rocm()):
            logger.warning(
                "CUDA graph is not supported for %s on ROCm yet, fallback "
                "to the eager mode.", self.hf_config.model_type)
            self.enforce_eager = True
815

816
817
    def _verify_bnb_config(self) -> None:
        """
818
        The current version of bitsandbytes (0.45.3) with 8-bit models does not
819
        yet support CUDA graph.
820
        # TODO Remove this when bitsandbytes supports.
821
822
823
824
825
826
827
828
829
830
831
832
833
834
        """
        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(
835
                "CUDA graph is not supported on BitsAndBytes 8bit yet, "
836
                "fallback to the eager mode.")
837

838
839
            self.enforce_eager = True

840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
    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.")

857
858
859
860
861
862
863
864
865
866
    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

867
        # Reminder: Please update docs/source/features/compatibility_matrix.md
868
        # If the feature combo become valid
869
        from vllm.platforms import current_platform
870
        if not current_platform.is_async_output_supported(self.enforce_eager):
871
872
873
874
875
876
877
            self.use_async_output_proc = False
            return

        if envs.VLLM_USE_RAY_SPMD_WORKER:
            self.use_async_output_proc = False
            return

878
        # Async postprocessor is not necessary for pooling models
879
        # since there is no token generation
880
        if self.runner_type == "pooling":
881
882
            self.use_async_output_proc = False

883
        # Reminder: Please update docs/source/features/compatibility_matrix.md
884
        # If the feature combo become valid
885
886
887
        if speculative_config:
            self.use_async_output_proc = False

888
889
890
891
    def verify_with_parallel_config(
        self,
        parallel_config: "ParallelConfig",
    ) -> None:
892
893
894
895
896
897

        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.")

898
899
        total_num_attention_heads = getattr(self.hf_text_config,
                                            "num_attention_heads", 0)
900
901
902
903
904
905
906
        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}).")

907
        if parallel_config.enable_expert_parallel:
908
909
            self._verify_with_expert_parallelism()

910
        pipeline_parallel_size = parallel_config.pipeline_parallel_size
911
        if pipeline_parallel_size > 1:
912
            if not self.registry.is_pp_supported_model(self.architectures):
913
914
915
916
917
918
                raise NotImplementedError(
                    "Pipeline parallelism is not supported for this model. "
                    "Supported models implement the `SupportsPP` interface.")

            if self.use_async_output_proc:
                self.use_async_output_proc = False
919

920
    def get_hf_config_sliding_window(
921
            self) -> Union[Optional[int], list[Optional[int]]]:
Woosuk Kwon's avatar
Woosuk Kwon committed
922
        """Get the sliding window size, or None if disabled."""
923
924
925
926

        # 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.
927
928
        if (hasattr(self.hf_text_config, "use_sliding_window")
                and not self.hf_text_config.use_sliding_window):
929
            return None
930
        return getattr(self.hf_text_config, "sliding_window", None)
931

932
    def get_sliding_window(self) -> Optional[Union[int, list[Optional[int]]]]:
933
934
935
936
937
938
939
940
        """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()

941
    def get_vocab_size(self) -> int:
942
        return self.hf_text_config.vocab_size
943

944
    def get_hidden_size(self) -> int:
945
        return self.hf_text_config.hidden_size
946

947
948
    @property
    def is_deepseek_mla(self) -> bool:
949
950
951
952
953
954
955
956
957
958
959
960
        if not hasattr(self.hf_text_config, "model_type"):
            return False
        elif self.hf_text_config.model_type in \
            ('deepseek_v2', 'deepseek_v3', 'deepseek_mtp'):
            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
961

962
    def get_head_size(self) -> int:
wangding zeng's avatar
wangding zeng committed
963
        # TODO remove hard code
964
        if self.is_deepseek_mla:
965
966
            qk_rope_head_dim = getattr(self.hf_text_config, "qk_rope_head_dim",
                                       0)
967
            if self.use_mla:
968
                return self.hf_text_config.kv_lora_rank + qk_rope_head_dim
969
970
971
972
973
            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
974

975
976
977
978
979
        if hasattr(self.hf_text_config,
                   "model_type") and (self.hf_text_config.model_type
                                      == "zamba2"):
            return self.hf_text_config.attention_head_dim

980
981
982
        if self.is_attention_free:
            return 0

983
984
        if hasattr(self.hf_text_config, "head_dim"):
            return self.hf_text_config.head_dim
985
        # FIXME(woosuk): This may not be true for all models.
986
987
        return (self.hf_text_config.hidden_size //
                self.hf_text_config.num_attention_heads)
988

989
990
    def get_total_num_kv_heads(self) -> int:
        """Returns the total number of KV heads."""
Zhuohan Li's avatar
Zhuohan Li committed
991
        # For GPTBigCode & Falcon:
992
        # NOTE: for falcon, when new_decoder_architecture is True, the
Zhuohan Li's avatar
Zhuohan Li committed
993
994
        # multi_query flag is ignored and we use n_head_kv for the number of
        # KV heads.
995
        falcon_model_types = ["falcon", "RefinedWeb", "RefinedWebModel"]
996
        new_decoder_arch_falcon = (
997
            self.hf_config.model_type in falcon_model_types
998
            and getattr(self.hf_config, "new_decoder_architecture", False))
999
        if not new_decoder_arch_falcon and getattr(self.hf_text_config,
1000
                                                   "multi_query", False):
Zhuohan Li's avatar
Zhuohan Li committed
1001
            # Multi-query attention, only one KV head.
Woosuk Kwon's avatar
Woosuk Kwon committed
1002
            # Currently, tensor parallelism is not supported in this case.
Zhuohan Li's avatar
Zhuohan Li committed
1003
            return 1
1004

1005
        # For DBRX and MPT
1006
1007
1008
1009
1010
        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":
1011
1012
1013
            return getattr(self.hf_config.attn_config, "kv_n_heads",
                           self.hf_config.num_attention_heads)

1014
1015
1016
1017
1018
1019
1020
1021
        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")

1022
1023
1024
        if self.is_attention_free:
            return 0

1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
        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:
1035
            num_kv_heads = getattr(self.hf_text_config, attr, None)
1036
1037
1038
1039
1040
            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.
1041
        return self.hf_text_config.num_attention_heads
1042
1043
1044

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

1049
1050
1051
1052
1053
1054
1055
        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)
1056

1057
1058
    def get_num_attention_heads(self,
                                parallel_config: "ParallelConfig") -> int:
1059
1060
        num_heads = getattr(self.hf_text_config, "num_attention_heads", 0)
        return num_heads // parallel_config.tensor_parallel_size
1061

1062
    def get_layers_start_end_indices(
1063
            self, parallel_config: "ParallelConfig") -> tuple[int, int]:
1064
        from vllm.distributed.utils import get_pp_indices
1065
1066
1067
1068
1069
1070
        if self.hf_text_config.model_type == "deepseek_mtp":
            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)
1071
1072
1073
        # the layout order is: DP x PP x TP
        pp_rank = (parallel_config.rank // parallel_config.tensor_parallel_size
                   ) % parallel_config.pipeline_parallel_size
1074
1075
        pp_size = parallel_config.pipeline_parallel_size
        start, end = get_pp_indices(total_num_hidden_layers, pp_rank, pp_size)
1076
        return start, end
Mor Zusman's avatar
Mor Zusman committed
1077

1078
1079
1080
    def get_num_layers(self, parallel_config: "ParallelConfig") -> int:
        start, end = self.get_layers_start_end_indices(parallel_config)
        return end - start
Mor Zusman's avatar
Mor Zusman committed
1081

1082
1083
1084
1085
1086
1087
1088
1089
    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
1090
1091
1092
        is_transformer = not self.is_hybrid and \
                            not self.has_noops and \
                            not self.is_attention_free
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
        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
1103
1104
1105
1106
        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])
1107
        else:
1108
            # Hybrid model Jamba
1109
1110
            layers_block_type_value = getattr(self.hf_config,
                                              "layers_block_type", None)
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
            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")

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

1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
    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

1149
    def try_get_generation_config(self) -> dict[str, Any]:
1150
        if self.generation_config in ("auto", "vllm"):
1151
            config = try_get_generation_config(
1152
                self.hf_config_path or self.model,
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
                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()

1167
    def get_diff_sampling_param(self) -> dict[str, Any]:
1168
        """
1169
        This method returns a dictionary containing the parameters
1170
1171
        that differ from the default sampling parameters. If
        `generation_config` is `"vllm"`, an empty dictionary is returned.
1172
1173

        Returns:
1174
            dict[str, Any]: A dictionary with the differing sampling
1175
            parameters, if `generation_config` is `"vllm"` an empty dictionary.
1176
        """
1177
        if self.generation_config == "vllm":
1178
1179
1180
1181
1182
1183
1184
            config = {}
        else:
            config = self.try_get_generation_config()

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

1185
1186
1187
1188
1189
1190
        available_params = [
            "repetition_penalty",
            "temperature",
            "top_k",
            "top_p",
            "min_p",
1191
            "max_new_tokens",
1192
1193
1194
1195
1196
1197
        ]
        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
            }
1198
1199
1200
1201
1202
            # 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")
1203
1204
        else:
            diff_sampling_param = {}
1205
1206
1207
1208
1209
1210
1211

        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`.")
1212
1213
        return diff_sampling_param

1214
    @property
1215
    def is_encoder_decoder(self) -> bool:
1216
        """Extract the HF encoder/decoder model flag."""
1217
1218
1219
1220
1221
        return is_encoder_decoder(self.hf_config)

    @property
    def uses_mrope(self) -> bool:
        return uses_mrope(self.hf_config)
1222

1223
1224
1225
1226
    @property
    def is_multimodal_model(self) -> bool:
        return self.multimodal_config is not None

1227
1228
    @property
    def is_cross_encoder(self) -> bool:
1229
        return self.registry.is_cross_encoder_model(self.architectures)
1230

1231
1232
    @property
    def use_mla(self) -> bool:
1233
        return self.is_deepseek_mla and not envs.VLLM_MLA_DISABLE
1234

1235
    @property
1236
    def supported_runner_types(self) -> set[RunnerType]:
1237
1238
1239
1240
1241
1242
        return {_TASK_RUNNER[task] for task in self.supported_tasks}

    @property
    def runner_type(self) -> RunnerType:
        return _TASK_RUNNER[self.task]

1243
1244
1245
1246
1247
    @property
    def is_v1_compatible(self) -> bool:
        architectures = getattr(self.hf_config, "architectures", [])
        return ModelRegistry.is_v1_compatible(architectures)

1248
1249
1250
1251
1252
    @property
    def is_matryoshka(self) -> bool:
        return (hasattr(self.hf_config, "matryoshka_dimensions")
                or getattr(self.hf_config, "is_matryoshka", False))

1253

1254
BlockSize = Literal[1, 8, 16, 32, 64, 128]
1255
1256
1257
1258
1259
1260
CacheDType = Literal["auto", "fp8", "fp8_e4m3", "fp8_e5m2"]
PrefixCachingHashAlgo = Literal["builtin", "sha256"]


@config
@dataclass
1261
class CacheConfig:
1262
    """Configuration for the KV cache."""
1263

1264
1265
1266
1267
    block_size: Optional[BlockSize] = None
    """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.
1268
    """
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
    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
    fp8 (=fp8_e4m3)."""
    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
    - "sha256" is collision resistant but with certain overheads."""
    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.
    """
    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."""

    # 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."""
1318

1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
    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.
        """
1331
        factors: list[Any] = []
1332
1333
        factors.append(self.cache_dtype)
        # `cpu_offload_gb` does not use `torch.compile` yet.
1334
1335
        hash_str = hashlib.md5(str(factors).encode(),
                               usedforsecurity=False).hexdigest()
1336
1337
        return hash_str

1338
1339
1340
    def __post_init__(self) -> None:
        self.swap_space_bytes = self.swap_space * GiB_bytes

1341
        self._verify_args()
1342
        self._verify_cache_dtype()
1343
        self._verify_prefix_caching()
1344

1345
    def metrics_info(self):
1346
1347
        # convert cache_config to dict(key: str, value: str) for prometheus
        # metrics info
1348
1349
        return {key: str(value) for key, value in self.__dict__.items()}

1350
    def _verify_args(self) -> None:
1351
1352
1353
1354
        if self.cpu_offload_gb < 0:
            raise ValueError("CPU offload space must be non-negative"
                             f", but got {self.cpu_offload_gb}")

1355
1356
1357
1358
1359
        if self.gpu_memory_utilization > 1.0:
            raise ValueError(
                "GPU memory utilization must be less than 1.0. Got "
                f"{self.gpu_memory_utilization}.")

1360
1361
1362
    def _verify_cache_dtype(self) -> None:
        if self.cache_dtype == "auto":
            pass
1363
        elif self.cache_dtype in get_args(CacheDType):
1364
            logger.info(
1365
1366
                "Using fp8 data type to store kv cache. It reduces the GPU "
                "memory footprint and boosts the performance. "
1367
1368
                "Meanwhile, it may cause accuracy drop without a proper "
                "scaling factor")
1369
1370
1371
        else:
            raise ValueError(f"Unknown kv cache dtype: {self.cache_dtype}")

1372
1373
1374
1375
    def _verify_prefix_caching(self) -> None:
        if not self.enable_prefix_caching:
            return

1376
        if self.sliding_window is not None and not envs.VLLM_USE_V1:
1377
1378
1379
1380
            raise NotImplementedError(
                "Prefix caching is not supported with sliding window. "
                "Run with --disable-sliding-window to use prefix caching.")

1381
1382
        if (self.enable_prefix_caching and self.prefix_caching_hash_algo
                not in get_args(PrefixCachingHashAlgo)):
1383
1384
            raise ValueError(
                "Unknown prefix caching hash algorithm: "
1385
1386
                f"{self.prefix_caching_hash_algo}. Must be one of "
                f"{get_args(PrefixCachingHashAlgo)}.")
1387

1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
    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

1398
1399
1400
        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.")
1401
1402
1403
        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:
1404
            logger.warning("Possibly too large swap space. %s", msg)
1405

1406

1407
1408
1409
1410
PoolType = Literal["ray"]


@config
1411
1412
@dataclass
class TokenizerPoolConfig:
1413
    """Configuration for the tokenizer pool."""
1414

1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
    pool_size: int = 0
    """Number of tokenizer workers in the pool to use for asynchronous
    tokenization. If 0, will use synchronous tokenization."""

    pool_type: Union[PoolType, type["BaseTokenizerGroup"]] = "ray"
    """Type of tokenizer pool to use for asynchronous tokenization. Ignored if
    tokenizer_pool_size is 0."""

    extra_config: dict = field(default_factory=dict)
    """Additional config for the pool. The way the config will be used depends
    on the pool type. This should be a JSON string that will be parsed into a
    dictionary. Ignored if tokenizer_pool_size is 0."""
1427

1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
    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.
1442
        factors: list[Any] = []
1443
1444
        hash_str = hashlib.md5(str(factors).encode(),
                               usedforsecurity=False).hexdigest()
1445
1446
        return hash_str

1447
    def __post_init__(self):
1448
1449
        if self.pool_type not in ("ray", ) and not isinstance(
                self.pool_type, type):
1450
1451
1452
1453
1454
1455
            raise ValueError(f"Unknown pool type: {self.pool_type}")
        if not isinstance(self.extra_config, dict):
            raise ValueError("extra_config must be a dictionary.")

    @classmethod
    def create_config(
1456
        cls, tokenizer_pool_size: int,
1457
        tokenizer_pool_type: Union[PoolType, type["BaseTokenizerGroup"]],
1458
1459
1460
        tokenizer_pool_extra_config: Optional[Union[str, dict]]
    ) -> Optional["TokenizerPoolConfig"]:
        """Create a TokenizerPoolConfig from the given parameters.
1461

1462
        If tokenizer_pool_size is 0, return None.
1463

1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
        Args:
            tokenizer_pool_size: Number of tokenizer workers in the pool.
            tokenizer_pool_type: Type of the pool.
            tokenizer_pool_extra_config: Additional config for the pool.
                The way the config will be used depends on the
                pool type. This can be a JSON string (will be parsed).
        """
        if tokenizer_pool_size:
            if isinstance(tokenizer_pool_extra_config, str):
                tokenizer_pool_extra_config_parsed = json.loads(
                    tokenizer_pool_extra_config)
            else:
                tokenizer_pool_extra_config_parsed = (
                    tokenizer_pool_extra_config or {})
            tokenizer_pool_config = cls(tokenizer_pool_size,
                                        tokenizer_pool_type,
                                        tokenizer_pool_extra_config_parsed)
        else:
            tokenizer_pool_config = None
        return tokenizer_pool_config


1486
1487
1488
1489
1490
1491
1492
class LoadFormat(str, enum.Enum):
    AUTO = "auto"
    PT = "pt"
    SAFETENSORS = "safetensors"
    NPCACHE = "npcache"
    DUMMY = "dummy"
    TENSORIZER = "tensorizer"
1493
    SHARDED_STATE = "sharded_state"
1494
    GGUF = "gguf"
1495
    BITSANDBYTES = "bitsandbytes"
1496
    MISTRAL = "mistral"
1497
    RUNAI_STREAMER = "runai_streamer"
1498
    RUNAI_STREAMER_SHARDED = "runai_streamer_sharded"
1499
    FASTSAFETENSORS = "fastsafetensors"
1500
1501


1502
@config
1503
1504
@dataclass
class LoadConfig:
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
    """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."""
1530
    download_dir: Optional[str] = None
1531
1532
    """Directory to download and load the weights, default to the default
    cache directory of Hugging Face."""
1533
    model_loader_extra_config: dict = field(default_factory=dict)
1534
1535
1536
    """Extra config for model loader. This will be passed to the model loader
    corresponding to the chosen load_format. This should be a JSON string that
    will be parsed into a dictionary."""
1537
    ignore_patterns: Optional[Union[list[str], str]] = None
1538
1539
    """The list of patterns to ignore when loading the model. Default to
    "original/**/*" to avoid repeated loading of llama's checkpoints."""
1540
    use_tqdm_on_load: bool = True
1541
1542
    """Whether to enable tqdm for showing progress bar when loading model
    weights."""
1543

1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
    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.
1558
        factors: list[Any] = []
1559
1560
        hash_str = hashlib.md5(str(factors).encode(),
                               usedforsecurity=False).hexdigest()
1561
1562
        return hash_str

1563
    def __post_init__(self):
1564
1565
1566
        if isinstance(self.load_format, str):
            load_format = self.load_format.lower()
            self.load_format = LoadFormat(load_format)
1567

1568
1569
1570
1571
1572
1573
1574
        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/**/*"]

1575

1576
1577
1578
DistributedExecutorBackend = Literal["ray", "mp", "uni", "external_launcher"]


1579
@config
1580
@dataclass
1581
class ParallelConfig:
1582
    """Configuration for the distributed execution."""
1583

1584
1585
1586
1587
1588
1589
1590
1591
1592
    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."""
    data_parallel_rank: int = 0
    """Rank of the data parallel group."""
1593
    data_parallel_rank_local: Optional[int] = None
1594
    """Local rank of the data parallel group, defaults to global rank."""
1595
    data_parallel_master_ip: str = "127.0.0.1"
1596
1597
1598
1599
1600
    """IP of the data parallel master."""
    data_parallel_master_port: int = 29500
    """Port of the data parallel master."""
    enable_expert_parallel: bool = False
    """Use expert parallelism instead of tensor parallelism for MoE layers."""
1601

1602
    max_parallel_loading_workers: Optional[int] = None
1603
1604
1605
    """Maximum number of parallal loading workers when loading model
    sequentially in multiple batches. To avoid RAM OOM when using tensor
    parallel and large models."""
1606
1607

    disable_custom_all_reduce: bool = False
1608
    """Disable the custom all-reduce kernel and fall back to NCCL."""
1609
1610

    tokenizer_pool_config: Optional[TokenizerPoolConfig] = None
1611
1612
    """Config for the tokenizer pool. If None, will use synchronous
    tokenization."""
1613
1614

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

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

1620
    distributed_executor_backend: Optional[Union[DistributedExecutorBackend,
1621
                                                 type["ExecutorBase"]]] = None
1622
1623
1624
1625
1626
1627
1628
    """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
    and hpu only support Ray for distributed inference."""
1629
1630

    worker_cls: str = "auto"
1631
1632
    """The full name of the worker class to use. If "auto", the worker class
    will be determined based on the platform."""
1633
    sd_worker_cls: str = "auto"
1634
    """The full name of the worker class to use for speculative decofing.
1635
    If "auto", the worker class will be determined based on the platform."""
1636
    worker_extension_cls: str = ""
1637
1638
1639
1640
    """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."""
1641
1642

    world_size: int = field(init=False)
1643
    """world_size is TPxPP, it affects the number of workers we create."""
1644
    world_size_across_dp: int = field(init=False)
1645
1646
    """world_size_across_dp is TPxPPxDP, it is the size of the world
    including data parallelism."""
1647
1648

    rank: int = 0
1649
    """Global rank in distributed setup."""
1650

1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
    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":
        from vllm.distributed.utils import (
            stateless_init_torch_distributed_process_group)

        # use gloo since the engine process might not have cuda device
        dp_group = 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")

        return dp_group

    @staticmethod
    def has_unfinished_dp(dp_group: "ProcessGroup",
youkaichao's avatar
youkaichao committed
1680
                          has_unfinished: bool) -> bool:
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
        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

1692
1693
1694
1695
1696
1697
1698
1699
    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.
        """
1700
        factors: list[Any] = []
1701
1702
        factors.append(self.pipeline_parallel_size)
        factors.append(self.tensor_parallel_size)
1703
        factors.append(self.enable_expert_parallel)
1704
1705
        return hashlib.sha256(str(factors).encode()).hexdigest()

1706
1707
1708
    def __post_init__(self) -> None:
        self.world_size = self.pipeline_parallel_size * \
            self.tensor_parallel_size
1709

1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
        if self.data_parallel_size > 1:
            # Data parallel was specified in the engine args.
            self.data_parallel_master_port = get_open_port()
            # TODO multi-node
        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

1722
        self.world_size_across_dp = self.world_size * self.data_parallel_size
1723

1724
1725
1726
1727
1728
        if self.distributed_executor_backend == "external_launcher":
            import os
            os.environ["VLLM_ENABLE_V1_MULTIPROCESSING"] = "0"
            logger.info("Disabling V1 multiprocessing for external launcher.")

1729
        ray_only_devices: list[str] = []
1730
        from vllm.platforms import current_platform
1731
1732
        if (current_platform.device_type in ray_only_devices
                and self.world_size > 1):
1733
1734
1735
1736
            if self.distributed_executor_backend is None:
                self.distributed_executor_backend = "ray"
            if self.distributed_executor_backend != "ray":
                raise ValueError(
1737
1738
                    f"{current_platform.device_type.upper()} backend only "
                    "supports Ray for distributed inference.")
1739

1740
        if self.distributed_executor_backend is None and self.world_size > 1:
1741
1742
1743
            # We use multiprocessing by default if world_size fits on the
            # current node and we aren't in a ray placement group.

1744
            from vllm.executor import ray_utils
1745
            backend: DistributedExecutorBackend = "mp"
1746
            ray_found = ray_utils.ray_is_available()
1747
1748
1749
1750
1751
            if current_platform.is_neuron():
                # neuron uses single process to control multiple devices
                backend = "uni"
            elif (current_platform.is_cuda()
                  and cuda_device_count_stateless() < self.world_size):
1752
1753
                if not ray_found:
                    raise ValueError("Unable to load Ray which is "
1754
1755
1756
                                     "required for multi-node inference, "
                                     "please install Ray with `pip install "
                                     "ray`.") from ray_utils.ray_import_err
1757
1758
                backend = "ray"
            elif ray_found:
1759
                if self.placement_group:
1760
                    backend = "ray"
1761
1762
1763
1764
1765
1766
                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"
1767
1768
1769
            self.distributed_executor_backend = backend
            logger.info("Defaulting to use %s for distributed inference",
                        backend)
1770

1771
1772
1773
        if self.distributed_executor_backend is None and self.world_size == 1:
            self.distributed_executor_backend = "uni"

1774
1775
        self._verify_args()

1776
1777
1778
1779
1780
1781
    @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)

1782
    def _verify_args(self) -> None:
1783
1784
        # Lazy import to avoid circular import
        from vllm.executor.executor_base import ExecutorBase
1785
        from vllm.platforms import current_platform
1786
        if self.distributed_executor_backend not in (
1787
1788
                "ray", "mp", "uni",
                "external_launcher", None) and not (isinstance(
1789
1790
                    self.distributed_executor_backend, type) and issubclass(
                        self.distributed_executor_backend, ExecutorBase)):
1791
            raise ValueError(
1792
1793
                "Unrecognized distributed executor backend "
                f"{self.distributed_executor_backend}. Supported "
1794
1795
                "values are 'ray', 'mp' 'uni', 'external_launcher' or"
                " custom ExecutorBase subclass.")
1796
        if self.use_ray:
1797
1798
            from vllm.executor import ray_utils
            ray_utils.assert_ray_available()
1799
1800

        if not current_platform.use_custom_allreduce():
1801
1802
1803
            self.disable_custom_all_reduce = True
            logger.info(
                "Disabled the custom all-reduce kernel because it is not "
1804
                "supported on current platform.")
1805
        if self.ray_workers_use_nsight and not self.use_ray:
1806
1807
            raise ValueError("Unable to use nsight profiling unless workers "
                             "run with Ray.")
1808

1809
1810
1811
        assert isinstance(self.worker_extension_cls, str), (
            "worker_extension_cls must be a string (qualified class name).")

1812

1813
1814
1815
1816
SchedulerPolicy = Literal["fcfs", "priority"]


@config
1817
@dataclass
1818
class SchedulerConfig:
1819
    """Scheduler configuration."""
1820

1821
1822
    runner_type: RunnerType = "generate"
    """The runner type to launch for the model."""
1823

1824
1825
    max_num_batched_tokens: int = None  # type: ignore
    """Maximum number of tokens to be processed in a single iteration.
1826

1827
1828
    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."""
1829

1830
1831
    max_num_seqs: int = None  # type: ignore
    """Maximum number of sequences to be processed in a single iteration.
1832

1833
1834
    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."""
1835

1836
1837
1838
1839
    max_model_len: int = None  # type: ignore
    """Maximum length of a sequence (including prompt and generated text). This
    is primarily set in `ModelConfig` and that value should be manually
    duplicated here."""
1840

1841
    max_num_partial_prefills: int = 1
1842
1843
    """For chunked prefill, the maximum number of sequences that can be
    partially prefilled concurrently."""
1844
1845

    max_long_partial_prefills: int = 1
1846
1847
1848
1849
    """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."""
1850
1851

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

1855
    num_lookahead_slots: int = 0
1856
1857
1858
1859
1860
1861
1862
    """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."""
1863
1864

    delay_factor: float = 0.0
1865
1866
    """Apply a delay (of delay factor multiplied by previous
    prompt latency) before scheduling next prompt."""
1867

1868
1869
1870
    enable_chunked_prefill: bool = None  # type: ignore
    """If True, prefill requests can be chunked based
    on the remaining max_num_batched_tokens."""
1871
1872

    is_multimodal_model: bool = False
1873
1874
1875
1876
1877
    """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.
1878

1879
1880
1881
1882
1883
1884
1885
1886
1887
    NOTE: This is not currently configurable. It will be overridden by
    max_num_batched_tokens in case max multimodal embedding size is larger."""

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

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

1889
    preemption_mode: Optional[str] = None
1890
1891
1892
1893
1894
1895
    """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."""
1896
1897

    num_scheduler_steps: int = 1
1898
    """Maximum number of forward steps per scheduler call."""
1899

1900
1901
    multi_step_stream_outputs: bool = True
    """If False, then multi-step will stream outputs at the end of all steps"""
1902
1903

    send_delta_data: bool = False
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
    """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)."""
1915
1916

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

1919
    disable_chunked_mm_input: bool = False
1920
1921
1922
1923
1924
1925
    """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."""
1926

1927
    scheduler_cls: Union[str, type[object]] = "vllm.core.scheduler.Scheduler"
1928
1929
1930
    """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"."""
1931

1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
    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.
1946
        factors: list[Any] = []
1947
1948
        hash_str = hashlib.md5(str(factors).encode(),
                               usedforsecurity=False).hexdigest()
1949
1950
        return hash_str

1951
    def __post_init__(self) -> None:
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
        if self.max_model_len is None:
            self.max_model_len = 8192
            logger.warning(
                "max_model_len was is not set. Defaulting to arbitrary value "
                "of %d.", self.max_model_len)

        if self.max_num_seqs is None:
            self.max_num_seqs = 128
            logger.warning(
                "max_num_seqs was is not set. Defaulting to arbitrary value "
                "of %d.", self.max_num_seqs)

1964
1965
1966
        if self.max_num_batched_tokens is None:
            if self.enable_chunked_prefill:
                if self.num_scheduler_steps > 1:
1967
1968
1969
1970
                    # 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.
1971
1972
                    self.max_num_batched_tokens = max(
                        self.max_model_len, _DEFAULT_MAX_NUM_BATCHED_TOKENS)
1973
                else:
1974
1975
                    self.max_num_batched_tokens = (
                        _DEFAULT_MAX_NUM_BATCHED_TOKENS)
1976
            else:
1977
1978
                # If max_model_len is too short, use
                # _DEFAULT_MAX_NUM_BATCHED_TOKENS as the default value
1979
                # for higher throughput.
1980
1981
                self.max_num_batched_tokens = max(
                    self.max_model_len, _DEFAULT_MAX_NUM_BATCHED_TOKENS)
1982

1983
1984
            if self.runner_type == "pooling":
                # Choose specific value for higher throughput
1985
1986
                self.max_num_batched_tokens = max(
                    self.max_num_batched_tokens,
1987
                    _POOLING_MODEL_MAX_NUM_BATCHED_TOKENS,
1988
                )
1989
            if self.is_multimodal_model:
1990
                # The value needs to be at least the number of multimodal tokens
1991
1992
                self.max_num_batched_tokens = max(
                    self.max_num_batched_tokens,
1993
1994
1995
                    _MULTIMODAL_MODEL_MAX_NUM_BATCHED_TOKENS,
                )

1996
1997
1998
        self.max_num_encoder_input_tokens = self.max_num_batched_tokens
        self.encoder_cache_size = self.max_num_batched_tokens

1999
        if self.enable_chunked_prefill:
2000
2001
            logger.info(
                "Chunked prefill is enabled with max_num_batched_tokens=%d.",
2002
                self.max_num_batched_tokens)
2003

2004
        self.chunked_prefill_enabled = self.enable_chunked_prefill
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
        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)

2017
2018
2019
        self._verify_args()

    def _verify_args(self) -> None:
2020
2021
        if (self.max_num_batched_tokens < self.max_model_len
                and not self.chunked_prefill_enabled):
2022
2023
2024
2025
2026
2027
2028
            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.")
2029

2030
2031
2032
2033
2034
        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}).")
2035

2036
2037
2038
2039
2040
2041
        if self.num_lookahead_slots < 0:
            raise ValueError(
                "num_lookahead_slots "
                f"({self.num_lookahead_slots}) must be greater than or "
                "equal to 0.")

2042
2043
2044
2045
2046
2047
        if self.num_scheduler_steps < 1:
            raise ValueError(
                "num_scheduler_steps "
                f"({self.num_scheduler_steps}) must be greater than or "
                "equal to 1.")

2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
        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}).")

2071
2072
2073
2074
    @property
    def is_multi_step(self) -> bool:
        return self.num_scheduler_steps > 1

2075

2076
2077
2078
2079
2080
Device = Literal["auto", "cuda", "neuron", "cpu", "tpu", "xpu", "hpu"]


@config
@dataclass
2081
class DeviceConfig:
2082
2083
2084
2085
2086
2087
2088
    """Configuration for the device to use for vLLM execution."""

    device: Union[Device, torch.device] = "auto"
    """Device type for vLLM execution."""
    device_type: str = field(init=False)
    """Device type from the current platform. This is set in
    `__post_init__`."""
2089

2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
    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.
2105
        factors: list[Any] = []
2106
2107
        hash_str = hashlib.md5(str(factors).encode(),
                               usedforsecurity=False).hexdigest()
2108
2109
        return hash_str

2110
2111
    def __post_init__(self):
        if self.device == "auto":
2112
            # Automated device type detection
2113
            from vllm.platforms import current_platform
2114
            self.device_type = current_platform.device_type
2115
            if not self.device_type:
2116
2117
2118
2119
                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.")
2120
2121
        else:
            # Device type is assigned explicitly
2122
            self.device_type = self.device
2123
2124

        # Some device types require processing inputs on CPU
2125
        if self.device_type in ["neuron"]:
2126
            self.device = torch.device("cpu")
2127
2128
        elif self.device_type in ["tpu"]:
            self.device = None
2129
2130
2131
2132
        else:
            # Set device with device type
            self.device = torch.device(self.device_type)

2133

2134
2135
2136
2137
2138
2139
2140
SpeculativeMethod = Literal["ngram", "eagle", "medusa", "mlp_speculator",
                            "draft_model"]
SpeculativeAcceptanceMethod = Literal["rejection_sampler",
                                      "typical_acceptance_sampler"]


@config
2141
@dataclass
2142
class SpeculativeConfig:
2143
    """Configuration for speculative decoding."""
2144

2145
    # General speculative decoding control
2146
2147
    num_speculative_tokens: int = field(default=None,
                                        init=True)  # type: ignore
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
    """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."""
    acceptance_method: SpeculativeAcceptanceMethod = "rejection_sampler"
    """The method to use for accepting draft tokens:\n
    - "rejection_sampler" maps to `RejectionSampler`.\n
    - "typical_acceptance_sampler" maps to `TypicalAcceptanceSampler`.

    If using `typical_acceptance_sampler`, the related configuration
    `posterior_threshold` and `posterior_alpha` should be considered."""
2168
    draft_tensor_parallel_size: Optional[int] = None
2169
2170
    """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."""
2171
    disable_logprobs: bool = True
2172
2173
2174
    """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."""
2175

2176
    # Draft model configuration
2177
    quantization: Optional[str] = None
2178
2179
2180
    """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."""
2181
    max_model_len: Optional[int] = None
2182
2183
    """The maximum model length of the draft model. Used when testing the
    ability to skip speculation for some sequences."""
2184
    revision: Optional[str] = None
2185
2186
2187
    """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."""
2188
    code_revision: Optional[str] = None
2189
2190
2191
    """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."""
2192

2193
    # Advanced control
2194
    disable_mqa_scorer: bool = False
2195
2196
    """Disable the MQA scorer and fall back to batch expansion for scoring
    proposals."""
2197
    disable_by_batch_size: Optional[int] = None
2198
2199
2200
2201
    """Disable speculative decoding for new incoming requests when the number
    of enqueued requests is larger than this value, if provided."""

    # Ngram proposer configuration
2202
    prompt_lookup_max: Optional[int] = None
2203
2204
    """Maximum size of ngram token window when using Ngram proposer, required
    when method is set to ngram."""
2205
    prompt_lookup_min: Optional[int] = None
2206
2207
2208
2209
    """Minimum size of ngram token window when using Ngram proposer, if
    provided. Defaults to 1."""

    # Typical acceptance sampler configuration
2210
    posterior_threshold: Optional[float] = None
2211
2212
2213
2214
    """A threshold value that sets a lower bound on the posterior probability
    of a token in the target model for it to be accepted. This threshold is
    used only when we use the `TypicalAcceptanceSampler` for token acceptance.
    """
2215
    posterior_alpha: Optional[float] = None
2216
2217
    """Scaling factor for entropy-based threshold, applied when using
    `TypicalAcceptanceSampler`."""
2218
2219
2220
2221

    # required configuration params passed from engine
    target_model_config: ModelConfig = field(default=None,
                                             init=True)  # type: ignore
2222
    """The configuration of the target model."""
2223
2224
    target_parallel_config: ParallelConfig = field(default=None,
                                                   init=True)  # type: ignore
2225
    """The parallel configuration for the target model."""
2226
2227
    enable_chunked_prefill: bool = field(default=None,
                                         init=True)  # type: ignore
2228
2229
    """Whether vLLM is configured to use chunked prefill or not. Used for
    raising an error since it's not yet compatible with speculative decode."""
2230
    disable_log_stats: bool = field(default=None, init=True)  # type: ignore
2231
2232
    """Whether to disable the periodic printing of stage times in speculative
    decoding."""
2233
2234
2235
2236

    # params generated in the post-init stage
    draft_model_config: ModelConfig = field(default=None,
                                            init=True)  # type: ignore
2237
    """The configuration of the draft model initialized internal."""
2238
2239
    draft_parallel_config: ParallelConfig = field(default=None,
                                                  init=True)  # type: ignore
2240
    """The parallel configuration for the draft model initialized internal."""
2241

2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
    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.
        # spec decode does not use `torch.compile` yet.
2256
        factors: list[Any] = []
2257
2258
        hash_str = hashlib.md5(str(factors).encode(),
                               usedforsecurity=False).hexdigest()
2259
2260
        return hash_str

2261
2262
2263
2264
2265
    @classmethod
    def from_dict(cls, dict_value: dict) -> "SpeculativeConfig":
        """Parse the CLI value for the speculative config."""
        return cls(**dict_value)

2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
    @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"]
            })
        return hf_config

2278
    def __post_init__(self):
2279

2280
2281
2282
2283
2284
2285
2286
        # 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.
2287
2288
2289
2290

        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
2291
2292
            if self.target_model_config and \
                self.target_model_config.hf_text_config.model_type \
2293
                        == "deepseek_v3":
2294
2295
2296
2297
                # use the draft model from the same model:
                self.model = self.target_model_config.model
            elif self.method in ("ngram", "[ngram]"):
                self.model = "ngram"
2298
            else:
2299
2300
2301
                raise ValueError("num_speculative_tokens was provided without "
                                 "speculative model.")

2302
2303
        # Automatically configure the method for ngram when "model" is used
        # instead of "method"
2304
2305
2306
2307
2308
2309
2310
        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"
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
            # 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
2325
            if self.prompt_lookup_min < 1:
2326
2327
2328
2329
2330
                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")
2331
            if self.prompt_lookup_min > self.prompt_lookup_max:
2332
2333
2334
                raise ValueError(
                    f"prompt_lookup_min={self.prompt_lookup_min} must "
                    f"be <= prompt_lookup_max={self.prompt_lookup_max}")
2335

2336
2337
2338
            # 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.
2339
2340
            self.draft_model_config = self.target_model_config
            self.draft_parallel_config = self.target_parallel_config
2341
        else:
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
            self.prompt_lookup_max = 0
            self.prompt_lookup_min = 0

            if self.model is not None:
                self.draft_model_config = ModelConfig(
                    model=self.model,
                    task="draft",
                    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,
                    max_model_len=None,
                    spec_target_max_model_len=self.target_model_config.
                    max_model_len,
                    quantization=self.quantization,
                    enforce_eager=self.target_model_config.enforce_eager,
                    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,
                )
2371

2372
                # Automatically detect the method
2373
2374
2375
                if self.method == 'eagle':
                    pass
                elif "eagle-" in self.draft_model_config.model.lower():
2376
2377
2378
2379
2380
2381
                    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"
2382
                else:
2383
2384
2385
2386
                    self.method = "draft_model"

                # Replace hf_config for EAGLE draft_model
                if self.method == "eagle":
2387
                    if self.enable_chunked_prefill and not envs.VLLM_USE_V1:
2388
                        raise ValueError(
2389
2390
                            "Chunked prefill and EAGLE are not compatible "
                            "when using V0.")
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426

                    from vllm.transformers_utils.configs.eagle import (
                        EAGLEConfig)
                    if isinstance(self.draft_model_config.hf_config,
                                  EAGLEConfig):
                        pass
                    else:
                        eagle_config = EAGLEConfig(
                            self.draft_model_config.hf_config)
                        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

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

2428
2429
2430
2431
2432
2433
                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,
                    ))
2434

2435
2436
2437
2438
                self.draft_parallel_config = (
                    SpeculativeConfig.create_draft_parallel_config(
                        self.target_parallel_config,
                        self.draft_tensor_parallel_size))
2439

2440
2441
2442
2443
2444
        if self.acceptance_method == "typical_acceptance_sampler":
            if self.posterior_threshold is None:
                self.posterior_threshold = 0.09
            if self.posterior_alpha is None:
                self.posterior_alpha = 0.3
2445

2446
        self._verify_args()
2447

2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
    @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,
        )

2483
    @staticmethod
2484
    def _verify_and_get_draft_tp(
2485
2486
2487
2488
2489
2490
            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.
2491
        """
2492
2493
        # If speculative_draft_tensor_parallel_size is unset then set it
        # appropriately else verify that it is set correctly.
2494
        if speculative_draft_tensor_parallel_size is None:
2495
2496
2497
2498
            if draft_hf_config.model_type == "mlp_speculator":
                speculative_draft_tensor_parallel_size = 1
                if target_parallel_config.tensor_parallel_size > 1:
                    logger.warning(
2499
2500
2501
                        "%s cannot currently be run with tp>1; "
                        "setting speculative_draft_tensor_parallel_size=1",
                        draft_hf_config.model_type)
2502
2503
2504
            else:
                speculative_draft_tensor_parallel_size = \
                    target_parallel_config.tensor_parallel_size
2505
2506
        elif speculative_draft_tensor_parallel_size not in (
                1, target_parallel_config.tensor_parallel_size):
2507
            raise ValueError(
2508
                f"{speculative_draft_tensor_parallel_size=} cannot be "
2509
                f"other value than 1 or target model tensor_parallel_size")
2510
        return speculative_draft_tensor_parallel_size
2511

2512
2513
2514
2515
2516
2517
2518
2519
2520
    @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.
        """
2521
2522
2523
        draft_parallel_config = ParallelConfig(
            pipeline_parallel_size=target_parallel_config.
            pipeline_parallel_size,
2524
            tensor_parallel_size=speculative_draft_tensor_parallel_size,
2525
2526
            distributed_executor_backend=target_parallel_config.
            distributed_executor_backend,
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
            max_parallel_loading_workers=target_parallel_config.
            max_parallel_loading_workers,
            disable_custom_all_reduce=target_parallel_config.
            disable_custom_all_reduce,
            tokenizer_pool_config=target_parallel_config.tokenizer_pool_config,
            ray_workers_use_nsight=target_parallel_config.
            ray_workers_use_nsight,
            placement_group=target_parallel_config.placement_group,
        )

        return draft_parallel_config

    def _verify_args(self) -> None:
2540
2541
2542
2543
2544
2545
        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.")

2546
2547
2548
2549
2550
2551
2552
        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)
2553
2554
            # Validate and set draft token acceptance related settings.

2555
2556
        if self.acceptance_method is None:
            raise ValueError("acceptance_method is not set. "
2557
2558
2559
                             "Expected values are rejection_sampler or "
                             "typical_acceptance_sampler.")

2560
2561
        if (self.acceptance_method != 'rejection_sampler'
                and self.acceptance_method != 'typical_acceptance_sampler'):
2562
            raise ValueError(
2563
                "Expected acceptance_method to be either "
2564
                "rejection_sampler or typical_acceptance_sampler. Instead it "
2565
                f"is {self.acceptance_method}")
2566

2567
2568
2569
2570
        if self.acceptance_method == "typical_acceptance_sampler" and (
            (self.posterior_threshold is not None
             and self.posterior_threshold < 0) or
            (self.posterior_alpha is not None and self.posterior_alpha < 0)):
2571
            raise ValueError(
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
                "Expected the posterior_threshold and posterior_alpha of "
                "typical_acceptance_sampler to be > 0. "
                "Instead found posterior_threshold = "
                f"{self.posterior_threshold} and posterior_alpha = "
                f"{self.posterior_alpha}")

        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=}")
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594

    @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

    def __repr__(self) -> str:
2595
2596
        method = self.method
        model = None if method == "ngram" else self.draft_model_config.model
2597
        num_spec_tokens = self.num_speculative_tokens
2598
        return f"SpeculativeConfig({method=}, {model=}, {num_spec_tokens=})"
2599
2600


2601
2602
2603
2604
@dataclass
class LoRAConfig:
    max_lora_rank: int
    max_loras: int
2605
    fully_sharded_loras: bool = False
2606
    max_cpu_loras: Optional[int] = None
2607
    lora_dtype: Optional[Union[torch.dtype, str]] = None
2608
2609
2610
    lora_extra_vocab_size: int = 256
    # This is a constant.
    lora_vocab_padding_size: ClassVar[int] = 256
2611
    long_lora_scaling_factors: Optional[tuple[float]] = None
2612
    bias_enabled: bool = False
2613

2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
    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.
        """
2626
        factors: list[Any] = []
2627
2628
2629
2630
2631
2632
2633
        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)
        factors.append(self.long_lora_scaling_factors)
        factors.append(self.bias_enabled)
2634
2635
        hash_str = hashlib.md5(str(factors).encode(),
                               usedforsecurity=False).hexdigest()
2636
2637
        return hash_str

2638
    def __post_init__(self):
2639
        # Setting the maximum rank to 512 should be able to satisfy the vast
2640
        # majority of applications.
2641
        possible_max_ranks = (8, 16, 32, 64, 128, 256, 320, 512)
2642
        possible_lora_extra_vocab_size = (256, 512)
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
        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
2658
                f"max_loras ({self.max_loras})")
2659

2660
    def verify_with_cache_config(self, cache_config: CacheConfig):
2661
2662
2663
        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.")
2664

2665
2666
2667
2668
2669
2670
    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)

2671
2672
2673
2674
2675
    def verify_lora_support(self):
        if self.long_lora_scaling_factors is not None and envs.VLLM_USE_V1:
            raise ValueError(
                "V1 LoRA does not support long LoRA, please use V0.")

2676

2677
2678
2679
2680
2681
2682
2683
@dataclass
class PromptAdapterConfig:
    max_prompt_adapters: int
    max_prompt_adapter_token: int
    max_cpu_prompt_adapters: Optional[int] = None
    prompt_adapter_dtype: Optional[torch.dtype] = None

2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
    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.
2698
        factors: list[Any] = []
2699
2700
        hash_str = hashlib.md5(str(factors).encode(),
                               usedforsecurity=False).hexdigest()
2701
2702
        return hash_str

2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
    def __post_init__(self):

        if self.max_prompt_adapters < 1:
            raise ValueError(f"max_prompt_adapters "
                             f"({self.max_prompt_adapters}) must be >= 1.")
        if self.max_prompt_adapter_token == 0:
            raise ValueError("max_prompt_adapter_token must be set.")
        if self.max_cpu_prompt_adapters is None:
            self.max_cpu_prompt_adapters = self.max_prompt_adapters

    def verify_with_model_config(self, model_config: ModelConfig):
        if self.prompt_adapter_dtype in (None, "auto"):
            self.prompt_adapter_dtype = model_config.dtype
        elif isinstance(self.prompt_adapter_dtype, str):
            self.prompt_adapter_dtype = getattr(torch,
                                                self.prompt_adapter_dtype)


2721
@config
2722
@dataclass
2723
class MultiModalConfig:
2724
2725
    """Controls the behavior of multimodal models."""

2726
    limit_per_prompt: dict[str, int] = field(default_factory=dict)
2727
    """
2728
    The maximum number of input items allowed per prompt for each modality.
2729
2730
    This should be a JSON string that will be parsed into a dictionary.
    Defaults to 1 (V0) or 999 (V1) for each modality.
2731
2732
2733

    For example, to allow up to 16 images and 2 videos per prompt:
    ``{"images": 16, "videos": 2}``
2734
2735
    """

2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
    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.
2750
        factors: list[Any] = []
2751
2752
        hash_str = hashlib.md5(str(factors).encode(),
                               usedforsecurity=False).hexdigest()
2753
2754
        return hash_str

2755
2756
2757
2758
2759
    def get_limit_per_prompt(self, modality: str) -> int:
        """
        Get the maximum number of input items allowed per prompt
        for the given modality.
        """
2760
2761
2762
2763
        return self.limit_per_prompt.get(
            modality,
            999 if envs.VLLM_USE_V1 else 1,
        )
2764

2765
    # TODO: Add configs to init vision tower or not.
2766

2767

2768
@config
2769
2770
@dataclass
class PoolerConfig:
2771
    """Controls the behavior of output pooling in pooling models."""
2772
2773

    pooling_type: Optional[str] = None
2774
    """
2775
    The pooling method of the pooling model. This should be a key in
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
    :class:`vllm.model_executor.layers.pooler.PoolingType`.
    """

    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
    """
2793
    If set, only the score corresponding to the ``step_tag_id`` in the
2794
2795
2796
2797
    generated sentence should be returned. Otherwise, the scores for all tokens
    are returned.
    """

2798
    returned_token_ids: Optional[list[int]] = None
2799
    """
2800
2801
    A list of indices for the vocabulary dimensions to be extracted,
    such as the token IDs of ``good_token`` and ``bad_token`` in the
2802
2803
2804
    ``math-shepherd-mistral-7b-prm`` model.
    """

2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
    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.
2819
        factors: list[Any] = []
2820
2821
        hash_str = hashlib.md5(str(factors).encode(),
                               usedforsecurity=False).hexdigest()
2822
2823
        return hash_str

2824
2825
2826
    @staticmethod
    def from_json(json_str: str) -> "PoolerConfig":
        return PoolerConfig(**json.loads(json_str))
2827
2828


2829
2830
2831
2832
2833
2834
2835
2836
_STR_DTYPE_TO_TORCH_DTYPE = {
    "half": torch.float16,
    "float16": torch.float16,
    "float": torch.float32,
    "float32": torch.float32,
    "bfloat16": torch.bfloat16,
}

2837
_ROCM_NOT_SUPPORTED_DTYPE: list[str] = []  #
2838

2839
2840
2841

def _get_and_verify_dtype(
    config: PretrainedConfig,
2842
    dtype: Union[str, torch.dtype],
2843
2844
2845
2846
) -> torch.dtype:
    # NOTE: getattr(config, "torch_dtype", torch.float32) is not correct
    # because config.torch_dtype can be None.
    config_dtype = getattr(config, "torch_dtype", None)
2847
2848
2849
2850
2851
2852
2853
2854

    # Fallbacks for multi-modal models if the root config
    # does not define torch_dtype
    if config_dtype is None and hasattr(config, "text_config"):
        config_dtype = getattr(config.text_config, "torch_dtype", None)
    if config_dtype is None and hasattr(config, "vision_config"):
        config_dtype = getattr(config.vision_config, "torch_dtype", None)

2855
2856
2857
    if config_dtype is None:
        config_dtype = torch.float32

2858
2859
2860
2861
    if isinstance(dtype, str):
        dtype = dtype.lower()
        if dtype == "auto":
            if config_dtype == torch.float32:
2862
2863
                # Following common practice, we use float16 for float32 models
                torch_dtype = torch.float16
2864
2865
            else:
                torch_dtype = config_dtype
2866

Shinichi Hemmi's avatar
Shinichi Hemmi committed
2867
2868
2869
2870
2871
2872
2873
            if config.model_type == "plamo2":
                logger.info(
                    "For PLaMo2, we cast models to bfloat16 instead of using "
                    "float16 by default. This is because float16 does not work."
                )
                torch_dtype = torch.bfloat16

2874
            from vllm.platforms import current_platform
2875
2876
            if (current_platform.is_cpu()
                    and current_platform.get_cpu_architecture()
2877
                    == CpuArchEnum.POWERPC
2878
2879
2880
2881
2882
2883
2884
2885
                    and (config_dtype == torch.float16
                         or config_dtype == torch.float32)):
                logger.info(
                    "For POWERPC, we cast models to bfloat16 instead of "
                    "using float16 by default. Float16 is not currently "
                    "supported for POWERPC.")
                torch_dtype = torch.bfloat16

2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
            # TODO: change this condition to check if the platform support bf16
            # instead of checking the OS. For instance M2 shall supports bf16
            # already. But we need to modify `cpu_extension.cmake` to activate
            # the feature in the build.
            if (current_platform.is_cpu() and sys.platform.startswith("darwin")
                    and current_platform.get_cpu_architecture()
                    == CpuArchEnum.ARM and config_dtype == torch.bfloat16):
                logger.info("For macOS with Apple Silicon, currently bfloat16 "
                            "is not supported. Setting dtype to float16.")
                torch_dtype = torch.float16

2897
2898
            if current_platform.is_hpu() and config_dtype == torch.float16:
                logger.info(
2899
                    "For HPU, we cast models to bfloat16 instead of "
2900
2901
2902
                    "using float16 by default. Please specify `dtype` if you "
                    "want to use float16.")
                torch_dtype = torch.bfloat16
Shinichi Hemmi's avatar
Shinichi Hemmi committed
2903
2904
2905
2906
2907
        elif dtype == "float16" and config.model_type == "plamo2":
            logger.warning(
                "For PLaMo2, using float16 is unstable and might cause "
                "unexpected behavior. Please use bfloat16 or float32 instead.")
            torch_dtype = torch.float16
2908
        else:
2909
2910
2911
2912
2913
            if dtype not in _STR_DTYPE_TO_TORCH_DTYPE:
                raise ValueError(f"Unknown dtype: {dtype}")
            torch_dtype = _STR_DTYPE_TO_TORCH_DTYPE[dtype]
    elif isinstance(dtype, torch.dtype):
        torch_dtype = dtype
2914
    else:
2915
        raise ValueError(f"Unknown dtype: {dtype}")
2916
2917
2918
2919
2920

    # Verify the dtype.
    if torch_dtype != config_dtype:
        if torch_dtype == torch.float32:
            # Upcasting to float32 is allowed.
2921
            logger.info("Upcasting %s to %s.", config_dtype, torch_dtype)
2922
2923
2924
            pass
        elif config_dtype == torch.float32:
            # Downcasting from float32 to float16 or bfloat16 is allowed.
2925
            logger.info("Downcasting %s to %s.", config_dtype, torch_dtype)
2926
2927
            pass
        else:
Woosuk Kwon's avatar
Woosuk Kwon committed
2928
            # Casting between float16 and bfloat16 is allowed with a warning.
2929
            logger.warning("Casting %s to %s.", config_dtype, torch_dtype)
2930
2931

    return torch_dtype
2932
2933
2934
2935
2936


def _get_and_verify_max_len(
    hf_config: PretrainedConfig,
    max_model_len: Optional[int],
2937
    disable_sliding_window: bool,
2938
    sliding_window_len: Optional[Union[int, list[Optional[int]]]],
2939
    spec_target_max_model_len: Optional[int] = None,
2940
    encoder_config: Optional[Any] = None,
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
) -> 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",
2951
2952
        # ChatGLM2
        "seq_length",
2953
2954
        # Command-R
        "model_max_length",
2955
2956
        # Whisper
        "max_target_positions",
2957
2958
2959
2960
2961
        # Others
        "max_sequence_length",
        "max_seq_length",
        "seq_len",
    ]
2962
    # Choose the smallest "max_length" from the possible keys.
2963
    max_len_key = None
2964
    for key in possible_keys:
2965
2966
2967
2968
2969
        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
2970
2971
2972
2973
    # 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
2974
2975
2976
2977

    # 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:
2978
2979

        sliding_window_len_min = get_min_sliding_window(sliding_window_len)
2980
        max_len_key = "sliding_window" \
2981
2982
2983
            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)
2984
2985
2986

    # If none of the keys were found in the config, use a default and
    # log a warning.
2987
    if derived_max_model_len == float("inf"):
2988
2989
2990
2991
        if max_model_len is not None:
            # If max_model_len is specified, we use it.
            return max_model_len

2992
2993
2994
2995
2996
        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

2997
2998
2999
3000
        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: "
3001
            "%s. Assuming the model's maximum length is %d.", possible_keys,
3002
            default_max_len)
3003
        derived_max_model_len = default_max_len
3004

3005
    rope_scaling = getattr(hf_config, "rope_scaling", None)
3006
3007
3008
    # 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:
3009
3010
3011
        # No need to consider "type" key because of patch_rope_scaling when
        # loading HF config
        rope_type = rope_scaling["rope_type"]
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021

        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.")

3022
3023
3024
3025
            # 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)

3026
3027
3028
3029
            if rope_type == "yarn":
                derived_max_model_len = rope_scaling[
                    "original_max_position_embeddings"]
            derived_max_model_len *= scaling_factor
3030

3031
3032
3033
    if encoder_config and "max_seq_length" in encoder_config:
        derived_max_model_len = encoder_config["max_seq_length"]

3034
3035
    # If the user specified a max length, make sure it is smaller than the
    # derived length from the HF model config.
3036
    if max_model_len is None:
3037
        max_model_len = int(derived_max_model_len)
3038
    elif max_model_len > derived_max_model_len:
3039
3040
3041
3042
3043
        # 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:
3044
3045
3046
3047
3048
3049
3050
            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.")
3051
        else:
3052
            msg = (
3053
                f"User-specified max_model_len ({max_model_len}) is greater "
3054
3055
                f"than the derived max_model_len ({max_len_key}="
                f"{derived_max_model_len} or model_max_length="
3056
                f"{model_max_length} in model's config.json). This may lead "
3057
3058
3059
3060
3061
3062
3063
3064
3065
                "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")
3066
    return int(max_model_len)
3067
3068


3069
def get_min_sliding_window(
3070
        sliding_window: Union[int, list[Optional[int]]]) -> int:
3071
3072
3073
3074
3075
3076
    if isinstance(sliding_window, list):
        return min(s for s in sliding_window if s is not None)

    return sliding_window


3077
def get_served_model_name(model: str,
3078
                          served_model_name: Optional[Union[str, list[str]]]):
3079
    """
3080
3081
3082
3083
    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
3084
3085
3086
3087
3088
3089
3090
3091
3092
    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


3093
3094
3095
3096
3097
3098
GuidedDecodingBackendV0 = Literal["auto", "outlines", "lm-format-enforcer",
                                  "xgrammar"]
GuidedDecodingBackendV1 = Literal["auto", "xgrammar", "guidance"]


@config
3099
3100
@dataclass
class DecodingConfig:
3101
    """Dataclass which contains the decoding strategy of the engine."""
3102

3103
3104
3105
3106
3107
3108
3109
    guided_decoding_backend: Union[
        GuidedDecodingBackendV0,
        GuidedDecodingBackendV1] = "auto" if envs.VLLM_USE_V1 else "xgrammar"
    """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."""
3110

3111
    reasoning_backend: Optional[str] = None
3112
3113
3114
    """Select the reasoning parser depending on the model that you're using.
    This is used to parse the reasoning content into OpenAI API format.
    Required for `--enable-reasoning`."""
3115

3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
    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.
3130
        factors: list[Any] = []
3131
3132
        hash_str = hashlib.md5(str(factors).encode(),
                               usedforsecurity=False).hexdigest()
3133
3134
        return hash_str

3135
    def __post_init__(self):
3136
3137
        backend = GuidedDecodingParams(
            backend=self.guided_decoding_backend).backend_name
3138
        if envs.VLLM_USE_V1:
3139
            valid_guided_backends = get_args(GuidedDecodingBackendV1)
3140
        else:
3141
            valid_guided_backends = get_args(GuidedDecodingBackendV0)
3142
        if backend not in valid_guided_backends:
3143
            raise ValueError(f"Invalid guided_decoding_backend '{backend}',"
3144
                             f" must be one of {valid_guided_backends}")
3145
3146


3147
3148
@dataclass
class ObservabilityConfig:
3149
3150
3151
    """Configuration for observability - metrics and tracing."""
    show_hidden_metrics: bool = False

3152
3153
    otlp_traces_endpoint: Optional[str] = None

3154
3155
3156
3157
3158
3159
3160
3161
    # Collecting detailed timing information for each request can be expensive.

    # If set, collects the model forward time for the request.
    collect_model_forward_time: bool = False

    # If set, collects the model execute time for the request.
    collect_model_execute_time: bool = False

3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
    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.
3176
        factors: list[Any] = []
3177
3178
        hash_str = hashlib.md5(str(factors).encode(),
                               usedforsecurity=False).hexdigest()
3179
3180
        return hash_str

3181
    def __post_init__(self):
3182
3183
3184
3185
3186
        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}")
3187
3188


3189
3190
3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
class KVTransferConfig(BaseModel):
    """Configuration for distributed KV cache transfer."""

    # The KV connector for vLLM to transmit KV caches between vLLM instances.
    kv_connector: Optional[str] = None

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

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

    # Whether this vLLM instance produces, consumes KV cache, or both. Choices
    # are 'kv_producer', 'kv_consumer', and 'both'.
    kv_role: Optional[str] = None

    # 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.
    kv_rank: Optional[int] = None

    # The number of parallel instances for KV cache transfer. For
    # PyNcclConnector, this should be 2.
    kv_parallel_size: int = 1

    # The KV connector ip, used to build distributed connection
    kv_ip: str = "127.0.0.1"

    # The KV connector port, used to build distributed connection
    kv_port: int = 14579

3222
3223
3224
    # any extra config that the connector may need
    kv_connector_extra_config: dict[str, Any] = {}

3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
    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.
3239
        factors: list[Any] = []
3240
3241
        hash_str = hashlib.md5(str(factors).encode(),
                               usedforsecurity=False).hexdigest()
3242
3243
        return hash_str

3244
3245
    @classmethod
    def from_cli(cls, cli_value: str) -> "KVTransferConfig":
youkaichao's avatar
youkaichao committed
3246
        """Parse the CLI value for the kv cache transfer config."""
3247
3248
3249
3250
3251
3252
3253
3254
3255
3256
3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
        return KVTransferConfig.model_validate_json(cli_value)

    def model_post_init(self, __context: Any) -> None:

        if self.kv_role is not None and self.kv_role not in [
                "kv_producer", "kv_consumer", "kv_both"
        ]:
            raise ValueError(
                f"Unsupported kv_role: {self.kv_role}. "
                f"Supported roles are `kv_producer`, `kv_consumer`, "
                f"and `kv_both`")

        if self.kv_connector is not None and self.kv_role is None:
            raise ValueError("Please specify kv_disagg_role when kv_connector "
                             "is set, supported roles are `kv_producer`, "
                             "`kv_consumer`, and `kv_both`")

    @property
    def is_kv_transfer_instance(self) -> bool:
        return self.kv_connector is not None and \
            self.kv_role in ["kv_producer", "kv_consumer", "kv_both"]

    @property
    def is_kv_producer(self) -> bool:
        return self.kv_connector is not None and \
            self.kv_role in ["kv_producer", "kv_both"]

    @property
    def is_kv_consumer(self) -> bool:
        return self.kv_connector is not None and \
            self.kv_role in ["kv_consumer", "kv_both"]

3279
3280
3281
    def get_from_extra_config(self, key, default) -> Any:
        return self.kv_connector_extra_config.get(key, default)

3282

3283
3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
class CompilationLevel:
    # constants for the levels of the compilation process
    NO_COMPILATION = 0
    DYNAMO_AS_IS = 1
    DYNAMO_ONCE = 2
    PIECEWISE = 3


class CompilationConfig(BaseModel):
    """
    Configuration for compilation.
    It has three parts:
    - Top-level Compilation control:
        - level: the level of compilation.
            - 0: no compilation.
            - 1: dynamo as is.
            - 2: dynamo once.
            - 3: piecewise compilation.
3301
        - debug_dump_path: the path to dump the debug information.
3302
3303
3304
        - cache_dir: the directory to store the compiled graph, to
            accelerate Inductor compilation. By default, it will use
            model-related information to generate a cache directory.
3305
3306
3307
3308
3309
3310
3311
        - backend: 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).
3312
3313
3314
3315
3316
3317
3318
3319
3320
        - custom_ops: 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 disabled when running with Inductor (compile_level >= Inductor).
3321
        - splitting_ops: a list of ops to split the full graph into subgraphs, used in piecewise compilation.
3322
3323
3324
3325
    - CudaGraph capture:
        - use_cudagraph: whether to use cudagraph inside compilation.
            - False: cudagraph inside compilation is not used.
            - True: cudagraph inside compilation is used. It requires
3326
3327
3328
3329
                that all input buffers have fixed addresses, and all
                splitting ops write their outputs to input buffers.
            Note that this is orthogonal to the cudagraph capture logic
            outside of compilation.
3330
3331
3332
            TODO: move outside cudagraph logic into compilation.
            torch.compile will handle cudagraph capture logic in the future.
        - cudagraph_capture_sizes: sizes to capture cudagraph.
3333
            - None (default): capture sizes are inferred from vllm config.
3334
            - list[int]: capture sizes are specified as given.
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
        - cudagraph_num_of_warmups: 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.
        - cudagraph_copy_inputs: 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.
    - Inductor compilation:
        - use_inductor: whether to use inductor compilation.
            - False: inductor compilation is not used. graph runs in eager.
            - True: inductor compilation is used. one graph for symbolic shape
3348
3349
3350
3351
3352
                is compiled. In addition, compile for compile_sizes,
                using configurations in inductor_compile_config.
        - compile_sizes: sizes to compile for inductor. In addition
            to integers, it also supports "cudagraph_capture_sizes" to
            specify the sizes for cudagraph capture.
3353
3354
3355
3356
3357
3358
3359
        - inductor_compile_config: additional configurations for inductor.
            - None: use default configurations.
        - inductor_passes: 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})`
3360
        - custom inductor passes: see PassConfig for more details
3361

3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
    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.
    """ # noqa
    level: int = 0
3373
    debug_dump_path: str = ""
3374
    cache_dir: str = ""
3375
    backend: str = ""
3376
3377
    custom_ops: list[str] = Field(default_factory=list)
    splitting_ops: list[str] = Field(default=None)  # type: ignore
3378
3379

    use_inductor: bool = True
3380
3381
3382
    compile_sizes: Optional[list[Union[int, str]]] = Field(default=None)
    inductor_compile_config: dict = Field(default_factory=dict)
    inductor_passes: dict[str, str] = Field(default_factory=dict)
3383
3384
3385

    use_cudagraph: bool = False
    cudagraph_num_of_warmups: int = 0
3386
    cudagraph_capture_sizes: Optional[list[int]] = None
3387
3388
    cudagraph_copy_inputs: bool = False

3389
3390
3391
3392
3393
3394
3395
3396
3397
3398
    class PassConfig(BaseModel):
        """
        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.
        - dump_graph_stages: list of stages for which we want to dump the graph.
            Each pass defines its own stages (before, after, maybe in-between).
        - dump_graph_dir: directory to dump the graphs. Default is .
        - enable_fusion: whether to enable the custom fusion pass.
3399
3400
        - enable_noop: whether to enable the custom no-op elimination pass.
            TODO(luka) better pass enabling system.
3401
        """
3402
        dump_graph_stages: list[str] = Field(default_factory=list)
3403
3404
        dump_graph_dir: Path = Field(default=Path("."))
        enable_fusion: bool = True
3405
        enable_noop: bool = True
3406
3407
3408
3409
3410
3411
3412
3413

        def uuid(self):
            """
            Produces a hash unique to the pass configuration.
            Any new fields that affect compilation should be added to the hash.
            Do not include dump_graph_* in the hash - they don't affect
            compilation.
            """
3414
            dict_ = self.model_dump(include={"enable_fusion", "enable_noop"})
3415
            return InductorPass.hash_dict(dict_)
3416
3417

        def model_post_init(self, __context: Any) -> None:
3418
            if not self.enable_noop and self.enable_fusion:
3419
                logger.warning_once(
3420
                    "Fusion enabled but reshape elimination disabled. "
3421
3422
3423
                    "RMSNorm + quant (fp8) fusion might not work")

    pass_config: PassConfig = Field(default_factory=PassConfig)
3424
3425

    # not configurable, computed after init
3426
    max_capture_size: int = PrivateAttr
3427
    local_cache_dir: str = PrivateAttr  # local cache dir for each rank
3428
    # optimization:
3429
    # Intuitively, bs_to_padded_graph_size should be dict[int, int].
3430
    # since we know all keys are in a range [0, max_capture_size],
3431
3432
    # we can optimize it to list[int] for better lookup performance.
    bs_to_padded_graph_size: list[int] = PrivateAttr
3433

3434
3435
3436
    # keep track of enabled and disabled custom ops
    enabled_custom_ops: Counter[str] = PrivateAttr
    disabled_custom_ops: Counter[str] = PrivateAttr
3437
    traced_files: set[str] = PrivateAttr
3438
    compilation_time: float = PrivateAttr
3439

3440
3441
    # Per-model forward context
    # Map from layer name to the attention cls
3442
    static_forward_context: dict[str, Any] = PrivateAttr
3443

3444
3445
3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
    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.
        """
3456
        factors: list[Any] = []
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
        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()

3467
3468
3469
3470
3471
3472
3473
3474
    def __repr__(self) -> str:
        exclude = {
            "static_forward_context",
            "enabled_custom_ops",
            "disabled_custom_ops",
            "compilation_time",
            "bs_to_padded_graph_size",
            "pass_config",
3475
            "traced_files",
3476
3477
3478
3479
3480
        }
        return self.model_dump_json(exclude=exclude, exclude_unset=True)

    __str__ = __repr__

3481
3482
3483
3484
3485
    @classmethod
    def from_cli(cls, cli_value: str) -> "CompilationConfig":
        """Parse the CLI value for the compilation config."""
        if cli_value in ["0", "1", "2", "3"]:
            return cls(level=int(cli_value))
3486
3487
3488
        # do not use `eval`, it is dangerous and can execute arbitrary code
        dict_value = ast.literal_eval(cli_value)
        return CompilationConfig.model_validate(dict_value)
3489

3490
3491
3492
3493
3494
3495
    def model_post_init(self, __context: Any) -> None:

        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
3496
3497
3498
3499
3500
3501
3502
3503
        # 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

3504
        if is_torch_equal_or_newer("2.6"):
Michael Goin's avatar
Michael Goin committed
3505
3506
3507
3508
            KEY = 'enable_auto_functionalized_v2'
            if KEY not in self.inductor_compile_config:
                self.inductor_compile_config[KEY] = False

3509
        if self.splitting_ops is None:
3510
            self.splitting_ops = []
3511

3512
3513
3514
        for k, v in self.inductor_passes.items():
            if not isinstance(v, str):
                assert callable(v), (
3515
3516
3517
                    f"pass {k} should be callable or a qualified name")
                self.inductor_compile_config[k] = v if isinstance(
                    v, InductorPass) else CallableInductorPass(v)
3518
3519
3520
3521
3522
3523
3524
                continue

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

3528
3529
        self.enabled_custom_ops = Counter()
        self.disabled_custom_ops = Counter()
3530
        self.traced_files = set()
3531
        self.static_forward_context = {}
3532
        self.compilation_time = 0.0
3533

3534
    def init_backend(self, vllm_config: "VllmConfig") -> Union[str, Callable]:
3535
3536
3537
3538
3539
3540
3541
3542
3543
3544
3545
3546
3547
3548
3549
3550
3551
        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
3552

3553
        from vllm.compilation.backends import VllmBackend
3554
        return VllmBackend(vllm_config)
3555

3556
    def init_with_cudagraph_sizes(self,
3557
                                  cudagraph_capture_sizes: list[int]) -> None:
3558
        """To complete the initialization of config,
3559
3560
        we need to know the cudagraph sizes."""

3561
        if self.cudagraph_capture_sizes is None:
3562
            self.cudagraph_capture_sizes = cudagraph_capture_sizes
3563
        else:
3564
3565
3566
            # de-duplicate the sizes provided by the config
            self.cudagraph_capture_sizes = list(
                set(self.cudagraph_capture_sizes))
3567
3568
            logger.info(("cudagraph sizes specified by model runner"
                         " %s is overridden by config %s"),
3569
3570
3571
3572
3573
3574
3575
3576
3577
3578
3579
3580
3581
3582
3583
3584
                        cudagraph_capture_sizes, self.cudagraph_capture_sizes)

        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
3585

3586
        # sort to make sure cudagraph capture sizes are in descending order
3587
3588
3589
        self.cudagraph_capture_sizes.sort(reverse=True)
        self.max_capture_size = self.cudagraph_capture_sizes[
            0] if self.cudagraph_capture_sizes else 0
3590

3591
3592
3593
3594
        # 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)
        ]
3595
3596
        for end, start in zip(self.cudagraph_capture_sizes,
                              self.cudagraph_capture_sizes[1:] + [0]):
3597
3598
3599
3600
3601
3602
3603
            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
3604

3605
3606
3607
3608
3609
3610
3611
3612
3613
    def set_splitting_ops_for_v1(self):
        # If default, override splitting ops for piecewise cudagraph on V1.
        # NOTE: this function needs to be called
        if not self.splitting_ops:
            self.splitting_ops = [
                "vllm.unified_attention",
                "vllm.unified_attention_with_output",
            ]

3614

3615
3616
3617
@dataclass
class VllmConfig:
    """Dataclass which contains all vllm-related configuration. This
3618
3619
3620
    simplifies passing around the distinct configurations in the codebase.
    """

3621
3622
    model_config: ModelConfig = field(default=None, init=True)  # type: ignore
    cache_config: CacheConfig = field(default=None, init=True)  # type: ignore
3623
3624
3625
3626
    parallel_config: ParallelConfig = field(default_factory=ParallelConfig,
                                            init=True)
    scheduler_config: SchedulerConfig = field(default_factory=SchedulerConfig,
                                              init=True)
3627
3628
3629
    device_config: DeviceConfig = field(default=None,
                                        init=True)  # type: ignore
    load_config: LoadConfig = field(default=None, init=True)  # type: ignore
3630
    lora_config: Optional[LoRAConfig] = None
3631
3632
    speculative_config: SpeculativeConfig = field(default=None,
                                                  init=True)  # type: ignore
3633
3634
3635
    decoding_config: Optional[DecodingConfig] = None
    observability_config: Optional[ObservabilityConfig] = None
    prompt_adapter_config: Optional[PromptAdapterConfig] = None
3636
    quant_config: Optional[QuantizationConfig] = None
3637
3638
    compilation_config: CompilationConfig = field(default=None,
                                                  init=True)  # type: ignore
3639
3640
    kv_transfer_config: KVTransferConfig = field(default=None,
                                                 init=True)  # type: ignore
3641
    # some opaque config, only used to provide additional information
3642
3643
    # for the hash computation, mainly used for testing, debugging or out of
    # tree config registration.
3644
3645
    additional_config: SupportsHash = field(default=None,
                                            init=True)  # type: ignore
3646
    instance_id: str = ""
3647

3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
    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.
        """
3660
        factors: list[Any] = []
3661
3662

        # summarize vllm config
3663
        vllm_factors: list[Any] = []
3664
3665
        from vllm import __version__
        vllm_factors.append(__version__)
3666
        vllm_factors.append(envs.VLLM_USE_V1)
3667
3668
        if self.model_config:
            vllm_factors.append(self.model_config.compute_hash())
3669
3670
        else:
            vllm_factors.append("None")
3671
3672
        if self.cache_config:
            vllm_factors.append(self.cache_config.compute_hash())
3673
3674
        else:
            vllm_factors.append("None")
3675
3676
        if self.parallel_config:
            vllm_factors.append(self.parallel_config.compute_hash())
3677
3678
        else:
            vllm_factors.append("None")
3679
3680
        if self.scheduler_config:
            vllm_factors.append(self.scheduler_config.compute_hash())
3681
3682
        else:
            vllm_factors.append("None")
3683
3684
        if self.device_config:
            vllm_factors.append(self.device_config.compute_hash())
3685
3686
        else:
            vllm_factors.append("None")
3687
3688
        if self.load_config:
            vllm_factors.append(self.load_config.compute_hash())
3689
3690
        else:
            vllm_factors.append("None")
3691
3692
        if self.lora_config:
            vllm_factors.append(self.lora_config.compute_hash())
3693
3694
3695
3696
3697
            # 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))
3698
3699
        else:
            vllm_factors.append("None")
3700
3701
        if self.speculative_config:
            vllm_factors.append(self.speculative_config.compute_hash())
3702
3703
        else:
            vllm_factors.append("None")
3704
3705
        if self.decoding_config:
            vllm_factors.append(self.decoding_config.compute_hash())
3706
3707
        else:
            vllm_factors.append("None")
3708
3709
        if self.observability_config:
            vllm_factors.append(self.observability_config.compute_hash())
3710
3711
        else:
            vllm_factors.append("None")
3712
3713
        if self.prompt_adapter_config:
            vllm_factors.append(self.prompt_adapter_config.compute_hash())
3714
3715
        else:
            vllm_factors.append("None")
3716
3717
3718
3719
        if self.quant_config:
            pass  # should be captured by model_config.quantization
        if self.compilation_config:
            vllm_factors.append(self.compilation_config.compute_hash())
3720
3721
        else:
            vllm_factors.append("None")
3722
3723
        if self.kv_transfer_config:
            vllm_factors.append(self.kv_transfer_config.compute_hash())
3724
3725
3726
3727
3728
3729
        else:
            vllm_factors.append("None")
        if self.additional_config:
            vllm_factors.append(self.additional_config.compute_hash())
        else:
            vllm_factors.append("None")
3730
3731
        factors.append(vllm_factors)

3732
3733
        hash_str = hashlib.md5(str(factors).encode(),
                               usedforsecurity=False).hexdigest()[:10]
3734
3735
        return hash_str

3736
3737
3738
3739
3740
3741
    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]
3742

3743
3744
3745
3746
3747
    @staticmethod
    def _get_quantization_config(
            model_config: ModelConfig,
            load_config: LoadConfig) -> Optional[QuantizationConfig]:
        """Get the quantization config."""
3748
        from vllm.platforms import current_platform
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
3762
3763
3764
3765
3766
3767
3768
3769
3770
        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
3771

3772
3773
3774
3775
3776
3777
3778
3779
3780
    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

3781
3782
3783
3784
3785
        model_config = copy.deepcopy(self.model_config)
        model_config.hf_config = hf_config

        return replace(self, model_config=model_config)

3786
3787
3788
    def __post_init__(self):
        """Verify configs are valid & consistent with each other.
        """
3789
3790
3791
3792
3793
3794
3795
3796
        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)

        if self.cache_config is not None:
            self.cache_config.verify_with_parallel_config(self.parallel_config)
3797
3798

        if self.lora_config:
3799
            self.lora_config.verify_with_cache_config(self.cache_config)
3800
            self.lora_config.verify_with_model_config(self.model_config)
3801
            self.lora_config.verify_lora_support()
3802
3803
3804
        if self.prompt_adapter_config:
            self.prompt_adapter_config.verify_with_model_config(
                self.model_config)
3805
3806
3807
3808
3809

        if self.quant_config is None and \
            self.model_config is not None and self.load_config is not None:
            self.quant_config = VllmConfig._get_quantization_config(
                self.model_config, self.load_config)
3810

3811
        from vllm.platforms import current_platform
3812
3813
3814
3815
3816
        if self.scheduler_config is not None and \
            self.model_config is not None and \
            self.scheduler_config.chunked_prefill_enabled and \
            self.model_config.dtype == torch.float32 and \
            current_platform.get_device_capability() == (7, 5):
3817
            logger.warning_once(
3818
3819
3820
3821
                "Turing devices tensor cores do not support float32 matmul. "
                "To workaround this limitation, vLLM will set 'ieee' input "
                "precision for chunked prefill triton kernels.")

3822
        if self.compilation_config is None:
3823
            self.compilation_config = CompilationConfig()
3824
3825
        if envs.VLLM_USE_V1 and self.model_config is not None and \
            not self.model_config.enforce_eager:
3826
3827
3828
3829
            # NOTE(woosuk): Currently, we use inductor because the piecewise
            # CUDA graphs do not work properly with the custom CUDA kernels.
            # FIXME(woosuk): Disable inductor to reduce the compilation time
            # and avoid any potential issues with the inductor.
3830
            # FIXME(rob): Add function to set all of these.
3831
3832
3833
            self.compilation_config.custom_ops = ["none"]
            self.compilation_config.use_cudagraph = True
            self.compilation_config.use_inductor = True
3834
            self.compilation_config.cudagraph_num_of_warmups = 1
3835
            self.compilation_config.pass_config.enable_fusion = False
3836
            self.compilation_config.pass_config.enable_noop = False
3837
            self.compilation_config.level = CompilationLevel.PIECEWISE
3838
            self.compilation_config.set_splitting_ops_for_v1()
3839

3840
        self._set_cudagraph_sizes()
3841

3842
3843
        if self.cache_config is not None and \
            self.cache_config.cpu_offload_gb > 0 and \
3844
3845
            self.compilation_config.level != CompilationLevel.NO_COMPILATION \
                and not envs.VLLM_USE_V1:
3846
            logger.warning(
3847
                "CPU offload is not supported with `torch.compile` in v0 yet."
3848
3849
3850
                " Disabling `torch.compile`.")
            self.compilation_config.level = CompilationLevel.NO_COMPILATION

3851
3852
3853
3854
3855
3856
        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`.")
3857
3858
            self.compilation_config.level = CompilationLevel.NO_COMPILATION

3859

3860
        if self.model_config and self.model_config.use_mla and \
3861
            not (current_platform.is_cuda() or current_platform.is_rocm()):
3862
            logger.info(
3863
                "MLA is enabled on a non-GPU platform; forcing chunked "
3864
3865
3866
3867
3868
3869
3870
3871
3872
3873
                "prefill and prefix caching to be disabled.")
            self.scheduler_config.enable_chunked_prefill = False
            self.scheduler_config.chunked_prefill_enabled = False
            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

3874
3875
        current_platform.check_and_update_config(self)

3876
3877
3878
        if not self.instance_id:
            self.instance_id = random_uuid()[:5]

3879
3880
3881
3882
3883
3884
3885
3886
3887
3888
3889
3890
3891
3892
3893
3894
    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.

3895
3896
        In the end, `vllm_config.compilation_config.cudagraph_capture_sizes`
        will be the final sizes to capture cudagraph (in descending order).
3897
3898

        During runtime, if batchsize is larger than
3899
        `vllm_config.compilation_config.cudagraph_capture_sizes`,
3900
3901
        no cudagraph will be used.
        If the batch size is no larger than
3902
        `vllm_config.compilation_config.cudagraph_capture_sizes`,
3903
3904
3905
3906
3907
3908
3909
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
        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`.
        """

        # calculate the default `batch_size_capture_list`
        if not envs.VLLM_USE_V1:
            batch_size_capture_list = []
            max_batchsize_to_capture = 0
            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)]
                # 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:
                batch_size_capture_list = [1, 2, 4
                                           ] + [i for i in range(8, 513, 8)]
3939
3940
3941
3942
3943
                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
                ]
3944
3945
3946
3947

        self.compilation_config.init_with_cudagraph_sizes(
            batch_size_capture_list)

3948
    def __str__(self):
3949
3950
3951
3952
3953
3954
3955
3956
3957
3958
3959
3960
3961
3962
3963
3964
3965
3966
3967
3968
3969
3970
3971
3972
3973
3974
3975
3976
3977
3978
        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}, "
3979
            f"disable_mm_preprocessor_cache={self.model_config.disable_mm_preprocessor_cache!r}, "  # noqa
3980
            f"mm_processor_kwargs={self.model_config.mm_processor_kwargs}, "
3981
3982
            f"pooler_config={self.model_config.pooler_config!r}, "
            f"compilation_config={self.compilation_config!r}")
3983
3984
3985
3986
3987
3988


_current_vllm_config: Optional[VllmConfig] = None


@contextmanager
3989
def set_current_vllm_config(vllm_config: VllmConfig, check_compile=False):
3990
    """
3991
    Temporarily set the current vLLM config.
3992
    Used during model initialization.
3993
    We save the current vLLM config in a global variable,
3994
    so that all modules can access it, e.g. custom ops
3995
    can access the vLLM config to determine how to dispatch.
3996
3997
3998
3999
4000
4001
4002
4003
    """
    global _current_vllm_config
    old_vllm_config = _current_vllm_config
    from vllm.compilation.counter import compilation_counter
    num_models_seen = compilation_counter.num_models_seen
    try:
        _current_vllm_config = vllm_config
        yield
4004
4005
4006
    except Exception:
        raise
    else:
4007
4008
4009
4010
        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)
4011
4012
        if check_compile and \
            vllm_config.compilation_config.level == CompilationLevel.PIECEWISE \
4013
4014
4015
4016
4017
4018
4019
4020
4021
            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"
4022
                " if you want it to be supported.",
4023
                vllm_config.model_config.model)
4024
    finally:
4025
4026
4027
4028
4029
4030
4031
4032
        _current_vllm_config = old_vllm_config


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.
4033
        logger.warning("Current vLLM config is not set.")
4034
4035
4036
        from vllm.config import VllmConfig
        return VllmConfig()
    return _current_vllm_config
4037
4038
4039
4040
4041
4042
4043
4044
4045
4046
4047
4048
4049
4050
4051
4052
4053
4054
4055
4056
4057
4058
4059
4060
4061
4062
4063


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:
        bool: True if a match is found, False otherwise
    """
    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}")