nvflare.private.fed.server package

Submodules

• nvflare.private.fed.server.admin module
  • FedAdminServer
    • FedAdminServer.client_dead()
    • FedAdminServer.client_heartbeat()
    • FedAdminServer.get_client_tokens()
    • FedAdminServer.send_request_to_client()
    • FedAdminServer.send_requests()
    • FedAdminServer.send_requests_and_get_reply_dict()
    • FedAdminServer.stop()
  • check_client_replies()
  • new_message()
• nvflare.private.fed.server.client_manager module
  • ClientManager
    • ClientManager.authenticate()
    • ClientManager.authenticated_client()
    • ClientManager.disable_client()
    • ClientManager.enable_client()
    • ClientManager.get_all_clients_from_inputs()
    • ClientManager.get_client_from_name()
    • ClientManager.get_clients()
    • ClientManager.get_max_clients()
    • ClientManager.get_min_clients()
    • ClientManager.has_relays()
    • ClientManager.heartbeat()
    • ClientManager.is_client_disabled()
    • ClientManager.is_from_authorized_client()
    • ClientManager.is_valid_task()
    • ClientManager.login_client()
    • ClientManager.remove_client()
    • ClientManager.set_clients()
    • ClientManager.set_disabled_clients_file()
    • ClientManager.validate_client()
• nvflare.private.fed.server.cmd_utils module
  • CommandUtil
    • CommandUtil.JOB
    • CommandUtil.JOB_ID
    • CommandUtil.TARGET_CLIENTS
    • CommandUtil.TARGET_CLIENT_NAMES
    • CommandUtil.TARGET_CLIENT_TOKENS
    • CommandUtil.TARGET_TYPE
    • CommandUtil.TARGET_TYPE_ALL
    • CommandUtil.TARGET_TYPE_CLIENT
    • CommandUtil.TARGET_TYPE_SERVER
    • CommandUtil.authorize_client_operation()
    • CommandUtil.authorize_server_operation()
    • CommandUtil.command_authz_required()
    • CommandUtil.get_job_name()
    • CommandUtil.must_be_project_admin()
    • CommandUtil.process_replies_to_table()
    • CommandUtil.send_request_to_clients()
    • CommandUtil.validate_command_targets()
• nvflare.private.fed.server.cred_keeper module
  • CredKeeper
    • CredKeeper.get_id_asserter()
    • CredKeeper.get_id_verifier()
• nvflare.private.fed.server.fed_server module
  • BaseServer
    • BaseServer.client_cleanup()
    • BaseServer.close()
    • BaseServer.deploy()
    • BaseServer.fl_shutdown()
    • BaseServer.get_all_clients()
    • BaseServer.get_cell()
    • BaseServer.logout_client()
    • BaseServer.notify_dead_client()
    • BaseServer.remove_client_data()
    • BaseServer.remove_dead_clients()
    • BaseServer.set_admin_server()
  • FederatedServer
    • FederatedServer.abort_run()
    • FederatedServer.authentication_check()
    • FederatedServer.client_challenge()
    • FederatedServer.client_heartbeat()
    • FederatedServer.close()
    • FederatedServer.create_job_cell()
    • FederatedServer.create_run_manager()
    • FederatedServer.deploy()
    • FederatedServer.fl_shutdown()
    • FederatedServer.notify_dead_client()
    • FederatedServer.process_job_failure()
    • FederatedServer.quit_client()
    • FederatedServer.register_client()
    • FederatedServer.remove_client_data()
    • FederatedServer.reset_tokens()
    • FederatedServer.run_engine()
    • FederatedServer.sign_auth_token()
    • FederatedServer.start_run()
    • FederatedServer.stop_run_engine_cell()
    • FederatedServer.stop_training()
    • FederatedServer.task_meta_info()
    • FederatedServer.verify_auth_token()
• nvflare.private.fed.server.info_coll_cmd module
  • InfoCollectorCommandModule
    • InfoCollectorCommandModule.CONN_KEY_COLLECTOR
    • InfoCollectorCommandModule.authorize_info_collection()
    • InfoCollectorCommandModule.get_spec()
    • InfoCollectorCommandModule.reset_errors()
    • InfoCollectorCommandModule.show_errors()
    • InfoCollectorCommandModule.show_stats()
