nvflare.private.fed.client.client_app_runner module

class ClientAppRunner(time_out=60.0)

Bases: Runner

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.

close()

create_client_runner(app_root, args, config_folder, federated_client, secure_train, event_handlers=None)

create_run_manager(args, conf, federated_client, workspace)

logger = <Logger nvflare.private.fed.client.client_app_runner.ClientAppRunner (WARNING)>

notify_job_status(federated_client, job_id, status, timeout=5.0, retry_timeout=None)

Notify the CP the job status. This is called from CJ.

Parameters:

• federated_client – the fed client object.

• job_id – job ID

• status – status of the job.

• timeout – timeout of the notification message

• retry_timeout – max amount of time for retry

Returns: None

When the CJ is just started (status=2), it tries to notify the CP. Since this is the very first message from CJ to SP, the connection to CP may not have been established. We’ll retry until the notification is sent successfully, or the retry_timeout has been reached.

start_command_agent(args, federated_client, fl_ctx)

start_run(app_root, args, config_folder, federated_client, secure_train, event_handlers)

stop()

Method call at the end of the Runner process.

sync_up_parents_process(federated_client)