From 60199e7a0dcb84462963eb029c41735dd9f0e84d Mon Sep 17 00:00:00 2001 From: Adam Narozniak <51029327+adam-narozniak@users.noreply.github.com> Date: Wed, 15 Nov 2023 15:26:35 +0100 Subject: [PATCH] Clarify partitioners parameter description in docs (#2603) --- datasets/flwr_datasets/federated_dataset.py | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/datasets/flwr_datasets/federated_dataset.py b/datasets/flwr_datasets/federated_dataset.py index cad137a98ba8..2f755a124afb 100644 --- a/datasets/flwr_datasets/federated_dataset.py +++ b/datasets/flwr_datasets/federated_dataset.py @@ -49,7 +49,8 @@ class FederatedDataset: 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). + into). One or multiple `Partitioner`s can be specified in that manner, but at + most, one per split. shuffle : bool Whether to randomize the order of samples. Applied prior to resplitting, speratelly to each of the present splits in the dataset. It uses the `seed`