Tips for Debugging Model Cards
I am no expert but have learned a few thingscheck your yaml front matter with this toolhttps://nodeca.github.io/js-yaml/if it says “expected a single document in the stream, but found more”Your yaml is valid, otherwise your yaml is invalid.likethisis validValid:---
language: 
- en
- zh
tags:
- translation
license: apache-2.0
---
### My fancy modelNo spaces before tags (like “-zh”) will make this invalid.More to come as I learn more!Also the website takes 3 minutes for new tags to be reflected.
2020-08-21T14:51:48Z
What tags can you add?---
language: "ISO 639-1 code for your language, or `multilingual`"
thumbnail: "url to a thumbnail used in social sharing"
tags:
- array
- of
- tags
license: "any valid license identifier"
datasets:
- array of dataset identifiers
metrics:
- array of metric identifiers
---
2020-09-17T19:34:38Z
This template is very unintutive for someone who just does it for the first time.I raised a bunch of questions here:https://github.com/huggingface/transformers/issues/7208I think it’d make things easier if we had:a complete template that shows a very perfect entry with multiple entries where array is expected/supporteda document that explains each field’s format and variations.Actually perhaps:I think it’d make things easier if we had:template with just fields and no valuesa complete demo template that shows a very perfect entry with multiple entries where array is expected/supporteda document that explains each field’s format and variations.currently the template is also an instruction document and it doesn’t work well.
2020-09-17T19:36:58Z
At the moment the most useful tool is a multi-line preview feature of grep. e.g. I wanted to find the format fordatasetsentry, so I did:grep -r -A2 datasets: model_cardsmodel_cards/asafaya/bert-mini-arabic/README.md:datasets:
model_cards/asafaya/bert-mini-arabic/README.md-- oscar
model_cards/asafaya/bert-mini-arabic/README.md-- wikipediathis assumes that the cards are all valid, so that you’re not copying an invalid format from an existing card.but no urls
2020-09-17T19:52:27Z
agreed! You could draft a template, send a PR and add julien as a reviewer.Then he could correct possible duckups.
2020-09-17T20:47:19Z
Surely it can be made better, but here is the initial attempt:github.com/huggingface/model_card[doc] Model card example, template and instructionshuggingface:master←stas00:templateopened08:45PM - 17 Sep 20 UTCstas00+228-8As discussed here: https://discuss.huggingface.co/t/tips-for-debugging-model-car…ds/814 this is a proposal which may make it easier to create model_cards.

This PR splits the all-in-one approach which is difficult to use into 3:

1.  a template with just fields and no values
2.  a complete demo template that shows a very perfect entry with multiple entries where array is expected/supported
3.  a document that explains each field’s format and variations.

Surely, what I made could use more work, but this is a start.
2020-09-18T07:30:26Z
stas:currently the template is also an instruction document and it doesn’t work well.I think just linking to a YAML tutorial would be enough here?Because in my opinion the dochereand inGitHub - huggingface/model_cardis pretty clear as is?Any way, we’ll have more validation built-in to the next version of the website.
2020-09-18T10:01:13Z
Slightly off-topic: I would like to raise the case to make model cards required when submitting a model to the hub. At least some basic information such as the language. If not given it is very hard, as a user, to find the model. I would expect fo find all relevant models when I look for the Dutch tag, but not all of those models have cards and thus cannot be found this way.Yes, it should be easy for people to upload new models but for the community’s sake it seems only fair that they also provide some information about those models.
2020-09-18T13:58:45Z
I think stas PR is better than current README because it shows working model cards.I read the README and still screwed up a number of times. It’s easy for me now to think it’s obvious but a mere 3 weeks ago it was very not obvious to me.
2020-09-18T14:32:25Z
I have already raised a request for a checklist herehttps://github.com/huggingface/transformers/issues/6762.
2020-09-18T15:05:02Z
Love it. Wholeheartedly agree!
2020-09-18T16:06:13Z
julien-c:Because in my opinion the dochereand inhttps://github.com/huggingface/model_cardis pretty clear as is?FWIW, I couldn’t figure it out from those 2 docs.