check_repo.py 33 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
# coding=utf-8
# Copyright 2020 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.

16
17
18
19
import importlib
import inspect
import os
import re
20
import warnings
21
from collections import OrderedDict
22
from difflib import get_close_matches
23
from pathlib import Path
24

25
from transformers import is_flax_available, is_tf_available, is_torch_available
26
from transformers.models.auto import get_values
27
from transformers.utils import ENV_VARS_TRUE_VALUES
28

29
30
31
32
33

# All paths are set with the intent you should run this script from the root of the repo with the command
# python utils/check_repo.py
PATH_TO_TRANSFORMERS = "src/transformers"
PATH_TO_TESTS = "tests"
34
PATH_TO_DOC = "docs/source/en"
35

36
37
38
# Update this list with models that are supposed to be private.
PRIVATE_MODELS = [
    "DPRSpanPredictor",
Daniel Stancl's avatar
Daniel Stancl committed
39
    "LongT5Stack",
Li-Huai (Allan) Lin's avatar
Li-Huai (Allan) Lin committed
40
    "RealmBertModel",
41
    "T5Stack",
42
    "SwitchTransformersStack",
43
44
45
    "TFDPRSpanPredictor",
]

46
47
# Update this list for models that are not tested with a comment explaining the reason it should not be.
# Being in this list is an exception and should **not** be the rule.
48
IGNORE_NON_TESTED = PRIVATE_MODELS.copy() + [
49
    # models to ignore for not tested
50
    "ResNetBackbone",  # Backbones have their own tests.
NielsRogge's avatar
NielsRogge committed
51
    "CLIPSegDecoder",  # Building part of bigger (tested) model.
52
53
    "TableTransformerEncoder",  # Building part of bigger (tested) model.
    "TableTransformerDecoder",  # Building part of bigger (tested) model.
54
55
    "TimeSeriesTransformerEncoder",  # Building part of bigger (tested) model.
    "TimeSeriesTransformerDecoder",  # Building part of bigger (tested) model.
56
57
    "JukeboxVQVAE",  # Building part of bigger (tested) model.
    "JukeboxPrior",  # Building part of bigger (tested) model.
NielsRogge's avatar
NielsRogge committed
58
59
    "DeformableDetrEncoder",  # Building part of bigger (tested) model.
    "DeformableDetrDecoder",  # Building part of bigger (tested) model.
Younes Belkada's avatar
Younes Belkada committed
60
    "OPTDecoder",  # Building part of bigger (tested) model.
61
62
    "WhisperDecoder",  # Building part of bigger (tested) model.
    "WhisperEncoder",  # Building part of bigger (tested) model.
63
    "DecisionTransformerGPT2Model",  # Building part of bigger (tested) model.
NielsRogge's avatar
NielsRogge committed
64
    "SegformerDecodeHead",  # Building part of bigger (tested) model.
Gunjan Chhablani's avatar
Gunjan Chhablani committed
65
66
67
    "PLBartEncoder",  # Building part of bigger (tested) model.
    "PLBartDecoder",  # Building part of bigger (tested) model.
    "PLBartDecoderWrapper",  # Building part of bigger (tested) model.
Vasudev Gupta's avatar
Vasudev Gupta committed
68
69
70
    "BigBirdPegasusEncoder",  # Building part of bigger (tested) model.
    "BigBirdPegasusDecoder",  # Building part of bigger (tested) model.
    "BigBirdPegasusDecoderWrapper",  # Building part of bigger (tested) model.
NielsRogge's avatar
NielsRogge committed
71
72
73
    "DetrEncoder",  # Building part of bigger (tested) model.
    "DetrDecoder",  # Building part of bigger (tested) model.
    "DetrDecoderWrapper",  # Building part of bigger (tested) model.
74
75
    "ConditionalDetrEncoder",  # Building part of bigger (tested) model.
    "ConditionalDetrDecoder",  # Building part of bigger (tested) model.
Suraj Patil's avatar
Suraj Patil committed
76
77
    "M2M100Encoder",  # Building part of bigger (tested) model.
    "M2M100Decoder",  # Building part of bigger (tested) model.
Chan Woo Kim's avatar
Chan Woo Kim committed
78
    "MCTCTEncoder",  # Building part of bigger (tested) model.
Suraj Patil's avatar
Suraj Patil committed
79
80
    "Speech2TextEncoder",  # Building part of bigger (tested) model.
    "Speech2TextDecoder",  # Building part of bigger (tested) model.
Patrick von Platen's avatar
Patrick von Platen committed
81
82
    "LEDEncoder",  # Building part of bigger (tested) model.
    "LEDDecoder",  # Building part of bigger (tested) model.
83
    "BartDecoderWrapper",  # Building part of bigger (tested) model.
84
    "BartEncoder",  # Building part of bigger (tested) model.
85
    "BertLMHeadModel",  # Needs to be setup as decoder.
86
    "BlenderbotSmallEncoder",  # Building part of bigger (tested) model.
87
    "BlenderbotSmallDecoderWrapper",  # Building part of bigger (tested) model.
88
    "BlenderbotEncoder",  # Building part of bigger (tested) model.
89
    "BlenderbotDecoderWrapper",  # Building part of bigger (tested) model.
90
    "MBartEncoder",  # Building part of bigger (tested) model.
91
    "MBartDecoderWrapper",  # Building part of bigger (tested) model.
92
93
94
95
    "MegatronBertLMHeadModel",  # Building part of bigger (tested) model.
    "MegatronBertEncoder",  # Building part of bigger (tested) model.
    "MegatronBertDecoder",  # Building part of bigger (tested) model.
    "MegatronBertDecoderWrapper",  # Building part of bigger (tested) model.
StevenTang1998's avatar
StevenTang1998 committed
96
97
    "MvpDecoderWrapper",  # Building part of bigger (tested) model.
    "MvpEncoder",  # Building part of bigger (tested) model.
98
    "PegasusEncoder",  # Building part of bigger (tested) model.
99
    "PegasusDecoderWrapper",  # Building part of bigger (tested) model.
Jason Phang's avatar
Jason Phang committed
100
101
102
    "PegasusXEncoder",  # Building part of bigger (tested) model.
    "PegasusXDecoder",  # Building part of bigger (tested) model.
    "PegasusXDecoderWrapper",  # Building part of bigger (tested) model.
103
    "DPREncoder",  # Building part of bigger (tested) model.
104
    "ProphetNetDecoderWrapper",  # Building part of bigger (tested) model.
Li-Huai (Allan) Lin's avatar
Li-Huai (Allan) Lin committed
105
106
107
108
    "RealmBertModel",  # Building part of bigger (tested) model.
    "RealmReader",  # Not regular model.
    "RealmScorer",  # Not regular model.
    "RealmForOpenQA",  # Not regular model.
109
    "ReformerForMaskedLM",  # Needs to be setup as decoder.
110
    "Speech2Text2DecoderWrapper",  # Building part of bigger (tested) model.
Ratthachat (Jung)'s avatar
Ratthachat (Jung) committed
111
    "TFDPREncoder",  # Building part of bigger (tested) model.
112
113
    "TFElectraMainLayer",  # Building part of bigger (tested) model (should it be a TFPreTrainedModel ?)
    "TFRobertaForMultipleChoice",  # TODO: fix
114
    "TrOCRDecoderWrapper",  # Building part of bigger (tested) model.
amyeroberts's avatar
amyeroberts committed
115
116
    "TFWhisperEncoder",  # Building part of bigger (tested) model.
    "TFWhisperDecoder",  # Building part of bigger (tested) model.
abhishek thakur's avatar
abhishek thakur committed
117
    "SeparableConv1D",  # Building part of bigger (tested) model.
118
    "FlaxBartForCausalLM",  # Building part of bigger (tested) model.
119
    "FlaxBertForCausalLM",  # Building part of bigger (tested) model. Tested implicitly through FlaxRobertaForCausalLM.
Younes Belkada's avatar
Younes Belkada committed
120
    "OPTDecoderWrapper",
121
    "TFSegformerDecodeHead",  # Not a regular model.
122
123
124
125
126
]

