Skip to content
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

Merged
merged 10 commits into from
Aug 7, 2021

Conversation

julien-c
Copy link
Member

@julien-c julien-c commented Aug 6, 2021

⚠️ Warning: I got a little carried away with the 7d1d7c9 commit (😂), as it may very well break stuff in moon-landing, and it will require others JS-codebase PRs (like @mishig25's) to be rebased.

Let's see if maybe we want to split that change into a different PR

@julien-c
Copy link
Member Author

julien-c commented Aug 6, 2021

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!

@julien-c julien-c requested a review from elishowk August 6, 2021 12:03
@julien-c
Copy link
Member Author

julien-c commented Aug 6, 2021

CI is flakier than flakes but i've managed to spam it enough that it now passes 🔫

@julien-c julien-c requested a review from Pierrci August 6, 2021 12:21
Copy link
Member

@LysandreJik LysandreJik left a 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.

Copy link
Member

@osanseviero osanseviero left a 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:
Copy link
Member

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

Copy link
Member Author

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

Copy link
Member Author

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

@julien-c julien-c merged commit 63cc65d into main Aug 7, 2021
@julien-c julien-c deleted the doc_tweak_metadata branch August 7, 2021 17:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants