registry.py 53.5 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
    "JinaEmbeddingsV5Model": ("jina", "JinaEmbeddingsV5Model"),
231
    "LlamaBidirectionalModel": ("llama", "LlamaBidirectionalModel"),
232
    "LlamaModel": ("llama", "LlamaForCausalLM"),
233
234
    **{
        # Multiple models share the same architecture, so we include them all
235
236
        k: (mod, arch)
        for k, (mod, arch) in _TEXT_GENERATION_MODELS.items()
237
238
        if arch == "LlamaForCausalLM"
    },
239
    "MistralModel": ("llama", "LlamaForCausalLM"),
240
    "ModernBertModel": ("modernbert", "ModernBertModel"),
241
    "NomicBertModel": ("bert_with_rope", "NomicBertModel"),
242
    "Phi3ForCausalLM": ("phi3", "Phi3ForCausalLM"),
243
    "Qwen2Model": ("qwen2", "Qwen2ForCausalLM"),
244
    "Qwen2ForCausalLM": ("qwen2", "Qwen2ForCausalLM"),
245
246
    "RobertaForMaskedLM": ("roberta", "RobertaEmbeddingModel"),
    "RobertaModel": ("roberta", "RobertaEmbeddingModel"),
247
    "TeleChatForCausalLM": ("telechat2", "TeleChat2ForCausalLM"),
248
    "TeleChat2ForCausalLM": ("telechat2", "TeleChat2ForCausalLM"),
chengchengpei's avatar
chengchengpei committed
249
250
251
252
    "VoyageQwen3BidirectionalEmbedModel": (
        "voyage",
        "VoyageQwen3BidirectionalEmbedModel",
    ),
253
    "XLMRobertaModel": ("roberta", "RobertaEmbeddingModel"),
254
    # [Multimodal]
255
    "CLIPModel": ("clip", "CLIPEmbeddingModel"),
256
    "ColPaliForRetrieval": ("colpali", "ColPaliModel"),
257
    "LlamaNemotronVLModel": ("nemotron_vl", "LlamaNemotronVLForEmbedding"),
258
259
260
    "LlavaNextForConditionalGeneration": (
        "llava_next",
        "LlavaNextForConditionalGeneration",
261
    ),
262
    "Phi3VForCausalLM": ("phi3v", "Phi3VForCausalLM"),
263
    "Qwen2VLForConditionalGeneration": ("qwen2_vl", "Qwen2VLForConditionalGeneration"),
264
    "SiglipModel": ("siglip", "SiglipEmbeddingModel"),
265
266
    # Technically Terratorch models work on images, both in
    # input and output. I am adding it here because it piggy-backs on embedding
267
    # models for the time being.
268
269
    "PrithviGeoSpatialMAE": ("terratorch", "Terratorch"),
    "Terratorch": ("terratorch", "Terratorch"),
270
271
}

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

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

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

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

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

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

606
_TRANSFORMERS_SUPPORTED_MODELS = {
607
608
609
    # Text generation models
    "SmolLM3ForCausalLM": ("transformers", "TransformersForCausalLM"),
    # Multimodal models
610
611
612
613
    "Emu3ForConditionalGeneration": (
        "transformers",
        "TransformersMultiModalForCausalLM",
    ),
614
615
616
}

_TRANSFORMERS_BACKEND_MODELS = {
617
    # Text generation models
618
    "TransformersForCausalLM": ("transformers", "TransformersForCausalLM"),
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
    "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
637
    "TransformersForSequenceClassification": (
638
        "transformers",
639
        "TransformersForSequenceClassification",
640
    ),
641
    "TransformersMoEForSequenceClassification": (
642
        "transformers",
643
        "TransformersMoEForSequenceClassification",
644
    ),
645
646
647
    "TransformersMultiModalForSequenceClassification": (
        "transformers",
        "TransformersMultiModalForSequenceClassification",
648
    ),
649
}
650

651
_VLLM_MODELS = {
652
    **_TEXT_GENERATION_MODELS,
653
    **_EMBEDDING_MODELS,
654
655
656
657
    **_LATE_INTERACTION_MODELS,
    **_REWARD_MODELS,
    **_TOKEN_CLASSIFICATION_MODELS,
    **_SEQUENCE_CLASSIFICATION_MODELS,
658
    **_MULTIMODAL_MODELS,
659
    **_SPECULATIVE_DECODING_MODELS,
660
661
    **_TRANSFORMERS_SUPPORTED_MODELS,
    **_TRANSFORMERS_BACKEND_MODELS,
662
663
}

