registry.py 49.2 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_late_interaction,
53
    supports_mamba_prefix_caching,
54
55
56
57
58
59
60
    supports_multimodal,
    supports_multimodal_encoder_tp_data,
    supports_multimodal_raw_input_only,
    supports_pp,
    supports_transcription,
)
from .interfaces_base import (
61
    get_attn_type,
62
63
    get_default_seq_pooling_type,
    get_default_tok_pooling_type,
64
65
66
    is_pooling_model,
    is_text_generation_model,
)
67
68
69

logger = init_logger(__name__)

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

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

262
263
_CROSS_ENCODER_MODELS = {
    "BertForSequenceClassification": ("bert", "BertForSequenceClassification"),
264
    "BertForTokenClassification": ("bert", "BertForTokenClassification"),
265
266
267
268
    "GteNewForSequenceClassification": (
        "bert_with_rope",
        "GteNewForSequenceClassification",
    ),
269
270
271
272
273
    "JinaVLForRanking": ("jina_vl", "JinaVLForSequenceClassification"),
    "LlamaBidirectionalForSequenceClassification": (
        "llama",
        "LlamaBidirectionalForSequenceClassification",
    ),
274
275
276
277
    "ModernBertForSequenceClassification": (
        "modernbert",
        "ModernBertForSequenceClassification",
    ),
278
279
280
281
    "ModernBertForTokenClassification": (
        "modernbert",
        "ModernBertForTokenClassification",
    ),
282
283
284
285
286
    "RobertaForSequenceClassification": ("roberta", "RobertaForSequenceClassification"),
    "XLMRobertaForSequenceClassification": (
        "roberta",
        "RobertaForSequenceClassification",
    ),
287
288
}

289
_MULTIMODAL_MODELS = {
290
    # [Decoder-only]
291
    "AriaForConditionalGeneration": ("aria", "AriaForConditionalGeneration"),
292
293
294
295
    "AudioFlamingo3ForConditionalGeneration": (
        "audioflamingo3",
        "AudioFlamingo3ForConditionalGeneration",
    ),
296
297
298
299
    "MusicFlamingoForConditionalGeneration": (
        "musicflamingo",
        "MusicFlamingoForConditionalGeneration",
    ),
300
301
302
    "AyaVisionForConditionalGeneration": (
        "aya_vision",
        "AyaVisionForConditionalGeneration",
303
    ),
304
    "BagelForConditionalGeneration": ("bagel", "BagelForConditionalGeneration"),
305
    "BeeForConditionalGeneration": ("bee", "BeeForConditionalGeneration"),
306
    "Blip2ForConditionalGeneration": ("blip2", "Blip2ForConditionalGeneration"),
307
308
309
    "ChameleonForConditionalGeneration": (
        "chameleon",
        "ChameleonForConditionalGeneration",
310
    ),
311
312
313
    "Cohere2VisionForConditionalGeneration": (
        "cohere2_vision",
        "Cohere2VisionForConditionalGeneration",
314
    ),
315
    "DeepseekVLV2ForCausalLM": ("deepseek_vl2", "DeepseekVLV2ForCausalLM"),
316
    "DeepseekOCRForCausalLM": ("deepseek_ocr", "DeepseekOCRForCausalLM"),
RED's avatar
RED committed
317
    "DeepseekOCR2ForCausalLM": ("deepseek_ocr2", "DeepseekOCR2ForCausalLM"),
Roger Wang's avatar
Roger Wang committed
318
    "DotsOCRForCausalLM": ("dots_ocr", "DotsOCRForCausalLM"),
319
320
321
322
    "Eagle2_5_VLForConditionalGeneration": (
        "eagle2_5_vl",
        "Eagle2_5_VLForConditionalGeneration",
    ),
323
324
325
    "Ernie4_5_VLMoeForConditionalGeneration": (
        "ernie45_vl",
        "Ernie4_5_VLMoeForConditionalGeneration",
326
    ),
327
328
329
330
    "FunAudioChatForConditionalGeneration": (
        "funaudiochat",
        "FunAudioChatForConditionalGeneration",
    ),
331
    "FuyuForCausalLM": ("fuyu", "FuyuForCausalLM"),
332
    "Gemma3ForConditionalGeneration": ("gemma3_mm", "Gemma3ForConditionalGeneration"),  # noqa: E501
333
334
335
    "Gemma3nForConditionalGeneration": (
        "gemma3n_mm",
        "Gemma3nForConditionalGeneration",
336
    ),
337
    "GlmAsrForConditionalGeneration": ("glmasr", "GlmAsrForConditionalGeneration"),
338
    "GLM4VForCausalLM": ("glm4v", "GLM4VForCausalLM"),
339
340
341
    "Glm4vForConditionalGeneration": ("glm4_1v", "Glm4vForConditionalGeneration"),
    "Glm4vMoeForConditionalGeneration": ("glm4_1v", "Glm4vMoeForConditionalGeneration"),
    "GlmOcrForConditionalGeneration": ("glm_ocr", "GlmOcrForConditionalGeneration"),  # noqa: E501
342
343
344
    "GraniteSpeechForConditionalGeneration": (
        "granite_speech",
        "GraniteSpeechForConditionalGeneration",
345
    ),
346
    "H2OVLChatModel": ("h2ovl", "H2OVLChatModel"),
347
348
349
350
    "HunYuanVLForConditionalGeneration": (
        "hunyuan_vision",
        "HunYuanVLForConditionalGeneration",
    ),
ltd0924's avatar
ltd0924 committed
351
    "StepVLForConditionalGeneration": ("step_vl", "StepVLForConditionalGeneration"),
352
    "InternVLChatModel": ("internvl", "InternVLChatModel"),
353
    "NemotronH_Nano_VL_V2": ("nano_nemotron_vl", "NemotronH_Nano_VL_V2"),
Zero's avatar
Zero committed
354
355
356
357
    "OpenCUAForConditionalGeneration": (
        "opencua",
        "OpenCUAForConditionalGeneration",
    ),
358
359
360
    "InternS1ForConditionalGeneration": (
        "interns1",
        "InternS1ForConditionalGeneration",
361
    ),
362
363
364
    "InternVLForConditionalGeneration": (
        "interns1",
        "InternS1ForConditionalGeneration",
365
    ),
zxy's avatar
zxy committed
366
367
368
369
    "InternS1ProForConditionalGeneration": (
        "interns1_pro",
        "InternS1ProForConditionalGeneration",
    ),
370
371
372
373
    "Idefics3ForConditionalGeneration": (
        "idefics3",
        "Idefics3ForConditionalGeneration",
    ),
oscardev256's avatar
oscardev256 committed
374
    "IsaacForConditionalGeneration": ("isaac", "IsaacForConditionalGeneration"),
375
    "SmolVLMForConditionalGeneration": ("smolvlm", "SmolVLMForConditionalGeneration"),  # noqa: E501
376
    "KananaVForConditionalGeneration": ("kanana_v", "KananaVForConditionalGeneration"),
377
    "KeyeForConditionalGeneration": ("keye", "KeyeForConditionalGeneration"),
378
379
380
    "KeyeVL1_5ForConditionalGeneration": (
        "keye_vl1_5",
        "KeyeVL1_5ForConditionalGeneration",
381
    ),
382
    "RForConditionalGeneration": ("rvl", "RForConditionalGeneration"),
383
    "KimiVLForConditionalGeneration": ("kimi_vl", "KimiVLForConditionalGeneration"),  # noqa: E501
Roger Wang's avatar
Roger Wang committed
384
    "KimiK25ForConditionalGeneration": ("kimi_k25", "KimiK25ForConditionalGeneration"),  # noqa: E501
385
386
387
388
    "LightOnOCRForConditionalGeneration": (
        "lightonocr",
        "LightOnOCRForConditionalGeneration",
    ),
389
    "Lfm2VlForConditionalGeneration": ("lfm2_vl", "Lfm2VLForConditionalGeneration"),
390
    "Llama_Nemotron_Nano_VL": ("nemotron_vl", "LlamaNemotronVLChatModel"),
391
    "Llama4ForConditionalGeneration": ("mllama4", "Llama4ForConditionalGeneration"),  # noqa: E501
392
    "LlavaForConditionalGeneration": ("llava", "LlavaForConditionalGeneration"),
393
394
395
    "LlavaNextForConditionalGeneration": (
        "llava_next",
        "LlavaNextForConditionalGeneration",
396
    ),
397
398
399
    "LlavaNextVideoForConditionalGeneration": (
        "llava_next_video",
        "LlavaNextVideoForConditionalGeneration",
400
    ),
401
402
403
    "LlavaOnevisionForConditionalGeneration": (
        "llava_onevision",
        "LlavaOnevisionForConditionalGeneration",
404
    ),
405
    "MantisForConditionalGeneration": ("llava", "MantisForConditionalGeneration"),  # noqa: E501
406
    "MiDashengLMModel": ("midashenglm", "MiDashengLMModel"),
407
408
409
    "MiniMaxVL01ForConditionalGeneration": (
        "minimax_vl_01",
        "MiniMaxVL01ForConditionalGeneration",
410
    ),
411
    "MiniCPMO": ("minicpmo", "MiniCPMO"),
412
    "MiniCPMV": ("minicpmv", "MiniCPMV"),
413
414
415
    "Mistral3ForConditionalGeneration": (
        "mistral3",
        "Mistral3ForConditionalGeneration",
416
    ),
417
    "MolmoForCausalLM": ("molmo", "MolmoForCausalLM"),
418
    "Molmo2ForConditionalGeneration": ("molmo2", "Molmo2ForConditionalGeneration"),
419
    "NVLM_D": ("nvlm_d", "NVLM_D_Model"),
420
421
422
423
    "OpenPanguVLForConditionalGeneration": (
        "openpangu_vl",
        "OpenPanguVLForConditionalGeneration",
    ),
424
    "Ovis": ("ovis", "Ovis"),
425
    "Ovis2_5": ("ovis2_5", "Ovis2_5"),
426
427
428
429
    "PaddleOCRVLForConditionalGeneration": (
        "paddleocr_vl",
        "PaddleOCRVLForConditionalGeneration",
    ),
430
431
432
433
    "PaliGemmaForConditionalGeneration": (
        "paligemma",
        "PaliGemmaForConditionalGeneration",
    ),
434
    "Phi3VForCausalLM": ("phi3v", "Phi3VForCausalLM"),
435
    "Phi4MMForCausalLM": ("phi4mm", "Phi4MMForCausalLM"),
436
    "PixtralForConditionalGeneration": ("pixtral", "PixtralForConditionalGeneration"),  # noqa: E501
437
    "QwenVLForConditionalGeneration": ("qwen_vl", "QwenVLForConditionalGeneration"),  # noqa: E501
438
    "Qwen2VLForConditionalGeneration": ("qwen2_vl", "Qwen2VLForConditionalGeneration"),  # noqa: E501
439
440
441
    "Qwen2_5_VLForConditionalGeneration": (
        "qwen2_5_vl",
        "Qwen2_5_VLForConditionalGeneration",
442
    ),
443
444
445
    "Qwen2AudioForConditionalGeneration": (
        "qwen2_audio",
        "Qwen2AudioForConditionalGeneration",
446
    ),
447
448
449
    "Qwen2_5OmniModel": (
        "qwen2_5_omni_thinker",
        "Qwen2_5OmniThinkerForConditionalGeneration",
450
    ),
451
452
453
    "Qwen2_5OmniForConditionalGeneration": (
        "qwen2_5_omni_thinker",
        "Qwen2_5OmniThinkerForConditionalGeneration",
454
    ),
455
456
457
458
    "Qwen3OmniMoeForConditionalGeneration": (
        "qwen3_omni_moe_thinker",
        "Qwen3OmniMoeThinkerForConditionalGeneration",
    ),
Roger Wang's avatar
Roger Wang committed
459
460
461
462
    "Qwen3ASRForConditionalGeneration": (
        "qwen3_asr",
        "Qwen3ASRForConditionalGeneration",
    ),
463
    "Qwen3VLForConditionalGeneration": ("qwen3_vl", "Qwen3VLForConditionalGeneration"),  # noqa: E501
464
465
466
    "Qwen3VLMoeForConditionalGeneration": (
        "qwen3_vl_moe",
        "Qwen3VLMoeForConditionalGeneration",
467
    ),
468
    "SkyworkR1VChatModel": ("skyworkr1v", "SkyworkR1VChatModel"),
Song's avatar
Song committed
469
    "Step3VLForConditionalGeneration": ("step3_vl", "Step3VLForConditionalGeneration"),  # noqa: E501
汪志鹏's avatar
汪志鹏 committed
470
    "TarsierForConditionalGeneration": ("tarsier", "TarsierForConditionalGeneration"),  # noqa: E501
471
472
473
    "Tarsier2ForConditionalGeneration": (
        "qwen2_vl",
        "Tarsier2ForConditionalGeneration",
474
    ),
475
    "UltravoxModel": ("ultravox", "UltravoxModel"),
Patrick von Platen's avatar
Patrick von Platen committed
476
    "VoxtralForConditionalGeneration": ("voxtral", "VoxtralForConditionalGeneration"),  # noqa: E501
477
    "VoxtralRealtimeGeneration": ("voxtral_realtime", "VoxtralRealtimeGeneration"),  # noqa: E501
478
    # [Encoder-decoder]
479
480
481
482
    "NemotronParseForConditionalGeneration": (
        "nemotron_parse",
        "NemotronParseForConditionalGeneration",
    ),
483
    "WhisperForConditionalGeneration": ("whisper", "WhisperForConditionalGeneration"),  # noqa: E501
484
}
485
486

