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

[hacktoberfest] Model license:other challenge #985

Closed
Wauplin opened this issue Oct 2, 2023 · 16 comments
Closed

[hacktoberfest] Model license:other challenge #985

Wauplin opened this issue Oct 2, 2023 · 16 comments
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@Wauplin
Copy link
Contributor

Wauplin commented Oct 2, 2023

Issue to keep track of the "Model license:other challenge" for the Hacktoberfest 2023.

Context

The Hugging Face Hub hosts hundreds of thousands of public models and datasets. Public doesn't necessarily mean open-source without any limitations. Authors can define which license applies to the work they share (e.g. MIT, Apache2.0, OpenRAIL, etc.). All users must be able to quickly know which license applies to which model and even to list models with a specific license (e.g. Apache2.0). The Hub relies on the Model Card to do so. A Model Card is a file attached to a model providing handy information. They are essential for discoverability, reproducibility and sharing. In our case, we will focus on the metadata section of the Model Card. This metadata contains valuable information, including a license tag.

In this challenge, we will focus on models that has the license "other". This means that the model has a custom license defined by the author. For example, models from Coqui have their own coqui-public-model-license. Historically, this information was not available in the model card metadata. This is now possible by adding the license name and a URL to it:

# Example from https://huggingface.co/coqui/XTTS-v1
---
license: other
license_name: coqui-public-model-license
license_link: https://coqui.ai/cpml
---

Instructions

Check out the instructions details here.

Feel free to ping @davanstrien or @Wauplin for any question or review.

@ayan-joshi
Copy link

@Wauplin can you assign me this issue with hacktoberfest label

thanktua-spp added a commit to thanktua-spp/hub-docs that referenced this issue Oct 3, 2023
Hi guys!

I opened my first PRs for huggingface#985 - Just want to be sure I did that 1 right, I will be updating the model card license for a lot more models now that I have broken the ice.
@thanktua-spp
Copy link
Contributor

Hi @Wauplin, I completed a task to update a model license but am unable to update the License List. Can you please help? Many thanks

@stefan-it
Copy link
Contributor

@Wauplin could you please label this issue also with a hacktoberfest label 🤗

@Wauplin
Copy link
Contributor Author

Wauplin commented Oct 4, 2023

@Wauplin can you assign me this issue with hacktoberfest label

@Wauplin could you please label this issue also with a hacktoberfest label 🤗

Yes! Sorry for the confusion. We just tagged to whole repo as "hacktoberfest" so participation to any PR/issue should not be counted correctly (might need a few hours delay to appear on https://hacktoberfest.com/).

@Wauplin
Copy link
Contributor Author

Wauplin commented Oct 4, 2023

I completed a task to update a model license but am unable to update the License List. Can you please help? Many thanks

@thanktua-spp Thank you! You should be able to open a PR on the License list by going to and clicking on the little pen in the top right corner. It will let you contribute and open a PR on this repo (you must be logged in with Github). In the PR you should update the line that you've done with status and pr_url:
Example: | Merged | [here](link to your PR) (by @ayan-joshi) | ...

image

@thanktua-spp
Copy link
Contributor

thankyou! this worked.

@pksX01
Copy link
Contributor

pksX01 commented Oct 6, 2023

@Wauplin Could you please review this PR #1001 .

@Wauplin
Copy link
Contributor Author

Wauplin commented Oct 6, 2023

@Wauplin Could you please review this PR #1001 .

Yes for sure! Thanks for your contribution 🤗

Wauplin added a commit that referenced this issue Oct 6, 2023
* Update model_license_other.md

Hi guys!

I opened my first PRs for #985 - Just want to be sure I did that 1 right, I will be updating the model card license for a lot more models now that I have broken the ice.

* Update hacktoberfest_challenges/model_license_other.md

---------

Co-authored-by: Lucain <[email protected]>
@shreyashkar-ml
Copy link
Contributor

@Wauplin could you please review this PR #1009

@Wauplin
Copy link
Contributor Author

Wauplin commented Oct 10, 2023

@Wauplin could you please review this PR #1009

Sure, of course! PR approved and merged 🎉 Thank you for opening it 🤗

@Ashish-Soni08
Copy link
Contributor

Hey @Wauplin, Hope you are doing great! Could you please review this PR #1054

@Wauplin
Copy link
Contributor Author

Wauplin commented Oct 27, 2023

Hey @Wauplin, Hope you are doing great! Could you please review this PR #1054

Yes of course! Thanks for opening the PR 🙏
I just merged it so congratulation for this first contribution on HF 🤗

@Ashish-Soni08
Copy link
Contributor

@Wauplin Last ones #1055, #1056 , #1057, #1058, #1059, #1060, #1061.
thank you for your time :)

@Wauplin
Copy link
Contributor Author

Wauplin commented Oct 30, 2023

Wow, you were on fire @Ashish-Soni08! 🔥 🔥 🔥 I merged 4 of them and commented on 3 others. Thanks a lot!!

@Ashish-Soni08
Copy link
Contributor

Thank you @Wauplin. I made the required/suggested changes to 2 and closed 1, in the ones that are left.

@Wauplin
Copy link
Contributor Author

Wauplin commented Oct 30, 2023

Perfect! 6 merged, 1 closed then. Thanks again! :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

8 participants