Skip to content

feat: add 'Path' parameter for ModelCard template #3253

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Mar 21, 2025
Merged

feat: add 'Path' parameter for ModelCard template #3253

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
9069538
feat: add 'Path' parameter for ModelCard template
sam-hey Feb 28, 2025
920bcaa
ref:
sam-hey Feb 28, 2025
579d2f5
Move the 'template_path' implementation to 'behind the scenes'
tomaarsen Mar 20, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions sentence_transformers/model_card.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -315,6 +315,7 @@ class SentenceTransformerModelCardData(CardData):
pipeline_tag: str = field(default="sentence-similarity", init=False)
library_name: str = field(default="sentence-transformers", init=False)
version: dict[str, str] = field(default_factory=get_versions, init=False)
template_path: Path = field(default=Path(__file__).parent / "model_card_template.md", init=False)

# Passed via `register_model` only
model: SentenceTransformer | None = field(default=None, init=False, repr=False)
Expand Down Expand Up @@ -1016,6 +1017,7 @@ def to_yaml(self, line_break=None) -> str:


def generate_model_card(model: SentenceTransformer) -> str:
template_path = Path(__file__).parent / "model_card_template.md"
model_card = ModelCard.from_template(card_data=model.model_card_data, template_path=template_path, hf_emoji="🤗")
model_card = ModelCard.from_template(
card_data=model.model_card_data, template_path=model.model_card_data.template_path, hf_emoji="🤗"
)
return model_card.content
Loading