configuration_auto.py 43.8 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
# coding=utf-8
# Copyright 2018 The HuggingFace Inc. team.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
Sylvain Gugger's avatar
Sylvain Gugger committed
15
""" Auto Config class."""
16
import importlib
17
import os
18
import re
19
import warnings
20
from collections import OrderedDict
21
from typing import List, Union
22

Sylvain Gugger's avatar
Sylvain Gugger committed
23
from ...configuration_utils import PretrainedConfig
24
from ...dynamic_module_utils import get_class_from_dynamic_module, resolve_trust_remote_code
25
from ...utils import CONFIG_NAME, logging
Aymeric Augustin's avatar
Aymeric Augustin committed
26

27

28
29
logger = logging.get_logger(__name__)

30
31
32
CONFIG_MAPPING_NAMES = OrderedDict(
    [
        # Add configs here
33
        ("albert", "AlbertConfig"),
34
        ("align", "AlignConfig"),
Jongjyh's avatar
Jongjyh committed
35
        ("altclip", "AltCLIPConfig"),
36
        ("audio-spectrogram-transformer", "ASTConfig"),
37
        ("autoformer", "AutoformerConfig"),
Yoach Lacombe's avatar
Yoach Lacombe committed
38
        ("bark", "BarkConfig"),
39
        ("bart", "BartConfig"),
40
        ("beit", "BeitConfig"),
41
42
43
44
        ("bert", "BertConfig"),
        ("bert-generation", "BertGenerationConfig"),
        ("big_bird", "BigBirdConfig"),
        ("bigbird_pegasus", "BigBirdPegasusConfig"),
Kamal Raj Kanakarajan's avatar
Kamal Raj Kanakarajan committed
45
        ("biogpt", "BioGptConfig"),
NielsRogge's avatar
NielsRogge committed
46
        ("bit", "BitConfig"),
47
48
        ("blenderbot", "BlenderbotConfig"),
        ("blenderbot-small", "BlenderbotSmallConfig"),
Younes Belkada's avatar
Younes Belkada committed
49
        ("blip", "BlipConfig"),
NielsRogge's avatar
NielsRogge committed
50
        ("blip-2", "Blip2Config"),
Younes Belkada's avatar
Younes Belkada committed
51
        ("bloom", "BloomConfig"),
52
        ("bridgetower", "BridgeTowerConfig"),
53
        ("camembert", "CamembertConfig"),
54
        ("canine", "CanineConfig"),
55
        ("chinese_clip", "ChineseCLIPConfig"),
56
        ("clap", "ClapConfig"),
57
        ("clip", "CLIPConfig"),
NielsRogge's avatar
NielsRogge committed
58
        ("clipseg", "CLIPSegConfig"),
rooa's avatar
rooa committed
59
        ("codegen", "CodeGenConfig"),
60
        ("conditional_detr", "ConditionalDetrConfig"),
61
62
        ("convbert", "ConvBertConfig"),
        ("convnext", "ConvNextConfig"),
Alara Dirik's avatar
Alara Dirik committed
63
        ("convnextv2", "ConvNextV2Config"),
64
        ("cpmant", "CpmAntConfig"),
65
        ("ctrl", "CTRLConfig"),
NielsRogge's avatar
NielsRogge committed
66
        ("cvt", "CvtConfig"),
67
68
69
70
71
72
        ("data2vec-audio", "Data2VecAudioConfig"),
        ("data2vec-text", "Data2VecTextConfig"),
        ("data2vec-vision", "Data2VecVisionConfig"),
        ("deberta", "DebertaConfig"),
        ("deberta-v2", "DebertaV2Config"),
        ("decision_transformer", "DecisionTransformerConfig"),
NielsRogge's avatar
NielsRogge committed
73
        ("deformable_detr", "DeformableDetrConfig"),
74
        ("deit", "DeiTConfig"),
NielsRogge's avatar
NielsRogge committed
75
        ("deta", "DetaConfig"),
76
        ("detr", "DetrConfig"),
77
        ("dinat", "DinatConfig"),
NielsRogge's avatar
NielsRogge committed
78
        ("dinov2", "Dinov2Config"),
79
        ("distilbert", "DistilBertConfig"),
NielsRogge's avatar
NielsRogge committed
80
        ("donut-swin", "DonutSwinConfig"),
81
82
        ("dpr", "DPRConfig"),
        ("dpt", "DPTConfig"),
83
        ("efficientformer", "EfficientFormerConfig"),
Alara Dirik's avatar
Alara Dirik committed
84
        ("efficientnet", "EfficientNetConfig"),
85
        ("electra", "ElectraConfig"),
86
        ("encodec", "EncodecConfig"),
87
        ("encoder-decoder", "EncoderDecoderConfig"),
88
        ("ernie", "ErnieConfig"),
89
        ("ernie_m", "ErnieMConfig"),
90
        ("esm", "EsmConfig"),
Matt's avatar
Matt committed
91
        ("falcon", "FalconConfig"),
92
93
94
        ("flaubert", "FlaubertConfig"),
        ("flava", "FlavaConfig"),
        ("fnet", "FNetConfig"),
NielsRogge's avatar
NielsRogge committed
95
        ("focalnet", "FocalNetConfig"),
96
97
        ("fsmt", "FSMTConfig"),
        ("funnel", "FunnelConfig"),
98
        ("git", "GitConfig"),
99
        ("glpn", "GLPNConfig"),
100
        ("gpt-sw3", "GPT2Config"),
101
        ("gpt2", "GPT2Config"),
102
        ("gpt_bigcode", "GPTBigCodeConfig"),
103
        ("gpt_neo", "GPTNeoConfig"),
104
        ("gpt_neox", "GPTNeoXConfig"),
105
        ("gpt_neox_japanese", "GPTNeoXJapaneseConfig"),
106
        ("gptj", "GPTJConfig"),
107
        ("gptsan-japanese", "GPTSanJapaneseConfig"),
108
        ("graphormer", "GraphormerConfig"),
109
        ("groupvit", "GroupViTConfig"),
110
        ("hubert", "HubertConfig"),
111
        ("ibert", "IBertConfig"),
112
        ("imagegpt", "ImageGPTConfig"),
113
        ("informer", "InformerConfig"),
NielsRogge's avatar
NielsRogge committed
114
        ("instructblip", "InstructBlipConfig"),
115
        ("jukebox", "JukeboxConfig"),
116
117
        ("layoutlm", "LayoutLMConfig"),
        ("layoutlmv2", "LayoutLMv2Config"),
NielsRogge's avatar
NielsRogge committed
118
        ("layoutlmv3", "LayoutLMv3Config"),
119
        ("led", "LEDConfig"),
120
        ("levit", "LevitConfig"),
NielsRogge's avatar
NielsRogge committed
121
        ("lilt", "LiltConfig"),
Jason Phang's avatar
Jason Phang committed
122
        ("llama", "LlamaConfig"),
123
        ("longformer", "LongformerConfig"),
Daniel Stancl's avatar
Daniel Stancl committed
124
        ("longt5", "LongT5Config"),
125
126
127
        ("luke", "LukeConfig"),
        ("lxmert", "LxmertConfig"),
        ("m2m_100", "M2M100Config"),
128
        ("marian", "MarianConfig"),
NielsRogge's avatar
NielsRogge committed
129
        ("markuplm", "MarkupLMConfig"),
Alara Dirik's avatar
Alara Dirik committed
130
        ("mask2former", "Mask2FormerConfig"),
131
        ("maskformer", "MaskFormerConfig"),
132
        ("maskformer-swin", "MaskFormerSwinConfig"),
133
        ("mbart", "MBartConfig"),
Chan Woo Kim's avatar
Chan Woo Kim committed
134
        ("mctct", "MCTCTConfig"),
135
        ("mega", "MegaConfig"),
136
        ("megatron-bert", "MegatronBertConfig"),
wangpeng's avatar
wangpeng committed
137
        ("mgp-str", "MgpstrConfig"),
138
        ("mobilebert", "MobileBertConfig"),
139
        ("mobilenet_v1", "MobileNetV1Config"),
140
        ("mobilenet_v2", "MobileNetV2Config"),
141
        ("mobilevit", "MobileViTConfig"),
Shehan Munasinghe's avatar
Shehan Munasinghe committed
142
        ("mobilevitv2", "MobileViTV2Config"),
143
        ("mpnet", "MPNetConfig"),
144
        ("mpt", "MptConfig"),
145
        ("mra", "MraConfig"),
146
        ("mt5", "MT5Config"),
Sanchit Gandhi's avatar
Sanchit Gandhi committed
147
        ("musicgen", "MusicgenConfig"),
StevenTang1998's avatar
StevenTang1998 committed
148
        ("mvp", "MvpConfig"),
149
        ("nat", "NatConfig"),
150
        ("nezha", "NezhaConfig"),
151
        ("nllb-moe", "NllbMoeConfig"),
152
        ("nystromformer", "NystromformerConfig"),
Jitesh Jain's avatar
Jitesh Jain committed
153
        ("oneformer", "OneFormerConfig"),
154
        ("open-llama", "OpenLlamaConfig"),
155
        ("openai-gpt", "OpenAIGPTConfig"),
Younes Belkada's avatar
Younes Belkada committed
156
        ("opt", "OPTConfig"),
157
        ("owlvit", "OwlViTConfig"),
158
        ("pegasus", "PegasusConfig"),
Jason Phang's avatar
Jason Phang committed
159
        ("pegasus_x", "PegasusXConfig"),
160
        ("perceiver", "PerceiverConfig"),
Younes Belkada's avatar
Younes Belkada committed
161
        ("pix2struct", "Pix2StructConfig"),
162
163
164
        ("plbart", "PLBartConfig"),
        ("poolformer", "PoolFormerConfig"),
        ("prophetnet", "ProphetNetConfig"),
Rinat's avatar
Rinat committed
165
        ("pvt", "PvtConfig"),
166
167
168
        ("qdqbert", "QDQBertConfig"),
        ("rag", "RagConfig"),
        ("realm", "RealmConfig"),
169
        ("reformer", "ReformerConfig"),
170
171
172
173
        ("regnet", "RegNetConfig"),
        ("rembert", "RemBertConfig"),
        ("resnet", "ResNetConfig"),
        ("retribert", "RetriBertConfig"),
174
        ("roberta", "RobertaConfig"),
175
        ("roberta-prelayernorm", "RobertaPreLayerNormConfig"),
Weiwe Shi's avatar
Weiwe Shi committed
176
        ("roc_bert", "RoCBertConfig"),
177
        ("roformer", "RoFormerConfig"),
Sylvain Gugger's avatar
Sylvain Gugger committed
178
        ("rwkv", "RwkvConfig"),
179
        ("sam", "SamConfig"),
180
181
182
        ("segformer", "SegformerConfig"),
        ("sew", "SEWConfig"),
        ("sew-d", "SEWDConfig"),
183
        ("speech-encoder-decoder", "SpeechEncoderDecoderConfig"),
184
185
        ("speech_to_text", "Speech2TextConfig"),
        ("speech_to_text_2", "Speech2Text2Config"),
186
        ("speecht5", "SpeechT5Config"),
Ori Ram's avatar
Ori Ram committed
187
        ("splinter", "SplinterConfig"),
188
        ("squeezebert", "SqueezeBertConfig"),
Shehan Munasinghe's avatar
Shehan Munasinghe committed
189
        ("swiftformer", "SwiftFormerConfig"),
190
        ("swin", "SwinConfig"),
NielsRogge's avatar
NielsRogge committed
191
        ("swin2sr", "Swin2SRConfig"),
192
        ("swinv2", "Swinv2Config"),
193
        ("switch_transformers", "SwitchTransformersConfig"),
194
        ("t5", "T5Config"),
195
        ("table-transformer", "TableTransformerConfig"),
196
        ("tapas", "TapasConfig"),
197
        ("time_series_transformer", "TimeSeriesTransformerConfig"),
198
        ("timesformer", "TimesformerConfig"),
amyeroberts's avatar
amyeroberts committed
199
        ("timm_backbone", "TimmBackboneConfig"),
Carl's avatar
Carl committed
200
        ("trajectory_transformer", "TrajectoryTransformerConfig"),
201
202
        ("transfo-xl", "TransfoXLConfig"),
        ("trocr", "TrOCRConfig"),
Zineng Tang's avatar
Zineng Tang committed
203
        ("tvlt", "TvltConfig"),
204
        ("umt5", "UMT5Config"),
205
        ("unispeech", "UniSpeechConfig"),
206
        ("unispeech-sat", "UniSpeechSatConfig"),
NielsRogge's avatar
NielsRogge committed
207
        ("upernet", "UperNetConfig"),
208
        ("van", "VanConfig"),
NielsRogge's avatar
NielsRogge committed
209
        ("videomae", "VideoMAEConfig"),
210
211
212
213
214
        ("vilt", "ViltConfig"),
        ("vision-encoder-decoder", "VisionEncoderDecoderConfig"),
        ("vision-text-dual-encoder", "VisionTextDualEncoderConfig"),
        ("visual_bert", "VisualBertConfig"),
        ("vit", "ViTConfig"),
NielsRogge's avatar
NielsRogge committed
215
        ("vit_hybrid", "ViTHybridConfig"),
216
        ("vit_mae", "ViTMAEConfig"),
217
        ("vit_msn", "ViTMSNConfig"),
Jegor Kit拧kerkin's avatar
Jegor Kit拧kerkin committed
218
        ("vivit", "VivitConfig"),
219
        ("wav2vec2", "Wav2Vec2Config"),
220
        ("wav2vec2-conformer", "Wav2Vec2ConformerConfig"),
Patrick von Platen's avatar
Patrick von Platen committed
221
        ("wavlm", "WavLMConfig"),
222
        ("whisper", "WhisperConfig"),
NielsRogge's avatar
NielsRogge committed
223
        ("xclip", "XCLIPConfig"),
224
225
226
227
228
229
        ("xglm", "XGLMConfig"),
        ("xlm", "XLMConfig"),
        ("xlm-prophetnet", "XLMProphetNetConfig"),
        ("xlm-roberta", "XLMRobertaConfig"),
        ("xlm-roberta-xl", "XLMRobertaXLConfig"),
        ("xlnet", "XLNetConfig"),
Jannis Vamvas's avatar
Jannis Vamvas committed
230
        ("xmod", "XmodConfig"),
231
232
        ("yolos", "YolosConfig"),
        ("yoso", "YosoConfig"),
233
234
    ]
)
235

