registry.py 46.9 KB
Newer Older
1
# SPDX-License-Identifier: Apache-2.0
2
# SPDX-FileCopyrightText: Copyright contributors to the vLLM project
3
4
5
6
"""
Whenever you add an architecture to this page, please also update
`tests/models/registry.py` with example HuggingFace models for it.
"""
7

8
import importlib
9
import json
10
import os
11
import pickle
12
13
import subprocess
import sys
14
import tempfile
15
from abc import ABC, abstractmethod
16
from collections.abc import Callable, Set
17
from dataclasses import asdict, dataclass, field
18
from functools import lru_cache
19
from pathlib import Path
20
from typing import TYPE_CHECKING, Any, TypeVar
21
22

import torch.nn as nn
23
import transformers
24

25
from vllm import envs
26
27
28
29
30
from vllm.config import (
    ModelConfig,
    iter_architecture_defaults,
    try_match_architecture_defaults,
)
31
from vllm.logger import init_logger
32
from vllm.logging_utils import logtime
33
from vllm.transformers_utils.dynamic_module import try_get_class_from_dynamic_module
34
from vllm.utils.hashing import safe_hash
35

36
37
if TYPE_CHECKING:
    from vllm.config.model import AttnTypeStr
38
    from vllm.config.pooler import SequencePoolingType, TokenPoolingType
39
40
else:
    AttnTypeStr = Any
41
42
    SequencePoolingType = Any
    TokenPoolingType = Any
43
44


45
46
47
48
49
from .interfaces import (
    has_inner_state,
    has_noops,
    is_attention_free,
    is_hybrid,
Patrick von Platen's avatar
Patrick von Platen committed
50
    requires_raw_input_tokens,
51
    supports_cross_encoding,
52
    supports_mamba_prefix_caching,
53
54
55
56
57
58
59
    supports_multimodal,
    supports_multimodal_encoder_tp_data,
    supports_multimodal_raw_input_only,
    supports_pp,
    supports_transcription,
)
from .interfaces_base import (
60
    get_attn_type,
61
62
    get_default_seq_pooling_type,
    get_default_tok_pooling_type,
63
64
65
    is_pooling_model,
    is_text_generation_model,
)
66
67
68

logger = init_logger(__name__)