• nvflare.private.fed.server.job_cmds module
  • JobCommandModule
    • JobCommandModule.MAX_RETURNED_JOB_LOG_BYTES
    • JobCommandModule.abort_job()
    • JobCommandModule.authorize_configure_job_log()
    • JobCommandModule.authorize_job()
    • JobCommandModule.authorize_job_file()
    • JobCommandModule.authorize_job_id()
    • JobCommandModule.clone_job()
    • JobCommandModule.configure_job_log()
    • JobCommandModule.delete_job()
    • JobCommandModule.delete_job_id()
    • JobCommandModule.do_app_command()
    • JobCommandModule.download_job()
    • JobCommandModule.download_job_components()
    • JobCommandModule.get_job_log()
    • JobCommandModule.get_job_meta()
    • JobCommandModule.get_spec()
    • JobCommandModule.list_job_components()
    • JobCommandModule.list_jobs()
    • JobCommandModule.submit_job()
• nvflare.private.fed.server.job_meta_validator module
  • JobMetaValidator
    • JobMetaValidator.validate()
• nvflare.private.fed.server.job_runner module
  • JobRunner
    • JobRunner.abort_client_run()
    • JobRunner.fail_run()
    • JobRunner.handle_event()
    • JobRunner.mark_run_aborted()
    • JobRunner.remove_running_job()
    • JobRunner.restore_running_job()
    • JobRunner.run()
    • JobRunner.stop()
    • JobRunner.stop_all_runs()
    • JobRunner.stop_run()
    • JobRunner.update_abnormal_finished_jobs()
    • JobRunner.update_unfinished_jobs()
• nvflare.private.fed.server.message_send module
  • ClientReply
  • send_requests()
• nvflare.private.fed.server.run_info module
  • RunInfo
• nvflare.private.fed.server.run_manager module
  • RunManager
    • RunManager.add_component()
    • RunManager.add_handler()
    • RunManager.create_job_processing_context_properties()
    • RunManager.fire_event()
    • RunManager.get_cell()
    • RunManager.get_component()
    • RunManager.get_handlers()
    • RunManager.get_run_info()
    • RunManager.get_server_name()
    • RunManager.get_workspace()
    • RunManager.new_context()
    • RunManager.validate_targets()
• nvflare.private.fed.server.server_app_runner module
  • ServerAppRunner
    • ServerAppRunner.start_server_app()
    • ServerAppRunner.stop()
    • ServerAppRunner.sync_up_parents_process()
    • ServerAppRunner.update_job_run_status()
• nvflare.private.fed.server.server_cmd_modules module
  • ServerCommandModules
    • ServerCommandModules.cmd_modules
    • ServerCommandModules.register_cmd_module()
• nvflare.private.fed.server.server_command_agent module
  • ServerCommandAgent
    • ServerCommandAgent.aux_communicate()
    • ServerCommandAgent.execute_command()
    • ServerCommandAgent.shutdown()
    • ServerCommandAgent.start()
• nvflare.private.fed.server.server_commands module
  • AbortCommand
    • AbortCommand.get_command_name()
    • AbortCommand.process()
  • AppCommandProcessor
    • AppCommandProcessor.get_command_name()
    • AppCommandProcessor.process()
  • ByeCommand
    • ByeCommand.get_command_name()
    • ByeCommand.process()
  • CommandProcessor
    • CommandProcessor.get_command_name()
    • CommandProcessor.process()
  • ConfigureJobLogCommand
    • ConfigureJobLogCommand.get_command_name()
    • ConfigureJobLogCommand.process()
  • GetErrorsCommand
    • GetErrorsCommand.get_command_name()
    • GetErrorsCommand.process()
  • GetRunInfoCommand
    • GetRunInfoCommand.get_command_name()
    • GetRunInfoCommand.process()
  • GetTaskCommand
    • GetTaskCommand.get_command_name()
    • GetTaskCommand.get_state_check()
    • GetTaskCommand.process()
  • HandleDeadJobCommand
    • HandleDeadJobCommand.get_command_name()
    • HandleDeadJobCommand.process()
  • HeartbeatCommand
    • HeartbeatCommand.get_command_name()
    • HeartbeatCommand.process()
  • ResetErrorsCommand
    • ResetErrorsCommand.get_command_name()
    • ResetErrorsCommand.process()
  • ServerCommands
    • ServerCommands.app_cmd_registry
    • ServerCommands.client_request_commands_names
    • ServerCommands.commands
    • ServerCommands.get_app_command()
    • ServerCommands.get_command()
    • ServerCommands.register_app_command()
  • ServerStateCheck
    • ServerStateCheck.get_state_check()
  • ServerStateCommand
    • ServerStateCommand.get_command_name()
    • ServerStateCommand.process()
  • ShowStatsCommand
    • ShowStatsCommand.get_command_name()
    • ShowStatsCommand.process()
  • SubmitUpdateCommand
    • SubmitUpdateCommand.get_command_name()
    • SubmitUpdateCommand.get_state_check()
    • SubmitUpdateCommand.process()
