Skip to content

[quickrun]

Script to quickly run a simulated FL example locally using declearn.

This submodule, which is not imported by default, mainly aims at providing with the declearn-quickrun command-line entry-point so as to easily set up and run simulated federated learning experiments on a single computer.

It exposes the following, merely as a way to make the documentation of that util available to end-users:

  • quickrun: Backend function of the declearn-quickrun command-line entry-point.
  • parse_data_folder: Util to parse through a data folder used in a quickrun experiment.
  • DataSourceConfig: Dataclass and TOML parser for data-parsing hyper-parameters.
  • ExperimentConfig: Dataclass and TOML parser for experiment-defining hyper-parameters.
  • ModelConfig: Dataclass and TOML parser for model-defining hyper-parameters.