69
70
_TEXT_GENERATION_MODELS = {
    # [Decoder-only]
71
    "AfmoeForCausalLM": ("afmoe", "AfmoeForCausalLM"),
72
    "ApertusForCausalLM": ("apertus", "ApertusForCausalLM"),
73
74
    "AquilaModel": ("llama", "LlamaForCausalLM"),
    "AquilaForCausalLM": ("llama", "LlamaForCausalLM"),  # AquilaChat2
Raghav Ravishankar's avatar
Raghav Ravishankar committed
75
    "ArceeForCausalLM": ("arcee", "ArceeForCausalLM"),
76
    "ArcticForCausalLM": ("arctic", "ArcticForCausalLM"),
77
78
79
80
    # baichuan-7b, upper case 'C' in the class name
    "BaiChuanForCausalLM": ("baichuan", "BaiChuanForCausalLM"),
    # baichuan-13b, lower case 'c' in the class name
    "BaichuanForCausalLM": ("baichuan", "BaichuanForCausalLM"),
81
    "BailingMoeForCausalLM": ("bailing_moe", "BailingMoeForCausalLM"),
ant-yy's avatar
ant-yy committed
82
    "BailingMoeV2ForCausalLM": ("bailing_moe", "BailingMoeV2ForCausalLM"),
Yu Chin Fabian Lim's avatar
Yu Chin Fabian Lim committed
83
    "BambaForCausalLM": ("bamba", "BambaForCausalLM"),
84
    "BloomForCausalLM": ("bloom", "BloomForCausalLM"),
85
    "ChatGLMModel": ("chatglm", "ChatGLMForCausalLM"),
86
    "ChatGLMForConditionalGeneration": ("chatglm", "ChatGLMForCausalLM"),
87
    "CohereForCausalLM": ("commandr", "CohereForCausalLM"),
88
    "Cohere2ForCausalLM": ("commandr", "CohereForCausalLM"),
89
    "CwmForCausalLM": ("llama", "LlamaForCausalLM"),
90
    "DbrxForCausalLM": ("dbrx", "DbrxForCausalLM"),
91
    "DeciLMForCausalLM": ("nemotron_nas", "DeciLMForCausalLM"),
92
    "DeepseekForCausalLM": ("deepseek_v2", "DeepseekForCausalLM"),
93
    "DeepseekV2ForCausalLM": ("deepseek_v2", "DeepseekV2ForCausalLM"),
94
    "DeepseekV3ForCausalLM": ("deepseek_v2", "DeepseekV3ForCausalLM"),
95
    "DeepseekV32ForCausalLM": ("deepseek_v2", "DeepseekV3ForCausalLM"),
96
    "Dots1ForCausalLM": ("dots1", "Dots1ForCausalLM"),
97
    "Ernie4_5ForCausalLM": ("ernie45", "Ernie4_5ForCausalLM"),
98
    "Ernie4_5_MoeForCausalLM": ("ernie45_moe", "Ernie4_5_MoeForCausalLM"),
99
    "ExaoneForCausalLM": ("exaone", "ExaoneForCausalLM"),
100
    "Exaone4ForCausalLM": ("exaone4", "Exaone4ForCausalLM"),
101
    "Fairseq2LlamaForCausalLM": ("fairseq2_llama", "Fairseq2LlamaForCausalLM"),
102
103
104
    "FalconForCausalLM": ("falcon", "FalconForCausalLM"),
    "FalconMambaForCausalLM": ("mamba", "MambaForCausalLM"),
    "FalconH1ForCausalLM": ("falcon_h1", "FalconH1ForCausalLM"),
105
    "FlexOlmoForCausalLM": ("flex_olmo", "FlexOlmoForCausalLM"),
106
107
    "GemmaForCausalLM": ("gemma", "GemmaForCausalLM"),
    "Gemma2ForCausalLM": ("gemma2", "Gemma2ForCausalLM"),
108
    "Gemma3ForCausalLM": ("gemma3", "Gemma3ForCausalLM"),
Nicolò Lucchesi's avatar
Nicolò Lucchesi committed
109
    "Gemma3nForCausalLM": ("gemma3n", "Gemma3nForCausalLM"),
110
    "Qwen3NextForCausalLM": ("qwen3_next", "Qwen3NextForCausalLM"),
111
    "GlmForCausalLM": ("glm", "GlmForCausalLM"),
Yuxuan Zhang's avatar
Yuxuan Zhang committed
112
    "Glm4ForCausalLM": ("glm4", "Glm4ForCausalLM"),
Yuxuan Zhang's avatar
Yuxuan Zhang committed
113
    "Glm4MoeForCausalLM": ("glm4_moe", "Glm4MoeForCausalLM"),
114
    "GptOssForCausalLM": ("gpt_oss", "GptOssForCausalLM"),
115
116
117
118
119
120
    "GPT2LMHeadModel": ("gpt2", "GPT2LMHeadModel"),
    "GPTBigCodeForCausalLM": ("gpt_bigcode", "GPTBigCodeForCausalLM"),
    "GPTJForCausalLM": ("gpt_j", "GPTJForCausalLM"),
    "GPTNeoXForCausalLM": ("gpt_neox", "GPTNeoXForCausalLM"),
    "GraniteForCausalLM": ("granite", "GraniteForCausalLM"),
    "GraniteMoeForCausalLM": ("granitemoe", "GraniteMoeForCausalLM"),
121
122
    "GraniteMoeHybridForCausalLM": ("granitemoehybrid", "GraniteMoeHybridForCausalLM"),  # noqa: E501
    "GraniteMoeSharedForCausalLM": ("granitemoeshared", "GraniteMoeSharedForCausalLM"),  # noqa: E501
123
    "GritLM": ("gritlm", "GritLM"),
Bijaya Dangol's avatar
Bijaya Dangol committed
124
125
    "Grok1ModelForCausalLM": ("grok1", "GrokForCausalLM"),
    "Grok1ForCausalLM": ("grok1", "GrokForCausalLM"),
126
127
    "HunYuanMoEV1ForCausalLM": ("hunyuan_v1", "HunYuanMoEV1ForCausalLM"),
    "HunYuanDenseV1ForCausalLM": ("hunyuan_v1", "HunYuanDenseV1ForCausalLM"),
128
    "HCXVisionForCausalLM": ("hyperclovax_vision", "HCXVisionForCausalLM"),
129
130
    "InternLMForCausalLM": ("llama", "LlamaForCausalLM"),
    "InternLM2ForCausalLM": ("internlm2", "InternLM2ForCausalLM"),
131
    "InternLM2VEForCausalLM": ("internlm2_ve", "InternLM2VEForCausalLM"),
132
    "InternLM3ForCausalLM": ("llama", "LlamaForCausalLM"),
133
134
    "IQuestCoderForCausalLM": ("llama", "LlamaForCausalLM"),
    "IQuestLoopCoderForCausalLM": ("iquest_loopcoder", "IQuestLoopCoderForCausalLM"),
135
    "JAISLMHeadModel": ("jais", "JAISLMHeadModel"),
136
    "Jais2ForCausalLM": ("jais2", "Jais2ForCausalLM"),
137
    "JambaForCausalLM": ("jamba", "JambaForCausalLM"),
138
    "KimiLinearForCausalLM": ("kimi_linear", "KimiLinearForCausalLM"),  # noqa: E501
139
    "Lfm2ForCausalLM": ("lfm2", "Lfm2ForCausalLM"),
Paul Pak's avatar
Paul Pak committed
140
    "Lfm2MoeForCausalLM": ("lfm2_moe", "Lfm2MoeForCausalLM"),
141
    "LlamaForCausalLM": ("llama", "LlamaForCausalLM"),
142
    "Llama4ForCausalLM": ("llama4", "Llama4ForCausalLM"),
143
144
    # For decapoda-research/llama-*
    "LLaMAForCausalLM": ("llama", "LlamaForCausalLM"),
XuruiYang's avatar
XuruiYang committed
145
    "LongcatFlashForCausalLM": ("longcat_flash", "LongcatFlashForCausalLM"),
146
    "MambaForCausalLM": ("mamba", "MambaForCausalLM"),
147
    "Mamba2ForCausalLM": ("mamba2", "Mamba2ForCausalLM"),
148
149
    "MiniCPMForCausalLM": ("minicpm", "MiniCPMForCausalLM"),
    "MiniCPM3ForCausalLM": ("minicpm3", "MiniCPM3ForCausalLM"),
150
151
152
    "MiniMaxForCausalLM": ("minimax_text_01", "MiniMaxText01ForCausalLM"),
    "MiniMaxText01ForCausalLM": ("minimax_text_01", "MiniMaxText01ForCausalLM"),
    "MiniMaxM1ForCausalLM": ("minimax_text_01", "MiniMaxText01ForCausalLM"),
153
    "MiniMaxM2ForCausalLM": ("minimax_m2", "MiniMaxM2ForCausalLM"),
154
    "MistralForCausalLM": ("llama", "LlamaForCausalLM"),
155
    "MistralLarge3ForCausalLM": ("mistral_large_3", "MistralLarge3ForCausalLM"),
156
157
158
159
    "MixtralForCausalLM": ("mixtral", "MixtralForCausalLM"),
    # transformers's mpt class has lower case
    "MptForCausalLM": ("mpt", "MPTForCausalLM"),
    "MPTForCausalLM": ("mpt", "MPTForCausalLM"),
160
    "MiMoForCausalLM": ("mimo", "MiMoForCausalLM"),
161
    "MiMoV2FlashForCausalLM": ("mimo_v2_flash", "MiMoV2FlashForCausalLM"),
162
    "NemotronForCausalLM": ("nemotron", "NemotronForCausalLM"),
Luis Vega's avatar
Luis Vega committed
163
    "NemotronHForCausalLM": ("nemotron_h", "NemotronHForCausalLM"),
164
    "OlmoForCausalLM": ("olmo", "OlmoForCausalLM"),
165
    "Olmo2ForCausalLM": ("olmo2", "Olmo2ForCausalLM"),
166
    "Olmo3ForCausalLM": ("olmo2", "Olmo2ForCausalLM"),
167
168
169
    "OlmoeForCausalLM": ("olmoe", "OlmoeForCausalLM"),
    "OPTForCausalLM": ("opt", "OPTForCausalLM"),
    "OrionForCausalLM": ("orion", "OrionForCausalLM"),
170
    "OuroForCausalLM": ("ouro", "OuroForCausalLM"),
171
    "PanguEmbeddedForCausalLM": ("openpangu", "PanguEmbeddedForCausalLM"),
172
    "PanguProMoEV2ForCausalLM": ("openpangu", "PanguProMoEV2ForCausalLM"),
173
    "PanguUltraMoEForCausalLM": ("openpangu", "PanguUltraMoEForCausalLM"),
174
175
176
177
    "PersimmonForCausalLM": ("persimmon", "PersimmonForCausalLM"),
    "PhiForCausalLM": ("phi", "PhiForCausalLM"),
    "Phi3ForCausalLM": ("phi3", "Phi3ForCausalLM"),
    "PhiMoEForCausalLM": ("phimoe", "PhiMoEForCausalLM"),
Shinichi Hemmi's avatar
Shinichi Hemmi committed
178
    "Plamo2ForCausalLM": ("plamo2", "Plamo2ForCausalLM"),
179
    "Plamo3ForCausalLM": ("plamo3", "Plamo3ForCausalLM"),
180
    "QWenLMHeadModel": ("qwen", "QWenLMHeadModel"),
181
182
    "Qwen2ForCausalLM": ("qwen2", "Qwen2ForCausalLM"),
    "Qwen2MoeForCausalLM": ("qwen2_moe", "Qwen2MoeForCausalLM"),
183
184
    "Qwen3ForCausalLM": ("qwen3", "Qwen3ForCausalLM"),
    "Qwen3MoeForCausalLM": ("qwen3_moe", "Qwen3MoeForCausalLM"),
185
    "RWForCausalLM": ("falcon", "FalconForCausalLM"),
186
    "SeedOssForCausalLM": ("seed_oss", "SeedOssForCausalLM"),
Song's avatar
Song committed
187
    "Step3TextForCausalLM": ("step3_text", "Step3TextForCausalLM"),
188
189
190
191
    "StableLMEpochForCausalLM": ("stablelm", "StablelmForCausalLM"),
    "StableLmForCausalLM": ("stablelm", "StablelmForCausalLM"),
    "Starcoder2ForCausalLM": ("starcoder2", "Starcoder2ForCausalLM"),
    "SolarForCausalLM": ("solar", "SolarForCausalLM"),
192
    "TeleChatForCausalLM": ("telechat2", "TeleChat2ForCausalLM"),
193
    "TeleChat2ForCausalLM": ("telechat2", "TeleChat2ForCausalLM"),
194
    "TeleFLMForCausalLM": ("teleflm", "TeleFLMForCausalLM"),
195
    "XverseForCausalLM": ("llama", "LlamaForCausalLM"),
196
    "Zamba2ForCausalLM": ("zamba2", "Zamba2ForCausalLM"),
197
198
199
}

