DOC User guide for model cards #70
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
adrinjalali
reviewed
Aug 2, 2022
docs/model_card.rst
Outdated
| leaderboard of the task and the dataset on `Papers with Code | ||
| <paperswithcode.com>`__. | ||
|
|
||
| Metadata part looks like below: |
There was a problem hiding this comment.
what are the parts which are important for a scikit-learn model repo?
There was a problem hiding this comment.
Thanks for writing this. Overall, it already reads quite well. I believe there are some possible improvements though. Apart from what Adrin wrote, I could see e.g. a bit more elaboration at the start about the intent of model cards, so that the reader knows what the goal is (perhaps a link to existing docs would be enough).
Co-authored-by: Benjamin Bossan <BenjaminBossan@users.noreply.github.com>
BenjaminBossan
requested changes
Aug 4, 2022
Co-authored-by: Benjamin Bossan <BenjaminBossan@users.noreply.github.com>
Co-authored-by: Benjamin Bossan <BenjaminBossan@users.noreply.github.com>
Co-authored-by: Benjamin Bossan <BenjaminBossan@users.noreply.github.com>
BenjaminBossan
approved these changes
Aug 8, 2022
Co-authored-by: Benjamin Bossan <BenjaminBossan@users.noreply.github.com>
adrinjalali
approved these changes
Aug 9, 2022
adrinjalali
changed the title
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Added user guide for model cards.