registry.py 29 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
import importlib
8
import os
9
import pickle
10
11
import subprocess
import sys
12
import tempfile
13
from abc import ABC, abstractmethod
14
from collections.abc import Set
15
from dataclasses import asdict, dataclass, field
16
from functools import lru_cache
17
from typing import Callable, Optional, TypeVar, Union
18
19
20
21
22

import torch.nn as nn

from vllm.logger import init_logger

23
24
from .interfaces import (has_inner_state, has_noops, is_attention_free,
                         is_hybrid, supports_cross_encoding,
25
26
                         supports_multimodal, supports_multimodal_raw_input,
                         supports_pp, supports_transcription, supports_v0_only)
27
from .interfaces_base import is_text_generation_model
28
29
30

logger = init_logger(__name__)

31
# yapf: disable
32
33
_TEXT_GENERATION_MODELS = {
    # [Decoder-only]
34
35
    "AquilaModel": ("llama", "LlamaForCausalLM"),
    "AquilaForCausalLM": ("llama", "LlamaForCausalLM"),  # AquilaChat2
Raghav Ravishankar's avatar
Raghav Ravishankar committed
36
    "ArceeForCausalLM": ("arcee", "ArceeForCausalLM"),
37
    "ArcticForCausalLM": ("arctic", "ArcticForCausalLM"),
38
    "MiniMaxForCausalLM": ("minimax_text_01", "MiniMaxText01ForCausalLM"),
39
    "MiniMaxText01ForCausalLM": ("minimax_text_01", "MiniMaxText01ForCausalLM"),
40
    "MiniMaxM1ForCausalLM": ("minimax_text_01", "MiniMaxText01ForCausalLM"),
41
42
43
44
    # baichuan-7b, upper case 'C' in the class name
    "BaiChuanForCausalLM": ("baichuan", "BaiChuanForCausalLM"),
    # baichuan-13b, lower case 'c' in the class name
    "BaichuanForCausalLM": ("baichuan", "BaichuanForCausalLM"),
45
    "BailingMoeForCausalLM": ("bailing_moe", "BailingMoeForCausalLM"),
Yu Chin Fabian Lim's avatar
Yu Chin Fabian Lim committed
46
    "BambaForCausalLM": ("bamba", "BambaForCausalLM"),
47
    "BloomForCausalLM": ("bloom", "BloomForCausalLM"),
48
    "ChatGLMModel": ("chatglm", "ChatGLMForCausalLM"),
49
    "ChatGLMForConditionalGeneration": ("chatglm", "ChatGLMForCausalLM"),
50
    "CohereForCausalLM": ("commandr", "CohereForCausalLM"),
51
    "Cohere2ForCausalLM": ("commandr", "CohereForCausalLM"),
52
    "DbrxForCausalLM": ("dbrx", "DbrxForCausalLM"),
53
    "DeciLMForCausalLM": ("nemotron_nas", "DeciLMForCausalLM"),
54
55
    "DeepseekForCausalLM": ("deepseek", "DeepseekForCausalLM"),
    "DeepseekV2ForCausalLM": ("deepseek_v2", "DeepseekV2ForCausalLM"),
56
    "DeepseekV3ForCausalLM": ("deepseek_v2", "DeepseekV3ForCausalLM"),
57
    "Dots1ForCausalLM": ("dots1", "Dots1ForCausalLM"),
58
59
    "Ernie4_5_ForCausalLM": ("ernie45", "Ernie4_5_ForCausalLM"),
    "Ernie4_5_MoeForCausalLM": ("ernie45_moe", "Ernie4_5_MoeForCausalLM"),
60
    "ExaoneForCausalLM": ("exaone", "ExaoneForCausalLM"),
61
    "Exaone4ForCausalLM": ("exaone4", "Exaone4ForCausalLM"),
62
    "FalconForCausalLM": ("falcon", "FalconForCausalLM"),
63
    "FM9GForCausalLM": ("fm9g", "FM9GForCausalLM"),
64
    "Fairseq2LlamaForCausalLM": ("fairseq2_llama", "Fairseq2LlamaForCausalLM"),
65
66
    "GemmaForCausalLM": ("gemma", "GemmaForCausalLM"),
    "Gemma2ForCausalLM": ("gemma2", "Gemma2ForCausalLM"),
67
    "Gemma3ForCausalLM": ("gemma3", "Gemma3ForCausalLM"),
Robert Shaw's avatar
Robert Shaw committed
68
69
    #TODO(ywang96): Support multimodal gemma3n
    "Gemma3nForConditionalGeneration": ("gemma3n", "Gemma3nForConditionalGeneration"),    # noqa: E501
70
    "GlmForCausalLM": ("glm", "GlmForCausalLM"),
Yuxuan Zhang's avatar
Yuxuan Zhang committed
71
    "Glm4ForCausalLM": ("glm4", "Glm4ForCausalLM"),
zhuwenwen's avatar
zhuwenwen committed
72
    "Glm4MoeForCausalLM": ("glm4_moe", "Glm4MoeForCausalLM"),
73
74
75
76
77
78
    "GPT2LMHeadModel": ("gpt2", "GPT2LMHeadModel"),
    "GPTBigCodeForCausalLM": ("gpt_bigcode", "GPTBigCodeForCausalLM"),
    "GPTJForCausalLM": ("gpt_j", "GPTJForCausalLM"),
    "GPTNeoXForCausalLM": ("gpt_neox", "GPTNeoXForCausalLM"),
    "GraniteForCausalLM": ("granite", "GraniteForCausalLM"),
    "GraniteMoeForCausalLM": ("granitemoe", "GraniteMoeForCausalLM"),
79
    "GraniteMoeHybridForCausalLM": ("granitemoehybrid", "GraniteMoeHybridForCausalLM"),   # noqa: E501
80
    "GraniteMoeSharedForCausalLM": ("granitemoeshared", "GraniteMoeSharedForCausalLM"),   # noqa: E501
81
    "GritLM": ("gritlm", "GritLM"),
Michael Goin's avatar
Michael Goin committed
82
    "Grok1ModelForCausalLM": ("grok1", "Grok1ForCausalLM"),
83
84
    "HunYuanMoEV1ForCausalLM": ("hunyuan_v1", "HunYuanMoEV1ForCausalLM"),
    "HunYuanDenseV1ForCausalLM": ("hunyuan_v1", "HunYuanDenseV1ForCausalLM"),
85
86
    "InternLMForCausalLM": ("llama", "LlamaForCausalLM"),
    "InternLM2ForCausalLM": ("internlm2", "InternLM2ForCausalLM"),
87
    "InternLM2VEForCausalLM": ("internlm2_ve", "InternLM2VEForCausalLM"),
88
    "InternLM3ForCausalLM": ("llama", "LlamaForCausalLM"),
89
90
91
92
93
    "JAISLMHeadModel": ("jais", "JAISLMHeadModel"),
    "JambaForCausalLM": ("jamba", "JambaForCausalLM"),
    "LlamaForCausalLM": ("llama", "LlamaForCausalLM"),
    # For decapoda-research/llama-*
    "LLaMAForCausalLM": ("llama", "LlamaForCausalLM"),
94
    "MambaForCausalLM": ("mamba", "MambaForCausalLM"),
95
    "FalconMambaForCausalLM": ("mamba", "MambaForCausalLM"),
Dhia Eddine Rhaiem's avatar
Dhia Eddine Rhaiem committed
96
    "FalconH1ForCausalLM":("falcon_h1", "FalconH1ForCausalLM"),
97
    "Mamba2ForCausalLM": ("mamba2", "Mamba2ForCausalLM"),
98
99
    "MiniCPMForCausalLM": ("minicpm", "MiniCPMForCausalLM"),
    "MiniCPM3ForCausalLM": ("minicpm3", "MiniCPM3ForCausalLM"),
100
101
102
103
104
105
    "MistralForCausalLM": ("llama", "LlamaForCausalLM"),
    "MixtralForCausalLM": ("mixtral", "MixtralForCausalLM"),
    "QuantMixtralForCausalLM": ("mixtral_quant", "MixtralForCausalLM"),
    # transformers's mpt class has lower case
    "MptForCausalLM": ("mpt", "MPTForCausalLM"),
    "MPTForCausalLM": ("mpt", "MPTForCausalLM"),
106
    "MiMoForCausalLM": ("mimo", "MiMoForCausalLM"),
107
    "NemotronForCausalLM": ("nemotron", "NemotronForCausalLM"),
Luis Vega's avatar
Luis Vega committed
108
    "NemotronHForCausalLM": ("nemotron_h", "NemotronHForCausalLM"),
109
    "OlmoForCausalLM": ("olmo", "OlmoForCausalLM"),
110
    "Olmo2ForCausalLM": ("olmo2", "Olmo2ForCausalLM"),
111
112
113
114
115
116
117
    "OlmoeForCausalLM": ("olmoe", "OlmoeForCausalLM"),
    "OPTForCausalLM": ("opt", "OPTForCausalLM"),
    "OrionForCausalLM": ("orion", "OrionForCausalLM"),
    "PersimmonForCausalLM": ("persimmon", "PersimmonForCausalLM"),
    "PhiForCausalLM": ("phi", "PhiForCausalLM"),
    "Phi3ForCausalLM": ("phi3", "Phi3ForCausalLM"),
    "PhiMoEForCausalLM": ("phimoe", "PhiMoEForCausalLM"),
118
    "Phi4FlashForCausalLM": ("phi4flash", "Phi4FlashForCausalLM"),
Shinichi Hemmi's avatar
Shinichi Hemmi committed
119
    "Plamo2ForCausalLM": ("plamo2", "Plamo2ForCausalLM"),
120
    "QWenLMHeadModel": ("qwen", "QWenLMHeadModel"),
121
122
    "Qwen2ForCausalLM": ("qwen2", "Qwen2ForCausalLM"),
    "Qwen2MoeForCausalLM": ("qwen2_moe", "Qwen2MoeForCausalLM"),
123
124
    "Qwen3ForCausalLM": ("qwen3", "Qwen3ForCausalLM"),
    "Qwen3MoeForCausalLM": ("qwen3_moe", "Qwen3MoeForCausalLM"),
125
126
127
128
129
    "RWForCausalLM": ("falcon", "FalconForCausalLM"),
    "StableLMEpochForCausalLM": ("stablelm", "StablelmForCausalLM"),
    "StableLmForCausalLM": ("stablelm", "StablelmForCausalLM"),
    "Starcoder2ForCausalLM": ("starcoder2", "Starcoder2ForCausalLM"),
    "SolarForCausalLM": ("solar", "SolarForCausalLM"),
130
    "TeleChat2ForCausalLM": ("telechat2", "TeleChat2ForCausalLM"),
131
    "TeleFLMForCausalLM": ("teleflm", "TeleFLMForCausalLM"),
132
    "XverseForCausalLM": ("llama", "LlamaForCausalLM"),
133
    "Zamba2ForCausalLM": ("zamba2", "Zamba2ForCausalLM"),
134
135
136
    # [Encoder-decoder]
    "BartModel": ("bart", "BartForConditionalGeneration"),
    "BartForConditionalGeneration": ("bart", "BartForConditionalGeneration"),
137
138
139
}

