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

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

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

489
SPECIAL_MODEL_TYPE_TO_MODULE_NAME = OrderedDict(
490
491
492
493
494
    [
        ("openai-gpt", "openai"),
        ("data2vec-audio", "data2vec"),
        ("data2vec-text", "data2vec"),
        ("data2vec-vision", "data2vec"),
NielsRogge's avatar
NielsRogge committed
495
        ("donut-swin", "donut"),
496
        ("maskformer-swin", "maskformer"),
NielsRogge's avatar
NielsRogge committed
497
        ("xclip", "x_clip"),
498
    ]
499
)
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525


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
526
        self._extra_content = {}
527
528
529
        self._modules = {}

    def __getitem__(self, key):
530
531
        if key in self._extra_content:
            return self._extra_content[key]
532
533
534
535
536
537
        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")
538
539
540
541
542
543
544
        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)
545
546

    def keys(self):
547
        return list(self._mapping.keys()) + list(self._extra_content.keys())
548
549

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

552
    def items(self):
553
        return [(k, self[k]) for k in self._mapping.keys()] + list(self._extra_content.items())
554
555

    def __iter__(self):
556
        return iter(list(self._mapping.keys()) + list(self._extra_content.keys()))
557
558

    def __contains__(self, item):
559
560
561
562
563
564
565
566
567
        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
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
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632


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


638
639
640
641
642
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
643
            model_type_to_name = {model_type: f"[`{config}`]" for model_type, config in CONFIG_MAPPING_NAMES.items()}
644
645
        else:
            model_type_to_name = {
646
647
648
                model_type: _get_class_name(model_class)
                for model_type, model_class in config_to_class.items()
                if model_type in MODEL_NAMES_MAPPING
649
650
            }
        lines = [
651
            f"{indent}- **{model_type}** -- {model_type_to_name[model_type]} ({MODEL_NAMES_MAPPING[model_type]} model)"
652
            for model_type in sorted(model_type_to_name.keys())
653
654
        ]
    else:
655
656
657
658
659
        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
        }
660
        config_to_model_name = {
661
            config: MODEL_NAMES_MAPPING[model_type] for model_type, config in CONFIG_MAPPING_NAMES.items()
662
663
        }
        lines = [
Sylvain Gugger's avatar
Sylvain Gugger committed
664
665
            f"{indent}- [`{config_name}`] configuration class:"
            f" {config_to_name[config_name]} ({config_to_model_name[config_name]} model)"
666
            for config_name in sorted(config_to_name.keys())
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
        ]
    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
686
687
                f"The function {fn} should have an empty 'List options' in its docstring as placeholder, current"
                f" docstring is:\n{docstrings}"
688
689
690
691
692
693
694
            )
        fn.__doc__ = docstrings
        return fn

    return docstring_decorator


Julien Chaumond's avatar
Julien Chaumond committed
695
class AutoConfig:
Lysandre Debut's avatar
Lysandre Debut committed
696
    r"""
697
    This is a generic configuration class that will be instantiated as one of the configuration classes of the library
698
    when created with the [`~AutoConfig.from_pretrained`] class method.
699

700
    This class cannot be instantiated directly using `__init__()` (throws an error).
701
    """
702

703
    def __init__(self):
704
705
706
707
        raise EnvironmentError(
            "AutoConfig is designed to be instantiated "
            "using the `AutoConfig.from_pretrained(pretrained_model_name_or_path)` method."
        )
708

709
    @classmethod
710
711
712
713
    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)
714
        raise ValueError(
715
            f"Unrecognized model identifier: {model_type}. Should contain one of {', '.join(CONFIG_MAPPING.keys())}"
716
        )
717

718
    @classmethod
719
    @replace_list_option_in_docstrings()
720
    def from_pretrained(cls, pretrained_model_name_or_path, **kwargs):