236
CONFIG_ARCHIVE_MAP_MAPPING_NAMES = OrderedDict(
237
    [
NielsRogge's avatar
NielsRogge committed
238
        # Add archive maps here)
239
        ("albert", "ALBERT_PRETRAINED_CONFIG_ARCHIVE_MAP"),
240
        ("align", "ALIGN_PRETRAINED_CONFIG_ARCHIVE_MAP"),
Jongjyh's avatar
Jongjyh committed
241
        ("altclip", "ALTCLIP_PRETRAINED_CONFIG_ARCHIVE_MAP"),
242
        ("audio-spectrogram-transformer", "AUDIO_SPECTROGRAM_TRANSFORMER_PRETRAINED_CONFIG_ARCHIVE_MAP"),
243
        ("autoformer", "AUTOFORMER_PRETRAINED_CONFIG_ARCHIVE_MAP"),
Yoach Lacombe's avatar
Yoach Lacombe committed
244
        ("bark", "BARK_PRETRAINED_CONFIG_ARCHIVE_MAP"),
245
        ("bart", "BART_PRETRAINED_CONFIG_ARCHIVE_MAP"),
246
        ("beit", "BEIT_PRETRAINED_CONFIG_ARCHIVE_MAP"),
247
248
249
        ("bert", "BERT_PRETRAINED_CONFIG_ARCHIVE_MAP"),
        ("big_bird", "BIG_BIRD_PRETRAINED_CONFIG_ARCHIVE_MAP"),
        ("bigbird_pegasus", "BIGBIRD_PEGASUS_PRETRAINED_CONFIG_ARCHIVE_MAP"),
Kamal Raj Kanakarajan's avatar
Kamal Raj Kanakarajan committed
250
        ("biogpt", "BIOGPT_PRETRAINED_CONFIG_ARCHIVE_MAP"),
NielsRogge's avatar
NielsRogge committed
251
        ("bit", "BIT_PRETRAINED_CONFIG_ARCHIVE_MAP"),
252
253
        ("blenderbot", "BLENDERBOT_PRETRAINED_CONFIG_ARCHIVE_MAP"),
        ("blenderbot-small", "BLENDERBOT_SMALL_PRETRAINED_CONFIG_ARCHIVE_MAP"),
Younes Belkada's avatar
Younes Belkada committed
254
        ("blip", "BLIP_PRETRAINED_CONFIG_ARCHIVE_MAP"),
NielsRogge's avatar
NielsRogge committed
255
        ("blip-2", "BLIP_2_PRETRAINED_CONFIG_ARCHIVE_MAP"),
Younes Belkada's avatar
Younes Belkada committed
256
        ("bloom", "BLOOM_PRETRAINED_CONFIG_ARCHIVE_MAP"),
257
        ("bridgetower", "BRIDGETOWER_PRETRAINED_CONFIG_ARCHIVE_MAP"),
258
        ("camembert", "CAMEMBERT_PRETRAINED_CONFIG_ARCHIVE_MAP"),
259
        ("canine", "CANINE_PRETRAINED_CONFIG_ARCHIVE_MAP"),
260
        ("chinese_clip", "CHINESE_CLIP_PRETRAINED_CONFIG_ARCHIVE_MAP"),
261
        ("clap", "CLAP_PRETRAINED_MODEL_ARCHIVE_LIST"),
262
        ("clip", "CLIP_PRETRAINED_CONFIG_ARCHIVE_MAP"),
NielsRogge's avatar
NielsRogge committed
263
        ("clipseg", "CLIPSEG_PRETRAINED_CONFIG_ARCHIVE_MAP"),
rooa's avatar
rooa committed
264
        ("codegen", "CODEGEN_PRETRAINED_CONFIG_ARCHIVE_MAP"),
265
        ("conditional_detr", "CONDITIONAL_DETR_PRETRAINED_CONFIG_ARCHIVE_MAP"),
266
        ("convbert", "CONVBERT_PRETRAINED_CONFIG_ARCHIVE_MAP"),
267
        ("convnext", "CONVNEXT_PRETRAINED_CONFIG_ARCHIVE_MAP"),
Alara Dirik's avatar
Alara Dirik committed
268
        ("convnextv2", "CONVNEXTV2_PRETRAINED_CONFIG_ARCHIVE_MAP"),
269
        ("cpmant", "CPMANT_PRETRAINED_CONFIG_ARCHIVE_MAP"),
270
        ("ctrl", "CTRL_PRETRAINED_CONFIG_ARCHIVE_MAP"),
NielsRogge's avatar
NielsRogge committed
271
        ("cvt", "CVT_PRETRAINED_CONFIG_ARCHIVE_MAP"),
272
        ("data2vec-audio", "DATA2VEC_AUDIO_PRETRAINED_CONFIG_ARCHIVE_MAP"),
273
274
275
276
        ("data2vec-text", "DATA2VEC_TEXT_PRETRAINED_CONFIG_ARCHIVE_MAP"),
        ("data2vec-vision", "DATA2VEC_VISION_PRETRAINED_CONFIG_ARCHIVE_MAP"),
        ("deberta", "DEBERTA_PRETRAINED_CONFIG_ARCHIVE_MAP"),
        ("deberta-v2", "DEBERTA_V2_PRETRAINED_CONFIG_ARCHIVE_MAP"),
NielsRogge's avatar
NielsRogge committed
277
        ("deformable_detr", "DEFORMABLE_DETR_PRETRAINED_CONFIG_ARCHIVE_MAP"),
278
        ("deit", "DEIT_PRETRAINED_CONFIG_ARCHIVE_MAP"),
NielsRogge's avatar
NielsRogge committed
279
        ("deta", "DETA_PRETRAINED_CONFIG_ARCHIVE_MAP"),
280
        ("detr", "DETR_PRETRAINED_CONFIG_ARCHIVE_MAP"),
281
        ("dinat", "DINAT_PRETRAINED_CONFIG_ARCHIVE_MAP"),
NielsRogge's avatar
NielsRogge committed
282
        ("dinov2", "DINOV2_PRETRAINED_CONFIG_ARCHIVE_MAP"),
283
        ("distilbert", "DISTILBERT_PRETRAINED_CONFIG_ARCHIVE_MAP"),
NielsRogge's avatar
NielsRogge committed
284
        ("donut-swin", "DONUT_SWIN_PRETRAINED_CONFIG_ARCHIVE_MAP"),
285
286
        ("dpr", "DPR_PRETRAINED_CONFIG_ARCHIVE_MAP"),
        ("dpt", "DPT_PRETRAINED_CONFIG_ARCHIVE_MAP"),
287
        ("efficientformer", "EFFICIENTFORMER_PRETRAINED_CONFIG_ARCHIVE_MAP"),
Alara Dirik's avatar
Alara Dirik committed
288
        ("efficientnet", "EFFICIENTNET_PRETRAINED_CONFIG_ARCHIVE_MAP"),
289
        ("electra", "ELECTRA_PRETRAINED_CONFIG_ARCHIVE_MAP"),
290
        ("encodec", "ENCODEC_PRETRAINED_CONFIG_ARCHIVE_MAP"),
291
        ("ernie", "ERNIE_PRETRAINED_CONFIG_ARCHIVE_MAP"),
292
        ("ernie_m", "ERNIE_M_PRETRAINED_CONFIG_ARCHIVE_MAP"),
293
        ("esm", "ESM_PRETRAINED_CONFIG_ARCHIVE_MAP"),
Matt's avatar
Matt committed
294
        ("falcon", "FALCON_PRETRAINED_CONFIG_ARCHIVE_MAP"),
295
        ("flaubert", "FLAUBERT_PRETRAINED_CONFIG_ARCHIVE_MAP"),
296
297
        ("flava", "FLAVA_PRETRAINED_CONFIG_ARCHIVE_MAP"),
        ("fnet", "FNET_PRETRAINED_CONFIG_ARCHIVE_MAP"),
NielsRogge's avatar
NielsRogge committed
298
        ("focalnet", "FOCALNET_PRETRAINED_CONFIG_ARCHIVE_MAP"),
299
300
        ("fsmt", "FSMT_PRETRAINED_CONFIG_ARCHIVE_MAP"),
        ("funnel", "FUNNEL_PRETRAINED_CONFIG_ARCHIVE_MAP"),
301
        ("git", "GIT_PRETRAINED_CONFIG_ARCHIVE_MAP"),
302
303
        ("glpn", "GLPN_PRETRAINED_CONFIG_ARCHIVE_MAP"),
        ("gpt2", "GPT2_PRETRAINED_CONFIG_ARCHIVE_MAP"),
304
        ("gpt_bigcode", "GPT_BIGCODE_PRETRAINED_CONFIG_ARCHIVE_MAP"),
305
        ("gpt_neo", "GPT_NEO_PRETRAINED_CONFIG_ARCHIVE_MAP"),
306
        ("gpt_neox", "GPT_NEOX_PRETRAINED_CONFIG_ARCHIVE_MAP"),
307
        ("gpt_neox_japanese", "GPT_NEOX_JAPANESE_PRETRAINED_CONFIG_ARCHIVE_MAP"),
308
        ("gptj", "GPTJ_PRETRAINED_CONFIG_ARCHIVE_MAP"),
309
        ("gptsan-japanese", "GPTSAN_JAPANESE_PRETRAINED_CONFIG_ARCHIVE_MAP"),
310
        ("graphormer", "GRAPHORMER_PRETRAINED_CONFIG_ARCHIVE_MAP"),
311
        ("groupvit", "GROUPVIT_PRETRAINED_CONFIG_ARCHIVE_MAP"),
312
313
314
        ("hubert", "HUBERT_PRETRAINED_CONFIG_ARCHIVE_MAP"),
        ("ibert", "IBERT_PRETRAINED_CONFIG_ARCHIVE_MAP"),
        ("imagegpt", "IMAGEGPT_PRETRAINED_CONFIG_ARCHIVE_MAP"),
315
        ("informer", "INFORMER_PRETRAINED_CONFIG_ARCHIVE_MAP"),
NielsRogge's avatar
NielsRogge committed
316
        ("instructblip", "INSTRUCTBLIP_PRETRAINED_CONFIG_ARCHIVE_MAP"),
317
        ("jukebox", "JUKEBOX_PRETRAINED_CONFIG_ARCHIVE_MAP"),
318
        ("layoutlm", "LAYOUTLM_PRETRAINED_CONFIG_ARCHIVE_MAP"),
319
        ("layoutlmv2", "LAYOUTLMV2_PRETRAINED_CONFIG_ARCHIVE_MAP"),
NielsRogge's avatar
NielsRogge committed
320
        ("layoutlmv3", "LAYOUTLMV3_PRETRAINED_CONFIG_ARCHIVE_MAP"),
321
        ("led", "LED_PRETRAINED_CONFIG_ARCHIVE_MAP"),
322
        ("levit", "LEVIT_PRETRAINED_CONFIG_ARCHIVE_MAP"),
NielsRogge's avatar
NielsRogge committed
323
        ("lilt", "LILT_PRETRAINED_CONFIG_ARCHIVE_MAP"),
Jason Phang's avatar
Jason Phang committed
324
        ("llama", "LLAMA_PRETRAINED_CONFIG_ARCHIVE_MAP"),
325
        ("longformer", "LONGFORMER_PRETRAINED_CONFIG_ARCHIVE_MAP"),
Daniel Stancl's avatar
Daniel Stancl committed
326
        ("longt5", "LONGT5_PRETRAINED_CONFIG_ARCHIVE_MAP"),
327
328
329
        ("luke", "LUKE_PRETRAINED_CONFIG_ARCHIVE_MAP"),
        ("lxmert", "LXMERT_PRETRAINED_CONFIG_ARCHIVE_MAP"),
        ("m2m_100", "M2M_100_PRETRAINED_CONFIG_ARCHIVE_MAP"),
NielsRogge's avatar
NielsRogge committed
330
        ("markuplm", "MARKUPLM_PRETRAINED_CONFIG_ARCHIVE_MAP"),
Alara Dirik's avatar
Alara Dirik committed
331
        ("mask2former", "MASK2FORMER_PRETRAINED_CONFIG_ARCHIVE_MAP"),
332
333
        ("maskformer", "MASKFORMER_PRETRAINED_CONFIG_ARCHIVE_MAP"),
        ("mbart", "MBART_PRETRAINED_CONFIG_ARCHIVE_MAP"),
Chan Woo Kim's avatar
Chan Woo Kim committed
334
        ("mctct", "MCTCT_PRETRAINED_CONFIG_ARCHIVE_MAP"),
335
        ("mega", "MEGA_PRETRAINED_CONFIG_ARCHIVE_MAP"),
336
        ("megatron-bert", "MEGATRON_BERT_PRETRAINED_CONFIG_ARCHIVE_MAP"),
wangpeng's avatar
wangpeng committed
337
        ("mgp-str", "MGP_STR_PRETRAINED_CONFIG_ARCHIVE_MAP"),
338
        ("mobilenet_v1", "MOBILENET_V1_PRETRAINED_CONFIG_ARCHIVE_MAP"),
339
        ("mobilenet_v2", "MOBILENET_V2_PRETRAINED_CONFIG_ARCHIVE_MAP"),
340
        ("mobilevit", "MOBILEVIT_PRETRAINED_CONFIG_ARCHIVE_MAP"),
Shehan Munasinghe's avatar
Shehan Munasinghe committed
341
        ("mobilevitv2", "MOBILEVITV2_PRETRAINED_CONFIG_ARCHIVE_MAP"),
342
        ("mpnet", "MPNET_PRETRAINED_CONFIG_ARCHIVE_MAP"),
343
        ("mpt", "MPT_PRETRAINED_CONFIG_ARCHIVE_MAP"),
344
        ("mra", "MRA_PRETRAINED_CONFIG_ARCHIVE_MAP"),
Sanchit Gandhi's avatar
Sanchit Gandhi committed
345
        ("musicgen", "MUSICGEN_PRETRAINED_CONFIG_ARCHIVE_MAP"),
StevenTang1998's avatar
StevenTang1998 committed
346
        ("mvp", "MVP_PRETRAINED_CONFIG_ARCHIVE_MAP"),
347
        ("nat", "NAT_PRETRAINED_CONFIG_ARCHIVE_MAP"),
348
        ("nezha", "NEZHA_PRETRAINED_CONFIG_ARCHIVE_MAP"),
349
        ("nllb-moe", "NLLB_MOE_PRETRAINED_CONFIG_ARCHIVE_MAP"),
350
        ("nystromformer", "NYSTROMFORMER_PRETRAINED_CONFIG_ARCHIVE_MAP"),
Jitesh Jain's avatar
Jitesh Jain committed
351
        ("oneformer", "ONEFORMER_PRETRAINED_CONFIG_ARCHIVE_MAP"),
352
        ("open-llama", "OPEN_LLAMA_PRETRAINED_CONFIG_ARCHIVE_MAP"),
353
354
        ("openai-gpt", "OPENAI_GPT_PRETRAINED_CONFIG_ARCHIVE_MAP"),
        ("opt", "OPT_PRETRAINED_CONFIG_ARCHIVE_MAP"),
355
        ("owlvit", "OWLVIT_PRETRAINED_CONFIG_ARCHIVE_MAP"),
356
        ("pegasus", "PEGASUS_PRETRAINED_CONFIG_ARCHIVE_MAP"),
Jason Phang's avatar
Jason Phang committed
357
        ("pegasus_x", "PEGASUS_X_PRETRAINED_CONFIG_ARCHIVE_MAP"),
358
        ("perceiver", "PERCEIVER_PRETRAINED_CONFIG_ARCHIVE_MAP"),
Younes Belkada's avatar
Younes Belkada committed
359
        ("pix2struct", "PIX2STRUCT_PRETRAINED_CONFIG_ARCHIVE_MAP"),
360
361
362
        ("plbart", "PLBART_PRETRAINED_CONFIG_ARCHIVE_MAP"),
        ("poolformer", "POOLFORMER_PRETRAINED_CONFIG_ARCHIVE_MAP"),
        ("prophetnet", "PROPHETNET_PRETRAINED_CONFIG_ARCHIVE_MAP"),
Rinat's avatar
Rinat committed
363
        ("pvt", "PVT_PRETRAINED_CONFIG_ARCHIVE_MAP"),
364
365
366
367
368
369
370
        ("qdqbert", "QDQBERT_PRETRAINED_CONFIG_ARCHIVE_MAP"),
        ("realm", "REALM_PRETRAINED_CONFIG_ARCHIVE_MAP"),
        ("regnet", "REGNET_PRETRAINED_CONFIG_ARCHIVE_MAP"),
        ("rembert", "REMBERT_PRETRAINED_CONFIG_ARCHIVE_MAP"),
        ("resnet", "RESNET_PRETRAINED_CONFIG_ARCHIVE_MAP"),
        ("retribert", "RETRIBERT_PRETRAINED_CONFIG_ARCHIVE_MAP"),
        ("roberta", "ROBERTA_PRETRAINED_CONFIG_ARCHIVE_MAP"),
371
        ("roberta-prelayernorm", "ROBERTA_PRELAYERNORM_PRETRAINED_CONFIG_ARCHIVE_MAP"),
Weiwe Shi's avatar
Weiwe Shi committed
372
        ("roc_bert", "ROC_BERT_PRETRAINED_CONFIG_ARCHIVE_MAP"),
373
        ("roformer", "ROFORMER_PRETRAINED_CONFIG_ARCHIVE_MAP"),
Sylvain Gugger's avatar
Sylvain Gugger committed
374
        ("rwkv", "RWKV_PRETRAINED_CONFIG_ARCHIVE_MAP"),
375
        ("sam", "SAM_PRETRAINED_CONFIG_ARCHIVE_MAP"),
376
        ("segformer", "SEGFORMER_PRETRAINED_CONFIG_ARCHIVE_MAP"),
377
        ("sew", "SEW_PRETRAINED_CONFIG_ARCHIVE_MAP"),
378
379
380
        ("sew-d", "SEW_D_PRETRAINED_CONFIG_ARCHIVE_MAP"),
        ("speech_to_text", "SPEECH_TO_TEXT_PRETRAINED_CONFIG_ARCHIVE_MAP"),
        ("speech_to_text_2", "SPEECH_TO_TEXT_2_PRETRAINED_CONFIG_ARCHIVE_MAP"),
381
        ("speecht5", "SPEECHT5_PRETRAINED_CONFIG_ARCHIVE_MAP"),
382
383
        ("splinter", "SPLINTER_PRETRAINED_CONFIG_ARCHIVE_MAP"),
        ("squeezebert", "SQUEEZEBERT_PRETRAINED_CONFIG_ARCHIVE_MAP"),
Shehan Munasinghe's avatar
Shehan Munasinghe committed
384
        ("swiftformer", "SWIFTFORMER_PRETRAINED_CONFIG_ARCHIVE_MAP"),
385
        ("swin", "SWIN_PRETRAINED_CONFIG_ARCHIVE_MAP"),
NielsRogge's avatar
NielsRogge committed
386
        ("swin2sr", "SWIN2SR_PRETRAINED_CONFIG_ARCHIVE_MAP"),
387
        ("swinv2", "SWINV2_PRETRAINED_CONFIG_ARCHIVE_MAP"),
388
        ("switch_transformers", "SWITCH_TRANSFORMERS_PRETRAINED_CONFIG_ARCHIVE_MAP"),
389
        ("t5", "T5_PRETRAINED_CONFIG_ARCHIVE_MAP"),
390
        ("table-transformer", "TABLE_TRANSFORMER_PRETRAINED_CONFIG_ARCHIVE_MAP"),
391
        ("tapas", "TAPAS_PRETRAINED_CONFIG_ARCHIVE_MAP"),
392
        ("time_series_transformer", "TIME_SERIES_TRANSFORMER_PRETRAINED_CONFIG_ARCHIVE_MAP"),
393
        ("timesformer", "TIMESFORMER_PRETRAINED_CONFIG_ARCHIVE_MAP"),
394
        ("transfo-xl", "TRANSFO_XL_PRETRAINED_CONFIG_ARCHIVE_MAP"),
Zineng Tang's avatar
Zineng Tang committed
395
        ("tvlt", "TVLT_PRETRAINED_CONFIG_ARCHIVE_MAP"),
396
        ("unispeech", "UNISPEECH_PRETRAINED_CONFIG_ARCHIVE_MAP"),
397
398
        ("unispeech-sat", "UNISPEECH_SAT_PRETRAINED_CONFIG_ARCHIVE_MAP"),
        ("van", "VAN_PRETRAINED_CONFIG_ARCHIVE_MAP"),
NielsRogge's avatar
NielsRogge committed
399
        ("videomae", "VIDEOMAE_PRETRAINED_CONFIG_ARCHIVE_MAP"),
400
401
402
        ("vilt", "VILT_PRETRAINED_CONFIG_ARCHIVE_MAP"),
        ("visual_bert", "VISUAL_BERT_PRETRAINED_CONFIG_ARCHIVE_MAP"),
        ("vit", "VIT_PRETRAINED_CONFIG_ARCHIVE_MAP"),
NielsRogge's avatar
NielsRogge committed
403
        ("vit_hybrid", "VIT_HYBRID_PRETRAINED_CONFIG_ARCHIVE_MAP"),
404
        ("vit_mae", "VIT_MAE_PRETRAINED_CONFIG_ARCHIVE_MAP"),
405
        ("vit_msn", "VIT_MSN_PRETRAINED_CONFIG_ARCHIVE_MAP"),
Jegor Kit拧kerkin's avatar
Jegor Kit拧kerkin committed
406
        ("vivit", "VIVIT_PRETRAINED_CONFIG_ARCHIVE_MAP"),
407
        ("wav2vec2", "WAV_2_VEC_2_PRETRAINED_CONFIG_ARCHIVE_MAP"),
408
        ("wav2vec2-conformer", "WAV2VEC2_CONFORMER_PRETRAINED_CONFIG_ARCHIVE_MAP"),
409
        ("whisper", "WHISPER_PRETRAINED_CONFIG_ARCHIVE_MAP"),
410
        ("xclip", "XCLIP_PRETRAINED_CONFIG_ARCHIVE_MAP"),
411
412
413
414
415
        ("xglm", "XGLM_PRETRAINED_CONFIG_ARCHIVE_MAP"),
        ("xlm", "XLM_PRETRAINED_CONFIG_ARCHIVE_MAP"),
        ("xlm-prophetnet", "XLM_PROPHETNET_PRETRAINED_CONFIG_ARCHIVE_MAP"),
        ("xlm-roberta", "XLM_ROBERTA_PRETRAINED_CONFIG_ARCHIVE_MAP"),
        ("xlnet", "XLNET_PRETRAINED_CONFIG_ARCHIVE_MAP"),
Jannis Vamvas's avatar
Jannis Vamvas committed
416
        ("xmod", "XMOD_PRETRAINED_CONFIG_ARCHIVE_MAP"),
417
418
        ("yolos", "YOLOS_PRETRAINED_CONFIG_ARCHIVE_MAP"),
        ("yoso", "YOSO_PRETRAINED_CONFIG_ARCHIVE_MAP"),
419
420
421
422
423
    ]
)

