registry.py 49.1 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"),
240
    "XLMRobertaModel": ("roberta", "RobertaEmbeddingModel"),
241
    "BgeM3EmbeddingModel": ("roberta", "BgeM3EmbeddingModel"),
242
    # [Multimodal]
243
    "CLIPModel": ("clip", "CLIPEmbeddingModel"),
244
245
246
    "LlavaNextForConditionalGeneration": (
        "llava_next",
        "LlavaNextForConditionalGeneration",
247
    ),
248
    "Phi3VForCausalLM": ("phi3v", "Phi3VForCausalLM"),
249
    "Qwen2VLForConditionalGeneration": ("qwen2_vl", "Qwen2VLForConditionalGeneration"),  # noqa: E501
250
    "SiglipModel": ("siglip", "SiglipEmbeddingModel"),
251
252
    # Technically Terratorch models work on images, both in
    # input and output. I am adding it here because it piggy-backs on embedding
253
    # models for the time being.
254
255
    "PrithviGeoSpatialMAE": ("terratorch", "Terratorch"),
    "Terratorch": ("terratorch", "Terratorch"),
256
257
}

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

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

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

512
_TRANSFORMERS_SUPPORTED_MODELS = {
513
514
515
    # Text generation models
    "SmolLM3ForCausalLM": ("transformers", "TransformersForCausalLM"),
    # Multimodal models
516
517
518
519
    "Emu3ForConditionalGeneration": (
        "transformers",
        "TransformersMultiModalForCausalLM",
    ),
520
521
522
}

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

557
_VLLM_MODELS = {
558
    **_TEXT_GENERATION_MODELS,
559
    **_EMBEDDING_MODELS,
560
    **_CROSS_ENCODER_MODELS,
561
    **_MULTIMODAL_MODELS,
562
    **_SPECULATIVE_DECODING_MODELS,
563
564
    **_TRANSFORMERS_SUPPORTED_MODELS,
    **_TRANSFORMERS_BACKEND_MODELS,
565
566
}

567
568
569
570
# 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.
571
_SUBPROCESS_COMMAND = [sys.executable, "-m", "vllm.model_executor.models.registry"]
572

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

588

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

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


644
645
646
647
class _BaseRegisteredModel(ABC):
    @abstractmethod
    def inspect_model_cls(self) -> _ModelInfo:
        raise NotImplementedError
648

649
    @abstractmethod
650
    def load_model_cls(self) -> type[nn.Module]:
651
        raise NotImplementedError
652
653


654
655
656
657
658
659
660
@dataclass(frozen=True)
class _RegisteredModel(_BaseRegisteredModel):
    """
    Represents a model that has already been imported in the main process.
    """

    interfaces: _ModelInfo
661
    model_cls: type[nn.Module]
662
663

    @staticmethod
664
    def from_model_cls(model_cls: type[nn.Module]):
665
666
667
668
669
670
671
672
        return _RegisteredModel(
            interfaces=_ModelInfo.from_model_cls(model_cls),
            model_cls=model_cls,
        )

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

673
    def load_model_cls(self) -> type[nn.Module]:
674
675
676
677
678
679
680
681
        return self.model_cls


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

683
684
685
    module_name: str
    class_name: str

686
687
688
689
690
691
692
693
    @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"

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

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

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

726
    def _save_modelinfo_to_cache(self, mi: _ModelInfo, module_hash: str) -> None:
727
728
        """save dictionary json file to cache"""
        from vllm.model_executor.model_loader.weight_utils import atomic_writer
729

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

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

748
749
        if model_path.exists():
            with open(model_path, "rb") as f:
750
                module_hash = safe_hash(f.read(), usedforsecurity=False).hexdigest()
751
752
753

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

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

        # save cache file
776
777
        if module_hash is not None:
            self._save_modelinfo_to_cache(mi, module_hash)
778
779

        return mi
780

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

793
    current_platform.verify_model_arch(model_arch)
794
795
796
    try:
        return model.load_model_cls()
    except Exception:
797
        logger.exception("Error in loading model architecture '%s'", model_arch)
798
        return None
799
800


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


813
814
815
@dataclass
class _ModelRegistry:
    # Keyed by model_arch
816
    models: dict[str, _BaseRegisteredModel] = field(default_factory=dict)
817

818
    def get_supported_archs(self) -> Set[str]:
819
        return self.models.keys()
820

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

829
        `model_cls` can be either:
830

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

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

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

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

865
        self.models[model_arch] = model
866

867
    def _raise_for_unsupported(self, architectures: list[str]):
868
        all_supported_archs = self.get_supported_archs()
869

870
871
872
        if any(arch in all_supported_archs for arch in architectures):
            raise ValueError(
                f"Model architectures {architectures} failed "
873
874
                "to be inspected. Please check the logs for more details."
            )
875

876
877
878
879
880
881
882
883
        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 "
884
885
                    "use this model architecture."
                )
886

887
888
        raise ValueError(
            f"Model architectures {architectures} are not supported for now. "
889
890
            f"Supported architectures: {all_supported_archs}"
        )
891

