registry.py 49.7 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"),
Jee Jee Li's avatar
Jee Jee Li committed
117
    "GlmMoeDsaForCausalLM": ("deepseek_v2", "GlmMoeDsaForCausalLM"),
118
    "GptOssForCausalLM": ("gpt_oss", "GptOssForCausalLM"),
119
120
121
122
123
124
    "GPT2LMHeadModel": ("gpt2", "GPT2LMHeadModel"),
    "GPTBigCodeForCausalLM": ("gpt_bigcode", "GPTBigCodeForCausalLM"),
    "GPTJForCausalLM": ("gpt_j", "GPTJForCausalLM"),
    "GPTNeoXForCausalLM": ("gpt_neox", "GPTNeoXForCausalLM"),
    "GraniteForCausalLM": ("granite", "GraniteForCausalLM"),
    "GraniteMoeForCausalLM": ("granitemoe", "GraniteMoeForCausalLM"),
125
126
    "GraniteMoeHybridForCausalLM": ("granitemoehybrid", "GraniteMoeHybridForCausalLM"),  # noqa: E501
    "GraniteMoeSharedForCausalLM": ("granitemoeshared", "GraniteMoeSharedForCausalLM"),  # noqa: E501
127
    "GritLM": ("gritlm", "GritLM"),
Bijaya Dangol's avatar
Bijaya Dangol committed
128
129
    "Grok1ModelForCausalLM": ("grok1", "GrokForCausalLM"),
    "Grok1ForCausalLM": ("grok1", "GrokForCausalLM"),
130
131
    "HunYuanMoEV1ForCausalLM": ("hunyuan_v1", "HunYuanMoEV1ForCausalLM"),
    "HunYuanDenseV1ForCausalLM": ("hunyuan_v1", "HunYuanDenseV1ForCausalLM"),
132
    "HCXVisionForCausalLM": ("hyperclovax_vision", "HCXVisionForCausalLM"),
133
134
    "InternLMForCausalLM": ("llama", "LlamaForCausalLM"),
    "InternLM2ForCausalLM": ("internlm2", "InternLM2ForCausalLM"),
135
    "InternLM2VEForCausalLM": ("internlm2_ve", "InternLM2VEForCausalLM"),
136
    "InternLM3ForCausalLM": ("llama", "LlamaForCausalLM"),
137
138
    "IQuestCoderForCausalLM": ("llama", "LlamaForCausalLM"),
    "IQuestLoopCoderForCausalLM": ("iquest_loopcoder", "IQuestLoopCoderForCausalLM"),
139
    "JAISLMHeadModel": ("jais", "JAISLMHeadModel"),
140
    "Jais2ForCausalLM": ("jais2", "Jais2ForCausalLM"),
141
    "JambaForCausalLM": ("jamba", "JambaForCausalLM"),
142
    "KimiLinearForCausalLM": ("kimi_linear", "KimiLinearForCausalLM"),  # noqa: E501
143
    "Lfm2ForCausalLM": ("lfm2", "Lfm2ForCausalLM"),
Paul Pak's avatar
Paul Pak committed
144
    "Lfm2MoeForCausalLM": ("lfm2_moe", "Lfm2MoeForCausalLM"),
145
    "LlamaForCausalLM": ("llama", "LlamaForCausalLM"),
146
    "Llama4ForCausalLM": ("llama4", "Llama4ForCausalLM"),
147
148
    # For decapoda-research/llama-*
    "LLaMAForCausalLM": ("llama", "LlamaForCausalLM"),
XuruiYang's avatar
XuruiYang committed
149
    "LongcatFlashForCausalLM": ("longcat_flash", "LongcatFlashForCausalLM"),
150
    "MambaForCausalLM": ("mamba", "MambaForCausalLM"),
151
    "Mamba2ForCausalLM": ("mamba2", "Mamba2ForCausalLM"),
152
153
    "MiniCPMForCausalLM": ("minicpm", "MiniCPMForCausalLM"),
    "MiniCPM3ForCausalLM": ("minicpm3", "MiniCPM3ForCausalLM"),
154
155
156
    "MiniMaxForCausalLM": ("minimax_text_01", "MiniMaxText01ForCausalLM"),
    "MiniMaxText01ForCausalLM": ("minimax_text_01", "MiniMaxText01ForCausalLM"),
    "MiniMaxM1ForCausalLM": ("minimax_text_01", "MiniMaxText01ForCausalLM"),
157
    "MiniMaxM2ForCausalLM": ("minimax_m2", "MiniMaxM2ForCausalLM"),
158
    "MistralForCausalLM": ("mistral", "MistralForCausalLM"),
159
    "MistralLarge3ForCausalLM": ("mistral_large_3", "MistralLarge3ForCausalLM"),
160
161
162
163
    "MixtralForCausalLM": ("mixtral", "MixtralForCausalLM"),
    # transformers's mpt class has lower case
    "MptForCausalLM": ("mpt", "MPTForCausalLM"),
    "MPTForCausalLM": ("mpt", "MPTForCausalLM"),
164
    "MiMoForCausalLM": ("mimo", "MiMoForCausalLM"),
165
    "MiMoV2FlashForCausalLM": ("mimo_v2_flash", "MiMoV2FlashForCausalLM"),
166
    "NemotronForCausalLM": ("nemotron", "NemotronForCausalLM"),
Luis Vega's avatar
Luis Vega committed
167
    "NemotronHForCausalLM": ("nemotron_h", "NemotronHForCausalLM"),
168
    "NemotronHPuzzleForCausalLM": ("nemotron_h", "NemotronHForCausalLM"),
169
    "OlmoForCausalLM": ("olmo", "OlmoForCausalLM"),
170
    "Olmo2ForCausalLM": ("olmo2", "Olmo2ForCausalLM"),
171
    "Olmo3ForCausalLM": ("olmo2", "Olmo2ForCausalLM"),
172
173
174
    "OlmoeForCausalLM": ("olmoe", "OlmoeForCausalLM"),
    "OPTForCausalLM": ("opt", "OPTForCausalLM"),
    "OrionForCausalLM": ("orion", "OrionForCausalLM"),
175
    "OuroForCausalLM": ("ouro", "OuroForCausalLM"),
176
    "PanguEmbeddedForCausalLM": ("openpangu", "PanguEmbeddedForCausalLM"),
177
    "PanguProMoEV2ForCausalLM": ("openpangu", "PanguProMoEV2ForCausalLM"),
178
    "PanguUltraMoEForCausalLM": ("openpangu", "PanguUltraMoEForCausalLM"),
179
180
181
182
    "PersimmonForCausalLM": ("persimmon", "PersimmonForCausalLM"),
    "PhiForCausalLM": ("phi", "PhiForCausalLM"),
    "Phi3ForCausalLM": ("phi3", "Phi3ForCausalLM"),
    "PhiMoEForCausalLM": ("phimoe", "PhiMoEForCausalLM"),
Shinichi Hemmi's avatar
Shinichi Hemmi committed
183
    "Plamo2ForCausalLM": ("plamo2", "Plamo2ForCausalLM"),
184
    "Plamo3ForCausalLM": ("plamo3", "Plamo3ForCausalLM"),
185
    "QWenLMHeadModel": ("qwen", "QWenLMHeadModel"),
186
187
    "Qwen2ForCausalLM": ("qwen2", "Qwen2ForCausalLM"),
    "Qwen2MoeForCausalLM": ("qwen2_moe", "Qwen2MoeForCausalLM"),
188
189
    "Qwen3ForCausalLM": ("qwen3", "Qwen3ForCausalLM"),
    "Qwen3MoeForCausalLM": ("qwen3_moe", "Qwen3MoeForCausalLM"),
190
    "RWForCausalLM": ("falcon", "FalconForCausalLM"),
191
    "SeedOssForCausalLM": ("seed_oss", "SeedOssForCausalLM"),
