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

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

import torch.nn as nn
23
import transformers
24

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

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


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

logger = init_logger(__name__)

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

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

280
281
_CROSS_ENCODER_MODELS = {
    "BertForSequenceClassification": ("bert", "BertForSequenceClassification"),
282
    "BertForTokenClassification": ("bert", "BertForTokenClassification"),
283
284
285
286
    "GteNewForSequenceClassification": (
        "bert_with_rope",
        "GteNewForSequenceClassification",
    ),
287
288
289
290
    "JinaVLForRanking": ("jina_vl", "JinaVLForSequenceClassification"),
    "LlamaBidirectionalForSequenceClassification": (
        "llama",
        "LlamaBidirectionalForSequenceClassification",
291
292
293
294
    ),
    "LlamaNemotronVLForSequenceClassification": (
        "nemotron_vl",
        "LlamaNemotronVLForSequenceClassification",
295
    ),
296
297
298
299
    "ModernBertForSequenceClassification": (
        "modernbert",
        "ModernBertForSequenceClassification",
    ),
300
301
302
303
    "ModernBertForTokenClassification": (
        "modernbert",
        "ModernBertForTokenClassification",
    ),
304
305
306
307
308
    "RobertaForSequenceClassification": ("roberta", "RobertaForSequenceClassification"),
    "XLMRobertaForSequenceClassification": (
        "roberta",
        "RobertaForSequenceClassification",
    ),
309
310
}

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

_SPECULATIVE_DECODING_MODELS = {
528
    "ExtractHiddenStatesModel": ("extract_hidden_states", "ExtractHiddenStatesModel"),
529
    "MiMoMTPModel": ("mimo_mtp", "MiMoMTP"),
530
    "EagleLlamaForCausalLM": ("llama_eagle", "EagleLlamaForCausalLM"),
zhiweiz's avatar
zhiweiz committed
531
    "EagleLlama4ForCausalLM": ("llama4_eagle", "EagleLlama4ForCausalLM"),
532
    "EagleMiniCPMForCausalLM": ("minicpm_eagle", "EagleMiniCPMForCausalLM"),
533
    "Eagle3LlamaForCausalLM": ("llama_eagle3", "Eagle3LlamaForCausalLM"),
534
    "LlamaForCausalLMEagle3": ("llama_eagle3", "Eagle3LlamaForCausalLM"),
535
    "Eagle3Qwen2_5vlForCausalLM": ("llama_eagle3", "Eagle3LlamaForCausalLM"),
536
    "Eagle3Qwen3vlForCausalLM": ("llama_eagle3", "Eagle3LlamaForCausalLM"),
537
538
539
540
    "EagleMistralLarge3ForCausalLM": (
        "mistral_large_3_eagle",
        "EagleMistralLarge3ForCausalLM",
    ),
541
    "EagleDeepSeekMTPModel": ("deepseek_eagle", "EagleDeepseekV3ForCausalLM"),
542
    "DeepSeekMTPModel": ("deepseek_mtp", "DeepSeekMTP"),
543
    "ErnieMTPModel": ("ernie_mtp", "ErnieMTP"),
Kyungmin Lee's avatar
Kyungmin Lee committed
544
    "ExaoneMoeMTP": ("exaone_moe_mtp", "ExaoneMoeMTP"),
545
    "NemotronHMTPModel": ("nemotron_h_mtp", "NemotronHMTP"),
XuruiYang's avatar
XuruiYang committed
546
    "LongCatFlashMTPModel": ("longcat_flash_mtp", "LongCatFlashMTP"),
Yuxuan Zhang's avatar
Yuxuan Zhang committed
547
    "Glm4MoeMTPModel": ("glm4_moe_mtp", "Glm4MoeMTP"),
548
    "Glm4MoeLiteMTPModel": ("glm4_moe_lite_mtp", "Glm4MoeLiteMTP"),
549
    "GlmOcrMTPModel": ("glm_ocr_mtp", "GlmOcrMTP"),
550
    "MedusaModel": ("medusa", "Medusa"),
551
    "OpenPanguMTPModel": ("openpangu_mtp", "OpenPanguMTP"),
552
    "Qwen3NextMTP": ("qwen3_next_mtp", "Qwen3NextMTP"),
csy0225's avatar
csy0225 committed
553
    "Step3p5MTP": ("step3p5_mtp", "Step3p5MTP"),
554
555
    "Qwen3_5MTP": ("qwen3_5_mtp", "Qwen3_5MTP"),
    "Qwen3_5MoeMTP": ("qwen3_5_mtp", "Qwen3_5MoeMTP"),
556
557
558
    # Temporarily disabled.
    # # TODO(woosuk): Re-enable this once the MLP Speculator is supported in V1.
    # "MLPSpeculatorPreTrainedModel": ("mlp_speculator", "MLPSpeculator"),
559
}
560

