configuration_auto.py 43.6 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
        ("mra", "MraConfig"),
145
        ("mt5", "MT5Config"),
Sanchit Gandhi's avatar
Sanchit Gandhi committed
146
        ("musicgen", "MusicgenConfig"),
StevenTang1998's avatar
StevenTang1998 committed
147
        ("mvp", "MvpConfig"),
148
        ("nat", "NatConfig"),
149
        ("nezha", "NezhaConfig"),
150
        ("nllb-moe", "NllbMoeConfig"),
151
        ("nystromformer", "NystromformerConfig"),
Jitesh Jain's avatar
Jitesh Jain committed
152
        ("oneformer", "OneFormerConfig"),
153
        ("open-llama", "OpenLlamaConfig"),
154
        ("openai-gpt", "OpenAIGPTConfig"),
Younes Belkada's avatar
Younes Belkada committed
155
        ("opt", "OPTConfig"),
156
        ("owlvit", "OwlViTConfig"),
157
        ("pegasus", "PegasusConfig"),
Jason Phang's avatar
Jason Phang committed
158
        ("pegasus_x", "PegasusXConfig"),
159
        ("perceiver", "PerceiverConfig"),
Younes Belkada's avatar
Younes Belkada committed
160
        ("pix2struct", "Pix2StructConfig"),
161
162
163
164
165
166
        ("plbart", "PLBartConfig"),
        ("poolformer", "PoolFormerConfig"),
        ("prophetnet", "ProphetNetConfig"),
        ("qdqbert", "QDQBertConfig"),
        ("rag", "RagConfig"),
        ("realm", "RealmConfig"),
167
        ("reformer", "ReformerConfig"),
168
169
170
171
        ("regnet", "RegNetConfig"),
        ("rembert", "RemBertConfig"),
        ("resnet", "ResNetConfig"),
        ("retribert", "RetriBertConfig"),
172
        ("roberta", "RobertaConfig"),
173
        ("roberta-prelayernorm", "RobertaPreLayerNormConfig"),
Weiwe Shi's avatar
Weiwe Shi committed
174
        ("roc_bert", "RoCBertConfig"),
175
        ("roformer", "RoFormerConfig"),
Sylvain Gugger's avatar
Sylvain Gugger committed
176
        ("rwkv", "RwkvConfig"),
177
        ("sam", "SamConfig"),
178
179
180
        ("segformer", "SegformerConfig"),
        ("sew", "SEWConfig"),
        ("sew-d", "SEWDConfig"),
181
        ("speech-encoder-decoder", "SpeechEncoderDecoderConfig"),
182
183
        ("speech_to_text", "Speech2TextConfig"),
        ("speech_to_text_2", "Speech2Text2Config"),
184
        ("speecht5", "SpeechT5Config"),
Ori Ram's avatar
Ori Ram committed
185
        ("splinter", "SplinterConfig"),
186
        ("squeezebert", "SqueezeBertConfig"),
Shehan Munasinghe's avatar
Shehan Munasinghe committed
187
        ("swiftformer", "SwiftFormerConfig"),
188
        ("swin", "SwinConfig"),
NielsRogge's avatar
NielsRogge committed
189
        ("swin2sr", "Swin2SRConfig"),
190
        ("swinv2", "Swinv2Config"),
191
        ("switch_transformers", "SwitchTransformersConfig"),
192
        ("t5", "T5Config"),
193
        ("table-transformer", "TableTransformerConfig"),
194
        ("tapas", "TapasConfig"),
195
        ("time_series_transformer", "TimeSeriesTransformerConfig"),
196
        ("timesformer", "TimesformerConfig"),
amyeroberts's avatar
amyeroberts committed
197
        ("timm_backbone", "TimmBackboneConfig"),
Carl's avatar
Carl committed
198
        ("trajectory_transformer", "TrajectoryTransformerConfig"),
199
200
        ("transfo-xl", "TransfoXLConfig"),
        ("trocr", "TrOCRConfig"),
Zineng Tang's avatar
Zineng Tang committed
201
        ("tvlt", "TvltConfig"),
