From 6f1b15867c326945d44853d09cbfe8b2d85ad0dc Mon Sep 17 00:00:00 2001 From: Stephen Roller Date: Fri, 17 Sep 2021 11:56:31 -0400 Subject: [PATCH 1/2] Move sample_model_cards outside the top directory. --- .../blenderbot_90M/model_card.md | 0 ...e_language_generation_metrics_safety_heatmap.png | Bin .../sample_model_cards}/safety_multi/model_card.md | 0 3 files changed, 0 insertions(+), 0 deletions(-) rename {sample_model_cards => docs/sample_model_cards}/blenderbot_90M/model_card.md (100%) rename {sample_model_cards => docs/sample_model_cards}/blenderbot_90M/offensive_language_generation_metrics_safety_heatmap.png (100%) rename {sample_model_cards => docs/sample_model_cards}/safety_multi/model_card.md (100%) diff --git a/sample_model_cards/blenderbot_90M/model_card.md b/docs/sample_model_cards/blenderbot_90M/model_card.md similarity index 100% rename from sample_model_cards/blenderbot_90M/model_card.md rename to docs/sample_model_cards/blenderbot_90M/model_card.md diff --git a/sample_model_cards/blenderbot_90M/offensive_language_generation_metrics_safety_heatmap.png b/docs/sample_model_cards/blenderbot_90M/offensive_language_generation_metrics_safety_heatmap.png similarity index 100% rename from sample_model_cards/blenderbot_90M/offensive_language_generation_metrics_safety_heatmap.png rename to docs/sample_model_cards/blenderbot_90M/offensive_language_generation_metrics_safety_heatmap.png diff --git a/sample_model_cards/safety_multi/model_card.md b/docs/sample_model_cards/safety_multi/model_card.md similarity index 100% rename from sample_model_cards/safety_multi/model_card.md rename to docs/sample_model_cards/safety_multi/model_card.md From feef2e9d98ea0ffae3738dbc18b48347deb81847 Mon Sep 17 00:00:00 2001 From: Stephen Roller Date: Fri, 17 Sep 2021 11:57:28 -0400 Subject: [PATCH 2/2] Update docs. --- docs/source/tutorial_model_cards.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/tutorial_model_cards.md b/docs/source/tutorial_model_cards.md index 222780f3796..3a5c056a5e8 100644 --- a/docs/source/tutorial_model_cards.md +++ b/docs/source/tutorial_model_cards.md @@ -7,7 +7,7 @@ Think of model cards as a condensed medical card for models. It is a great way for people who might not have the time to read a paper in detail to get the gist of what a model is doing, the datasets involved, how it is performing, and any concerns that the author might have about the model. -You can check out the [Model Cards for Model Reporting paper](https://arxiv.org/pdf/1810.03993.pdf), and here's a sample model card for the [Blenderbot2.0 2.7B model](https://github.com/facebookresearch/ParlAI/blob/main/parlai/zoo/blenderbot2/model_card.md). In addition, here is a [link](https://github.com/facebookresearch/ParlAI/tree/main/sample_model_cards) to some more model card examples. +You can check out the [Model Cards for Model Reporting paper](https://arxiv.org/pdf/1810.03993.pdf), and here's a sample model card for the [Blenderbot2.0 2.7B model](https://github.com/facebookresearch/ParlAI/blob/main/parlai/zoo/blenderbot2/model_card.md). In addition, here is a [link](https://github.com/facebookresearch/ParlAI/tree/main/docs/sample_model_cards) to some more model card examples. ## The Process There are two steps in generating the model cards.