MODEL_NAMES_MAPPING = OrderedDict(
    [
424
        # Add full (and cased) model names here
425
        ("albert", "ALBERT"),
426
        ("align", "ALIGN"),
Jongjyh's avatar
Jongjyh committed
427
        ("altclip", "AltCLIP"),
428
        ("audio-spectrogram-transformer", "Audio Spectrogram Transformer"),
429
        ("autoformer", "Autoformer"),
Yoach Lacombe's avatar
Yoach Lacombe committed
430
        ("bark", "Bark"),
431
432
433
        ("bart", "BART"),
        ("barthez", "BARThez"),
        ("bartpho", "BARTpho"),
NielsRogge's avatar
NielsRogge committed
434
        ("beit", "BEiT"),
435
436
437
        ("bert", "BERT"),
        ("bert-generation", "Bert Generation"),
        ("bert-japanese", "BertJapanese"),
438
        ("bertweet", "BERTweet"),
439
        ("big_bird", "BigBird"),
440
        ("bigbird_pegasus", "BigBird-Pegasus"),
Kamal Raj Kanakarajan's avatar
Kamal Raj Kanakarajan committed
441
        ("biogpt", "BioGpt"),
NielsRogge's avatar
NielsRogge committed
442
        ("bit", "BiT"),
443
444
        ("blenderbot", "Blenderbot"),
        ("blenderbot-small", "BlenderbotSmall"),
Younes Belkada's avatar
Younes Belkada committed
445
        ("blip", "BLIP"),
NielsRogge's avatar
NielsRogge committed
446
        ("blip-2", "BLIP-2"),
Younes Belkada's avatar
Younes Belkada committed
447
        ("bloom", "BLOOM"),
448
        ("bort", "BORT"),
449
        ("bridgetower", "BridgeTower"),
450
451
        ("byt5", "ByT5"),
        ("camembert", "CamemBERT"),
452
        ("canine", "CANINE"),
453
        ("chinese_clip", "Chinese-CLIP"),
454
        ("clap", "CLAP"),
Suraj Patil's avatar
Suraj Patil committed
455
        ("clip", "CLIP"),
NielsRogge's avatar
NielsRogge committed
456
        ("clipseg", "CLIPSeg"),
rooa's avatar
rooa committed
457
        ("codegen", "CodeGen"),
458
        ("conditional_detr", "Conditional DETR"),
459
        ("convbert", "ConvBERT"),
460
        ("convnext", "ConvNeXT"),
Alara Dirik's avatar
Alara Dirik committed
461
        ("convnextv2", "ConvNeXTV2"),
462
        ("cpm", "CPM"),
463
        ("cpmant", "CPM-Ant"),
464
        ("ctrl", "CTRL"),
NielsRogge's avatar
NielsRogge committed
465
        ("cvt", "CvT"),
466
467
468
469
470
471
        ("data2vec-audio", "Data2VecAudio"),
        ("data2vec-text", "Data2VecText"),
        ("data2vec-vision", "Data2VecVision"),
        ("deberta", "DeBERTa"),
        ("deberta-v2", "DeBERTa-v2"),
        ("decision_transformer", "Decision Transformer"),
NielsRogge's avatar
NielsRogge committed
472
        ("deformable_detr", "Deformable DETR"),
NielsRogge's avatar
NielsRogge committed
473
        ("deit", "DeiT"),
474
        ("deplot", "DePlot"),
NielsRogge's avatar
NielsRogge committed
475
        ("deta", "DETA"),
NielsRogge's avatar
NielsRogge committed
476
        ("detr", "DETR"),
477
        ("dialogpt", "DialoGPT"),
478
        ("dinat", "DiNAT"),
NielsRogge's avatar
NielsRogge committed
479
        ("dinov2", "DINOv2"),
480
481
        ("distilbert", "DistilBERT"),
        ("dit", "DiT"),
NielsRogge's avatar
NielsRogge committed
482
        ("donut-swin", "DonutSwin"),
483
484
        ("dpr", "DPR"),
        ("dpt", "DPT"),
485
        ("efficientformer", "EfficientFormer"),
Alara Dirik's avatar
Alara Dirik committed
486
        ("efficientnet", "EfficientNet"),
487
        ("electra", "ELECTRA"),
488
        ("encodec", "EnCodec"),
489
        ("encoder-decoder", "Encoder decoder"),
490
        ("ernie", "ERNIE"),
491
        ("ernie_m", "ErnieM"),
492
        ("esm", "ESM"),
Matt's avatar
Matt committed
493
        ("falcon", "Falcon"),
494
        ("flan-t5", "FLAN-T5"),
Arthur's avatar
Arthur committed
495
        ("flan-ul2", "FLAN-UL2"),
496
        ("flaubert", "FlauBERT"),
497
        ("flava", "FLAVA"),
498
        ("fnet", "FNet"),
NielsRogge's avatar
NielsRogge committed
499
        ("focalnet", "FocalNet"),
500
501
        ("fsmt", "FairSeq Machine-Translation"),
        ("funnel", "Funnel Transformer"),
502
        ("git", "GIT"),
503
        ("glpn", "GLPN"),
504
        ("gpt-sw3", "GPT-Sw3"),
505
        ("gpt2", "OpenAI GPT-2"),
506
        ("gpt_bigcode", "GPTBigCode"),
Suraj Patil's avatar
Suraj Patil committed
507
        ("gpt_neo", "GPT Neo"),
508
        ("gpt_neox", "GPT NeoX"),
509
        ("gpt_neox_japanese", "GPT NeoX Japanese"),
510
        ("gptj", "GPT-J"),
511
        ("gptsan-japanese", "GPTSAN-japanese"),
512
        ("graphormer", "Graphormer"),
513
        ("groupvit", "GroupViT"),
514
515
        ("herbert", "HerBERT"),
        ("hubert", "Hubert"),
Sehoon Kim's avatar
Sehoon Kim committed
516
        ("ibert", "I-BERT"),
517
        ("imagegpt", "ImageGPT"),
518
        ("informer", "Informer"),
NielsRogge's avatar
NielsRogge committed
519
        ("instructblip", "InstructBLIP"),
520
        ("jukebox", "Jukebox"),
521
522
        ("layoutlm", "LayoutLM"),
        ("layoutlmv2", "LayoutLMv2"),
NielsRogge's avatar
NielsRogge committed
523
        ("layoutlmv3", "LayoutLMv3"),
524
525
        ("layoutxlm", "LayoutXLM"),
        ("led", "LED"),
526
        ("levit", "LeViT"),
NielsRogge's avatar
NielsRogge committed
527
        ("lilt", "LiLT"),
Jason Phang's avatar
Jason Phang committed
528
        ("llama", "LLaMA"),
529
        ("llama2", "Llama2"),
530
        ("longformer", "Longformer"),
Daniel Stancl's avatar
Daniel Stancl committed
531
        ("longt5", "LongT5"),
532
533
534
        ("luke", "LUKE"),
        ("lxmert", "LXMERT"),
        ("m2m_100", "M2M100"),
535
        ("marian", "Marian"),
NielsRogge's avatar
NielsRogge committed
536
        ("markuplm", "MarkupLM"),
Alara Dirik's avatar
Alara Dirik committed
537
        ("mask2former", "Mask2Former"),
538
        ("maskformer", "MaskFormer"),
539
        ("maskformer-swin", "MaskFormerSwin"),
540
        ("matcha", "MatCha"),
541
        ("mbart", "mBART"),
542
        ("mbart50", "mBART-50"),
Chan Woo Kim's avatar
Chan Woo Kim committed
543
        ("mctct", "M-CTC-T"),
544
        ("mega", "MEGA"),
545
546
        ("megatron-bert", "Megatron-BERT"),
        ("megatron_gpt2", "Megatron-GPT2"),
wangpeng's avatar
wangpeng committed
547
        ("mgp-str", "MGP-STR"),
548
        ("mluke", "mLUKE"),
549
        ("mms", "MMS"),
550
        ("mobilebert", "MobileBERT"),
551
        ("mobilenet_v1", "MobileNetV1"),
552
        ("mobilenet_v2", "MobileNetV2"),
553
        ("mobilevit", "MobileViT"),
Shehan Munasinghe's avatar
Shehan Munasinghe committed
554
        ("mobilevitv2", "MobileViTV2"),
555
        ("mpnet", "MPNet"),
556
        ("mpt", "MPT"),
557
        ("mra", "MRA"),
558
        ("mt5", "MT5"),
Sanchit Gandhi's avatar
Sanchit Gandhi committed
559
        ("musicgen", "MusicGen"),
StevenTang1998's avatar
StevenTang1998 committed
560
        ("mvp", "MVP"),
561
        ("nat", "NAT"),
562
        ("nezha", "Nezha"),
Lysandre Debut's avatar
Lysandre Debut committed
563
        ("nllb", "NLLB"),
564
        ("nllb-moe", "NLLB-MOE"),
565
        ("nystromformer", "Nystr枚mformer"),
Jitesh Jain's avatar
Jitesh Jain committed
566
        ("oneformer", "OneFormer"),
567
        ("open-llama", "OpenLlama"),
568
        ("openai-gpt", "OpenAI GPT"),
Younes Belkada's avatar
Younes Belkada committed
569
        ("opt", "OPT"),
570
        ("owlvit", "OWL-ViT"),
571
        ("pegasus", "Pegasus"),
Jason Phang's avatar
Jason Phang committed
572
        ("pegasus_x", "PEGASUS-X"),
573
574
        ("perceiver", "Perceiver"),
        ("phobert", "PhoBERT"),
Younes Belkada's avatar
Younes Belkada committed
575
        ("pix2struct", "Pix2Struct"),
576
577
578
        ("plbart", "PLBart"),
        ("poolformer", "PoolFormer"),
        ("prophetnet", "ProphetNet"),
Rinat's avatar
Rinat committed
579
        ("pvt", "PVT"),
580
581
        ("qdqbert", "QDQBert"),
        ("rag", "RAG"),
582
        ("realm", "REALM"),
583
        ("reformer", "Reformer"),
584
585
586
587
        ("regnet", "RegNet"),
        ("rembert", "RemBERT"),
        ("resnet", "ResNet"),
        ("retribert", "RetriBERT"),
588
        ("roberta", "RoBERTa"),
589
        ("roberta-prelayernorm", "RoBERTa-PreLayerNorm"),
Weiwe Shi's avatar
Weiwe Shi committed
590
        ("roc_bert", "RoCBert"),
591
        ("roformer", "RoFormer"),
Sylvain Gugger's avatar
Sylvain Gugger committed
592
        ("rwkv", "RWKV"),
593
        ("sam", "SAM"),
594
595
596
        ("segformer", "SegFormer"),
        ("sew", "SEW"),
        ("sew-d", "SEW-D"),
597
        ("speech-encoder-decoder", "Speech Encoder decoder"),
598
599
        ("speech_to_text", "Speech2Text"),
        ("speech_to_text_2", "Speech2Text2"),
600
        ("speecht5", "SpeechT5"),
Ori Ram's avatar
Ori Ram committed
601
        ("splinter", "Splinter"),
602
        ("squeezebert", "SqueezeBERT"),
Shehan Munasinghe's avatar
Shehan Munasinghe committed
603
        ("swiftformer", "SwiftFormer"),
604
        ("swin", "Swin Transformer"),
NielsRogge's avatar
NielsRogge committed
605
        ("swin2sr", "Swin2SR"),
606
        ("swinv2", "Swin Transformer V2"),
607
        ("switch_transformers", "SwitchTransformers"),
608
609
        ("t5", "T5"),
        ("t5v1.1", "T5v1.1"),
610
        ("table-transformer", "Table Transformer"),
611
612
        ("tapas", "TAPAS"),
        ("tapex", "TAPEX"),
613
        ("time_series_transformer", "Time Series Transformer"),
614
        ("timesformer", "TimeSformer"),
amyeroberts's avatar
amyeroberts committed
615
        ("timm_backbone", "TimmBackbone"),
Carl's avatar
Carl committed
616
        ("trajectory_transformer", "Trajectory Transformer"),
617
618
        ("transfo-xl", "Transformer-XL"),
        ("trocr", "TrOCR"),
Zineng Tang's avatar
Zineng Tang committed
619
        ("tvlt", "TVLT"),
620
        ("ul2", "UL2"),
621
        ("umt5", "UMT5"),
622
        ("unispeech", "UniSpeech"),
623
        ("unispeech-sat", "UniSpeechSat"),
NielsRogge's avatar
NielsRogge committed
624
        ("upernet", "UPerNet"),
625
        ("van", "VAN"),
NielsRogge's avatar
NielsRogge committed
626
        ("videomae", "VideoMAE"),
627
628
629
        ("vilt", "ViLT"),
        ("vision-encoder-decoder", "Vision Encoder decoder"),
        ("vision-text-dual-encoder", "VisionTextDualEncoder"),
630
        ("visual_bert", "VisualBERT"),
631
        ("vit", "ViT"),
NielsRogge's avatar
NielsRogge committed
632
        ("vit_hybrid", "ViT Hybrid"),
633
        ("vit_mae", "ViTMAE"),
634
        ("vit_msn", "ViTMSN"),
Jegor Kit拧kerkin's avatar
Jegor Kit拧kerkin committed
635
        ("vivit", "ViViT"),
636
        ("wav2vec2", "Wav2Vec2"),
637
        ("wav2vec2-conformer", "Wav2Vec2-Conformer"),
638
        ("wav2vec2_phoneme", "Wav2Vec2Phoneme"),
Patrick von Platen's avatar
Patrick von Platen committed
639
        ("wavlm", "WavLM"),
640
        ("whisper", "Whisper"),
NielsRogge's avatar
NielsRogge committed
641
        ("xclip", "X-CLIP"),
642
643
        ("xglm", "XGLM"),
        ("xlm", "XLM"),
644
        ("xlm-prophetnet", "XLM-ProphetNet"),
645
646
        ("xlm-roberta", "XLM-RoBERTa"),
        ("xlm-roberta-xl", "XLM-RoBERTa-XL"),
647
        ("xlm-v", "XLM-V"),
648
        ("xlnet", "XLNet"),
649
650
        ("xls_r", "XLS-R"),
        ("xlsr_wav2vec2", "XLSR-Wav2Vec2"),
Jannis Vamvas's avatar
Jannis Vamvas committed
651
        ("xmod", "X-MOD"),
652
653
        ("yolos", "YOLOS"),
        ("yoso", "YOSO"),
654
655
656
    ]
)