_EMBEDDING_MODELS = {
140
    # [Text-only]
141
    "BertModel": ("bert", "BertEmbeddingModel"),
142
    "DeciLMForCausalLM": ("nemotron_nas", "DeciLMForCausalLM"),
143
    "Gemma2Model": ("gemma2", "Gemma2ForCausalLM"),
144
    "GlmForCausalLM": ("glm", "GlmForCausalLM"),
145
    "GPT2ForSequenceClassification": ("gpt2", "GPT2ForSequenceClassification"),
146
    "GritLM": ("gritlm", "GritLM"),
147
148
    "GteModel": ("bert_with_rope", "SnowflakeGteNewModel"),
    "GteNewModel": ("bert_with_rope", "GteNewModel"),
149
    "InternLM2ForRewardModel": ("internlm2", "InternLM2ForRewardModel"),
150
    "JambaForSequenceClassification": ("jamba", "JambaForSequenceClassification"),  # noqa: E501
151
    "LlamaModel": ("llama", "LlamaForCausalLM"),
152
153
154
155
156
    **{
        # Multiple models share the same architecture, so we include them all
        k: (mod, arch) for k, (mod, arch) in _TEXT_GENERATION_MODELS.items()
        if arch == "LlamaForCausalLM"
    },
157
    "MistralModel": ("llama", "LlamaForCausalLM"),
158
    "ModernBertModel": ("modernbert", "ModernBertModel"),
159
    "NomicBertModel": ("bert_with_rope", "NomicBertModel"),
160
    "Phi3ForCausalLM": ("phi3", "Phi3ForCausalLM"),
161
    "Qwen2Model": ("qwen2", "Qwen2ForCausalLM"),
162
    "Qwen2ForCausalLM": ("qwen2", "Qwen2ForCausalLM"),
163
    "Qwen2ForRewardModel": ("qwen2_rm", "Qwen2ForRewardModel"),
164
    "Qwen2ForProcessRewardModel": ("qwen2_rm", "Qwen2ForProcessRewardModel"),
165
166
    "RobertaForMaskedLM": ("roberta", "RobertaEmbeddingModel"),
    "RobertaModel": ("roberta", "RobertaEmbeddingModel"),
167
    "TeleChat2ForCausalLM": ("telechat2", "TeleChat2ForCausalLM"),
168
    "XLMRobertaModel": ("roberta", "RobertaEmbeddingModel"),
169
    # [Multimodal]
Cyrus Leung's avatar
Cyrus Leung committed
170
    "LlavaNextForConditionalGeneration": ("llava_next", "LlavaNextForConditionalGeneration"),  # noqa: E501
171
    "Phi3VForCausalLM": ("phi3v", "Phi3VForCausalLM"),
172
    "Qwen2VLForConditionalGeneration": ("qwen2_vl", "Qwen2VLForConditionalGeneration"),  # noqa: E501
173
174
175
176
    # Technically PrithviGeoSpatialMAE is a model that works on images, both in
    # input and output. I am adding it here because it piggy-backs on embedding
    # models for the time being.
    "PrithviGeoSpatialMAE": ("prithvi_geospatial_mae", "PrithviGeoSpatialMAE"),
177
178
}

