nvflare.private.fed.client.client_run_manager module

class ClientRunInfo(job_id)

Bases: object

To init the ClientRunInfo.

Parameters:

job_id – job id

class ClientRunManager(client_name: str, job_id: str, workspace: Workspace, client: FederatedClient, components: Dict[str, FLComponent], handlers: List[FLComponent] | None = None, conf: ClientJsonConfigurator | None = None)

Bases: ClientEngineExecutorSpec

ClientRunManager provides the ClientEngine APIs implementation running in the child process.

To init the ClientRunManager.

Parameters:

• client_name – client name

• job_id – job id

• workspace – workspace

• client – FL client object

• components – available FL components

• handlers – available handlers

• conf – ClientJsonConfigurator object

abort_app(job_id: str, fl_ctx: FLContext)

Abort the running FL App on the client.

Parameters:

• job_id – current_job_id

• fl_ctx – FLContext

add_handler(handler: FLComponent)

build_component(config_dict)

Build a component from the config_dict.

Parameters:

config_dict – config dict

create_job_processing_context_properties(workspace, job_id)

dispatch(topic: str, request: Shareable, fl_ctx: FLContext) → Shareable

fire_and_forget_aux_request(topic: str, request: Shareable, fl_ctx: FLContext, optional=False, secure=False) → dict

Send an async request to Server via the aux channel.

Parameters:

• topic – topic of the request

• request – request to be sent

• fl_ctx – FL context

• optional – whether the request is optional

Returns:

fire_event(event_type: str, fl_ctx: FLContext)

get_all_clients_from_server(fl_ctx, retry=0)

get_all_components() → dict

get_cell()

get_client_from_name(client_name)

get_component(component_id: str) → object

get_run_info() → ClientRunInfo

get_task_assignment(fl_ctx: FLContext, timeout=None) → TaskAssignment

get_widget(widget_id: str) → Widget

get_workspace() → Workspace

new_context() → FLContext

register_aux_message_handler(topic: str, message_handle_func)

Register aux message handling function with specified topics.

Exception is raised when:

a handler is already registered for the topic; bad topic - must be a non-empty string bad message_handle_func - must be callable

Implementation Note: This method should simply call the ClientAuxRunner’s register_aux_message_handler method.

Parameters:

• topic – the topic to be handled by the func

• message_handle_func – the func to handle the message. Must follow aux_message_handle_func_signature.

reset_errors() → ClientRunInfo

send_aux_request(targets: None | str | List[str], topic: str, request: Shareable, timeout: float, fl_ctx: FLContext, optional=False, secure=False) → dict

Send a request to Server via the aux channel.

Implementation: simply calls the ClientAuxRunner’s send_aux_request method.

Parameters:

• targets – aux messages targets. None or empty list means the server.

• topic – topic of the request

• request – request to be sent

• timeout – number of secs to wait for replies. 0 means fire-and-forget.

• fl_ctx – FL context

• optional – whether the request is optional

• secure – should the request sent in the secure way

Returns:

{ site_name: reply_shareable }

Return type:

a dict of reply Shareable in the format of

send_task_result(result: Shareable, fl_ctx: FLContext, timeout=None) → bool

show_errors() → ClientRunInfo

validate_targets(inputs)

Validate specified target names.

Parameters:

target_names – list of names to be validated

Returns: a list of validate targets and a list of invalid target names