registry.py 25.9 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
16
from dataclasses import dataclass, field
from functools import lru_cache
17
from typing import Callable, Optional, TypeVar, Union
18

19
import cloudpickle
20
21
22
23
import torch.nn as nn

from vllm.logger import init_logger

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

logger = init_logger(__name__)

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

_EMBEDDING_MODELS = {
132
    # [Text-only]
133
    "BertModel": ("bert", "BertEmbeddingModel"),
134
    "DeciLMForCausalLM": ("nemotron_nas", "DeciLMForCausalLM"),
135
    "Gemma2Model": ("gemma2", "Gemma2ForCausalLM"),
136
    "GlmForCausalLM": ("glm", "GlmForCausalLM"),
137
    "GPT2ForSequenceClassification": ("gpt2", "GPT2ForSequenceClassification"),
138
    "GritLM": ("gritlm", "GritLM"),
139
140
    "GteModel": ("bert_with_rope", "SnowflakeGteNewModel"),
    "GteNewModel": ("bert_with_rope", "GteNewModel"),
141
    "InternLM2ForRewardModel": ("internlm2", "InternLM2ForRewardModel"),
142
    "JambaForSequenceClassification": ("jamba", "JambaForSequenceClassification"),  # noqa: E501
143
    "LlamaModel": ("llama", "LlamaForCausalLM"),
144
145
146
147
148
    **{
        # 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"
    },
149
    "MistralModel": ("llama", "LlamaForCausalLM"),
150
    "ModernBertModel": ("modernbert", "ModernBertModel"),
151
    "NomicBertModel": ("bert_with_rope", "NomicBertModel"),
152
    "Phi3ForCausalLM": ("phi3", "Phi3ForCausalLM"),
153
    "Qwen2Model": ("qwen2", "Qwen2ForCausalLM"),
154
    "Qwen2ForCausalLM": ("qwen2", "Qwen2ForCausalLM"),
155
    "Qwen2ForRewardModel": ("qwen2_rm", "Qwen2ForRewardModel"),
156
    "Qwen2ForProcessRewardModel": ("qwen2_rm", "Qwen2ForProcessRewardModel"),
157
158
    "RobertaForMaskedLM": ("roberta", "RobertaEmbeddingModel"),
    "RobertaModel": ("roberta", "RobertaEmbeddingModel"),
159
    "TeleChat2ForCausalLM": ("telechat2", "TeleChat2ForCausalLM"),
160
    "XLMRobertaModel": ("roberta", "RobertaEmbeddingModel"),
161
    # [Multimodal]
Cyrus Leung's avatar
Cyrus Leung committed
162
    "LlavaNextForConditionalGeneration": ("llava_next", "LlavaNextForConditionalGeneration"),  # noqa: E501
163
    "Phi3VForCausalLM": ("phi3v", "Phi3VForCausalLM"),
164
    "Qwen2VLForConditionalGeneration": ("qwen2_vl", "Qwen2VLForConditionalGeneration"),  # noqa: E501
165
166
    # [Auto-converted (see adapters.py)]
    "Qwen2ForSequenceClassification": ("qwen2", "Qwen2ForCausalLM"),
167
168
169
170
    # 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"),
171
172
}

173
174
175
176
177
178
_CROSS_ENCODER_MODELS = {
    "BertForSequenceClassification": ("bert", "BertForSequenceClassification"),
    "RobertaForSequenceClassification": ("roberta",
                                         "RobertaForSequenceClassification"),
    "XLMRobertaForSequenceClassification": ("roberta",
                                            "RobertaForSequenceClassification"),
xsank's avatar
xsank committed
179
180
    "ModernBertForSequenceClassification": ("modernbert",
                                            "ModernBertForSequenceClassification"),
181
    "Qwen3ForSequenceClassification": ("qwen3", "Qwen3ForSequenceClassification"), # noqa: E501
182
183
}

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

