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.

Sign up for GitHub

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

docs(datasets) Add info about dataset availability to FDS docs #3902

Merged
merged 5 commits into from
Jul 25, 2024
Merged

docs(datasets) Add info about dataset availability to FDS docs #3902

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
e740899
Add info about dataset availability to FDS docs
adam-narozniak Jul 24, 2024
778c0e1
Update datasets/doc/source/index.rst
adam-narozniak Jul 24, 2024
750dc1d
Merge branch 'main' into add-info-about-dataset-availability-to-fds-docs
jafermarq Jul 24, 2024
890fe62
Add rst specific note
adam-narozniak Jul 25, 2024
9470990
Merge branch 'main' into add-info-about-dataset-availability-to-fds-docs
jafermarq Jul 25, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 8 additions & 4 deletions datasets/doc/source/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,10 +67,14 @@ Main features
-------------
Flower Datasets library supports:

- **downloading datasets** - choose the dataset from Hugging Face's ``dataset`` (`link <https://huggingface.co/datasets>`_)
- **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)
- **Downloading datasets** - choose the dataset from Hugging Face's ``dataset`` (`link <https://huggingface.co/datasets>`_)(*)
- **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::

(*) Once the dataset is available on HuggingFace Hub it can be **immediately** used in ``Flower Datasets`` (no approval from the Flower team needed, no custom code needed).


.. image:: ./_static/readme/comparison_of_partitioning_schemes.png
Expand Down