From b118c57aebebeac34e7a00f6633fc4e2ca2b53b5 Mon Sep 17 00:00:00 2001 From: meg <90473723+meg-huggingface@users.noreply.github.com> Date: Mon, 8 Apr 2024 14:58:16 -0700 Subject: [PATCH] Update model-card-guidebook.md (#1264) * Update model-card-guidebook.md * Update model-cards-user-studies.md * Update model-card-annotated.md * Update model-card-appendix.md * Update model-card-guidebook.md * Update model-card-annotated.md * Update model-card-appendix.md * Update model-card-landscape-analysis.md * Update model-cards-user-studies.md --- docs/hub/model-card-annotated.md | 9 +++++++++ docs/hub/model-card-appendix.md | 6 ++++++ docs/hub/model-card-guidebook.md | 4 ++-- docs/hub/model-card-landscape-analysis.md | 4 ++++ docs/hub/model-cards-user-studies.md | 7 +++++++ 5 files changed, 28 insertions(+), 2 deletions(-) diff --git a/docs/hub/model-card-annotated.md b/docs/hub/model-card-annotated.md index 3e121cebd..6090195f9 100644 --- a/docs/hub/model-card-annotated.md +++ b/docs/hub/model-card-annotated.md @@ -22,6 +22,8 @@ _Instructions are provided below, in italics._ Template variable names appear in `monospace`. +--- + # Model Name **Section Overview:** Provide the model name and a 1-2 sentence summary of what the model is. @@ -317,3 +319,10 @@ _Clearly define terms in order to be accessible across audiences._ **Section Overview:** Provides a code snippet to show how to use the model. `get_started_code` + + +--- + +**Please cite as:** +Ozoani, Ezi and Gerchick, Marissa and Mitchell, Margaret. Model Card Guidebook. Hugging Face, 2022. https://huggingface.co/docs/hub/en/model-card-guidebook + diff --git a/docs/hub/model-card-appendix.md b/docs/hub/model-card-appendix.md index d2c0df461..4dd048dfb 100644 --- a/docs/hub/model-card-appendix.md +++ b/docs/hub/model-card-appendix.md @@ -103,3 +103,9 @@ Tools for understanding model cards and understanding how to create model cards * [Kaggle](https://www.kaggle.com/code/var0101/model-cards/tutorial) * [Code.org](https://studio.code.org/s/aiml-2021/lessons/8) * [UNICEF](https://unicef.github.io/inventory/data/model-card/) + +--- + +**Please cite as:** +Ozoani, Ezi and Gerchick, Marissa and Mitchell, Margaret. Model Card Guidebook. Hugging Face, 2022. https://huggingface.co/docs/hub/en/model-card-guidebook + diff --git a/docs/hub/model-card-guidebook.md b/docs/hub/model-card-guidebook.md index 5ed1fa6d3..d882890cd 100644 --- a/docs/hub/model-card-guidebook.md +++ b/docs/hub/model-card-guidebook.md @@ -20,7 +20,7 @@ With the launch of this Guidebook, we introduce several new resources and connec We also include an [Appendix](./model-card-appendix) with further details from this work. +--- -Citation for the Model Card Guidebook: - +**Please cite as:** Ozoani, Ezi and Gerchick, Marissa and Mitchell, Margaret. Model Card Guidebook. Hugging Face, 2022. https://huggingface.co/docs/hub/en/model-card-guidebook diff --git a/docs/hub/model-card-landscape-analysis.md b/docs/hub/model-card-landscape-analysis.md index 942ccfb55..06c758e28 100644 --- a/docs/hub/model-card-landscape-analysis.md +++ b/docs/hub/model-card-landscape-analysis.md @@ -139,3 +139,7 @@ While some headings within model cards may differ between models, we grouped com [^8]: By “Hugging Face models,” we mean models shared by Hugging Face, not another organisation, on the Hub. Formally, these are models without a ‘/’ in their model ID. +--- + +**Please cite as:** +Ozoani, Ezi and Gerchick, Marissa and Mitchell, Margaret. Model Card Guidebook. Hugging Face, 2022. https://huggingface.co/docs/hub/en/model-card-guidebook diff --git a/docs/hub/model-cards-user-studies.md b/docs/hub/model-cards-user-studies.md index 06b6c7793..bf68dce1c 100644 --- a/docs/hub/model-cards-user-studies.md +++ b/docs/hub/model-cards-user-studies.md @@ -111,3 +111,10 @@ We want to acknowledge and thank [Bibi Ofuya](https://www.figma.com/proto/qrPCjW [^1]: See https://towardsdatascience.com/dag-card-is-the-new-model-card-70754847a111 + + +--- + +**Please cite as:** +Ozoani, Ezi and Gerchick, Marissa and Mitchell, Margaret. Model Card Guidebook. Hugging Face, 2022. https://huggingface.co/docs/hub/en/model-card-guidebook +