nvflare.collab package

Subpackages

• nvflare.collab.api package
  • Submodules
    • nvflare.collab.api.app module
      • App
      • ClientApp
      • ServerApp
    • nvflare.collab.api.call_opt module
      • CallOption
    • nvflare.collab.api.call_utils module
      • check_call_args()
      • check_context_support()
      • check_optional_args()
      • get_collab_object_name()
    • nvflare.collab.api.constants module
      • CollabMethodArgName
      • ContextKey
    • nvflare.collab.api.context module
      • Context
      • get_call_context()
      • set_call_context()
    • nvflare.collab.api.decorators module
      • adjust_kwargs()
      • classproperty
      • final()
      • get_object_final_funcs()
      • get_object_init_funcs()
      • get_object_main_funcs()
      • get_object_publish_interface()
      • get_param_names()
      • get_param_specs()
      • init()
      • is_publish()
      • main()
      • publish()
      • supports_context()
    • nvflare.collab.api.exceptions module
      • CollabCallError
      • RunAborted
    • nvflare.collab.api.facade module
      • Facade
      • get_call_context()
    • nvflare.collab.api.group module
      • Group
      • group()
    • nvflare.collab.api.group_call_context module
      • GroupCallContext
      • ResultQueue
      • ResultWaiter
    • nvflare.collab.api.module_wrapper module
      • ModuleWrapper
      • get_caller_module()
      • get_importable_module_name()
      • resolve_server_client()
      • wrap_if_module()
    • nvflare.collab.api.proxy module
      • Proxy
    • nvflare.collab.api.proxy_list module
      • ProxyList
    • nvflare.collab.api.publish_interface module
      • MethodInterface
      • MethodParameter
      • PublishInterface
  • Module contents
    • App
      • App.add_collab_object()
      • App.backend
      • App.client_hierarchy
      • App.client_proxies
      • App.finalize()
      • App.find_collab_method()
      • App.find_method()
      • App.fqn
      • App.get_children()
      • App.get_collab_interface()
      • App.get_collab_objects()
      • App.get_leaf_clients()
      • App.get_prop()
      • App.get_props()
      • App.get_target_object_publish_interface()
      • App.has_children()
      • App.initialize()
      • App.my_site
      • App.new_context()
      • App.server_proxy
      • App.set_fqn()
      • App.set_prop()
      • App.setup()
      • App.update_props()
      • App.workspace
    • CallOption
    • ClientApp
      • ClientApp.get_children()
      • ClientApp.has_children()
    • CollabCallError
    • Context
      • Context.backend
      • Context.client_hierarchy
      • Context.clients
      • Context.get_prop()
      • Context.is_aborted()
      • Context.server
      • Context.set_prop()
      • Context.target_group_size
      • Context.workspace
    • ContextKey
      • ContextKey.RESULT
    • GroupCallContext
      • GroupCallContext.add_partial_result()
      • GroupCallContext.call_completed()
      • GroupCallContext.set_completion_cb()
      • GroupCallContext.set_exception()
      • GroupCallContext.set_result()
    • ModuleWrapper
      • ModuleWrapper.module_name
    • PublishInterface
      • PublishInterface.from_dict()
      • PublishInterface.get_method()
      • PublishInterface.to_dict()
    • ServerApp
      • ServerApp.get_children()
      • ServerApp.has_children()
• nvflare.collab.runtime package
  • Submodules
    • nvflare.collab.runtime.adaptor module
      • CollabAdaptor
    • nvflare.collab.runtime.cell_dispatcher module
      • CellDispatcher
    • nvflare.collab.runtime.controller module
      • CollabController
    • nvflare.collab.runtime.defs module
      • CallReplyKey
      • ObjectCallKey
      • SyncKey
    • nvflare.collab.runtime.dispatch module
      • prepare_for_remote_call()
    • nvflare.collab.runtime.executor module
      • CollabExecutor
    • nvflare.collab.runtime.lifecycle module
      • run_server()
  • Module contents

Submodules

• nvflare.collab.recipe module
  • CollabRecipe
    • CollabRecipe.finalize()
    • CollabRecipe.set_client_prop()
    • CollabRecipe.set_server_prop()

Module contents

exception CollabCallError(site: str, func_name: str, cause, cause_type: str | None = None, remote_traceback: str | None = None)

Bases: Exception

Raised when a call to a Collab function fails.

class CollabRecipe(job_name: str, server: object | None = None, client: object | None = None, server_objects: Dict[str, object] | None = None, client_objects: Dict[str, object] | None = None, sync_task_timeout=60, max_call_threads_for_server=100, max_call_threads_for_client=100, min_clients: int = 1, max_inbound_call_threads_for_server=None, max_outbound_call_threads_for_server=None, max_inbound_call_threads_for_client=None, max_outbound_call_threads_for_client=None)

Bases: Recipe

Create a recipe for collaborative training.

finalize() → FedJob

Called to finalize the setup of the recipe.

Returns:

set_client_prop(name: str, value)

set_server_prop(name: str, value)

collab

alias of Facade

simple_logging(level=20)

Configure basic stdout logging for example and user scripts.