179
180
181
182
183
184
_CROSS_ENCODER_MODELS = {
    "BertForSequenceClassification": ("bert", "BertForSequenceClassification"),
    "RobertaForSequenceClassification": ("roberta",
                                         "RobertaForSequenceClassification"),
    "XLMRobertaForSequenceClassification": ("roberta",
                                            "RobertaForSequenceClassification"),
xsank's avatar
xsank committed
185
186
    "ModernBertForSequenceClassification": ("modernbert",
                                            "ModernBertForSequenceClassification"),
187
    # [Auto-converted (see adapters.py)]
188
    "JinaVLForRanking": ("jina_vl", "JinaVLForSequenceClassification"), # noqa: E501,
189
190
}

191
_MULTIMODAL_MODELS = {
192
    # [Decoder-only]
193
    "AriaForConditionalGeneration": ("aria", "AriaForConditionalGeneration"),
Jennifer Zhao's avatar
Jennifer Zhao committed
194
    "AyaVisionForConditionalGeneration": ("aya_vision", "AyaVisionForConditionalGeneration"),  # noqa: E501
195
196
    "Blip2ForConditionalGeneration": ("blip2", "Blip2ForConditionalGeneration"),
    "ChameleonForConditionalGeneration": ("chameleon", "ChameleonForConditionalGeneration"),  # noqa: E501
197
    "DeepseekVLV2ForCausalLM": ("deepseek_vl2", "DeepseekVLV2ForCausalLM"),
198
    "FuyuForCausalLM": ("fuyu", "FuyuForCausalLM"),
199
    "Gemma3ForConditionalGeneration": ("gemma3_mm", "Gemma3ForConditionalGeneration"),  # noqa: E501
200
    "GLM4VForCausalLM": ("glm4v", "GLM4VForCausalLM"),
201
    "Glm4vForConditionalGeneration": ("glm4_1v", "Glm4vForConditionalGeneration"),  # noqa: E501
202
    "GraniteSpeechForConditionalGeneration": ("granite_speech", "GraniteSpeechForConditionalGeneration"),  # noqa: E501
203
    "H2OVLChatModel": ("h2ovl", "H2OVLChatModel"),
204
    "InternVLChatModel": ("internvl", "InternVLChatModel"),
205
    "Idefics3ForConditionalGeneration":("idefics3","Idefics3ForConditionalGeneration"),
206
    "SmolVLMForConditionalGeneration": ("smolvlm","SmolVLMForConditionalGeneration"),  # noqa: E501
207
    "KeyeForConditionalGeneration": ("keye", "KeyeForConditionalGeneration"),
208
    "KimiVLForConditionalGeneration": ("kimi_vl", "KimiVLForConditionalGeneration"),  # noqa: E501
209
    "Llama_Nemotron_Nano_VL": ("nemotron_vl", "LlamaNemotronVLChatModel"),
210
211
212
213
    "LlavaForConditionalGeneration": ("llava", "LlavaForConditionalGeneration"),
    "LlavaNextForConditionalGeneration": ("llava_next", "LlavaNextForConditionalGeneration"),  # noqa: E501
    "LlavaNextVideoForConditionalGeneration": ("llava_next_video", "LlavaNextVideoForConditionalGeneration"),  # noqa: E501
    "LlavaOnevisionForConditionalGeneration": ("llava_onevision", "LlavaOnevisionForConditionalGeneration"),  # noqa: E501
214
    "MantisForConditionalGeneration": ("llava", "MantisForConditionalGeneration"),  # noqa: E501
215
    "MiniMaxVL01ForConditionalGeneration": ("minimax_vl_01", "MiniMaxVL01ForConditionalGeneration"),  # noqa: E501
216
    "MiniCPMO": ("minicpmo", "MiniCPMO"),
217
    "MiniCPMV": ("minicpmv", "MiniCPMV"),
218
    "Mistral3ForConditionalGeneration": ("mistral3", "Mistral3ForConditionalGeneration"),  # noqa: E501
219
    "MolmoForCausalLM": ("molmo", "MolmoForCausalLM"),
220
    "NVLM_D": ("nvlm_d", "NVLM_D_Model"),
221
    "Ovis": ("ovis", "Ovis"),
222
    "PaliGemmaForConditionalGeneration": ("paligemma", "PaliGemmaForConditionalGeneration"),  # noqa: E501
223
    "Phi3VForCausalLM": ("phi3v", "Phi3VForCausalLM"),
224
    "PixtralForConditionalGeneration": ("pixtral", "PixtralForConditionalGeneration"),  # noqa: E501
225
    "QwenVLForConditionalGeneration": ("qwen_vl", "QwenVLForConditionalGeneration"),  # noqa: E501
226
    "Qwen2VLForConditionalGeneration": ("qwen2_vl", "Qwen2VLForConditionalGeneration"),  # noqa: E501
Roger Wang's avatar
Roger Wang committed
227
    "Qwen2_5_VLForConditionalGeneration": ("qwen2_5_vl", "Qwen2_5_VLForConditionalGeneration"),  # noqa: E501
228
    "Qwen2AudioForConditionalGeneration": ("qwen2_audio", "Qwen2AudioForConditionalGeneration"),  # noqa: E501
229
    "Qwen2_5OmniModel": ("qwen2_5_omni_thinker", "Qwen2_5OmniThinkerForConditionalGeneration"),  # noqa: E501
230
    "Qwen2_5OmniForConditionalGeneration": ("qwen2_5_omni_thinker", "Qwen2_5OmniThinkerForConditionalGeneration"),  # noqa: E501
231
    "UltravoxModel": ("ultravox", "UltravoxModel"),
232
    "Phi4MMForCausalLM": ("phi4mm", "Phi4MMForCausalLM"),
汪志鹏's avatar
汪志鹏 committed
233
    "TarsierForConditionalGeneration": ("tarsier", "TarsierForConditionalGeneration"),  # noqa: E501
234
    "Tarsier2ForConditionalGeneration": ("qwen2_vl", "Tarsier2ForConditionalGeneration"),  # noqa: E501
Patrick von Platen's avatar
Patrick von Platen committed
235
    "VoxtralForConditionalGeneration": ("voxtral", "VoxtralForConditionalGeneration"),  # noqa: E501
236
    # [Encoder-decoder]
237
    "Florence2ForConditionalGeneration": ("florence2", "Florence2ForConditionalGeneration"),  # noqa: E501
238
    "MllamaForConditionalGeneration": ("mllama", "MllamaForConditionalGeneration"),  # noqa: E501
239
    "Llama4ForConditionalGeneration": ("mllama4", "Llama4ForConditionalGeneration"),  # noqa: E501
240
    "SkyworkR1VChatModel": ("skyworkr1v", "SkyworkR1VChatModel"),
241
    "WhisperForConditionalGeneration": ("whisper", "WhisperForConditionalGeneration"),  # noqa: E501
242
}
243
244