Sylvain Gugger's avatar
Sylvain Gugger committed
657
658
659
660
DEPRECATED_MODELS = [
    "bort",
    "mctct",
    "mmbt",
661
    "open_llama",
Sylvain Gugger's avatar
Sylvain Gugger committed
662
    "retribert",
663
    "tapex",
Sylvain Gugger's avatar
Sylvain Gugger committed
664
665
666
667
    "trajectory_transformer",
    "van",
]

668
SPECIAL_MODEL_TYPE_TO_MODULE_NAME = OrderedDict(
669
670
671
672
673
    [
        ("openai-gpt", "openai"),
        ("data2vec-audio", "data2vec"),
        ("data2vec-text", "data2vec"),
        ("data2vec-vision", "data2vec"),
NielsRogge's avatar
NielsRogge committed
674
        ("donut-swin", "donut"),
675
        ("maskformer-swin", "maskformer"),
NielsRogge's avatar
NielsRogge committed
676
        ("xclip", "x_clip"),
677
    ]
678
)
679
680
681
682
683
684
685
686


def model_type_to_module_name(key):
    """Converts a config key to the corresponding module."""
    # Special treatment
    if key in SPECIAL_MODEL_TYPE_TO_MODULE_NAME:
        return SPECIAL_MODEL_TYPE_TO_MODULE_NAME[key]