561
_TRANSFORMERS_SUPPORTED_MODELS = {
562
563
564
    # Text generation models
    "SmolLM3ForCausalLM": ("transformers", "TransformersForCausalLM"),
    # Multimodal models
565
566
567
568
    "Emu3ForConditionalGeneration": (
        "transformers",
        "TransformersMultiModalForCausalLM",
    ),
569
570
571
}

_TRANSFORMERS_BACKEND_MODELS = {
572
    # Text generation models
573
    "TransformersForCausalLM": ("transformers", "TransformersForCausalLM"),
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
    "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
592
    "TransformersForSequenceClassification": (
593
        "transformers",
594
        "TransformersForSequenceClassification",
595
    ),
596
    "TransformersMoEForSequenceClassification": (
597
        "transformers",
598
        "TransformersMoEForSequenceClassification",
599
    ),
600
601
602
    "TransformersMultiModalForSequenceClassification": (
        "transformers",
        "TransformersMultiModalForSequenceClassification",
603
    ),
604
}
605

606
_VLLM_MODELS = {
607
    **_TEXT_GENERATION_MODELS,
608
    **_EMBEDDING_MODELS,
609
    **_CROSS_ENCODER_MODELS,
610
    **_MULTIMODAL_MODELS,
611
    **_SPECULATIVE_DECODING_MODELS,
612
613
    **_TRANSFORMERS_SUPPORTED_MODELS,
    **_TRANSFORMERS_BACKEND_MODELS,
614
615
}

616
617
618
619
# 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.
620
_SUBPROCESS_COMMAND = [sys.executable, "-m", "vllm.model_executor.models.registry"]
621

622
_PREVIOUSLY_SUPPORTED_MODELS = {
623
    "MotifForCausalLM": "0.10.2",
624
    "Phi3SmallForCausalLM": "0.9.2",
625
    "Phi4FlashForCausalLM": "0.10.2",
626
    "Phi4MultimodalForCausalLM": "0.12.0",
627
628
629
630
631
632
633
634
635
    # 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",
}
636

637

638
639
@dataclass(frozen=True)
class _ModelInfo:
640
    architecture: str
641
    is_text_generation_model: bool
642
    is_pooling_model: bool
643
    attn_type: AttnTypeStr
644
645
    default_seq_pooling_type: SequencePoolingType
    default_tok_pooling_type: TokenPoolingType
646
    supports_cross_encoding: bool
647
    supports_late_interaction: bool
648
    supports_multimodal: bool
649
    supports_multimodal_raw_input_only: bool
Patrick von Platen's avatar
Patrick von Platen committed
650
    requires_raw_input_tokens: bool
651
    supports_multimodal_encoder_tp_data: bool
652
    supports_pp: bool
653
654
    has_inner_state: bool
    is_attention_free: bool
655
    is_hybrid: bool
656
    has_noops: bool
657
    supports_mamba_prefix_caching: bool
658
    supports_transcription: bool
