nvflare.private.fed.client package

Submodules

• nvflare.private.fed.client.admin module
  • FedAdminAgent
    • FedAdminAgent.register_cell_cb()
    • FedAdminAgent.register_processor()
  • RequestProcessor
    • RequestProcessor.get_topics()
    • RequestProcessor.process()
• nvflare.private.fed.client.admin_commands module
  • AbortCommand
    • AbortCommand.get_command_name()
    • AbortCommand.process()
  • AbortTaskCommand
    • AbortTaskCommand.get_command_name()
    • AbortTaskCommand.process()
  • AdminCommands
    • AdminCommands.commands
    • AdminCommands.get_command()
    • AdminCommands.register_command()
  • ByeCommand
    • ByeCommand.get_command_name()
    • ByeCommand.process()
  • CheckStatusCommand
    • CheckStatusCommand.get_command_name()
    • CheckStatusCommand.process()
  • CommandProcessor
    • CommandProcessor.get_command_name()
    • CommandProcessor.process()
  • ResetErrorsCommand
    • ResetErrorsCommand.get_command_name()
    • ResetErrorsCommand.process()
  • ShowErrorsCommand
    • ShowErrorsCommand.get_command_name()
    • ShowErrorsCommand.process()
  • ShowStatsCommand
    • ShowStatsCommand.get_command_name()
    • ShowStatsCommand.process()
• nvflare.private.fed.client.client_app_runner module
  • ClientAppRunner
    • ClientAppRunner.close()
    • ClientAppRunner.create_client_runner()
    • ClientAppRunner.create_run_manager()
    • ClientAppRunner.logger
    • ClientAppRunner.notify_job_status()
    • ClientAppRunner.start_command_agent()
    • ClientAppRunner.start_run()
    • ClientAppRunner.stop()
    • ClientAppRunner.sync_up_parents_process()
• nvflare.private.fed.client.client_engine module
  • ClientEngine
    • ClientEngine.abort_app()
    • ClientEngine.abort_task()
    • ClientEngine.delete_run()
    • ClientEngine.deploy_app()
    • ClientEngine.fire_event()
    • ClientEngine.get_all_job_ids()
    • ClientEngine.get_client_name()
    • ClientEngine.get_component()
    • ClientEngine.get_current_run_info()
    • ClientEngine.get_engine_status()
    • ClientEngine.get_errors()
    • ClientEngine.new_context()
    • ClientEngine.notify_job_status()
    • ClientEngine.reset_errors()
    • ClientEngine.restart()
    • ClientEngine.set_agent()
    • ClientEngine.shutdown()
    • ClientEngine.start_app()
  • shutdown_client()
• nvflare.private.fed.client.client_engine_executor_spec module
  • ClientEngineExecutorSpec
    • ClientEngineExecutorSpec.abort_app()
    • ClientEngineExecutorSpec.build_component()
    • ClientEngineExecutorSpec.fire_and_forget_aux_request()
    • ClientEngineExecutorSpec.get_all_components()
    • ClientEngineExecutorSpec.get_task_assignment()
    • ClientEngineExecutorSpec.get_widget()
    • ClientEngineExecutorSpec.get_workspace()
    • ClientEngineExecutorSpec.register_aux_message_handler()
    • ClientEngineExecutorSpec.send_aux_request()
    • ClientEngineExecutorSpec.send_task_result()
  • TaskAssignment
• nvflare.private.fed.client.client_engine_internal_spec module
  • ClientEngineInternalSpec
    • ClientEngineInternalSpec.abort_app()
    • ClientEngineInternalSpec.abort_task()
    • ClientEngineInternalSpec.delete_run()
    • ClientEngineInternalSpec.deploy_app()
    • ClientEngineInternalSpec.get_all_job_ids()
    • ClientEngineInternalSpec.get_client_name()
    • ClientEngineInternalSpec.get_engine_status()
    • ClientEngineInternalSpec.notify_job_status()
    • ClientEngineInternalSpec.restart()
    • ClientEngineInternalSpec.shutdown()
    • ClientEngineInternalSpec.start_app()
