registry.py 53.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.tasks import ScoreType
34
from vllm.transformers_utils.dynamic_module import try_get_class_from_dynamic_module
35
from vllm.utils.hashing import safe_hash
36

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


46
47
48
49
50
from .interfaces import (
    has_inner_state,
    has_noops,
    is_attention_free,
    is_hybrid,
Patrick von Platen's avatar
Patrick von Platen committed
51
    requires_raw_input_tokens,
52
    supports_mamba_prefix_caching,
53
54
55
56
57
58
59
    supports_multimodal,
    supports_multimodal_encoder_tp_data,
    supports_multimodal_raw_input_only,
    supports_pp,
    supports_transcription,
)
from .interfaces_base import (
60
    get_attn_type,
61
62
    get_default_seq_pooling_type,
    get_default_tok_pooling_type,
63
    get_score_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
    "Gemma4ForCausalLM": ("gemma4", "Gemma4ForCausalLM"),
115
    "Qwen3NextForCausalLM": ("qwen3_next", "Qwen3NextForCausalLM"),
116
    "GlmForCausalLM": ("glm", "GlmForCausalLM"),
Yuxuan Zhang's avatar
Yuxuan Zhang committed
117
    "Glm4ForCausalLM": ("glm4", "Glm4ForCausalLM"),
Yuxuan Zhang's avatar
Yuxuan Zhang committed
118
    "Glm4MoeForCausalLM": ("glm4_moe", "Glm4MoeForCausalLM"),
119
    "Glm4MoeLiteForCausalLM": ("glm4_moe_lite", "Glm4MoeLiteForCausalLM"),
Jee Jee Li's avatar
Jee Jee Li committed
120
    "GlmMoeDsaForCausalLM": ("deepseek_v2", "GlmMoeDsaForCausalLM"),
121
    "GptOssForCausalLM": ("gpt_oss", "GptOssForCausalLM"),
122
123
124
125
126
127
    "GPT2LMHeadModel": ("gpt2", "GPT2LMHeadModel"),
    "GPTBigCodeForCausalLM": ("gpt_bigcode", "GPTBigCodeForCausalLM"),
    "GPTJForCausalLM": ("gpt_j", "GPTJForCausalLM"),
    "GPTNeoXForCausalLM": ("gpt_neox", "GPTNeoXForCausalLM"),
    "GraniteForCausalLM": ("granite", "GraniteForCausalLM"),
    "GraniteMoeForCausalLM": ("granitemoe", "GraniteMoeForCausalLM"),
128
129
    "GraniteMoeHybridForCausalLM": ("granitemoehybrid", "GraniteMoeHybridForCausalLM"),
    "GraniteMoeSharedForCausalLM": ("granitemoeshared", "GraniteMoeSharedForCausalLM"),
130
    "GritLM": ("gritlm", "GritLM"),
Bijaya Dangol's avatar
Bijaya Dangol committed
131
132
    "Grok1ModelForCausalLM": ("grok1", "GrokForCausalLM"),
    "Grok1ForCausalLM": ("grok1", "GrokForCausalLM"),
133
134
    "HunYuanMoEV1ForCausalLM": ("hunyuan_v1", "HunYuanMoEV1ForCausalLM"),
    "HunYuanDenseV1ForCausalLM": ("hunyuan_v1", "HunYuanDenseV1ForCausalLM"),
135
    "HCXVisionForCausalLM": ("hyperclovax_vision", "HCXVisionForCausalLM"),
136
    "HCXVisionV2ForCausalLM": ("hyperclovax_vision_v2", "HCXVisionV2ForCausalLM"),
137
    "HyperCLOVAXForCausalLM": ("hyperclovax", "HyperCLOVAXForCausalLM"),
138
139
    "InternLMForCausalLM": ("llama", "LlamaForCausalLM"),
    "InternLM2ForCausalLM": ("internlm2", "InternLM2ForCausalLM"),
140
    "InternLM2VEForCausalLM": ("internlm2_ve", "InternLM2VEForCausalLM"),
141
    "InternLM3ForCausalLM": ("llama", "LlamaForCausalLM"),
142
143
    "IQuestCoderForCausalLM": ("llama", "LlamaForCausalLM"),
    "IQuestLoopCoderForCausalLM": ("iquest_loopcoder", "IQuestLoopCoderForCausalLM"),
144
    "JAISLMHeadModel": ("jais", "JAISLMHeadModel"),
145
    "Jais2ForCausalLM": ("jais2", "Jais2ForCausalLM"),
146
    "JambaForCausalLM": ("jamba", "JambaForCausalLM"),
147
    "KimiLinearForCausalLM": ("kimi_linear", "KimiLinearForCausalLM"),
148
    "Lfm2ForCausalLM": ("lfm2", "Lfm2ForCausalLM"),
Paul Pak's avatar
Paul Pak committed
149
    "Lfm2MoeForCausalLM": ("lfm2_moe", "Lfm2MoeForCausalLM"),
150
    "LlamaForCausalLM": ("llama", "LlamaForCausalLM"),
151
    "Llama4ForCausalLM": ("llama4", "Llama4ForCausalLM"),
152
153
    # For decapoda-research/llama-*
    "LLaMAForCausalLM": ("llama", "LlamaForCausalLM"),
XuruiYang's avatar
XuruiYang committed
154
    "LongcatFlashForCausalLM": ("longcat_flash", "LongcatFlashForCausalLM"),
155
    "MambaForCausalLM": ("mamba", "MambaForCausalLM"),
156
    "Mamba2ForCausalLM": ("mamba2", "Mamba2ForCausalLM"),
157
158
    "MiniCPMForCausalLM": ("minicpm", "MiniCPMForCausalLM"),
    "MiniCPM3ForCausalLM": ("minicpm3", "MiniCPM3ForCausalLM"),
159
160
161
    "MiniMaxForCausalLM": ("minimax_text_01", "MiniMaxText01ForCausalLM"),
    "MiniMaxText01ForCausalLM": ("minimax_text_01", "MiniMaxText01ForCausalLM"),
    "MiniMaxM1ForCausalLM": ("minimax_text_01", "MiniMaxText01ForCausalLM"),
162
    "MiniMaxM2ForCausalLM": ("minimax_m2", "MiniMaxM2ForCausalLM"),
163
    "Ministral3ForCausalLM": ("mistral", "MistralForCausalLM"),
164
    "MistralForCausalLM": ("mistral", "MistralForCausalLM"),
165
    "MistralLarge3ForCausalLM": ("mistral_large_3", "MistralLarge3ForCausalLM"),
166
167
168
169
    "MixtralForCausalLM": ("mixtral", "MixtralForCausalLM"),
    # transformers's mpt class has lower case
    "MptForCausalLM": ("mpt", "MPTForCausalLM"),
    "MPTForCausalLM": ("mpt", "MPTForCausalLM"),
170
    "MiMoForCausalLM": ("mimo", "MiMoForCausalLM"),
171
    "MiMoV2FlashForCausalLM": ("mimo_v2_flash", "MiMoV2FlashForCausalLM"),
172
    "NemotronForCausalLM": ("nemotron", "NemotronForCausalLM"),
Luis Vega's avatar
Luis Vega committed
173
    "NemotronHForCausalLM": ("nemotron_h", "NemotronHForCausalLM"),
174
    "NemotronHPuzzleForCausalLM": ("nemotron_h", "NemotronHForCausalLM"),
175
    "OlmoForCausalLM": ("olmo", "OlmoForCausalLM"),
176
    "Olmo2ForCausalLM": ("olmo2", "Olmo2ForCausalLM"),
177
    "Olmo3ForCausalLM": ("olmo2", "Olmo2ForCausalLM"),
178
    "OlmoHybridForCausalLM": ("olmo_hybrid", "OlmoHybridForCausalLM"),
179
180
181
    "OlmoeForCausalLM": ("olmoe", "OlmoeForCausalLM"),
    "OPTForCausalLM": ("opt", "OPTForCausalLM"),
    "OrionForCausalLM": ("orion", "OrionForCausalLM"),
182
    "OuroForCausalLM": ("ouro", "OuroForCausalLM"),
183
    "PanguEmbeddedForCausalLM": ("openpangu", "PanguEmbeddedForCausalLM"),
184
    "PanguProMoEV2ForCausalLM": ("openpangu", "PanguProMoEV2ForCausalLM"),
185
    "PanguUltraMoEForCausalLM": ("openpangu", "PanguUltraMoEForCausalLM"),
186
    "Param2MoEForCausalLM": ("param2moe", "Param2MoEForCausalLM"),
187
188
189
190
    "PersimmonForCausalLM": ("persimmon", "PersimmonForCausalLM"),
    "PhiForCausalLM": ("phi", "PhiForCausalLM"),
    "Phi3ForCausalLM": ("phi3", "Phi3ForCausalLM"),
    "PhiMoEForCausalLM": ("phimoe", "PhiMoEForCausalLM"),
Shinichi Hemmi's avatar
Shinichi Hemmi committed
191
    "Plamo2ForCausalLM": ("plamo2", "Plamo2ForCausalLM"),
192
    "Plamo3ForCausalLM": ("plamo3", "Plamo3ForCausalLM"),
193
    "QWenLMHeadModel": ("qwen", "QWenLMHeadModel"),
194
195
    "Qwen2ForCausalLM": ("qwen2", "Qwen2ForCausalLM"),
    "Qwen2MoeForCausalLM": ("qwen2_moe", "Qwen2MoeForCausalLM"),
196
197
    "Qwen3ForCausalLM": ("qwen3", "Qwen3ForCausalLM"),
    "Qwen3MoeForCausalLM": ("qwen3_moe", "Qwen3MoeForCausalLM"),
198
    "RWForCausalLM": ("falcon", "FalconForCausalLM"),
199
200
    "SarvamMoEForCausalLM": ("sarvam", "SarvamMoEForCausalLM"),
    "SarvamMLAForCausalLM": ("sarvam", "SarvamMLAForCausalLM"),
201
    "SeedOssForCausalLM": ("seed_oss", "SeedOssForCausalLM"),
Li Xie's avatar
Li Xie committed
202
    "Step1ForCausalLM": ("step1", "Step1ForCausalLM"),
Song's avatar
Song committed
203
    "Step3TextForCausalLM": ("step3_text", "Step3TextForCausalLM"),
csy0225's avatar
csy0225 committed
204
    "Step3p5ForCausalLM": ("step3p5", "Step3p5ForCausalLM"),
205
206
207
208
    "StableLMEpochForCausalLM": ("stablelm", "StablelmForCausalLM"),
    "StableLmForCausalLM": ("stablelm", "StablelmForCausalLM"),
    "Starcoder2ForCausalLM": ("starcoder2", "Starcoder2ForCausalLM"),
    "SolarForCausalLM": ("solar", "SolarForCausalLM"),
209
    "TeleChatForCausalLM": ("telechat2", "TeleChat2ForCausalLM"),
210
    "TeleChat2ForCausalLM": ("telechat2", "TeleChat2ForCausalLM"),
211
    "TeleChat3ForCausalLM": ("llama", "LlamaForCausalLM"),
212
    "TeleFLMForCausalLM": ("teleflm", "TeleFLMForCausalLM"),
213
    "XverseForCausalLM": ("llama", "LlamaForCausalLM"),
214
    "Zamba2ForCausalLM": ("zamba2", "Zamba2ForCausalLM"),
215
216
217
}

