nvflare.private.fed.client.client_executor module

class ClientExecutor

Bases: ABC

abstract abort_app(job_id)

Aborts the running app.

Parameters:

job_id – the job_id

abstract abort_task(job_id)

Aborts the client executing task.

Parameters:

job_id – the job_id

abstract check_status(job_id) → str

Checks the status of the running client.

Parameters:

job_id – the job_id

Returns:

A client status message

abstract get_errors(job_id)

Get the error information.

Returns:

A dict of error information.

abstract get_run_info(job_id)

Gets the run information.

Parameters:

job_id – the job_id

Returns:

A dict of run information.

abstract process_aux_command(shareable: Shareable, job_id)

Processes the aux command.

Parameters:

• shareable – aux message Shareable

• job_id – the job_id

abstract reset_errors(job_id)

Resets the error information.

Parameters:

job_id – the job_id

abstract start_app(client, job_id, args, app_custom_folder, listen_port, allocated_resource, token, resource_manager, target: str)

Starts the client app.

Parameters:

• client – the FL client object

• job_id – the job_id

• args – admin command arguments for starting the FL client training

• app_custom_folder – FL application custom folder

• listen_port – port to listen the command.

• allocated_resource – allocated resources

• token – token from resource manager

• resource_manager – resource manager

• target – SP target location

class ProcessExecutor(startup)

Bases: ClientExecutor

Run the Client executor in a child process.

To init the ProcessExecutor.

Parameters:

startup – startup folder

abort_app(job_id)

Aborts the running app.

Parameters:

job_id – the job_id

abort_task(job_id)

Aborts the client executing task.

Parameters:

job_id – the job_id

check_status(job_id)

Checks the status of the running client.

Parameters:

job_id – the job_id

Returns:

A client status message

get_conn_client(job_id)

get_errors(job_id)

Get the error information.

Parameters:

job_id – the job_id

Returns:

A dict of error information.

get_run_info(job_id)

Gets the run information.

Parameters:

job_id – the job_id

Returns:

A dict of run information.

get_run_processes_keys()

get_status(job_id)

process_aux_command(shareable: Shareable, job_id)

Processes the aux command.

Parameters:

• shareable – aux message Shareable

• job_id – the job_id

reset_errors(job_id)

Resets the error information.

Parameters:

job_id – the job_id

start_app(client, job_id, args, app_custom_folder, listen_port, allocated_resource, token, resource_manager: ResourceManagerSpec, target: str)

Starts the app.

Parameters:

• client – the FL client object

• job_id – the job_id

• args – admin command arguments for starting the worker process

• app_custom_folder – FL application custom folder

• listen_port – port to listen the command.

• allocated_resource – allocated resources

• token – token from resource manager

• resource_manager – resource manager

• target – SP target location