docs(datasets) Add dataset contribution guide #4601
+63
−0
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
adam-narozniak
requested review from
jafermarq,
tanertopal and
danieljanes
as code owners
jafermarq
reviewed
Nov 29, 2024
There was a problem hiding this comment.
Hey @adam-narozniak , it looks pretty good. I like the inclusion of a mini example at the bottom. Some comments below to move some text around a bit.
|
|
||
| 1. Create the dataset locally. | ||
|
|
||
| We recommend that you do not upload custom scripts to HuggingFace Hub; instead, create the dataset locally and upload the data, which will speed up the processing time each time the data set is downloaded. |
There was a problem hiding this comment.
useful info, how about having it as a :: tip: right under the Creating a datasets locally section?
|
|
||
| 2. Contribute to HuggingFace Hub. | ||
|
|
||
| Each dataset in the HF Hub is a Git repository with a specific structure and readme file, and HuggingFace provides an API to push the dataset and, alternatively, a user interface directly in the website to populate the information in the readme file. |
There was a problem hiding this comment.
I'd move this as a mini introduction to the Contribution to the HuggingFace Hub section. It's good
Co-authored-by: Javier <jafermarq@users.noreply.github.com>
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.
No description provided.