_EMBEDDING_MODELS = {
218
    # [Text-only]
219
    "BertModel": ("bert", "BertEmbeddingModel"),
220
    "BertSpladeSparseEmbeddingModel": ("bert", "BertSpladeSparseEmbeddingModel"),
221
    "ErnieModel": ("ernie", "ErnieEmbeddingModel"),
222
    "BgeM3EmbeddingModel": ("roberta", "BgeM3EmbeddingModel"),
223
    "DeciLMForCausalLM": ("nemotron_nas", "DeciLMForCausalLM"),
224
    "Gemma2Model": ("gemma2", "Gemma2ForCausalLM"),
225
    "Gemma3TextModel": ("gemma3", "Gemma3Model"),
226
    "GlmForCausalLM": ("glm", "GlmForCausalLM"),
227
    "GritLM": ("gritlm", "GritLM"),
228
229
    "GteModel": ("bert_with_rope", "SnowflakeGteNewModel"),
    "GteNewModel": ("bert_with_rope", "GteNewModel"),
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
245
    "RobertaForMaskedLM": ("roberta", "RobertaEmbeddingModel"),
    "RobertaModel": ("roberta", "RobertaEmbeddingModel"),
246
    "TeleChatForCausalLM": ("telechat2", "TeleChat2ForCausalLM"),
247
    "TeleChat2ForCausalLM": ("telechat2", "TeleChat2ForCausalLM"),
chengchengpei's avatar
chengchengpei committed
248
249
250
251
    "VoyageQwen3BidirectionalEmbedModel": (
        "voyage",
        "VoyageQwen3BidirectionalEmbedModel",
    ),
252
    "XLMRobertaModel": ("roberta", "RobertaEmbeddingModel"),
253
    # [Multimodal]
254
    "CLIPModel": ("clip", "CLIPEmbeddingModel"),
255
    "ColPaliForRetrieval": ("colpali", "ColPaliModel"),
256
    "LlamaNemotronVLModel": ("nemotron_vl", "LlamaNemotronVLForEmbedding"),
257
258
259
    "LlavaNextForConditionalGeneration": (
        "llava_next",
        "LlavaNextForConditionalGeneration",
260
    ),
261
    "Phi3VForCausalLM": ("phi3v", "Phi3VForCausalLM"),
262
    "Qwen2VLForConditionalGeneration": ("qwen2_vl", "Qwen2VLForConditionalGeneration"),
263
    "SiglipModel": ("siglip", "SiglipEmbeddingModel"),
264
265
    # Technically Terratorch models work on images, both in
    # input and output. I am adding it here because it piggy-backs on embedding
266
    # models for the time being.
267
268
    "PrithviGeoSpatialMAE": ("terratorch", "Terratorch"),
    "Terratorch": ("terratorch", "Terratorch"),
269
270
}

271
272
273
274
275
_LATE_INTERACTION_MODELS = {
    # [Text-only]
    "HF_ColBERT": ("colbert", "ColBERTModel"),
    "ColBERTModernBertModel": ("colbert", "ColBERTModernBertModel"),
    "ColBERTJinaRobertaModel": ("colbert", "ColBERTJinaRobertaModel"),
276
    "ColBERTLfm2Model": ("colbert", "ColBERTLfm2Model"),
277
    "JinaForRanking": ("jina", "JinaForRanking"),
278
279
    # [Multimodal]
    "ColModernVBertForRetrieval": ("colmodernvbert", "ColModernVBertForRetrieval"),
280
    "ColPaliForRetrieval": ("colpali", "ColPaliModel"),
281
282
    "ColQwen3": ("colqwen3", "ColQwen3Model"),
    "OpsColQwen3Model": ("colqwen3", "ColQwen3Model"),
283
    "ColQwen3_5": ("colqwen3_5", "ColQwen3_5Model"),
284
285
286
287
288
289
290
291
292
293
    "Qwen3VLNemotronEmbedModel": ("colqwen3", "ColQwen3Model"),
}

_REWARD_MODELS = {
    "InternLM2ForRewardModel": ("internlm2", "InternLM2ForRewardModel"),
    "Qwen2ForRewardModel": ("qwen2_rm", "Qwen2ForRewardModel"),
    "Qwen2ForProcessRewardModel": ("qwen2_rm", "Qwen2ForProcessRewardModel"),
}

_TOKEN_CLASSIFICATION_MODELS = {
294
    "BertForTokenClassification": ("bert", "BertForTokenClassification"),
295
    "ErnieForTokenClassification": ("ernie", "ErnieForTokenClassification"),
296
297
298
299
    "ModernBertForTokenClassification": (
        "modernbert",
        "ModernBertForTokenClassification",
    ),
300
301
302
303
    "Qwen3ASRForcedAlignerForTokenClassification": (
        "qwen3_asr_forced_aligner",
        "Qwen3ASRForcedAlignerForTokenClassification",
    ),
304
305
306
307
308
}