Sylvain Gugger's avatar
Sylvain Gugger committed
687
688
689
690
691
    key = key.replace("-", "_")
    if key in DEPRECATED_MODELS:
        key = f"deprecated.{key}"

    return key
692
693
694
695
696
697
698


def config_class_to_model_type(config):
    """Converts a config class name to the corresponding model type"""
    for key, cls in CONFIG_MAPPING_NAMES.items():
        if cls == config:
            return key
699
700
701
702
    # if key not found check in extra content
    for key, cls in CONFIG_MAPPING._extra_content.items():
        if cls.__name__ == config:
            return key
703
704
705
706
707
708
709
710
711
712
    return None


class _LazyConfigMapping(OrderedDict):
    """
    A dictionary that lazily load its values when they are requested.
    """

    def __init__(self, mapping):
        self._mapping = mapping
713
        self._extra_content = {}
714
715
716
        self._modules = {}

    def __getitem__(self, key):
717
718
        if key in self._extra_content:
            return self._extra_content[key]
719
720
721
722
723
724
        if key not in self._mapping:
            raise KeyError(key)
        value = self._mapping[key]
        module_name = model_type_to_module_name(key)
        if module_name not in self._modules:
            self._modules[module_name] = importlib.import_module(f".{module_name}", "transformers.models")
