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

Improve docs of model card evaluation data #1109

Open
osanseviero opened this issue Nov 20, 2023 · 1 comment
Open

Improve docs of model card evaluation data #1109

osanseviero opened this issue Nov 20, 2023 · 1 comment
Assignees

Comments

@osanseviero
Copy link
Member

Section https://huggingface.co/docs/hub/model-cards#evaluation-results

@Wauplin
Copy link
Contributor

Wauplin commented Nov 20, 2023

Related to (internal) slack message (cc @julien-c):

maybe it's worth it improving https://huggingface.co/docs/hub/model-cards#evaluation-results slighlty, which is not currently great?

  • the model-index i.E. the only interesting part is missing from the snippet
  • the screenshot is ok but the part on the left could be the actual model-index metadata? (here it looks like it's linking from a JSON?)
  • maybe mention that the spec is originally by Papers with code?

From @Wauplin:

Also link (and improve) this doc: https://huggingface.co/docs/huggingface_hub/guides/model-cards#include-evaluation-results. huggingface_hub should make it easy to add eval results to an existing model card but it's not well documented.

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

No branches or pull requests

2 participants