nvflare.private.fed.utils.fed_utils module

add_custom_dir_to_path(app_custom_folder, new_env)[source]

Util method to add app_custom_folder into the sys.path and carry into the child process.

authorize_build_component(config_dict, config_ctx, node, fl_ctx: FLContext, event_handlers) str[source]
create_job_processing_context_properties(workspace: Workspace, job_id: str) dict[source]
create_stats_pool_files_for_job(workspace: Workspace, job_id: str, prefix=None)[source]
custom_fobs_initialize(workspace: Workspace | None = None, job_id: str | None = None)[source]
find_char_positions(s, ch)[source]
fobs_initialize(workspace: Workspace | None = None, job_id: str | None = None)[source]
get_job_meta_from_workspace(workspace: Workspace, job_id: str) dict[source]
get_return_code(process, job_id, workspace, logger)[source]
get_scope_info()[source]
get_scope_prop(scope_name: str, key: str, default=None) Any[source]

Get the value of a specified property from the specified scope. :param scope_name: name of the scope :param key: key of the scope :param default: value to return if the prop is not found

Returns:

get_simulator_app_root(simulator_root, site_name)[source]
get_target_names(targets)[source]
nvflare_fobs_initialize()[source]
register_decomposer_module(decomposer_module)[source]
register_ext_decomposers(decomposer_module: str | List[str])[source]
security_close()[source]
security_init(secure_train: bool, site_org: str, workspace: Workspace, app_validator: AppValidator, site_type: str)[source]

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

set_message_security_data(request, job, fl_ctx)[source]
set_scope_prop(scope_name: str, key: str, value: Any)[source]

Save the specified property of the specified scope (globally). :param scope_name: name of the scope :param key: key of the property to be saved :param value: value of property

Returns: None

set_stats_pool_config_for_job(workspace: Workspace, job_id: str, prefix=None)[source]
split_gpus(gpus) [<class 'str'>][source]