Run a Flower Application
Call function.run(action="train", ...) to execute the federated-learning application.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| action | str | ✓ | Action to execute. Must be train. |
| schedule | str | Quartz cron expression for scheduling the task. | |
| volumes | list[dict] | List of volumes. | |
| resources | dict | Resource limits and requests. | |
| envs | list[dict] | Environment variables. | |
| secrets | list[str] | List of secret names. | |
| profile | str | Profile template. | |
| local_execution | bool | Run a local Flower simulation instead of submitting the run remotely. Defaults to False. |
|
| parameters | dict | Flower application and training configuration. | |
| federation | str | ✓ | Federation name. Required for remote execution. |
| superlink | str | ✓ | SuperLink service endpoint. Required for remote execution. |
| root_certificates | str | Root certificate content for secure remote communication. |
Training parameters
Parameters configure the Flower application. For Git-based applications, they override configuration in pyproject.toml; for source-based applications, they are used to generate that configuration.
Reserved parameter names include:
| Name | Type | Required | Description |
|---|---|---|---|
| name | str | Application name. Defaults to flower-app. |
|
| version | str | Application version. Defaults to 0.1.0. |
|
| description | str | Application description. Defaults to Flower Application. |
|
| publisher | str | Publisher. Defaults to digitalhub-runtime-flower. |
|
| dependencies | list[str] | Python package dependencies. | |
| packages | list[str] | Python packages to include. Defaults to ["."]. |
Other parameters beginning with option. are added to [tool.flwr.federations.local-simulation]; other keys are added to [tool.flwr.app.config]. The serverapp and clientapp components come from the Function parameters.
Local simulation requires the digitalhub-runtime-flower[local] extra and the application dependencies. Remote execution runs on a platform-managed server or cluster.