725
726
727
728
729
730
731
        if hasattr(self._modules[module_name], value):
            return getattr(self._modules[module_name], value)

        # Some of the mappings have entries model_type -> config of another model type. In that case we try to grab the
        # object at the top level.
        transformers_module = importlib.import_module("transformers")
        return getattr(transformers_module, value)
732
733

    def keys(self):
734
        return list(self._mapping.keys()) + list(self._extra_content.keys())
735
736

    def values(self):
737
        return [self[k] for k in self._mapping.keys()] + list(self._extra_content.values())
738

739
    def items(self):
740
        return [(k, self[k]) for k in self._mapping.keys()] + list(self._extra_content.items())
741
742

    def __iter__(self):
743
        return iter(list(self._mapping.keys()) + list(self._extra_content.keys()))
744
745

    def __contains__(self, item):
746
747
        return item in self._mapping or item in self._extra_content

748
    def register(self, key, value, exist_ok=False):
749
750
751
        """
        Register a new configuration in this mapping.
        """
752
        if key in self._mapping.keys() and not exist_ok:
753
754
            raise ValueError(f"'{key}' is already used by a Transformers config, pick another name.")
        self._extra_content[key] = value
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819


CONFIG_MAPPING = _LazyConfigMapping(CONFIG_MAPPING_NAMES)