_SPECULATIVE_DECODING_MODELS = {
235
    "MiMoMTPModel": ("mimo_mtp", "MiMoMTP"),
236
    "EAGLEModel": ("eagle", "EAGLE"),
237
    "EagleLlamaForCausalLM": ("llama_eagle", "EagleLlamaForCausalLM"),
238
    "EagleMiniCPMForCausalLM": ("minicpm_eagle", "EagleMiniCPMForCausalLM"),
239
    "Eagle3LlamaForCausalLM": ("llama_eagle3", "Eagle3LlamaForCausalLM"),
240
    "DeepSeekMTPModel": ("deepseek_mtp", "DeepSeekMTP"),
241
242
    "MedusaModel": ("medusa", "Medusa"),
    "MLPSpeculatorPreTrainedModel": ("mlp_speculator", "MLPSpeculator"),
243
}
244

245
_TRANSFORMERS_MODELS = {
246
    "TransformersForCausalLM": ("transformers", "TransformersForCausalLM"),
247
}
248
# yapf: enable
249

250
_VLLM_MODELS = {
251
    **_TEXT_GENERATION_MODELS,
252
    **_EMBEDDING_MODELS,
253
    **_CROSS_ENCODER_MODELS,
254
    **_MULTIMODAL_MODELS,
255
    **_SPECULATIVE_DECODING_MODELS,
256
    **_TRANSFORMERS_MODELS,
257
258
}

259
260
261
262
263
264
265
266
# 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"
]

267

268
269
@dataclass(frozen=True)
class _ModelInfo:
270
    architecture: str
271
    is_text_generation_model: bool
272
    is_pooling_model: bool
273
    supports_cross_encoding: bool
274
275
    supports_multimodal: bool
    supports_pp: bool
276
277
    has_inner_state: bool
    is_attention_free: bool
278
    is_hybrid: bool
279
    has_noops: bool
280
    supports_transcription: bool
281
    supports_v0_only: bool
282
283

    @staticmethod
284
    def from_model_cls(model: type[nn.Module]) -> "_ModelInfo":
285
        return _ModelInfo(
286
            architecture=model.__name__,
287
            is_text_generation_model=is_text_generation_model(model),
288
            is_pooling_model=True,  # Can convert any model into a pooling model
289
            supports_cross_encoding=supports_cross_encoding(model),
290
291
            supports_multimodal=supports_multimodal(model),
            supports_pp=supports_pp(model),
292
293
            has_inner_state=has_inner_state(model),
            is_attention_free=is_attention_free(model),
294
            is_hybrid=is_hybrid(model),
295
296
            supports_transcription=supports_transcription(model),
            supports_v0_only=supports_v0_only(model),
297
            has_noops=has_noops(model),
298
        )
299
300


301
class _BaseRegisteredModel(ABC):
302

303
304
305
    @abstractmethod
    def inspect_model_cls(self) -> _ModelInfo:
        raise NotImplementedError
306

307
    @abstractmethod
308
    def load_model_cls(self) -> type[nn.Module]:
309
        raise NotImplementedError
310
311


312
313
314
315
316
317
318
@dataclass(frozen=True)
class _RegisteredModel(_BaseRegisteredModel):
    """
    Represents a model that has already been imported in the main process.
    """

    interfaces: _ModelInfo
319
    model_cls: type[nn.Module]
320
321

    @staticmethod
322
    def from_model_cls(model_cls: type[nn.Module]):
323
324
325
326
327
328
329
330
        return _RegisteredModel(
            interfaces=_ModelInfo.from_model_cls(model_cls),
            model_cls=model_cls,
        )

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

331
    def load_model_cls(self) -> type[nn.Module]:
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
        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()))

348
    def load_model_cls(self) -> type[nn.Module]:
349
350
351
352
353
354
355
356
        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,
357
) -> Optional[type[nn.Module]]:
358
    from vllm.platforms import current_platform