659
    supports_transcription_only: bool
660
661

    @staticmethod
662
    def from_model_cls(model: type[nn.Module]) -> "_ModelInfo":
663
        return _ModelInfo(
664
            architecture=model.__name__,
665
            is_text_generation_model=is_text_generation_model(model),
666
            is_pooling_model=is_pooling_model(model),
667
668
            default_seq_pooling_type=get_default_seq_pooling_type(model),
            default_tok_pooling_type=get_default_tok_pooling_type(model),
669
            attn_type=get_attn_type(model),
670
            supports_cross_encoding=supports_cross_encoding(model),
671
            supports_late_interaction=supports_late_interaction(model),
672
            supports_multimodal=supports_multimodal(model),
673
674
675
            supports_multimodal_raw_input_only=supports_multimodal_raw_input_only(
                model
            ),
Patrick von Platen's avatar
Patrick von Platen committed
676
            requires_raw_input_tokens=requires_raw_input_tokens(model),
677
678
679
            supports_multimodal_encoder_tp_data=supports_multimodal_encoder_tp_data(
                model
            ),
680
            supports_pp=supports_pp(model),
681
682
            has_inner_state=has_inner_state(model),
            is_attention_free=is_attention_free(model),
683
            is_hybrid=is_hybrid(model),
684
            supports_mamba_prefix_caching=supports_mamba_prefix_caching(model),
685
            supports_transcription=supports_transcription(model),
686
687
688
            supports_transcription_only=(
                supports_transcription(model) and model.supports_transcription_only
            ),
689
            has_noops=has_noops(model),
690
        )
691
692


693
694
695
696
class _BaseRegisteredModel(ABC):
    @abstractmethod
    def inspect_model_cls(self) -> _ModelInfo:
        raise NotImplementedError
697

698
    @abstractmethod
699
    def load_model_cls(self) -> type[nn.Module]:
700
        raise NotImplementedError
701
702


703
704
705
706
707
708
709
@dataclass(frozen=True)
class _RegisteredModel(_BaseRegisteredModel):
    """
    Represents a model that has already been imported in the main process.
    """

    interfaces: _ModelInfo
710
    model_cls: type[nn.Module]
711
712

    @staticmethod
713
    def from_model_cls(model_cls: type[nn.Module]):
714
715
716
717
718
719
720
721
        return _RegisteredModel(
            interfaces=_ModelInfo.from_model_cls(model_cls),
            model_cls=model_cls,
        )

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

722
    def load_model_cls(self) -> type[nn.Module]:
723
724
725
726
727
728
729
730
        return self.model_cls


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

732
733
734
    module_name: str
    class_name: str

735
736
737
738
739
740
741
742
    @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"

743
    def _load_modelinfo_from_cache(self, module_hash: str) -> _ModelInfo | None:
744
745
        try:
            try:
746
                modelinfo_path = self._get_cache_dir() / self._get_cache_filename()
747
748
749
                with open(modelinfo_path, encoding="utf-8") as file:
                    mi_dict = json.load(file)
            except FileNotFoundError:
750
                logger.debug(
751
                    "Cached model info file for class %s.%s not found",
752
753
754
                    self.module_name,
                    self.class_name,
                )
755
756
757
                return None

            if mi_dict["hash"] != module_hash:
758
                logger.debug(
759
                    "Cached model info file for class %s.%s is stale",
760
761
762
                    self.module_name,
                    self.class_name,
                )
763
764
765
766
767
                return None

            # file not changed, use cached _ModelInfo properties
            return _ModelInfo(**mi_dict["modelinfo"])
        except Exception:
768
            logger.debug(
769
                "Cached model info for class %s.%s error. ",
770
771
772
                self.module_name,
                self.class_name,
            )
773
774
            return None

775
    def _save_modelinfo_to_cache(self, mi: _ModelInfo, module_hash: str) -> None:
776
777
        """save dictionary json file to cache"""
        from vllm.model_executor.model_loader.weight_utils import atomic_writer
778

779
780
781
782
783
784
785
786
        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()
787
            with atomic_writer(modelinfo_path, encoding="utf-8") as f:
788
789
790
791
792
                json.dump(modelinfo_dict, f, indent=2)
        except Exception:
            logger.exception("Error saving model info cache.")

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

797
798
        if model_path.exists():
            with open(model_path, "rb") as f:
799
                module_hash = safe_hash(f.read(), usedforsecurity=False).hexdigest()
800
801
802

            mi = self._load_modelinfo_from_cache(module_hash)
            if mi is not None:
803
                logger.debug(
804
                    "Loaded model info for class %s.%s from cache",
805
806
807
                    self.module_name,
                    self.class_name,
                )
808
809
                return mi
            else:
810
                logger.debug(
811
                    "Cache model info for class %s.%s miss. Loading model instead.",
812
813
814
                    self.module_name,
                    self.class_name,
                )
815
816
817

        # Performed in another process to avoid initializing CUDA
        mi = _run_in_subprocess(
818
819
820
821
822
            lambda: _ModelInfo.from_model_cls(self.load_model_cls())
        )
        logger.debug(
            "Loaded model info for class %s.%s", self.module_name, self.class_name
        )
823
824

        # save cache file
825
826
        if module_hash is not None:
            self._save_modelinfo_to_cache(mi, module_hash)
827
828

        return mi
829

830
    def load_model_cls(self) -> type[nn.Module]:
831
832
833
834
835
836
837
838
        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,
839
) -> type[nn.Module] | None:
840
    from vllm.platforms import current_platform
841

842
    current_platform.verify_model_arch(model_arch)
843
844
845
    try:
        return model.load_model_cls()
    except Exception:
846
        logger.exception("Error in loading model architecture '%s'", model_arch)
847
        return None
848
849


850
851
852
853
@lru_cache(maxsize=128)
def _try_inspect_model_cls(
    model_arch: str,
    model: _BaseRegisteredModel,
854
) -> _ModelInfo | None:
855
856
857
    try:
        return model.inspect_model_cls()
    except Exception:
858
        logger.exception("Error in inspecting model architecture '%s'", model_arch)
859
        return None
860
861


862
863
864
@dataclass
class _ModelRegistry:
    # Keyed by model_arch
865
    models: dict[str, _BaseRegisteredModel] = field(default_factory=dict)
866

867
    def get_supported_archs(self) -> Set[str]:
868
        return self.models.keys()
869

870
871
872
    def register_model(
        self,
        model_arch: str,
873
        model_cls: type[nn.Module] | str,
874
    ) -> None:
875
876
877
        """
        Register an external model to be used in vLLM.

878
        `model_cls` can be either:
879

880
        - A [`torch.nn.Module`][] class directly referencing the model.
881
        - A string in the format `<module>:<class>` which can be used to
882
883
          lazily import the model. This is useful to avoid initializing CUDA
          when importing the model and thus the related error
884
          `RuntimeError: Cannot re-initialize CUDA in forked subprocess`.
885
        """
886
887
888
889
        if not isinstance(model_arch, str):
            msg = f"`model_arch` should be a string, not a {type(model_arch)}"
            raise TypeError(msg)

890
        if model_arch in self.models:
891
892
            logger.warning(
                "Model architecture %s is already registered, and will be "
893
894
895
896
                "overwritten by the new model class %s.",
                model_arch,
                model_cls,
            )
897
898
899
900
901
902

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

904
            model = _LazyRegisteredModel(*split_str)
905
        elif isinstance(model_cls, type) and issubclass(model_cls, nn.Module):
906
            model = _RegisteredModel.from_model_cls(model_cls)
907
        else:
908
909
910
911
            msg = (
                "`model_cls` should be a string or PyTorch model class, "
                f"not a {type(model_arch)}"
            )
