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

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

import torch.nn as nn
23
import transformers
24

25
from vllm import envs
26
27
28
29
30
from vllm.config import (
    ModelConfig,
    iter_architecture_defaults,
    try_match_architecture_defaults,
)
31
from vllm.logger import init_logger
32
from vllm.logging_utils import logtime
33
from vllm.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
    "MistralForCausalLM": ("mistral", "MistralForCausalLM"),
164
    "MistralLarge3ForCausalLM": ("mistral_large_3", "MistralLarge3ForCausalLM"),
165
166
167
168
    "MixtralForCausalLM": ("mixtral", "MixtralForCausalLM"),
    # transformers's mpt class has lower case
    "MptForCausalLM": ("mpt", "MPTForCausalLM"),
    "MPTForCausalLM": ("mpt", "MPTForCausalLM"),
169
    "MiMoForCausalLM": ("mimo", "MiMoForCausalLM"),
170
    "MiMoV2FlashForCausalLM": ("mimo_v2_flash", "MiMoV2FlashForCausalLM"),
171
    "NemotronForCausalLM": ("nemotron", "NemotronForCausalLM"),
Luis Vega's avatar
Luis Vega committed
172
    "NemotronHForCausalLM": ("nemotron_h", "NemotronHForCausalLM"),
173
    "NemotronHPuzzleForCausalLM": ("nemotron_h", "NemotronHForCausalLM"),
174
    "OlmoForCausalLM": ("olmo", "OlmoForCausalLM"),
175
    "Olmo2ForCausalLM": ("olmo2", "Olmo2ForCausalLM"),
176
    "Olmo3ForCausalLM": ("olmo2", "Olmo2ForCausalLM"),
177
    "OlmoHybridForCausalLM": ("olmo_hybrid", "OlmoHybridForCausalLM"),
178
179
180
    "OlmoeForCausalLM": ("olmoe", "OlmoeForCausalLM"),
    "OPTForCausalLM": ("opt", "OPTForCausalLM"),
    "OrionForCausalLM": ("orion", "OrionForCausalLM"),
181
    "OuroForCausalLM": ("ouro", "OuroForCausalLM"),
182
    "PanguEmbeddedForCausalLM": ("openpangu", "PanguEmbeddedForCausalLM"),
183
    "PanguProMoEV2ForCausalLM": ("openpangu", "PanguProMoEV2ForCausalLM"),
184
    "PanguUltraMoEForCausalLM": ("openpangu", "PanguUltraMoEForCausalLM"),
185
    "Param2MoEForCausalLM": ("param2moe", "Param2MoEForCausalLM"),
186
187
188
189
    "PersimmonForCausalLM": ("persimmon", "PersimmonForCausalLM"),
    "PhiForCausalLM": ("phi", "PhiForCausalLM"),
    "Phi3ForCausalLM": ("phi3", "Phi3ForCausalLM"),
    "PhiMoEForCausalLM": ("phimoe", "PhiMoEForCausalLM"),
Shinichi Hemmi's avatar
Shinichi Hemmi committed
190
    "Plamo2ForCausalLM": ("plamo2", "Plamo2ForCausalLM"),
191
    "Plamo3ForCausalLM": ("plamo3", "Plamo3ForCausalLM"),
192
    "QWenLMHeadModel": ("qwen", "QWenLMHeadModel"),
193
194
    "Qwen2ForCausalLM": ("qwen2", "Qwen2ForCausalLM"),
    "Qwen2MoeForCausalLM": ("qwen2_moe", "Qwen2MoeForCausalLM"),
195
196
    "Qwen3ForCausalLM": ("qwen3", "Qwen3ForCausalLM"),
    "Qwen3MoeForCausalLM": ("qwen3_moe", "Qwen3MoeForCausalLM"),
197
    "RWForCausalLM": ("falcon", "FalconForCausalLM"),
198
199
    "SarvamMoEForCausalLM": ("sarvam", "SarvamMoEForCausalLM"),
    "SarvamMLAForCausalLM": ("sarvam", "SarvamMLAForCausalLM"),
200
    "SeedOssForCausalLM": ("seed_oss", "SeedOssForCausalLM"),
Li Xie's avatar
Li Xie committed
201
    "Step1ForCausalLM": ("step1", "Step1ForCausalLM"),
Song's avatar
Song committed
202
    "Step3TextForCausalLM": ("step3_text", "Step3TextForCausalLM"),
csy0225's avatar
csy0225 committed
203
    "Step3p5ForCausalLM": ("step3p5", "Step3p5ForCausalLM"),
204
205
206
207
    "StableLMEpochForCausalLM": ("stablelm", "StablelmForCausalLM"),
    "StableLmForCausalLM": ("stablelm", "StablelmForCausalLM"),
    "Starcoder2ForCausalLM": ("starcoder2", "Starcoder2ForCausalLM"),
    "SolarForCausalLM": ("solar", "SolarForCausalLM"),
208
    "TeleChatForCausalLM": ("telechat2", "TeleChat2ForCausalLM"),
209
    "TeleChat2ForCausalLM": ("telechat2", "TeleChat2ForCausalLM"),
210
    "TeleChat3ForCausalLM": ("llama", "LlamaForCausalLM"),
211
    "TeleFLMForCausalLM": ("teleflm", "TeleFLMForCausalLM"),
212
    "XverseForCausalLM": ("llama", "LlamaForCausalLM"),
213
    "Zamba2ForCausalLM": ("zamba2", "Zamba2ForCausalLM"),
214
215
216
}

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

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

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

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

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

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

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

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

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

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

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

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

673
674
675
676
677
678
679
_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",
}

680

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

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


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

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


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

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

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

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

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


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

773
774
775
    module_name: str
    class_name: str

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

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

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

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

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

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

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

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

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

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

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

        return mi
870

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

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


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


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

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

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

919
        `model_cls` can be either:
920

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

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

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

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

955
        self.models[model_arch] = model
956

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

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

966
967
968
969
970
971
972
973
        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 "
974
975
                    "use this model architecture."
                )
976
977
978
979
980
981
982
983
            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."
                )
984

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

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

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

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

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

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

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

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

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

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

1068
        return model_config._get_transformers_backend_cls()
1069

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
    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
1095

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

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

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

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

1146
        return self._raise_for_unsupported(architectures)
1147

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

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

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

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

1200
        return self._raise_for_unsupported(architectures)
1201

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

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

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

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

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

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

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

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

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

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

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

1290

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

_T = TypeVar("_T")


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

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

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

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

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

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


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

1338
1339
1340
1341
1342
    load_general_plugins()

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

    result = fn()
1343
1344
1345

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


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