• nvflare.private.fed.client.client_executor module
  • ClientExecutor
    • ClientExecutor.abort_app()
    • ClientExecutor.abort_task()
    • ClientExecutor.check_status()
    • ClientExecutor.get_errors()
    • ClientExecutor.get_run_info()
    • ClientExecutor.reset_errors()
    • ClientExecutor.start_app()
  • ProcessExecutor
    • ProcessExecutor.abort_app()
    • ProcessExecutor.abort_task()
    • ProcessExecutor.check_status()
    • ProcessExecutor.get_errors()
    • ProcessExecutor.get_run_info()
    • ProcessExecutor.get_run_processes_keys()
    • ProcessExecutor.get_status()
    • ProcessExecutor.notify_job_status()
    • ProcessExecutor.reset_errors()
    • ProcessExecutor.start_app()
• nvflare.private.fed.client.client_json_config module
  • ClientJsonConfigurator
    • ClientJsonConfigurator.build_component()
    • ClientJsonConfigurator.finalize_config()
    • ClientJsonConfigurator.process_config_element()
• nvflare.private.fed.client.client_req_processors module
  • ClientRequestProcessors
    • ClientRequestProcessors.register_cmd_module()
    • ClientRequestProcessors.request_processors
• nvflare.private.fed.client.client_run_manager module
  • ClientRunInfo
  • ClientRunManager
    • ClientRunManager.abort_app()
    • ClientRunManager.add_handler()
    • ClientRunManager.build_component()
    • ClientRunManager.create_job_processing_context_properties()
    • ClientRunManager.dispatch()
    • ClientRunManager.fire_and_forget_aux_request()
    • ClientRunManager.fire_event()
    • ClientRunManager.get_all_clients_from_server()
    • ClientRunManager.get_all_components()
    • ClientRunManager.get_cell()
    • ClientRunManager.get_client_from_name()
    • ClientRunManager.get_component()
    • ClientRunManager.get_run_info()
    • ClientRunManager.get_task_assignment()
    • ClientRunManager.get_widget()
    • ClientRunManager.get_workspace()
    • ClientRunManager.new_context()
    • ClientRunManager.register_aux_message_handler()
    • ClientRunManager.reset_errors()
    • ClientRunManager.send_aux_request()
    • ClientRunManager.send_task_result()
    • ClientRunManager.show_errors()
    • ClientRunManager.validate_targets()
• nvflare.private.fed.client.client_runner module
  • ClientRunner
    • ClientRunner.abort()
    • ClientRunner.end_run_events_sequence()
    • ClientRunner.fetch_and_run_one_task()
    • ClientRunner.find_executor()
    • ClientRunner.handle_event()
    • ClientRunner.init_run()
    • ClientRunner.run()
  • ClientRunnerConfig
    • ClientRunnerConfig.add_component()
  • TaskRouter
    • TaskRouter.add_executor()
    • TaskRouter.route()
• nvflare.private.fed.client.client_status module
  • ClientStatus
    • ClientStatus.EXCEPTION
    • ClientStatus.NOT_STARTED
    • ClientStatus.STARTED
    • ClientStatus.STARTING
    • ClientStatus.STOPPED
    • ClientStatus.status_messages
  • get_status_message()
• nvflare.private.fed.client.command_agent module
  • CommandAgent
    • CommandAgent.aux_communication()
    • CommandAgent.execute_command()
    • CommandAgent.register_cell_cb()
    • CommandAgent.shutdown()
    • CommandAgent.start()
• nvflare.private.fed.client.communicator module
  • Communicator
    • Communicator.client_registration()
    • Communicator.pull_task()
    • Communicator.quit_remote()
    • Communicator.send_heartbeat()
    • Communicator.submit_update()
