huggingface / hub-docs

Docs of the Hugging Face Hub
http://hf.co/docs/hub
Apache License 2.0
303 stars 254 forks source link

[hacktoberfest] Model `license:other` challenge #985

Closed Wauplin closed 1 year ago

Wauplin commented 1 year ago

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 commented 1 year ago

@Wauplin can you assign me this issue with hacktoberfest label

thanktua-spp commented 1 year ago

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 commented 1 year ago

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

Wauplin commented 1 year ago

@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 commented 1 year ago

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 commented 1 year ago

thankyou! this worked.

pksX01 commented 1 year ago

@Wauplin Could you please review this PR #1001 .

Wauplin commented 1 year ago

@Wauplin Could you please review this PR #1001 .

Yes for sure! Thanks for your contribution :hugs:

shreyashkar-ml commented 1 year ago

@Wauplin could you please review this PR #1009

Wauplin commented 1 year ago

@Wauplin could you please review this PR #1009

Sure, of course! PR approved and merged :tada: Thank you for opening it :hugs:

Ashish-Soni08 commented 1 year ago

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

Wauplin commented 1 year ago

Hey @Wauplin, Hope you are doing great! Could you please review this PR https://github.com/huggingface/hub-docs/pull/1054

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

Ashish-Soni08 commented 1 year ago

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

Wauplin commented 1 year ago

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

Ashish-Soni08 commented 1 year ago

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

Wauplin commented 1 year ago

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