Unverified Commit 0607b889 authored by Sylvain Gugger's avatar Sylvain Gugger Committed by GitHub
Browse files

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
parent 331d8d29
...@@ -171,8 +171,11 @@ Add a model card ...@@ -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 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 considerations, please add a README.md model card to the 🤗 Transformers repo under `model_cards/`. It should then be
`README.md` and follow `this template <https://github.com/huggingface/model_card>`__. 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 <https://github.com/huggingface/model_card>`__ 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), 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. 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 ...@@ -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 If you have never made a pull request to the 🤗 Transformers repo, look at the
:doc:`contributing guide <contributing>` to see the steps to follow. :doc:`contributing guide <contributing>` 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 Using your model
^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment