Skip to content

Commit

Permalink
Update model-card-guidebook.md (#1264)
Browse files Browse the repository at this point in the history
* 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
  • Loading branch information
meg-huggingface authored Apr 8, 2024
1 parent 24f1d65 commit b118c57
Show file tree
Hide file tree
Showing 5 changed files with 28 additions and 2 deletions.
9 changes: 9 additions & 0 deletions docs/hub/model-card-annotated.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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

6 changes: 6 additions & 0 deletions docs/hub/model-card-appendix.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

4 changes: 2 additions & 2 deletions docs/hub/model-card-guidebook.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
4 changes: 4 additions & 0 deletions docs/hub/model-card-landscape-analysis.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
7 changes: 7 additions & 0 deletions docs/hub/model-cards-user-studies.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

0 comments on commit b118c57

Please sign in to comment.