nvflare.private.fed.server.run_manager module

class RunManager(server_name, engine: ~nvflare.apis.server_engine_spec.ServerEngineSpec, job_id, workspace: ~nvflare.apis.workspace.Workspace, components: {<class 'str'>: <class 'nvflare.apis.fl_component.FLComponent'>}, client_manager: ~nvflare.private.fed.server.client_manager.ClientManager | None = None, handlers: ~typing.List[~nvflare.apis.fl_component.FLComponent] | None = None)[source]

Bases: EngineSpec

Manage run.

Parameters:
  • server_name – server name

  • engine (ServerEngineSpec) – server engine

  • job_id – job id

  • workspace (Workspace) – workspace

  • components (dict) – A dict of extra python objects {id: object}

  • client_manager (ClientManager, optional) – client manager

  • handlers (List[FLComponent], optional) – handlers

add_component(component_id: str, component)[source]
add_handler(handler: FLComponent)[source]
create_job_processing_context_properties(workspace, job_id)[source]
fire_event(event_type: str, fl_ctx: FLContext)[source]
get_cell()[source]
get_component(component_id: str) object[source]
get_handlers()[source]
get_run_info() RunInfo[source]
get_server_name()[source]
get_workspace() Workspace[source]
new_context() FLContext[source]
validate_targets(client_names: List[str]) Tuple[List[Client], List[str]][source]

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