nvflare.app_common.executors.multi_process_executor module

class MultiProcessExecutor(executor_id=None, num_of_processes=1, components=None)

Bases: Executor

Manage the multi-process execution life cycle.

Parameters:

• executor_id – executor component ID

• num_of_processes – number of processes to create

• components – a dictionary for component classes to their arguments

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

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.

finalize(fl_ctx: FLContext)

This is called when exiting/aborting the executor.

abstract get_multi_process_command() → str

Provide the command for starting multi-process execution.

Returns:

multi-process starting command

handle_event(event_type: str, fl_ctx: FLContext)

Handles events.

Parameters:

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

• fl_ctx (FLContext) – FLContext information.

initialize(fl_ctx: FLContext)

receive_execute_result(request: Message) → Message

class WorkerComponentBuilder(fl_ctx: FLContext | None = None, workspace=None, enforce_authorization=True)

Bases: ComponentBuilder

Component to build workers.

FL_MODULES = ['client', 'app']

FL_PACKAGES = ['nvflare']

build_component(config_dict, node=None)

get_module_scanner()

Provide the package module scanner.

Returns: module_scanner

static make_component_node(component_config, index=None)

Create a config node for a worker component payload.

Parameters:

• component_config – Component configuration dict.

• index – Optional 1-based index when the config came from a components list.