Flower CLI reference#

flower-server#

This will start a Flower server (meaning, a Driver API and a Fleet API), that clients will be able to connect to.

usage: flower-server [-h] [--database DATABASE]
                     [--driver-api-address DRIVER_API_ADDRESS]
                     [--grpc-bidi | --grpc-rere | --rest]
                     [--grpc-bidi-fleet-api-address GRPC_BIDI_FLEET_API_ADDRESS]
                     [--grpc-rere-fleet-api-address GRPC_RERE_FLEET_API_ADDRESS]
                     [--rest-fleet-api-address REST_FLEET_API_ADDRESS]
                     [--ssl-certfile SSL_CERTFILE] [--ssl-keyfile SSL_KEYFILE]
                     [--rest-fleet-api-workers REST_FLEET_API_WORKERS]

Named Arguments#

--database

A string representing the path to the database file that will be opened. Note that passing ‘:memory:’ will open a connection to a database that is in RAM, instead of on disk. If nothing is provided, Flower will just create a state in memory.

Default: “:flwr-in-memory-state:”

--driver-api-address

Driver API (gRPC) server address (IPv4, IPv6, or a domain name)

Default: “0.0.0.0:9091”

--grpc-bidi

Start a Fleet API server (gRPC-bidi)

Default: “grpc-bidi”

--grpc-rere

Start a Fleet API server (gRPC-rere)

--rest

Start a Fleet API server (REST, experimental)

Fleet API (gRPC-bidi) server options#

--grpc-bidi-fleet-api-address

Fleet API (gRPC-bidi) server address (IPv4, IPv6, or a domain name)

Default: “0.0.0.0:9092”

Fleet API (gRPC-rere) server options#

--grpc-rere-fleet-api-address

Fleet API (gRPC-rere) server address (IPv4, IPv6, or a domain name)

Default: “0.0.0.0:9092”

Fleet API (REST) server options#

--rest-fleet-api-address

Fleet API (REST) server address (IPv4, IPv6, or a domain name)

Default: “0.0.0.0:9093”

--ssl-certfile

Fleet API (REST) server SSL certificate file (as a path str), needed for using ‘https’.

--ssl-keyfile

Fleet API (REST) server SSL private key file (as a path str), needed for using ‘https’.

--rest-fleet-api-workers

Set the number of concurrent workers for the Fleet API REST server.

Default: 1

flower-driver-api#

Start a Flower Driver API server. This server will be responsible for receiving TaskIns from the Driver script and sending them to the Fleet API. Once the client nodes are done, they will send the TaskRes back to this Driver API server (through the Fleet API) which will then send them back to the Driver script.

usage: flower-driver-api [-h] [--database DATABASE]
                         [--driver-api-address DRIVER_API_ADDRESS]

Named Arguments#

--database

A string representing the path to the database file that will be opened. Note that passing ‘:memory:’ will open a connection to a database that is in RAM, instead of on disk. If nothing is provided, Flower will just create a state in memory.

Default: “:flwr-in-memory-state:”

--driver-api-address

Driver API (gRPC) server address (IPv4, IPv6, or a domain name)

Default: “0.0.0.0:9091”

flower-fleet-api#

Start a Flower Fleet API server.This server will be responsible for sending TaskIns (received from the Driver API) to the client nodes and of receiving TaskRes sent back from those same client nodes once they are done. Then, this Fleet API server can send those TaskRes back to the Driver API.

usage: flower-fleet-api [-h] [--database DATABASE]
                        [--grpc-bidi | --grpc-rere | --rest]
                        [--grpc-bidi-fleet-api-address GRPC_BIDI_FLEET_API_ADDRESS]
                        [--grpc-rere-fleet-api-address GRPC_RERE_FLEET_API_ADDRESS]
                        [--rest-fleet-api-address REST_FLEET_API_ADDRESS]
                        [--ssl-certfile SSL_CERTFILE]
                        [--ssl-keyfile SSL_KEYFILE]
                        [--rest-fleet-api-workers REST_FLEET_API_WORKERS]

Named Arguments#

--database

A string representing the path to the database file that will be opened. Note that passing ‘:memory:’ will open a connection to a database that is in RAM, instead of on disk. If nothing is provided, Flower will just create a state in memory.

Default: “:flwr-in-memory-state:”

--grpc-bidi

Start a Fleet API server (gRPC-bidi)

Default: “grpc-bidi”

--grpc-rere

Start a Fleet API server (gRPC-rere)

--rest

Start a Fleet API server (REST, experimental)

Fleet API (gRPC-bidi) server options#

--grpc-bidi-fleet-api-address

Fleet API (gRPC-bidi) server address (IPv4, IPv6, or a domain name)

Default: “0.0.0.0:9092”

Fleet API (gRPC-rere) server options#

--grpc-rere-fleet-api-address

Fleet API (gRPC-rere) server address (IPv4, IPv6, or a domain name)

Default: “0.0.0.0:9092”

Fleet API (REST) server options#

--rest-fleet-api-address

Fleet API (REST) server address (IPv4, IPv6, or a domain name)

Default: “0.0.0.0:9093”

--ssl-certfile

Fleet API (REST) server SSL certificate file (as a path str), needed for using ‘https’.

--ssl-keyfile

Fleet API (REST) server SSL private key file (as a path str), needed for using ‘https’.

--rest-fleet-api-workers

Set the number of concurrent workers for the Fleet API REST server.

Default: 1