_EMBEDDING_MODELS = {
200
    # [Text-only]
201
    "BertModel": ("bert", "BertEmbeddingModel"),
202
    "BertSpladeSparseEmbeddingModel": ("bert", "BertSpladeSparseEmbeddingModel"),
203
    "DeciLMForCausalLM": ("nemotron_nas", "DeciLMForCausalLM"),
204
    "Gemma2Model": ("gemma2", "Gemma2ForCausalLM"),
205
    "Gemma3TextModel": ("gemma3", "Gemma3Model"),
206
    "GlmForCausalLM": ("glm", "GlmForCausalLM"),
207
    "GPT2ForSequenceClassification": ("gpt2", "GPT2ForSequenceClassification"),
208
    "GritLM": ("gritlm", "GritLM"),
209
210
    "GteModel": ("bert_with_rope", "SnowflakeGteNewModel"),
    "GteNewModel": ("bert_with_rope", "GteNewModel"),
211
    "InternLM2ForRewardModel": ("internlm2", "InternLM2ForRewardModel"),
212
    "JambaForSequenceClassification": ("jamba", "JambaForSequenceClassification"),  # noqa: E501
213
    "LlamaBidirectionalModel": ("llama", "LlamaBidirectionalModel"),
214
    "LlamaModel": ("llama", "LlamaForCausalLM"),
215
216
    **{
        # Multiple models share the same architecture, so we include them all
217
218
        k: (mod, arch)
        for k, (mod, arch) in _TEXT_GENERATION_MODELS.items()
219
220
        if arch == "LlamaForCausalLM"
    },
221
    "MistralModel": ("llama", "LlamaForCausalLM"),
222
    "ModernBertModel": ("modernbert", "ModernBertModel"),
223
    "NomicBertModel": ("bert_with_rope", "NomicBertModel"),
224
    "Phi3ForCausalLM": ("phi3", "Phi3ForCausalLM"),
225
    "Qwen2Model": ("qwen2", "Qwen2ForCausalLM"),
226
    "Qwen2ForCausalLM": ("qwen2", "Qwen2ForCausalLM"),
227
    "Qwen2ForRewardModel": ("qwen2_rm", "Qwen2ForRewardModel"),
228
    "Qwen2ForProcessRewardModel": ("qwen2_rm", "Qwen2ForProcessRewardModel"),
229
230
    "RobertaForMaskedLM": ("roberta", "RobertaEmbeddingModel"),
    "RobertaModel": ("roberta", "RobertaEmbeddingModel"),
231
    "TeleChatForCausalLM": ("telechat2", "TeleChat2ForCausalLM"),
232
    "TeleChat2ForCausalLM": ("telechat2", "TeleChat2ForCausalLM"),
233
    "XLMRobertaModel": ("roberta", "RobertaEmbeddingModel"),
234
    # [Multimodal]
235
    "CLIPModel": ("clip", "CLIPEmbeddingModel"),
236
237
238
    "LlavaNextForConditionalGeneration": (
        "llava_next",
        "LlavaNextForConditionalGeneration",
239
    ),
240
    "Phi3VForCausalLM": ("phi3v", "Phi3VForCausalLM"),
241
    "Qwen2VLForConditionalGeneration": ("qwen2_vl", "Qwen2VLForConditionalGeneration"),  # noqa: E501
242
    "SiglipModel": ("siglip", "SiglipEmbeddingModel"),
243
244
    # Technically Terratorch models work on images, both in
    # input and output. I am adding it here because it piggy-backs on embedding
245
    # models for the time being.
246
247
    "PrithviGeoSpatialMAE": ("terratorch", "Terratorch"),
    "Terratorch": ("terratorch", "Terratorch"),
248
249
}

250
251
_CROSS_ENCODER_MODELS = {
    "BertForSequenceClassification": ("bert", "BertForSequenceClassification"),
252
    "BertForTokenClassification": ("bert", "BertForTokenClassification"),
253
254
255
256
    "GteNewForSequenceClassification": (
        "bert_with_rope",
        "GteNewForSequenceClassification",
    ),
257
258
259
260
261
    "JinaVLForRanking": ("jina_vl", "JinaVLForSequenceClassification"),
    "LlamaBidirectionalForSequenceClassification": (
        "llama",
        "LlamaBidirectionalForSequenceClassification",
    ),
262
263
264
265
    "ModernBertForSequenceClassification": (
        "modernbert",
        "ModernBertForSequenceClassification",
    ),
266
267
268
269
    "ModernBertForTokenClassification": (
        "modernbert",
        "ModernBertForTokenClassification",
    ),
270
271
272
273
274
    "RobertaForSequenceClassification": ("roberta", "RobertaForSequenceClassification"),
    "XLMRobertaForSequenceClassification": (
        "roberta",
        "RobertaForSequenceClassification",
    ),
275
276
}

277
_MULTIMODAL_MODELS = {
278
    # [Decoder-only]
279
    "AriaForConditionalGeneration": ("aria", "AriaForConditionalGeneration"),
280
281
282
283
    "AudioFlamingo3ForConditionalGeneration": (
        "audioflamingo3",
        "AudioFlamingo3ForConditionalGeneration",
    ),
284
285
286
    "AyaVisionForConditionalGeneration": (
        "aya_vision",
        "AyaVisionForConditionalGeneration",
287
    ),
288
    "BagelForConditionalGeneration": ("bagel", "BagelForConditionalGeneration"),
289
    "BeeForConditionalGeneration": ("bee", "BeeForConditionalGeneration"),
290
    "Blip2ForConditionalGeneration": ("blip2", "Blip2ForConditionalGeneration"),
291
292
293
    "ChameleonForConditionalGeneration": (
        "chameleon",
        "ChameleonForConditionalGeneration",
294
    ),
295
296
297
    "Cohere2VisionForConditionalGeneration": (
        "cohere2_vision",
        "Cohere2VisionForConditionalGeneration",
298
    ),
299
    "DeepseekVLV2ForCausalLM": ("deepseek_vl2", "DeepseekVLV2ForCausalLM"),
300
    "DeepseekOCRForCausalLM": ("deepseek_ocr", "DeepseekOCRForCausalLM"),
Roger Wang's avatar
Roger Wang committed
301
    "DotsOCRForCausalLM": ("dots_ocr", "DotsOCRForCausalLM"),
302
303
304
    "Ernie4_5_VLMoeForConditionalGeneration": (
        "ernie45_vl",
        "Ernie4_5_VLMoeForConditionalGeneration",
305
    ),
306
    "FuyuForCausalLM": ("fuyu", "FuyuForCausalLM"),
307
    "Gemma3ForConditionalGeneration": ("gemma3_mm", "Gemma3ForConditionalGeneration"),  # noqa: E501
308
309
310
    "Gemma3nForConditionalGeneration": (
        "gemma3n_mm",
        "Gemma3nForConditionalGeneration",
311
    ),
312
    "GlmAsrForConditionalGeneration": ("glmasr", "GlmAsrForConditionalGeneration"),
313
    "GLM4VForCausalLM": ("glm4v", "GLM4VForCausalLM"),
314
    "Glm4vForConditionalGeneration": ("glm4_1v", "Glm4vForConditionalGeneration"),  # noqa: E501
Jee Jee Li's avatar
Jee Jee Li committed
315
    "Glm4vMoeForConditionalGeneration": ("glm4_1v", "Glm4vMoeForConditionalGeneration"),  # noqa: E501
316
317
318
    "GraniteSpeechForConditionalGeneration": (
        "granite_speech",
        "GraniteSpeechForConditionalGeneration",
319
    ),
320
    "H2OVLChatModel": ("h2ovl", "H2OVLChatModel"),
321
322
323
324
    "HunYuanVLForConditionalGeneration": (
        "hunyuan_vision",
        "HunYuanVLForConditionalGeneration",
    ),
325
    "InternVLChatModel": ("internvl", "InternVLChatModel"),
326
    "NemotronH_Nano_VL_V2": ("nano_nemotron_vl", "NemotronH_Nano_VL_V2"),
Zero's avatar
Zero committed
327
328
329
330
    "OpenCUAForConditionalGeneration": (
        "opencua",
        "OpenCUAForConditionalGeneration",
    ),
331
332
333
    "InternS1ForConditionalGeneration": (
        "interns1",
        "InternS1ForConditionalGeneration",
334
    ),
335
336
337
    "InternVLForConditionalGeneration": (
        "interns1",
        "InternS1ForConditionalGeneration",
338
    ),
339
340
341
342
    "Idefics3ForConditionalGeneration": (
        "idefics3",
        "Idefics3ForConditionalGeneration",
    ),
oscardev256's avatar
oscardev256 committed
343
    "IsaacForConditionalGeneration": ("isaac", "IsaacForConditionalGeneration"),
344
    "SmolVLMForConditionalGeneration": ("smolvlm", "SmolVLMForConditionalGeneration"),  # noqa: E501
345
    "KeyeForConditionalGeneration": ("keye", "KeyeForConditionalGeneration"),
346
347
348
    "KeyeVL1_5ForConditionalGeneration": (
        "keye_vl1_5",
        "KeyeVL1_5ForConditionalGeneration",
349
    ),
350
    "RForConditionalGeneration": ("rvl", "RForConditionalGeneration"),
351
    "KimiVLForConditionalGeneration": ("kimi_vl", "KimiVLForConditionalGeneration"),  # noqa: E501
352
353
354
355
    "LightOnOCRForConditionalGeneration": (
        "lightonocr",
        "LightOnOCRForConditionalGeneration",
    ),
356
    "Lfm2VlForConditionalGeneration": ("lfm2_vl", "Lfm2VLForConditionalGeneration"),
357
    "Llama_Nemotron_Nano_VL": ("nemotron_vl", "LlamaNemotronVLChatModel"),
358
    "Llama4ForConditionalGeneration": ("mllama4", "Llama4ForConditionalGeneration"),  # noqa: E501
359
    "LlavaForConditionalGeneration": ("llava", "LlavaForConditionalGeneration"),
360
361
362
    "LlavaNextForConditionalGeneration": (
        "llava_next",
        "LlavaNextForConditionalGeneration",
363
    ),
364
365
366
    "LlavaNextVideoForConditionalGeneration": (
        "llava_next_video",
        "LlavaNextVideoForConditionalGeneration",
367
    ),
368
369
370
    "LlavaOnevisionForConditionalGeneration": (
        "llava_onevision",
        "LlavaOnevisionForConditionalGeneration",
371
    ),
372
    "MantisForConditionalGeneration": ("llava", "MantisForConditionalGeneration"),  # noqa: E501
373
    "MiDashengLMModel": ("midashenglm", "MiDashengLMModel"),
374
375
376
    "MiniMaxVL01ForConditionalGeneration": (
        "minimax_vl_01",
        "MiniMaxVL01ForConditionalGeneration",
377
    ),
378
    "MiniCPMO": ("minicpmo", "MiniCPMO"),
379
    "MiniCPMV": ("minicpmv", "MiniCPMV"),
380
381
382
    "Mistral3ForConditionalGeneration": (
        "mistral3",
        "Mistral3ForConditionalGeneration",
383
    ),
384
    "MolmoForCausalLM": ("molmo", "MolmoForCausalLM"),
385
    "NVLM_D": ("nvlm_d", "NVLM_D_Model"),
386
    "Ovis": ("ovis", "Ovis"),
387
    "Ovis2_5": ("ovis2_5", "Ovis2_5"),
388
389
390
391
    "PaddleOCRVLForConditionalGeneration": (
        "paddleocr_vl",
        "PaddleOCRVLForConditionalGeneration",
    ),
392
393
394
395
    "PaliGemmaForConditionalGeneration": (
        "paligemma",
        "PaliGemmaForConditionalGeneration",
    ),
396
    "Phi3VForCausalLM": ("phi3v", "Phi3VForCausalLM"),
397
    "Phi4MMForCausalLM": ("phi4mm", "Phi4MMForCausalLM"),
398
    "PixtralForConditionalGeneration": ("pixtral", "PixtralForConditionalGeneration"),  # noqa: E501
399
    "QwenVLForConditionalGeneration": ("qwen_vl", "QwenVLForConditionalGeneration"),  # noqa: E501
400
    "Qwen2VLForConditionalGeneration": ("qwen2_vl", "Qwen2VLForConditionalGeneration"),  # noqa: E501
401
402
403
    "Qwen2_5_VLForConditionalGeneration": (
        "qwen2_5_vl",
        "Qwen2_5_VLForConditionalGeneration",
404
    ),
405
406
407
    "Qwen2AudioForConditionalGeneration": (
        "qwen2_audio",
        "Qwen2AudioForConditionalGeneration",
408
    ),
409
410
411
    "Qwen2_5OmniModel": (
        "qwen2_5_omni_thinker",
        "Qwen2_5OmniThinkerForConditionalGeneration",
412
    ),
413
414
415
    "Qwen2_5OmniForConditionalGeneration": (
        "qwen2_5_omni_thinker",
        "Qwen2_5OmniThinkerForConditionalGeneration",
416
    ),
417
418
419
420
    "Qwen3OmniMoeForConditionalGeneration": (
        "qwen3_omni_moe_thinker",
        "Qwen3OmniMoeThinkerForConditionalGeneration",
    ),
421
    "Qwen3VLForConditionalGeneration": ("qwen3_vl", "Qwen3VLForConditionalGeneration"),  # noqa: E501
422
423
424
    "Qwen3VLMoeForConditionalGeneration": (
        "qwen3_vl_moe",
        "Qwen3VLMoeForConditionalGeneration",
425
    ),
426
    "SkyworkR1VChatModel": ("skyworkr1v", "SkyworkR1VChatModel"),
Song's avatar
Song committed
427
    "Step3VLForConditionalGeneration": ("step3_vl", "Step3VLForConditionalGeneration"),  # noqa: E501
汪志鹏's avatar
汪志鹏 committed
428
    "TarsierForConditionalGeneration": ("tarsier", "TarsierForConditionalGeneration"),  # noqa: E501
429
430
431
    "Tarsier2ForConditionalGeneration": (
        "qwen2_vl",
        "Tarsier2ForConditionalGeneration",
432
    ),
433
    "UltravoxModel": ("ultravox", "UltravoxModel"),
Patrick von Platen's avatar
Patrick von Platen committed
434
    "VoxtralForConditionalGeneration": ("voxtral", "VoxtralForConditionalGeneration"),  # noqa: E501
Patrick von Platen's avatar
Patrick von Platen committed
435
    "VoxtralStreamingGeneration": ("voxtral_streaming", "VoxtralStreamingGeneration"),  # noqa: E501
436
    # [Encoder-decoder]
437
438
439
440
    "NemotronParseForConditionalGeneration": (
        "nemotron_parse",
        "NemotronParseForConditionalGeneration",
    ),
441
    "WhisperForConditionalGeneration": ("whisper", "WhisperForConditionalGeneration"),  # noqa: E501
442
}
443
444

