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: Optional[List[Filter]] = None, handlers: Optional[List[FLComponent]] = None, executors: Optional[List[Executor]] = None, compression=None, enable_byoc=False, overseer_agent=None, args=None, components=None)[source]

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

  • enable_byoc – True/False to allow byoc

extract_shareable(responses, fl_ctx: FLContext)[source]
fetch_task(fl_ctx: FLContext)[source]