nvflare.apis package¶
Subpackages¶
- nvflare.apis.impl package
- Submodules
- nvflare.apis.impl.any_relay_manager module
- nvflare.apis.impl.bcast_manager module
- nvflare.apis.impl.controller module
- nvflare.apis.impl.job_def_manager module
- nvflare.apis.impl.send_manager module
- nvflare.apis.impl.seq_relay_manager module
- nvflare.apis.impl.task_controller module
- nvflare.apis.impl.task_manager module
- Module contents
- Submodules
- nvflare.apis.utils package
Submodules¶
- nvflare.apis.analytix module
AnalyticsDataAnalyticsDataTypeAnalyticsDataType.IMAGEAnalyticsDataType.INIT_DATAAnalyticsDataType.LOG_RECORDAnalyticsDataType.METRICAnalyticsDataType.METRICSAnalyticsDataType.MODELAnalyticsDataType.PARAMETERAnalyticsDataType.PARAMETERSAnalyticsDataType.SCALARAnalyticsDataType.SCALARSAnalyticsDataType.TAGAnalyticsDataType.TAGSAnalyticsDataType.TEXT
- nvflare.apis.app_deployer_spec module
- nvflare.apis.app_validation module
- nvflare.apis.aux_spec module
- nvflare.apis.client module
- nvflare.apis.client_engine_spec module
- nvflare.apis.controller_spec module
ClientTaskControllerSpecControllerSpec.broadcast()ControllerSpec.broadcast_and_wait()ControllerSpec.broadcast_forever()ControllerSpec.cancel_all_tasks()ControllerSpec.cancel_task()ControllerSpec.get_num_standing_tasks()ControllerSpec.process_result_of_unknown_task()ControllerSpec.relay()ControllerSpec.relay_and_wait()ControllerSpec.send()ControllerSpec.send_and_wait()ControllerSpec.start_controller()ControllerSpec.stop_controller()
OperatorConfigKeyOperatorMethodSendOrderTaskTaskCompletionStatusTaskOperatorKeyTaskOperatorKey.AGGREGATORTaskOperatorKey.DATA_FILTERSTaskOperatorKey.METHODTaskOperatorKey.MIN_TARGETSTaskOperatorKey.NUM_ROUNDSTaskOperatorKey.OP_IDTaskOperatorKey.PERSISTORTaskOperatorKey.RESULT_FILTERSTaskOperatorKey.SHAREABLE_GENERATORTaskOperatorKey.TARGETSTaskOperatorKey.TASK_ASSIGNMENT_TIMEOUTTaskOperatorKey.TIMEOUTTaskOperatorKey.WAIT_TIME_AFTER_MIN_RESPS
after_task_sent_cb_signature()before_task_sent_cb_signature()result_received_cb_signature()task_done_cb_signature()
- nvflare.apis.dxo module
- nvflare.apis.dxo_filter module
- nvflare.apis.engine_spec module
- nvflare.apis.event_type module
EventTypeEventType.ABORT_TASKEventType.ABOUT_TO_END_RUNEventType.ABOUT_TO_START_RUNEventType.AFTER_CHECK_CLIENT_RESOURCESEventType.AFTER_CLIENT_REGISTEREventType.AFTER_PROCESS_SUBMISSIONEventType.AFTER_PULL_TASKEventType.AFTER_SEND_TASK_RESULTEventType.AFTER_TASK_DATA_FILTEREventType.AFTER_TASK_EXECUTIONEventType.AFTER_TASK_RESULT_FILTEREventType.AUTHORIZE_COMMAND_CHECKEventType.BEFORE_BUILD_COMPONENTEventType.BEFORE_CHECK_CLIENT_RESOURCESEventType.BEFORE_CHECK_RESOURCE_MANAGEREventType.BEFORE_CLIENT_REGISTEREventType.BEFORE_PROCESS_SUBMISSIONEventType.BEFORE_PULL_TASKEventType.BEFORE_SEND_ADMIN_COMMANDEventType.BEFORE_SEND_TASK_RESULTEventType.BEFORE_TASK_DATA_FILTEREventType.BEFORE_TASK_EXECUTIONEventType.BEFORE_TASK_RESULT_FILTEREventType.CLIENT_REGISTEREDEventType.CRITICAL_LOG_AVAILABLEEventType.DEBUG_LOG_AVAILABLEEventType.DEPLOY_JOB_TO_CLIENTEventType.DEPLOY_JOB_TO_SERVEREventType.END_RUNEventType.END_WORKFLOWEventType.ERROR_LOG_AVAILABLEEventType.EXCEPTION_LOG_AVAILABLEEventType.FATAL_SYSTEM_ERROREventType.INFO_LOG_AVAILABLEEventType.JOB_ABORTEDEventType.JOB_CANCELLEDEventType.JOB_COMPLETEDEventType.JOB_DEPLOYEDEventType.JOB_STARTEDEventType.PRE_RUN_RESULT_AVAILABLEEventType.START_RUNEventType.START_WORKFLOWEventType.SWAP_INEventType.SWAP_OUTEventType.SYSTEM_BOOTSTRAPEventType.SYSTEM_ENDEventType.SYSTEM_STARTEventType.WARNING_LOG_AVAILABLE
- nvflare.apis.executor module
- nvflare.apis.filter module
- nvflare.apis.fl_component module
- nvflare.apis.fl_constant module
AdminCommandNamesAdminCommandNames.ABORTAdminCommandNames.ABORT_JOBAdminCommandNames.ABORT_TASKAdminCommandNames.ADMIN_CHECK_STATUSAdminCommandNames.AUX_COMMANDAdminCommandNames.CALLAdminCommandNames.CHECK_RESOURCESAdminCommandNames.CHECK_STATUSAdminCommandNames.CLONE_JOBAdminCommandNames.DELETE_JOBAdminCommandNames.DELETE_WORKSPACEAdminCommandNames.DEPLOY_APPAdminCommandNames.DOWNLOAD_JOBAdminCommandNames.DOWNLOAD_JOB_FILEAdminCommandNames.GET_JOB_METAAdminCommandNames.LIST_JOBSAdminCommandNames.REMOVE_CLIENTAdminCommandNames.REPORT_RESOURCESAdminCommandNames.RESET_ERRORSAdminCommandNames.RESTARTAdminCommandNames.SET_TIMEOUTAdminCommandNames.SHELL_CATAdminCommandNames.SHELL_GREPAdminCommandNames.SHELL_HEADAdminCommandNames.SHELL_LSAdminCommandNames.SHELL_PWDAdminCommandNames.SHELL_TAILAdminCommandNames.SHOW_ERRORSAdminCommandNames.SHOW_SCOPESAdminCommandNames.SHOW_STATSAdminCommandNames.SHUTDOWNAdminCommandNames.START_APPAdminCommandNames.SUBMIT_JOBAdminCommandNames.SYS_INFO
ConfigVarNameEventScopeFLContextKeyFLContextKey.APP_ROOTFLContextKey.ARGSFLContextKey.AUTHORIZATION_REASONFLContextKey.AUTHORIZATION_RESULTFLContextKey.CLIENT_NAMEFLContextKey.CLIENT_REGISTER_DATAFLContextKey.CLIENT_RESOURCE_SPECSFLContextKey.CLIENT_TOKENFLContextKey.COMMAND_NAMEFLContextKey.COMMUNICATION_ERRORFLContextKey.COMPONENT_BUILD_ERRORFLContextKey.COMPONENT_CONFIGFLContextKey.COMPONENT_NODEFLContextKey.CONFIG_CTXFLContextKey.CURRENT_JOB_IDFLContextKey.CURRENT_RUNFLContextKey.CUSTOM_PROPSFLContextKey.EFFECTIVE_JOB_SCOPE_NAMEFLContextKey.EVENT_DATAFLContextKey.EVENT_IDFLContextKey.EVENT_ORIGINFLContextKey.EVENT_ORIGIN_SITEFLContextKey.EVENT_SCOPEFLContextKey.EXCEPTIONSFLContextKey.FATAL_SYSTEM_ERRORFLContextKey.FILTER_DIRECTIONFLContextKey.FROM_RANK_NUMBERFLContextKey.IS_CLIENT_TASK_RESENDFLContextKey.JOB_BLOCK_REASONFLContextKey.JOB_DEPLOY_DETAILFLContextKey.JOB_INFOFLContextKey.JOB_METAFLContextKey.JOB_PARTICIPANTSFLContextKey.JOB_RUN_NUMBERFLContextKey.JOB_SCOPE_NAMEFLContextKey.NUM_OF_PROCESSESFLContextKey.PEER_CONTEXTFLContextKey.RANK_NUMBERFLContextKey.REPLYFLContextKey.RUNNERFLContextKey.RUN_ABORT_SIGNALFLContextKey.SCOPE_OBJECTFLContextKey.SCOPE_PROPERTIESFLContextKey.SECURE_MODEFLContextKey.SECURITY_ITEMSFLContextKey.SHAREABLEFLContextKey.SIMULATE_MODEFLContextKey.SITE_NAMEFLContextKey.SP_END_POINTFLContextKey.SSIDFLContextKey.SUBMITTER_NAMEFLContextKey.SUBMITTER_ORGFLContextKey.SUBMITTER_ROLEFLContextKey.TASK_DATAFLContextKey.TASK_IDFLContextKey.TASK_NAMEFLContextKey.TASK_RESULTFLContextKey.UNAUTHENTICATEDFLContextKey.USER_NAMEFLContextKey.USER_ORGFLContextKey.USER_ROLEFLContextKey.WORKFLOWFLContextKey.WORKSPACE_OBJECTFLContextKey.WORKSPACE_ROOT
FLMetaKeyFedEventHeaderFilterKeyJobConstantsLogMessageTagMachineStatusNonSerializableKeysReservedKeyReservedKey.APP_ROOTReservedKey.ARGSReservedKey.AUDIT_EVENT_IDReservedKey.AUX_RUNNERReservedKey.CLIENT_NAMEReservedKey.COOKIE_JARReservedKey.CURRENT_JOB_IDReservedKey.CUSTOM_PROPSReservedKey.ENGINEReservedKey.EVENT_DATAReservedKey.EVENT_IDReservedKey.EVENT_ORIGINReservedKey.EVENT_ORIGIN_SITEReservedKey.EVENT_SCOPEReservedKey.EXCEPTIONSReservedKey.FATAL_SYSTEM_ERRORReservedKey.FROM_RANK_NUMBERReservedKey.IDENTITY_NAMEReservedKey.IS_RESENDReservedKey.JOB_DEPLOY_DETAILReservedKey.JOB_INFOReservedKey.JOB_IS_UNSAFEReservedKey.JOB_METAReservedKey.JOB_RUN_NUMBERReservedKey.MANAGERReservedKey.NUM_OF_PROCESSESReservedKey.PEER_CTXReservedKey.RANK_NUMBERReservedKey.RCReservedKey.REPLYReservedKey.RUNNERReservedKey.RUN_ABORT_SIGNALReservedKey.RUN_NUMReservedKey.SECURE_MODEReservedKey.SHAREABLEReservedKey.SHARED_FL_CONTEXTReservedKey.SIMULATE_MODEReservedKey.SP_END_POINTReservedKey.TASK_DATAReservedKey.TASK_IDReservedKey.TASK_NAMEReservedKey.TASK_RESULTReservedKey.WORKFLOWReservedKey.WORKSPACE_OBJECTReservedKey.WORKSPACE_ROOT
ReservedTopicReturnCodeReturnCode.BAD_PEER_CONTEXTReturnCode.BAD_REQUEST_DATAReturnCode.BAD_TASK_DATAReturnCode.COMMUNICATION_ERRORReturnCode.EMPTY_RESULTReturnCode.ERRORReturnCode.EXECUTION_EXCEPTIONReturnCode.EXECUTION_RESULT_ERRORReturnCode.HANDLER_EXCEPTIONReturnCode.MISSING_PEER_CONTEXTReturnCode.MODEL_UNRECOGNIZEDReturnCode.OKReturnCode.RUN_MISMATCHReturnCode.SERVER_NOT_READYReturnCode.SERVICE_UNAVAILABLEReturnCode.TASK_ABORTEDReturnCode.TASK_DATA_FILTER_ERRORReturnCode.TASK_RESULT_FILTER_ERRORReturnCode.TASK_UNKNOWNReturnCode.TASK_UNSUPPORTEDReturnCode.TOPIC_UNKNOWNReturnCode.UNSAFE_JOBReturnCode.VALIDATE_TYPE_UNKNOWN
RunProcessKeySecureTrainConstServerCommandKeyServerCommandKey.AUX_REPLYServerCommandKey.CLIENTSServerCommandKey.COLLECTORServerCommandKey.COMMANDServerCommandKey.DATAServerCommandKey.FL_CLIENTServerCommandKey.FL_CONTEXTServerCommandKey.JOB_IDServerCommandKey.PEER_FL_CONTEXTServerCommandKey.SHAREABLEServerCommandKey.TASK_IDServerCommandKey.TASK_NAMEServerCommandKey.TOPICServerCommandKey.TURN_TO_COLD
ServerCommandNamesServerCommandNames.AUX_COMMUNICATEServerCommandNames.AUX_SENDServerCommandNames.GET_CLIENTSServerCommandNames.GET_ERRORSServerCommandNames.GET_RUN_INFOServerCommandNames.GET_TASKServerCommandNames.HANDLE_DEAD_JOBServerCommandNames.HEARTBEATServerCommandNames.RESET_ERRORSServerCommandNames.SERVER_STATEServerCommandNames.SHOW_STATSServerCommandNames.SUBMIT_UPDATEServerCommandNames.UPDATE_RUN_STATUS
SiteTypeSnapshotKeySystemComponentsSystemComponents.APP_DEPLOYERSystemComponents.CANCEL_RESOURCE_PROCESSORSystemComponents.CHECK_RESOURCE_PROCESSORSystemComponents.CLIENT_RUNNERSystemComponents.DEFAULT_APP_DEPLOYERSystemComponents.JOB_MANAGERSystemComponents.JOB_META_VALIDATORSystemComponents.JOB_RUNNERSystemComponents.JOB_SCHEDULERSystemComponents.RESOURCE_CONSUMERSystemComponents.RESOURCE_MANAGERSystemComponents.SERVER_RUNNER
SystemConfigsWorkspaceConstantsWorkspaceConstants.ADMIN_STARTUP_CONFIGWorkspaceConstants.APP_PREFIXWorkspaceConstants.AUDIT_LOGWorkspaceConstants.AUTHORIZATION_CONFIGWorkspaceConstants.CLIENT_APP_CONFIGWorkspaceConstants.CLIENT_STARTUP_CONFIGWorkspaceConstants.CUSTOM_FOLDER_NAMEWorkspaceConstants.DEFAULT_AUTHORIZATION_CONFIGWorkspaceConstants.DEFAULT_LOGGING_CONFIGWorkspaceConstants.DEFAULT_RESOURCES_CONFIGWorkspaceConstants.JOB_META_FILEWorkspaceConstants.JOB_RESOURCES_CONFIGWorkspaceConstants.LOGGING_CONFIGWorkspaceConstants.LOG_FILE_NAMEWorkspaceConstants.PRIVACY_CONFIGWorkspaceConstants.RESOURCES_CONFIGWorkspaceConstants.RESTART_FILEWorkspaceConstants.SAMPLE_PRIVACY_CONFIGWorkspaceConstants.SERVER_APP_CONFIGWorkspaceConstants.SERVER_STARTUP_CONFIGWorkspaceConstants.SHUTDOWN_FILEWorkspaceConstants.SITE_FOLDER_NAMEWorkspaceConstants.STARTUP_FOLDER_NAMEWorkspaceConstants.STATS_POOL_RECORDS_FILE_NAMEWorkspaceConstants.STATS_POOL_SUMMARY_FILE_NAMEWorkspaceConstants.WORKSPACE_PREFIX
- nvflare.apis.fl_context module
FLContextFLContext.get_all_public_props()FLContext.get_custom_prop()FLContext.get_engine()FLContext.get_identity_name()FLContext.get_job_id()FLContext.get_peer_context()FLContext.get_prop()FLContext.get_prop_detail()FLContext.get_prop_keys()FLContext.get_run_abort_signal()FLContext.is_job_unsafe()FLContext.public_key_exists()FLContext.put()FLContext.remove_prop()FLContext.set_custom_prop()FLContext.set_job_is_unsafe()FLContext.set_peer_context()FLContext.set_prop()FLContext.set_public_props()FLContext.sync_sticky()
FLContextManageris_private()is_sticky()make_mask()to_string()
- nvflare.apis.fl_exception module
- nvflare.apis.fl_snapshot module
- nvflare.apis.job_def module
JobJobDataKeyJobMetaKeyJobMetaKey.APPROVALSJobMetaKey.CLONED_FROMJobMetaKey.CONTENT_LOCATIONJobMetaKey.CUSTOM_PROPSJobMetaKey.DEPLOY_MAPJobMetaKey.DURATIONJobMetaKey.FROM_HUB_SITEJobMetaKey.JOB_DEPLOY_DETAILJobMetaKey.JOB_FOLDER_NAMEJobMetaKey.JOB_IDJobMetaKey.JOB_NAMEJobMetaKey.LAST_SCHEDULE_TIMEJobMetaKey.MANDATORY_CLIENTSJobMetaKey.MIN_CLIENTSJobMetaKey.RESOURCE_SPECJobMetaKey.RESULT_LOCATIONJobMetaKey.SCHEDULE_COUNTJobMetaKey.SCHEDULE_HISTORYJobMetaKey.SCOPEJobMetaKey.START_TIMEJobMetaKey.STATS_POOL_CONFIGJobMetaKey.STATUSJobMetaKey.SUBMITTER_NAMEJobMetaKey.SUBMITTER_ORGJobMetaKey.SUBMITTER_ROLEJobMetaKey.SUBMIT_TIMEJobMetaKey.SUBMIT_TIME_ISO
RunStatusTopDirget_custom_prop()get_custom_props()is_valid_job_id()job_from_meta()new_job_id()
- nvflare.apis.job_def_manager_spec module
JobDefManagerSpecJobDefManagerSpec.create()JobDefManagerSpec.delete()JobDefManagerSpec.get_all_jobs()JobDefManagerSpec.get_app()JobDefManagerSpec.get_apps()JobDefManagerSpec.get_content()JobDefManagerSpec.get_job()JobDefManagerSpec.get_job_data()JobDefManagerSpec.get_jobs_by_status()JobDefManagerSpec.get_jobs_waiting_for_review()JobDefManagerSpec.get_storage_component()JobDefManagerSpec.get_storage_for_download()JobDefManagerSpec.refresh_meta()JobDefManagerSpec.save_workspace()JobDefManagerSpec.set_approval()JobDefManagerSpec.set_status()JobDefManagerSpec.update_meta()
- nvflare.apis.job_meta_validator_spec module
- nvflare.apis.job_scheduler_spec module
- nvflare.apis.operator_spec module
- nvflare.apis.overseer_spec module
- nvflare.apis.persistable module
- nvflare.apis.resource_manager_spec module
- nvflare.apis.responder module
- nvflare.apis.server_engine_spec module
ServerEngineSpecServerEngineSpec.cancel_client_resources()ServerEngineSpec.check_client_resources()ServerEngineSpec.fire_and_forget_aux_request()ServerEngineSpec.fire_event()ServerEngineSpec.get_client_name_from_token()ServerEngineSpec.get_clients()ServerEngineSpec.get_component()ServerEngineSpec.get_widget()ServerEngineSpec.get_workspace()ServerEngineSpec.new_context()ServerEngineSpec.persist_components()ServerEngineSpec.register_aux_message_handler()ServerEngineSpec.restore_components()ServerEngineSpec.send_aux_request()ServerEngineSpec.start_client_job()ServerEngineSpec.sync_clients_from_main_process()ServerEngineSpec.update_job_run_status()
- nvflare.apis.shareable module
ReservedHeaderKeyReservedHeaderKey.AUDIT_EVENT_IDReservedHeaderKey.CONTENT_TYPEReservedHeaderKey.COOKIE_JARReservedHeaderKey.HEADERSReservedHeaderKey.PEER_PROPSReservedHeaderKey.RCReservedHeaderKey.REPLY_IS_LATEReservedHeaderKey.TASK_IDReservedHeaderKey.TASK_NAMEReservedHeaderKey.TASK_OPERATORReservedHeaderKey.TOPICReservedHeaderKey.WORKFLOW
ShareableShareable.add_cookie()Shareable.from_bytes()Shareable.get_cookie()Shareable.get_cookie_jar()Shareable.get_header()Shareable.get_peer_prop()Shareable.get_peer_props()Shareable.get_return_code()Shareable.set_cookie_jar()Shareable.set_header()Shareable.set_peer_props()Shareable.set_return_code()Shareable.to_bytes()
make_copy()make_reply()
- nvflare.apis.signal module
- nvflare.apis.state_persistor module
- nvflare.apis.storage module
- nvflare.apis.workspace module
WorkspaceWorkspace.get_admin_startup_file_path()Workspace.get_app_config_dir()Workspace.get_app_custom_dir()Workspace.get_app_dir()Workspace.get_app_log_file_path()Workspace.get_audit_file_path()Workspace.get_authorization_file_path()Workspace.get_client_app_config_file_path()Workspace.get_client_custom_dir()Workspace.get_client_startup_file_path()Workspace.get_file_path_in_root()Workspace.get_file_path_in_site_config()Workspace.get_file_path_in_startup()Workspace.get_job_meta_path()Workspace.get_job_resources_file_path()Workspace.get_log_config_file_path()Workspace.get_log_file_path()Workspace.get_resources_file_path()Workspace.get_root_dir()Workspace.get_run_dir()Workspace.get_server_app_config_file_path()Workspace.get_server_startup_file_path()Workspace.get_site_config_dir()Workspace.get_site_custom_dir()Workspace.get_site_privacy_file_path()Workspace.get_startup_kit_dir()Workspace.get_stats_pool_records_path()Workspace.get_stats_pool_summary_path()