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

Jump to bottom

docs(datasets) Clarify the partitioner parameter docs of FederatedDataset #3907

Merged
merged 2 commits into from
Jul 25, 2024
Merged

docs(datasets) Clarify the partitioner parameter docs of FederatedDataset #3907

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4881e7a
Clarify the partitioner parameter of FederatedDataset
adam-narozniak Jul 24, 2024
3df9364
Merge branch 'main' into clarify-the-int-partitioners-fds-param
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
8 changes: 5 additions & 3 deletions datasets/flwr_datasets/federated_dataset.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,9 +54,11 @@ class FederatedDataset:
no operation is applied.
partitioners : Dict[str, Union[Partitioner, int]]
A dictionary mapping the Dataset split (a `str`) to a `Partitioner` or an `int`
(representing the number of IID partitions that this split should be partitioned
into). One or multiple `Partitioner` objects can be specified in that manner,
but at most, one per split.
(representing the number of IID partitions that this split should be
partitioned into, i.e., using the default partitioner
`IidPartitioner <https://flower.ai/docs/datasets/ref-api/flwr_
datasets.partitioner.IidPartitioner.html>`_). One or multiple `Partitioner`
objects can be specified in that manner, but at most, one per split.
shuffle : bool
Whether to randomize the order of samples. Applied prior to preprocessing
operations, speratelly to each of the present splits in the dataset. It uses
Expand Down