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

Clarify what "More Resources" is by breaking it into its parts. #1238

Merged
merged 4 commits into from
Dec 7, 2022

Conversation

meg-huggingface
Copy link
Contributor

This also helps distinguish it from the "More Information" section. It adds the jinja variables demo, paper, and repo. See discussion at:
https://huggingface.slack.com/archives/C025H22A3ND/p1669923069281609

This also helps distinguish it from the "More Information" section.
It adds the jinja variables `demo`, `paper`, and `repo`.
See discussion at:
https://huggingface.slack.com/archives/C025H22A3ND/p1669923069281609
@HuggingFaceDocBuilderDev
Copy link

HuggingFaceDocBuilderDev commented Dec 1, 2022

The documentation is not available anymore as the PR was closed or merged.

@Wauplin
Copy link
Contributor

Wauplin commented Dec 2, 2022

Hi @meg-huggingface thanks for opening the PR. I have read the related slack conversation.

I am not against removing More resources without a deprecation cycle as it wouldn't break existing code. But if you don't mind could we still keep it as a other section ? Something like:

- **Repository:** {{ repo | default("[More Information Needed]", true)}}
- **Paper [optional]:** {{ paper | default("[More Information Needed]", true)}}
- **Demo [optional]:** {{ demo | default("[More Information Needed]", true)}}
{% if more_resources is defined and more_resources|length %}
- **Other [optional]:** {{ more_resources)}
{% endif %}

By default (and for most model cards) the "other" section will not be displayed. But if the field is already used by some users, the more_resources value will not be ignored. WDYT ? (cc @nateraw as well).

Beside that, could you update ./docs/source/how-to-model-cards.mdx ? There are 2 occurrences of more_resources that need to be changed.

@EziOzoani
Copy link
Contributor

For your last point @Wauplin do you mean this doc ??

@Wauplin
Copy link
Contributor

Wauplin commented Dec 2, 2022

For your last point @Wauplin do you mean this doc ??

No I meant this page that is then rendered here. In the example in the documentation we use more_resources=https://github.com/huggingface/huggingface_hub. It should be updated to have demo=... for example (as more_resources is deprecated)

@meg-huggingface
Copy link
Contributor Author

meg-huggingface commented Dec 7, 2022

Hi @meg-huggingface thanks for opening the PR. I have read the related slack conversation.

I am not against removing More resources without a deprecation cycle as it wouldn't break existing code. But if you don't mind could we still keep it as a other section ? Something like:

- **Repository:** {{ repo | default("[More Information Needed]", true)}}
- **Paper [optional]:** {{ paper | default("[More Information Needed]", true)}}
- **Demo [optional]:** {{ demo | default("[More Information Needed]", true)}}
{% if more_resources is defined and more_resources|length %}
- **Other [optional]:** {{ more_resources)}
{% endif %}

By default (and for most model cards) the "other" section will not be displayed. But if the field is already used by some users, the more_resources value will not be ignored. WDYT ? (cc @nateraw as well).

Beside that, could you update ./docs/source/how-to-model-cards.mdx ? There are 2 occurrences of more_resources that need to be changed.

I'll change to Other, but I do wonder if anyone is actually using the more_resources tag? My impression is that these newer categories really aren't being used, so there isn't as much of an issue with changing (or removing). I'm happy to do the Other for now, but would like to ideally deprecate it if we find that tag hasn't been used yet by people other than us.

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.

Good to go !

@Wauplin Wauplin merged commit 465812d into main Dec 7, 2022
@Wauplin Wauplin deleted the meg-huggingface-patch-2 branch December 7, 2022 09:19
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.

4 participants