# Update this list with test files that don't have a tester with a `all_model_classes` variable and which don't
# trigger the common tests.
TEST_FILES_WITH_NO_COMMON_TESTS = [
Yih-Dar's avatar
Yih-Dar committed
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
    "models/decision_transformer/test_modeling_decision_transformer.py",
    "models/camembert/test_modeling_camembert.py",
    "models/mt5/test_modeling_flax_mt5.py",
    "models/mbart/test_modeling_mbart.py",
    "models/mt5/test_modeling_mt5.py",
    "models/pegasus/test_modeling_pegasus.py",
    "models/camembert/test_modeling_tf_camembert.py",
    "models/mt5/test_modeling_tf_mt5.py",
    "models/xlm_roberta/test_modeling_tf_xlm_roberta.py",
    "models/xlm_roberta/test_modeling_flax_xlm_roberta.py",
    "models/xlm_prophetnet/test_modeling_xlm_prophetnet.py",
    "models/xlm_roberta/test_modeling_xlm_roberta.py",
    "models/vision_text_dual_encoder/test_modeling_vision_text_dual_encoder.py",
    "models/vision_text_dual_encoder/test_modeling_flax_vision_text_dual_encoder.py",
    "models/decision_transformer/test_modeling_decision_transformer.py",
142
143
]