• nvflare.private.fed.client.comp_caller_cmd module
  • ComponentCallerProcessor
    • ComponentCallerProcessor.get_topics()
    • ComponentCallerProcessor.process()
• nvflare.private.fed.client.fed_client module
  • FederatedClient
    • FederatedClient.extract_shareable()
    • FederatedClient.fetch_task()
• nvflare.private.fed.client.fed_client_base module
  • FederatedClientBase
    • FederatedClientBase.client_register()
    • FederatedClientBase.close()
    • FederatedClientBase.fetch_execute_task()
    • FederatedClientBase.heartbeat()
    • FederatedClientBase.logout_client()
    • FederatedClientBase.overseer_callback()
    • FederatedClientBase.pull_task()
    • FederatedClientBase.push_execute_result()
    • FederatedClientBase.push_results()
    • FederatedClientBase.quit_remote()
    • FederatedClientBase.register()
    • FederatedClientBase.run_heartbeat()
    • FederatedClientBase.send_heartbeat()
    • FederatedClientBase.set_client_engine()
    • FederatedClientBase.set_client_runner()
    • FederatedClientBase.set_primary_sp()
    • FederatedClientBase.set_sp()
    • FederatedClientBase.start_heartbeat()
    • FederatedClientBase.start_overseer_agent()
    • FederatedClientBase.stop_cell()
    • FederatedClientBase.terminate()
• nvflare.private.fed.client.info_coll_cmd module
  • ClientInfoProcessor
    • ClientInfoProcessor.get_topics()
    • ClientInfoProcessor.process()
• nvflare.private.fed.client.scheduler_cmds module
  • CancelResourceProcessor
    • CancelResourceProcessor.get_topics()
    • CancelResourceProcessor.process()
  • CheckResourceProcessor
    • CheckResourceProcessor.get_topics()
    • CheckResourceProcessor.process()
  • ReportResourcesProcessor
    • ReportResourcesProcessor.get_topics()
    • ReportResourcesProcessor.process()
  • StartJobProcessor
    • StartJobProcessor.get_topics()
    • StartJobProcessor.process()
• nvflare.private.fed.client.shell_cmd module
  • ShellCommandProcessor
    • ShellCommandProcessor.get_topics()
    • ShellCommandProcessor.process()
• nvflare.private.fed.client.sys_cmd module
  • ReportEnvProcessor
    • ReportEnvProcessor.get_topics()
    • ReportEnvProcessor.process()
  • SysInfoProcessor
    • SysInfoProcessor.get_topics()
    • SysInfoProcessor.process()
• nvflare.private.fed.client.training_cmds module
  • AbortAppProcessor
    • AbortAppProcessor.get_topics()
    • AbortAppProcessor.process()
  • AbortTaskProcessor
    • AbortTaskProcessor.get_topics()
    • AbortTaskProcessor.process()
  • ClientStatusProcessor
    • ClientStatusProcessor.get_topics()
    • ClientStatusProcessor.process()
  • DeleteRunNumberProcessor
    • DeleteRunNumberProcessor.get_topics()
    • DeleteRunNumberProcessor.process()
  • DeployProcessor
    • DeployProcessor.get_topics()
    • DeployProcessor.process()
  • NotifyJobStatusProcessor
    • NotifyJobStatusProcessor.get_topics()
    • NotifyJobStatusProcessor.process()
  • RestartClientProcessor
    • RestartClientProcessor.get_topics()
    • RestartClientProcessor.process()
  • ScopeInfoProcessor
    • ScopeInfoProcessor.get_topics()
    • ScopeInfoProcessor.process()
  • ShutdownClientProcessor
    • ShutdownClientProcessor.get_topics()
    • ShutdownClientProcessor.process()
  • StartAppProcessor
    • StartAppProcessor.get_topics()
    • StartAppProcessor.process()

Module contents

This is the NVFlare client package.