202
        ("umt5", "UMT5Config"),
203
        ("unispeech", "UniSpeechConfig"),
204
        ("unispeech-sat", "UniSpeechSatConfig"),
NielsRogge's avatar
NielsRogge committed
205
        ("upernet", "UperNetConfig"),
206
        ("van", "VanConfig"),
NielsRogge's avatar
NielsRogge committed
207
        ("videomae", "VideoMAEConfig"),
208
209
210
211
212
        ("vilt", "ViltConfig"),
        ("vision-encoder-decoder", "VisionEncoderDecoderConfig"),
        ("vision-text-dual-encoder", "VisionTextDualEncoderConfig"),
        ("visual_bert", "VisualBertConfig"),
        ("vit", "ViTConfig"),
NielsRogge's avatar
NielsRogge committed
213
        ("vit_hybrid", "ViTHybridConfig"),
214
        ("vit_mae", "ViTMAEConfig"),
215
        ("vit_msn", "ViTMSNConfig"),
Jegor Kit拧kerkin's avatar
Jegor Kit拧kerkin committed
216
        ("vivit", "VivitConfig"),
217
        ("wav2vec2", "Wav2Vec2Config"),
218
        ("wav2vec2-conformer", "Wav2Vec2ConformerConfig"),
Patrick von Platen's avatar
Patrick von Platen committed
219
        ("wavlm", "WavLMConfig"),
220
        ("whisper", "WhisperConfig"),
NielsRogge's avatar
NielsRogge committed
221
        ("xclip", "XCLIPConfig"),
222
223
224
225
226
227
        ("xglm", "XGLMConfig"),
        ("xlm", "XLMConfig"),
        ("xlm-prophetnet", "XLMProphetNetConfig"),
        ("xlm-roberta", "XLMRobertaConfig"),
        ("xlm-roberta-xl", "XLMRobertaXLConfig"),
        ("xlnet", "XLNetConfig"),
Jannis Vamvas's avatar
Jannis Vamvas committed
228
        ("xmod", "XmodConfig"),
229
230
        ("yolos", "YolosConfig"),
        ("yoso", "YosoConfig"),
231
232
    ]
)
233

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

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

Sylvain Gugger's avatar
Sylvain Gugger committed
651
652
653
654
655
DEPRECATED_MODELS = [
    "bort",
    "mctct",
    "mmbt",
    "retribert",
656
    "tapex",
Sylvain Gugger's avatar
Sylvain Gugger committed
657
658
659
660
    "trajectory_transformer",
    "van",
]

661
SPECIAL_MODEL_TYPE_TO_MODULE_NAME = OrderedDict(
662
663
664
665
666
    [
        ("openai-gpt", "openai"),
        ("data2vec-audio", "data2vec"),
        ("data2vec-text", "data2vec"),
        ("data2vec-vision", "data2vec"),
NielsRogge's avatar
NielsRogge committed
667
        ("donut-swin", "donut"),
668
        ("maskformer-swin", "maskformer"),
NielsRogge's avatar
NielsRogge committed
669
        ("xclip", "x_clip"),
670
    ]
671
)
672
673
674
675
676
677
678
679


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
680
681
682
683
684
    key = key.replace("-", "_")
    if key in DEPRECATED_MODELS:
        key = f"deprecated.{key}"

    return key
685
686
687
688
689
690
691


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
692
693
694
695
    # if key not found check in extra content
    for key, cls in CONFIG_MAPPING._extra_content.items():
        if cls.__name__ == config:
            return key
696
697
698
699
700
701
702
703
704
705
    return None


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

    def __init__(self, mapping):
        self._mapping = mapping
706
        self._extra_content = {}
707
708
709
        self._modules = {}

    def __getitem__(self, key):
710
711
        if key in self._extra_content:
            return self._extra_content[key]
712
713
714
715
716
717
        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")
718
719
720
721
722
723
724
        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)
725
726

    def keys(self):
727
        return list(self._mapping.keys()) + list(self._extra_content.keys())
728
729

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

732
    def items(self):
733
        return [(k, self[k]) for k in self._mapping.keys()] + list(self._extra_content.items())