144
145
# Update this list for models that are not in any of the auto MODEL_XXX_MAPPING. Being in this list is an exception and
# should **not** be the rule.
146
IGNORE_NON_AUTO_CONFIGURED = PRIVATE_MODELS.copy() + [
147
    # models to ignore for model xxx mapping
NielsRogge's avatar
NielsRogge committed
148
149
150
    "CLIPSegForImageSegmentation",
    "CLIPSegVisionModel",
    "CLIPSegTextModel",
Matt's avatar
Matt committed
151
    "EsmForProteinFolding",
152
    "TimeSeriesTransformerForPrediction",
153
154
    "JukeboxVQVAE",
    "JukeboxPrior",
Jason Phang's avatar
Jason Phang committed
155
156
157
158
159
160
    "PegasusXEncoder",
    "PegasusXDecoder",
    "PegasusXDecoderWrapper",
    "PegasusXEncoder",
    "PegasusXDecoder",
    "PegasusXDecoderWrapper",
NielsRogge's avatar
NielsRogge committed
161
    "DPTForDepthEstimation",
162
    "DecisionTransformerGPT2Model",
NielsRogge's avatar
NielsRogge committed
163
    "GLPNForDepthEstimation",
NielsRogge's avatar
NielsRogge committed
164
165
    "ViltForImagesAndTextClassification",
    "ViltForImageAndTextRetrieval",
166
    "ViltForTokenClassification",
NielsRogge's avatar
NielsRogge committed
167
    "ViltForMaskedLM",
Suraj Patil's avatar
Suraj Patil committed
168
169
170
    "XGLMEncoder",
    "XGLMDecoder",
    "XGLMDecoderWrapper",
NielsRogge's avatar
NielsRogge committed
171
172
    "PerceiverForMultimodalAutoencoding",
    "PerceiverForOpticalFlow",
NielsRogge's avatar
NielsRogge committed
173
    "SegformerDecodeHead",
174
    "TFSegformerDecodeHead",
Kamal Raj's avatar
Kamal Raj committed
175
    "FlaxBeitForMaskedImageModeling",
Gunjan Chhablani's avatar
Gunjan Chhablani committed
176
177
178
    "PLBartEncoder",
    "PLBartDecoder",
    "PLBartDecoderWrapper",
NielsRogge's avatar
NielsRogge committed
179
    "BeitForMaskedImageModeling",
Suraj Patil's avatar
Suraj Patil committed
180
    "CLIPTextModel",
181
    "CLIPTextModelWithProjection",
Suraj Patil's avatar
Suraj Patil committed
182
    "CLIPVisionModel",
183
    "CLIPVisionModelWithProjection",
184
185
    "GroupViTTextModel",
    "GroupViTVisionModel",
Yih-Dar's avatar
Yih-Dar committed
186
187
    "TFCLIPTextModel",
    "TFCLIPVisionModel",
188
189
    "TFGroupViTTextModel",
    "TFGroupViTVisionModel",
Suraj Patil's avatar
Suraj Patil committed
190
191
    "FlaxCLIPTextModel",
    "FlaxCLIPVisionModel",
192
    "FlaxWav2Vec2ForCTC",
NielsRogge's avatar
NielsRogge committed
193
    "DetrForSegmentation",
194
    "ConditionalDetrForSegmentation",
195
196
    "DPRReader",
    "FlaubertForQuestionAnswering",
197
198
199
200
    "FlavaImageCodebook",
    "FlavaTextModel",
    "FlavaImageModel",
    "FlavaMultimodalModel",
201
    "GPT2DoubleHeadsModel",
202
    "LayoutLMForQuestionAnswering",
Ryokan RI's avatar
Ryokan RI committed
203
    "LukeForMaskedLM",
NielsRogge's avatar
NielsRogge committed
204
205
206
    "LukeForEntityClassification",
    "LukeForEntityPairClassification",
    "LukeForEntitySpanClassification",
207
    "OpenAIGPTDoubleHeadsModel",
208
209
210
    "OwlViTTextModel",
    "OwlViTVisionModel",
    "OwlViTForObjectDetection",
211
212
213
    "RagModel",
    "RagSequenceForGeneration",
    "RagTokenForGeneration",
Li-Huai (Allan) Lin's avatar
Li-Huai (Allan) Lin committed
214
215
216
217
    "RealmEmbedder",
    "RealmForOpenQA",
    "RealmScorer",
    "RealmReader",
Ratthachat (Jung)'s avatar
Ratthachat (Jung) committed
218
    "TFDPRReader",
219
    "TFGPT2DoubleHeadsModel",
220
    "TFLayoutLMForQuestionAnswering",
221
    "TFOpenAIGPTDoubleHeadsModel",
Ratthachat (Jung)'s avatar
Ratthachat (Jung) committed
222
223
224
    "TFRagModel",
    "TFRagSequenceForGeneration",
    "TFRagTokenForGeneration",
225
    "Wav2Vec2ForCTC",
Patrick von Platen's avatar
Patrick von Platen committed
226
    "HubertForCTC",
227
228
    "SEWForCTC",
    "SEWDForCTC",
229
230
    "XLMForQuestionAnswering",
    "XLNetForQuestionAnswering",
abhishek thakur's avatar
abhishek thakur committed
231
    "SeparableConv1D",
Gunjan Chhablani's avatar
Gunjan Chhablani committed
232
233
234
235
    "VisualBertForRegionToPhraseAlignment",
    "VisualBertForVisualReasoning",
    "VisualBertForQuestionAnswering",
    "VisualBertForMultipleChoice",
Will Rice's avatar
Will Rice committed
236
    "TFWav2Vec2ForCTC",
Will Rice's avatar
Will Rice committed
237
    "TFHubertForCTC",
238
    "MaskFormerForInstanceSegmentation",
NielsRogge's avatar
NielsRogge committed
239
240
    "XCLIPVisionModel",
    "XCLIPTextModel",
241
242
]