Li Xie's avatar
Li Xie committed
192
    "Step1ForCausalLM": ("step1", "Step1ForCausalLM"),
Song's avatar
Song committed
193
    "Step3TextForCausalLM": ("step3_text", "Step3TextForCausalLM"),
csy0225's avatar
csy0225 committed
194
    "Step3p5ForCausalLM": ("step3p5", "Step3p5ForCausalLM"),
195
196
197
198
    "StableLMEpochForCausalLM": ("stablelm", "StablelmForCausalLM"),
    "StableLmForCausalLM": ("stablelm", "StablelmForCausalLM"),
    "Starcoder2ForCausalLM": ("starcoder2", "Starcoder2ForCausalLM"),
    "SolarForCausalLM": ("solar", "SolarForCausalLM"),
199
    "TeleChatForCausalLM": ("telechat2", "TeleChat2ForCausalLM"),
200
    "TeleChat2ForCausalLM": ("telechat2", "TeleChat2ForCausalLM"),
201
    "TeleFLMForCausalLM": ("teleflm", "TeleFLMForCausalLM"),
202
    "XverseForCausalLM": ("llama", "LlamaForCausalLM"),
203
    "Zamba2ForCausalLM": ("zamba2", "Zamba2ForCausalLM"),
204
205
206
}

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

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

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

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

528
_TRANSFORMERS_SUPPORTED_MODELS = {
529
530
531
    # Text generation models
    "SmolLM3ForCausalLM": ("transformers", "TransformersForCausalLM"),
    # Multimodal models
532
533
534
535
    "Emu3ForConditionalGeneration": (
        "transformers",
        "TransformersMultiModalForCausalLM",
    ),
536
537
538
}

_TRANSFORMERS_BACKEND_MODELS = {
539
    # Text generation models
540
    "TransformersForCausalLM": ("transformers", "TransformersForCausalLM"),
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
    "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
559
    "TransformersForSequenceClassification": (
560
        "transformers",
561
        "TransformersForSequenceClassification",
562
    ),
563
    "TransformersMoEForSequenceClassification": (
564
        "transformers",
565
        "TransformersMoEForSequenceClassification",
566
    ),
567
568
569
    "TransformersMultiModalForSequenceClassification": (
        "transformers",
        "TransformersMultiModalForSequenceClassification",
570
    ),
571
}
572

573
_VLLM_MODELS = {
574
    **_TEXT_GENERATION_MODELS,
575
    **_EMBEDDING_MODELS,
576
    **_CROSS_ENCODER_MODELS,
577
    **_MULTIMODAL_MODELS,
578
    **_SPECULATIVE_DECODING_MODELS,
579
580
    **_TRANSFORMERS_SUPPORTED_MODELS,
    **_TRANSFORMERS_BACKEND_MODELS,
581
582
}

583
584
585
586
# 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.
587
_SUBPROCESS_COMMAND = [sys.executable, "-m", "vllm.model_executor.models.registry"]
588

589
_PREVIOUSLY_SUPPORTED_MODELS = {
590
    "MotifForCausalLM": "0.10.2",
591
    "Phi3SmallForCausalLM": "0.9.2",
592
    "Phi4FlashForCausalLM": "0.10.2",
593
    "Phi4MultimodalForCausalLM": "0.12.0",
594
595
596
597
598
599
600
601
602
    # 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",
}
603

604

605
606
@dataclass(frozen=True)
class _ModelInfo:
607
    architecture: str
608
    is_text_generation_model: bool
609
    is_pooling_model: bool
610
    attn_type: AttnTypeStr
611
612
    default_seq_pooling_type: SequencePoolingType
    default_tok_pooling_type: TokenPoolingType
613
    supports_cross_encoding: bool
614
    supports_late_interaction: bool
615
    supports_multimodal: bool
616
    supports_multimodal_raw_input_only: bool
Patrick von Platen's avatar
Patrick von Platen committed
617
    requires_raw_input_tokens: bool
618
    supports_multimodal_encoder_tp_data: bool
619
    supports_pp: bool
620
621
    has_inner_state: bool
    is_attention_free: bool
622
    is_hybrid: bool
623
    has_noops: bool
624
    supports_mamba_prefix_caching: bool
625
    supports_transcription: bool
626
    supports_transcription_only: bool
627
628

    @staticmethod
629
    def from_model_cls(model: type[nn.Module]) -> "_ModelInfo":
630
        return _ModelInfo(
631
            architecture=model.__name__,
632
            is_text_generation_model=is_text_generation_model(model),
633
            is_pooling_model=is_pooling_model(model),
634
635
            default_seq_pooling_type=get_default_seq_pooling_type(model),
            default_tok_pooling_type=get_default_tok_pooling_type(model),
636
            attn_type=get_attn_type(model),
637
            supports_cross_encoding=supports_cross_encoding(model),
638
            supports_late_interaction=supports_late_interaction(model),
639
            supports_multimodal=supports_multimodal(model),
640
641
642
            supports_multimodal_raw_input_only=supports_multimodal_raw_input_only(
                model
            ),
Patrick von Platen's avatar
Patrick von Platen committed
643
            requires_raw_input_tokens=requires_raw_input_tokens(model),
644
645
646
            supports_multimodal_encoder_tp_data=supports_multimodal_encoder_tp_data(
                model
            ),
647
            supports_pp=supports_pp(model),
648
649
            has_inner_state=has_inner_state(model),
            is_attention_free=is_attention_free(model),
650
            is_hybrid=is_hybrid(model),
651
            supports_mamba_prefix_caching=supports_mamba_prefix_caching(model),
652
            supports_transcription=supports_transcription(model),
653
654
655
            supports_transcription_only=(
                supports_transcription(model) and model.supports_transcription_only
            ),
656
            has_noops=has_noops(model),
657
        )
658
659


660
661
662
663
class _BaseRegisteredModel(ABC):
    @abstractmethod
    def inspect_model_cls(self) -> _ModelInfo:
        raise NotImplementedError
664

665
    @abstractmethod
666
    def load_model_cls(self) -> type[nn.Module]:
667
        raise NotImplementedError
668
669


670
671
672
673
674
675
676
@dataclass(frozen=True)
class _RegisteredModel(_BaseRegisteredModel):
    """
    Represents a model that has already been imported in the main process.
    """

    interfaces: _ModelInfo
677
    model_cls: type[nn.Module]
678
679

    @staticmethod
680
    def from_model_cls(model_cls: type[nn.Module]):
681
682
683
684
685
686
687
688
        return _RegisteredModel(
            interfaces=_ModelInfo.from_model_cls(model_cls),
            model_cls=model_cls,
        )

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

689
    def load_model_cls(self) -> type[nn.Module]:
690
691
692
693
694
695
696
697
        return self.model_cls


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

699
700
701
    module_name: str
    class_name: str

702
703
704
705
706
707
708
709
    @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"

710
    def _load_modelinfo_from_cache(self, module_hash: str) -> _ModelInfo | None:
711
712
        try:
            try:
713
                modelinfo_path = self._get_cache_dir() / self._get_cache_filename()
714
715
716
                with open(modelinfo_path, encoding="utf-8") as file:
                    mi_dict = json.load(file)
            except FileNotFoundError:
717
                logger.debug(
718
                    "Cached model info file for class %s.%s not found",
719
720
721
                    self.module_name,
                    self.class_name,
                )
722
723
724
                return None

            if mi_dict["hash"] != module_hash:
725
                logger.debug(
726
                    "Cached model info file for class %s.%s is stale",
727
728
729
                    self.module_name,
                    self.class_name,
                )
730
731
732
733
734
                return None

            # file not changed, use cached _ModelInfo properties
            return _ModelInfo(**mi_dict["modelinfo"])
        except Exception:
735
            logger.debug(
736
                "Cached model info for class %s.%s error. ",
737
738
739
                self.module_name,
                self.class_name,
            )
