-
Notifications
You must be signed in to change notification settings - Fork 0
Clarify license and citation guidance for Hugging Face #51
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
Conversation
clear up confusion over need for file or use of MIT license for datasets
aligns with repo guide page clarification
still a good reference for both datasets and models
hlapp
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks fine. My only comment is to possibly using a more accurate term for required in the statement "Unlike in GitHub, a LICENSE.md file is not required". I think it's not only not required, but even if one is there, the UI and API won't use it to extract license information. So perhaps something more like "Unlike in GitHub, a LICENSE.md file is not required, and even if present will not be used by HF to determine license information." Or use not supported instead of not required?
|
And BTW I would leave the markdown lint complaints alone, and move any edits you want to make to appease it into their own PR. |
include also the links to the repo card templates
Remove extra opening parenthesis in the Digital Products Release and Licensing Policy link that broke the markdown rendering. Also fix "eg." to "e.g." on the same line for correctness.
gwtaylor
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I pushed a fix for a broken markdown link on line 20 of HF_DatasetCard_Template_Imageomics.md. There was an extra opening parenthesis in the Digital Products Release and Licensing Policy URL that broke the link rendering. I also corrected eg. to e.g. on that same line since both forms appeared side by side.
On the topic of eg. vs e.g.: this inconsistency exists across many files in the project. I've opened #54 to track a global fix separately.
Otherwise, LGTM: the licensing clarifications and dataset vs. model distinction look good.
Pull from Collab Guide [PR 51](Imageomics/Collaborative-distributed-science-guide#51) * Clarify license section, include link to policy clear up confusion over need for file or use of MIT license for datasets * Remove 'Imageomics' in front of policy, no need for that specification here * Add pro-tip to use data/model card checklists * Clarify license recommendations/references in templates aligns with repo guide page clarification * Add citation clarification in note under standard files * Add choose-a-license link back in still a good reference for both datasets and models * Clarify license not supported, as it's more about how the system works include also the links to the repo card templates * fix: correct broken link and abbreviation in dataset card template Remove extra opening parenthesis in the Digital Products Release and Licensing Policy link that broke the markdown rendering. Also fix "eg." to "e.g." on the same line for correctness. --------- Co-authored-by: Graham Taylor <gwtaylor@gmail.com>
Pull from Collab Guide [PR 51](Imageomics/Collaborative-distributed-science-guide#51) * Clarify license section, include link to policy clear up confusion over need for file or use of MIT license for datasets * Remove 'Imageomics' in front of policy, no need for that specification here * Add pro-tip to use data/model card checklists * Clarify license recommendations/references in templates aligns with repo guide page clarification * Add citation clarification in note under standard files * Add choose-a-license link back in still a good reference for both datasets and models * Clarify license not supported, as it's more about how the system works include also the links to the repo card templates * fix: correct broken link and abbreviation in dataset card template Remove extra opening parenthesis in the Digital Products Release and Licensing Policy link that broke the markdown rendering. Also fix "eg." to "e.g." on the same line for correctness. --------- Co-authored-by: Graham Taylor <gwtaylor@gmail.com>
Pull from Collab Guide [PR 51](Imageomics/Collaborative-distributed-science-guide#51) * Clarify license section, include link to policy clear up confusion over need for file or use of MIT license for datasets * Remove 'Imageomics' in front of policy, no need for that specification here * Add pro-tip to use data/model card checklists * Clarify license recommendations/references in templates aligns with repo guide page clarification * Add citation clarification in note under standard files * Add choose-a-license link back in still a good reference for both datasets and models * Clarify license not supported, as it's more about how the system works include also the links to the repo card templates * fix: correct broken link and abbreviation in dataset card template Remove extra opening parenthesis in the Digital Products Release and Licensing Policy link that broke the markdown rendering. Also fix "eg." to "e.g." on the same line for correctness. --------- Co-authored-by: Graham Taylor <gwtaylor@gmail.com>
Pull from Collab Guide [PR 51](Imageomics/Collaborative-distributed-science-guide#51) * Clarify license section, include link to policy clear up confusion over need for file or use of MIT license for datasets * Remove 'Imageomics' in front of policy, no need for that specification here * Add pro-tip to use data/model card checklists * Clarify license recommendations/references in templates aligns with repo guide page clarification * Add citation clarification in note under standard files * Add choose-a-license link back in still a good reference for both datasets and models * Clarify license not supported, as it's more about how the system works include also the links to the repo card templates * fix: correct broken link and abbreviation in dataset card template Remove extra opening parenthesis in the Digital Products Release and Licensing Policy link that broke the markdown rendering. Also fix "eg." to "e.g." on the same line for correctness. --------- Co-authored-by: Graham Taylor <gwtaylor@gmail.com>
This update to Hugging Face repo guidance includes clarifying that
yamlof the dataset/model cardsAdditionally, pointers to the data and model card templates were added on the template pages.
Any changes to gitignore guidance should likely be included as part of #44 (see note).
This PR closes #46.