_SPECULATIVE_DECODING_MODELS = {
245
    "MiMoMTPModel": ("mimo_mtp", "MiMoMTP"),
246
    "EagleLlamaForCausalLM": ("llama_eagle", "EagleLlamaForCausalLM"),
zhiweiz's avatar
zhiweiz committed
247
    "EagleLlama4ForCausalLM": ("llama4_eagle", "EagleLlama4ForCausalLM"),
248
    "EagleMiniCPMForCausalLM": ("minicpm_eagle", "EagleMiniCPMForCausalLM"),
249
    "Eagle3LlamaForCausalLM": ("llama_eagle3", "Eagle3LlamaForCausalLM"),
250
    "DeepSeekMTPModel": ("deepseek_mtp", "DeepSeekMTP"),
zhuwenwen's avatar
zhuwenwen committed
251
    "Glm4MoeMTPModel": ("glm4_moe_mtp", "Glm4MoeMTP"),
252
    "MedusaModel": ("medusa", "Medusa"),
253
254
255
    # Temporarily disabled.
    # # TODO(woosuk): Re-enable this once the MLP Speculator is supported in V1.
    # "MLPSpeculatorPreTrainedModel": ("mlp_speculator", "MLPSpeculator"),
256
}
257

258
_TRANSFORMERS_MODELS = {
259
    "TransformersForMultimodalLM": ("transformers", "TransformersForMultimodalLM"), # noqa: E501
260
    "TransformersForCausalLM": ("transformers", "TransformersForCausalLM"),
261
}
262
# yapf: enable
263

