nvflare.app_common.hub.hub_controller module

class BcastOperator

Bases: OperatorSpec, FLComponent

operate(op_description: dict, controller: ControllerSpec, task_name: str, task_data: Shareable, abort_signal: Signal, fl_ctx: FLContext) → Shareable | None

process_result_of_unknown_task(client: Client, task_name: str, client_task_id: str, result: Shareable, fl_ctx: FLContext)

class HubController(pipe_id: str, task_wait_time=None, task_data_poll_interval: float = 0.1)

Bases: Controller

Controller logic for tasks and their destinations.

Must set_communicator() to access communication related function implementations.

Parameters:

task_check_period (float, optional) – interval for checking status of tasks. Applicable for WFCommServer. Defaults to 0.2.

control_flow(abort_signal: Signal, fl_ctx: FLContext)

This is the control logic for the RUN.

NOTE: this is running in a separate thread, and its life is the duration of the RUN.

Parameters:

• fl_ctx – the FL context

• abort_signal – the abort signal. If triggered, this method stops waiting and returns to the caller.

handle_event(event_type: str, fl_ctx: FLContext)

Handles events.

Parameters:

• event_type (str) – event type fired by workflow.

• fl_ctx (FLContext) – FLContext information.

process_result_of_unknown_task(client: Client, task_name: str, client_task_id: str, result: Shareable, fl_ctx: FLContext)

Process result when no task is found for it.

This is called when a result submission is received from a client, but no standing task can be found for it (from the task queue)

This could happen when: - the client’s submission is too late - the task is already completed - the Controller lost the task, e.g. the Server is restarted

Parameters:

• client – the client that the result comes from

• task_name – the name of the task

• client_task_id – ID of the task

• result – the result from the client

• fl_ctx – the FL context that comes with the client’s submission

start_controller(fl_ctx: FLContext) → None

Starts the controller.

This method is called at the beginning of the RUN.

Parameters:

• fl_ctx – the FL context. You can use this context to access services provided by the

• example (framework. For) –

• your (you can get Command Register from it and register) –

• modules. (admin command) –

stop_controller(fl_ctx: FLContext)

Stops the controller.

This method is called right before the RUN is ended.

Parameters:

• fl_ctx – the FL context. You can use this context to access services provided by the

• example (framework. For) –

• your (you can get Command Register from it and unregister) –

• modules. (admin command) –

class RelayOperator

Bases: OperatorSpec, FLComponent

operate(op_description: dict, controller: ControllerSpec, task_name: str, task_data: Shareable, abort_signal: Signal, fl_ctx: FLContext) → None | Shareable