_SPECULATIVE_DECODING_MODELS = {
445
    "MiMoMTPModel": ("mimo_mtp", "MiMoMTP"),
446
    "EagleLlamaForCausalLM": ("llama_eagle", "EagleLlamaForCausalLM"),
zhiweiz's avatar
zhiweiz committed
447
    "EagleLlama4ForCausalLM": ("llama4_eagle", "EagleLlama4ForCausalLM"),
448
    "EagleMiniCPMForCausalLM": ("minicpm_eagle", "EagleMiniCPMForCausalLM"),
449
    "Eagle3LlamaForCausalLM": ("llama_eagle3", "Eagle3LlamaForCausalLM"),
450
    "LlamaForCausalLMEagle3": ("llama_eagle3", "Eagle3LlamaForCausalLM"),
451
    "Eagle3Qwen2_5vlForCausalLM": ("llama_eagle3", "Eagle3LlamaForCausalLM"),
452
    "Eagle3Qwen3vlForCausalLM": ("llama_eagle3", "Eagle3LlamaForCausalLM"),
453
454
455
456
    "EagleMistralLarge3ForCausalLM": (
        "mistral_large_3_eagle",
        "EagleMistralLarge3ForCausalLM",
    ),
457
    "EagleDeepSeekMTPModel": ("deepseek_eagle", "EagleDeepseekV3ForCausalLM"),
458
    "DeepSeekMTPModel": ("deepseek_mtp", "DeepSeekMTP"),
459
    "ErnieMTPModel": ("ernie_mtp", "ErnieMTP"),
XuruiYang's avatar
XuruiYang committed
460
    "LongCatFlashMTPModel": ("longcat_flash_mtp", "LongCatFlashMTP"),
Yuxuan Zhang's avatar
Yuxuan Zhang committed
461
    "Glm4MoeMTPModel": ("glm4_moe_mtp", "Glm4MoeMTP"),
462
    "MedusaModel": ("medusa", "Medusa"),
463
    "OpenPanguMTPModel": ("openpangu_mtp", "OpenPanguMTP"),
464
    "Qwen3NextMTP": ("qwen3_next_mtp", "Qwen3NextMTP"),
465
466
467
    # Temporarily disabled.
    # # TODO(woosuk): Re-enable this once the MLP Speculator is supported in V1.
    # "MLPSpeculatorPreTrainedModel": ("mlp_speculator", "MLPSpeculator"),
468
}
469

470
_TRANSFORMERS_SUPPORTED_MODELS = {
471
472
473
    # Text generation models
    "SmolLM3ForCausalLM": ("transformers", "TransformersForCausalLM"),
    # Multimodal models
474
475
476
477
    "Emu3ForConditionalGeneration": (
        "transformers",
        "TransformersMultiModalForCausalLM",
    ),
478
479
480
}

_TRANSFORMERS_BACKEND_MODELS = {
481
    # Text generation models
482
    "TransformersForCausalLM": ("transformers", "TransformersForCausalLM"),
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
    "TransformersMoEForCausalLM": ("transformers", "TransformersMoEForCausalLM"),
    # Multimodal models
    "TransformersMultiModalForCausalLM": (
        "transformers",
        "TransformersMultiModalForCausalLM",
    ),
    "TransformersMultiModalMoEForCausalLM": (
        "transformers",
        "TransformersMultiModalMoEForCausalLM",
    ),
    # Embedding models
    "TransformersEmbeddingModel": ("transformers", "TransformersEmbeddingModel"),
    "TransformersMoEEmbeddingModel": ("transformers", "TransformersMoEEmbeddingModel"),
    "TransformersMultiModalEmbeddingModel": (
        "transformers",
        "TransformersMultiModalEmbeddingModel",
    ),
    # Sequence classification models
501
    "TransformersForSequenceClassification": (
502
        "transformers",
503
        "TransformersForSequenceClassification",
504
    ),
505
    "TransformersMoEForSequenceClassification": (
506
        "transformers",
507
        "TransformersMoEForSequenceClassification",
508
    ),
509
510
511
    "TransformersMultiModalForSequenceClassification": (
        "transformers",
        "TransformersMultiModalForSequenceClassification",
512
    ),
513
}
514

515
_VLLM_MODELS = {
516
    **_TEXT_GENERATION_MODELS,
517
    **_EMBEDDING_MODELS,
518
    **_CROSS_ENCODER_MODELS,
519
    **_MULTIMODAL_MODELS,
520
    **_SPECULATIVE_DECODING_MODELS,
521
522
    **_TRANSFORMERS_SUPPORTED_MODELS,
    **_TRANSFORMERS_BACKEND_MODELS,
523
524
}

525
526
527
528
# This variable is used as the args for subprocess.run(). We
# can modify  this variable to alter the args if needed. e.g.
# when we use par format to pack things together, sys.executable
# might not be the target we want to run.
529
_SUBPROCESS_COMMAND = [sys.executable, "-m", "vllm.model_executor.models.registry"]
530

531
_PREVIOUSLY_SUPPORTED_MODELS = {
532
    "MotifForCausalLM": "0.10.2",
533
    "Phi3SmallForCausalLM": "0.9.2",
534
    "Phi4FlashForCausalLM": "0.10.2",
535
    "Phi4MultimodalForCausalLM": "0.12.0",
536
537
538
539
540
541
542
543
544
    # encoder-decoder models except whisper
    # have been removed for V0 deprecation.
    "BartModel": "0.10.2",
    "BartForConditionalGeneration": "0.10.2",
    "DonutForConditionalGeneration": "0.10.2",
    "Florence2ForConditionalGeneration": "0.10.2",
    "MBartForConditionalGeneration": "0.10.2",
    "MllamaForConditionalGeneration": "0.10.2",
}
545

546

547
548
@dataclass(frozen=True)
class _ModelInfo:
549
    architecture: str
550
    is_text_generation_model: bool
551
    is_pooling_model: bool
552
    attn_type: AttnTypeStr
553
554
    default_seq_pooling_type: SequencePoolingType
    default_tok_pooling_type: TokenPoolingType
555
    supports_cross_encoding: bool
556
    supports_multimodal: bool
557
    supports_multimodal_raw_input_only: bool
Patrick von Platen's avatar
Patrick von Platen committed
558
    requires_raw_input_tokens: bool
559
    supports_multimodal_encoder_tp_data: bool
560
    supports_pp: bool
561
562
    has_inner_state: bool
    is_attention_free: bool
563
    is_hybrid: bool
564
    has_noops: bool
565
    supports_mamba_prefix_caching: bool
566
    supports_transcription: bool
567
    supports_transcription_only: bool
568
569

    @staticmethod
570
    def from_model_cls(model: type[nn.Module]) -> "_ModelInfo":
571
        return _ModelInfo(
572
            architecture=model.__name__,
573
            is_text_generation_model=is_text_generation_model(model),
574
            is_pooling_model=is_pooling_model(model),
575
576
            default_seq_pooling_type=get_default_seq_pooling_type(model),
            default_tok_pooling_type=get_default_tok_pooling_type(model),
577
            attn_type=get_attn_type(model),
578
            supports_cross_encoding=supports_cross_encoding(model),
579
            supports_multimodal=supports_multimodal(model),
580
581
582
            supports_multimodal_raw_input_only=supports_multimodal_raw_input_only(
                model
            ),
Patrick von Platen's avatar
Patrick von Platen committed
583
            requires_raw_input_tokens=requires_raw_input_tokens(model),
584
585
586
            supports_multimodal_encoder_tp_data=supports_multimodal_encoder_tp_data(
                model
            ),
587
            supports_pp=supports_pp(model),
588
589
            has_inner_state=has_inner_state(model),
            is_attention_free=is_attention_free(model),
590
            is_hybrid=is_hybrid(model),
591
            supports_mamba_prefix_caching=supports_mamba_prefix_caching(model),
592
            supports_transcription=supports_transcription(model),
593
594
595
            supports_transcription_only=(
                supports_transcription(model) and model.supports_transcription_only
            ),
596
            has_noops=has_noops(model),
597
        )
598
599


600
601
602
603
class _BaseRegisteredModel(ABC):
    @abstractmethod
    def inspect_model_cls(self) -> _ModelInfo:
        raise NotImplementedError
604

605
    @abstractmethod
606
    def load_model_cls(self) -> type[nn.Module]:
607
        raise NotImplementedError
608
609


610
611
612
613
614
615
616
@dataclass(frozen=True)
class _RegisteredModel(_BaseRegisteredModel):
    """
    Represents a model that has already been imported in the main process.
    """

    interfaces: _ModelInfo
617
    model_cls: type[nn.Module]
618
619

    @staticmethod
620
    def from_model_cls(model_cls: type[nn.Module]):
621
622
623
624
625
626
627
628
        return _RegisteredModel(
            interfaces=_ModelInfo.from_model_cls(model_cls),
            model_cls=model_cls,
        )

    def inspect_model_cls(self) -> _ModelInfo:
        return self.interfaces

629
    def load_model_cls(self) -> type[nn.Module]:
630
631
632
633
634
635
636
637
        return self.model_cls


@dataclass(frozen=True)
class _LazyRegisteredModel(_BaseRegisteredModel):
    """
    Represents a model that has not been imported in the main process.
    """
638

639
640
641
    module_name: str
    class_name: str

642
643
644
645
646
647
648
649
    @staticmethod
    def _get_cache_dir() -> Path:
        return Path(envs.VLLM_CACHE_ROOT) / "modelinfos"

    def _get_cache_filename(self) -> str:
        cls_name = f"{self.module_name}-{self.class_name}".replace(".", "-")
        return f"{cls_name}.json"

650
    def _load_modelinfo_from_cache(self, module_hash: str) -> _ModelInfo | None:
651
652
        try:
            try:
653
                modelinfo_path = self._get_cache_dir() / self._get_cache_filename()
654
655
656
                with open(modelinfo_path, encoding="utf-8") as file:
                    mi_dict = json.load(file)
            except FileNotFoundError:
657
                logger.debug(
658
                    "Cached model info file for class %s.%s not found",
659
660
661
                    self.module_name,
                    self.class_name,
                )
662
663
664
                return None

            if mi_dict["hash"] != module_hash:
665
                logger.debug(
666
                    "Cached model info file for class %s.%s is stale",
667
668
669
                    self.module_name,
                    self.class_name,
                )
670
671
672
673
674
                return None

            # file not changed, use cached _ModelInfo properties
            return _ModelInfo(**mi_dict["modelinfo"])
        except Exception:
675
            logger.debug(
676
                "Cached model info for class %s.%s error. ",
677
678
679
                self.module_name,
                self.class_name,
            )
680
681
            return None

682
    def _save_modelinfo_to_cache(self, mi: _ModelInfo, module_hash: str) -> None:
683
684
        """save dictionary json file to cache"""
        from vllm.model_executor.model_loader.weight_utils import atomic_writer
685

686
687
688
689
690
691
692
693
        try:
            modelinfo_dict = {
                "hash": module_hash,
                "modelinfo": asdict(mi),
            }
            cache_dir = self._get_cache_dir()
            cache_dir.mkdir(parents=True, exist_ok=True)
            modelinfo_path = cache_dir / self._get_cache_filename()
694
            with atomic_writer(modelinfo_path, encoding="utf-8") as f:
695
696
697
698
699
                json.dump(modelinfo_dict, f, indent=2)
        except Exception:
            logger.exception("Error saving model info cache.")

    @logtime(logger=logger, msg="Registry inspect model class")
700
    def inspect_model_cls(self) -> _ModelInfo:
701
        model_path = Path(__file__).parent / f"{self.module_name.split('.')[-1]}.py"
702
        module_hash = None
703

704
705
        if model_path.exists():
            with open(model_path, "rb") as f:
706
                module_hash = safe_hash(f.read(), usedforsecurity=False).hexdigest()
707
708
709

            mi = self._load_modelinfo_from_cache(module_hash)
            if mi is not None:
710
                logger.debug(
711
                    "Loaded model info for class %s.%s from cache",
712
713
714
                    self.module_name,
                    self.class_name,
                )
715
716
                return mi
            else:
717
                logger.debug(
718
                    "Cache model info for class %s.%s miss. Loading model instead.",
719
720
721
                    self.module_name,
                    self.class_name,
                )
722
723
724

        # Performed in another process to avoid initializing CUDA
        mi = _run_in_subprocess(
725
726
727
728
729
            lambda: _ModelInfo.from_model_cls(self.load_model_cls())
        )
        logger.debug(
            "Loaded model info for class %s.%s", self.module_name, self.class_name
        )
730
731

        # save cache file
732
733
        if module_hash is not None:
            self._save_modelinfo_to_cache(mi, module_hash)
734
735

        return mi
736

737
    def load_model_cls(self) -> type[nn.Module]:
738
739
740
741
742
743
744
745
        mod = importlib.import_module(self.module_name)
        return getattr(mod, self.class_name)


@lru_cache(maxsize=128)
def _try_load_model_cls(
    model_arch: str,
    model: _BaseRegisteredModel,
746
) -> type[nn.Module] | None:
747
    from vllm.platforms import current_platform
748

749
    current_platform.verify_model_arch(model_arch)
750
751
752
    try:
        return model.load_model_cls()
    except Exception:
753
        logger.exception("Error in loading model architecture '%s'", model_arch)
754
        return None
755
756


757
758
759
760
@lru_cache(maxsize=128)
def _try_inspect_model_cls(
    model_arch: str,
    model: _BaseRegisteredModel,
761
) -> _ModelInfo | None:
762
763
764
    try:
        return model.inspect_model_cls()
    except Exception:
765
        logger.exception("Error in inspecting model architecture '%s'", model_arch)
766
        return None
767
768


769
770
771
@dataclass
class _ModelRegistry:
    # Keyed by model_arch
772
    models: dict[str, _BaseRegisteredModel] = field(default_factory=dict)
773

774
    def get_supported_archs(self) -> Set[str]:
775
        return self.models.keys()
776

777
778
779
    def register_model(
        self,
        model_arch: str,
780
        model_cls: type[nn.Module] | str,
781
    ) -> None:
782
783
784
        """
        Register an external model to be used in vLLM.

785
        `model_cls` can be either:
786

787
        - A [`torch.nn.Module`][] class directly referencing the model.
788
        - A string in the format `<module>:<class>` which can be used to
789
790
          lazily import the model. This is useful to avoid initializing CUDA
          when importing the model and thus the related error
791
          `RuntimeError: Cannot re-initialize CUDA in forked subprocess`.
792
        """
793
794
795
796
        if not isinstance(model_arch, str):
            msg = f"`model_arch` should be a string, not a {type(model_arch)}"
            raise TypeError(msg)