264
_VLLM_MODELS = {
265
    **_TEXT_GENERATION_MODELS,
266
    **_EMBEDDING_MODELS,
267
    **_CROSS_ENCODER_MODELS,
268
    **_MULTIMODAL_MODELS,
269
    **_SPECULATIVE_DECODING_MODELS,
270
    **_TRANSFORMERS_MODELS,
271
272
}

273
274
275
276
277
278
279
280
# 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.
_SUBPROCESS_COMMAND = [
    sys.executable, "-m", "vllm.model_executor.models.registry"
]

281
282
_PREVIOUSLY_SUPPORTED_MODELS = {"Phi3SmallForCausalLM": "0.9.2"}

283

284
285
@dataclass(frozen=True)
class _ModelInfo:
286
    architecture: str
287
    is_text_generation_model: bool
288
    is_pooling_model: bool
289
    supports_cross_encoding: bool
290
    supports_multimodal: bool
291
    supports_multimodal_raw_input: bool
292
    supports_pp: bool
293
294
    has_inner_state: bool
    is_attention_free: bool
295
    is_hybrid: bool
296
    has_noops: bool
297
    supports_transcription: bool
298
    supports_transcription_only: bool
299
    supports_v0_only: bool
300
301

    @staticmethod
302
    def from_model_cls(model: type[nn.Module]) -> "_ModelInfo":
303
        return _ModelInfo(
304
            architecture=model.__name__,
305
            is_text_generation_model=is_text_generation_model(model),
306
            is_pooling_model=True,  # Can convert any model into a pooling model
307
            supports_cross_encoding=supports_cross_encoding(model),
308
            supports_multimodal=supports_multimodal(model),
309
            supports_multimodal_raw_input=supports_multimodal_raw_input(model),
310
            supports_pp=supports_pp(model),
311
312
            has_inner_state=has_inner_state(model),
            is_attention_free=is_attention_free(model),
313
            is_hybrid=is_hybrid(model),
314
            supports_transcription=supports_transcription(model),
315
316
            supports_transcription_only=(supports_transcription(model) and
                                         model.supports_transcription_only),
317
            supports_v0_only=supports_v0_only(model),
318
            has_noops=has_noops(model),
319
        )
320
321


322
class _BaseRegisteredModel(ABC):
323

324
325
326
    @abstractmethod
    def inspect_model_cls(self) -> _ModelInfo:
        raise NotImplementedError
327

328
    @abstractmethod
329
    def load_model_cls(self) -> type[nn.Module]:
330
        raise NotImplementedError
331
332


333
334
335
336
337
338
339
@dataclass(frozen=True)
class _RegisteredModel(_BaseRegisteredModel):
    """
    Represents a model that has already been imported in the main process.
    """

    interfaces: _ModelInfo
340
    model_cls: type[nn.Module]
341
342

    @staticmethod
343
    def from_model_cls(model_cls: type[nn.Module]):
344
345
346
347
348
349
350
351
        return _RegisteredModel(
            interfaces=_ModelInfo.from_model_cls(model_cls),
            model_cls=model_cls,
        )

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

352
    def load_model_cls(self) -> type[nn.Module]:
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
        return self.model_cls


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

    # Performed in another process to avoid initializing CUDA
    def inspect_model_cls(self) -> _ModelInfo:
        return _run_in_subprocess(
            lambda: _ModelInfo.from_model_cls(self.load_model_cls()))

369
    def load_model_cls(self) -> type[nn.Module]:
370
371
372
373
374
375
376
377
        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,
378
) -> Optional[type[nn.Module]]:
379
    from vllm.platforms import current_platform
380
    current_platform.verify_model_arch(model_arch)
381
382
383
384
385
386
    try:
        return model.load_model_cls()
    except Exception:
        logger.exception("Error in loading model architecture '%s'",
                         model_arch)
        return None
387
388


389
390
391
392
393
394
395
396
397
398
399
@lru_cache(maxsize=128)
def _try_inspect_model_cls(
    model_arch: str,
    model: _BaseRegisteredModel,
) -> Optional[_ModelInfo]:
    try:
        return model.inspect_model_cls()
    except Exception:
        logger.exception("Error in inspecting model architecture '%s'",
                         model_arch)
        return None
400
401


402
403
404
@dataclass
class _ModelRegistry:
    # Keyed by model_arch
405
    models: dict[str, _BaseRegisteredModel] = field(default_factory=dict)
406

407
    def get_supported_archs(self) -> Set[str]:
408
        return self.models.keys()
409

410
411
412
    def register_model(
        self,
        model_arch: str,
413
        model_cls: Union[type[nn.Module], str],
414
    ) -> None:
415
416
417
        """
        Register an external model to be used in vLLM.

418
        `model_cls` can be either:
419

420
        - A [`torch.nn.Module`][] class directly referencing the model.
421
        - A string in the format `<module>:<class>` which can be used to
422
423
          lazily import the model. This is useful to avoid initializing CUDA
          when importing the model and thus the related error
424
          `RuntimeError: Cannot re-initialize CUDA in forked subprocess`.
425
        """
426
427
428
429
        if not isinstance(model_arch, str):
            msg = f"`model_arch` should be a string, not a {type(model_arch)}"
            raise TypeError(msg)

430
        if model_arch in self.models:
431
432
433
            logger.warning(
                "Model architecture %s is already registered, and will be "
                "overwritten by the new model class %s.", model_arch,
434
435
436
437
438
439
440
                model_cls)

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

442
            model = _LazyRegisteredModel(*split_str)
443
        elif isinstance(model_cls, type) and issubclass(model_cls, nn.Module):
444
            model = _RegisteredModel.from_model_cls(model_cls)
445
446
447
448
        else:
            msg = ("`model_cls` should be a string or PyTorch model class, "
                   f"not a {type(model_arch)}")
            raise TypeError(msg)
449

450
        self.models[model_arch] = model
451

452
    def _raise_for_unsupported(self, architectures: list[str]):
453
        all_supported_archs = self.get_supported_archs()
454

455
456
457
458
459
        if any(arch in all_supported_archs for arch in architectures):
            raise ValueError(
                f"Model architectures {architectures} failed "
                "to be inspected. Please check the logs for more details.")

460
461
462
        raise ValueError(
            f"Model architectures {architectures} are not supported for now. "
            f"Supported architectures: {all_supported_archs}")
463

464
    def _try_load_model_cls(self,
465
                            model_arch: str) -> Optional[type[nn.Module]]:
466
467
        if model_arch not in self.models:
            return None
468

469
        return _try_load_model_cls(model_arch, self.models[model_arch])
470

471
    def _try_inspect_model_cls(self, model_arch: str) -> Optional[_ModelInfo]:
472
473
474
475
476
477
478
479
        if model_arch in self.models:
            return _try_inspect_model_cls(model_arch, self.models[model_arch])

        if model_arch.endswith("ForSequenceClassification"):
            causal_lm_arch = model_arch.replace("ForSequenceClassification",
                                                "ForCausalLM")
            if causal_lm_arch not in self.models:
                return None
480

481
482
483
484
485
486
487
488
489
490
491
            info = _try_inspect_model_cls(causal_lm_arch,
                                          self.models[causal_lm_arch])

            info = _ModelInfo(**dict(
                asdict(info), **{
                    "architecture": model_arch,
                    "supports_cross_encoding": True
                }))
            return info

        return None
492

493
494
    def _normalize_archs(
        self,
495
496
        architectures: Union[str, list[str]],
    ) -> list[str]:
497
498
499
500
501
        if isinstance(architectures, str):
            architectures = [architectures]
        if not architectures:
            logger.warning("No model architectures are specified")

502
503
504
505
        # filter out support architectures
        normalized_arch = list(
            filter(lambda model: model in self.models, architectures))

506
507
508
509
510
511
512
513
514
        # try automatic conversion in adapters.py
        for arch in architectures:
            if not arch.endswith("ForSequenceClassification"):
                continue
            causal_lm_arch = arch.replace("ForSequenceClassification",
                                          "ForCausalLM")
            if causal_lm_arch in self.models:
                normalized_arch.append(arch)

515
516
517
518
519
520
521
522
        # NOTE(Isotr0py): Be careful of architectures' order!
        # Make sure Transformers backend architecture is at the end of the
        # list, otherwise pooling models automatic conversion will fail!
        for arch in normalized_arch:
            if arch.startswith("TransformersFor"):
                normalized_arch.remove(arch)
                normalized_arch.append(arch)

523
        return normalized_arch
524

525
526
    def inspect_model_cls(
        self,
527
528
        architectures: Union[str, list[str]],
    ) -> tuple[_ModelInfo, str]:
529
        architectures = self._normalize_archs(architectures)
530

531
532
533
        for arch in architectures:
            model_info = self._try_inspect_model_cls(arch)
            if model_info is not None:
534
                return (model_info, arch)
535

536
        return self._raise_for_unsupported(architectures)
537

538
539
    def resolve_model_cls(
        self,
540
541
        architectures: Union[str, list[str]],
    ) -> tuple[type[nn.Module], str]:
542
        architectures = self._normalize_archs(architectures)
543

544
545
546
547
        for arch in architectures:
            model_cls = self._try_load_model_cls(arch)
            if model_cls is not None:
                return (model_cls, arch)
548

549
        return self._raise_for_unsupported(architectures)
550

551
552
    def is_text_generation_model(
        self,
553
        architectures: Union[str, list[str]],
554
    ) -> bool:
555
556
        model_cls, _ = self.inspect_model_cls(architectures)
        return model_cls.is_text_generation_model
557

558
    def is_pooling_model(
559
        self,
560
        architectures: Union[str, list[str]],
561
    ) -> bool:
562
        model_cls, _ = self.inspect_model_cls(architectures)
563
        return model_cls.is_pooling_model
564

565
566
    def is_cross_encoder_model(
        self,
567
        architectures: Union[str, list[str]],
568
    ) -> bool:
569
570
        model_cls, _ = self.inspect_model_cls(architectures)
        return model_cls.supports_cross_encoding
571

572
573
    def is_multimodal_model(
        self,
574
        architectures: Union[str, list[str]],
575
    ) -> bool:
576
577
        model_cls, _ = self.inspect_model_cls(architectures)
        return model_cls.supports_multimodal
578

579
580
581
582
583
584
585
    def supports_multimodal_raw_input(
        self,
        architectures: Union[str, list[str]],
    ) -> bool:
        model_cls, _ = self.inspect_model_cls(architectures)
        return model_cls.supports_multimodal_raw_input

586
587
    def is_pp_supported_model(
        self,
588
        architectures: Union[str, list[str]],
589
    ) -> bool:
590
591
        model_cls, _ = self.inspect_model_cls(architectures)
        return model_cls.supports_pp
592

593
594
    def model_has_inner_state(
        self,
595
        architectures: Union[str, list[str]],
596
597
598
    ) -> bool:
        model_cls, _ = self.inspect_model_cls(architectures)
        return model_cls.has_inner_state
599

600
601
    def is_attention_free_model(
        self,
602
        architectures: Union[str, list[str]],
603
604
605
    ) -> bool:
        model_cls, _ = self.inspect_model_cls(architectures)
        return model_cls.is_attention_free
606

607
608
    def is_hybrid_model(
        self,
609
        architectures: Union[str, list[str]],
610
611
612
613
    ) -> bool:
        model_cls, _ = self.inspect_model_cls(architectures)
        return model_cls.is_hybrid

614
615
    def is_noops_model(
        self,
616
        architectures: Union[str, list[str]],
617
618
619
620
    ) -> bool:
        model_cls, _ = self.inspect_model_cls(architectures)
        return model_cls.has_noops

621
622
    def is_transcription_model(
        self,
623
        architectures: Union[str, list[str]],
624
625
626
627
    ) -> bool:
        model_cls, _ = self.inspect_model_cls(architectures)
        return model_cls.supports_transcription

628
629
630
631
632
633
634
    def is_transcription_only_model(
        self,
        architectures: Union[str, list[str]],
    ) -> bool:
        model_cls, _ = self.inspect_model_cls(architectures)
        return model_cls.supports_transcription_only

635
636
    def is_v1_compatible(
        self,
637
        architectures: Union[str, list[str]],
638
639
640
641
    ) -> bool:
        model_cls, _ = self.inspect_model_cls(architectures)
        return not model_cls.supports_v0_only

642
643

ModelRegistry = _ModelRegistry({
644
645
    model_arch:
    _LazyRegisteredModel(
646
647
648
649
650
651
652
653
654
655
        module_name=f"vllm.model_executor.models.{mod_relname}",
        class_name=cls_name,
    )
    for model_arch, (mod_relname, cls_name) in _VLLM_MODELS.items()
})

_T = TypeVar("_T")


def _run_in_subprocess(fn: Callable[[], _T]) -> _T:
656
657
658
659
660
    # 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")

661
        # `cloudpickle` allows pickling lambda functions directly
662
        import cloudpickle
663
        input_bytes = cloudpickle.dumps((fn, output_filepath))
664
665
666

        # cannot use `sys.executable __file__` here because the script
        # contains relative imports
667
668
669
        returned = subprocess.run(_SUBPROCESS_COMMAND,
                                  input=input_bytes,
                                  capture_output=True)
670
671
672
673
674
675
676
677
678

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

679
        with open(output_filepath, "rb") as f:
680
681
682
683
684
685
686
687
688
689
690
            return pickle.load(f)


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

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

    result = fn()
691
692
693

    with open(output_file, "wb") as f:
        f.write(pickle.dumps(result))
694
695
696


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