Skip to content

Conversation

@egrace479
Copy link
Member

This update to Hugging Face repo guidance includes clarifying that

  • there is no license file to include, but there are specific codes to be included in the yaml of the dataset/model cards
  • datasets have different license types from models and software (including update in the template)
    • Choose A License was kept in the dataset card templates since they do include a "My project isn’t software." link.
  • the digital product policy should be referenced for appropriate licensing

Additionally, 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.

@egrace479 egrace479 requested review from gwtaylor and hlapp January 24, 2026 00:22
@egrace479 egrace479 added documentation Improvements or additions to documentation structure Refactoring or architecture, general code organization labels Jan 24, 2026
Copy link
Member

@hlapp hlapp left a 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?

@hlapp
Copy link
Member

hlapp commented Jan 24, 2026

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.

@egrace479
Copy link
Member Author

@hlapp, that's a good idea for clarification on HF not reading the file either. In terms of the linting, the templates weren't meant to be run through (it's a bug, being fixed in #53).

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.
Copy link
Collaborator

@gwtaylor gwtaylor left a 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.

@egrace479 egrace479 merged commit e4c51be into main Jan 28, 2026
1 check passed
@egrace479 egrace479 deleted the hf-update branch January 28, 2026 18:17
egrace479 added a commit to Imageomics/Imageomics-guide that referenced this pull request Jan 29, 2026
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>
egrace479 added a commit to ABC-Center/ABC-guide that referenced this pull request Jan 29, 2026
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>
egrace479 added a commit to ABC-Center/ABC-guide that referenced this pull request Jan 29, 2026
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>
egrace479 added a commit to Imageomics/Imageomics-guide that referenced this pull request Jan 29, 2026
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>
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 structure Refactoring or architecture, general code organization

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Update HF Repo Guide

4 participants