740
741
            return None

742
    def _save_modelinfo_to_cache(self, mi: _ModelInfo, module_hash: str) -> None:
743
744
        """save dictionary json file to cache"""
        from vllm.model_executor.model_loader.weight_utils import atomic_writer
745

746
747
748
749
750
751
752
753
        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()
754
            with atomic_writer(modelinfo_path, encoding="utf-8") as f:
755
756
757
758
759
                json.dump(modelinfo_dict, f, indent=2)
        except Exception:
            logger.exception("Error saving model info cache.")

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

764
765
        if model_path.exists():
            with open(model_path, "rb") as f:
766
                module_hash = safe_hash(f.read(), usedforsecurity=False).hexdigest()
767
768
769

            mi = self._load_modelinfo_from_cache(module_hash)
            if mi is not None:
770
                logger.debug(
771
                    "Loaded model info for class %s.%s from cache",
772
773
774
                    self.module_name,
                    self.class_name,
                )
775
776
                return mi
            else:
777
                logger.debug(
778
                    "Cache model info for class %s.%s miss. Loading model instead.",
779
780
781
                    self.module_name,
                    self.class_name,
                )
782
783
784

        # Performed in another process to avoid initializing CUDA
        mi = _run_in_subprocess(
785
786
787
788
789
            lambda: _ModelInfo.from_model_cls(self.load_model_cls())
        )
        logger.debug(
            "Loaded model info for class %s.%s", self.module_name, self.class_name
        )
790
791

        # save cache file
792
793
        if module_hash is not None:
            self._save_modelinfo_to_cache(mi, module_hash)
794
795

        return mi
796

797
    def load_model_cls(self) -> type[nn.Module]:
798
799
800
801
802
803
804
805
        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,
806
) -> type[nn.Module] | None:
807
    from vllm.platforms import current_platform
808

809
    current_platform.verify_model_arch(model_arch)
810
811
812
    try:
        return model.load_model_cls()
    except Exception:
813
        logger.exception("Error in loading model architecture '%s'", model_arch)
814
        return None
815
816


817
818
819
820
@lru_cache(maxsize=128)
def _try_inspect_model_cls(
    model_arch: str,
    model: _BaseRegisteredModel,
821
) -> _ModelInfo | None:
822
823
824
    try:
        return model.inspect_model_cls()
    except Exception:
825
        logger.exception("Error in inspecting model architecture '%s'", model_arch)
826
        return None
827
828


829
830
831
@dataclass
class _ModelRegistry:
    # Keyed by model_arch
832
    models: dict[str, _BaseRegisteredModel] = field(default_factory=dict)
833

834
    def get_supported_archs(self) -> Set[str]:
835
        return self.models.keys()
836

837
838
839
    def register_model(
        self,
        model_arch: str,
840
        model_cls: type[nn.Module] | str,
841
    ) -> None:
842
843
844
        """
        Register an external model to be used in vLLM.

845
        `model_cls` can be either:
846

847
        - A [`torch.nn.Module`][] class directly referencing the model.
848
        - A string in the format `<module>:<class>` which can be used to
849
850
          lazily import the model. This is useful to avoid initializing CUDA
          when importing the model and thus the related error
851
          `RuntimeError: Cannot re-initialize CUDA in forked subprocess`.
852
        """
853
854
855
856
        if not isinstance(model_arch, str):
            msg = f"`model_arch` should be a string, not a {type(model_arch)}"
            raise TypeError(msg)

857
        if model_arch in self.models:
858
859
            logger.warning(
                "Model architecture %s is already registered, and will be "
860
861
862
863
                "overwritten by the new model class %s.",
                model_arch,
                model_cls,
            )
864
865
866
867
868
869

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

871
            model = _LazyRegisteredModel(*split_str)
872
        elif isinstance(model_cls, type) and issubclass(model_cls, nn.Module):
873
            model = _RegisteredModel.from_model_cls(model_cls)
874
        else:
875
876
877
878
            msg = (
                "`model_cls` should be a string or PyTorch model class, "
                f"not a {type(model_arch)}"
            )
879
            raise TypeError(msg)
880

881
        self.models[model_arch] = model
882

883
    def _raise_for_unsupported(self, architectures: list[str]):
884
        all_supported_archs = self.get_supported_archs()
885

886
887
888
        if any(arch in all_supported_archs for arch in architectures):
            raise ValueError(
                f"Model architectures {architectures} failed "
889
890
                "to be inspected. Please check the logs for more details."
            )
891

892
893
894
895
896
897
898
899
        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 "
900
901
                    "use this model architecture."
                )
902

903
904
        raise ValueError(
            f"Model architectures {architectures} are not supported for now. "
905
906
            f"Supported architectures: {all_supported_archs}"
        )
907

908
    def _try_load_model_cls(self, model_arch: str) -> type[nn.Module] | None:
909
910
        if model_arch not in self.models:
            return None
911

912
        return _try_load_model_cls(model_arch, self.models[model_arch])
913

914
    def _try_inspect_model_cls(self, model_arch: str) -> _ModelInfo | None:
915
916
        if model_arch not in self.models:
            return None
917

918
919
920
921
922
923
        return _try_inspect_model_cls(model_arch, self.models[model_arch])

    def _try_resolve_transformers(
        self,
        architecture: str,
        model_config: ModelConfig,
924
    ) -> str | None:
925
926
927
        if architecture in _TRANSFORMERS_BACKEND_MODELS:
            return architecture

928
929
930
        auto_map: dict[str, str] = (
            getattr(model_config.hf_config, "auto_map", None) or dict()
        )
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946

        # 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,
947
                        trust_remote_code=model_config.trust_remote_code,
948
949
950
951
952
953
954
955
956
957
958
959
                        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,
960
                        trust_remote_code=model_config.trust_remote_code,
961
962
963
964
965
                        warn_on_fail=True,
                    )
                    if model_module is not None:
                        break
            else:
966
                if model_config.model_impl != "transformers":
967
968
969
970
971
972
973
                    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 "
974
975
                    "'auto_map' (relevant if the model is custom)."
                )
976
977

        if not model_module.is_backend_compatible():
978
            if model_config.model_impl != "transformers":
979
                return None
980

981
982
            raise ValueError(
                f"The Transformers implementation of {architecture!r} "
983
984
                "is not compatible with vLLM."
            )
985

986
        return model_config._get_transformers_backend_cls()
987

988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
    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
1013

1014
1015
    def inspect_model_cls(
        self,
1016
        architectures: str | list[str],
1017
        model_config: ModelConfig,
1018
    ) -> tuple[_ModelInfo, str]:
1019
1020
        if isinstance(architectures, str):
            architectures = [architectures]
1021
1022
        if not architectures:
            raise ValueError("No model architectures are specified")
1023
1024

        # Require transformers impl
1025
        if model_config.model_impl == "transformers":
1026
            arch = self._try_resolve_transformers(architectures[0], model_config)
1027
1028
1029
1030
            if arch is not None:
                model_info = self._try_inspect_model_cls(arch)
                if model_info is not None:
                    return (model_info, arch)
1031
        elif model_config.model_impl == "terratorch":
1032
1033
            model_info = self._try_inspect_model_cls("Terratorch")
            return (model_info, "Terratorch")
1034

1035
        # Fallback to transformers impl (after resolving convert_type)
1036
1037
1038
1039
1040
1041
        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)
1042
1043
1044
1045
1046
1047
1048
            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)
1049
            model_info = self._try_inspect_model_cls(normalized_arch)
1050
            if model_info is not None:
1051
                return (model_info, arch)
1052

1053
        # Fallback to transformers impl (before resolving runner_type)
1054
1055
1056
1057
1058
        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)
1059
1060
1061
1062
1063
            if arch is not None:
                model_info = self._try_inspect_model_cls(arch)
                if model_info is not None:
                    return (model_info, arch)

1064
        return self._raise_for_unsupported(architectures)
1065

1066
1067
    def resolve_model_cls(
        self,
1068
        architectures: str | list[str],
1069
        model_config: ModelConfig,
1070
    ) -> tuple[type[nn.Module], str]:
1071
1072
        if isinstance(architectures, str):
            architectures = [architectures]
1073
1074
        if not architectures:
            raise ValueError("No model architectures are specified")
1075
1076

        # Require transformers impl
1077
        if model_config.model_impl == "transformers":
1078
            arch = self._try_resolve_transformers(architectures[0], model_config)
1079
1080
1081
1082
            if arch is not None:
                model_cls = self._try_load_model_cls(arch)
                if model_cls is not None:
                    return (model_cls, arch)
1083
        elif model_config.model_impl == "terratorch":
1084
1085
1086
1087
            arch = "Terratorch"
            model_cls = self._try_load_model_cls(arch)
            if model_cls is not None:
                return (model_cls, arch)
1088

1089
        # Fallback to transformers impl (after resolving convert_type)
1090
1091
1092
1093
1094
1095
        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)
1096
1097
1098
1099
1100
1101
1102
            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)
1103
            model_cls = self._try_load_model_cls(normalized_arch)
1104
1105
            if model_cls is not None:
                return (model_cls, arch)
1106

1107
        # Fallback to transformers impl (before resolving runner_type)
1108
1109
1110
1111
1112
        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)
1113
1114
1115
1116
1117
            if arch is not None:
                model_cls = self._try_load_model_cls(arch)
                if model_cls is not None:
                    return (model_cls, arch)

1118
        return self._raise_for_unsupported(architectures)
1119

1120
1121
    def is_text_generation_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.is_text_generation_model
1127

1128
    def is_pooling_model(
1129
        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.is_pooling_model
1135

1136
1137
    def is_cross_encoder_model(
        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_cross_encoding
1143

1144
1145
    def is_multimodal_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_multimodal
1151

1152
    def is_multimodal_raw_input_only_model(
1153
        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.supports_multimodal_raw_input_only
1159

1160
1161
    def is_pp_supported_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.supports_pp
1167

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

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

1184
1185
    def is_hybrid_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.is_hybrid

1192
1193
    def is_noops_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.has_noops

1200
1201
    def is_transcription_model(
        self,
1202
        architectures: str | list[str],
1203
        model_config: ModelConfig,
1204
    ) -> bool:
1205
        model_cls, _ = self.inspect_model_cls(architectures, model_config)
1206
1207
        return model_cls.supports_transcription

1208
1209
    def is_transcription_only_model(
        self,
1210
        architectures: str | list[str],
1211
        model_config: ModelConfig,
1212
    ) -> bool:
1213
        model_cls, _ = self.inspect_model_cls(architectures, model_config)
1214
1215
        return model_cls.supports_transcription_only

1216

1217
1218
1219
1220
1221
1222
1223
1224
1225
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()
    }
)
1226
1227
1228
1229
1230

_T = TypeVar("_T")


def _run_in_subprocess(fn: Callable[[], _T]) -> _T:
1231
1232
1233
1234
1235
    # 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")

1236
        # `cloudpickle` allows pickling lambda functions directly
1237
        import cloudpickle
1238

1239
        input_bytes = cloudpickle.dumps((fn, output_filepath))
1240
1241
1242

        # cannot use `sys.executable __file__` here because the script
        # contains relative imports
1243
1244
1245
        returned = subprocess.run(
            _SUBPROCESS_COMMAND, input=input_bytes, capture_output=True
        )
1246
1247
1248
1249
1250
1251

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

1256
        with open(output_filepath, "rb") as f:
1257
1258
1259
1260
1261
1262
            return pickle.load(f)


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

1264
1265
1266
1267
1268
    load_general_plugins()

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

    result = fn()
1269
1270
1271

    with open(output_file, "wb") as f:
        f.write(pickle.dumps(result))
1272
1273
1274


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