359
    current_platform.verify_model_arch(model_arch)
360
361
362
363
364
365
    try:
        return model.load_model_cls()
    except Exception:
        logger.exception("Error in loading model architecture '%s'",
                         model_arch)
        return None
366
367


368
369
370
371
372
373
374
375
376
377
378
@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
379
380


381
382
383
@dataclass
class _ModelRegistry:
    # Keyed by model_arch
384
    models: dict[str, _BaseRegisteredModel] = field(default_factory=dict)
385

386
    def get_supported_archs(self) -> Set[str]:
387
        return self.models.keys()
388

389
390
391
    def register_model(
        self,
        model_arch: str,
392
        model_cls: Union[type[nn.Module], str],
393
    ) -> None:
394
395
396
        """
        Register an external model to be used in vLLM.

397
        `model_cls` can be either:
398

399
        - A [`torch.nn.Module`][] class directly referencing the model.
400
        - A string in the format `<module>:<class>` which can be used to
401
402
          lazily import the model. This is useful to avoid initializing CUDA
          when importing the model and thus the related error
403
          `RuntimeError: Cannot re-initialize CUDA in forked subprocess`.
404
        """
405
406
407
408
        if not isinstance(model_arch, str):
            msg = f"`model_arch` should be a string, not a {type(model_arch)}"
            raise TypeError(msg)

409
        if model_arch in self.models:
410
411
412
            logger.warning(
                "Model architecture %s is already registered, and will be "
                "overwritten by the new model class %s.", model_arch,
413
414
415
416
417
418
419
                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)
420

421
            model = _LazyRegisteredModel(*split_str)
422
        elif isinstance(model_cls, type) and issubclass(model_cls, nn.Module):
423
            model = _RegisteredModel.from_model_cls(model_cls)
424
425
426
427
        else:
            msg = ("`model_cls` should be a string or PyTorch model class, "
                   f"not a {type(model_arch)}")
            raise TypeError(msg)
428

429
        self.models[model_arch] = model
430

431
    def _raise_for_unsupported(self, architectures: list[str]):
432
        all_supported_archs = self.get_supported_archs()
433

434
435
436
437
438
        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.")

439
440
441
        raise ValueError(
            f"Model architectures {architectures} are not supported for now. "
            f"Supported architectures: {all_supported_archs}")
442

443
    def _try_load_model_cls(self,
444
                            model_arch: str) -> Optional[type[nn.Module]]:
445
446
        if model_arch not in self.models:
            return None
447

448
        return _try_load_model_cls(model_arch, self.models[model_arch])
449

450
451
452
    def _try_inspect_model_cls(self, model_arch: str) -> Optional[_ModelInfo]:
        if model_arch not in self.models:
            return None
453

454
        return _try_inspect_model_cls(model_arch, self.models[model_arch])
455

456
457
    def _normalize_archs(
        self,
458
459
        architectures: Union[str, list[str]],
    ) -> list[str]:
460
461
462
463
464
        if isinstance(architectures, str):
            architectures = [architectures]
        if not architectures:
            logger.warning("No model architectures are specified")

465
466
467
468
        # filter out support architectures
        normalized_arch = list(
            filter(lambda model: model in self.models, architectures))

469
        # make sure Transformers backend is put at the last as a fallback
470
        if len(normalized_arch) != len(architectures):
471
            normalized_arch.append("TransformersForCausalLM")
472
        return normalized_arch
473

474
475
    def inspect_model_cls(
        self,
476
477
        architectures: Union[str, list[str]],
    ) -> tuple[_ModelInfo, str]:
478
        architectures = self._normalize_archs(architectures)
479

480
481
482
        for arch in architectures:
            model_info = self._try_inspect_model_cls(arch)
            if model_info is not None:
483
                return (model_info, arch)
484

485
        return self._raise_for_unsupported(architectures)
486