_SEQUENCE_CLASSIFICATION_MODELS = {
    "BertForSequenceClassification": ("bert", "BertForSequenceClassification"),
    "GPT2ForSequenceClassification": ("gpt2", "GPT2ForSequenceClassification"),
309
    "ErnieForSequenceClassification": ("ernie", "ErnieForSequenceClassification"),
310
311
312
313
    "GteNewForSequenceClassification": (
        "bert_with_rope",
        "GteNewForSequenceClassification",
    ),
314
    "JambaForSequenceClassification": ("jamba", "JambaForSequenceClassification"),
315
316
317
    "LlamaBidirectionalForSequenceClassification": (
        "llama",
        "LlamaBidirectionalForSequenceClassification",
318
    ),
319
320
321
322
323
324
325
326
327
    "ModernBertForSequenceClassification": (
        "modernbert",
        "ModernBertForSequenceClassification",
    ),
    "RobertaForSequenceClassification": ("roberta", "RobertaForSequenceClassification"),
    "XLMRobertaForSequenceClassification": (
        "roberta",
        "RobertaForSequenceClassification",
    ),
328
329
330
331
332
333
    # [Multimodal]
    "JinaVLForRanking": ("jina_vl", "JinaVLForSequenceClassification"),
    "LlamaNemotronVLForSequenceClassification": (
        "nemotron_vl",
        "LlamaNemotronVLForSequenceClassification",
    ),
334
335
}

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

_SPECULATIVE_DECODING_MODELS = {
561
    "ExtractHiddenStatesModel": ("extract_hidden_states", "ExtractHiddenStatesModel"),
562
    "MiMoMTPModel": ("mimo_mtp", "MiMoMTP"),
563
    "EagleLlamaForCausalLM": ("llama_eagle", "EagleLlamaForCausalLM"),
zhiweiz's avatar
zhiweiz committed
564
    "EagleLlama4ForCausalLM": ("llama4_eagle", "EagleLlama4ForCausalLM"),
565
    "EagleMiniCPMForCausalLM": ("minicpm_eagle", "EagleMiniCPMForCausalLM"),
566
    "DFlashDraftModel": ("qwen3_dflash", "DFlashQwen3ForCausalLM"),
567
    "Eagle3LlamaForCausalLM": ("llama_eagle3", "Eagle3LlamaForCausalLM"),
568
    "Eagle3MiniMaxM2ForCausalLM": ("llama_eagle3", "Eagle3LlamaForCausalLM"),
569
    "LlamaForCausalLMEagle3": ("llama_eagle3", "Eagle3LlamaForCausalLM"),
570
    "Eagle3Qwen2_5vlForCausalLM": ("llama_eagle3", "Eagle3LlamaForCausalLM"),
571
    "Eagle3Qwen3vlForCausalLM": ("llama_eagle3", "Eagle3LlamaForCausalLM"),
572
573
574
575
    "EagleMistralLarge3ForCausalLM": (
        "mistral_large_3_eagle",
        "EagleMistralLarge3ForCausalLM",
    ),
576
577
    "Eagle3DeepseekV2ForCausalLM": ("deepseek_eagle3", "Eagle3DeepseekV2ForCausalLM"),
    "Eagle3DeepseekV3ForCausalLM": ("deepseek_eagle3", "Eagle3DeepseekV2ForCausalLM"),
578
    "EagleDeepSeekMTPModel": ("deepseek_eagle", "EagleDeepseekV3ForCausalLM"),
579
    "DeepSeekMTPModel": ("deepseek_mtp", "DeepSeekMTP"),
580
    "ErnieMTPModel": ("ernie_mtp", "ErnieMTP"),
Kyungmin Lee's avatar
Kyungmin Lee committed
581
    "ExaoneMoeMTP": ("exaone_moe_mtp", "ExaoneMoeMTP"),
Kyungmin Lee's avatar
Kyungmin Lee committed
582
    "Exaone4_5_MTP": ("exaone4_5_mtp", "Exaone4_5_MTP"),
583
    "NemotronHMTPModel": ("nemotron_h_mtp", "NemotronHMTP"),
XuruiYang's avatar
XuruiYang committed
584
    "LongCatFlashMTPModel": ("longcat_flash_mtp", "LongCatFlashMTP"),
Yuxuan Zhang's avatar
Yuxuan Zhang committed
585
    "Glm4MoeMTPModel": ("glm4_moe_mtp", "Glm4MoeMTP"),
586
    "Glm4MoeLiteMTPModel": ("glm4_moe_lite_mtp", "Glm4MoeLiteMTP"),
587
    "GlmOcrMTPModel": ("glm_ocr_mtp", "GlmOcrMTP"),
588
    "MedusaModel": ("medusa", "Medusa"),
589
    "OpenPanguMTPModel": ("openpangu_mtp", "OpenPanguMTP"),
590
    "Qwen3NextMTP": ("qwen3_next_mtp", "Qwen3NextMTP"),
csy0225's avatar
csy0225 committed
591
    "Step3p5MTP": ("step3p5_mtp", "Step3p5MTP"),
592
593
    "Qwen3_5MTP": ("qwen3_5_mtp", "Qwen3_5MTP"),
    "Qwen3_5MoeMTP": ("qwen3_5_mtp", "Qwen3_5MoeMTP"),
594
595
596
    # Temporarily disabled.
    # # TODO(woosuk): Re-enable this once the MLP Speculator is supported in V1.
    # "MLPSpeculatorPreTrainedModel": ("mlp_speculator", "MLPSpeculator"),
597
}
598

599
_TRANSFORMERS_SUPPORTED_MODELS = {
600
601
602
    # Text generation models
    "SmolLM3ForCausalLM": ("transformers", "TransformersForCausalLM"),
    # Multimodal models
603
604
605
606
    "Emu3ForConditionalGeneration": (
        "transformers",
        "TransformersMultiModalForCausalLM",
    ),
607
608
609
}

_TRANSFORMERS_BACKEND_MODELS = {
610
    # Text generation models
611
    "TransformersForCausalLM": ("transformers", "TransformersForCausalLM"),
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
    "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
630
    "TransformersForSequenceClassification": (
631
        "transformers",
632
        "TransformersForSequenceClassification",
633
    ),
634
    "TransformersMoEForSequenceClassification": (
635
        "transformers",
636
        "TransformersMoEForSequenceClassification",
637
    ),
638
639
640
    "TransformersMultiModalForSequenceClassification": (
        "transformers",
        "TransformersMultiModalForSequenceClassification",
641
    ),
642
}
643

644
_VLLM_MODELS = {
645
    **_TEXT_GENERATION_MODELS,
646
    **_EMBEDDING_MODELS,
647
648
649
650
    **_LATE_INTERACTION_MODELS,
    **_REWARD_MODELS,
    **_TOKEN_CLASSIFICATION_MODELS,
    **_SEQUENCE_CLASSIFICATION_MODELS,
651
    **_MULTIMODAL_MODELS,
652
    **_SPECULATIVE_DECODING_MODELS,
653
654
    **_TRANSFORMERS_SUPPORTED_MODELS,
    **_TRANSFORMERS_BACKEND_MODELS,
655
656
}

657
658
659
660
# 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.
661
_SUBPROCESS_COMMAND = [sys.executable, "-m", "vllm.model_executor.models.registry"]
662

663
_PREVIOUSLY_SUPPORTED_MODELS = {
664
    "MotifForCausalLM": "0.10.2",
665
    "Phi3SmallForCausalLM": "0.9.2",
666
    "Phi4FlashForCausalLM": "0.10.2",
667
    "Phi4MultimodalForCausalLM": "0.12.0",
668
669
670
671
672
    # encoder-decoder models except whisper
    # have been removed for V0 deprecation.
    "DonutForConditionalGeneration": "0.10.2",
    "MllamaForConditionalGeneration": "0.10.2",
}
673

674
675
676
677
678
679
680
_OOT_SUPPORTED_MODELS = {
    "BartModel": "https://github.com/vllm-project/bart-plugin",
    "BartForConditionalGeneration": "https://github.com/vllm-project/bart-plugin",
    "Florence2ForConditionalGeneration": "https://github.com/vllm-project/bart-plugin",
    "MBartForConditionalGeneration": "https://github.com/vllm-project/bart-plugin",
}

681

682
683
@dataclass(frozen=True)
class _ModelInfo:
684
    architecture: str
685
    is_text_generation_model: bool
686
    is_pooling_model: bool
687
    attn_type: AttnTypeStr
688
689
    default_seq_pooling_type: SequencePoolingType
    default_tok_pooling_type: TokenPoolingType
690
    score_type: ScoreType
691
    supports_multimodal: bool
692
    supports_multimodal_raw_input_only: bool
Patrick von Platen's avatar
Patrick von Platen committed
693
    requires_raw_input_tokens: bool
694
    supports_multimodal_encoder_tp_data: bool
695
    supports_pp: bool
696
697
    has_inner_state: bool
    is_attention_free: bool
698
    is_hybrid: bool
699
    has_noops: bool
700
    supports_mamba_prefix_caching: bool
701
    supports_transcription: bool
702
    supports_transcription_only: bool
703
704

    @staticmethod
705
    def from_model_cls(model: type[nn.Module]) -> "_ModelInfo":
706
        return _ModelInfo(
707
            architecture=model.__name__,
708
            is_text_generation_model=is_text_generation_model(model),
709
            is_pooling_model=is_pooling_model(model),
710
711
            default_seq_pooling_type=get_default_seq_pooling_type(model),
            default_tok_pooling_type=get_default_tok_pooling_type(model),
712
            attn_type=get_attn_type(model),
713
            score_type=get_score_type(model),
714
            supports_multimodal=supports_multimodal(model),
715
716
717
            supports_multimodal_raw_input_only=supports_multimodal_raw_input_only(
                model
            ),
Patrick von Platen's avatar
Patrick von Platen committed
718
            requires_raw_input_tokens=requires_raw_input_tokens(model),
719
720
721
            supports_multimodal_encoder_tp_data=supports_multimodal_encoder_tp_data(
                model
            ),
722
            supports_pp=supports_pp(model),
723
724
            has_inner_state=has_inner_state(model),
            is_attention_free=is_attention_free(model),
725
            is_hybrid=is_hybrid(model),
726
            supports_mamba_prefix_caching=supports_mamba_prefix_caching(model),
727
            supports_transcription=supports_transcription(model),
728
729
730
            supports_transcription_only=(
                supports_transcription(model) and model.supports_transcription_only
            ),
731
            has_noops=has_noops(model),
732
        )