892
    def _try_load_model_cls(self, model_arch: str) -> type[nn.Module] | None:
893
894
        if model_arch not in self.models:
            return None
895

896
        return _try_load_model_cls(model_arch, self.models[model_arch])
897

898
    def _try_inspect_model_cls(self, model_arch: str) -> _ModelInfo | None:
899
900
        if model_arch not in self.models:
            return None
901

902
903
904
905
906
907
        return _try_inspect_model_cls(model_arch, self.models[model_arch])

    def _try_resolve_transformers(
        self,
        architecture: str,
        model_config: ModelConfig,
908
    ) -> str | None:
909
910
911
        if architecture in _TRANSFORMERS_BACKEND_MODELS:
            return architecture

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

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

        if not model_module.is_backend_compatible():
962
            if model_config.model_impl != "transformers":
963
                return None
964

965
966
            raise ValueError(
                f"The Transformers implementation of {architecture!r} "
967
968
                "is not compatible with vLLM."
            )
969

970
        return model_config._get_transformers_backend_cls()
971

972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
    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
997

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

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

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

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

1048
        return self._raise_for_unsupported(architectures)
1049

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

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

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

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

1102
        return self._raise_for_unsupported(architectures)
1103

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

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

1120
1121
    def is_cross_encoder_model(
        self,
1122
        architectures: str | list[str],
1123
        model_config: ModelConfig,
1124
    ) -> bool:
1125
        model_cls, _ = self.inspect_model_cls(architectures, model_config)
1126
        return model_cls.supports_cross_encoding
1127

1128
1129
    def is_multimodal_model(
        self,
1130
        architectures: str | list[str],
1131
        model_config: ModelConfig,
1132
    ) -> bool:
1133
        model_cls, _ = self.inspect_model_cls(architectures, model_config)
1134
        return model_cls.supports_multimodal
1135

1136
    def is_multimodal_raw_input_only_model(
1137
        self,
1138
        architectures: str | list[str],
1139
        model_config: ModelConfig,
1140
    ) -> bool:
1141
        model_cls, _ = self.inspect_model_cls(architectures, model_config)
1142
        return model_cls.supports_multimodal_raw_input_only
1143

1144
1145
    def is_pp_supported_model(
        self,
1146
        architectures: str | list[str],
1147
        model_config: ModelConfig,
1148
    ) -> bool:
1149
        model_cls, _ = self.inspect_model_cls(architectures, model_config)
1150
        return model_cls.supports_pp
1151

1152
1153
    def model_has_inner_state(
        self,
1154
        architectures: str | list[str],
1155
        model_config: ModelConfig,
1156
    ) -> bool:
1157
        model_cls, _ = self.inspect_model_cls(architectures, model_config)
1158
        return model_cls.has_inner_state
1159

1160
1161
    def is_attention_free_model(
        self,
1162
        architectures: str | list[str],
1163
        model_config: ModelConfig,
1164
    ) -> bool:
1165
        model_cls, _ = self.inspect_model_cls(architectures, model_config)
1166
        return model_cls.is_attention_free
1167

1168
1169
    def is_hybrid_model(
        self,
1170
        architectures: str | list[str],
1171
        model_config: ModelConfig,
1172
    ) -> bool:
1173
        model_cls, _ = self.inspect_model_cls(architectures, model_config)
1174
1175
        return model_cls.is_hybrid

1176
1177
    def is_noops_model(
        self,
1178
        architectures: str | list[str],
1179
        model_config: ModelConfig,
1180
    ) -> bool:
1181
        model_cls, _ = self.inspect_model_cls(architectures, model_config)
1182
1183
        return model_cls.has_noops

1184
1185
    def is_transcription_model(
        self,
1186
        architectures: str | list[str],
1187
        model_config: ModelConfig,
1188
    ) -> bool:
1189
        model_cls, _ = self.inspect_model_cls(architectures, model_config)
1190
1191
        return model_cls.supports_transcription

1192
1193
    def is_transcription_only_model(
        self,
1194
        architectures: str | list[str],
1195
        model_config: ModelConfig,
1196
    ) -> bool:
1197
        model_cls, _ = self.inspect_model_cls(architectures, model_config)
1198
1199
        return model_cls.supports_transcription_only

1200

1201
1202
1203
1204
1205
1206
1207
1208
1209
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()
    }
)
1210
1211
1212
1213
1214

_T = TypeVar("_T")


def _run_in_subprocess(fn: Callable[[], _T]) -> _T:
1215
1216
1217
1218
1219
    # 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")

1220
        # `cloudpickle` allows pickling lambda functions directly
1221
        import cloudpickle
1222

1223
        input_bytes = cloudpickle.dumps((fn, output_filepath))
1224
1225
1226

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

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

1240
        with open(output_filepath, "rb") as f:
1241
1242
1243
1244
1245
1246
            return pickle.load(f)


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

1248
1249
1250
1251
1252
    load_general_plugins()

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

    result = fn()
1253
1254
1255

    with open(output_file, "wb") as f:
        f.write(pickle.dumps(result))
1256
1257
1258


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