From 0607b88945a4b355f1fd2e60790cc90daaf22fbb Mon Sep 17 00:00:00 2001 From: Sylvain Gugger <35901082+sgugger@users.noreply.github.com> Date: Tue, 30 Jun 2020 08:59:32 -0400 Subject: [PATCH] How to share model cards with the CLI (#5374) * How to share model cards * Switch the two options * Fix bad copy/cut * Julien's suggestion --- docs/source/model_sharing.rst | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) diff --git a/docs/source/model_sharing.rst b/docs/source/model_sharing.rst index eaef2ba8d..bdb11bc36 100644 --- a/docs/source/model_sharing.rst +++ b/docs/source/model_sharing.rst @@ -171,8 +171,11 @@ Add a model card ^^^^^^^^^^^^^^^^ To make sure everyone knows what your model can do, what its limitations and potential bias or ethetical -considerations, please add a README.md model card to the 🤗 Transformers repo under `model_cards/`. It should be named -`README.md` and follow `this template `__. +considerations, please add a README.md model card to the 🤗 Transformers repo under `model_cards/`. It should then be +placed in a subfolder with your username or organization, then another subfolder named like your model +(`awesome-name-you-picked`). Or just click on the "Create a model card on GitHub" button on the model page, it will +get you directly to the right location. If you need one, `here `__ is a +model card template (meta-suggestions are welcome). If your model is fine-tuned from another model coming from the model hub (all 🤗 Transformers pretrained models do), don't forget to link to its model card so that people can fully trace how your model was built. @@ -180,6 +183,11 @@ don't forget to link to its model card so that people can fully trace how your m If you have never made a pull request to the 🤗 Transformers repo, look at the :doc:`contributing guide ` to see the steps to follow. +.. Note:: + + You can also send your model card in the folder you uploaded with the CLI by placing it in a `README.md` file + inside `path/to/awesome-name-you-picked/`. + Using your model ^^^^^^^^^^^^^^^^