docs(datasets) Add info about dataset availability to FDS docs #3902
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
Jul 24, 2024
datasets/doc/source/index.rst
Outdated
| - **partitioning datasets** - choose one of the implemented partitioning scheme or create your own. | ||
| - **creating centralized datasets** - leave parts of the dataset unpartitioned (e.g. for centralized evaluation) | ||
| - **visualization of the partitioned datasets** - visualize the label distribution of the partitioned dataset (and compare the results on different parameters of the same partitioning schemes, different datasets, different partitioning schemes, or any mix of them) | ||
|
|
||
| (*) Note that once the dataset is available on HuggingFace Hub it can be **immediately** used in `Flower Datasets` (no approval from Flower team needed, no custom code needed). |
There was a problem hiding this comment.
How about if we put his earlier (maybe soon after Main feature?) as a sphinx note?:
.. note::
Note that once the dataset is available on HuggingFace Hub it can be **immediately** used in `Flower Datasets` (no approval from Flower team needed, no custom code needed).
There was a problem hiding this comment.
To me, it seems a bit less important (compared to other features). It seems like a great addition or side effects. Wdyt?
I'll change it to a "note"
jafermarq
approved these changes
Jul 25, 2024
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.
Issue
The FDS description lacks info about how the HF Hub dataset availability relates to the dataset usage in FDS.
Proposal
Add that information to emphasise the benefits of Flower Datasets.