243
244
245
246
247
248
# Update this list for models that have multiple model types for the same
# model doc
MODEL_TYPE_TO_DOC_MAPPING = OrderedDict(
    [
        ("data2vec-text", "data2vec"),
        ("data2vec-audio", "data2vec"),
249
        ("data2vec-vision", "data2vec"),
NielsRogge's avatar
NielsRogge committed
250
        ("donut-swin", "donut"),
251
252
253
254
    ]
)


255
256
257
258
259
260
261
262
263
# This is to make sure the transformers module imported is the one in the repo.
spec = importlib.util.spec_from_file_location(
    "transformers",
    os.path.join(PATH_TO_TRANSFORMERS, "__init__.py"),
    submodule_search_locations=[PATH_TO_TRANSFORMERS],
)
transformers = spec.loader.load_module()


264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
def check_model_list():
    """Check the model list inside the transformers library."""
    # Get the models from the directory structure of `src/transformers/models/`
    models_dir = os.path.join(PATH_TO_TRANSFORMERS, "models")
    _models = []
    for model in os.listdir(models_dir):
        model_dir = os.path.join(models_dir, model)
        if os.path.isdir(model_dir) and "__init__.py" in os.listdir(model_dir):
            _models.append(model)

    # Get the models from the directory structure of `src/transformers/models/`
    models = [model for model in dir(transformers.models) if not model.startswith("__")]

    missing_models = sorted(list(set(_models).difference(models)))
    if missing_models:
        raise Exception(
            f"The following models should be included in {models_dir}/__init__.py: {','.join(missing_models)}."
        )


284
285
286
# If some modeling modules should be ignored for all checks, they should be added in the nested list
# _ignore_modules of this function.
def get_model_modules():
Patrick von Platen's avatar
Patrick von Platen committed
287
    """Get the model modules inside the transformers library."""
288
289
290
291
292
293
294
295
    _ignore_modules = [
        "modeling_auto",
        "modeling_encoder_decoder",
        "modeling_marian",
        "modeling_mmbt",
        "modeling_outputs",
        "modeling_retribert",
        "modeling_utils",
Sylvain Gugger's avatar
Sylvain Gugger committed
296
        "modeling_flax_auto",
297
        "modeling_flax_encoder_decoder",
Stas Bekman's avatar
Stas Bekman committed
298
        "modeling_flax_utils",
299
        "modeling_speech_encoder_decoder",
300
        "modeling_flax_speech_encoder_decoder",
301
        "modeling_flax_vision_encoder_decoder",
302
303
        "modeling_transfo_xl_utilities",
        "modeling_tf_auto",
304
        "modeling_tf_encoder_decoder",
305
306
307
308
        "modeling_tf_outputs",
        "modeling_tf_pytorch_utils",
        "modeling_tf_utils",
        "modeling_tf_transfo_xl_utilities",
309
        "modeling_tf_vision_encoder_decoder",
310
        "modeling_vision_encoder_decoder",
311
312
    ]
    modules = []
Sylvain Gugger's avatar
Sylvain Gugger committed
313
314
315
316
317
318
319
320
321
    for model in dir(transformers.models):
        # There are some magic dunder attributes in the dir, we ignore them
        if not model.startswith("__"):
            model_module = getattr(transformers.models, model)
            for submodule in dir(model_module):
                if submodule.startswith("modeling") and submodule not in _ignore_modules:
                    modeling_module = getattr(model_module, submodule)
                    if inspect.ismodule(modeling_module):
                        modules.append(modeling_module)
322
323
324
    return modules


325
def get_models(module, include_pretrained=False):
Patrick von Platen's avatar
Patrick von Platen committed
326
    """Get the objects in module that are models."""
327
    models = []
328
    model_classes = (transformers.PreTrainedModel, transformers.TFPreTrainedModel, transformers.FlaxPreTrainedModel)
329
    for attr_name in dir(module):
330
        if not include_pretrained and ("Pretrained" in attr_name or "PreTrained" in attr_name):
331
332
333
334
335
336
337
            continue
        attr = getattr(module, attr_name)
        if isinstance(attr, type) and issubclass(attr, model_classes) and attr.__module__ == module.__name__:
            models.append((attr_name, attr))
    return models


338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
def is_a_private_model(model):
    """Returns True if the model should not be in the main init."""
    if model in PRIVATE_MODELS:
        return True

    # Wrapper, Encoder and Decoder are all privates
    if model.endswith("Wrapper"):
        return True
    if model.endswith("Encoder"):
        return True
    if model.endswith("Decoder"):
        return True
    return False


def check_models_are_in_init():
    """Checks all models defined in the library are in the main init."""
    models_not_in_init = []
    dir_transformers = dir(transformers)
    for module in get_model_modules():
        models_not_in_init += [
            model[0] for model in get_models(module, include_pretrained=True) if model[0] not in dir_transformers
        ]

    # Remove private models
    models_not_in_init = [model for model in models_not_in_init if not is_a_private_model(model)]
    if len(models_not_in_init) > 0:
        raise Exception(f"The following models should be in the main init: {','.join(models_not_in_init)}.")


368
369
370
# If some test_modeling files should be ignored when checking models are all tested, they should be added in the
# nested list _ignore_files of this function.
def get_model_test_files():
Yih-Dar's avatar
Yih-Dar committed
371
372
373
374
375
376
    """Get the model test files.

    The returned files should NOT contain the `tests` (i.e. `PATH_TO_TESTS` defined in this script). They will be
    considered as paths relative to `tests`. A caller has to use `os.path.join(PATH_TO_TESTS, ...)` to access the files.
    """

