configuration_auto.py 35.4 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 re
18
import warnings
19
from collections import OrderedDict
20
from typing import List, Union
21

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

26

27
28
logger = logging.get_logger(__name__)

29
30
31
CONFIG_MAPPING_NAMES = OrderedDict(
    [
        # Add configs here
32
33
        ("albert", "AlbertConfig"),
        ("bart", "BartConfig"),
34
        ("beit", "BeitConfig"),
35
36
37
38
39
40
        ("bert", "BertConfig"),
        ("bert-generation", "BertGenerationConfig"),
        ("big_bird", "BigBirdConfig"),
        ("bigbird_pegasus", "BigBirdPegasusConfig"),
        ("blenderbot", "BlenderbotConfig"),
        ("blenderbot-small", "BlenderbotSmallConfig"),
Younes Belkada's avatar
Younes Belkada committed
41
        ("bloom", "BloomConfig"),
42
        ("camembert", "CamembertConfig"),
43
44
        ("canine", "CanineConfig"),
        ("clip", "CLIPConfig"),
NielsRogge's avatar
NielsRogge committed
45
        ("clipseg", "CLIPSegConfig"),
rooa's avatar
rooa committed
46
        ("codegen", "CodeGenConfig"),
47
        ("conditional_detr", "ConditionalDetrConfig"),
48
49
50
        ("convbert", "ConvBertConfig"),
        ("convnext", "ConvNextConfig"),
        ("ctrl", "CTRLConfig"),
NielsRogge's avatar
NielsRogge committed
51
        ("cvt", "CvtConfig"),
52
53
54
55
56
57
        ("data2vec-audio", "Data2VecAudioConfig"),
        ("data2vec-text", "Data2VecTextConfig"),
        ("data2vec-vision", "Data2VecVisionConfig"),
        ("deberta", "DebertaConfig"),
        ("deberta-v2", "DebertaV2Config"),
        ("decision_transformer", "DecisionTransformerConfig"),
NielsRogge's avatar
NielsRogge committed
58
        ("deformable_detr", "DeformableDetrConfig"),
59
60
        ("deit", "DeiTConfig"),
        ("detr", "DetrConfig"),
61
        ("distilbert", "DistilBertConfig"),
NielsRogge's avatar
NielsRogge committed
62
        ("donut-swin", "DonutSwinConfig"),
63
64
65
66
        ("dpr", "DPRConfig"),
        ("dpt", "DPTConfig"),
        ("electra", "ElectraConfig"),
        ("encoder-decoder", "EncoderDecoderConfig"),
67
        ("ernie", "ErnieConfig"),
68
        ("esm", "EsmConfig"),
69
70
71
72
73
74
75
        ("flaubert", "FlaubertConfig"),
        ("flava", "FlavaConfig"),
        ("fnet", "FNetConfig"),
        ("fsmt", "FSMTConfig"),
        ("funnel", "FunnelConfig"),
        ("glpn", "GLPNConfig"),
        ("gpt2", "GPT2Config"),
76
        ("gpt_neo", "GPTNeoConfig"),
77
        ("gpt_neox", "GPTNeoXConfig"),
78
        ("gpt_neox_japanese", "GPTNeoXJapaneseConfig"),
79
        ("gptj", "GPTJConfig"),
80
        ("groupvit", "GroupViTConfig"),
81
        ("hubert", "HubertConfig"),
82
        ("ibert", "IBertConfig"),
83
        ("imagegpt", "ImageGPTConfig"),
84
        ("jukebox", "JukeboxConfig"),
85
86
        ("layoutlm", "LayoutLMConfig"),
        ("layoutlmv2", "LayoutLMv2Config"),
NielsRogge's avatar
NielsRogge committed
87
        ("layoutlmv3", "LayoutLMv3Config"),
88
        ("led", "LEDConfig"),
89
        ("levit", "LevitConfig"),
NielsRogge's avatar
NielsRogge committed
90
        ("lilt", "LiltConfig"),
91
        ("longformer", "LongformerConfig"),
Daniel Stancl's avatar
Daniel Stancl committed
92
        ("longt5", "LongT5Config"),
93
94
95
        ("luke", "LukeConfig"),
        ("lxmert", "LxmertConfig"),
        ("m2m_100", "M2M100Config"),
96
        ("marian", "MarianConfig"),
NielsRogge's avatar
NielsRogge committed
97
        ("markuplm", "MarkupLMConfig"),
98
        ("maskformer", "MaskFormerConfig"),
99
        ("mbart", "MBartConfig"),
Chan Woo Kim's avatar
Chan Woo Kim committed
100
        ("mctct", "MCTCTConfig"),
101
        ("megatron-bert", "MegatronBertConfig"),
102
        ("mobilebert", "MobileBertConfig"),
103
        ("mobilevit", "MobileViTConfig"),
104
        ("mpnet", "MPNetConfig"),
105
        ("mt5", "MT5Config"),
StevenTang1998's avatar
StevenTang1998 committed
106
        ("mvp", "MvpConfig"),
107
        ("nezha", "NezhaConfig"),
108
109
        ("nystromformer", "NystromformerConfig"),
        ("openai-gpt", "OpenAIGPTConfig"),
Younes Belkada's avatar
Younes Belkada committed
110
        ("opt", "OPTConfig"),
111
        ("owlvit", "OwlViTConfig"),
112
        ("pegasus", "PegasusConfig"),
Jason Phang's avatar
Jason Phang committed
113
        ("pegasus_x", "PegasusXConfig"),
114
115
116
117
118
119
120
        ("perceiver", "PerceiverConfig"),
        ("plbart", "PLBartConfig"),
        ("poolformer", "PoolFormerConfig"),
        ("prophetnet", "ProphetNetConfig"),
        ("qdqbert", "QDQBertConfig"),
        ("rag", "RagConfig"),
        ("realm", "RealmConfig"),
121
        ("reformer", "ReformerConfig"),
122
123
124
125
        ("regnet", "RegNetConfig"),
        ("rembert", "RemBertConfig"),
        ("resnet", "ResNetConfig"),
        ("retribert", "RetriBertConfig"),
126
        ("roberta", "RobertaConfig"),
Weiwe Shi's avatar
Weiwe Shi committed
127
        ("roc_bert", "RoCBertConfig"),
128
129
130
131
        ("roformer", "RoFormerConfig"),
        ("segformer", "SegformerConfig"),
        ("sew", "SEWConfig"),
        ("sew-d", "SEWDConfig"),
132
        ("speech-encoder-decoder", "SpeechEncoderDecoderConfig"),
133
134
        ("speech_to_text", "Speech2TextConfig"),
        ("speech_to_text_2", "Speech2Text2Config"),
Ori Ram's avatar
Ori Ram committed
135
        ("splinter", "SplinterConfig"),
136
137
        ("squeezebert", "SqueezeBertConfig"),
        ("swin", "SwinConfig"),
138
        ("swinv2", "Swinv2Config"),
139
        ("t5", "T5Config"),
140
        ("table-transformer", "TableTransformerConfig"),
141
        ("tapas", "TapasConfig"),
142
        ("time_series_transformer", "TimeSeriesTransformerConfig"),
Carl's avatar
Carl committed
143
        ("trajectory_transformer", "TrajectoryTransformerConfig"),
144
145
        ("transfo-xl", "TransfoXLConfig"),
        ("trocr", "TrOCRConfig"),
146
        ("unispeech", "UniSpeechConfig"),
147
148
        ("unispeech-sat", "UniSpeechSatConfig"),
        ("van", "VanConfig"),
NielsRogge's avatar
NielsRogge committed
149
        ("videomae", "VideoMAEConfig"),
150
151
152
153
154
155
        ("vilt", "ViltConfig"),
        ("vision-encoder-decoder", "VisionEncoderDecoderConfig"),
        ("vision-text-dual-encoder", "VisionTextDualEncoderConfig"),
        ("visual_bert", "VisualBertConfig"),
        ("vit", "ViTConfig"),
        ("vit_mae", "ViTMAEConfig"),
156
        ("vit_msn", "ViTMSNConfig"),
157
        ("wav2vec2", "Wav2Vec2Config"),
158
        ("wav2vec2-conformer", "Wav2Vec2ConformerConfig"),
Patrick von Platen's avatar
Patrick von Platen committed
159
        ("wavlm", "WavLMConfig"),
160
        ("whisper", "WhisperConfig"),
NielsRogge's avatar
NielsRogge committed
161
        ("xclip", "XCLIPConfig"),
162
163
164
165
166
167
168
169
        ("xglm", "XGLMConfig"),
        ("xlm", "XLMConfig"),
        ("xlm-prophetnet", "XLMProphetNetConfig"),
        ("xlm-roberta", "XLMRobertaConfig"),
        ("xlm-roberta-xl", "XLMRobertaXLConfig"),
        ("xlnet", "XLNetConfig"),
        ("yolos", "YolosConfig"),
        ("yoso", "YosoConfig"),
170
171
    ]
)
172

