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

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

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

498
SPECIAL_MODEL_TYPE_TO_MODULE_NAME = OrderedDict(
499
500
501
502
503
    [
        ("openai-gpt", "openai"),
        ("data2vec-audio", "data2vec"),
        ("data2vec-text", "data2vec"),
        ("data2vec-vision", "data2vec"),
NielsRogge's avatar
NielsRogge committed
504
        ("donut-swin", "donut"),
505
        ("maskformer-swin", "maskformer"),
NielsRogge's avatar
NielsRogge committed
506
        ("xclip", "x_clip"),
507
    ]
508
)
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534


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
535
        self._extra_content = {}
536
537
538
        self._modules = {}

    def __getitem__(self, key):
539
540
        if key in self._extra_content:
            return self._extra_content[key]
541
542
543
544
545
546
        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")
547
548
549
550
551
552
553
        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)
554
555

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

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

561
    def items(self):
562
        return [(k, self[k]) for k in self._mapping.keys()] + list(self._extra_content.items())
563
564

    def __iter__(self):
565
        return iter(list(self._mapping.keys()) + list(self._extra_content.keys()))
566
567

    def __contains__(self, item):
568
569
570
571
572
573
574
575
576
        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
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
633
634
635
636
637
638
639
640
641


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


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

    return docstring_decorator


Julien Chaumond's avatar
Julien Chaumond committed
704
class AutoConfig:
Lysandre Debut's avatar
Lysandre Debut committed
705
    r"""
706
    This is a generic configuration class that will be instantiated as one of the configuration classes of the library
707
    when created with the [`~AutoConfig.from_pretrained`] class method.
708

709
    This class cannot be instantiated directly using `__init__()` (throws an error).
710
    """
711

712
    def __init__(self):
713
714
715
716
        raise EnvironmentError(
            "AutoConfig is designed to be instantiated "
            "using the `AutoConfig.from_pretrained(pretrained_model_name_or_path)` method."
        )
717

718
    @classmethod
719
720
721
722
    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)
723
        raise ValueError(
724
            f"Unrecognized model identifier: {model_type}. Should contain one of {', '.join(CONFIG_MAPPING.keys())}"
725
        )
726

727
    @classmethod
728
    @replace_list_option_in_docstrings()
729
    def from_pretrained(cls, pretrained_model_name_or_path, **kwargs):
730
731
        r"""
        Instantiate one of the configuration classes of the library from a pretrained model configuration.
732

Sylvain Gugger's avatar
Sylvain Gugger committed
733
734
        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`:
735

736
        List options
Lysandre Debut's avatar
Lysandre Debut committed
737
738

        Args:
739
            pretrained_model_name_or_path (`str` or `os.PathLike`):
740
741
                Can be either:

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

Sylvain Gugger's avatar
Sylvain Gugger committed
769
770
771
                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.
772
            trust_remote_code (`bool`, *optional*, defaults to `False`):
773
                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
774
775
                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.
776
            kwargs(additional keyword arguments, *optional*):
777
                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
778
                values. Behavior concerning key/value pairs whose keys are *not* configuration attributes is controlled
779
                by the `return_unused_kwargs` keyword parameter.
Lysandre Debut's avatar
Lysandre Debut committed
780

781
        Examples:
782

783
784
        ```python
        >>> from transformers import AutoConfig
785

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

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

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

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

798
        >>> # Change some config attributes when loading a pretrained config.
Sylvain Gugger's avatar
Sylvain Gugger committed
799
        >>> config = AutoConfig.from_pretrained("bert-base-uncased", output_attentions=True, foo=False)
800
801
        >>> config.output_attentions
        True
Sylvain Gugger's avatar
Sylvain Gugger committed
802
803
804
805

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

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

844
        raise ValueError(
845
            f"Unrecognized model in {pretrained_model_name_or_path}. "
846
            f"Should have a `model_type` key in its {CONFIG_NAME}, or contain one of the following strings "
847
            f"in its name: {', '.join(CONFIG_MAPPING.keys())}"
848
        )
849
850
851
852
853
854
855

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

        Args:
856
857
            model_type (`str`): The model type like "bert" or "gpt".
            config ([`PretrainedConfig`]): The config to register.
858
859
860
861
862
863
864
865
        """
        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)