• nvflare.private.fed.server.server_engine module
  • ServerEngine
    • ServerEngine.abort_app_on_clients()
    • ServerEngine.abort_app_on_server()
    • ServerEngine.add_component()
    • ServerEngine.ask_to_stop()
    • ServerEngine.build_component()
    • ServerEngine.cancel_client_resources()
    • ServerEngine.check_app_start_readiness()
    • ServerEngine.check_client_resources()
    • ServerEngine.close()
    • ServerEngine.configure_job_log()
    • ServerEngine.delete_job_id()
    • ServerEngine.deploy_app()
    • ServerEngine.deploy_app_to_server()
    • ServerEngine.disable_clients()
    • ServerEngine.dispatch()
    • ServerEngine.enable_clients()
    • ServerEngine.fire_event()
    • ServerEngine.get_app_data()
    • ServerEngine.get_app_run_info()
    • ServerEngine.get_cell()
    • ServerEngine.get_client_from_name()
    • ServerEngine.get_client_name_from_token()
    • ServerEngine.get_clients()
    • ServerEngine.get_component()
    • ServerEngine.get_engine_info()
    • ServerEngine.get_errors()
    • ServerEngine.get_job_clients()
    • ServerEngine.get_participating_clients()
    • ServerEngine.get_run_info()
    • ServerEngine.get_staging_path_of_app()
    • ServerEngine.get_widget()
    • ServerEngine.get_workspace()
    • ServerEngine.has_relays()
    • ServerEngine.initialize_comm()
    • ServerEngine.multicast_aux_requests()
    • ServerEngine.new_context()
    • ServerEngine.notify_dead_job()
    • ServerEngine.pause_server_jobs()
    • ServerEngine.persist_components()
    • ServerEngine.register_app_command()
    • ServerEngine.register_aux_message_handler()
    • ServerEngine.register_stream_processing()
    • ServerEngine.remove_clients()
    • ServerEngine.remove_custom_path()
    • ServerEngine.remove_exception_process()
    • ServerEngine.reset_errors()
    • ServerEngine.restart_server()
    • ServerEngine.restore_components()
    • ServerEngine.send_app_command()
    • ServerEngine.send_aux_request()
    • ServerEngine.send_aux_to_targets()
    • ServerEngine.send_command_to_child_runner_process()
    • ServerEngine.set_configurator()
    • ServerEngine.set_job_runner()
    • ServerEngine.set_run_manager()
    • ServerEngine.show_stats()
    • ServerEngine.shutdown_server()
    • ServerEngine.shutdown_streamer()
    • ServerEngine.start_app_on_server()
    • ServerEngine.start_client_job()
    • ServerEngine.stop_all_jobs()
    • ServerEngine.stream_objects()
    • ServerEngine.sync_clients_from_main_process()
    • ServerEngine.update_job_run_status()
    • ServerEngine.validate_targets()
    • ServerEngine.wait_for_complete()
  • server_shutdown()