487
488
    def resolve_model_cls(
        self,
489
490
        architectures: Union[str, list[str]],
    ) -> tuple[type[nn.Module], str]:
491
        architectures = self._normalize_archs(architectures)
492

493
494
495
496
        for arch in architectures:
            model_cls = self._try_load_model_cls(arch)
            if model_cls is not None:
                return (model_cls, arch)
497

498
        return self._raise_for_unsupported(architectures)
499

500
501
    def is_text_generation_model(
        self,
502
        architectures: Union[str, list[str]],
503
    ) -> bool:
504
505
        model_cls, _ = self.inspect_model_cls(architectures)
        return model_cls.is_text_generation_model
506

507
    def is_pooling_model(
508
        self,
509
        architectures: Union[str, list[str]],
510
    ) -> bool:
511
        model_cls, _ = self.inspect_model_cls(architectures)
512
        return model_cls.is_pooling_model
513

514
515
    def is_cross_encoder_model(
        self,
516
        architectures: Union[str, list[str]],
517
    ) -> bool:
518
519
        model_cls, _ = self.inspect_model_cls(architectures)
        return model_cls.supports_cross_encoding
520

521
522
    def is_multimodal_model(
        self,
523
        architectures: Union[str, list[str]],
524
    ) -> bool:
525
526
        model_cls, _ = self.inspect_model_cls(architectures)
        return model_cls.supports_multimodal
527
528
529

    def is_pp_supported_model(
        self,
530
        architectures: Union[str, list[str]],
531
    ) -> bool:
532
533
        model_cls, _ = self.inspect_model_cls(architectures)
        return model_cls.supports_pp
534

535
536
    def model_has_inner_state(
        self,
537
        architectures: Union[str, list[str]],
538
539
540
    ) -> bool:
        model_cls, _ = self.inspect_model_cls(architectures)
        return model_cls.has_inner_state
541

542
543
    def is_attention_free_model(
        self,
544
        architectures: Union[str, list[str]],
545
546
547
    ) -> bool:
        model_cls, _ = self.inspect_model_cls(architectures)
        return model_cls.is_attention_free
548

549
550
    def is_hybrid_model(
        self,
551
        architectures: Union[str, list[str]],
552
553
554
555
    ) -> bool:
        model_cls, _ = self.inspect_model_cls(architectures)
        return model_cls.is_hybrid

556
557
    def is_noops_model(
        self,
558
        architectures: Union[str, list[str]],
559
560
561
562
    ) -> bool:
        model_cls, _ = self.inspect_model_cls(architectures)
        return model_cls.has_noops

563
564
    def is_transcription_model(
        self,
565
        architectures: Union[str, list[str]],
566
567
568
569
    ) -> bool:
        model_cls, _ = self.inspect_model_cls(architectures)
        return model_cls.supports_transcription

570
571
    def is_v1_compatible(
        self,
572
        architectures: Union[str, list[str]],
573
574
575
576
    ) -> bool:
        model_cls, _ = self.inspect_model_cls(architectures)
        return not model_cls.supports_v0_only

577
578

ModelRegistry = _ModelRegistry({
579
580
    model_arch:
    _LazyRegisteredModel(
581
582
583
584
585
586
587
588
589
590
        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:
591
592
593
594
595
    # 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")

596
        # `cloudpickle` allows pickling lambda functions directly
597
        input_bytes = cloudpickle.dumps((fn, output_filepath))
598
599
600

        # cannot use `sys.executable __file__` here because the script
        # contains relative imports
601
602
603
        returned = subprocess.run(_SUBPROCESS_COMMAND,
                                  input=input_bytes,
                                  capture_output=True)
604
605
606
607
608
609
610
611
612

        # 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

613
        with open(output_filepath, "rb") as f:
614
615
616
617
618
619
620
621
622
623
624
            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()
625
626
627

    with open(output_file, "wb") as f:
        f.write(pickle.dumps(result))
628
629
630


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