733
734


735
736
737
738
class _BaseRegisteredModel(ABC):
    @abstractmethod
    def inspect_model_cls(self) -> _ModelInfo:
        raise NotImplementedError
739

740
    @abstractmethod
741
    def load_model_cls(self) -> type[nn.Module]:
742
        raise NotImplementedError
743
744


745
746
747
748
749
750
751
@dataclass(frozen=True)
class _RegisteredModel(_BaseRegisteredModel):
    """
    Represents a model that has already been imported in the main process.
    """

    interfaces: _ModelInfo
752
    model_cls: type[nn.Module]
753
754

    @staticmethod
755
    def from_model_cls(model_cls: type[nn.Module]):
756
757
758
759
760
761
762
763
        return _RegisteredModel(
            interfaces=_ModelInfo.from_model_cls(model_cls),
            model_cls=model_cls,
        )

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

764
    def load_model_cls(self) -> type[nn.Module]:
765
766
767
768
769
770
771
772
        return self.model_cls


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

774
775
776
    module_name: str
    class_name: str

777
778
779
780
781
782
783
784
    @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"

785
    def _load_modelinfo_from_cache(self, module_hash: str) -> _ModelInfo | None:
786
787
        try:
            try:
788
                modelinfo_path = self._get_cache_dir() / self._get_cache_filename()
789
790
791
                with open(modelinfo_path, encoding="utf-8") as file:
                    mi_dict = json.load(file)
            except FileNotFoundError:
792
                logger.debug(
793
                    "Cached model info file for class %s.%s not found",
794
795
796
                    self.module_name,
                    self.class_name,
                )
797
798
799
                return None

            if mi_dict["hash"] != module_hash:
800
                logger.debug(
801
                    "Cached model info file for class %s.%s is stale",
802
803
804
                    self.module_name,
                    self.class_name,
                )
805
806
807
808
809
                return None

            # file not changed, use cached _ModelInfo properties
            return _ModelInfo(**mi_dict["modelinfo"])
        except Exception:
810
            logger.debug(
811
                "Cached model info for class %s.%s error. ",
812
813
814
                self.module_name,
                self.class_name,
            )
815
816
            return None

817
    def _save_modelinfo_to_cache(self, mi: _ModelInfo, module_hash: str) -> None:
818
819
        """save dictionary json file to cache"""
        from vllm.model_executor.model_loader.weight_utils import atomic_writer
820

821
822
823
824
825
826
827
828
        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()
829
            with atomic_writer(modelinfo_path, encoding="utf-8") as f:
830
831
832
833
834
                json.dump(modelinfo_dict, f, indent=2)
        except Exception:
            logger.exception("Error saving model info cache.")

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

839
840
        if model_path.exists():
            with open(model_path, "rb") as f:
841
                module_hash = safe_hash(f.read(), usedforsecurity=False).hexdigest()
842
843
844

            mi = self._load_modelinfo_from_cache(module_hash)
            if mi is not None:
845
                logger.debug(
846
                    "Loaded model info for class %s.%s from cache",
847
848
849
                    self.module_name,
                    self.class_name,
                )
850
851
                return mi
            else:
852
                logger.debug(
853
                    "Cache model info for class %s.%s miss. Loading model instead.",
854
855
856
                    self.module_name,
                    self.class_name,
                )
857
858
859

        # Performed in another process to avoid initializing CUDA
        mi = _run_in_subprocess(
860
861
862
863
864
            lambda: _ModelInfo.from_model_cls(self.load_model_cls())
        )
        logger.debug(
            "Loaded model info for class %s.%s", self.module_name, self.class_name
        )
865
866

        # save cache file
867
868
        if module_hash is not None:
            self._save_modelinfo_to_cache(mi, module_hash)
869
870

        return mi
871

872
    def load_model_cls(self) -> type[nn.Module]:
873
874
875
876
877
878
879
880
        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,
881
) -> type[nn.Module] | None:
882
    from vllm.platforms import current_platform
883

884
    current_platform.verify_model_arch(model_arch)
885
886
887
    try:
        return model.load_model_cls()
    except Exception:
888
        logger.exception("Error in loading model architecture '%s'", model_arch)
889
        return None
890
891


892
893
894
895
@lru_cache(maxsize=128)
def _try_inspect_model_cls(
    model_arch: str,
    model: _BaseRegisteredModel,
896
) -> _ModelInfo | None:
897
898
899
    try:
        return model.inspect_model_cls()
    except Exception:
900
        logger.exception("Error in inspecting model architecture '%s'", model_arch)
901
        return None
902
903


904
905
906
@dataclass
class _ModelRegistry:
    # Keyed by model_arch
907
    models: dict[str, _BaseRegisteredModel] = field(default_factory=dict)
908

909
    def get_supported_archs(self) -> Set[str]:
910
        return self.models.keys()
911

912
913
914
    def register_model(
        self,
        model_arch: str,
915
        model_cls: type[nn.Module] | str,
916
    ) -> None:
917
918
919
        """
        Register an external model to be used in vLLM.

920
        `model_cls` can be either:
921

922
        - A [`torch.nn.Module`][] class directly referencing the model.
923
        - A string in the format `<module>:<class>` which can be used to
924
925
          lazily import the model. This is useful to avoid initializing CUDA
          when importing the model and thus the related error
926
          `RuntimeError: Cannot re-initialize CUDA in forked subprocess`.
927
        """