912
            raise TypeError(msg)
913

914
        self.models[model_arch] = model
915

916
    def _raise_for_unsupported(self, architectures: list[str]):
917
        all_supported_archs = self.get_supported_archs()
918

919
920
921
        if any(arch in all_supported_archs for arch in architectures):
            raise ValueError(
                f"Model architectures {architectures} failed "
922
923
                "to be inspected. Please check the logs for more details."
            )
924

925
926
927
928
929
930
931
932
        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 "
933
934
                    "use this model architecture."
                )
935

936
937
        raise ValueError(
            f"Model architectures {architectures} are not supported for now. "
938
939
            f"Supported architectures: {all_supported_archs}"
        )
940

941
    def _try_load_model_cls(self, model_arch: str) -> type[nn.Module] | None:
942
943
        if model_arch not in self.models:
            return None
944

945
        return _try_load_model_cls(model_arch, self.models[model_arch])
946

947
    def _try_inspect_model_cls(self, model_arch: str) -> _ModelInfo | None:
948
949
        if model_arch not in self.models:
            return None
950

951
952
953
954
955
956
        return _try_inspect_model_cls(model_arch, self.models[model_arch])

    def _try_resolve_transformers(
        self,
        architecture: str,
        model_config: ModelConfig,
957
    ) -> str | None:
958
959
960
        if architecture in _TRANSFORMERS_BACKEND_MODELS:
            return architecture

961
962
963
        auto_map: dict[str, str] = (
            getattr(model_config.hf_config, "auto_map", None) or dict()
        )
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979

        # 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,
980
                        trust_remote_code=model_config.trust_remote_code,
981
982
983
984
985
986
987
988
989
990
991
992
                        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,
993
                        trust_remote_code=model_config.trust_remote_code,
994
995
996
997
998
                        warn_on_fail=True,
                    )
                    if model_module is not None:
                        break
            else:
999
                if model_config.model_impl != "transformers":
1000
1001
1002
1003
1004
1005
1006
                    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 "
1007
1008
                    "'auto_map' (relevant if the model is custom)."
                )
1009
1010

        if not model_module.is_backend_compatible():
1011
            if model_config.model_impl != "transformers":
1012
                return None
1013

1014
1015
            raise ValueError(
                f"The Transformers implementation of {architecture!r} "
1016
1017
                "is not compatible with vLLM."
            )
1018

1019
        return model_config._get_transformers_backend_cls()
1020

1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
    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
1046

1047
1048
    def inspect_model_cls(
        self,
1049
        architectures: str | list[str],
1050
        model_config: ModelConfig,
1051
    ) -> tuple[_ModelInfo, str]:
1052
1053
        if isinstance(architectures, str):
            architectures = [architectures]
1054
1055
        if not architectures:
            raise ValueError("No model architectures are specified")
1056
1057

        # Require transformers impl
1058
        if model_config.model_impl == "transformers":
1059
            arch = self._try_resolve_transformers(architectures[0], model_config)
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
        elif model_config.model_impl == "terratorch":
1065
1066
            model_info = self._try_inspect_model_cls("Terratorch")
            return (model_info, "Terratorch")
1067

1068
        # Fallback to transformers impl (after resolving convert_type)
1069
1070
1071
1072
1073
1074
        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)
1075
1076
1077
1078
1079
1080
1081
            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)
1082
            model_info = self._try_inspect_model_cls(normalized_arch)
1083
            if model_info is not None:
1084
                return (model_info, arch)
1085

1086
        # Fallback to transformers impl (before resolving runner_type)
1087
1088
1089
1090
1091
        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)
1092
1093
1094
1095
1096
            if arch is not None:
                model_info = self._try_inspect_model_cls(arch)
                if model_info is not None:
                    return (model_info, arch)

1097
        return self._raise_for_unsupported(architectures)
1098