664
665
666
667
# 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.
668
_SUBPROCESS_COMMAND = [sys.executable, "-m", "vllm.model_executor.models.registry"]
669

670
_PREVIOUSLY_SUPPORTED_MODELS = {
671
    "MotifForCausalLM": "0.10.2",
672
    "Phi3SmallForCausalLM": "0.9.2",
673
    "Phi4FlashForCausalLM": "0.10.2",
674
    "Phi4MultimodalForCausalLM": "0.12.0",
675
676
677
678
679
    # encoder-decoder models except whisper
    # have been removed for V0 deprecation.
    "DonutForConditionalGeneration": "0.10.2",
    "MllamaForConditionalGeneration": "0.10.2",
}
680

681
682
683
684
685
686
687
_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",
}

688

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

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


742
743
744
745
class _BaseRegisteredModel(ABC):
    @abstractmethod
    def inspect_model_cls(self) -> _ModelInfo:
        raise NotImplementedError
746

747
    @abstractmethod
748
    def load_model_cls(self) -> type[nn.Module]:
749
        raise NotImplementedError
750
751


752
753
754
755
756
757
758
@dataclass(frozen=True)
class _RegisteredModel(_BaseRegisteredModel):
    """
    Represents a model that has already been imported in the main process.
    """

    interfaces: _ModelInfo
759
    model_cls: type[nn.Module]
760
761

    @staticmethod
762
    def from_model_cls(model_cls: type[nn.Module]):
763
764
765
766
767
768
769
770
        return _RegisteredModel(
            interfaces=_ModelInfo.from_model_cls(model_cls),
            model_cls=model_cls,
        )

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

771
    def load_model_cls(self) -> type[nn.Module]:
772
773
774
775
776
777
778
779
        return self.model_cls


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

781
782
783
    module_name: str
    class_name: str

784
785
786
787
788
789
790
791
    @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"

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

            if mi_dict["hash"] != module_hash:
807
                logger.debug(
808
                    "Cached model info file for class %s.%s is stale",
809
810
811
                    self.module_name,
                    self.class_name,
                )
812
813
814
815
816
                return None

            # file not changed, use cached _ModelInfo properties
            return _ModelInfo(**mi_dict["modelinfo"])
        except Exception:
817
            logger.debug(
818
                "Cached model info for class %s.%s error. ",
819
820
821
                self.module_name,
                self.class_name,
            )
822
823
            return None

824
    def _save_modelinfo_to_cache(self, mi: _ModelInfo, module_hash: str) -> None:
825
826
        """save dictionary json file to cache"""
        from vllm.model_executor.model_loader.weight_utils import atomic_writer
827

828
829
830
831
832
833
834
835
        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()
836
            with atomic_writer(modelinfo_path, encoding="utf-8") as f:
837
838
839
840
841
                json.dump(modelinfo_dict, f, indent=2)
        except Exception:
            logger.exception("Error saving model info cache.")

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

846
847
        if model_path.exists():
            with open(model_path, "rb") as f:
848
                module_hash = safe_hash(f.read(), usedforsecurity=False).hexdigest()
849
850
851

            mi = self._load_modelinfo_from_cache(module_hash)
            if mi is not None:
852
                logger.debug(
853
                    "Loaded model info for class %s.%s from cache",
854
855
856
                    self.module_name,
                    self.class_name,
                )
857
858
                return mi
            else:
859
                logger.debug(
860
                    "Cache model info for class %s.%s miss. Loading model instead.",
861
862
863
                    self.module_name,
                    self.class_name,
                )
864
865
866

        # Performed in another process to avoid initializing CUDA
        mi = _run_in_subprocess(
867
868
869
870
871
            lambda: _ModelInfo.from_model_cls(self.load_model_cls())
        )
        logger.debug(
            "Loaded model info for class %s.%s", self.module_name, self.class_name
        )
872
873

        # save cache file
874
875
        if module_hash is not None:
            self._save_modelinfo_to_cache(mi, module_hash)
876
877

        return mi
878

879
    def load_model_cls(self) -> type[nn.Module]:
880
881
882
883
884
885
886
887
        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,