class _LazyLoadAllMappings(OrderedDict):
    """
    A mapping that will load all pairs of key values at the first access (either by indexing, requestions keys, values,
    etc.)

    Args:
        mapping: The mapping to load.
    """

    def __init__(self, mapping):
        self._mapping = mapping
        self._initialized = False
        self._data = {}

    def _initialize(self):
        if self._initialized:
            return
        warnings.warn(
            "ALL_PRETRAINED_CONFIG_ARCHIVE_MAP is deprecated and will be removed in v5 of Transformers. "
            "It does not contain all available model checkpoints, far from it. Checkout hf.co/models for that.",
            FutureWarning,
        )

        for model_type, map_name in self._mapping.items():
            module_name = model_type_to_module_name(model_type)
            module = importlib.import_module(f".{module_name}", "transformers.models")
            mapping = getattr(module, map_name)
            self._data.update(mapping)

        self._initialized = True

    def __getitem__(self, key):
        self._initialize()
        return self._data[key]

    def keys(self):
        self._initialize()
        return self._data.keys()

    def values(self):
        self._initialize()
        return self._data.values()

    def items(self):
        self._initialize()
        return self._data.keys()

    def __iter__(self):
        self._initialize()
        return iter(self._data)

    def __contains__(self, item):
        self._initialize()
        return item in self._data


ALL_PRETRAINED_CONFIG_ARCHIVE_MAP = _LazyLoadAllMappings(CONFIG_ARCHIVE_MAP_MAPPING_NAMES)


def _get_class_name(model_class: Union[str, List[str]]):
820
    if isinstance(model_class, (list, tuple)):
Stas Bekman's avatar
Stas Bekman committed
821
822
        return " or ".join([f"[`{c}`]" for c in model_class if c is not None])
    return f"[`{model_class}`]"
823
824


825
826
827
828
829
def _list_model_options(indent, config_to_class=None, use_model_types=True):
    if config_to_class is None and not use_model_types:
        raise ValueError("Using `use_model_types=False` requires a `config_to_class` dictionary.")
    if use_model_types:
        if config_to_class is None:
Stas Bekman's avatar
Stas Bekman committed
830
            model_type_to_name = {model_type: f"[`{config}`]" for model_type, config in CONFIG_MAPPING_NAMES.items()}
831
832
        else:
            model_type_to_name = {
833
834
835
                model_type: _get_class_name(model_class)
                for model_type, model_class in config_to_class.items()
                if model_type in MODEL_NAMES_MAPPING
836
837
            }
        lines = [
838
            f"{indent}- **{model_type}** -- {model_type_to_name[model_type]} ({MODEL_NAMES_MAPPING[model_type]} model)"
839
            for model_type in sorted(model_type_to_name.keys())
840
841
        ]
    else:
842
843
844
845
846
        config_to_name = {
            CONFIG_MAPPING_NAMES[config]: _get_class_name(clas)
            for config, clas in config_to_class.items()
            if config in CONFIG_MAPPING_NAMES
        }
847
        config_to_model_name = {
848
            config: MODEL_NAMES_MAPPING[model_type] for model_type, config in CONFIG_MAPPING_NAMES.items()
849
850
        }
        lines = [
Sylvain Gugger's avatar
Sylvain Gugger committed
851
852
            f"{indent}- [`{config_name}`] configuration class:"
            f" {config_to_name[config_name]} ({config_to_model_name[config_name]} model)"
853
            for config_name in sorted(config_to_name.keys())
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
        ]
    return "\n".join(lines)


def replace_list_option_in_docstrings(config_to_class=None, use_model_types=True):
    def docstring_decorator(fn):
        docstrings = fn.__doc__
        lines = docstrings.split("\n")
        i = 0
        while i < len(lines) and re.search(r"^(\s*)List options\s*$", lines[i]) is None:
            i += 1
        if i < len(lines):
            indent = re.search(r"^(\s*)List options\s*$", lines[i]).groups()[0]
            if use_model_types:
                indent = f"{indent}    "
            lines[i] = _list_model_options(indent, config_to_class=config_to_class, use_model_types=use_model_types)
            docstrings = "\n".join(lines)
        else:
            raise ValueError(
Sylvain Gugger's avatar
Sylvain Gugger committed
873
874
                f"The function {fn} should have an empty 'List options' in its docstring as placeholder, current"
                f" docstring is:\n{docstrings}"
875
876
877
878
879
880
881
            )
        fn.__doc__ = docstrings
        return fn

    return docstring_decorator


Julien Chaumond's avatar
Julien Chaumond committed
882
class AutoConfig:
Lysandre Debut's avatar
Lysandre Debut committed
883
    r"""
884
    This is a generic configuration class that will be instantiated as one of the configuration classes of the library
885
    when created with the [`~AutoConfig.from_pretrained`] class method.
886

887
    This class cannot be instantiated directly using `__init__()` (throws an error).
888
    """
889

890
    def __init__(self):
891
892
893
894
        raise EnvironmentError(
            "AutoConfig is designed to be instantiated "
            "using the `AutoConfig.from_pretrained(pretrained_model_name_or_path)` method."
        )
895

896
    @classmethod
897
898
899
900
    def for_model(cls, model_type: str, *args, **kwargs):
        if model_type in CONFIG_MAPPING:
            config_class = CONFIG_MAPPING[model_type]
            return config_class(*args, **kwargs)