377
378
379
    _ignore_files = [
        "test_modeling_common",
        "test_modeling_encoder_decoder",
380
        "test_modeling_flax_encoder_decoder",
381
        "test_modeling_flax_speech_encoder_decoder",
382
383
        "test_modeling_marian",
        "test_modeling_tf_common",
384
        "test_modeling_tf_encoder_decoder",
385
386
    ]
    test_files = []
Yih-Dar's avatar
Yih-Dar committed
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
    # Check both `PATH_TO_TESTS` and `PATH_TO_TESTS/models`
    model_test_root = os.path.join(PATH_TO_TESTS, "models")
    model_test_dirs = []
    for x in os.listdir(model_test_root):
        x = os.path.join(model_test_root, x)
        if os.path.isdir(x):
            model_test_dirs.append(x)

    for target_dir in [PATH_TO_TESTS] + model_test_dirs:
        for file_or_dir in os.listdir(target_dir):
            path = os.path.join(target_dir, file_or_dir)
            if os.path.isfile(path):
                filename = os.path.split(path)[-1]
                if "test_modeling" in filename and not os.path.splitext(filename)[0] in _ignore_files:
                    file = os.path.join(*path.split(os.sep)[1:])
                    test_files.append(file)

404
405
406
407
408
409
    return test_files


# This is a bit hacky but I didn't find a way to import the test_file as a module and read inside the tester class
# for the all_model_classes variable.
def find_tested_models(test_file):
Patrick von Platen's avatar
Patrick von Platen committed
410
    """Parse the content of test_file to detect what's in all_model_classes"""
Sylvain Gugger's avatar
Sylvain Gugger committed
411
    # This is a bit hacky but I didn't find a way to import the test_file as a module and read inside the class
412
    with open(os.path.join(PATH_TO_TESTS, test_file), "r", encoding="utf-8", newline="\n") as f:
413
        content = f.read()
Sylvain Gugger's avatar
Sylvain Gugger committed
414
    all_models = re.findall(r"all_model_classes\s+=\s+\(\s*\(([^\)]*)\)", content)
415
416
    # Check with one less parenthesis as well
    all_models += re.findall(r"all_model_classes\s+=\s+\(([^\)]*)\)", content)
Sylvain Gugger's avatar
Sylvain Gugger committed
417
    if len(all_models) > 0:
418
        model_tested = []
Sylvain Gugger's avatar
Sylvain Gugger committed
419
420
421
422
423
        for entry in all_models:
            for line in entry.split(","):
                name = line.strip()
                if len(name) > 0:
                    model_tested.append(name)
424
425
426
427
        return model_tested


def check_models_are_tested(module, test_file):
Patrick von Platen's avatar
Patrick von Platen committed
428
    """Check models defined in module are tested in test_file."""
429
    # XxxPreTrainedModel are not tested
430
431
432
    defined_models = get_models(module)
    tested_models = find_tested_models(test_file)
    if tested_models is None:
433
        if test_file.replace(os.path.sep, "/") in TEST_FILES_WITH_NO_COMMON_TESTS:
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
            return
        return [
            f"{test_file} should define `all_model_classes` to apply common tests to the models it tests. "
            + "If this intentional, add the test filename to `TEST_FILES_WITH_NO_COMMON_TESTS` in the file "
            + "`utils/check_repo.py`."
        ]
    failures = []
    for model_name, _ in defined_models:
        if model_name not in tested_models and model_name not in IGNORE_NON_TESTED:
            failures.append(
                f"{model_name} is defined in {module.__name__} but is not tested in "
                + f"{os.path.join(PATH_TO_TESTS, test_file)}. Add it to the all_model_classes in that file."
                + "If common tests should not applied to that model, add its name to `IGNORE_NON_TESTED`"
                + "in the file `utils/check_repo.py`."
            )
    return failures


def check_all_models_are_tested():
Patrick von Platen's avatar
Patrick von Platen committed
453
    """Check all models are properly tested."""
454
455
456
457
    modules = get_model_modules()
    test_files = get_model_test_files()
    failures = []
    for module in modules:
458
459
        test_file = [file for file in test_files if f"test_{module.__name__.split('.')[-1]}.py" in file]
        if len(test_file) == 0:
460
            failures.append(f"{module.__name__} does not have its corresponding test file {test_file}.")
461
462
463
464
        elif len(test_file) > 1:
            failures.append(f"{module.__name__} has several test files: {test_file}.")
        else:
            test_file = test_file[0]
465
466
467
            new_failures = check_models_are_tested(module, test_file)
            if new_failures is not None:
                failures += new_failures
468
469
470
471
    if len(failures) > 0:
        raise Exception(f"There were {len(failures)} failures:\n" + "\n".join(failures))


472
def get_all_auto_configured_models():
Patrick von Platen's avatar
Patrick von Platen committed
473
    """Return the list of all models in at least one auto class."""
474
    result = set()  # To avoid duplicates we concatenate all model classes in a set.
