nvflare.private.fed.client.client_runner module

class ClientRunner(config: ClientRunnerConfig, job_id, engine: ClientEngineSpec, task_fetch_interval: int = 5)

Bases: FLComponent

To init the ClientRunner.

Parameters

• config – ClientRunnerConfig

• job_id – job id

• engine – ClientEngine object

• task_fetch_interval – fetch task interval

abort()

To Abort the current run.

Returns: N/A

abort_task(task_names=None)

end_run_events_sequence(requester)

handle_event(event_type: str, fl_ctx: FLContext)

Handles events.

Parameters

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

• fl_ctx (FLContext) – FLContext information.

run(app_root, args)

class ClientRunnerConfig(task_table: dict, task_data_filters: dict, task_result_filters: dict, handlers=None, components=None)

Bases: object

To init ClientRunnerConfig.

Parameters

• task_table – task_name: Executor dict

• task_data_filters – task_name => list of data filters

• task_result_filters – task_name => list of result filters

• handlers – list of event handlers

• components – dict of extra python objects: id => object