173
CONFIG_ARCHIVE_MAP_MAPPING_NAMES = OrderedDict(
174
    [
NielsRogge's avatar
NielsRogge committed
175
        # Add archive maps here)
176
177
        ("albert", "ALBERT_PRETRAINED_CONFIG_ARCHIVE_MAP"),
        ("bart", "BART_PRETRAINED_CONFIG_ARCHIVE_MAP"),
178
        ("beit", "BEIT_PRETRAINED_CONFIG_ARCHIVE_MAP"),
179
180
181
182
183
        ("bert", "BERT_PRETRAINED_CONFIG_ARCHIVE_MAP"),
        ("big_bird", "BIG_BIRD_PRETRAINED_CONFIG_ARCHIVE_MAP"),
        ("bigbird_pegasus", "BIGBIRD_PEGASUS_PRETRAINED_CONFIG_ARCHIVE_MAP"),
        ("blenderbot", "BLENDERBOT_PRETRAINED_CONFIG_ARCHIVE_MAP"),
        ("blenderbot-small", "BLENDERBOT_SMALL_PRETRAINED_CONFIG_ARCHIVE_MAP"),
Younes Belkada's avatar
Younes Belkada committed
184
        ("bloom", "BLOOM_PRETRAINED_CONFIG_ARCHIVE_MAP"),
185
        ("camembert", "CAMEMBERT_PRETRAINED_CONFIG_ARCHIVE_MAP"),
186
187
        ("canine", "CANINE_PRETRAINED_CONFIG_ARCHIVE_MAP"),
        ("clip", "CLIP_PRETRAINED_CONFIG_ARCHIVE_MAP"),
NielsRogge's avatar
NielsRogge committed
188
        ("clipseg", "CLIPSEG_PRETRAINED_CONFIG_ARCHIVE_MAP"),
rooa's avatar
rooa committed
189
        ("codegen", "CODEGEN_PRETRAINED_CONFIG_ARCHIVE_MAP"),
190
        ("conditional_detr", "CONDITIONAL_DETR_PRETRAINED_CONFIG_ARCHIVE_MAP"),
191
        ("convbert", "CONVBERT_PRETRAINED_CONFIG_ARCHIVE_MAP"),
192
        ("convnext", "CONVNEXT_PRETRAINED_CONFIG_ARCHIVE_MAP"),
193
        ("ctrl", "CTRL_PRETRAINED_CONFIG_ARCHIVE_MAP"),
NielsRogge's avatar
NielsRogge committed
194
        ("cvt", "CVT_PRETRAINED_CONFIG_ARCHIVE_MAP"),
195
        ("data2vec-audio", "DATA2VEC_AUDIO_PRETRAINED_CONFIG_ARCHIVE_MAP"),
196
197
198
199
        ("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
200
        ("deformable_detr", "DEFORMABLE_DETR_PRETRAINED_CONFIG_ARCHIVE_MAP"),
201
202
        ("deit", "DEIT_PRETRAINED_CONFIG_ARCHIVE_MAP"),
        ("detr", "DETR_PRETRAINED_CONFIG_ARCHIVE_MAP"),
203
        ("distilbert", "DISTILBERT_PRETRAINED_CONFIG_ARCHIVE_MAP"),
NielsRogge's avatar
NielsRogge committed
204
        ("donut-swin", "DONUT_SWIN_PRETRAINED_CONFIG_ARCHIVE_MAP"),
205
206
207
        ("dpr", "DPR_PRETRAINED_CONFIG_ARCHIVE_MAP"),
        ("dpt", "DPT_PRETRAINED_CONFIG_ARCHIVE_MAP"),
        ("electra", "ELECTRA_PRETRAINED_CONFIG_ARCHIVE_MAP"),
208
        ("ernie", "ERNIE_PRETRAINED_CONFIG_ARCHIVE_MAP"),
209
        ("esm", "ESM_PRETRAINED_CONFIG_ARCHIVE_MAP"),
210
        ("flaubert", "FLAUBERT_PRETRAINED_CONFIG_ARCHIVE_MAP"),
211
212
        ("flava", "FLAVA_PRETRAINED_CONFIG_ARCHIVE_MAP"),
        ("fnet", "FNET_PRETRAINED_CONFIG_ARCHIVE_MAP"),
213
214
        ("fsmt", "FSMT_PRETRAINED_CONFIG_ARCHIVE_MAP"),
        ("funnel", "FUNNEL_PRETRAINED_CONFIG_ARCHIVE_MAP"),
215
216
217
        ("glpn", "GLPN_PRETRAINED_CONFIG_ARCHIVE_MAP"),
        ("gpt2", "GPT2_PRETRAINED_CONFIG_ARCHIVE_MAP"),
        ("gpt_neo", "GPT_NEO_PRETRAINED_CONFIG_ARCHIVE_MAP"),
218
        ("gpt_neox", "GPT_NEOX_PRETRAINED_CONFIG_ARCHIVE_MAP"),
219
        ("gpt_neox_japanese", "GPT_NEOX_JAPANESE_PRETRAINED_CONFIG_ARCHIVE_MAP"),
220
        ("gptj", "GPTJ_PRETRAINED_CONFIG_ARCHIVE_MAP"),
221
        ("groupvit", "GROUPVIT_PRETRAINED_CONFIG_ARCHIVE_MAP"),
222
223
224
        ("hubert", "HUBERT_PRETRAINED_CONFIG_ARCHIVE_MAP"),
        ("ibert", "IBERT_PRETRAINED_CONFIG_ARCHIVE_MAP"),
        ("imagegpt", "IMAGEGPT_PRETRAINED_CONFIG_ARCHIVE_MAP"),
225
        ("jukebox", "JUKEBOX_PRETRAINED_CONFIG_ARCHIVE_MAP"),
226
        ("layoutlm", "LAYOUTLM_PRETRAINED_CONFIG_ARCHIVE_MAP"),
227
        ("layoutlmv2", "LAYOUTLMV2_PRETRAINED_CONFIG_ARCHIVE_MAP"),
NielsRogge's avatar
NielsRogge committed
228
        ("layoutlmv3", "LAYOUTLMV3_PRETRAINED_CONFIG_ARCHIVE_MAP"),
229
        ("led", "LED_PRETRAINED_CONFIG_ARCHIVE_MAP"),
230
        ("levit", "LEVIT_PRETRAINED_CONFIG_ARCHIVE_MAP"),
NielsRogge's avatar
NielsRogge committed
231
        ("lilt", "LILT_PRETRAINED_CONFIG_ARCHIVE_MAP"),
232
        ("longformer", "LONGFORMER_PRETRAINED_CONFIG_ARCHIVE_MAP"),
Daniel Stancl's avatar
Daniel Stancl committed
233
        ("longt5", "LONGT5_PRETRAINED_CONFIG_ARCHIVE_MAP"),
234
235
236
        ("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
237
        ("markuplm", "MARKUPLM_PRETRAINED_CONFIG_ARCHIVE_MAP"),
238
239
        ("maskformer", "MASKFORMER_PRETRAINED_CONFIG_ARCHIVE_MAP"),
        ("mbart", "MBART_PRETRAINED_CONFIG_ARCHIVE_MAP"),
Chan Woo Kim's avatar
Chan Woo Kim committed
240
        ("mctct", "MCTCT_PRETRAINED_CONFIG_ARCHIVE_MAP"),
241
        ("megatron-bert", "MEGATRON_BERT_PRETRAINED_CONFIG_ARCHIVE_MAP"),
242
        ("mobilevit", "MOBILEVIT_PRETRAINED_CONFIG_ARCHIVE_MAP"),
243
        ("mpnet", "MPNET_PRETRAINED_CONFIG_ARCHIVE_MAP"),
StevenTang1998's avatar
StevenTang1998 committed
244
        ("mvp", "MVP_PRETRAINED_CONFIG_ARCHIVE_MAP"),
245
        ("nezha", "NEZHA_PRETRAINED_CONFIG_ARCHIVE_MAP"),
246
247
248
        ("nystromformer", "NYSTROMFORMER_PRETRAINED_CONFIG_ARCHIVE_MAP"),
        ("openai-gpt", "OPENAI_GPT_PRETRAINED_CONFIG_ARCHIVE_MAP"),
        ("opt", "OPT_PRETRAINED_CONFIG_ARCHIVE_MAP"),
249
        ("owlvit", "OWLVIT_PRETRAINED_CONFIG_ARCHIVE_MAP"),
250
        ("pegasus", "PEGASUS_PRETRAINED_CONFIG_ARCHIVE_MAP"),
Jason Phang's avatar
Jason Phang committed
251
        ("pegasus_x", "PEGASUS_X_PRETRAINED_CONFIG_ARCHIVE_MAP"),
252
253
254
255
256
257
258
259
260
261
262
        ("perceiver", "PERCEIVER_PRETRAINED_CONFIG_ARCHIVE_MAP"),
        ("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"),
Weiwe Shi's avatar
Weiwe Shi committed
263
        ("roc_bert", "ROC_BERT_PRETRAINED_CONFIG_ARCHIVE_MAP"),
264
265
        ("roformer", "ROFORMER_PRETRAINED_CONFIG_ARCHIVE_MAP"),
        ("segformer", "SEGFORMER_PRETRAINED_CONFIG_ARCHIVE_MAP"),
266
        ("sew", "SEW_PRETRAINED_CONFIG_ARCHIVE_MAP"),
267
268
269
270
271
272
        ("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"),
        ("splinter", "SPLINTER_PRETRAINED_CONFIG_ARCHIVE_MAP"),
        ("squeezebert", "SQUEEZEBERT_PRETRAINED_CONFIG_ARCHIVE_MAP"),
        ("swin", "SWIN_PRETRAINED_CONFIG_ARCHIVE_MAP"),
273
        ("swinv2", "SWINV2_PRETRAINED_CONFIG_ARCHIVE_MAP"),
274
        ("t5", "T5_PRETRAINED_CONFIG_ARCHIVE_MAP"),
275
        ("table-transformer", "TABLE_TRANSFORMER_PRETRAINED_CONFIG_ARCHIVE_MAP"),
276
        ("tapas", "TAPAS_PRETRAINED_CONFIG_ARCHIVE_MAP"),
277
        ("time_series_transformer", "TIME_SERIES_TRANSFORMER_PRETRAINED_CONFIG_ARCHIVE_MAP"),
278
        ("transfo-xl", "TRANSFO_XL_PRETRAINED_CONFIG_ARCHIVE_MAP"),
279
        ("unispeech", "UNISPEECH_PRETRAINED_CONFIG_ARCHIVE_MAP"),
280
281
        ("unispeech-sat", "UNISPEECH_SAT_PRETRAINED_CONFIG_ARCHIVE_MAP"),
        ("van", "VAN_PRETRAINED_CONFIG_ARCHIVE_MAP"),
NielsRogge's avatar
NielsRogge committed
282
        ("videomae", "VIDEOMAE_PRETRAINED_CONFIG_ARCHIVE_MAP"),
283
284
285
286
        ("vilt", "VILT_PRETRAINED_CONFIG_ARCHIVE_MAP"),
        ("visual_bert", "VISUAL_BERT_PRETRAINED_CONFIG_ARCHIVE_MAP"),
        ("vit", "VIT_PRETRAINED_CONFIG_ARCHIVE_MAP"),
        ("vit_mae", "VIT_MAE_PRETRAINED_CONFIG_ARCHIVE_MAP"),
287
        ("vit_msn", "VIT_MSN_PRETRAINED_CONFIG_ARCHIVE_MAP"),
288
        ("wav2vec2", "WAV_2_VEC_2_PRETRAINED_CONFIG_ARCHIVE_MAP"),
289
        ("wav2vec2-conformer", "WAV2VEC2_CONFORMER_PRETRAINED_CONFIG_ARCHIVE_MAP"),
290
        ("whisper", "WHISPER_PRETRAINED_CONFIG_ARCHIVE_MAP"),
NielsRogge's avatar
NielsRogge committed
291
        ("xclip", "X_CLIP_PRETRAINED_CONFIG_ARCHIVE_MAP"),
292
293
294
295
296
297
298
        ("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"),
        ("yolos", "YOLOS_PRETRAINED_CONFIG_ARCHIVE_MAP"),
        ("yoso", "YOSO_PRETRAINED_CONFIG_ARCHIVE_MAP"),
299
300
301
302
303
    ]
)

MODEL_NAMES_MAPPING = OrderedDict(
    [
304
        # Add full (and cased) model names here
305
306
307
308
        ("albert", "ALBERT"),
        ("bart", "BART"),
        ("barthez", "BARThez"),
        ("bartpho", "BARTpho"),
NielsRogge's avatar
NielsRogge committed
309
        ("beit", "BEiT"),
310
311
312
        ("bert", "BERT"),
        ("bert-generation", "Bert Generation"),
        ("bert-japanese", "BertJapanese"),
313
        ("bertweet", "BERTweet"),
314
        ("big_bird", "BigBird"),
315
        ("bigbird_pegasus", "BigBird-Pegasus"),
316
317
        ("blenderbot", "Blenderbot"),
        ("blenderbot-small", "BlenderbotSmall"),
Younes Belkada's avatar
Younes Belkada committed
318
        ("bloom", "BLOOM"),
319
320
321
        ("bort", "BORT"),
        ("byt5", "ByT5"),
        ("camembert", "CamemBERT"),
322
        ("canine", "CANINE"),
Suraj Patil's avatar
Suraj Patil committed
323
        ("clip", "CLIP"),
NielsRogge's avatar
NielsRogge committed
324
        ("clipseg", "CLIPSeg"),
rooa's avatar
rooa committed
325
        ("codegen", "CodeGen"),
326
        ("conditional_detr", "Conditional DETR"),
327
        ("convbert", "ConvBERT"),
328
        ("convnext", "ConvNeXT"),
329
330
        ("cpm", "CPM"),
        ("ctrl", "CTRL"),
NielsRogge's avatar
NielsRogge committed
331
        ("cvt", "CvT"),
332
333
334
335
336
337
        ("data2vec-audio", "Data2VecAudio"),
        ("data2vec-text", "Data2VecText"),
        ("data2vec-vision", "Data2VecVision"),
        ("deberta", "DeBERTa"),
        ("deberta-v2", "DeBERTa-v2"),
        ("decision_transformer", "Decision Transformer"),
NielsRogge's avatar
NielsRogge committed
338
        ("deformable_detr", "Deformable DETR"),
NielsRogge's avatar
NielsRogge committed
339
        ("deit", "DeiT"),
NielsRogge's avatar
NielsRogge committed
340
        ("detr", "DETR"),
341
342
343
        ("dialogpt", "DialoGPT"),
        ("distilbert", "DistilBERT"),
        ("dit", "DiT"),
NielsRogge's avatar
NielsRogge committed
344
        ("donut-swin", "DonutSwin"),
345
346
347
348
        ("dpr", "DPR"),
        ("dpt", "DPT"),
        ("electra", "ELECTRA"),
        ("encoder-decoder", "Encoder decoder"),
349
        ("ernie", "ERNIE"),
350
        ("esm", "ESM"),
351
        ("flan-t5", "FLAN-T5"),
352
        ("flaubert", "FlauBERT"),
353
        ("flava", "FLAVA"),
354
355
356
357
358
        ("fnet", "FNet"),
        ("fsmt", "FairSeq Machine-Translation"),
        ("funnel", "Funnel Transformer"),
        ("glpn", "GLPN"),
        ("gpt2", "OpenAI GPT-2"),
Suraj Patil's avatar
Suraj Patil committed
359
        ("gpt_neo", "GPT Neo"),
360
        ("gpt_neox", "GPT NeoX"),
361
        ("gpt_neox_japanese", "GPT NeoX Japanese"),
362
        ("gptj", "GPT-J"),
363
        ("groupvit", "GroupViT"),
364
365
        ("herbert", "HerBERT"),
        ("hubert", "Hubert"),
Sehoon Kim's avatar
Sehoon Kim committed
366
        ("ibert", "I-BERT"),
367
        ("imagegpt", "ImageGPT"),
368
        ("jukebox", "Jukebox"),
369
370
        ("layoutlm", "LayoutLM"),
        ("layoutlmv2", "LayoutLMv2"),
NielsRogge's avatar
NielsRogge committed
371
        ("layoutlmv3", "LayoutLMv3"),
372
373
        ("layoutxlm", "LayoutXLM"),
        ("led", "LED"),
374
        ("levit", "LeViT"),
NielsRogge's avatar
NielsRogge committed
375
        ("lilt", "LiLT"),
376
        ("longformer", "Longformer"),
Daniel Stancl's avatar
Daniel Stancl committed
377
        ("longt5", "LongT5"),
378
379
380
        ("luke", "LUKE"),
        ("lxmert", "LXMERT"),
        ("m2m_100", "M2M100"),
381
        ("marian", "Marian"),
NielsRogge's avatar
NielsRogge committed
382
        ("markuplm", "MarkupLM"),
383
        ("maskformer", "MaskFormer"),
384
        ("mbart", "mBART"),
385
        ("mbart50", "mBART-50"),
Chan Woo Kim's avatar
Chan Woo Kim committed
386
        ("mctct", "M-CTC-T"),
387
388
        ("megatron-bert", "Megatron-BERT"),
        ("megatron_gpt2", "Megatron-GPT2"),
389
390
        ("mluke", "mLUKE"),
        ("mobilebert", "MobileBERT"),
391
        ("mobilevit", "MobileViT"),
392
        ("mpnet", "MPNet"),
393
        ("mt5", "MT5"),
StevenTang1998's avatar
StevenTang1998 committed
394
        ("mvp", "MVP"),
395
        ("nezha", "Nezha"),
Lysandre Debut's avatar
Lysandre Debut committed
396
        ("nllb", "NLLB"),
397
        ("nystromformer", "Nystr枚mformer"),
398
        ("openai-gpt", "OpenAI GPT"),
Younes Belkada's avatar
Younes Belkada committed
399
        ("opt", "OPT"),
400
        ("owlvit", "OWL-ViT"),
401
        ("pegasus", "Pegasus"),
Jason Phang's avatar
Jason Phang committed
402
        ("pegasus_x", "PEGASUS-X"),
403
404
405
406
407
408
409
        ("perceiver", "Perceiver"),
        ("phobert", "PhoBERT"),
        ("plbart", "PLBart"),
        ("poolformer", "PoolFormer"),
        ("prophetnet", "ProphetNet"),
        ("qdqbert", "QDQBert"),
        ("rag", "RAG"),
410
        ("realm", "REALM"),
411
        ("reformer", "Reformer"),
412
413
414
415
        ("regnet", "RegNet"),
        ("rembert", "RemBERT"),
        ("resnet", "ResNet"),
        ("retribert", "RetriBERT"),
416
        ("roberta", "RoBERTa"),
Weiwe Shi's avatar
Weiwe Shi committed
417
        ("roc_bert", "RoCBert"),
418
419
420
421
        ("roformer", "RoFormer"),
        ("segformer", "SegFormer"),
        ("sew", "SEW"),
        ("sew-d", "SEW-D"),
422
        ("speech-encoder-decoder", "Speech Encoder decoder"),
423
424
        ("speech_to_text", "Speech2Text"),
        ("speech_to_text_2", "Speech2Text2"),
Ori Ram's avatar
Ori Ram committed
425
        ("splinter", "Splinter"),
426
        ("squeezebert", "SqueezeBERT"),
427
        ("swin", "Swin Transformer"),
428
        ("swinv2", "Swin Transformer V2"),
429
430
        ("t5", "T5"),
        ("t5v1.1", "T5v1.1"),
431
        ("table-transformer", "Table Transformer"),
432
433
        ("tapas", "TAPAS"),
        ("tapex", "TAPEX"),
434
        ("time_series_transformer", "Time Series Transformer"),
Carl's avatar
Carl committed
435
        ("trajectory_transformer", "Trajectory Transformer"),
436
437
        ("transfo-xl", "Transformer-XL"),
        ("trocr", "TrOCR"),
438
        ("ul2", "UL2"),
439
        ("unispeech", "UniSpeech"),
440
441
        ("unispeech-sat", "UniSpeechSat"),
        ("van", "VAN"),
NielsRogge's avatar
NielsRogge committed
442
        ("videomae", "VideoMAE"),
443
444
445
        ("vilt", "ViLT"),
        ("vision-encoder-decoder", "Vision Encoder decoder"),
        ("vision-text-dual-encoder", "VisionTextDualEncoder"),
446
        ("visual_bert", "VisualBERT"),
447
448
        ("vit", "ViT"),
        ("vit_mae", "ViTMAE"),
449
        ("vit_msn", "ViTMSN"),
450
        ("wav2vec2", "Wav2Vec2"),
451
        ("wav2vec2-conformer", "Wav2Vec2-Conformer"),
452
        ("wav2vec2_phoneme", "Wav2Vec2Phoneme"),
Patrick von Platen's avatar
Patrick von Platen committed
453
        ("wavlm", "WavLM"),
454
        ("whisper", "Whisper"),
NielsRogge's avatar
NielsRogge committed
455
        ("xclip", "X-CLIP"),
456
457
        ("xglm", "XGLM"),
        ("xlm", "XLM"),
458
        ("xlm-prophetnet", "XLM-ProphetNet"),
459
460
461
        ("xlm-roberta", "XLM-RoBERTa"),
        ("xlm-roberta-xl", "XLM-RoBERTa-XL"),
        ("xlnet", "XLNet"),
462
463
        ("xls_r", "XLS-R"),
        ("xlsr_wav2vec2", "XLSR-Wav2Vec2"),
464
465
        ("yolos", "YOLOS"),
        ("yoso", "YOSO"),
466
467
468
    ]
)

469
SPECIAL_MODEL_TYPE_TO_MODULE_NAME = OrderedDict(
470
471
472
473
474
    [
        ("openai-gpt", "openai"),
        ("data2vec-audio", "data2vec"),
        ("data2vec-text", "data2vec"),
        ("data2vec-vision", "data2vec"),
NielsRogge's avatar
NielsRogge committed
475
        ("donut-swin", "donut"),
NielsRogge's avatar
NielsRogge committed
476
        ("xclip", "x_clip"),
477
    ]
478
)
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504


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]

    return key.replace("-", "_")


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
    return None


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

    def __init__(self, mapping):
        self._mapping = mapping
505
        self._extra_content = {}
506
507
508
        self._modules = {}

    def __getitem__(self, key):
509
510
        if key in self._extra_content:
            return self._extra_content[key]
511
512
513
514
515
516
        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")
517
518
519
520
521
522
523
        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)