475
476
    if is_torch_available():
        for attr_name in dir(transformers.models.auto.modeling_auto):
477
            if attr_name.startswith("MODEL_") and attr_name.endswith("MAPPING_NAMES"):
478
479
480
                result = result | set(get_values(getattr(transformers.models.auto.modeling_auto, attr_name)))
    if is_tf_available():
        for attr_name in dir(transformers.models.auto.modeling_tf_auto):
481
            if attr_name.startswith("TF_MODEL_") and attr_name.endswith("MAPPING_NAMES"):
482
483
484
                result = result | set(get_values(getattr(transformers.models.auto.modeling_tf_auto, attr_name)))
    if is_flax_available():
        for attr_name in dir(transformers.models.auto.modeling_flax_auto):
485
            if attr_name.startswith("FLAX_MODEL_") and attr_name.endswith("MAPPING_NAMES"):
486
                result = result | set(get_values(getattr(transformers.models.auto.modeling_flax_auto, attr_name)))
487
    return [cls for cls in result]
488
489


490
491
492
493
494
495
496
497
498
499
500
def ignore_unautoclassed(model_name):
    """Rules to determine if `name` should be in an auto class."""
    # Special white list
    if model_name in IGNORE_NON_AUTO_CONFIGURED:
        return True
    # Encoder and Decoder should be ignored
    if "Encoder" in model_name or "Decoder" in model_name:
        return True
    return False


501
def check_models_are_auto_configured(module, all_auto_models):
Patrick von Platen's avatar
Patrick von Platen committed
502
    """Check models defined in module are each in an auto class."""
503
504
505
    defined_models = get_models(module)
    failures = []
    for model_name, _ in defined_models:
506
        if model_name not in all_auto_models and not ignore_unautoclassed(model_name):
507
508
509
510
511
512
513
514
515
            failures.append(
                f"{model_name} is defined in {module.__name__} but is not present in any of the auto mapping. "
                "If that is intended behavior, add its name to `IGNORE_NON_AUTO_CONFIGURED` in the file "
                "`utils/check_repo.py`."
            )
    return failures


def check_all_models_are_auto_configured():
Patrick von Platen's avatar
Patrick von Platen committed
516
    """Check all models are each in an auto class."""
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
    missing_backends = []
    if not is_torch_available():
        missing_backends.append("PyTorch")
    if not is_tf_available():
        missing_backends.append("TensorFlow")
    if not is_flax_available():
        missing_backends.append("Flax")
    if len(missing_backends) > 0:
        missing = ", ".join(missing_backends)
        if os.getenv("TRANSFORMERS_IS_CI", "").upper() in ENV_VARS_TRUE_VALUES:
            raise Exception(
                "Full quality checks require all backends to be installed (with `pip install -e .[dev]` in the "
                f"Transformers repo, the following are missing: {missing}."
            )
        else:
            warnings.warn(
                "Full quality checks require all backends to be installed (with `pip install -e .[dev]` in the "
                f"Transformers repo, the following are missing: {missing}. While it's probably fine as long as you "
                "didn't make any change in one of those backends modeling files, you should probably execute the "
                "command above to be on the safe side."
            )
538
539
540
541
542
543
544
545
546
547
548
    modules = get_model_modules()
    all_auto_models = get_all_auto_configured_models()
    failures = []
    for module in modules:
        new_failures = check_models_are_auto_configured(module, all_auto_models)
        if new_failures is not None:
            failures += new_failures
    if len(failures) > 0:
        raise Exception(f"There were {len(failures)} failures:\n" + "\n".join(failures))


Sylvain Gugger's avatar
Sylvain Gugger committed
549
550
551
552
_re_decorator = re.compile(r"^\s*@(\S+)\s+$")


def check_decorator_order(filename):
Patrick von Platen's avatar
Patrick von Platen committed
553
    """Check that in the test file `filename` the slow decorator is always last."""
554
    with open(filename, "r", encoding="utf-8", newline="\n") as f:
Sylvain Gugger's avatar
Sylvain Gugger committed
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
        lines = f.readlines()
    decorator_before = None
    errors = []
    for i, line in enumerate(lines):
        search = _re_decorator.search(line)
        if search is not None:
            decorator_name = search.groups()[0]
            if decorator_before is not None and decorator_name.startswith("parameterized"):
                errors.append(i)
            decorator_before = decorator_name
        elif decorator_before is not None:
            decorator_before = None
    return errors


def check_all_decorator_order():
Patrick von Platen's avatar
Patrick von Platen committed
571
    """Check that in all test files, the slow decorator is always last."""
Sylvain Gugger's avatar
Sylvain Gugger committed
572
573
574
575
576
577
578
579
580
    errors = []
    for fname in os.listdir(PATH_TO_TESTS):
        if fname.endswith(".py"):
            filename = os.path.join(PATH_TO_TESTS, fname)
            new_errors = check_decorator_order(filename)
            errors += [f"- {filename}, line {i}" for i in new_errors]
    if len(errors) > 0:
        msg = "\n".join(errors)
        raise ValueError(
Sylvain Gugger's avatar
Sylvain Gugger committed
581
582
            "The parameterized decorator (and its variants) should always be first, but this is not the case in the"
            f" following files:\n{msg}"
Sylvain Gugger's avatar
Sylvain Gugger committed
583
584
585
        )


