Automatically add transformers tag to the modelcard (#32623)

* Automatically add `transformers` tag to the modelcard * Specify library_name and test
huggingface · Aug 20, 2024 · 9c7aa7b · 9c7aa7b
1 parent ed6acee
commit 9c7aa7b
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 1 deletion.
diff --git a/src/transformers/modelcard.py b/src/transformers/modelcard.py
@@ -454,6 +454,7 @@ def create_metadata(self):
         metric_mapping = infer_metric_tags_from_eval_results(self.eval_results)
 
         metadata = {}
+        metadata = _insert_value(metadata, "library_name", "transformers")
         metadata = _insert_values_as_list(metadata, "language", self.language)
         metadata = _insert_value(metadata, "license", self.license)
         if self.finetuned_from is not None and isinstance(self.finetuned_from, str) and len(self.finetuned_from) > 0:

diff --git a/tests/utils/test_model_card.py b/tests/utils/test_model_card.py
@@ -19,7 +19,7 @@
 import tempfile
 import unittest
 
-from transformers.modelcard import ModelCard
+from transformers.modelcard import ModelCard, TrainingSummary
 
 
 class ModelCardTester(unittest.TestCase):
@@ -82,3 +82,8 @@ def test_model_card_from_and_save_pretrained(self):
             model_card_second = ModelCard.from_pretrained(tmpdirname)
 
         self.assertEqual(model_card_second.to_dict(), model_card_first.to_dict())
+
+    def test_model_summary_modelcard_base_metadata(self):
+        metadata = TrainingSummary("Model name").create_metadata()
+        self.assertTrue("library_name" in metadata)
+        self.assertTrue(metadata["library_name"] == "transformers")