524
525

    def keys(self):
526
        return list(self._mapping.keys()) + list(self._extra_content.keys())
527
528

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

531
    def items(self):
532
        return [(k, self[k]) for k in self._mapping.keys()] + list(self._extra_content.items())
533
534

    def __iter__(self):
535
        return iter(list(self._mapping.keys()) + list(self._extra_content.keys()))
536
537

    def __contains__(self, item):
538
539
540
541
542
543
544
545
546
        return item in self._mapping or item in self._extra_content

    def register(self, key, value):
        """
        Register a new configuration in this mapping.
        """
        if key in self._mapping.keys():
            raise ValueError(f"'{key}' is already used by a Transformers config, pick another name.")
        self._extra_content[key] = value
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611


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


617
618
619
620
621
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
622
            model_type_to_name = {model_type: f"[`{config}`]" for model_type, config in CONFIG_MAPPING_NAMES.items()}
623
624
        else:
            model_type_to_name = {
625
626
627
                model_type: _get_class_name(model_class)
                for model_type, model_class in config_to_class.items()
                if model_type in MODEL_NAMES_MAPPING
628
629
            }
        lines = [
630
            f"{indent}- **{model_type}** -- {model_type_to_name[model_type]} ({MODEL_NAMES_MAPPING[model_type]} model)"
631
            for model_type in sorted(model_type_to_name.keys())
632
633
        ]
    else:
634
635
636
637
638
        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
        }
639
        config_to_model_name = {
640
            config: MODEL_NAMES_MAPPING[model_type] for model_type, config in CONFIG_MAPPING_NAMES.items()
641
642
        }
        lines = [
Sylvain Gugger's avatar
Sylvain Gugger committed
643
644
            f"{indent}- [`{config_name}`] configuration class:"
            f" {config_to_name[config_name]} ({config_to_model_name[config_name]} model)"
645
            for config_name in sorted(config_to_name.keys())
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
        ]
    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
665
666
                f"The function {fn} should have an empty 'List options' in its docstring as placeholder, current"
                f" docstring is:\n{docstrings}"
667
668
669
670
671
672
673
            )
        fn.__doc__ = docstrings
        return fn

    return docstring_decorator


Julien Chaumond's avatar
Julien Chaumond committed
674
class AutoConfig:
Lysandre Debut's avatar
Lysandre Debut committed
675
    r"""
676
    This is a generic configuration class that will be instantiated as one of the configuration classes of the library
677
    when created with the [`~AutoConfig.from_pretrained`] class method.
678

679
    This class cannot be instantiated directly using `__init__()` (throws an error).
680
    """
681

682
    def __init__(self):
683
684
685
686
        raise EnvironmentError(
            "AutoConfig is designed to be instantiated "
            "using the `AutoConfig.from_pretrained(pretrained_model_name_or_path)` method."
        )
