Using Dataset and Model Card Templates

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.

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 or Model Card) into your README.md file.¹ 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!

Practice makes perfect!

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 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. Read the story of the workshop and clone the repo to follow along with the 1 hour and 15 minute lesson!

Note

The Dataset and Model cards have incorporated some of Hugging Face's January 2024 updates (following their Dataset Card Overhaul). 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, HF Model Card).

---

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. ↩