registry.py 25.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
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
56
    "ExaoneForCausalLM": ("exaone", "ExaoneForCausalLM"),
    "FalconForCausalLM": ("falcon", "FalconForCausalLM"),
57
    "Fairseq2LlamaForCausalLM": ("fairseq2_llama", "Fairseq2LlamaForCausalLM"),
58
59
    "GemmaForCausalLM": ("gemma", "GemmaForCausalLM"),
    "Gemma2ForCausalLM": ("gemma2", "Gemma2ForCausalLM"),
60
    "Gemma3ForCausalLM": ("gemma3", "Gemma3ForCausalLM"),
61
    "GlmForCausalLM": ("glm", "GlmForCausalLM"),
Yuxuan Zhang's avatar
Yuxuan Zhang committed
62
    "Glm4ForCausalLM": ("glm4", "Glm4ForCausalLM"),
63
64
65
66
67
68
    "GPT2LMHeadModel": ("gpt2", "GPT2LMHeadModel"),
    "GPTBigCodeForCausalLM": ("gpt_bigcode", "GPTBigCodeForCausalLM"),
    "GPTJForCausalLM": ("gpt_j", "GPTJForCausalLM"),
    "GPTNeoXForCausalLM": ("gpt_neox", "GPTNeoXForCausalLM"),
    "GraniteForCausalLM": ("granite", "GraniteForCausalLM"),
    "GraniteMoeForCausalLM": ("granitemoe", "GraniteMoeForCausalLM"),
69
    "GraniteMoeHybridForCausalLM": ("granitemoehybrid", "GraniteMoeHybridForCausalLM"),   # noqa: E501
70
    "GraniteMoeSharedForCausalLM": ("granitemoeshared", "GraniteMoeSharedForCausalLM"),   # noqa: E501
71
    "GritLM": ("gritlm", "GritLM"),
Michael Goin's avatar
Michael Goin committed
72
    "Grok1ModelForCausalLM": ("grok1", "Grok1ForCausalLM"),
73
74
    "InternLMForCausalLM": ("llama", "LlamaForCausalLM"),
    "InternLM2ForCausalLM": ("internlm2", "InternLM2ForCausalLM"),
75
    "InternLM2VEForCausalLM": ("internlm2_ve", "InternLM2VEForCausalLM"),
76
    "InternLM3ForCausalLM": ("llama", "LlamaForCausalLM"),
77
78
79
80
81
    "JAISLMHeadModel": ("jais", "JAISLMHeadModel"),
    "JambaForCausalLM": ("jamba", "JambaForCausalLM"),
    "LlamaForCausalLM": ("llama", "LlamaForCausalLM"),
    # For decapoda-research/llama-*
    "LLaMAForCausalLM": ("llama", "LlamaForCausalLM"),
82
    "MambaForCausalLM": ("mamba", "MambaForCausalLM"),
83
    "FalconMambaForCausalLM": ("mamba", "MambaForCausalLM"),
Dhia Eddine Rhaiem's avatar
Dhia Eddine Rhaiem committed
84
    "FalconH1ForCausalLM":("falcon_h1", "FalconH1ForCausalLM"),
85
    "Mamba2ForCausalLM": ("mamba2", "Mamba2ForCausalLM"),
86
87
    "MiniCPMForCausalLM": ("minicpm", "MiniCPMForCausalLM"),
    "MiniCPM3ForCausalLM": ("minicpm3", "MiniCPM3ForCausalLM"),
88
89
90
91
92
93
    "MistralForCausalLM": ("llama", "LlamaForCausalLM"),
    "MixtralForCausalLM": ("mixtral", "MixtralForCausalLM"),
    "QuantMixtralForCausalLM": ("mixtral_quant", "MixtralForCausalLM"),
    # transformers's mpt class has lower case
    "MptForCausalLM": ("mpt", "MPTForCausalLM"),
    "MPTForCausalLM": ("mpt", "MPTForCausalLM"),
94
    "MiMoForCausalLM": ("mimo", "MiMoForCausalLM"),
95
    "NemotronForCausalLM": ("nemotron", "NemotronForCausalLM"),
Luis Vega's avatar
Luis Vega committed
96
    "NemotronHForCausalLM": ("nemotron_h", "NemotronHForCausalLM"),
97
    "OlmoForCausalLM": ("olmo", "OlmoForCausalLM"),
98
    "Olmo2ForCausalLM": ("olmo2", "Olmo2ForCausalLM"),
99
100
101
102
103
104
105
106
    "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
107
    "Plamo2ForCausalLM": ("plamo2", "Plamo2ForCausalLM"),
108
    "QWenLMHeadModel": ("qwen", "QWenLMHeadModel"),
