-
Notifications
You must be signed in to change notification settings - Fork 2.7k
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
Update DatasetMetadata and ReadMe #2436
Merged
lhoestq
merged 17 commits into
huggingface:master
from
gchhablani:update_dataset_metadata
Jun 14, 2021
Merged
Update DatasetMetadata and ReadMe #2436
lhoestq
merged 17 commits into
huggingface:master
from
gchhablani:update_dataset_metadata
Jun 14, 2021
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
gchhablani
changed the title
[WIP] Update DatasetMetadata
[WIP] Update DatasetMetadata and ReadMe
Jun 1, 2021
gchhablani
changed the title
[WIP] Update DatasetMetadata and ReadMe
Update DatasetMetadata and ReadMe
Jun 8, 2021
lhoestq
reviewed
Jun 10, 2021
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you !
Could you rename pretty_names to pretty_name ?
Other than that it looks all good to me :)
lhoestq
approved these changes
Jun 14, 2021
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks a lot ! Merging ^^
JayantGoel001
added a commit
to JayantGoel001/datasets-1
that referenced
this pull request
Jun 14, 2021
Update DatasetMetadata and ReadMe (huggingface#2436)
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.
This PR contains the changes discussed in #2395.
Edit:
In addition to those changes, I'll be updating the
ReadMe
as follows:Currently,
Section
has separate parsing and validation error lists. In.validate()
, we add these lists to the final lists and throw errors.One way to make
ReadMe
consistent withDatasetMetadata
and add a separate.validate()
method is to throw separate parsing and validation errors.This way, we don't have to throw validation errors, but only parsing errors in
__init__ ()
. We can have an option in__init__()
to suppress parsing errors so that an object is created for validation. Doing this will allow the user to get all the errors in one go.In
test_dataset_cards
, we are already catching error messages and appending to a list. This can be done forReadMe()
for parsing errors, andReadMe(...,suppress_errors=True); readme.validate()
for validation, separately.Edit 2:
The only parsing issue we have as of now is multiple headings at the same level with the same name. I assume this will happen very rarely, but it is still better to throw an error than silently pick one of them. It should be okay to separate it this way.
Wdyt @lhoestq ?