734
735

    def __iter__(self):
736
        return iter(list(self._mapping.keys()) + list(self._extra_content.keys()))
737
738

    def __contains__(self, item):
739
740
        return item in self._mapping or item in self._extra_content

741
    def register(self, key, value, exist_ok=False):
742
743
744
        """
        Register a new configuration in this mapping.
        """
745
        if key in self._mapping.keys() and not exist_ok:
746
747
            raise ValueError(f"'{key}' is already used by a Transformers config, pick another name.")
        self._extra_content[key] = value
748
749
750
751
752
753
754
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


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]]):
813
    if isinstance(model_class, (list, tuple)):
Stas Bekman's avatar
Stas Bekman committed
814
815
        return " or ".join([f"[`{c}`]" for c in model_class if c is not None])
    return f"[`{model_class}`]"
816
817


818
819
820
821
822
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
823
            model_type_to_name = {model_type: f"[`{config}`]" for model_type, config in CONFIG_MAPPING_NAMES.items()}
824
825
        else:
            model_type_to_name = {
826
827
828
                model_type: _get_class_name(model_class)
                for model_type, model_class in config_to_class.items()
                if model_type in MODEL_NAMES_MAPPING
829
830
            }
        lines = [
831
            f"{indent}- **{model_type}** -- {model_type_to_name[model_type]} ({MODEL_NAMES_MAPPING[model_type]} model)"
832
            for model_type in sorted(model_type_to_name.keys())
833
834
        ]
    else:
835
836
837
838
839
        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
        }
840
        config_to_model_name = {
841
            config: MODEL_NAMES_MAPPING[model_type] for model_type, config in CONFIG_MAPPING_NAMES.items()
842
843
        }
        lines = [
Sylvain Gugger's avatar
Sylvain Gugger committed
844
845
            f"{indent}- [`{config_name}`] configuration class:"
            f" {config_to_name[config_name]} ({config_to_model_name[config_name]} model)"
846
            for config_name in sorted(config_to_name.keys())
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
        ]
    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
866
867
                f"The function {fn} should have an empty 'List options' in its docstring as placeholder, current"
                f" docstring is:\n{docstrings}"
868
869
870
871
872
873
874
            )
        fn.__doc__ = docstrings
        return fn

    return docstring_decorator


Julien Chaumond's avatar
Julien Chaumond committed
875
class AutoConfig:
Lysandre Debut's avatar
Lysandre Debut committed
876
    r"""
877
    This is a generic configuration class that will be instantiated as one of the configuration classes of the library
878
    when created with the [`~AutoConfig.from_pretrained`] class method.
879

880
    This class cannot be instantiated directly using `__init__()` (throws an error).
881
    """
882

883
    def __init__(self):
884
885
886
887
        raise EnvironmentError(
            "AutoConfig is designed to be instantiated "
            "using the `AutoConfig.from_pretrained(pretrained_model_name_or_path)` method."
        )
888

889
    @classmethod
890
891
892
893
    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)
894
        raise ValueError(
895
            f"Unrecognized model identifier: {model_type}. Should contain one of {', '.join(CONFIG_MAPPING.keys())}"
896
        )
897

898
    @classmethod
899
    @replace_list_option_in_docstrings()
900
    def from_pretrained(cls, pretrained_model_name_or_path, **kwargs):
