Skip to content

Dataset card template overhaul#1708

Merged
Wauplin merged 6 commits into
mainfrom
update-datasetcard-template
Oct 10, 2023
Merged

Dataset card template overhaul#1708
Wauplin merged 6 commits into
mainfrom
update-datasetcard-template

Conversation

@mariosasko

@mariosasko mariosasko commented Oct 3, 2023 •
edited
Loading

Copy link
Copy Markdown
Contributor

It seems to me that new model releases are more likely to have a filled-out (or fewer blank and "out-of-template" sections/fields) repo card than new dataset releases.
So, this PR introduces the following changes to the dataset card template to make working with it less cumbersome and improve the situation (hopefully):

  • Aligns the structure and section names with the model card template. Besides consistency, this should also mean less time is needed to write the repo cards for joint model-dataset releases
  • Adds (markdown) comments to the sections to make it clear what information a particular section expects
  • Removes unnecessary/outdated sections (e.g., the viewer displays data samples, value statistics/ranges, split sizes, and more, so we can simplify the Dataset Structure section) and fields (e.g., homepage, leaderboard, etc.)

@HuggingFaceDocBuilderDev

HuggingFaceDocBuilderDev commented Oct 3, 2023 •
edited
Loading

Copy link
Copy Markdown

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

@codecov

codecov Bot commented Oct 3, 2023 •
edited
Loading

Copy link
Copy Markdown

Codecov Report

All modified lines are covered by tests ✅

Comparison is base (90c1182) 82.30% compared to head (af900cc) 82.42%.

Additional details and impacted files 
@@            Coverage Diff             @@
##             main    #1708      +/-   ##
==========================================
+ Coverage   82.30%   82.42%   +0.12%     
==========================================
  Files          62       62              
  Lines        7226     7226              
==========================================
+ Hits         5947     5956       +9     
+ Misses       1279     1270       -9

see 3 files with indirect coverage changes

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@mariosasko
mariosasko requested review from julien-c and lhoestq October 3, 2023 23:03
julien-c
julien-c reviewed Oct 4, 2023
View reviewed changes
Comment thread src/huggingface_hub/templates/modelcard_template.md

### Training Data

<!-- This should link to a Data Card, perhaps with a short stub of information on what the training data is all about as well as documentation related to data pre-processing or additional filtering. -->

@julien-c julien-c Oct 4, 2023

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

julien-c
julien-c reviewed Oct 4, 2023
View reviewed changes

@julien-c julien-c left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

looks good to me from a super quick glance

I assume you have checked it still works in DatasetCard.from_template?

cc @EziOzoani @meg-huggingface too on dataset documentation. cc @yjernite too

Wauplin
Wauplin reviewed Oct 4, 2023
View reviewed changes

@Wauplin Wauplin left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for opening the PR @mariosasko! Looks good to me as well but from a non-expert point of view.

I posted a message in slack (private) as well. To ease the review, here are the actual files (I found it easier to review than the diff):

lhoestq
lhoestq reviewed Oct 4, 2023
View reviewed changes
Comment thread src/huggingface_hub/templates/datasetcard_template.md
@mariosasko

mariosasko commented Oct 4, 2023

Copy link
Copy Markdown
Contributor Author

@julien-c

I assume you have checked it still works in DatasetCard.from_template?

We have tests in tests/test_repocard.py that check this :)

meg-huggingface
meg-huggingface requested changes Oct 4, 2023
View reviewed changes

@meg-huggingface meg-huggingface left a comment •
edited
Loading

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great, thank you for this!!
Adding some minor changes in wording/spelling.

Comment thread src/huggingface_hub/templates/datasetcard_template.md
Comment thread src/huggingface_hub/templates/datasetcard_template.md Outdated
Comment thread src/huggingface_hub/templates/datasetcard_template.md Outdated
Comment thread src/huggingface_hub/templates/datasetcard_template.md Outdated
@mariosasko

mariosasko commented Oct 4, 2023

Copy link
Copy Markdown
Contributor Author

Ready for the final review :)!

(CI failures are unrelated to the changes)

meg-huggingface
meg-huggingface approved these changes Oct 6, 2023
View reviewed changes

@meg-huggingface meg-huggingface left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So happy for this, thanks for the work!

@Wauplin

Wauplin commented Oct 10, 2023

Copy link
Copy Markdown
Collaborator

Great, I'm merging it and will release it this week :)

@Wauplin
Wauplin merged commit 6dd7ee8 into main Oct 10, 2023
@Wauplin
Wauplin deleted the update-datasetcard-template branch October 10, 2023 09:53
Wauplin added a commit that referenced this pull request Oct 10, 2023
@mariosasko @meg-huggingface @Wauplin
Dataset card template overhaul (#1708)
147702b 
* Dataset card template overhaul

* Add Privacy Considerations subsection

* Apply suggestions from code review

Co-authored-by: meg <[email protected]>

* Address more comments

---------

Co-authored-by: meg <[email protected]>
Co-authored-by: Lucain <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@julien-c julien-c julien-c left review comments
@Wauplin Wauplin Wauplin left review comments
@meg-huggingface meg-huggingface meg-huggingface approved these changes
@lhoestq lhoestq Awaiting requested review from lhoestq

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

6 participants

@mariosasko @HuggingFaceDocBuilderDev @Wauplin @julien-c @lhoestq @meg-huggingface