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

[model_cards] Migrate cards from this repo to model repos on huggingface.co #9013

Merged
merged 8 commits into from Dec 11, 2020

Conversation

julien-c
Copy link
Member

@julien-c julien-c commented Dec 9, 2020

Fellow reviewers/contributors, please take a look at the documentation part and let me know your thoughts.


⚠️ Still to-do before merging ⚠️

ETA: I plan on doing this Thursday (Dec 10) or Friday (Dec 11)!

@sgugger it is still not super crystal clear/streamlined so let me know if any ideas to make it simpler
Comment on lines 103 to 104
The only learning curve you might have compared to regular git is the one for git-lfs. The documentation at
https://git-lfs.github.com/ is decent, but we'll work on a tutorial with some tips and tricks in the coming weeks!
Copy link
Member Author

Choose a reason for hiding this comment

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

cc @Pierrci (with stuff like how to get a progress bar when cloning, etc.)

@julien-c julien-c added the model card Related to pretrained model cards label Dec 9, 2020
@julien-c julien-c requested a review from Pierrci December 9, 2020 20:38
docs/source/model_sharing.rst Outdated Show resolved Hide resolved
docs/source/model_sharing.rst Outdated Show resolved Hide resolved

The only learning curve you might have compared to regular git is the one for git-lfs. The documentation at
https://git-lfs.github.com/ is decent, but we'll work on a tutorial with some tips and tricks in the coming weeks!
Copy link
Collaborator

Choose a reason for hiding this comment

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

Make a link.

card template (meta-suggestions are welcome).
To make sure everyone knows what your model can do, what its limitations and potential bias or ethical considerations,
please add a README.md model card to your model repo. You can just create it, or there's also a convenient button
titled "Add a README.md" on your model page. If you need one, `here <https://github.com/huggingface/model_card>`__ is a
Copy link
Contributor

Choose a reason for hiding this comment

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

It's currently called "Add readme" I think (the button)

Copy link
Contributor

@patrickvonplaten patrickvonplaten left a comment

Choose a reason for hiding this comment

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

Awesome this will make git clone so much faster :D

We should also delete the "Update/Create on github" model card button

@sgugger
Copy link
Collaborator

sgugger commented Dec 10, 2020

@patrickvonplaten, unless we erase them from the history, it won't make git clone any faster.

@julien-c
Copy link
Member Author

@sgugger it might make a git checkout slightly faster. I don't think the model cards were ever an issue in terms of git performance though (8% of number of files in the repo, 7% of total size of the repo)

@julien-c
Copy link
Member Author

https://github.com/github/git-sizer is an awesome tool by the way

$ git-sizer
Processing blobs: 22486                        
Processing trees: 25585                        
Processing commits: 7749                        
Matching commits to trees: 7749                        
Processing annotated tags: 33                        
Processing references: 216                        
| Name                         | Value     | Level of concern               |
| ---------------------------- | --------- | ------------------------------ |
| Biggest checkouts            |           |                                |
| * Maximum path length    [1] |   135 B   | *                              |

[1]  030c0d2cdc80cf8dcf23a6ee55c20e979548a181 (refs/heads/master^{tree})

vs on datasets (cc @lhoestq):

$ git-sizer
Processing blobs: 9449                        
Processing trees: 12905                        
Processing commits: 1245                        
Matching commits to trees: 1245                        
Processing annotated tags: 16                        
Processing references: 110                        
| Name                         | Value     | Level of concern               |
| ---------------------------- | --------- | ------------------------------ |
| Biggest objects              |           |                                |
| * Blobs                      |           |                                |
|   * Maximum size         [1] |  17.8 MiB | *                              |
|                              |           |                                |
| Biggest checkouts            |           |                                |
| * Number of directories  [2] |  4.89 k   | **                             |
| * Maximum path depth     [3] |    16     | *                              |
| * Maximum path length    [3] |   231 B   | **                             |

[1]  3fe8eaab7a337ea2a8d06daa5721fc5935ba3098 (75cafce7677d6f66c49c34e43cfbc425e1f50d30:datasets/anli/dummy/plain_text/0.1.0/dummy_data.zip)
[2]  681c565a3d8f63535823a1d33438c2b76ba3c706 (refs/heads/master^{tree})
[3]  c94ea70f34be4ed2723fc1c647340792ba03879c (7cd045237bb77f3b32877d31aae87789ec57ffab^{tree})

@julien-c
Copy link
Member Author

Update: I deployed the new buttons/call to actions on the model pages.
I also created a new Forum topic (@sgugger @Pierrci @patrickvonplaten) titled "Model cards" where users can suggest edits or creations of existing model cards, in case they don't have write access to the corresponding model repo:

https://discuss.huggingface.co/t/about-the-model-cards-category/2777

Copy link
Member

@LysandreJik LysandreJik left a comment

Choose a reason for hiding this comment

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

Cool! Good to me for merge after Sylvain's and Patrick's comments

@julien-c
Copy link
Member Author

All out-standing model card PRs were merged. No more model cards PRs expected!

Will migrate existing ones now.

Co-authored-by: Sylvain Gugger <35901082+sgugger@users.noreply.github.com>
julien-c and others added 2 commits December 11, 2020 18:50
Co-authored-by: Sylvain Gugger <35901082+sgugger@users.noreply.github.com>
Co-authored-by: Patrick von Platen <patrick.v.platen@gmail.com>
@julien-c julien-c marked this pull request as ready for review December 11, 2020 23:20
@julien-c julien-c merged commit 3552d0e into master Dec 11, 2020
@julien-c julien-c deleted the migrate-model-cards branch December 11, 2020 23:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants