nvflare.apis package¶
Subpackages¶
- nvflare.apis.impl package
- Submodules
- Module contents
- nvflare.apis.utils package
Submodules¶
- nvflare.apis.analytix 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.abort_all_tasks()ControllerSpec.abort_task()ControllerSpec.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()
SendOrderTaskTaskCompletionStatusafter_task_sent_cb_signature()before_task_sent_cb_signature()result_received_cb_signature()task_done_cb_signature()
- nvflare.apis.dxo module
- nvflare.apis.event_type module
EventTypeEventType.ABORT_TASKEventType.ABOUT_TO_END_RUNEventType.ABOUT_TO_START_RUNEventType.AFTER_PROCESS_SUBMISSIONEventType.AFTER_PULL_TASKEventType.AFTER_SEND_TASK_RESULTEventType.AFTER_TASK_DATA_FILTEREventType.AFTER_TASK_EXECUTIONEventType.AFTER_TASK_RESULT_FILTEREventType.BEFORE_PROCESS_SUBMISSIONEventType.BEFORE_PULL_TASKEventType.BEFORE_SEND_TASK_RESULTEventType.BEFORE_TASK_DATA_FILTEREventType.BEFORE_TASK_EXECUTIONEventType.BEFORE_TASK_RESULT_FILTEREventType.CRITICAL_LOG_AVAILABLEEventType.DEBUG_LOG_AVAILABLEEventType.END_RUNEventType.END_WORKFLOWEventType.ERROR_LOG_AVAILABLEEventType.EXCEPTION_LOG_AVAILABLEEventType.FATAL_SYSTEM_ERROREventType.FATAL_TASK_ERROREventType.INFO_LOG_AVAILABLEEventType.JOB_ABORTEDEventType.JOB_CANCELLEDEventType.JOB_COMPLETEDEventType.JOB_DEPLOYEDEventType.JOB_STARTEDEventType.START_RUNEventType.START_WORKFLOWEventType.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.AUX_COMMANDAdminCommandNames.CHECK_STATUSAdminCommandNames.CLONE_JOBAdminCommandNames.DELETE_JOBAdminCommandNames.DELETE_WORKSPACEAdminCommandNames.DEPLOY_APPAdminCommandNames.DOWNLOAD_JOBAdminCommandNames.LIST_JOBSAdminCommandNames.REMOVE_CLIENTAdminCommandNames.RESET_ERRORSAdminCommandNames.RESTARTAdminCommandNames.SET_TIMEOUTAdminCommandNames.SHOW_ERRORSAdminCommandNames.SHOW_STATSAdminCommandNames.SHUTDOWNAdminCommandNames.START_APPAdminCommandNames.SUBMIT_JOB
EventScopeFLContextKeyFLContextKey.APP_ROOTFLContextKey.ARGSFLContextKey.CLIENT_NAMEFLContextKey.CURRENT_JOB_IDFLContextKey.CURRENT_RUNFLContextKey.EVENT_DATAFLContextKey.EVENT_IDFLContextKey.EVENT_ORIGINFLContextKey.EVENT_ORIGIN_SITEFLContextKey.EVENT_SCOPEFLContextKey.FROM_RANK_NUMBERFLContextKey.IS_CLIENT_TASK_RESENDFLContextKey.JOB_INFOFLContextKey.JOB_RUN_NUMBERFLContextKey.NUM_OF_PROCESSESFLContextKey.PEER_CONTEXTFLContextKey.RANK_NUMBERFLContextKey.REPLYFLContextKey.RUNNERFLContextKey.RUN_ABORT_SIGNALFLContextKey.SECURE_MODEFLContextKey.SHAREABLEFLContextKey.SP_END_POINTFLContextKey.TASK_DATAFLContextKey.TASK_IDFLContextKey.TASK_NAMEFLContextKey.TASK_RESULTFLContextKey.WORKFLOWFLContextKey.WORKSPACE_OBJECTFLContextKey.WORKSPACE_ROOT
FedEventHeaderLogMessageTagMachineStatusNonSerializableKeysReservedKeyReservedKey.APP_ROOTReservedKey.ARGSReservedKey.AUX_RUNNERReservedKey.CLIENT_NAMEReservedKey.COOKIE_JARReservedKey.CURRENT_JOB_IDReservedKey.ENGINEReservedKey.EVENT_DATAReservedKey.EVENT_IDReservedKey.EVENT_ORIGINReservedKey.EVENT_ORIGIN_SITEReservedKey.EVENT_SCOPEReservedKey.FROM_RANK_NUMBERReservedKey.IDENTITY_NAMEReservedKey.IS_RESENDReservedKey.JOB_INFOReservedKey.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.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.TASK_ABORTEDReturnCode.TASK_DATA_FILTER_ERRORReturnCode.TASK_RESULT_FILTER_ERRORReturnCode.TASK_UNKNOWNReturnCode.TASK_UNSUPPORTEDReturnCode.TOPIC_UNKNOWNReturnCode.VALIDATE_TYPE_UNKNOWN
RunProcessKeyServerCommandKeyServerCommandKey.AUX_REPLYServerCommandKey.CLIENTSServerCommandKey.COLLECTORServerCommandKey.COMMANDServerCommandKey.DATAServerCommandKey.FL_CLIENTServerCommandKey.FL_CONTEXTServerCommandKey.JOB_IDServerCommandKey.PEER_FL_CONTEXTServerCommandKey.SHAREABLEServerCommandKey.TASK_IDServerCommandKey.TASK_NAMEServerCommandKey.TOPIC
ServerCommandNamesSnapshotKeySystemComponentsSystemComponents.CANCEL_RESOURCE_PROCESSORSystemComponents.CHECK_RESOURCE_PROCESSORSystemComponents.CLIENT_RUNNERSystemComponents.JOB_MANAGERSystemComponents.JOB_RUNNERSystemComponents.JOB_SCHEDULERSystemComponents.RESOURCE_CONSUMERSystemComponents.RESOURCE_MANAGERSystemComponents.SERVER_RUNNER
WorkspaceConstants
- nvflare.apis.fl_context module
FLContextFLContext.MASK_PRIVATEFLContext.MASK_STICKYFLContext.clone_sticky()FLContext.get_all_public_props()FLContext.get_engine()FLContext.get_identity_name()FLContext.get_job_id()FLContext.get_peer_context()FLContext.get_prop()FLContext.get_prop_detail()FLContext.get_run_abort_signal()FLContext.public_key_exists()FLContext.remove_prop()FLContext.set_peer_context()FLContext.set_prop()FLContext.set_public_props()FLContext.sync_sticky()
FLContextManager
- nvflare.apis.fl_exception module
- nvflare.apis.fl_snapshot module
- nvflare.apis.job_def module
JobJobDataKeyJobMetaKeyJobMetaKey.APPROVALSJobMetaKey.CONTENT_LOCATIONJobMetaKey.DEPLOY_MAPJobMetaKey.DURATIONJobMetaKey.JOB_FOLDER_NAMEJobMetaKey.JOB_IDJobMetaKey.JOB_NAMEJobMetaKey.MANDATORY_CLIENTSJobMetaKey.MIN_CLIENTSJobMetaKey.RESOURCE_SPECJobMetaKey.RESULT_LOCATIONJobMetaKey.START_TIMEJobMetaKey.STATUSJobMetaKey.SUBMIT_TIMEJobMetaKey.SUBMIT_TIME_ISO
RunStatusjob_from_meta()
- 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.save_workspace()JobDefManagerSpec.set_approval()JobDefManagerSpec.set_status()JobDefManagerSpec.update_meta()
- nvflare.apis.job_scheduler_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.validate_clients()
- nvflare.apis.shareable module
ReservedHeaderKeyShareableShareable.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_reply()
- nvflare.apis.signal module
- nvflare.apis.state_persistor module
- nvflare.apis.storage module
- nvflare.apis.workspace module