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

add COMET to model-libraries.ts #1219

Merged
merged 6 commits into from
Feb 26, 2025
Merged

add COMET to model-libraries.ts #1219

merged 6 commits into from
Feb 26, 2025

Conversation

zouharvi
Copy link
Contributor

COMET is a very popular machine translation quality estimation framework. However, downloads can't be tracked as of now.

Copy link
Member

@Vaibhavs10 Vaibhavs10 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @zouharvi - thanks a lot for your PR! I was wondering if it's possible for you to change the file-name upstream to one of the recognised file-names here: https://huggingface.co/docs/hub/en/models-download-stats#which-are-the-query-files-for-different-libraries

This way the downloads would automatically work for your repos - and this way we don't need another custom download rule for the library.

In anyway - you'd need to make sure that the repos have the COMET tag and show up here: https://huggingface.co/models?other=COMET before the merge (this is the only way downloads would be tracked)

@zouharvi
Copy link
Contributor Author

Hi, thanks for reply. My repos are following the file layout as needed by the COMET library (https://github.com/Unbabel/COMET/), so I can't change them.

I didn't add the COMET tag because the library is not being tracked yet.

Copy link
Contributor

@Wauplin Wauplin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

As mentioned by @Vaibhavs10 , we prefer to have at least a few models listed under https://huggingface.co/models?other=comet before making it official. You simply have to add library_name: comet to the modelcard metadata (or under tags if repo already have a library_name).

@zouharvi Would you mind updating your model cards and opening a few PRs on main COMET repos to add this metadata? That is a very good opportunity to make sure COMET models are easily discoverable on the Hub!


Note: failing tests are unrelated.

@Wauplin
Copy link
Contributor

Wauplin commented Feb 26, 2025

Here is an example PR I've opened in the past to a repo I didn't own in order to add library_name: https://huggingface.co/MCG-NJU/VFIMamba_S/discussions/1. It's usually good to provide context and link to this PR so that the repo owner understand why the change is needed :)

@zouharvi
Copy link
Contributor Author

zouharvi commented Feb 26, 2025

@Wauplin
Copy link
Contributor

Wauplin commented Feb 26, 2025

Perfect, thanks! I'll merge once the lint CI is green :)
Expect a 3-4 days before having it live on production.

@Wauplin Wauplin merged commit d77f15e into huggingface:main Feb 26, 2025
4 checks passed
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.

3 participants