nvflare.private.fed.utils.fed_utils module

authorize_build_component(config_dict, config_ctx, node, fl_ctx: FLContext, event_handlers) → str

create_job_processing_context_properties(workspace: Workspace, job_id: str) → dict

create_stats_pool_files_for_job(workspace: Workspace, job_id: str, prefix=None)

custom_fobs_initialize(workspace: Workspace | None = None, job_id: str | None = None)

execute_command_directly(args: List[str]) → str

Execute a command directly, without using shell

extract_participants(participants_list)

Extract participant site names from deploy_map forms.

Supported forms include:

• [“server”, “site-1”]

• [“@ALL”]

• {“targets”: [“server”, “site-1”]}

• {“sites”: [“server”, “site-1”]}

• [{“sites”: [“site-1”]}, “site-2”]

• [{“targets”: [“site-1”]}, “site-2”]

find_char_positions(s, ch)

fobs_initialize(workspace: Workspace | None = None, job_id: str | None = None)

get_job_launcher(job_meta: dict, fl_ctx: FLContext) → JobLauncherSpec

get_job_meta_from_workspace(workspace: Workspace, job_id: str) → dict

get_return_code(job_handle, job_id, workspace, logger)

get_scope_info()

get_simulator_app_root(simulator_root, site_name)

get_target_names(targets)

nvflare_fobs_initialize()

register_decomposer_module(decomposer_module)

register_ext_decomposers(decomposer_module: str | List[str])

require_signed_jobs(workspace: Workspace) → bool

Return True if the server requires all submitted jobs to carry __nvfl_sig.json.

Centralized and distributed provisioning use the same verification model: the job carries the submitter certificate, and that certificate must chain to the server’s rootCA.pem. Operators can set require_signed_jobs: false in fed_server.json to allow unsigned job folders without restarting the server (hot-reload).

Default: True when rootCA.pem is present (any PKI deployment); False otherwise. Explicit “require_signed_jobs” key in fed_server.json overrides the inferred default.

security_close()

security_init(secure_train: bool, site_org: str, workspace: Workspace, app_validator: AppValidator, site_type: str)

To check the security content if running in security mode.

Parameters:

• secure_train (bool) – if run in secure mode or not.

• site_org – organization of the site

• workspace – the workspace object.

• app_validator – app validator for application validation

• site_type (str) – server or client. fed_client.json or fed_server.json

security_init_for_job(secure_train: bool, workspace: Workspace, site_type: str, job_id: str)

Initialize security processing for a job process (SJ or CJ).

Parameters:

• secure_train (bool) – if run in secure mode or not.

• workspace – the workspace object.

• site_type (str) – server or client. fed_client.json or fed_server.json

set_message_security_data(request, job, fl_ctx)

set_stats_pool_config_for_job(workspace: Workspace, job_id: str, prefix=None)

split_gpus(gpus) → [<class 'str'>]