docs(datasets) Add how to use partitioner docs #3871
Merged
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
During the Flower Dataset user study, there was a problem with users not having easy material that explained how to use different partitioning schemes with FederatedDataset.
Description
One issue that was present is using FederatedDataset in the docs that use just the shortcut API
partitioners={"train": 10}
which stands forpartitioners={"train": IidPartitioner(10)}
(which is addressed). The second problem is the lack of a tutorial to explain that.Proposal
Add a basic Jupyter Notebook tutorial that explains how to use FederatedDataset with different
Partitioner
s.Explanation
Emphasize that it's basically very easy because it has the same API.