From e740899a907dc9f639135a5968d253a233cf6ccc Mon Sep 17 00:00:00 2001 From: Adam Narozniak Date: Wed, 24 Jul 2024 12:15:01 +0200 Subject: [PATCH 1/3] Add info about dataset availability to FDS docs --- datasets/doc/source/index.rst | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/datasets/doc/source/index.rst b/datasets/doc/source/index.rst index fcc7920711bf..9f9a3ac6124f 100644 --- a/datasets/doc/source/index.rst +++ b/datasets/doc/source/index.rst @@ -67,11 +67,13 @@ Main features ------------- Flower Datasets library supports: -- **downloading datasets** - choose the dataset from Hugging Face's ``dataset`` (`link `_) +- **downloading datasets** - choose the dataset from Hugging Face's ``dataset`` (`link `_)(*) - **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). + .. image:: ./_static/readme/comparison_of_partitioning_schemes.png :align: center From 778c0e13ee9389f70a6605d7f690c9111881daab Mon Sep 17 00:00:00 2001 From: Adam Narozniak <51029327+adam-narozniak@users.noreply.github.com> Date: Wed, 24 Jul 2024 17:17:21 +0200 Subject: [PATCH 2/3] Update datasets/doc/source/index.rst Co-authored-by: Javier --- datasets/doc/source/index.rst | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/datasets/doc/source/index.rst b/datasets/doc/source/index.rst index 9f9a3ac6124f..27bcc6f4a9a1 100644 --- a/datasets/doc/source/index.rst +++ b/datasets/doc/source/index.rst @@ -67,10 +67,10 @@ Main features ------------- Flower Datasets library supports: -- **downloading datasets** - choose the dataset from Hugging Face's ``dataset`` (`link `_)(*) -- **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 `_)(*) +- **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). From 890fe621e08e3182ec353c2ac6191cb8c24b765d Mon Sep 17 00:00:00 2001 From: Adam Narozniak Date: Thu, 25 Jul 2024 10:02:25 +0200 Subject: [PATCH 3/3] Add rst specific note --- datasets/doc/source/index.rst | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/datasets/doc/source/index.rst b/datasets/doc/source/index.rst index cdbfb8d49662..3302dd758dd6 100644 --- a/datasets/doc/source/index.rst +++ b/datasets/doc/source/index.rst @@ -72,7 +72,9 @@ Flower Datasets library supports: - **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). +.. 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