109
110
    "Qwen2ForCausalLM": ("qwen2", "Qwen2ForCausalLM"),
    "Qwen2MoeForCausalLM": ("qwen2_moe", "Qwen2MoeForCausalLM"),
111
112
    "Qwen3ForCausalLM": ("qwen3", "Qwen3ForCausalLM"),
    "Qwen3MoeForCausalLM": ("qwen3_moe", "Qwen3MoeForCausalLM"),
113
114
115
116
117
    "RWForCausalLM": ("falcon", "FalconForCausalLM"),
    "StableLMEpochForCausalLM": ("stablelm", "StablelmForCausalLM"),
    "StableLmForCausalLM": ("stablelm", "StablelmForCausalLM"),
    "Starcoder2ForCausalLM": ("starcoder2", "Starcoder2ForCausalLM"),
    "SolarForCausalLM": ("solar", "SolarForCausalLM"),
118
    "TeleChat2ForCausalLM": ("telechat2", "TeleChat2ForCausalLM"),
119
    "TeleFLMForCausalLM": ("teleflm", "TeleFLMForCausalLM"),
120
    "XverseForCausalLM": ("llama", "LlamaForCausalLM"),
121
    "Zamba2ForCausalLM": ("zamba2", "Zamba2ForCausalLM"),
122
123
124
    # [Encoder-decoder]
    "BartModel": ("bart", "BartForConditionalGeneration"),
    "BartForConditionalGeneration": ("bart", "BartForConditionalGeneration"),
125
126
127
}

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

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

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

_SPECULATIVE_DECODING_MODELS = {
230
    "MiMoMTPModel": ("mimo_mtp", "MiMoMTP"),
231
    "EAGLEModel": ("eagle", "EAGLE"),
232
    "EagleLlamaForCausalLM": ("llama_eagle", "EagleLlamaForCausalLM"),
233
    "EagleMiniCPMForCausalLM": ("minicpm_eagle", "EagleMiniCPMForCausalLM"),
234
    "Eagle3LlamaForCausalLM": ("llama_eagle3", "Eagle3LlamaForCausalLM"),
235
    "DeepSeekMTPModel": ("deepseek_mtp", "DeepSeekMTP"),
236
237
    "MedusaModel": ("medusa", "Medusa"),
    "MLPSpeculatorPreTrainedModel": ("mlp_speculator", "MLPSpeculator"),
238
}
239

240
_TRANSFORMERS_MODELS = {
241
    "TransformersForCausalLM": ("transformers", "TransformersForCausalLM"),
242
}
243
# yapf: enable
244

245
_VLLM_MODELS = {
246
    **_TEXT_GENERATION_MODELS,
247
    **_EMBEDDING_MODELS,
248
    **_CROSS_ENCODER_MODELS,
249
    **_MULTIMODAL_MODELS,
250
    **_SPECULATIVE_DECODING_MODELS,
251
    **_TRANSFORMERS_MODELS,
252
253
}

254
255
256
257
258
259
260
261
# 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"
]

262

263
264
@dataclass(frozen=True)
class _ModelInfo:
265
    architecture: str
266
    is_text_generation_model: bool
267
    is_pooling_model: bool
268
    supports_cross_encoding: bool
269
270
    supports_multimodal: bool
    supports_pp: bool
271
272
    has_inner_state: bool
    is_attention_free: bool
273
    is_hybrid: bool
274
    has_noops: bool
275
    supports_transcription: bool
276
    supports_v0_only: bool
277
278

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


296
class _BaseRegisteredModel(ABC):
297

298
299
300
    @abstractmethod
    def inspect_model_cls(self) -> _ModelInfo:
        raise NotImplementedError
301

302
    @abstractmethod
303
    def load_model_cls(self) -> type[nn.Module]:
304
        raise NotImplementedError
305
306


307
308
309
310
311
312
313
@dataclass(frozen=True)
class _RegisteredModel(_BaseRegisteredModel):
    """
    Represents a model that has already been imported in the main process.
    """

    interfaces: _ModelInfo
314
    model_cls: type[nn.Module]
315
316

    @staticmethod
317
    def from_model_cls(model_cls: type[nn.Module]):
318
319
320
321
322
323
324
325
        return _RegisteredModel(
            interfaces=_ModelInfo.from_model_cls(model_cls),
            model_cls=model_cls,
        )

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

326
    def load_model_cls(self) -> type[nn.Module]:
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
        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()))

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


363
364
365
366
367
368
369
370
371
372
373
@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
374
375


376
377
378
@dataclass
class _ModelRegistry:
    # Keyed by model_arch
379
    models: dict[str, _BaseRegisteredModel] = field(default_factory=dict)
380

381
    def get_supported_archs(self) -> Set[str]:
382
        return self.models.keys()
383

384
385
386
    def register_model(
        self,
        model_arch: str,
387
        model_cls: Union[type[nn.Module], str],
388
    ) -> None:
389
390
391
        """
        Register an external model to be used in vLLM.

392
        `model_cls` can be either:
393

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

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

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

424
        self.models[model_arch] = model
425

426
    def _raise_for_unsupported(self, architectures: list[str]):
427
        all_supported_archs = self.get_supported_archs()
428

429
430
431
432
433
        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.")

434
435
436
        raise ValueError(
            f"Model architectures {architectures} are not supported for now. "
            f"Supported architectures: {all_supported_archs}")
437

438
    def _try_load_model_cls(self,
439
                            model_arch: str) -> Optional[type[nn.Module]]:
440
441
        if model_arch not in self.models:
            return None
442

443
        return _try_load_model_cls(model_arch, self.models[model_arch])
444

445
446
447
    def _try_inspect_model_cls(self, model_arch: str) -> Optional[_ModelInfo]:
        if model_arch not in self.models:
            return None
448

449
        return _try_inspect_model_cls(model_arch, self.models[model_arch])
450

451
452
    def _normalize_archs(
        self,
453
454
        architectures: Union[str, list[str]],
    ) -> list[str]:
455
456
457
458
459
        if isinstance(architectures, str):
            architectures = [architectures]
        if not architectures:
            logger.warning("No model architectures are specified")

460
461
462
463
        # filter out support architectures
        normalized_arch = list(
            filter(lambda model: model in self.models, architectures))

464
        # make sure Transformers backend is put at the last as a fallback
465
        if len(normalized_arch) != len(architectures):
466
            normalized_arch.append("TransformersForCausalLM")
467
        return normalized_arch
468

469
470
    def inspect_model_cls(
        self,
471
472
        architectures: Union[str, list[str]],
    ) -> tuple[_ModelInfo, str]:
473
        architectures = self._normalize_archs(architectures)
474

475
476
477
        for arch in architectures:
            model_info = self._try_inspect_model_cls(arch)
            if model_info is not None:
478
                return (model_info, arch)
479

480
        return self._raise_for_unsupported(architectures)
481

482
483
    def resolve_model_cls(
        self,
484
485
        architectures: Union[str, list[str]],
    ) -> tuple[type[nn.Module], str]:
486
        architectures = self._normalize_archs(architectures)
487

488
489
490
491
        for arch in architectures:
            model_cls = self._try_load_model_cls(arch)
            if model_cls is not None:
                return (model_cls, arch)
492

493
        return self._raise_for_unsupported(architectures)
494

495
496
    def is_text_generation_model(
        self,
497
        architectures: Union[str, list[str]],
498
    ) -> bool:
499
500
        model_cls, _ = self.inspect_model_cls(architectures)
        return model_cls.is_text_generation_model
501

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

509
510
    def is_cross_encoder_model(
        self,
511
        architectures: Union[str, list[str]],
512
    ) -> bool:
513
514
        model_cls, _ = self.inspect_model_cls(architectures)
        return model_cls.supports_cross_encoding
515

516
517
    def is_multimodal_model(
        self,
518
        architectures: Union[str, list[str]],
519
    ) -> bool:
520
521
        model_cls, _ = self.inspect_model_cls(architectures)
        return model_cls.supports_multimodal
522
523
524

    def is_pp_supported_model(
        self,
525
        architectures: Union[str, list[str]],
526
    ) -> bool:
527
528
        model_cls, _ = self.inspect_model_cls(architectures)
        return model_cls.supports_pp
529

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

537
538
    def is_attention_free_model(
        self,
539
        architectures: Union[str, list[str]],
540
541
542
    ) -> bool:
        model_cls, _ = self.inspect_model_cls(architectures)
        return model_cls.is_attention_free
543

544
545
    def is_hybrid_model(
        self,
546
        architectures: Union[str, list[str]],
547
548
549
550
    ) -> bool:
        model_cls, _ = self.inspect_model_cls(architectures)
        return model_cls.is_hybrid

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

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

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

572
573

ModelRegistry = _ModelRegistry({
574
575
    model_arch:
    _LazyRegisteredModel(
576
577
578
579
580
581
582
583
584
585
        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:
586
587
588
589
590
    # 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")

591
        # `cloudpickle` allows pickling lambda functions directly
592
        input_bytes = cloudpickle.dumps((fn, output_filepath))
593
594
595

        # cannot use `sys.executable __file__` here because the script
        # contains relative imports
596
597
598
        returned = subprocess.run(_SUBPROCESS_COMMAND,
                                  input=input_bytes,
                                  capture_output=True)
599
600
601
602
603
604
605
606
607

        # 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

608
        with open(output_filepath, "rb") as f:
609
610
611
612
613
614
615
616
617
618
619
            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()
620
621
622

    with open(output_file, "wb") as f:
        f.write(pickle.dumps(result))
623
624
625


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