Skip to content

Commit ecb7a66

Browse files
committed
Add brief page on templates
mainly an intro to our options, to be used for general linking instead of README Redirect link in HF repo guide to template page
1 parent f7cec23 commit ecb7a66

File tree

3 files changed

+17
-1
lines changed

3 files changed

+17
-1
lines changed

docs/wiki-guide/About-Templates.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# Using Dataset and Model Card Templates
2+
3+
We have Imageomics-specific versions of Hugging Face's Dataset and Model Card templates. These include guidance and examples for the various metadata sections, reference information for Hugging Face's particular flavor of markdown, and the Imageomics grant acknowledgment.
4+
5+
To use the template for a new dataset or model repository on Hugging Face (HF), simply copy and paste the contents of the appropriate template ([Dataset Card](HF_DatasetCard_Template_mkdocs.md) or [Model Card](HF_ModelCard_Template_mkdocs.md)) into your `README.md` file.[^1]
6+
Then, follow the descriptions under each section to fill in the appropriate information. This is meant to be an iterative process throughout the life of your project, so do not worry if you cannot answer all parts at the beginning—that's to be expected!
7+
[^1]: The templates can also be added to your repository thorugh the website user interface (UI): Navigate to the "Model/Dataset Card" tab on your repo, select "Create Model/Dataset Card", copy and paste the template contents into the `README.md` file, and add your content.
8+
9+
10+
!!! tip "Practice makes perfect!"
11+
If you have never filled out a dataset card before, or are unsure of how to find the answers to fill in the sections, we ran a [workshop](https://github.com/Imageomics/data-workshop-AH-2024) to help familiarize our members with this process. In particular, the portion where we walked through filling out part of a dataset card as we did exploratory data analysis (EDA) was recorded and is available on the [Imageomics YouTube Channel](https://www.youtube.com/@ImageomicsInstitute/videos). Read the [story of the workshop](https://github.com/Imageomics/data-workshop-AH-2024/tree/video-url?tab=readme-ov-file#story-of-the-workshop) and clone the [repo](https://github.com/Imageomics/data-workshop-AH-2024) to follow along with the 1 hour and 15 minute lesson!
12+
13+
!!! note "Note"
14+
The Dataset and Model cards have incorporated some of Hugging Face's January 2024 updates (following their [Dataset Card Overhaul](https://github.com/huggingface/huggingface_hub/commit/6dd7ee829bd1b1216663a9993c1943c29b64690a)). It doesn't appear they will be updated more and we do not currently anticipate further large updates on our end as our overall template formats have diverged, but you may nevertheless wish to check HF for extra information or tagging updates ([HF Dataset Card](https://github.com/huggingface/huggingface_hub/blob/main/src/huggingface_hub/templates/datasetcard_template.md), [HF Model Card](https://github.com/huggingface/huggingface_hub/blob/main/src/huggingface_hub/templates/modelcard_template.md)).
15+

docs/wiki-guide/Hugging-Face-Repo-Guide.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -71,4 +71,4 @@ git push origin pr/<PR#>:refs/pr/<PR#>
7171
For more information on Hugging Face Pull Requests and Discussions, see their [documentation](https://huggingface.co/docs/hub/repositories-pull-requests-discussions).
7272

7373
## Templates for Model and Dataset Cards
74-
See [here](https://github.com/Imageomics/Imageomics-Guide#hugging-face) for guidelines on using templates for these important pieces of documentation.
74+
See [About Templates](About-Templates.md) for guidelines on using templates for these important pieces of documentation.

mkdocs.yaml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -105,6 +105,7 @@ nav:
105105
- "Metadata Guide": wiki-guide/Metadata-Guide.md
106106
- "DOI Generation": wiki-guide/doi-generation.md
107107
- Templates:
108+
- "About Templates": wiki-guide/About-Templates.md
108109
- "Dataset Card Template": wiki-guide/HF_DatasetCard_Template_mkdocs.md
109110
- "Model Card Template": wiki-guide/HF_ModelCard_Template_mkdocs.md
110111
- Command Line Cheat Sheet: wiki-guide/Command-Line-Cheat-Sheet.md

0 commit comments

Comments
 (0)