721
722
        r"""
        Instantiate one of the configuration classes of the library from a pretrained model configuration.
723

Sylvain Gugger's avatar
Sylvain Gugger committed
724
725
        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`:
726

727
        List options
Lysandre Debut's avatar
Lysandre Debut committed
728
729

        Args:
730
            pretrained_model_name_or_path (`str` or `os.PathLike`):
731
732
                Can be either:

733
734
735
736
                    - 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
737
738
                      [`~PretrainedConfig.save_pretrained`] method, or the [`~PreTrainedModel.save_pretrained`] method,
                      e.g., `./my_model_directory/`.
739
740
741
                    - A path or url to a saved configuration JSON *file*, e.g.,
                      `./my_model_directory/configuration.json`.
            cache_dir (`str` or `os.PathLike`, *optional*):
742
743
                Path to a directory in which a downloaded pretrained model configuration should be cached if the
                standard cache should not be used.
744
            force_download (`bool`, *optional*, defaults to `False`):
745
746
                Whether or not to force the (re-)download the model weights and configuration files and override the
                cached versions if they exist.
747
            resume_download (`bool`, *optional*, defaults to `False`):
748
749
                Whether or not to delete incompletely received files. Will attempt to resume the download if such a
                file exists.
750
            proxies (`Dict[str, str]`, *optional*):
Sylvain Gugger's avatar
Sylvain Gugger committed
751
752
                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.
753
            revision (`str`, *optional*, defaults to `"main"`):
Julien Chaumond's avatar
Julien Chaumond committed
754
                The specific model version to use. It can be a branch name, a tag name, or a commit id, since we use a
755
                git-based system for storing models and other artifacts on huggingface.co, so `revision` can be any
Julien Chaumond's avatar
Julien Chaumond committed
756
                identifier allowed by git.
757
758
            return_unused_kwargs (`bool`, *optional*, defaults to `False`):
                If `False`, then this function returns just the final configuration object.
759

Sylvain Gugger's avatar
Sylvain Gugger committed
760
761
762
                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.
763
            trust_remote_code (`bool`, *optional*, defaults to `False`):
764
                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
765
766
                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.
767
            kwargs(additional keyword arguments, *optional*):
768
                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
769
                values. Behavior concerning key/value pairs whose keys are *not* configuration attributes is controlled
770
                by the `return_unused_kwargs` keyword parameter.
Lysandre Debut's avatar
Lysandre Debut committed
771

772
        Examples:
773

774
775
        ```python
        >>> from transformers import AutoConfig
776

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

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

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

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

789
        >>> # Change some config attributes when loading a pretrained config.
Sylvain Gugger's avatar
Sylvain Gugger committed
790
        >>> config = AutoConfig.from_pretrained("bert-base-uncased", output_attentions=True, foo=False)
791
792
        >>> config.output_attentions
        True
Sylvain Gugger's avatar
Sylvain Gugger committed
793
794
795
796

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

800
        >>> unused_kwargs
801
802
        {'foo': False}
        ```"""
803
        kwargs["_from_auto"] = True
804
805
        kwargs["name_or_path"] = pretrained_model_name_or_path
        trust_remote_code = kwargs.pop("trust_remote_code", False)
806
        config_dict, unused_kwargs = PretrainedConfig.get_config_dict(pretrained_model_name_or_path, **kwargs)
807
808
809
        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
810
811
812
                    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."
813
814
                )
            if kwargs.get("revision", None) is None:
815
                logger.warning(
816
817
818
819
820
821
822
823
824
825
                    "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:
826
            config_class = CONFIG_MAPPING[config_dict["model_type"]]
827
            return config_class.from_dict(config_dict, **unused_kwargs)
828
829
        else:
            # Fallback: use pattern matching on the string.
830
831
            # 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):
832
                if pattern in str(pretrained_model_name_or_path):
833
                    return CONFIG_MAPPING[pattern].from_dict(config_dict, **unused_kwargs)
834

835
        raise ValueError(
836
            f"Unrecognized model in {pretrained_model_name_or_path}. "
837
            f"Should have a `model_type` key in its {CONFIG_NAME}, or contain one of the following strings "
838
            f"in its name: {', '.join(CONFIG_MAPPING.keys())}"
839
        )
840
841
842
843
844
845
846

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

        Args:
847
848
            model_type (`str`): The model type like "bert" or "gpt".
            config ([`PretrainedConfig`]): The config to register.
849
850
851
852
853
854
855
856
        """
        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)