Skip to content

Commit

Permalink
Apply suggestions from code review
Browse files Browse the repository at this point in the history
Co-authored-by: Javier <[email protected]>
  • Loading branch information
adam-narozniak and jafermarq authored Jun 23, 2024
1 parent a56c468 commit 3fed62c
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 5 deletions.
6 changes: 3 additions & 3 deletions datasets/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Thanks to using Hugging Face's `datasets` used under the hood, Flower Datasets i
* Jax,
* Arrow.

Create **custom partitioning schemes** or choose from the **implemented partitioning schemes**:
Create **custom partitioning schemes** or choose from the **implemented [partitioning schemes](https://flower.ai/docs/datasets/ref-api/flwr_datasets.partitioner.html#module-flwr_datasets.partitioner)**:

* Partitioner (the abstract base class) `Partitioner`
* IID partitioning `IidPartitioner(num_partitions)`
Expand All @@ -41,7 +41,7 @@ Create **custom partitioning schemes** or choose from the **implemented partitio
<br>
<em>Comparison of Partitioning Schemes on CIFAR10</em>
</p>
PS: This plot was generated using a library function (see flwr_datasets.visualization package for more).
PS: This plot was generated using a library function (see [flwr_datasets.visualization](https://flower.ai/docs/datasets/ref-api/flwr_datasets.visualization.html) package for more).

# Installation

Expand Down Expand Up @@ -79,7 +79,7 @@ Here's a basic quickstart example of how to partition the MNIST dataset:
from flwr_datasets import FederatedDataset
# The train split of the MNIST dataset will be partitioned into 100 partitions
fds = FederatedDataset("mnist", partitioners={"train": 100}
fds = FederatedDataset("mnist", partitioners={"train": 100})
partition = fds.load_partition(0)
Expand Down
4 changes: 2 additions & 2 deletions datasets/doc/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ 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 implemnted partitioning scheme or create a fully custom one
- **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)

Expand All @@ -74,7 +74,7 @@ Thanks to using Hugging Face's ``datasets`` used under the hood, Flower Datasets
- Jax
- Arrow

Here are a few of the ``Partitioner`` s that are available: (for a full list see `link <https://flower.ai/docs/datasets/ref-api/flwr_datasets.partitioner.html#module-flwr_datasets.partitioner>`_ )
Here are a few of the ``Partitioner`` s that are available: (for a full list see `link <ref-api/flwr_datasets.partitioner.html#module-flwr_datasets.partitioner>`_ )

* Partitioner (the abstract base class) ``Partitioner``
* IID partitioning ``IidPartitioner(num_partitions)``
Expand Down

0 comments on commit 3fed62c

Please sign in to comment.