Skip to content

Commit

Permalink
docs(datasets) Clarify the split docs in FederatedDataset (#3912)
Browse files Browse the repository at this point in the history
  • Loading branch information
adam-narozniak authored Sep 10, 2024
1 parent 801c0fc commit c5e28d4
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions datasets/flwr_datasets/federated_dataset.py
Original file line number Diff line number Diff line change
Expand Up @@ -161,6 +161,11 @@ def load_partition(
not need to provide this argument, but if `partitioners={"train": 10,
"test": 100}`, you need to set it to differentiate which partitioner should
be used.
The split names you can choose from vary from dataset to dataset. You need
to check the dataset on the `Hugging Face Hub`<https://huggingface.co/
datasets>_ to see which splits are available. You can resplit the dataset
by using the `preprocessor` parameter (to rename, merge, divide, etc. the
available splits).
Returns
-------
Expand Down Expand Up @@ -203,6 +208,11 @@ def load_split(self, split: str) -> Dataset:
----------
split : str
Split name of the downloaded dataset (e.g. "train", "test").
The split names you can choose from vary from dataset to dataset. You need
to check the dataset on the `Hugging Face Hub`<https://huggingface.co/
datasets>_ to see which splits are available. You can resplit the dataset
by using the `preprocessor` parameter (to rename, merge, divide, etc. the
available splits).
Returns
-------
Expand Down

0 comments on commit c5e28d4

Please sign in to comment.