nvflare.private.fed.client.fed_client module

The client of the federated training process.

class FederatedClient(client_name, client_args, secure_train, server_args=None, retry_timeout=30, client_state_processors: List[Filter] | None = None, handlers: List[FLComponent] | None = None, executors: List[Executor] | None = None, compression=None, overseer_agent=None, args=None, components=None, cell: Cell | None = None)

Bases: FederatedClientBase

Federated client-side implementation.

To init FederatedClient.

Parameters:

• client_name – client name

• client_args – client config args

• secure_train – True/False to indicate secure train

• server_args – server config args

• retry_timeout – retry timeout seconds

• client_state_processors – Client state processor filters

• handlers – handlers

• executors – executors

• compression – communication compression algorithm

• cell (object) – CellNet communicator

extract_shareable(responses, fl_ctx: FLContext)

fetch_task(fl_ctx: FLContext, timeout=None)