nvflare.apis package¶
Subpackages¶
- nvflare.apis.impl package
- Submodules
- Module contents
- nvflare.apis.utils package
Submodules¶
- nvflare.apis.analytix module
AnalyticsData
AnalyticsDataType
AnalyticsDataType.IMAGE
AnalyticsDataType.INIT_DATA
AnalyticsDataType.LOG_RECORD
AnalyticsDataType.METRIC
AnalyticsDataType.METRICS
AnalyticsDataType.MODEL
AnalyticsDataType.PARAMETER
AnalyticsDataType.PARAMETERS
AnalyticsDataType.SCALAR
AnalyticsDataType.SCALARS
AnalyticsDataType.TAG
AnalyticsDataType.TAGS
AnalyticsDataType.TEXT
- 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
ClientTask
ControllerSpec
ControllerSpec.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()
SendOrder
Task
TaskCompletionStatus
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
EventType
EventType.ABORT_TASK
EventType.ABOUT_TO_END_RUN
EventType.ABOUT_TO_START_RUN
EventType.AFTER_PROCESS_SUBMISSION
EventType.AFTER_PULL_TASK
EventType.AFTER_SEND_TASK_RESULT
EventType.AFTER_TASK_DATA_FILTER
EventType.AFTER_TASK_EXECUTION
EventType.AFTER_TASK_RESULT_FILTER
EventType.BEFORE_CHECK_CLIENT_RESOURCES
EventType.BEFORE_CHECK_RESOURCE_MANAGER
EventType.BEFORE_PROCESS_SUBMISSION
EventType.BEFORE_PULL_TASK
EventType.BEFORE_SEND_TASK_RESULT
EventType.BEFORE_TASK_DATA_FILTER
EventType.BEFORE_TASK_EXECUTION
EventType.BEFORE_TASK_RESULT_FILTER
EventType.CRITICAL_LOG_AVAILABLE
EventType.DEBUG_LOG_AVAILABLE
EventType.END_RUN
EventType.END_WORKFLOW
EventType.ERROR_LOG_AVAILABLE
EventType.EXCEPTION_LOG_AVAILABLE
EventType.FATAL_SYSTEM_ERROR
EventType.FATAL_TASK_ERROR
EventType.INFO_LOG_AVAILABLE
EventType.JOB_ABORTED
EventType.JOB_CANCELLED
EventType.JOB_COMPLETED
EventType.JOB_DEPLOYED
EventType.JOB_STARTED
EventType.PRE_RUN_RESULT_AVAILABLE
EventType.START_RUN
EventType.START_WORKFLOW
EventType.SWAP_IN
EventType.SWAP_OUT
EventType.SYSTEM_END
EventType.SYSTEM_START
EventType.WARNING_LOG_AVAILABLE
- nvflare.apis.executor module
- nvflare.apis.filter module
- nvflare.apis.fl_component module
- nvflare.apis.fl_constant module
AdminCommandNames
AdminCommandNames.ABORT
AdminCommandNames.ABORT_JOB
AdminCommandNames.ABORT_TASK
AdminCommandNames.ADMIN_CHECK_STATUS
AdminCommandNames.AUX_COMMAND
AdminCommandNames.CALL
AdminCommandNames.CHECK_STATUS
AdminCommandNames.CLONE_JOB
AdminCommandNames.DELETE_JOB
AdminCommandNames.DELETE_WORKSPACE
AdminCommandNames.DEPLOY_APP
AdminCommandNames.DOWNLOAD_JOB
AdminCommandNames.GET_JOB_META
AdminCommandNames.LIST_JOBS
AdminCommandNames.REMOVE_CLIENT
AdminCommandNames.REPORT_RESOURCES
AdminCommandNames.RESET_ERRORS
AdminCommandNames.RESTART
AdminCommandNames.SET_TIMEOUT
AdminCommandNames.SHELL_CAT
AdminCommandNames.SHELL_GREP
AdminCommandNames.SHELL_HEAD
AdminCommandNames.SHELL_LS
AdminCommandNames.SHELL_PWD
AdminCommandNames.SHELL_TAIL
AdminCommandNames.SHOW_ERRORS
AdminCommandNames.SHOW_SCOPES
AdminCommandNames.SHOW_STATS
AdminCommandNames.SHUTDOWN
AdminCommandNames.START_APP
AdminCommandNames.SUBMIT_JOB
AdminCommandNames.SYS_INFO
EventScope
FLContextKey
FLContextKey.APP_ROOT
FLContextKey.ARGS
FLContextKey.CLIENT_NAME
FLContextKey.CLIENT_RESOURCE_SPECS
FLContextKey.COMMUNICATION_ERROR
FLContextKey.CURRENT_JOB_ID
FLContextKey.CURRENT_RUN
FLContextKey.EFFECTIVE_JOB_SCOPE_NAME
FLContextKey.EVENT_DATA
FLContextKey.EVENT_ID
FLContextKey.EVENT_ORIGIN
FLContextKey.EVENT_ORIGIN_SITE
FLContextKey.EVENT_SCOPE
FLContextKey.FATAL_SYSTEM_ERROR
FLContextKey.FROM_RANK_NUMBER
FLContextKey.IS_CLIENT_TASK_RESEND
FLContextKey.JOB_BLOCK_REASON
FLContextKey.JOB_DEPLOY_DETAIL
FLContextKey.JOB_INFO
FLContextKey.JOB_META
FLContextKey.JOB_PARTICIPANTS
FLContextKey.JOB_RUN_NUMBER
FLContextKey.JOB_SCOPE_NAME
FLContextKey.NUM_OF_PROCESSES
FLContextKey.PEER_CONTEXT
FLContextKey.RANK_NUMBER
FLContextKey.REPLY
FLContextKey.RUNNER
FLContextKey.RUN_ABORT_SIGNAL
FLContextKey.SCOPE_OBJECT
FLContextKey.SCOPE_PROPERTIES
FLContextKey.SECURE_MODE
FLContextKey.SHAREABLE
FLContextKey.SIMULATE_MODE
FLContextKey.SP_END_POINT
FLContextKey.SSID
FLContextKey.TASK_DATA
FLContextKey.TASK_ID
FLContextKey.TASK_NAME
FLContextKey.TASK_RESULT
FLContextKey.UNAUTHENTICATED
FLContextKey.WORKFLOW
FLContextKey.WORKSPACE_OBJECT
FLContextKey.WORKSPACE_ROOT
FedEventHeader
JobConstants
LogMessageTag
MachineStatus
NonSerializableKeys
ReservedKey
ReservedKey.APP_ROOT
ReservedKey.ARGS
ReservedKey.AUDIT_EVENT_ID
ReservedKey.AUX_RUNNER
ReservedKey.CLIENT_NAME
ReservedKey.COOKIE_JAR
ReservedKey.CURRENT_JOB_ID
ReservedKey.ENGINE
ReservedKey.EVENT_DATA
ReservedKey.EVENT_ID
ReservedKey.EVENT_ORIGIN
ReservedKey.EVENT_ORIGIN_SITE
ReservedKey.EVENT_SCOPE
ReservedKey.FATAL_SYSTEM_ERROR
ReservedKey.FROM_RANK_NUMBER
ReservedKey.IDENTITY_NAME
ReservedKey.IS_RESEND
ReservedKey.JOB_DEPLOY_DETAIL
ReservedKey.JOB_INFO
ReservedKey.JOB_META
ReservedKey.JOB_RUN_NUMBER
ReservedKey.MANAGER
ReservedKey.NUM_OF_PROCESSES
ReservedKey.PEER_CTX
ReservedKey.RANK_NUMBER
ReservedKey.RC
ReservedKey.REPLY
ReservedKey.RUNNER
ReservedKey.RUN_ABORT_SIGNAL
ReservedKey.RUN_NUM
ReservedKey.SECURE_MODE
ReservedKey.SHAREABLE
ReservedKey.SHARED_FL_CONTEXT
ReservedKey.SIMULATE_MODE
ReservedKey.SP_END_POINT
ReservedKey.TASK_DATA
ReservedKey.TASK_ID
ReservedKey.TASK_NAME
ReservedKey.TASK_RESULT
ReservedKey.WORKFLOW
ReservedKey.WORKSPACE_OBJECT
ReservedKey.WORKSPACE_ROOT
ReservedTopic
ReturnCode
ReturnCode.BAD_PEER_CONTEXT
ReturnCode.BAD_REQUEST_DATA
ReturnCode.BAD_TASK_DATA
ReturnCode.COMMUNICATION_ERROR
ReturnCode.EMPTY_RESULT
ReturnCode.ERROR
ReturnCode.EXECUTION_EXCEPTION
ReturnCode.EXECUTION_RESULT_ERROR
ReturnCode.HANDLER_EXCEPTION
ReturnCode.MISSING_PEER_CONTEXT
ReturnCode.MODEL_UNRECOGNIZED
ReturnCode.OK
ReturnCode.RUN_MISMATCH
ReturnCode.SERVER_NOT_READY
ReturnCode.TASK_ABORTED
ReturnCode.TASK_DATA_FILTER_ERROR
ReturnCode.TASK_RESULT_FILTER_ERROR
ReturnCode.TASK_UNKNOWN
ReturnCode.TASK_UNSUPPORTED
ReturnCode.TOPIC_UNKNOWN
ReturnCode.VALIDATE_TYPE_UNKNOWN
RunProcessKey
SecureTrainConst
ServerCommandKey
ServerCommandKey.AUX_REPLY
ServerCommandKey.CLIENTS
ServerCommandKey.COLLECTOR
ServerCommandKey.COMMAND
ServerCommandKey.DATA
ServerCommandKey.FL_CLIENT
ServerCommandKey.FL_CONTEXT
ServerCommandKey.JOB_ID
ServerCommandKey.PEER_FL_CONTEXT
ServerCommandKey.SHAREABLE
ServerCommandKey.TASK_ID
ServerCommandKey.TASK_NAME
ServerCommandKey.TOPIC
ServerCommandKey.TURN_TO_COLD
ServerCommandNames
ServerCommandNames.AUX_COMMUNICATE
ServerCommandNames.AUX_SEND
ServerCommandNames.GET_CLIENTS
ServerCommandNames.GET_ERRORS
ServerCommandNames.GET_RUN_INFO
ServerCommandNames.GET_TASK
ServerCommandNames.HANDLE_DEAD_JOB
ServerCommandNames.HEARTBEAT
ServerCommandNames.RESET_ERRORS
ServerCommandNames.SERVER_STATE
ServerCommandNames.SHOW_STATS
ServerCommandNames.SUBMIT_UPDATE
ServerCommandNames.UPDATE_RUN_STATUS
SiteType
SnapshotKey
SystemComponents
SystemComponents.CANCEL_RESOURCE_PROCESSOR
SystemComponents.CHECK_RESOURCE_PROCESSOR
SystemComponents.CLIENT_RUNNER
SystemComponents.JOB_MANAGER
SystemComponents.JOB_RUNNER
SystemComponents.JOB_SCHEDULER
SystemComponents.RESOURCE_CONSUMER
SystemComponents.RESOURCE_MANAGER
SystemComponents.SERVER_RUNNER
SystemConfigs
WorkspaceConstants
WorkspaceConstants.ADMIN_STARTUP_CONFIG
WorkspaceConstants.APP_PREFIX
WorkspaceConstants.AUDIT_LOG
WorkspaceConstants.AUTHORIZATION_CONFIG
WorkspaceConstants.CLIENT_STARTUP_CONFIG
WorkspaceConstants.CUSTOM_FOLDER_NAME
WorkspaceConstants.DEFAULT_AUTHORIZATION_CONFIG
WorkspaceConstants.DEFAULT_LOGGING_CONFIG
WorkspaceConstants.DEFAULT_RESOURCES_CONFIG
WorkspaceConstants.JOB_META_FILE
WorkspaceConstants.LOGGING_CONFIG
WorkspaceConstants.LOG_FILE_NAME
WorkspaceConstants.PRIVACY_CONFIG
WorkspaceConstants.RESOURCES_CONFIG
WorkspaceConstants.RESTART_FILE
WorkspaceConstants.SAMPLE_PRIVACY_CONFIG
WorkspaceConstants.SERVER_STARTUP_CONFIG
WorkspaceConstants.SHUTDOWN_FILE
WorkspaceConstants.SITE_FOLDER_NAME
WorkspaceConstants.STARTUP_FOLDER_NAME
WorkspaceConstants.WORKSPACE_PREFIX
- nvflare.apis.fl_context module
FLContext
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_prop_keys()
FLContext.get_run_abort_signal()
FLContext.public_key_exists()
FLContext.put()
FLContext.remove_prop()
FLContext.set_peer_context()
FLContext.set_prop()
FLContext.set_public_props()
FLContext.sync_sticky()
FLContextManager
is_private()
is_sticky()
make_mask()
to_string()
- nvflare.apis.fl_exception module
- nvflare.apis.fl_snapshot module
- nvflare.apis.job_def module
Job
JobDataKey
JobMetaKey
JobMetaKey.APPROVALS
JobMetaKey.CLONED_FROM
JobMetaKey.CONTENT_LOCATION
JobMetaKey.DEPLOY_MAP
JobMetaKey.DURATION
JobMetaKey.JOB_DEPLOY_DETAIL
JobMetaKey.JOB_FOLDER_NAME
JobMetaKey.JOB_ID
JobMetaKey.JOB_NAME
JobMetaKey.LAST_SCHEDULE_TIME
JobMetaKey.MANDATORY_CLIENTS
JobMetaKey.MIN_CLIENTS
JobMetaKey.RESOURCE_SPEC
JobMetaKey.RESULT_LOCATION
JobMetaKey.SCHEDULE_COUNT
JobMetaKey.SCHEDULE_HISTORY
JobMetaKey.SCOPE
JobMetaKey.START_TIME
JobMetaKey.STATUS
JobMetaKey.SUBMITTER_NAME
JobMetaKey.SUBMITTER_ORG
JobMetaKey.SUBMITTER_ROLE
JobMetaKey.SUBMIT_TIME
JobMetaKey.SUBMIT_TIME_ISO
RunStatus
TopDir
job_from_meta()
- nvflare.apis.job_def_manager_spec module
JobDefManagerSpec
JobDefManagerSpec.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.refresh_meta()
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
ServerEngineSpec
ServerEngineSpec.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
ReservedHeaderKey
ReservedHeaderKey.AUDIT_EVENT_ID
ReservedHeaderKey.CONTENT_TYPE
ReservedHeaderKey.COOKIE_JAR
ReservedHeaderKey.HEADERS
ReservedHeaderKey.PEER_PROPS
ReservedHeaderKey.RC
ReservedHeaderKey.REPLY_IS_LATE
ReservedHeaderKey.TASK_ID
ReservedHeaderKey.TASK_NAME
ReservedHeaderKey.TOPIC
ReservedHeaderKey.WORKFLOW
Shareable
Shareable.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
Workspace
Workspace.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_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_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_startup_file_path()
Workspace.get_site_config_dir()
Workspace.get_site_custom_dir()
Workspace.get_site_privacy_file_path()
Workspace.get_startup_kit_dir()