-
Notifications
You must be signed in to change notification settings - Fork 470
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Clarify/specify/document model card metadata, model-index
, and pipeline/task types
#265
Conversation
On further thought the migration path is simple enough that I think this is reviewable/mergeable. Will still tag @mishig25, let me know if i shouldn't merge this when it's reviewed! |
CI is flakier than flakes but i've managed to spam it enough that it now passes 🔫 ✅ |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you for specifying the required/optional nature of elements in the modelcard.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This looks great to me, thanks for this!
@@ -246,7 +246,8 @@ The metadata held in model cards is the best way to supercharge your model. It i | |||
define tags for your library or framework, the type of model uploaded, the language, license, evaluation results, | |||
and more. | |||
|
|||
The full model card specification can be seen below: | |||
The full model card specification is [here](https://github.com/huggingface/huggingface_hub/blame/main/modelcard.md), it's also repeated below for convenience: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Do we really want to maintain the spec in two places? Maybe we can delete the one below to avoid obsolete content
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
yes i think it makes sense
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
i'll leave it for now but we can remove it later
Let's see if maybe we want to split that change into a different PR