797
        if model_arch in self.models:
798
799
            logger.warning(
                "Model architecture %s is already registered, and will be "
800
801
802
803
                "overwritten by the new model class %s.",
                model_arch,
                model_cls,
            )
804
805
806
807
808
809

        if isinstance(model_cls, str):
            split_str = model_cls.split(":")
            if len(split_str) != 2:
                msg = "Expected a string in the format `<module>:<class>`"
                raise ValueError(msg)
810

811
            model = _LazyRegisteredModel(*split_str)
812
        elif isinstance(model_cls, type) and issubclass(model_cls, nn.Module):
813
            model = _RegisteredModel.from_model_cls(model_cls)
814
        else:
815
816
817
818
            msg = (
                "`model_cls` should be a string or PyTorch model class, "
                f"not a {type(model_arch)}"
            )
819
            raise TypeError(msg)
820

821
        self.models[model_arch] = model
822

823
    def _raise_for_unsupported(self, architectures: list[str]):
824
        all_supported_archs = self.get_supported_archs()
825

826
827
828
        if any(arch in all_supported_archs for arch in architectures):
            raise ValueError(
                f"Model architectures {architectures} failed "
829
830
                "to be inspected. Please check the logs for more details."
            )
831

832
833
834
835
836
837
838
839
        for arch in architectures:
            if arch in _PREVIOUSLY_SUPPORTED_MODELS:
                previous_version = _PREVIOUSLY_SUPPORTED_MODELS[arch]

                raise ValueError(
                    f"Model architecture {arch} was supported in vLLM until "
                    f"v{previous_version}, and is not supported anymore. "
                    "Please use an older version of vLLM if you want to "
840
841
                    "use this model architecture."
                )
842

843
844
        raise ValueError(
            f"Model architectures {architectures} are not supported for now. "
845
846
            f"Supported architectures: {all_supported_archs}"
        )
847

848
    def _try_load_model_cls(self, model_arch: str) -> type[nn.Module] | None:
849
850
        if model_arch not in self.models:
            return None
851

852
        return _try_load_model_cls(model_arch, self.models[model_arch])
853

854
    def _try_inspect_model_cls(self, model_arch: str) -> _ModelInfo | None:
855
856
        if model_arch not in self.models:
            return None
857

858
859
860
861
862
863
        return _try_inspect_model_cls(model_arch, self.models[model_arch])

    def _try_resolve_transformers(
        self,
        architecture: str,
        model_config: ModelConfig,
864
    ) -> str | None:
865
866
867
        if architecture in _TRANSFORMERS_BACKEND_MODELS:
            return architecture

868
869
870
        auto_map: dict[str, str] = (
            getattr(model_config.hf_config, "auto_map", None) or dict()
        )
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903

        # Make sure that config class is always initialized before model class,
        # otherwise the model class won't be able to access the config class,
        # the expected auto_map should have correct order like:
        # "auto_map": {
        #     "AutoConfig": "<your-repo-name>--<config-name>",
        #     "AutoModel": "<your-repo-name>--<config-name>",
        #     "AutoModelFor<Task>": "<your-repo-name>--<config-name>",
        # },
        for prefix in ("AutoConfig", "AutoModel"):
            for name, module in auto_map.items():
                if name.startswith(prefix):
                    try_get_class_from_dynamic_module(
                        module,
                        model_config.model,
                        revision=model_config.revision,
                        warn_on_fail=False,
                    )

        model_module = getattr(transformers, architecture, None)

        if model_module is None:
            for name, module in auto_map.items():
                if name.startswith("AutoModel"):
                    model_module = try_get_class_from_dynamic_module(
                        module,
                        model_config.model,
                        revision=model_config.revision,
                        warn_on_fail=True,
                    )
                    if model_module is not None:
                        break
            else:
904
                if model_config.model_impl != "transformers":
905
906
907
908
909
910
911
                    return None

                raise ValueError(
                    f"Cannot find model module. {architecture!r} is not a "
                    "registered model in the Transformers library (only "
                    "relevant if the model is meant to be in Transformers) "
                    "and 'AutoModel' is not present in the model config's "
912
913
                    "'auto_map' (relevant if the model is custom)."
                )
914
915

        if not model_module.is_backend_compatible():
916
            if model_config.model_impl != "transformers":
917
                return None
918

919
920
            raise ValueError(
                f"The Transformers implementation of {architecture!r} "
921
922
                "is not compatible with vLLM."
            )
923

924
        return model_config._get_transformers_backend_cls()
925

926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
    def _normalize_arch(
        self,
        architecture: str,
        model_config: ModelConfig,
    ) -> str:
        if architecture in self.models:
            return architecture

        # This may be called in order to resolve runner_type and convert_type
        # in the first place, in which case we consider the default match
        match = try_match_architecture_defaults(
            architecture,
            runner_type=getattr(model_config, "runner_type", None),
            convert_type=getattr(model_config, "convert_type", None),
        )
        if match:
            suffix, _ = match

            # Get the name of the base model to convert
            for repl_suffix, _ in iter_architecture_defaults():
                base_arch = architecture.replace(suffix, repl_suffix)
                if base_arch in self.models:
                    return base_arch

        return architecture
951

952
953
    def inspect_model_cls(
        self,
954
        architectures: str | list[str],
955
        model_config: ModelConfig,
956
    ) -> tuple[_ModelInfo, str]:
957
958
        if isinstance(architectures, str):
            architectures = [architectures]
959
960
        if not architectures:
            raise ValueError("No model architectures are specified")
961
962

        # Require transformers impl
963
        if model_config.model_impl == "transformers":
964
            arch = self._try_resolve_transformers(architectures[0], model_config)
965
966
967
968
            if arch is not None:
                model_info = self._try_inspect_model_cls(arch)
                if model_info is not None:
                    return (model_info, arch)
969
        elif model_config.model_impl == "terratorch":
970
971
            model_info = self._try_inspect_model_cls("Terratorch")
            return (model_info, "Terratorch")
972

973
        # Fallback to transformers impl (after resolving convert_type)
974
975
976
977
978
979
        if (
            all(arch not in self.models for arch in architectures)
            and model_config.model_impl == "auto"
            and getattr(model_config, "convert_type", "none") == "none"
        ):
            arch = self._try_resolve_transformers(architectures[0], model_config)
980
981
982
983
984
985
986
            if arch is not None:
                model_info = self._try_inspect_model_cls(arch)
                if model_info is not None:
                    return (model_info, arch)

        for arch in architectures:
            normalized_arch = self._normalize_arch(arch, model_config)
987
            model_info = self._try_inspect_model_cls(normalized_arch)
988
            if model_info is not None:
989
                return (model_info, arch)
990

991
        # Fallback to transformers impl (before resolving runner_type)
992
993
994
995
996
        if (
            all(arch not in self.models for arch in architectures)
            and model_config.model_impl == "auto"
        ):
            arch = self._try_resolve_transformers(architectures[0], model_config)
997
998
999
1000
1001
            if arch is not None:
                model_info = self._try_inspect_model_cls(arch)
                if model_info is not None:
                    return (model_info, arch)

1002
        return self._raise_for_unsupported(architectures)
1003

1004
1005
    def resolve_model_cls(
        self,
1006
        architectures: str | list[str],
1007
        model_config: ModelConfig,
1008
    ) -> tuple[type[nn.Module], str]:
1009
1010
        if isinstance(architectures, str):
            architectures = [architectures]
1011
1012
        if not architectures:
            raise ValueError("No model architectures are specified")
