nvflare.collab.runtime.executor module

class CollabExecutor(client_obj_id: str, collab_obj_ids: List[str] | None = None, props: Dict[str, Any] | None = None, max_call_threads=100, max_inbound_call_threads=None, max_outbound_call_threads=None)[source]

Bases: Executor, CollabAdaptor

Client executor for Collab calls in the site’s FLARE process.

Init FLComponent.

The FLComponent is the base class of all FL Components. (executors, controllers, responders, filters, aggregators, and widgets are all FLComponents)

FLComponents have the capability to handle and fire events and contain various methods for logging.

execute(task_name: str, shareable: Shareable, fl_ctx: FLContext, abort_signal: Signal) → Shareable[source]

Executes a task.

Parameters:

  • task_name (str) – task name.

  • shareable (Shareable) – input shareable.

  • fl_ctx (FLContext) – fl context.

  • abort_signal (Signal) – signal to check during execution to determine whether this task is aborted.

Returns:

An output shareable.