_SPECULATIVE_DECODING_MODELS = {
487
    "MiMoMTPModel": ("mimo_mtp", "MiMoMTP"),
488
    "EagleLlamaForCausalLM": ("llama_eagle", "EagleLlamaForCausalLM"),
zhiweiz's avatar
zhiweiz committed
489
    "EagleLlama4ForCausalLM": ("llama4_eagle", "EagleLlama4ForCausalLM"),
490
    "EagleMiniCPMForCausalLM": ("minicpm_eagle", "EagleMiniCPMForCausalLM"),
491
    "Eagle3LlamaForCausalLM": ("llama_eagle3", "Eagle3LlamaForCausalLM"),
492
    "LlamaForCausalLMEagle3": ("llama_eagle3", "Eagle3LlamaForCausalLM"),
493
    "Eagle3Qwen2_5vlForCausalLM": ("llama_eagle3", "Eagle3LlamaForCausalLM"),
494
    "Eagle3Qwen3vlForCausalLM": ("llama_eagle3", "Eagle3LlamaForCausalLM"),
495
496
497
498
    "EagleMistralLarge3ForCausalLM": (
        "mistral_large_3_eagle",
        "EagleMistralLarge3ForCausalLM",
    ),
499
    "EagleDeepSeekMTPModel": ("deepseek_eagle", "EagleDeepseekV3ForCausalLM"),
500
    "DeepSeekMTPModel": ("deepseek_mtp", "DeepSeekMTP"),
501
    "ErnieMTPModel": ("ernie_mtp", "ErnieMTP"),
Kyungmin Lee's avatar
Kyungmin Lee committed
502
    "ExaoneMoeMTP": ("exaone_moe_mtp", "ExaoneMoeMTP"),
XuruiYang's avatar
XuruiYang committed
503
    "LongCatFlashMTPModel": ("longcat_flash_mtp", "LongCatFlashMTP"),
Yuxuan Zhang's avatar
Yuxuan Zhang committed
504
    "Glm4MoeMTPModel": ("glm4_moe_mtp", "Glm4MoeMTP"),
505
    "Glm4MoeLiteMTPModel": ("glm4_moe_lite_mtp", "Glm4MoeLiteMTP"),
506
    "GlmOcrMTPModel": ("glm_ocr_mtp", "GlmOcrMTP"),
507
    "MedusaModel": ("medusa", "Medusa"),
508
    "OpenPanguMTPModel": ("openpangu_mtp", "OpenPanguMTP"),
509
    "Qwen3NextMTP": ("qwen3_next_mtp", "Qwen3NextMTP"),
csy0225's avatar
csy0225 committed
510
    "Step3p5MTP": ("step3p5_mtp", "Step3p5MTP"),
511
512
513
    # Temporarily disabled.
    # # TODO(woosuk): Re-enable this once the MLP Speculator is supported in V1.
    # "MLPSpeculatorPreTrainedModel": ("mlp_speculator", "MLPSpeculator"),
514
}
515