901
902
        r"""
        Instantiate one of the configuration classes of the library from a pretrained model configuration.
903

Sylvain Gugger's avatar
Sylvain Gugger committed
904
905
        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`:
906

907
        List options
Lysandre Debut's avatar
Lysandre Debut committed
908
909

        Args:
910
            pretrained_model_name_or_path (`str` or `os.PathLike`):
911
912
                Can be either:

913
914
915
916
                    - 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
917
918
                      [`~PretrainedConfig.save_pretrained`] method, or the [`~PreTrainedModel.save_pretrained`] method,
                      e.g., `./my_model_directory/`.
919
920
921
                    - A path or url to a saved configuration JSON *file*, e.g.,
                      `./my_model_directory/configuration.json`.
            cache_dir (`str` or `os.PathLike`, *optional*):
922
923
                Path to a directory in which a downloaded pretrained model configuration should be cached if the
                standard cache should not be used.
924
            force_download (`bool`, *optional*, defaults to `False`):
925
926
                Whether or not to force the (re-)download the model weights and configuration files and override the
                cached versions if they exist.
927
            resume_download (`bool`, *optional*, defaults to `False`):
928
929
                Whether or not to delete incompletely received files. Will attempt to resume the download if such a
                file exists.
930
            proxies (`Dict[str, str]`, *optional*):
Sylvain Gugger's avatar
Sylvain Gugger committed
931
932
                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.
933
            revision (`str`, *optional*, defaults to `"main"`):
Julien Chaumond's avatar
Julien Chaumond committed
934
                The specific model version to use. It can be a branch name, a tag name, or a commit id, since we use a
935
                git-based system for storing models and other artifacts on huggingface.co, so `revision` can be any
Julien Chaumond's avatar
Julien Chaumond committed
936
                identifier allowed by git.
937
938
            return_unused_kwargs (`bool`, *optional*, defaults to `False`):
                If `False`, then this function returns just the final configuration object.
939

Sylvain Gugger's avatar
Sylvain Gugger committed
940
941
942
                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.
943
            trust_remote_code (`bool`, *optional*, defaults to `False`):
944
                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
945
946
                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.
947
            kwargs(additional keyword arguments, *optional*):
948
                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
949
                values. Behavior concerning key/value pairs whose keys are *not* configuration attributes is controlled
950
                by the `return_unused_kwargs` keyword parameter.
Lysandre Debut's avatar
Lysandre Debut committed
951

952
        Examples:
953

954
955
        ```python
        >>> from transformers import AutoConfig
956

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

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

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

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

969
        >>> # Change some config attributes when loading a pretrained config.
Sylvain Gugger's avatar
Sylvain Gugger committed
970
        >>> config = AutoConfig.from_pretrained("bert-base-uncased", output_attentions=True, foo=False)
971
972
        >>> config.output_attentions
        True
Sylvain Gugger's avatar
Sylvain Gugger committed
973
974
975
976

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

980
        >>> unused_kwargs
981
982
        {'foo': False}
        ```"""
983
        kwargs["_from_auto"] = True
984
        kwargs["name_or_path"] = pretrained_model_name_or_path
985
        trust_remote_code = kwargs.pop("trust_remote_code", None)
986
        config_dict, unused_kwargs = PretrainedConfig.get_config_dict(pretrained_model_name_or_path, **kwargs)
987
988
989
990
991
992
993
        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:
994
            class_ref = config_dict["auto_map"]["AutoConfig"]
995
            config_class = get_class_from_dynamic_module(class_ref, pretrained_model_name_or_path, **kwargs)
996
997
            if os.path.isdir(pretrained_model_name_or_path):
                config_class.register_for_auto_class()
998
            _ = kwargs.pop("code_revision", None)
999
1000
            return config_class.from_pretrained(pretrained_model_name_or_path, **kwargs)
        elif "model_type" in config_dict:
1001
            config_class = CONFIG_MAPPING[config_dict["model_type"]]
1002
            return config_class.from_dict(config_dict, **unused_kwargs)
1003
1004
        else:
            # Fallback: use pattern matching on the string.
1005
1006
            # 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):
1007
                if pattern in str(pretrained_model_name_or_path):
1008
                    return CONFIG_MAPPING[pattern].from_dict(config_dict, **unused_kwargs)
1009

1010
        raise ValueError(
1011
            f"Unrecognized model in {pretrained_model_name_or_path}. "
1012
            f"Should have a `model_type` key in its {CONFIG_NAME}, or contain one of the following strings "
1013
            f"in its name: {', '.join(CONFIG_MAPPING.keys())}"
1014
        )
1015
1016
1017
1018
1019
1020
1021

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

        Args:
1022
1023
            model_type (`str`): The model type like "bert" or "gpt".
            config ([`PretrainedConfig`]): The config to register.
1024
1025
1026
1027
1028
1029
1030
1031
        """
        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)