Remove modelcards dependency (#2050)

* Switch to huggingface_hub.ModelCard

* Remove modelcards dependency in favor of Jinja2

docker/diffusers-flax-cpu/Dockerfile

@@ -34,8 +34,8 @@ RUN python3 -m pip install --no-cache-dir --upgrade pip && \
         datasets \
         hf-doc-builder \
         huggingface-hub \
+        Jinja2 \
         librosa \
-        modelcards \
         numpy \
         scipy \
         tensorboard \

docker/diffusers-flax-tpu/Dockerfile

@@ -36,8 +36,8 @@ RUN python3 -m pip install --no-cache-dir --upgrade pip && \
         datasets \
         hf-doc-builder \
         huggingface-hub \
+        Jinja2 \
         librosa \        
-        modelcards \
         numpy \
         scipy \
         tensorboard \

docker/diffusers-onnxruntime-cpu/Dockerfile

@@ -34,8 +34,8 @@ RUN python3 -m pip install --no-cache-dir --upgrade pip && \
         datasets \
         hf-doc-builder \
         huggingface-hub \
+        Jinja2 \
         librosa \
-        modelcards \
         numpy \
         scipy \
         tensorboard \

docker/diffusers-onnxruntime-cuda/Dockerfile

@@ -34,8 +34,8 @@ RUN python3 -m pip install --no-cache-dir --upgrade pip && \
         datasets \
         hf-doc-builder \
         huggingface-hub \
+        Jinja2 \
         librosa \
-        modelcards \
         numpy \
         scipy \
         tensorboard \

docker/diffusers-pytorch-cpu/Dockerfile

@@ -33,8 +33,8 @@ RUN python3 -m pip install --no-cache-dir --upgrade pip && \
         datasets \
         hf-doc-builder \
         huggingface-hub \
+        Jinja2 \
         librosa \
-        modelcards \
         numpy \
         scipy \
         tensorboard \

docker/diffusers-pytorch-cuda/Dockerfile

@@ -33,8 +33,8 @@ RUN python3 -m pip install --no-cache-dir --upgrade pip && \
         datasets \
         hf-doc-builder \
         huggingface-hub \
+        Jinja2 \
         librosa \
-        modelcards \
         numpy \
         scipy \
         tensorboard \

examples/dreambooth/requirements.txt

@@ -3,4 +3,4 @@ torchvision
 transformers>=4.25.1
 ftfy
 tensorboard
-modelcards
+Jinja2

examples/dreambooth/requirements_flax.txt

@@ -5,4 +5,4 @@ torch
 torchvision
 ftfy
 tensorboard
-modelcards
+Jinja2

examples/research_projects/colossalai/requirement.txt

@@ -3,5 +3,5 @@ torch
 torchvision
 ftfy
 tensorboard
-modelcards
+Jinja2
 transformers
\ No newline at end of file

examples/research_projects/dreambooth_inpaint/requirements.txt

@@ -4,4 +4,4 @@ torchvision
 transformers>=4.21.0
 ftfy
 tensorboard
-modelcards
+Jinja2

examples/research_projects/intel_opts/textual_inversion/requirements.txt

@@ -3,5 +3,5 @@ torchvision
 transformers>=4.21.0
 ftfy
 tensorboard
-modelcards
+Jinja2
 intel_extension_for_pytorch>=1.13

examples/research_projects/multi_subject_dreambooth/requirements.txt

@@ -3,4 +3,4 @@ torchvision
 transformers>=4.25.1
 ftfy
 tensorboard
-modelcards
+Jinja2
\ No newline at end of file

examples/text_to_image/requirements.txt

@@ -4,4 +4,4 @@ transformers>=4.25.1
 datasets
 ftfy
 tensorboard
-modelcards
+Jinja2

examples/text_to_image/requirements_flax.txt

@@ -6,4 +6,4 @@ torch
 torchvision
 ftfy
 tensorboard
-modelcards
+Jinja2

examples/textual_inversion/requirements.txt

@@ -3,4 +3,4 @@ torchvision
 transformers>=4.25.1
 ftfy
 tensorboard
-modelcards
+Jinja2

examples/textual_inversion/requirements_flax.txt

@@ -5,4 +5,4 @@ torch
 torchvision
 ftfy
 tensorboard
-modelcards
+Jinja2

setup.py

@@ -91,9 +91,9 @@ _deps = [
     "isort>=5.5.4",
     "jax>=0.2.8,!=0.3.2",
     "jaxlib>=0.1.65",
+    "Jinja2",
     "k-diffusion>=0.0.12",
     "librosa",
-    "modelcards>=0.1.4",
     "numpy",
     "parameterized",
     "pytest",
@@ -180,9 +180,10 @@ extras = {}
 extras = {}
 extras["quality"] = deps_list("black", "isort", "flake8", "hf-doc-builder")
 extras["docs"] = deps_list("hf-doc-builder")
-extras["training"] = deps_list("accelerate", "datasets", "tensorboard", "modelcards")
+extras["training"] = deps_list("accelerate", "datasets", "tensorboard", "Jinja2")
 extras["test"] = deps_list(
     "datasets",
+    "Jinja2",
     "k-diffusion",
     "librosa",
     "parameterized",

src/diffusers/dependency_versions_table.py

@@ -15,9 +15,9 @@ deps = {
     "isort": "isort>=5.5.4",
     "jax": "jax>=0.2.8,!=0.3.2",
     "jaxlib": "jaxlib>=0.1.65",
+    "Jinja2": "Jinja2",
     "k-diffusion": "k-diffusion>=0.0.12",
     "librosa": "librosa",
-    "modelcards": "modelcards>=0.1.4",
     "numpy": "numpy",
     "parameterized": "parameterized",
     "pytest": "pytest",

src/diffusers/utils/__init__.py

@@ -48,7 +48,6 @@ from .import_utils import (
     is_k_diffusion_available,
     is_k_diffusion_version,
     is_librosa_available,
-    is_modelcards_available,
     is_onnx_available,
     is_safetensors_available,
     is_scipy_available,

src/diffusers/utils/hub_utils.py

@@ -20,7 +20,8 @@ from pathlib import Path
 from typing import Dict, Optional, Union
 from uuid import uuid4
 
-from huggingface_hub import HfFolder, whoami
+from huggingface_hub import HfFolder, ModelCard, ModelCardData, whoami
+from huggingface_hub.utils import is_jinja_available
 
 from .. import __version__
 from .constants import HUGGINGFACE_CO_RESOLVE_ENDPOINT
@@ -31,21 +32,16 @@ from .import_utils import (
     _onnxruntime_version,
     _torch_version,
     is_flax_available,
-    is_modelcards_available,
     is_onnx_available,
     is_torch_available,
 )
 from .logging import get_logger
 
 
-if is_modelcards_available():
-    from modelcards import CardData, ModelCard
-
-
 logger = get_logger(__name__)
 
 
-MODEL_CARD_TEMPLATE_PATH = Path(__file__).parent / "utils" / "model_card_template.md"
+MODEL_CARD_TEMPLATE_PATH = Path(__file__).parent / "model_card_template.md"
 SESSION_ID = uuid4().hex
 HF_HUB_OFFLINE = os.getenv("HF_HUB_OFFLINE", "").upper() in ENV_VARS_TRUE_VALUES
 DISABLE_TELEMETRY = os.getenv("DISABLE_TELEMETRY", "").upper() in ENV_VARS_TRUE_VALUES
@@ -87,10 +83,11 @@ def get_full_repo_name(model_id: str, organization: Optional[str] = None, token:
 
 
 def create_model_card(args, model_name):
-    if not is_modelcards_available:
+    if not is_jinja_available():
         raise ValueError(
-            "Please make sure to have `modelcards` installed when using the `create_model_card` function. You can"
-            " install the package with `pip install modelcards`."
+            "Modelcard rendering is based on Jinja templates."
+            " Please make sure to have `jinja` installed before using `create_model_card`."
+            " To install it, please run `pip install Jinja2`."
         )
 
     if hasattr(args, "local_rank") and args.local_rank not in [-1, 0]:
@@ -100,7 +97,7 @@ def create_model_card(args, model_name):
     repo_name = get_full_repo_name(model_name, token=hub_token)
 
     model_card = ModelCard.from_template(
-        card_data=CardData(  # Card metadata object that will be converted to YAML block
+        card_data=ModelCardData(  # Card metadata object that will be converted to YAML block
             language="en",
             license="apache-2.0",
             library_name="diffusers",