687

688
    @classmethod
689
690
691
692
    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)
693
        raise ValueError(
694
            f"Unrecognized model identifier: {model_type}. Should contain one of {', '.join(CONFIG_MAPPING.keys())}"
695
        )
696

697
    @classmethod
698
    @replace_list_option_in_docstrings()
699
    def from_pretrained(cls, pretrained_model_name_or_path, **kwargs):
700
701
        r"""
        Instantiate one of the configuration classes of the library from a pretrained model configuration.
702

Sylvain Gugger's avatar
Sylvain Gugger committed
703
704
        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`:
705

706
        List options
Lysandre Debut's avatar
Lysandre Debut committed
707
708

        Args:
709
            pretrained_model_name_or_path (`str` or `os.PathLike`):
710
711
                Can be either:

712
713
714
715
                    - 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
716
717
                      [`~PretrainedConfig.save_pretrained`] method, or the [`~PreTrainedModel.save_pretrained`] method,
                      e.g., `./my_model_directory/`.
718
719
720
                    - A path or url to a saved configuration JSON *file*, e.g.,
                      `./my_model_directory/configuration.json`.
            cache_dir (`str` or `os.PathLike`, *optional*):
721
722
                Path to a directory in which a downloaded pretrained model configuration should be cached if the
                standard cache should not be used.
723
            force_download (`bool`, *optional*, defaults to `False`):
724
725
                Whether or not to force the (re-)download the model weights and configuration files and override the
                cached versions if they exist.
726
            resume_download (`bool`, *optional*, defaults to `False`):
727
728
                Whether or not to delete incompletely received files. Will attempt to resume the download if such a
                file exists.
729
            proxies (`Dict[str, str]`, *optional*):
Sylvain Gugger's avatar
Sylvain Gugger committed
730
731
                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.
732
            revision (`str`, *optional*, defaults to `"main"`):
Julien Chaumond's avatar
Julien Chaumond committed
733
                The specific model version to use. It can be a branch name, a tag name, or a commit id, since we use a
734
                git-based system for storing models and other artifacts on huggingface.co, so `revision` can be any
Julien Chaumond's avatar
Julien Chaumond committed
735
                identifier allowed by git.
736
737
            return_unused_kwargs (`bool`, *optional*, defaults to `False`):
                If `False`, then this function returns just the final configuration object.
738

Sylvain Gugger's avatar
Sylvain Gugger committed
739
740
741
                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.
742
            trust_remote_code (`bool`, *optional*, defaults to `False`):
743
                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
744
745
                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.
746
            kwargs(additional keyword arguments, *optional*):
747
                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
748
                values. Behavior concerning key/value pairs whose keys are *not* configuration attributes is controlled
749
                by the `return_unused_kwargs` keyword parameter.
Lysandre Debut's avatar
Lysandre Debut committed
750

751
        Examples:
752

753
754
        ```python
        >>> from transformers import AutoConfig
755

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

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

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

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

768
        >>> # Change some config attributes when loading a pretrained config.
Sylvain Gugger's avatar
Sylvain Gugger committed
769
        >>> config = AutoConfig.from_pretrained("bert-base-uncased", output_attentions=True, foo=False)
770
771
        >>> config.output_attentions
        True
Sylvain Gugger's avatar
Sylvain Gugger committed
772
773
774
775

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

779
        >>> unused_kwargs
780
781
        {'foo': False}
        ```"""