928
929
930
931
        if not isinstance(model_arch, str):
            msg = f"`model_arch` should be a string, not a {type(model_arch)}"
            raise TypeError(msg)

932
        if model_arch in self.models:
933
934
            logger.warning(
                "Model architecture %s is already registered, and will be "
935
936
937
938
                "overwritten by the new model class %s.",
                model_arch,
                model_cls,
            )
939
940
941
942
943
944

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

946
            model = _LazyRegisteredModel(*split_str)
947
        elif isinstance(model_cls, type) and issubclass(model_cls, nn.Module):
948
            model = _RegisteredModel.from_model_cls(model_cls)
949
        else:
950
951
952
953
            msg = (
                "`model_cls` should be a string or PyTorch model class, "
                f"not a {type(model_arch)}"
            )
954
            raise TypeError(msg)
955

956
        self.models[model_arch] = model
957

958
    def _raise_for_unsupported(self, architectures: list[str]):
959
        all_supported_archs = self.get_supported_archs()
960

961
962
963
        if any(arch in all_supported_archs for arch in architectures):
            raise ValueError(
                f"Model architectures {architectures} failed "
964
965
                "to be inspected. Please check the logs for more details."
            )
966

967
968
969
970
971
972
973
974
        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 "
975
976
                    "use this model architecture."
                )
977
978
979
980
981
982
983
984
            if arch in _OOT_SUPPORTED_MODELS:
                plugin_url = _OOT_SUPPORTED_MODELS[arch]

                raise ValueError(
                    f"Model architecture {arch} is not supported in-tree anymore. "
                    f"Please install the plugin at {plugin_url} if you want to "
                    "use this model architecture."
                )
985

986
987
        raise ValueError(
            f"Model architectures {architectures} are not supported for now. "
988
989
            f"Supported architectures: {all_supported_archs}"
        )
990

991
    def _try_load_model_cls(self, model_arch: str) -> type[nn.Module] | None:
992
993
        if model_arch not in self.models:
            return None
994

995
        return _try_load_model_cls(model_arch, self.models[model_arch])
996

997
    def _try_inspect_model_cls(self, model_arch: str) -> _ModelInfo | None:
998
999
        if model_arch not in self.models:
            return None
1000

1001
1002
1003
1004
1005
1006
        return _try_inspect_model_cls(model_arch, self.models[model_arch])

    def _try_resolve_transformers(
        self,
        architecture: str,
        model_config: ModelConfig,
1007
    ) -> str | None:
1008
1009
1010
        if architecture in _TRANSFORMERS_BACKEND_MODELS:
            return architecture

1011
1012
1013
        auto_map: dict[str, str] = (
            getattr(model_config.hf_config, "auto_map", None) or dict()
        )
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029

        # 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,
1030
                        trust_remote_code=model_config.trust_remote_code,
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
                        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,
1043
                        trust_remote_code=model_config.trust_remote_code,
1044
1045
1046
1047
1048
                        warn_on_fail=True,
                    )
                    if model_module is not None:
                        break
            else:
1049
                if model_config.model_impl != "transformers":
1050
1051
1052
1053
1054
1055
1056
                    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 "
1057
1058
                    "'auto_map' (relevant if the model is custom)."
                )
1059
1060

        if not model_module.is_backend_compatible():
1061
            if model_config.model_impl != "transformers":
1062
                return None
1063

1064
1065
            raise ValueError(
                f"The Transformers implementation of {architecture!r} "
1066
1067
                "is not compatible with vLLM."
            )
1068

1069
        return model_config._get_transformers_backend_cls()
1070

1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
    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
1096

1097
1098
    def inspect_model_cls(
        self,
1099
        architectures: str | list[str],
1100
        model_config: ModelConfig,
1101
    ) -> tuple[_ModelInfo, str]:
1102
1103
        if isinstance(architectures, str):
            architectures = [architectures]
1104
1105
        if not architectures:
            raise ValueError("No model architectures are specified")
1106
1107

        # Require transformers impl
1108
        if model_config.model_impl == "transformers":
1109
            arch = self._try_resolve_transformers(architectures[0], model_config)
1110
1111
1112
1113
            if arch is not None:
                model_info = self._try_inspect_model_cls(arch)
                if model_info is not None:
                    return (model_info, arch)
1114
        elif model_config.model_impl == "terratorch":
1115
1116
            model_info = self._try_inspect_model_cls("Terratorch")
            return (model_info, "Terratorch")
1117

1118
        # Fallback to transformers impl (after resolving convert_type)
1119
1120
1121
1122
1123
1124
        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)
1125
1126
1127
1128
1129
1130
1131
            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)
1132
            model_info = self._try_inspect_model_cls(normalized_arch)
1133
            if model_info is not None:
1134
                return (model_info, arch)
1135

1136
        # Fallback to transformers impl (before resolving runner_type)
1137
1138
1139
1140
1141
        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)
1142
1143
1144
1145
1146
            if arch is not None:
                model_info = self._try_inspect_model_cls(arch)
                if model_info is not None:
                    return (model_info, arch)

1147
        return self._raise_for_unsupported(architectures)
1148

1149
1150
    def resolve_model_cls(
        self,
1151
        architectures: str | list[str],
1152
        model_config: ModelConfig,
1153
    ) -> tuple[type[nn.Module], str]:
1154
1155
        if isinstance(architectures, str):
            architectures = [architectures]
