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

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

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

460
SPECIAL_MODEL_TYPE_TO_MODULE_NAME = OrderedDict(
461
462
463
464
465
    [
        ("openai-gpt", "openai"),
        ("data2vec-audio", "data2vec"),
        ("data2vec-text", "data2vec"),
        ("data2vec-vision", "data2vec"),
NielsRogge's avatar
NielsRogge committed
466
        ("donut-swin", "donut"),
NielsRogge's avatar
NielsRogge committed
467
        ("xclip", "x_clip"),
468
    ]
469
)
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495


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
496
        self._extra_content = {}
497
498
499
        self._modules = {}

    def __getitem__(self, key):
500
501
        if key in self._extra_content:
            return self._extra_content[key]
502
503
504
505
506
507
        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")
508
509
510
511
512
513
514
        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)
515
516

    def keys(self):
517
        return list(self._mapping.keys()) + list(self._extra_content.keys())
518
519

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

522
    def items(self):
523
        return [(k, self[k]) for k in self._mapping.keys()] + list(self._extra_content.items())
524
525

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

    def __contains__(self, item):
529
530
531
532
533
534
535
536
537
        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
538
539
540
541
542
543
544
545
546
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


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


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

    return docstring_decorator


Julien Chaumond's avatar
Julien Chaumond committed
665
class AutoConfig:
Lysandre Debut's avatar
Lysandre Debut committed
666
    r"""
667
    This is a generic configuration class that will be instantiated as one of the configuration classes of the library
668
    when created with the [`~AutoConfig.from_pretrained`] class method.
669

670
    This class cannot be instantiated directly using `__init__()` (throws an error).
671
    """
672

673
    def __init__(self):
674
675
676
677
        raise EnvironmentError(
            "AutoConfig is designed to be instantiated "
            "using the `AutoConfig.from_pretrained(pretrained_model_name_or_path)` method."
        )
678

679
    @classmethod
680
681
682
683
    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)
684
        raise ValueError(
685
            f"Unrecognized model identifier: {model_type}. Should contain one of {', '.join(CONFIG_MAPPING.keys())}"
686
        )
687

688
    @classmethod
689
    @replace_list_option_in_docstrings()
690
    def from_pretrained(cls, pretrained_model_name_or_path, **kwargs):
691
692
        r"""
        Instantiate one of the configuration classes of the library from a pretrained model configuration.
693

Sylvain Gugger's avatar
Sylvain Gugger committed
694
695
        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`:
696

697
        List options
Lysandre Debut's avatar
Lysandre Debut committed
698
699

        Args:
700
            pretrained_model_name_or_path (`str` or `os.PathLike`):
701
702
                Can be either:

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

Sylvain Gugger's avatar
Sylvain Gugger committed
730
731
732
                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.
733
            trust_remote_code (`bool`, *optional*, defaults to `False`):
734
                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
735
736
                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.
737
            kwargs(additional keyword arguments, *optional*):
738
                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
739
                values. Behavior concerning key/value pairs whose keys are *not* configuration attributes is controlled
740
                by the `return_unused_kwargs` keyword parameter.
Lysandre Debut's avatar
Lysandre Debut committed
741

742
        Examples:
743

744
745
        ```python
        >>> from transformers import AutoConfig
746

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

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

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

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

759
        >>> # Change some config attributes when loading a pretrained config.
Sylvain Gugger's avatar
Sylvain Gugger committed
760
        >>> config = AutoConfig.from_pretrained("bert-base-uncased", output_attentions=True, foo=False)
761
762
        >>> config.output_attentions
        True
Sylvain Gugger's avatar
Sylvain Gugger committed
763
764
765
766

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

770
        >>> unused_kwargs
771
772
        {'foo': False}
        ```"""
773
        kwargs["_from_auto"] = True
774
775
        kwargs["name_or_path"] = pretrained_model_name_or_path
        trust_remote_code = kwargs.pop("trust_remote_code", False)
776
        config_dict, unused_kwargs = PretrainedConfig.get_config_dict(pretrained_model_name_or_path, **kwargs)
777
778
779
        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
780
781
782
                    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."
783
784
                )
            if kwargs.get("revision", None) is None:
785
                logger.warning(
786
787
788
789
790
791
792
793
794
795
                    "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:
796
            config_class = CONFIG_MAPPING[config_dict["model_type"]]
797
            return config_class.from_dict(config_dict, **unused_kwargs)
798
799
        else:
            # Fallback: use pattern matching on the string.
800
801
            # 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):
802
                if pattern in str(pretrained_model_name_or_path):
803
                    return CONFIG_MAPPING[pattern].from_dict(config_dict, **unused_kwargs)
804

805
        raise ValueError(
806
            f"Unrecognized model in {pretrained_model_name_or_path}. "
807
            f"Should have a `model_type` key in its {CONFIG_NAME}, or contain one of the following strings "
808
            f"in its name: {', '.join(CONFIG_MAPPING.keys())}"
809
        )
810
811
812
813
814
815
816

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

        Args:
817
818
            model_type (`str`): The model type like "bert" or "gpt".
            config ([`PretrainedConfig`]): The config to register.
819
820
821
822
823
824
825
826
        """
        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)