586
def find_all_documented_objects():
Patrick von Platen's avatar
Patrick von Platen committed
587
    """Parse the content of all doc files to detect which classes and functions it documents"""
588
589
    documented_obj = []
    for doc_file in Path(PATH_TO_DOC).glob("**/*.rst"):
Julien Plu's avatar
Julien Plu committed
590
        with open(doc_file, "r", encoding="utf-8", newline="\n") as f:
591
592
593
            content = f.read()
        raw_doc_objs = re.findall(r"(?:autoclass|autofunction):: transformers.(\S+)\s+", content)
        documented_obj += [obj.split(".")[-1] for obj in raw_doc_objs]
Sylvain Gugger's avatar
Sylvain Gugger committed
594
595
596
597
598
    for doc_file in Path(PATH_TO_DOC).glob("**/*.mdx"):
        with open(doc_file, "r", encoding="utf-8", newline="\n") as f:
            content = f.read()
        raw_doc_objs = re.findall("\[\[autodoc\]\]\s+(\S+)\s+", content)
        documented_obj += [obj.split(".")[-1] for obj in raw_doc_objs]
599
600
601
602
603
604
    return documented_obj


# One good reason for not being documented is to be deprecated. Put in this list deprecated objects.
DEPRECATED_OBJECTS = [
    "AutoModelWithLMHead",
605
    "BartPretrainedModel",
606
607
    "DataCollator",
    "DataCollatorForSOP",
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
    "GlueDataset",
    "GlueDataTrainingArguments",
    "LineByLineTextDataset",
    "LineByLineWithRefDataset",
    "LineByLineWithSOPTextDataset",
    "PretrainedBartModel",
    "PretrainedFSMTModel",
    "SingleSentenceClassificationProcessor",
    "SquadDataTrainingArguments",
    "SquadDataset",
    "SquadExample",
    "SquadFeatures",
    "SquadV1Processor",
    "SquadV2Processor",
    "TFAutoModelWithLMHead",
623
    "TFBartPretrainedModel",
624
625
    "TextDataset",
    "TextDatasetForNextSentencePrediction",
626
    "Wav2Vec2ForMaskedLM",
627
    "Wav2Vec2Tokenizer",
628
629
630
631
632
633
634
635
636
637
    "glue_compute_metrics",
    "glue_convert_examples_to_features",
    "glue_output_modes",
    "glue_processors",
    "glue_tasks_num_labels",
    "squad_convert_examples_to_features",
    "xnli_compute_metrics",
    "xnli_output_modes",
    "xnli_processors",
    "xnli_tasks_num_labels",
638
639
    "TFTrainer",
    "TFTrainingArguments",
640
641
642
643
644
645
646
]

# Exceptionally, some objects should not be documented after all rules passed.
# ONLY PUT SOMETHING IN THIS LIST AS A LAST RESORT!
UNDOCUMENTED_OBJECTS = [
    "AddedToken",  # This is a tokenizers class.
    "BasicTokenizer",  # Internal, should never have been in the main init.
647
    "CharacterTokenizer",  # Internal, should never have been in the main init.
648
    "DPRPretrainedReader",  # Like an Encoder.
Sylvain Gugger's avatar
Sylvain Gugger committed
649
    "DummyObject",  # Just picked by mistake sometimes.
650
    "MecabTokenizer",  # Internal, should never have been in the main init.
651
652
653
654
655
656
657
658
659
660
661
    "ModelCard",  # Internal type.
    "SqueezeBertModule",  # Internal building block (should have been called SqueezeBertLayer)
    "TFDPRPretrainedReader",  # Like an Encoder.
    "TransfoXLCorpus",  # Internal type.
    "WordpieceTokenizer",  # Internal, should never have been in the main init.
    "absl",  # External module
    "add_end_docstrings",  # Internal, should never have been in the main init.
    "add_start_docstrings",  # Internal, should never have been in the main init.
    "convert_tf_weight_name_to_pt_weight_name",  # Internal used to convert model weights
    "logger",  # Internal logger
    "logging",  # External module
662
    "requires_backends",  # Internal function
663
664
665
666
667
668
669
670
671
]

# This list should be empty. Objects in it should get their own doc page.
SHOULD_HAVE_THEIR_OWN_PAGE = [
    # Benchmarks
    "PyTorchBenchmark",
    "PyTorchBenchmarkArguments",
    "TensorFlowBenchmark",
    "TensorFlowBenchmarkArguments",
672
673
    "ResNetBackbone",
    "AutoBackbone",
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
]


def ignore_undocumented(name):
    """Rules to determine if `name` should be undocumented."""
    # NOT DOCUMENTED ON PURPOSE.
    # Constants uppercase are not documented.
    if name.isupper():
        return True
    # PreTrainedModels / Encoders / Decoders / Layers / Embeddings / Attention are not documented.
    if (
        name.endswith("PreTrainedModel")
        or name.endswith("Decoder")
        or name.endswith("Encoder")
        or name.endswith("Layer")
        or name.endswith("Embeddings")
        or name.endswith("Attention")
    ):
        return True
    # Submodules are not documented.
    if os.path.isdir(os.path.join(PATH_TO_TRANSFORMERS, name)) or os.path.isfile(
        os.path.join(PATH_TO_TRANSFORMERS, f"{name}.py")
    ):
        return True
    # All load functions are not documented.
    if name.startswith("load_tf") or name.startswith("load_pytorch"):
        return True
    # is_xxx_available functions are not documented.
    if name.startswith("is_") and name.endswith("_available"):
        return True
    # Deprecated objects are not documented.
    if name in DEPRECATED_OBJECTS or name in UNDOCUMENTED_OBJECTS:
        return True
    # MMBT model does not really work.
    if name.startswith("MMBT"):
        return True
    if name in SHOULD_HAVE_THEIR_OWN_PAGE:
        return True
    return False


def check_all_objects_are_documented():
Patrick von Platen's avatar
Patrick von Platen committed
716
    """Check all models are properly documented."""
717
    documented_objs = find_all_documented_objects()
718
719
720
    modules = transformers._modules
    objects = [c for c in dir(transformers) if c not in modules and not c.startswith("_")]
    undocumented_objs = [c for c in objects if c not in documented_objs and not ignore_undocumented(c)]
721
722
723
724
725
    if len(undocumented_objs) > 0:
        raise Exception(
            "The following objects are in the public init so should be documented:\n - "
            + "\n - ".join(undocumented_objs)
        )
726
    check_docstrings_are_in_md()
727
728
729
730
731
732
733
734
735
    check_model_type_doc_match()


def check_model_type_doc_match():
    """Check all doc pages have a corresponding model type."""
    model_doc_folder = Path(PATH_TO_DOC) / "model_doc"
    model_docs = [m.stem for m in model_doc_folder.glob("*.mdx")]

    model_types = list(transformers.models.auto.configuration_auto.MODEL_NAMES_MAPPING.keys())
736
    model_types = [MODEL_TYPE_TO_DOC_MAPPING[m] if m in MODEL_TYPE_TO_DOC_MAPPING else m for m in model_types]
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754

    errors = []
    for m in model_docs:
        if m not in model_types and m != "auto":
            close_matches = get_close_matches(m, model_types)
            error_message = f"{m} is not a proper model identifier."
            if len(close_matches) > 0:
                close_matches = "/".join(close_matches)
                error_message += f" Did you mean {close_matches}?"
            errors.append(error_message)

    if len(errors) > 0:
        raise ValueError(
            "Some model doc pages do not match any existing model type:\n"
            + "\n".join(errors)
            + "\nYou can add any missing model type to the `MODEL_NAMES_MAPPING` constant in "
            "models/auto/configuration_auto.py."
        )
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781


# Re pattern to catch :obj:`xx`, :class:`xx`, :func:`xx` or :meth:`xx`.
_re_rst_special_words = re.compile(r":(?:obj|func|class|meth):`([^`]+)`")
# Re pattern to catch things between double backquotes.
_re_double_backquotes = re.compile(r"(^|[^`])``([^`]+)``([^`]|$)")
# Re pattern to catch example introduction.
_re_rst_example = re.compile(r"^\s*Example.*::\s*$", flags=re.MULTILINE)


def is_rst_docstring(docstring):
    """
    Returns `True` if `docstring` is written in rst.
    """
    if _re_rst_special_words.search(docstring) is not None:
        return True
    if _re_double_backquotes.search(docstring) is not None:
        return True
    if _re_rst_example.search(docstring) is not None:
        return True
    return False


def check_docstrings_are_in_md():
    """Check all docstrings are in md"""
    files_with_rst = []
    for file in Path(PATH_TO_TRANSFORMERS).glob("**/*.py"):
782
        with open(file, encoding="utf-8") as f:
783
784
785
786
787
788
789
790
791
792
793
794
795
            code = f.read()
        docstrings = code.split('"""')

        for idx, docstring in enumerate(docstrings):
            if idx % 2 == 0 or not is_rst_docstring(docstring):
                continue
            files_with_rst.append(file)
            break

    if len(files_with_rst) > 0:
        raise ValueError(
            "The following files have docstrings written in rst:\n"
            + "\n".join([f"- {f}" for f in files_with_rst])
Kamal Raj's avatar
Kamal Raj committed
796
            + "\nTo fix this run `doc-builder convert path_to_py_file` after installing `doc-builder`\n"
797
798
            "(`pip install git+https://github.com/huggingface/doc-builder`)"
        )
799
800


801
def check_repo_quality():
Patrick von Platen's avatar
Patrick von Platen committed
802
    """Check all models are properly tested and documented."""
803
804
    print("Checking all models are included.")
    check_model_list()
805
806
    print("Checking all models are public.")
    check_models_are_in_init()
807
    print("Checking all models are properly tested.")
Sylvain Gugger's avatar
Sylvain Gugger committed
808
    check_all_decorator_order()
809
    check_all_models_are_tested()
810
    print("Checking all objects are properly documented.")
811
    check_all_objects_are_documented()
812
813
    print("Checking all models are in at least one auto class.")
    check_all_models_are_auto_configured()
814
815
816
817


if __name__ == "__main__":
    check_repo_quality()