first commit

utils/check_config_docstrings.py

@@ -0,0 +1,95 @@
+# Copyright 2022 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.
+
+import inspect
+import re
+
+from transformers.utils import direct_transformers_import
+
+
+CHECKER_CONFIG = {
+    "name": "config_docstrings",
+    "label": "Config docstrings",
+    # Approximate: iterates CONFIG_MAPPING at runtime via inspect.getsource(), not cache globs.
+    # Only configs registered in CONFIG_MAPPING are checked; deprecated models are skipped.
+    "cache_globs": ["src/transformers/models/**/configuration_*.py"],
+    "check_args": [],
+    "fix_args": None,
+}
+
+# All paths are set with the intent you should run this script from the root of the repo with the command
+# python utils/check_config_docstrings.py
+PATH_TO_TRANSFORMERS = "src/transformers"
+
+
+# This is to make sure the transformers module imported is the one in the repo.
+transformers = direct_transformers_import(PATH_TO_TRANSFORMERS)
+
+CONFIG_MAPPING = transformers.models.auto.configuration_auto.CONFIG_MAPPING
+
+# Regex pattern used to find the checkpoint mentioned in the docstring of `config_class`.
+# For example, `[google-bert/bert-base-uncased](https://huggingface.co/google-bert/bert-base-uncased)`
+_re_checkpoint = re.compile(r"""(?s)@auto_docstring\(.*?checkpoint\s*=\s*["']([^"']+)["']""")
+
+
+CONFIG_CLASSES_TO_IGNORE_FOR_DOCSTRING_CHECKPOINT_CHECK = {
+    "DecisionTransformerConfig",
+    "EncoderDecoderConfig",
+    "MusicgenConfig",
+    "RagConfig",
+    "SpeechEncoderDecoderConfig",
+    "TimmBackboneConfig",
+    "TimmWrapperConfig",
+    "VisionEncoderDecoderConfig",
+    "VisionTextDualEncoderConfig",
+    "GraniteConfig",
+    "GraniteMoeConfig",
+    "GraniteMoeHybridConfig",
+    "Qwen3MoeConfig",
+    "GraniteSpeechConfig",
+}
+
+
+def get_checkpoint_from_config_class(config_class):
+    # source code of `config_class`
+    config_source = inspect.getsource(config_class)
+    checkpoints = _re_checkpoint.findall(config_source)
+    return checkpoints[0] if checkpoints else None
+
+
+def check_config_docstrings_have_checkpoints():
+    configs_without_checkpoint = []
+
+    for config_class in list(CONFIG_MAPPING.values()):
+        # Skip deprecated models
+        if "models.deprecated" in config_class.__module__:
+            continue
+        checkpoint = get_checkpoint_from_config_class(config_class)
+
+        name = config_class.__name__
+        if checkpoint is None and name not in CONFIG_CLASSES_TO_IGNORE_FOR_DOCSTRING_CHECKPOINT_CHECK:
+            configs_without_checkpoint.append(name)
+
+    if len(configs_without_checkpoint) > 0:
+        message = "\n".join(sorted(configs_without_checkpoint))
+        raise ValueError(
+            f"The following configurations don't contain any valid checkpoint:\n{message}\n\n"
+            "The requirement is to include a link pointing to one of the models of this architecture in the "
+            "docstring of the config classes listed above. The link should be passed to an `auto_docstring`"
+            "decorator as follows `@auto_docstring(checkpoint='myorg/mymodel')."
+        )
+
+
+if __name__ == "__main__":
+    check_config_docstrings_have_checkpoints()