516
_TRANSFORMERS_SUPPORTED_MODELS = {
517
518
519
    # Text generation models
    "SmolLM3ForCausalLM": ("transformers", "TransformersForCausalLM"),
    # Multimodal models
520
521
522
523
    "Emu3ForConditionalGeneration": (
        "transformers",
        "TransformersMultiModalForCausalLM",
    ),
524
525
526
}

_TRANSFORMERS_BACKEND_MODELS = {
527
    # Text generation models
528
    "TransformersForCausalLM": ("transformers", "TransformersForCausalLM"),
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
    "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
547
    "TransformersForSequenceClassification": (
548
        "transformers",
549
        "TransformersForSequenceClassification",
550
    ),
551
    "TransformersMoEForSequenceClassification": (
552
        "transformers",
553
        "TransformersMoEForSequenceClassification",
554
    ),
555
556
557
    "TransformersMultiModalForSequenceClassification": (
        "transformers",
        "TransformersMultiModalForSequenceClassification",
558
    ),
559
}
560

561
_VLLM_MODELS = {
562
    **_TEXT_GENERATION_MODELS,
563
    **_EMBEDDING_MODELS,
564
    **_CROSS_ENCODER_MODELS,
565
    **_MULTIMODAL_MODELS,
566
    **_SPECULATIVE_DECODING_MODELS,
567
568
    **_TRANSFORMERS_SUPPORTED_MODELS,
    **_TRANSFORMERS_BACKEND_MODELS,
569
570
}

571
572
573
574
# 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.
575
_SUBPROCESS_COMMAND = [sys.executable, "-m", "vllm.model_executor.models.registry"]
576