1156
1157
        if not architectures:
            raise ValueError("No model architectures are specified")
1158
1159

        # Require transformers impl
1160
        if model_config.model_impl == "transformers":
1161
            arch = self._try_resolve_transformers(architectures[0], model_config)
1162
1163
1164
1165
            if arch is not None:
                model_cls = self._try_load_model_cls(arch)
                if model_cls is not None:
                    return (model_cls, arch)
1166
        elif model_config.model_impl == "terratorch":
1167
1168
1169
1170
            arch = "Terratorch"
            model_cls = self._try_load_model_cls(arch)
            if model_cls is not None:
                return (model_cls, arch)
1171

1172
        # Fallback to transformers impl (after resolving convert_type)
1173
1174
1175
1176
1177
1178
        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)
1179
1180
1181
1182
1183
1184
1185
            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)
1186
            model_cls = self._try_load_model_cls(normalized_arch)
1187
1188
            if model_cls is not None:
                return (model_cls, arch)
1189

1190
        # Fallback to transformers impl (before resolving runner_type)
1191
1192
1193
1194
1195
        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)
1196
1197
1198
1199
1200
            if arch is not None:
                model_cls = self._try_load_model_cls(arch)
                if model_cls is not None:
                    return (model_cls, arch)

1201
        return self._raise_for_unsupported(architectures)
1202

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

1211
    def is_pooling_model(
1212
        self,
1213
        architectures: str | list[str],
1214
        model_config: ModelConfig,
1215
    ) -> bool:
1216
        model_cls, _ = self.inspect_model_cls(architectures, model_config)
1217
        return model_cls.is_pooling_model
1218
1219
1220

    def is_multimodal_model(
        self,
1221
        architectures: str | list[str],
1222
        model_config: ModelConfig,
1223
    ) -> bool:
1224
        model_cls, _ = self.inspect_model_cls(architectures, model_config)
1225
        return model_cls.supports_multimodal
1226

1227
    def is_multimodal_raw_input_only_model(
1228
        self,
1229
        architectures: str | list[str],
1230
        model_config: ModelConfig,
1231
    ) -> bool:
1232
        model_cls, _ = self.inspect_model_cls(architectures, model_config)
1233
        return model_cls.supports_multimodal_raw_input_only
1234

1235
1236
    def is_pp_supported_model(
        self,
1237
        architectures: str | list[str],
1238
        model_config: ModelConfig,
1239
    ) -> bool:
1240
        model_cls, _ = self.inspect_model_cls(architectures, model_config)
1241
        return model_cls.supports_pp
1242

1243
1244
    def model_has_inner_state(
        self,
1245
        architectures: str | list[str],
1246
        model_config: ModelConfig,
1247
    ) -> bool:
1248
        model_cls, _ = self.inspect_model_cls(architectures, model_config)
1249
        return model_cls.has_inner_state
1250

1251
1252
    def is_attention_free_model(
        self,
1253
        architectures: str | list[str],
1254
        model_config: ModelConfig,
1255
    ) -> bool:
1256
        model_cls, _ = self.inspect_model_cls(architectures, model_config)
1257
        return model_cls.is_attention_free
1258

1259
1260
    def is_hybrid_model(
        self,
1261
        architectures: str | list[str],
1262
        model_config: ModelConfig,
1263
    ) -> bool:
1264
        model_cls, _ = self.inspect_model_cls(architectures, model_config)
1265
1266
        return model_cls.is_hybrid

1267
1268
    def is_noops_model(
        self,
1269
        architectures: str | list[str],
1270
        model_config: ModelConfig,
1271
    ) -> bool:
1272
        model_cls, _ = self.inspect_model_cls(architectures, model_config)
1273
1274
        return model_cls.has_noops

1275
1276
    def is_transcription_model(
        self,
1277
        architectures: str | list[str],
1278
        model_config: ModelConfig,
1279
    ) -> bool:
1280
        model_cls, _ = self.inspect_model_cls(architectures, model_config)
1281
1282
        return model_cls.supports_transcription

1283
1284
    def is_transcription_only_model(
        self,
1285
        architectures: str | list[str],
1286
        model_config: ModelConfig,
1287
    ) -> bool:
1288
        model_cls, _ = self.inspect_model_cls(architectures, model_config)
1289
1290
        return model_cls.supports_transcription_only

1291

1292
1293
1294
1295
1296
1297
1298
1299
1300
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()
    }
)
1301
1302
1303
1304
1305

_T = TypeVar("_T")


def _run_in_subprocess(fn: Callable[[], _T]) -> _T:
1306
1307
1308
1309
1310
    # 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")

1311
        # `cloudpickle` allows pickling lambda functions directly
1312
        import cloudpickle
1313

1314
        input_bytes = cloudpickle.dumps((fn, output_filepath))
1315
1316
1317

        # cannot use `sys.executable __file__` here because the script
        # contains relative imports
1318
1319
1320
        returned = subprocess.run(
            _SUBPROCESS_COMMAND, input=input_bytes, capture_output=True
        )
1321
1322
1323
1324
1325
1326

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

1331
        with open(output_filepath, "rb") as f:
1332
1333
1334
1335
1336
1337
            return pickle.load(f)


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

1339
1340
1341
1342
1343
    load_general_plugins()

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

    result = fn()
1344
1345
1346

    with open(output_file, "wb") as f:
        f.write(pickle.dumps(result))
1347
1348
1349


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