1013
1014

        # Require transformers impl
1015
        if model_config.model_impl == "transformers":
1016
            arch = self._try_resolve_transformers(architectures[0], model_config)
1017
1018
1019
1020
            if arch is not None:
                model_cls = self._try_load_model_cls(arch)
                if model_cls is not None:
                    return (model_cls, arch)
1021
        elif model_config.model_impl == "terratorch":
1022
1023
1024
1025
            arch = "Terratorch"
            model_cls = self._try_load_model_cls(arch)
            if model_cls is not None:
                return (model_cls, arch)
1026

1027
        # Fallback to transformers impl (after resolving convert_type)
1028
1029
1030
1031
1032
1033
        if (
            all(arch not in self.models for arch in architectures)
            and model_config.model_impl == "auto"
            and getattr(model_config, "convert_type", "none") == "none"
        ):
            arch = self._try_resolve_transformers(architectures[0], model_config)
1034
1035
1036
1037
1038
1039
1040
            if arch is not None:
                model_cls = self._try_load_model_cls(arch)
                if model_cls is not None:
                    return (model_cls, arch)

        for arch in architectures:
            normalized_arch = self._normalize_arch(arch, model_config)
1041
            model_cls = self._try_load_model_cls(normalized_arch)
1042
1043
            if model_cls is not None:
                return (model_cls, arch)
1044

1045
        # Fallback to transformers impl (before resolving runner_type)
1046
1047
1048
1049
1050
        if (
            all(arch not in self.models for arch in architectures)
            and model_config.model_impl == "auto"
        ):
            arch = self._try_resolve_transformers(architectures[0], model_config)
1051
1052
1053
1054
1055
            if arch is not None:
                model_cls = self._try_load_model_cls(arch)
                if model_cls is not None:
                    return (model_cls, arch)

1056
        return self._raise_for_unsupported(architectures)
1057

1058
1059
    def is_text_generation_model(
        self,
1060
        architectures: str | list[str],
1061
        model_config: ModelConfig,
1062
    ) -> bool:
1063
        model_cls, _ = self.inspect_model_cls(architectures, model_config)
1064
        return model_cls.is_text_generation_model
1065

1066
    def is_pooling_model(
1067
        self,
1068
        architectures: str | list[str],
1069
        model_config: ModelConfig,
1070
    ) -> bool:
1071
        model_cls, _ = self.inspect_model_cls(architectures, model_config)
1072
        return model_cls.is_pooling_model
1073

1074
1075
    def is_cross_encoder_model(
        self,
1076
        architectures: str | list[str],
1077
        model_config: ModelConfig,
1078
    ) -> bool:
1079
        model_cls, _ = self.inspect_model_cls(architectures, model_config)
1080
        return model_cls.supports_cross_encoding
1081

1082
1083
    def is_multimodal_model(
        self,
1084
        architectures: str | list[str],
1085
        model_config: ModelConfig,
1086
    ) -> bool:
1087
        model_cls, _ = self.inspect_model_cls(architectures, model_config)
1088
        return model_cls.supports_multimodal
1089

1090
    def is_multimodal_raw_input_only_model(
1091
        self,
1092
        architectures: str | list[str],
1093
        model_config: ModelConfig,
1094
    ) -> bool:
1095
        model_cls, _ = self.inspect_model_cls(architectures, model_config)
1096
        return model_cls.supports_multimodal_raw_input_only
1097

1098
1099
    def is_pp_supported_model(
        self,
1100
        architectures: str | list[str],
1101
        model_config: ModelConfig,
1102
    ) -> bool:
1103
        model_cls, _ = self.inspect_model_cls(architectures, model_config)
1104
        return model_cls.supports_pp
1105

1106
1107
    def model_has_inner_state(
        self,
1108
        architectures: str | list[str],
1109
        model_config: ModelConfig,
1110
    ) -> bool:
1111
        model_cls, _ = self.inspect_model_cls(architectures, model_config)
1112
        return model_cls.has_inner_state
1113

1114
1115
    def is_attention_free_model(
        self,
1116
        architectures: str | list[str],
1117
        model_config: ModelConfig,
1118
    ) -> bool:
1119
        model_cls, _ = self.inspect_model_cls(architectures, model_config)
1120
        return model_cls.is_attention_free
1121

1122
1123
    def is_hybrid_model(
        self,
1124
        architectures: str | list[str],
1125
        model_config: ModelConfig,
1126
    ) -> bool:
1127
        model_cls, _ = self.inspect_model_cls(architectures, model_config)
1128
1129
        return model_cls.is_hybrid

1130
1131
    def is_noops_model(
        self,
1132
        architectures: str | list[str],
1133
        model_config: ModelConfig,
1134
    ) -> bool:
1135
        model_cls, _ = self.inspect_model_cls(architectures, model_config)
1136
1137
        return model_cls.has_noops

1138
1139
    def is_transcription_model(
        self,
1140
        architectures: str | list[str],
1141
        model_config: ModelConfig,
1142
    ) -> bool:
1143
        model_cls, _ = self.inspect_model_cls(architectures, model_config)
1144
1145
        return model_cls.supports_transcription

1146
1147
    def is_transcription_only_model(
        self,
1148
        architectures: str | list[str],
1149
        model_config: ModelConfig,
1150
    ) -> bool:
1151
        model_cls, _ = self.inspect_model_cls(architectures, model_config)
1152
1153
        return model_cls.supports_transcription_only

1154

1155
1156
1157
1158
1159
1160
1161
1162
1163
ModelRegistry = _ModelRegistry(
    {
        model_arch: _LazyRegisteredModel(
            module_name=f"vllm.model_executor.models.{mod_relname}",
            class_name=cls_name,
        )
        for model_arch, (mod_relname, cls_name) in _VLLM_MODELS.items()
    }
)
1164
1165
1166
1167
1168

_T = TypeVar("_T")


def _run_in_subprocess(fn: Callable[[], _T]) -> _T:
1169
1170
1171
1172
1173
    # NOTE: We use a temporary directory instead of a temporary file to avoid
    # issues like https://stackoverflow.com/questions/23212435/permission-denied-to-write-to-my-temporary-file
    with tempfile.TemporaryDirectory() as tempdir:
        output_filepath = os.path.join(tempdir, "registry_output.tmp")

1174
        # `cloudpickle` allows pickling lambda functions directly
1175
        import cloudpickle
1176

1177
        input_bytes = cloudpickle.dumps((fn, output_filepath))
1178
1179
1180

        # cannot use `sys.executable __file__` here because the script
        # contains relative imports
1181
1182
1183
        returned = subprocess.run(
            _SUBPROCESS_COMMAND, input=input_bytes, capture_output=True
        )
1184
1185
1186
1187
1188
1189

        # check if the subprocess is successful
        try:
            returned.check_returncode()
        except Exception as e:
            # wrap raised exception to provide more information
1190
1191
1192
            raise RuntimeError(
                f"Error raised in subprocess:\n{returned.stderr.decode()}"
            ) from e
1193

1194
        with open(output_filepath, "rb") as f:
1195
1196
1197
1198
1199
1200
            return pickle.load(f)


def _run() -> None:
    # Setup plugins
    from vllm.plugins import load_general_plugins
1201

1202
1203
1204
1205
1206
    load_general_plugins()

    fn, output_file = pickle.loads(sys.stdin.buffer.read())

    result = fn()
1207
1208
1209

    with open(output_file, "wb") as f:
        f.write(pickle.dumps(result))
1210
1211
1212


if __name__ == "__main__":
1213
    _run()