577
_PREVIOUSLY_SUPPORTED_MODELS = {
578
    "MotifForCausalLM": "0.10.2",
579
    "Phi3SmallForCausalLM": "0.9.2",
580
    "Phi4FlashForCausalLM": "0.10.2",
581
    "Phi4MultimodalForCausalLM": "0.12.0",
582
583
584
585
586
587
588
589
590
    # 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",
}
591

592

593
594
@dataclass(frozen=True)
class _ModelInfo:
595
    architecture: str
596
    is_text_generation_model: bool
597
    is_pooling_model: bool
598
    attn_type: AttnTypeStr
599
600
    default_seq_pooling_type: SequencePoolingType
    default_tok_pooling_type: TokenPoolingType
601
    supports_cross_encoding: bool
602
    supports_late_interaction: bool
603
    supports_multimodal: bool
604
    supports_multimodal_raw_input_only: bool
Patrick von Platen's avatar
Patrick von Platen committed
605
    requires_raw_input_tokens: bool
606
    supports_multimodal_encoder_tp_data: bool
607
    supports_pp: bool
608
609
    has_inner_state: bool
    is_attention_free: bool
610
    is_hybrid: bool
611
    has_noops: bool
612
    supports_mamba_prefix_caching: bool
613
    supports_transcription: bool
614
    supports_transcription_only: bool
615
616

    @staticmethod
617
    def from_model_cls(model: type[nn.Module]) -> "_ModelInfo":
618
        return _ModelInfo(
619
            architecture=model.__name__,
620
            is_text_generation_model=is_text_generation_model(model),
621
            is_pooling_model=is_pooling_model(model),
622
623
            default_seq_pooling_type=get_default_seq_pooling_type(model),
            default_tok_pooling_type=get_default_tok_pooling_type(model),
624
            attn_type=get_attn_type(model),
625
            supports_cross_encoding=supports_cross_encoding(model),
626
            supports_late_interaction=supports_late_interaction(model),
627
            supports_multimodal=supports_multimodal(model),
628
629
630
            supports_multimodal_raw_input_only=supports_multimodal_raw_input_only(
                model
            ),
Patrick von Platen's avatar
Patrick von Platen committed
631
            requires_raw_input_tokens=requires_raw_input_tokens(model),
632
633
634
            supports_multimodal_encoder_tp_data=supports_multimodal_encoder_tp_data(
                model
            ),
635
            supports_pp=supports_pp(model),
636
637
            has_inner_state=has_inner_state(model),
            is_attention_free=is_attention_free(model),
638
            is_hybrid=is_hybrid(model),
639
            supports_mamba_prefix_caching=supports_mamba_prefix_caching(model),
640
            supports_transcription=supports_transcription(model),
641
642
643
            supports_transcription_only=(
                supports_transcription(model) and model.supports_transcription_only
            ),
644
            has_noops=has_noops(model),
645
        )
646
647


648
649
650
651
class _BaseRegisteredModel(ABC):
    @abstractmethod
    def inspect_model_cls(self) -> _ModelInfo:
        raise NotImplementedError
652

653
    @abstractmethod
654
    def load_model_cls(self) -> type[nn.Module]:
655
        raise NotImplementedError
656
657


658
659
660
661
662
663
664
@dataclass(frozen=True)
class _RegisteredModel(_BaseRegisteredModel):
    """
    Represents a model that has already been imported in the main process.
    """

    interfaces: _ModelInfo
665
    model_cls: type[nn.Module]
666
667

    @staticmethod
668
    def from_model_cls(model_cls: type[nn.Module]):
669
670
671
672
673
674
675
676
        return _RegisteredModel(
            interfaces=_ModelInfo.from_model_cls(model_cls),
            model_cls=model_cls,
        )

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

677
    def load_model_cls(self) -> type[nn.Module]:
678
679
680
681
682
683
684
685
        return self.model_cls


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

687
688
689
    module_name: str
    class_name: str

690
691
692
693
694
695
696
697
    @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"

698
    def _load_modelinfo_from_cache(self, module_hash: str) -> _ModelInfo | None:
699
700
        try:
            try:
701
                modelinfo_path = self._get_cache_dir() / self._get_cache_filename()
702
703
704
                with open(modelinfo_path, encoding="utf-8") as file:
                    mi_dict = json.load(file)
            except FileNotFoundError:
705
                logger.debug(
706
                    "Cached model info file for class %s.%s not found",
707
708
709
                    self.module_name,
                    self.class_name,
                )
710
711
712
                return None

            if mi_dict["hash"] != module_hash:
713
                logger.debug(
714
                    "Cached model info file for class %s.%s is stale",
715
716
717
                    self.module_name,
                    self.class_name,
                )
718
719
720
721
722
                return None

            # file not changed, use cached _ModelInfo properties
            return _ModelInfo(**mi_dict["modelinfo"])
        except Exception:
723
            logger.debug(
724
                "Cached model info for class %s.%s error. ",
725
726
727
                self.module_name,
                self.class_name,
            )
728
729
            return None

730
    def _save_modelinfo_to_cache(self, mi: _ModelInfo, module_hash: str) -> None:
731
732
        """save dictionary json file to cache"""
        from vllm.model_executor.model_loader.weight_utils import atomic_writer
733

734
735
736
737
738
739
740
741
        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()
742
            with atomic_writer(modelinfo_path, encoding="utf-8") as f:
743
744
745
746
747
                json.dump(modelinfo_dict, f, indent=2)
        except Exception:
            logger.exception("Error saving model info cache.")

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

752
753
        if model_path.exists():
            with open(model_path, "rb") as f:
754
                module_hash = safe_hash(f.read(), usedforsecurity=False).hexdigest()
755
756
757

            mi = self._load_modelinfo_from_cache(module_hash)
            if mi is not None:
758
                logger.debug(
759
                    "Loaded model info for class %s.%s from cache",
760
761
762
                    self.module_name,
                    self.class_name,
                )
763
764
                return mi
            else:
765
                logger.debug(
766
                    "Cache model info for class %s.%s miss. Loading model instead.",
767
768
769
                    self.module_name,
                    self.class_name,
                )
770
771
772

        # Performed in another process to avoid initializing CUDA
        mi = _run_in_subprocess(
773
774
775
776
777
            lambda: _ModelInfo.from_model_cls(self.load_model_cls())
        )
        logger.debug(
            "Loaded model info for class %s.%s", self.module_name, self.class_name
        )
778
779

        # save cache file
780
781
        if module_hash is not None:
            self._save_modelinfo_to_cache(mi, module_hash)
782
783

        return mi
784

785
    def load_model_cls(self) -> type[nn.Module]:
786
787
788
789
790
791
792
793
        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,
794
) -> type[nn.Module] | None:
795
    from vllm.platforms import current_platform
796

797
    current_platform.verify_model_arch(model_arch)
798
799
800
    try:
        return model.load_model_cls()
    except Exception:
801
        logger.exception("Error in loading model architecture '%s'", model_arch)
802
        return None
803
804


805
806
807
808
@lru_cache(maxsize=128)
def _try_inspect_model_cls(
    model_arch: str,
    model: _BaseRegisteredModel,
809
) -> _ModelInfo | None:
810
811
812
    try:
        return model.inspect_model_cls()
    except Exception:
813
        logger.exception("Error in inspecting model architecture '%s'", model_arch)
814
        return None
815
816


817
818
819
@dataclass
class _ModelRegistry:
    # Keyed by model_arch
820
    models: dict[str, _BaseRegisteredModel] = field(default_factory=dict)
821

822
    def get_supported_archs(self) -> Set[str]:
823
        return self.models.keys()
824

825
826
827
    def register_model(
        self,
        model_arch: str,
828
        model_cls: type[nn.Module] | str,
829
    ) -> None:
830
831
832
        """
        Register an external model to be used in vLLM.

833
        `model_cls` can be either:
834

835
        - A [`torch.nn.Module`][] class directly referencing the model.
836
        - A string in the format `<module>:<class>` which can be used to
837
838
          lazily import the model. This is useful to avoid initializing CUDA
          when importing the model and thus the related error
839
          `RuntimeError: Cannot re-initialize CUDA in forked subprocess`.
840
        """
841
842
843
844
        if not isinstance(model_arch, str):
            msg = f"`model_arch` should be a string, not a {type(model_arch)}"
            raise TypeError(msg)

845
        if model_arch in self.models:
846
847
            logger.warning(
                "Model architecture %s is already registered, and will be "
848
849
850
851
                "overwritten by the new model class %s.",
                model_arch,
                model_cls,
            )
852
853
854
855
856
857

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

859
            model = _LazyRegisteredModel(*split_str)
860
        elif isinstance(model_cls, type) and issubclass(model_cls, nn.Module):
861
            model = _RegisteredModel.from_model_cls(model_cls)
862
        else:
863
864
865
866
            msg = (
                "`model_cls` should be a string or PyTorch model class, "
                f"not a {type(model_arch)}"
            )
867
            raise TypeError(msg)
868

869
        self.models[model_arch] = model
870

871
    def _raise_for_unsupported(self, architectures: list[str]):
872
        all_supported_archs = self.get_supported_archs()
873

874
875
876
        if any(arch in all_supported_archs for arch in architectures):
            raise ValueError(
                f"Model architectures {architectures} failed "
877
878
                "to be inspected. Please check the logs for more details."
            )
879

880
881
882
883
884
885
886
887
        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 "
888
889
                    "use this model architecture."
                )
890

891
892
        raise ValueError(
            f"Model architectures {architectures} are not supported for now. "
893
894
            f"Supported architectures: {all_supported_archs}"
        )
895

896
    def _try_load_model_cls(self, model_arch: str) -> type[nn.Module] | None:
897
898
        if model_arch not in self.models:
            return None
899

900
        return _try_load_model_cls(model_arch, self.models[model_arch])
901

902
    def _try_inspect_model_cls(self, model_arch: str) -> _ModelInfo | None:
903
904
        if model_arch not in self.models:
            return None
905

906
907
908
909
910
911
        return _try_inspect_model_cls(model_arch, self.models[model_arch])

    def _try_resolve_transformers(
        self,
        architecture: str,
        model_config: ModelConfig,
912
    ) -> str | None:
913
914
915
        if architecture in _TRANSFORMERS_BACKEND_MODELS:
            return architecture

916
917
918
        auto_map: dict[str, str] = (
            getattr(model_config.hf_config, "auto_map", None) or dict()
        )
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934

        # 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,
935
                        trust_remote_code=model_config.trust_remote_code,
936
937
938
939
940
941
942
943
944
945
946
947
                        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,
948
                        trust_remote_code=model_config.trust_remote_code,
949
950
951
952
953
                        warn_on_fail=True,
                    )
                    if model_module is not None:
                        break
            else:
954
                if model_config.model_impl != "transformers":
955
956
957
958
959
960
961
                    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 "
962
963
                    "'auto_map' (relevant if the model is custom)."
                )
964
965

        if not model_module.is_backend_compatible():
966
            if model_config.model_impl != "transformers":
967
                return None
968

969
970
            raise ValueError(
                f"The Transformers implementation of {architecture!r} "
971
972
                "is not compatible with vLLM."
            )
973

974
        return model_config._get_transformers_backend_cls()
975

976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
    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
1001

1002
1003
    def inspect_model_cls(
        self,
1004
        architectures: str | list[str],
1005
        model_config: ModelConfig,
1006
    ) -> tuple[_ModelInfo, str]:
1007
1008
        if isinstance(architectures, str):
            architectures = [architectures]
1009
1010
        if not architectures:
            raise ValueError("No model architectures are specified")
1011
1012

        # Require transformers impl
1013
        if model_config.model_impl == "transformers":
1014
            arch = self._try_resolve_transformers(architectures[0], model_config)
1015
1016
1017
1018
            if arch is not None:
                model_info = self._try_inspect_model_cls(arch)
                if model_info is not None:
                    return (model_info, arch)
1019
        elif model_config.model_impl == "terratorch":
1020
1021
            model_info = self._try_inspect_model_cls("Terratorch")
            return (model_info, "Terratorch")
1022

1023
        # Fallback to transformers impl (after resolving convert_type)
1024
1025
1026
1027
1028
1029
        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)
1030
1031
1032
1033
1034
1035
1036
            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)
1037
            model_info = self._try_inspect_model_cls(normalized_arch)
1038
            if model_info is not None:
1039
                return (model_info, arch)
1040

1041
        # Fallback to transformers impl (before resolving runner_type)
1042
1043
1044
1045
1046
        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)
1047
1048
1049
1050
1051
            if arch is not None:
                model_info = self._try_inspect_model_cls(arch)
                if model_info is not None:
                    return (model_info, arch)

1052
        return self._raise_for_unsupported(architectures)
1053

1054
1055
    def resolve_model_cls(
        self,
1056
        architectures: str | list[str],
1057
        model_config: ModelConfig,
1058
    ) -> tuple[type[nn.Module], str]:
1059
1060
        if isinstance(architectures, str):
            architectures = [architectures]
1061
1062
        if not architectures:
            raise ValueError("No model architectures are specified")
1063
1064

        # Require transformers impl
1065
        if model_config.model_impl == "transformers":
1066
            arch = self._try_resolve_transformers(architectures[0], model_config)
1067
1068
1069
1070
            if arch is not None:
                model_cls = self._try_load_model_cls(arch)
                if model_cls is not None:
                    return (model_cls, arch)
1071
        elif model_config.model_impl == "terratorch":
1072
1073
1074
1075
            arch = "Terratorch"
            model_cls = self._try_load_model_cls(arch)
            if model_cls is not None:
                return (model_cls, arch)
1076

1077
        # Fallback to transformers impl (after resolving convert_type)
1078
1079
1080
1081
1082
1083
        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)
