Flower Datasets CLI reference¶

Basic Commands¶

flwr-datasets CLI¶

flwr-datasets create¶

Create a federated dataset and save each partition in a sub-directory.

This command is used to generate federated datasets for demo purposes and currently supports only IID partitioning IidPartitioner.

flwr-datasets create [OPTIONS] DATASET_NAME

Options

--num-partitions <num_partitions>¶

Number of partitions to create. Must be a positive integer

Default:

10

--out-dir <out_dir>¶

Output directory for the federated dataset.

Default:

PosixPath('federated_dataset')

--install-completion¶

Install completion for the current shell.

--show-completion¶

Show completion for the current shell, to copy it or customize the installation.

Arguments

DATASET_NAME¶

Required argument

Hugging Face dataset identifier (e.g., ‘ylecun/mnist’).