• nvflare.private.fed.server.server_engine_internal_spec module
  • EngineInfo
  • ServerEngineInternalSpec
    • ServerEngineInternalSpec.abort_app_on_clients()
    • ServerEngineInternalSpec.abort_app_on_server()
    • ServerEngineInternalSpec.ask_to_stop()
    • ServerEngineInternalSpec.build_component()
    • ServerEngineInternalSpec.check_app_start_readiness()
    • ServerEngineInternalSpec.delete_job_id()
    • ServerEngineInternalSpec.deploy_app_to_server()
    • ServerEngineInternalSpec.disable_clients()
    • ServerEngineInternalSpec.enable_clients()
    • ServerEngineInternalSpec.get_app_data()
    • ServerEngineInternalSpec.get_app_run_info()
    • ServerEngineInternalSpec.get_client_from_name()
    • ServerEngineInternalSpec.get_engine_info()
    • ServerEngineInternalSpec.get_errors()
    • ServerEngineInternalSpec.get_job_clients()
    • ServerEngineInternalSpec.get_staging_path_of_app()
    • ServerEngineInternalSpec.remove_clients()
    • ServerEngineInternalSpec.reset_errors()
    • ServerEngineInternalSpec.restart_server()
    • ServerEngineInternalSpec.send_app_command()
    • ServerEngineInternalSpec.set_configurator()
    • ServerEngineInternalSpec.set_job_runner()
    • ServerEngineInternalSpec.set_run_manager()
    • ServerEngineInternalSpec.show_stats()
    • ServerEngineInternalSpec.shutdown_server()
    • ServerEngineInternalSpec.start_app_on_server()
• nvflare.private.fed.server.server_json_config module
  • ServerJsonConfigurator
    • ServerJsonConfigurator.finalize_config()
    • ServerJsonConfigurator.process_config_element()
  • WorkFlow
• nvflare.private.fed.server.server_runner module
  • ServerRunner
    • ServerRunner.ABORT_RETURN_CODES
    • ServerRunner.abort()
    • ServerRunner.get_persist_state()
    • ServerRunner.handle_dead_job()
    • ServerRunner.handle_event()
    • ServerRunner.process_submission()
    • ServerRunner.process_task_request()
    • ServerRunner.restore()
    • ServerRunner.run()
  • ServerRunnerConfig
    • ServerRunnerConfig.add_component()
• nvflare.private.fed.server.server_state module
  • HotState
    • HotState.aux_communicate()
    • HotState.get_task()
    • HotState.heartbeat()
    • HotState.register()
    • HotState.submit_result()
  • ServerState
    • ServerState.ABORT_CURRENT_RUN
    • ServerState.IN_SERVICE
    • ServerState.NOT_IN_SERVICE
    • ServerState.aux_communicate()
    • ServerState.get_task()
    • ServerState.heartbeat()
    • ServerState.logger
    • ServerState.register()
    • ServerState.submit_result()
• nvflare.private.fed.server.server_status module
  • ServerStatus
    • ServerStatus.NOT_STARTED
    • ServerStatus.SHUTDOWN
    • ServerStatus.STARTED
    • ServerStatus.STARTING
    • ServerStatus.STOPPED
    • ServerStatus.status_messages
  • get_status_message()
• nvflare.private.fed.server.shell_cmd module
  • ShellCommandModule
    • ShellCommandModule.get_spec()
• nvflare.private.fed.server.site_security module
  • SiteSecurity
    • SiteSecurity.authorization_check()
• nvflare.private.fed.server.study_cmds module
  • StudyCommandModule
    • StudyCommandModule.authorize_list_studies()
    • StudyCommandModule.authorize_study_admin()
    • StudyCommandModule.cmd_add_study_site()
    • StudyCommandModule.cmd_add_study_user()
    • StudyCommandModule.cmd_list_studies()
    • StudyCommandModule.cmd_register_study()
    • StudyCommandModule.cmd_remove_study()
    • StudyCommandModule.cmd_remove_study_site()
    • StudyCommandModule.cmd_remove_study_user()
    • StudyCommandModule.cmd_show_study()
    • StudyCommandModule.get_spec()
• nvflare.private.fed.server.sys_cmd module
  • SystemCommandModule
    • SystemCommandModule.authorize_configure_site_log()
    • SystemCommandModule.configure_site_log()
    • SystemCommandModule.dead_client()
    • SystemCommandModule.get_spec()
    • SystemCommandModule.report_env()
    • SystemCommandModule.report_resources()
    • SystemCommandModule.report_version()
    • SystemCommandModule.sys_info()
• nvflare.private.fed.server.training_cmds module
  • TrainingCommandModule
    • TrainingCommandModule.check_status()
    • TrainingCommandModule.disable_client()
    • TrainingCommandModule.enable_client()
    • TrainingCommandModule.get_spec()
    • TrainingCommandModule.remove_client()
    • TrainingCommandModule.restart()
    • TrainingCommandModule.show_scopes()
    • TrainingCommandModule.shutdown()

Module contents