888
) -> type[nn.Module] | None:
889
    from vllm.platforms import current_platform
890

891
    current_platform.verify_model_arch(model_arch)
892
893
894
    try:
        return model.load_model_cls()
    except Exception:
895
        logger.exception("Error in loading model architecture '%s'", model_arch)
896
        return None
897
898


899
900
901
902
@lru_cache(maxsize=128)
def _try_inspect_model_cls(
    model_arch: str,
    model: _BaseRegisteredModel,
903
) -> _ModelInfo | None:
904
905
906
    try:
        return model.inspect_model_cls()
    except Exception:
907
        logger.exception("Error in inspecting model architecture '%s'", model_arch)
908
        return None
909
910


911
912
913
@dataclass
class _ModelRegistry:
    # Keyed by model_arch
914
    models: dict[str, _BaseRegisteredModel] = field(default_factory=dict)
915

916
    def get_supported_archs(self) -> Set[str]:
917
        return self.models.keys()
918

919
920
921
    def register_model(
        self,
        model_arch: str,
922
        model_cls: type[nn.Module] | str,
923
    ) -> None:
924
925
926
        """
        Register an external model to be used in vLLM.

927
        `model_cls` can be either:
928

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

939
        if model_arch in self.models:
940
941
            logger.warning(
                "Model architecture %s is already registered, and will be "
942
943
944
945
                "overwritten by the new model class %s.",
                model_arch,
                model_cls,
            )
946
947
948
949
950
951

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

953
            model = _LazyRegisteredModel(*split_str)
954
        elif isinstance(model_cls, type) and issubclass(model_cls, nn.Module):
955
            model = _RegisteredModel.from_model_cls(model_cls)
956
        else:
957
958
959
960
            msg = (
                "`model_cls` should be a string or PyTorch model class, "
                f"not a {type(model_arch)}"
            )
961
            raise TypeError(msg)
962

963
        self.models[model_arch] = model
964

965
    def _raise_for_unsupported(self, architectures: list[str]):
966
        all_supported_archs = self.get_supported_archs()
967

968
969
970
        if any(arch in all_supported_archs for arch in architectures):
            raise ValueError(
                f"Model architectures {architectures} failed "
971
972
                "to be inspected. Please check the logs for more details."
            )
973

974
975
976
977
978
979
980
981
        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 "
982
983
                    "use this model architecture."
                )
984
985
986
987
988
989
990
991
            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."
                )
992

993
994
        raise ValueError(
            f"Model architectures {architectures} are not supported for now. "
995
996
            f"Supported architectures: {all_supported_archs}"
        )
997

998
    def _try_load_model_cls(self, model_arch: str) -> type[nn.Module] | None:
999
1000
        if model_arch not in self.models:
            return None
1001

1002
        return _try_load_model_cls(model_arch, self.models[model_arch])
1003

1004
    def _try_inspect_model_cls(self, model_arch: str) -> _ModelInfo | None:
1005
1006
        if model_arch not in self.models:
            return None
1007

1008
1009
1010
1011
1012
1013
        return _try_inspect_model_cls(model_arch, self.models[model_arch])

    def _try_resolve_transformers(
        self,
        architecture: str,
        model_config: ModelConfig,
1014
    ) -> str | None:
1015
1016
1017
        if architecture in _TRANSFORMERS_BACKEND_MODELS:
            return architecture

1018
1019
1020
        auto_map: dict[str, str] = (
            getattr(model_config.hf_config, "auto_map", None) or dict()
        )
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036

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

        if not model_module.is_backend_compatible():
1068
            if model_config.model_impl != "transformers":
1069
                return None
1070

1071
1072
            raise ValueError(
                f"The Transformers implementation of {architecture!r} "
1073
1074
                "is not compatible with vLLM."
            )
1075

1076
        return model_config._get_transformers_backend_cls()
1077

1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
    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
1103

1104
1105
    def inspect_model_cls(
        self,
1106
        architectures: str | list[str],
1107
        model_config: ModelConfig,
1108
    ) -> tuple[_ModelInfo, str]:
1109
1110
        if isinstance(architectures, str):
            architectures = [architectures]
1111
1112
        if not architectures:
            raise ValueError("No model architectures are specified")
1113
1114

        # Require transformers impl
1115
        if model_config.model_impl == "transformers":
1116
            arch = self._try_resolve_transformers(architectures[0], model_config)
1117
1118
1119
1120
            if arch is not None:
                model_info = self._try_inspect_model_cls(arch)
                if model_info is not None:
                    return (model_info, arch)
1121
        elif model_config.model_impl == "terratorch":
1122
1123
            model_info = self._try_inspect_model_cls("Terratorch")
            return (model_info, "Terratorch")
1124

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

1143
        # Fallback to transformers impl (before resolving runner_type)
1144
1145
1146
1147
1148
        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)
1149
1150
1151
1152
1153
            if arch is not None:
                model_info = self._try_inspect_model_cls(arch)
                if model_info is not None:
                    return (model_info, arch)

1154
        return self._raise_for_unsupported(architectures)
1155

1156
1157
    def resolve_model_cls(
        self,
1158
        architectures: str | list[str],
1159
        model_config: ModelConfig,
1160
    ) -> tuple[type[nn.Module], str]:
1161
1162
        if isinstance(architectures, str):
            architectures = [architectures]
1163
1164
        if not architectures:
            raise ValueError("No model architectures are specified")
1165
1166

        # Require transformers impl
1167
        if model_config.model_impl == "transformers":
1168
            arch = self._try_resolve_transformers(architectures[0], model_config)
1169
1170
1171
1172
            if arch is not None:
                model_cls = self._try_load_model_cls(arch)
                if model_cls is not None:
                    return (model_cls, arch)
1173
        elif model_config.model_impl == "terratorch":
1174
1175
1176
1177
            arch = "Terratorch"
            model_cls = self._try_load_model_cls(arch)
            if model_cls is not None:
                return (model_cls, arch)
1178

1179
        # Fallback to transformers impl (after resolving convert_type)
1180
1181
1182
1183
1184
1185
        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)
1186
1187
1188
1189
1190
1191
1192
            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)
1193
            model_cls = self._try_load_model_cls(normalized_arch)
1194
1195
            if model_cls is not None:
                return (model_cls, arch)
1196

1197
        # Fallback to transformers impl (before resolving runner_type)
1198
1199
1200
1201
1202
        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)
1203
1204
1205
1206
1207
            if arch is not None:
                model_cls = self._try_load_model_cls(arch)
                if model_cls is not None:
                    return (model_cls, arch)

1208
        return self._raise_for_unsupported(architectures)
1209

1210
1211
    def is_text_generation_model(
        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_text_generation_model
1217

1218
    def is_pooling_model(
1219
        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.is_pooling_model
1225
1226
1227

    def is_multimodal_model(
        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
1233

1234
    def is_multimodal_raw_input_only_model(
1235
        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_multimodal_raw_input_only
1241

1242
1243
    def is_pp_supported_model(
        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.supports_pp
1249

1250
1251
    def model_has_inner_state(
        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.has_inner_state
1257

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

1266
1267
    def is_hybrid_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.is_hybrid

1274
1275
    def is_noops_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.has_noops

1282
1283
    def is_transcription_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

1290
1291
    def is_transcription_only_model(
        self,
1292
        architectures: str | list[str],
1293
        model_config: ModelConfig,
1294
    ) -> bool:
1295
        model_cls, _ = self.inspect_model_cls(architectures, model_config)
1296
1297
        return model_cls.supports_transcription_only

1298

1299
1300
1301
1302
1303
1304
1305
1306
1307
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()
    }
)
1308
1309
1310
1311
1312

_T = TypeVar("_T")


def _run_in_subprocess(fn: Callable[[], _T]) -> _T:
1313
1314
1315
1316
1317
    # 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")

1318
        # `cloudpickle` allows pickling lambda functions directly
1319
        import cloudpickle
1320

1321
        input_bytes = cloudpickle.dumps((fn, output_filepath))
1322
1323
1324

        # cannot use `sys.executable __file__` here because the script
        # contains relative imports
1325
1326
1327
        returned = subprocess.run(
            _SUBPROCESS_COMMAND, input=input_bytes, capture_output=True
        )
1328
1329
1330
1331
1332
1333

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

1338
        with open(output_filepath, "rb") as f:
1339
1340
1341
1342
1343
1344
            return pickle.load(f)


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

1346
1347
1348
1349
1350
    load_general_plugins()

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

    result = fn()
1351
1352
1353

    with open(output_file, "wb") as f:
        f.write(pickle.dumps(result))
1354
1355
1356


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