Skip to content

Commit

Permalink
docs(readme): Update data/README.md
Browse files Browse the repository at this point in the history
Added flower icon and formatted note for Flower Partitioner section in README.md
  • Loading branch information
KarhouTam committed Dec 20, 2024
1 parent 5fd50a5 commit 6fd0266
Showing 1 changed file with 6 additions and 3 deletions.
9 changes: 6 additions & 3 deletions data/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -109,10 +109,13 @@ python generate_data.py -d cifar10 -sm 1 -cn 20
```
<img src="../.github/images/distributions/semantic.png" alt="Image" width="350"/>

## Flower Partitioner
## Flower Partitioner 🌼

This benchmark also supports external partitioners provided by [flwr_datasets](https://flower.ai/docs/datasets/), enabling the comparison with built-in partitioning schemes and additional schemese that exist in flwr_datasets. To use flwr partitioners, you need to specify the class path of the partitioner you want to use and all its parameters in a seperate dictionary. This is how you would use the DirichletPartitioner from flwr:
Attention: To use flwr's partitioners, internally a mock dataset is created that has a column called "label". If the partitioning scheme depends on label information, please insert "label" as the label column.
This benchmark also supports external partitioners provided by [flwr_datasets](https://flower.ai/docs/datasets/), enabling the comparison with built-in partitioning schemes and additional schemese that exist in flwr_datasets. To use flwr partitioners, you need to specify the class path of the partitioner you want to use and all its parameters in a seperate dictionary.
> \[!NOTE\]
> To use flwr's partitioners, internally a mock dataset is created that has a column called `label`. If the partitioning scheme depends on label information, please insert `label` as the label column.
This is how you would use the `DirichletPartitioner` from flwr:
```shell
python generate_data.py -d cifar10 -cn 10 -fpc "flwr_datasets.partitioner.DirichletPartitioner" -fpk '{"alpha": 100.0, "partition_by": "label"}'
```
Expand Down

0 comments on commit 6fd0266

Please sign in to comment.