1099
1100
    def resolve_model_cls(
        self,
1101
        architectures: str | list[str],
1102
        model_config: ModelConfig,
1103
    ) -> tuple[type[nn.Module], str]:
1104
1105
        if isinstance(architectures, str):
            architectures = [architectures]
1106
1107
        if not architectures:
            raise ValueError("No model architectures are specified")
1108
1109

        # Require transformers impl
1110
        if model_config.model_impl == "transformers":
1111
            arch = self._try_resolve_transformers(architectures[0], model_config)
1112
1113
1114
1115
            if arch is not None:
                model_cls = self._try_load_model_cls(arch)
                if model_cls is not None:
                    return (model_cls, arch)
1116
        elif model_config.model_impl == "terratorch":
1117
1118
1119
1120
            arch = "Terratorch"
            model_cls = self._try_load_model_cls(arch)
            if model_cls is not None:
                return (model_cls, arch)
1121

1122
        # Fallback to transformers impl (after resolving convert_type)
1123
1124
1125
1126
1127
1128
        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)
1129
1130
1131
1132
1133
1134
1135
            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)
1136
            model_cls = self._try_load_model_cls(normalized_arch)
1137
1138
            if model_cls is not None:
                return (model_cls, arch)
1139

1140
        # Fallback to transformers impl (before resolving runner_type)
1141
1142
1143
1144
1145
        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)
1146
1147
1148
1149
1150
            if arch is not None:
                model_cls = self._try_load_model_cls(arch)
                if model_cls is not None:
                    return (model_cls, arch)

1151
        return self._raise_for_unsupported(architectures)
1152

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

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

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

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

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

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

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

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

1217
1218
    def is_hybrid_model(
        self,
1219
        architectures: str | list[str],
1220
        model_config: ModelConfig,
1221
    ) -> bool:
1222
        model_cls, _ = self.inspect_model_cls(architectures, model_config)
1223
1224
        return model_cls.is_hybrid

1225
1226
    def is_noops_model(
        self,
1227
        architectures: str | list[str],
1228
        model_config: ModelConfig,
1229
    ) -> bool:
1230
        model_cls, _ = self.inspect_model_cls(architectures, model_config)
1231
1232
        return model_cls.has_noops

1233
1234
    def is_transcription_model(
        self,
1235
        architectures: str | list[str],
1236
        model_config: ModelConfig,
1237
    ) -> bool:
1238
        model_cls, _ = self.inspect_model_cls(architectures, model_config)
1239
1240
        return model_cls.supports_transcription

1241
1242
    def is_transcription_only_model(
        self,
1243
        architectures: str | list[str],
1244
        model_config: ModelConfig,
1245
    ) -> bool:
1246
        model_cls, _ = self.inspect_model_cls(architectures, model_config)
1247
1248
        return model_cls.supports_transcription_only

1249

1250
1251
1252
1253
1254
1255
1256
1257
1258
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()
    }
)
1259
1260
1261
1262
1263

_T = TypeVar("_T")


def _run_in_subprocess(fn: Callable[[], _T]) -> _T:
1264
1265
1266
1267
1268
    # 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")

1269
        # `cloudpickle` allows pickling lambda functions directly
1270
        import cloudpickle
1271

1272
        input_bytes = cloudpickle.dumps((fn, output_filepath))
1273
1274
1275

        # cannot use `sys.executable __file__` here because the script
        # contains relative imports
1276
1277
1278
        returned = subprocess.run(
            _SUBPROCESS_COMMAND, input=input_bytes, capture_output=True
        )
1279
1280
1281
1282
1283
1284

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

1289
        with open(output_filepath, "rb") as f:
1290
1291
1292
1293
1294
1295
            return pickle.load(f)


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

1297
1298
1299
1300
1301
    load_general_plugins()

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

    result = fn()
1302
1303
1304

    with open(output_file, "wb") as f:
        f.write(pickle.dumps(result))
1305
1306
1307


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