add tests

Author: Wauplin

src/huggingface_hub/hub_mixin.py

@@ -204,7 +204,7 @@ def save_pretrained(
         # save model card
         model_card_path = save_directory / "README.md"
         if not model_card_path.exists():  # do not overwrite if already exists
-            self._generate_model_card().save(save_directory / "README.md")
+            self.generate_model_card().save(save_directory / "README.md")
 
         # push to the Hub if required
         if push_to_hub:
@@ -466,7 +466,7 @@ def push_to_hub(
                 delete_patterns=delete_patterns,
             )
 
-    def _generate_model_card(self, *args, **kwargs) -> ModelCard:
+    def generate_model_card(self, *args, **kwargs) -> ModelCard:
         card = ModelCard.from_template(
             card_data=ModelCardData(**asdict(self.library_info)),
             template_str=DEFAULT_MODEL_CARD,

src/huggingface_hub/repocard_data.py

@@ -309,10 +309,17 @@ def __init__(
         ignore_metadata_errors: bool = False,
         **kwargs,
     ):
+        unique_tags = tags
+        if tags is not None:
+            unique_tags = []  # make tags unique + keep order explicitly
+            for tag in tags:
+                if tag not in unique_tags:
+                    unique_tags.append(tag)
+
         self.language = language
         self.license = license
         self.library_name = library_name
-        self.tags = tags
+        self.tags = unique_tags
         self.base_model = base_model
         self.datasets = datasets
         self.metrics = metrics

tests/test_hub_mixin_pytorch.py

@@ -8,7 +8,7 @@
 
 import pytest
 
-from huggingface_hub import HfApi, hf_hub_download
+from huggingface_hub import HfApi, ModelCard, hf_hub_download
 from huggingface_hub.constants import PYTORCH_WEIGHTS_NAME
 from huggingface_hub.hub_mixin import ModelHubMixin, PyTorchModelHubMixin
 from huggingface_hub.utils import EntryNotFoundError, HfHubHTTPError, SoftTemporaryDirectory, is_torch_available
@@ -32,6 +32,14 @@ def __init__(self, **kwargs):
         def forward(self, x):
             return self.l1(x)
 
+    class DummyModelWithTags(nn.Module, PyTorchModelHubMixin, tags=["tag1", "tag2"], library_name="my-dummy-lib"):
+        def __init__(self, linear_layer: int = 4):
+            super().__init__()
+            self.l1 = nn.Linear(linear_layer, linear_layer)
+
+        def forward(self, x):
+            return self.l1(x)
+
 else:
     DummyModel = None
 
@@ -231,3 +239,14 @@ def test_push_to_hub(self):
 
         # Delete repo
         self._api.delete_repo(repo_id=repo_id)
+
+    def test_generate_model_card(self):
+        model = DummyModelWithTags()
+        card = model.generate_model_card()
+        assert card.data.tags == ["tag1", "tag2", "pytorch_model_hub_mixin", "model_hub_mixin"]
+
+        model.save_pretrained(self.cache_dir)
+        card_reloaded = ModelCard.load(self.cache_dir / "README.md")
+
+        assert str(card) == str(card_reloaded)
+        assert card.data == card_reloaded.data

tests/test_repocard.py

@@ -178,6 +178,15 @@
 Some cool dataset card.
 """
 
+DUMMY_MODEL_CARD_TEMPLATE = """
+---
+{{ card_data }}
+---
+
+Custom template passed as a string.
+{{ repo_url | default("[More Information Needed]", true) }}
+"""
+
 
 def require_jinja(test_case):
     """
@@ -586,7 +595,8 @@ def test_repo_card_from_default_template_with_model_id(self):
         )
 
     @require_jinja
-    def test_repo_card_from_custom_template(self):
+    def test_repo_card_from_custom_template_path(self):
+        # Template is passed as a path (not a raw string)
         template_path = SAMPLE_CARDS_DIR / "sample_template.md"
         card = RepoCard.from_template(
             card_data=CardData(
@@ -605,6 +615,15 @@ def test_repo_card_from_custom_template(self):
             "Custom template didn't set jinja variable correctly",
         )
 
+    @require_jinja
+    def test_repo_card_from_custom_template_string(self):
+        # Template is passed as a raw string (not a path)
+        card = RepoCard.from_template(
+            card_data=CardData(language="en", license="mit"),
+            template_str=DUMMY_MODEL_CARD_TEMPLATE,
+        )
+        assert "Custom template passed as a string." in str(card)
+
     def test_repo_card_data_must_be_dict(self):
         sample_path = SAMPLE_CARDS_DIR / "sample_invalid_card_data.md"
         with pytest.raises(ValueError, match="repo card metadata block should be a dict"):

tests/test_repocard_data.py

@@ -233,6 +233,10 @@ def test_eval_result_with_incomplete_source(self):
                 source_name="Open LLM Leaderboard",
             )
 
+    def test_model_card_unique_tags(self):
+        data = ModelCardData(tags=["tag2", "tag1", "tag2", "tag3"])
+        assert data.tags == ["tag2", "tag1", "tag3"]
+
 
 class DatasetCardDataTest(unittest.TestCase):
     def test_train_eval_index_keys_updated(self):