901
        raise ValueError(
902
            f"Unrecognized model identifier: {model_type}. Should contain one of {', '.join(CONFIG_MAPPING.keys())}"
903
        )
904

905
    @classmethod
906
    @replace_list_option_in_docstrings()
907
    def from_pretrained(cls, pretrained_model_name_or_path, **kwargs):
908
909
        r"""
        Instantiate one of the configuration classes of the library from a pretrained model configuration.
910

Sylvain Gugger's avatar
Sylvain Gugger committed
911
912
        The configuration class to instantiate is selected based on the `model_type` property of the config object that
        is loaded, or when it's missing, by falling back to using pattern matching on `pretrained_model_name_or_path`:
913

914
        List options
Lysandre Debut's avatar
Lysandre Debut committed
915
916

        Args:
917
            pretrained_model_name_or_path (`str` or `os.PathLike`):
918
919
                Can be either:

920
921
922
923
                    - A string, the *model id* of a pretrained model configuration hosted inside a model repo on
                      huggingface.co. Valid model ids can be located at the root-level, like `bert-base-uncased`, or
                      namespaced under a user or organization name, like `dbmdz/bert-base-german-cased`.
                    - A path to a *directory* containing a configuration file saved using the
Sylvain Gugger's avatar
Sylvain Gugger committed
924
925
                      [`~PretrainedConfig.save_pretrained`] method, or the [`~PreTrainedModel.save_pretrained`] method,
                      e.g., `./my_model_directory/`.
926
927
928
                    - A path or url to a saved configuration JSON *file*, e.g.,
                      `./my_model_directory/configuration.json`.
            cache_dir (`str` or `os.PathLike`, *optional*):
929
930
                Path to a directory in which a downloaded pretrained model configuration should be cached if the
                standard cache should not be used.
931
            force_download (`bool`, *optional*, defaults to `False`):
932
933
                Whether or not to force the (re-)download the model weights and configuration files and override the
                cached versions if they exist.
934
            resume_download (`bool`, *optional*, defaults to `False`):
935
936
                Whether or not to delete incompletely received files. Will attempt to resume the download if such a
                file exists.
937
            proxies (`Dict[str, str]`, *optional*):
Sylvain Gugger's avatar
Sylvain Gugger committed
938
939
                A dictionary of proxy servers to use by protocol or endpoint, e.g., `{'http': 'foo.bar:3128',
                'http://hostname': 'foo.bar:4012'}`. The proxies are used on each request.
940
            revision (`str`, *optional*, defaults to `"main"`):
Julien Chaumond's avatar
Julien Chaumond committed
941
                The specific model version to use. It can be a branch name, a tag name, or a commit id, since we use a
942
                git-based system for storing models and other artifacts on huggingface.co, so `revision` can be any
Julien Chaumond's avatar
Julien Chaumond committed
943
                identifier allowed by git.
944
945
            return_unused_kwargs (`bool`, *optional*, defaults to `False`):
                If `False`, then this function returns just the final configuration object.
946

Sylvain Gugger's avatar
Sylvain Gugger committed
947
948
949
                If `True`, then this functions returns a `Tuple(config, unused_kwargs)` where *unused_kwargs* is a
                dictionary consisting of the key/value pairs whose keys are not configuration attributes: i.e., the
                part of `kwargs` which has not been used to update `config` and is otherwise ignored.
950
            trust_remote_code (`bool`, *optional*, defaults to `False`):
951
                Whether or not to allow for custom models defined on the Hub in their own modeling files. This option
Sylvain Gugger's avatar
Sylvain Gugger committed
952
953
                should only be set to `True` for repositories you trust and in which you have read the code, as it will
                execute code present on the Hub on your local machine.
954
            kwargs(additional keyword arguments, *optional*):
955
                The values in kwargs of any keys which are configuration attributes will be used to override the loaded
Sylvain Gugger's avatar
Sylvain Gugger committed
956
                values. Behavior concerning key/value pairs whose keys are *not* configuration attributes is controlled
957
                by the `return_unused_kwargs` keyword parameter.
Lysandre Debut's avatar
Lysandre Debut committed
958

959
        Examples:
960

961
962
        ```python
        >>> from transformers import AutoConfig
963

964
        >>> # Download configuration from huggingface.co and cache.
Sylvain Gugger's avatar
Sylvain Gugger committed
965
        >>> config = AutoConfig.from_pretrained("bert-base-uncased")
Lysandre Debut's avatar
Lysandre Debut committed
966

967
        >>> # Download configuration from huggingface.co (user-uploaded) and cache.
Sylvain Gugger's avatar
Sylvain Gugger committed
968
        >>> config = AutoConfig.from_pretrained("dbmdz/bert-base-german-cased")
Lysandre Debut's avatar
Lysandre Debut committed
969

970
        >>> # If configuration file is in a directory (e.g., was saved using *save_pretrained('./test/saved_model/')*).
Sylvain Gugger's avatar
Sylvain Gugger committed
971
        >>> config = AutoConfig.from_pretrained("./test/bert_saved_model/")
972

973
        >>> # Load a specific configuration file.
Sylvain Gugger's avatar
Sylvain Gugger committed
974
        >>> config = AutoConfig.from_pretrained("./test/bert_saved_model/my_configuration.json")
975

976
        >>> # Change some config attributes when loading a pretrained config.
Sylvain Gugger's avatar
Sylvain Gugger committed
977
        >>> config = AutoConfig.from_pretrained("bert-base-uncased", output_attentions=True, foo=False)
978
979
        >>> config.output_attentions
        True
Sylvain Gugger's avatar
Sylvain Gugger committed
980
981
982
983

        >>> config, unused_kwargs = AutoConfig.from_pretrained(
        ...     "bert-base-uncased", output_attentions=True, foo=False, return_unused_kwargs=True
        ... )
984
985
        >>> config.output_attentions
        True
Sylvain Gugger's avatar
Sylvain Gugger committed
986

987
        >>> unused_kwargs
988
989
        {'foo': False}
        ```"""
990
        kwargs["_from_auto"] = True
991
        kwargs["name_or_path"] = pretrained_model_name_or_path
992
        trust_remote_code = kwargs.pop("trust_remote_code", None)
993
        config_dict, unused_kwargs = PretrainedConfig.get_config_dict(pretrained_model_name_or_path, **kwargs)
994
995
996
997
998
999
1000
        has_remote_code = "auto_map" in config_dict and "AutoConfig" in config_dict["auto_map"]
        has_local_code = "model_type" in config_dict and config_dict["model_type"] in CONFIG_MAPPING
        trust_remote_code = resolve_trust_remote_code(
            trust_remote_code, pretrained_model_name_or_path, has_local_code, has_remote_code
        )

        if has_remote_code and trust_remote_code:
1001
            class_ref = config_dict["auto_map"]["AutoConfig"]
1002
            config_class = get_class_from_dynamic_module(class_ref, pretrained_model_name_or_path, **kwargs)
1003
1004
            if os.path.isdir(pretrained_model_name_or_path):
                config_class.register_for_auto_class()
1005
            _ = kwargs.pop("code_revision", None)
1006
1007
            return config_class.from_pretrained(pretrained_model_name_or_path, **kwargs)
        elif "model_type" in config_dict:
1008
            config_class = CONFIG_MAPPING[config_dict["model_type"]]
1009
            return config_class.from_dict(config_dict, **unused_kwargs)
1010
1011
        else:
            # Fallback: use pattern matching on the string.
1012
1013
            # We go from longer names to shorter names to catch roberta before bert (for instance)
            for pattern in sorted(CONFIG_MAPPING.keys(), key=len, reverse=True):
1014
                if pattern in str(pretrained_model_name_or_path):
1015
                    return CONFIG_MAPPING[pattern].from_dict(config_dict, **unused_kwargs)
1016

1017
        raise ValueError(
1018
            f"Unrecognized model in {pretrained_model_name_or_path}. "
1019
            f"Should have a `model_type` key in its {CONFIG_NAME}, or contain one of the following strings "
1020
            f"in its name: {', '.join(CONFIG_MAPPING.keys())}"
1021
        )
1022
1023
1024
1025
1026
1027
1028

    @staticmethod
    def register(model_type, config):
        """
        Register a new configuration for this class.

        Args:
1029
1030
            model_type (`str`): The model type like "bert" or "gpt".
            config ([`PretrainedConfig`]): The config to register.
1031
1032
1033
1034
1035
1036
1037
1038
        """
        if issubclass(config, PretrainedConfig) and config.model_type != model_type:
            raise ValueError(
                "The config you are passing has a `model_type` attribute that is not consistent with the model type "
                f"you passed (config has {config.model_type} and you passed {model_type}. Fix one of those so they "
                "match!"
            )
        CONFIG_MAPPING.register(model_type, config)