782
        kwargs["_from_auto"] = True
783
784
        kwargs["name_or_path"] = pretrained_model_name_or_path
        trust_remote_code = kwargs.pop("trust_remote_code", False)
785
        config_dict, unused_kwargs = PretrainedConfig.get_config_dict(pretrained_model_name_or_path, **kwargs)
786
787
788
        if "auto_map" in config_dict and "AutoConfig" in config_dict["auto_map"]:
            if not trust_remote_code:
                raise ValueError(
Sylvain Gugger's avatar
Sylvain Gugger committed
789
790
791
                    f"Loading {pretrained_model_name_or_path} requires you to execute the configuration file in that"
                    " repo on your local machine. Make sure you have read the code there to avoid malicious use, then"
                    " set the option `trust_remote_code=True` to remove this error."
792
793
                )
            if kwargs.get("revision", None) is None:
794
                logger.warning(
795
796
797
798
799
800
801
802
803
804
                    "Explicitly passing a `revision` is encouraged when loading a configuration with custom code to "
                    "ensure no malicious code has been contributed in a newer revision."
                )
            class_ref = config_dict["auto_map"]["AutoConfig"]
            module_file, class_name = class_ref.split(".")
            config_class = get_class_from_dynamic_module(
                pretrained_model_name_or_path, module_file + ".py", class_name, **kwargs
            )
            return config_class.from_pretrained(pretrained_model_name_or_path, **kwargs)
        elif "model_type" in config_dict:
805
            config_class = CONFIG_MAPPING[config_dict["model_type"]]
806
            return config_class.from_dict(config_dict, **unused_kwargs)
807
808
        else:
            # Fallback: use pattern matching on the string.
809
810
            # 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):
811
                if pattern in str(pretrained_model_name_or_path):
812
                    return CONFIG_MAPPING[pattern].from_dict(config_dict, **unused_kwargs)
813

814
        raise ValueError(
815
            f"Unrecognized model in {pretrained_model_name_or_path}. "
816
            f"Should have a `model_type` key in its {CONFIG_NAME}, or contain one of the following strings "
817
            f"in its name: {', '.join(CONFIG_MAPPING.keys())}"
818
        )
819
820
821
822
823
824
825

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

        Args:
826
827
            model_type (`str`): The model type like "bert" or "gpt".
            config ([`PretrainedConfig`]): The config to register.
828
829
830
831
832
833
834
835
        """
        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)