1084
1085
1086
1087
1088
1089
1090
            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)
1091
            model_cls = self._try_load_model_cls(normalized_arch)
1092
1093
            if model_cls is not None:
                return (model_cls, arch)
1094

1095
        # Fallback to transformers impl (before resolving runner_type)
1096
1097
1098
1099
1100
        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)
1101
1102
1103
1104
1105
            if arch is not None:
                model_cls = self._try_load_model_cls(arch)
                if model_cls is not None:
                    return (model_cls, arch)

1106
        return self._raise_for_unsupported(architectures)
1107

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

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

1124
1125
    def is_cross_encoder_model(
        self,
1126
        architectures: str | list[str],
1127
        model_config: ModelConfig,
1128
    ) -> bool:
1129
        model_cls, _ = self.inspect_model_cls(architectures, model_config)
1130
        return model_cls.supports_cross_encoding
1131

1132
1133
    def is_multimodal_model(
        self,
1134
        architectures: str | list[str],
1135
        model_config: ModelConfig,
1136
    ) -> bool:
1137
        model_cls, _ = self.inspect_model_cls(architectures, model_config)
1138
        return model_cls.supports_multimodal
1139

1140
    def is_multimodal_raw_input_only_model(
1141
        self,
1142
        architectures: str | list[str],
1143
        model_config: ModelConfig,
1144
    ) -> bool:
1145
        model_cls, _ = self.inspect_model_cls(architectures, model_config)
1146
        return model_cls.supports_multimodal_raw_input_only
1147

1148
1149
    def is_pp_supported_model(
        self,
1150
        architectures: str | list[str],
1151
        model_config: ModelConfig,
1152
    ) -> bool:
1153
        model_cls, _ = self.inspect_model_cls(architectures, model_config)
1154
        return model_cls.supports_pp
1155

1156
1157
    def model_has_inner_state(
        self,
1158
        architectures: str | list[str],
1159
        model_config: ModelConfig,
1160
    ) -> bool:
1161
        model_cls, _ = self.inspect_model_cls(architectures, model_config)
1162
        return model_cls.has_inner_state
1163

1164
1165
    def is_attention_free_model(
        self,
1166
        architectures: str | list[str],
1167
        model_config: ModelConfig,
1168
    ) -> bool:
1169
        model_cls, _ = self.inspect_model_cls(architectures, model_config)
1170
        return model_cls.is_attention_free
1171

1172
1173
    def is_hybrid_model(
        self,
1174
        architectures: str | list[str],
1175
        model_config: ModelConfig,
1176
    ) -> bool:
1177
        model_cls, _ = self.inspect_model_cls(architectures, model_config)
1178
1179
        return model_cls.is_hybrid

1180
1181
    def is_noops_model(
        self,
1182
        architectures: str | list[str],
1183
        model_config: ModelConfig,
1184
    ) -> bool:
1185
        model_cls, _ = self.inspect_model_cls(architectures, model_config)
1186
1187
        return model_cls.has_noops

1188
1189
    def is_transcription_model(
        self,
1190
        architectures: str | list[str],
1191
        model_config: ModelConfig,
1192
    ) -> bool:
1193
        model_cls, _ = self.inspect_model_cls(architectures, model_config)
1194
1195
        return model_cls.supports_transcription

1196
1197
    def is_transcription_only_model(
        self,
1198
        architectures: str | list[str],
1199
        model_config: ModelConfig,
1200
    ) -> bool:
1201
        model_cls, _ = self.inspect_model_cls(architectures, model_config)
1202
1203
        return model_cls.supports_transcription_only

1204

1205
1206
1207
1208
1209
1210
1211
1212
1213
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()
    }
)
1214
1215
1216
1217
1218

_T = TypeVar("_T")


def _run_in_subprocess(fn: Callable[[], _T]) -> _T:
1219
1220
1221
1222
1223
    # 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")

1224
        # `cloudpickle` allows pickling lambda functions directly
1225
        import cloudpickle
1226

1227
        input_bytes = cloudpickle.dumps((fn, output_filepath))
1228
1229
1230

        # cannot use `sys.executable __file__` here because the script
        # contains relative imports
1231
1232
1233
        returned = subprocess.run(
            _SUBPROCESS_COMMAND, input=input_bytes, capture_output=True
        )
1234
1235
1236
1237
1238
1239

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

1244
        with open(output_filepath, "rb") as f:
1245
1246
1247
1248
1249
1250
            return pickle.load(f)


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

1252
1253
1254
1255
1256
    load_general_plugins()

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

    result = fn()
1257
1258
1259

    with open(output_file, "wb") as f:
        f.write(pickle.dumps(result))
1260
1261
1262


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