Skip to content

Commit

Permalink
Fix divide_dataset fnc docs
Browse files Browse the repository at this point in the history
  • Loading branch information
adam-narozniak committed Aug 29, 2024
1 parent 1fc80ad commit 54c19de
Showing 1 changed file with 9 additions and 15 deletions.
24 changes: 9 additions & 15 deletions datasets/flwr_datasets/utils.py
Original file line number Diff line number Diff line change
Expand Up @@ -134,29 +134,23 @@ def divide_dataset(
Use `divide_dataset` with division specified as a list.
>>> from flwr_datasets import FederatedDataset
>>> from flwr_datasets.utils import concatenate_divisions
>>> from flwr_datasets.utils import divide_dataset
>>>
>>> fds = FederatedDataset(dataset="mnist", partitioners={"train": 100})
>>> concatenated_divisions = concatenate_divisions(
... partitioner=fds.partitioners["train"],
... partition_division=[0.8, 0.2],
... division_id=1
... )
>>> print(concatenated_divisions)
>>> partition = fds.load_partition(0)
>>> division = [0.8, 0.2]
>>> train, test = divide_dataset(dataset=partition, division=division)
Use `divide_dataset` with division specified as a dict
(this accomplishes the same goal as the example with a list above).
>>> from flwr_datasets import FederatedDataset
>>> from flwr_datasets.utils import concatenate_divisions
>>> from flwr_datasets.utils import divide_dataset
>>>
>>> fds = FederatedDataset(dataset="mnist", partitioners={"train": 100})
>>> concatenated_divisions = concatenate_divisions(
... partitioner=fds.partitioners["train"],
... partition_division={"train": 0.8, "test": 0.2},
... division_id="test",
... )
>>> print(concatenated_divisions)
>>> partition = fds.load_partition(0)
>>> division = {"train": 0.8, "test": 0.2}
>>> train_test = divide_dataset(dataset=partition, division=division)
>>> train, test = train_test["train"], train_test["test"]
"""
_check_division_config_correctness(division)
dataset_length = len(dataset)
Expand Down

0 comments on commit 54c19de

Please sign in to comment.