nvflare package

Subpackages

• nvflare.apis package
  • Subpackages
    • nvflare.apis.impl package
      • Submodules
      • Module contents
    • nvflare.apis.utils package
      • Subpackages
      • Submodules
      • Module contents
  • Submodules
    • nvflare.apis.analytix module
      • AnalyticsData
      • AnalyticsDataType
    • nvflare.apis.app_validation module
      • AppValidationKey
      • AppValidator
    • nvflare.apis.aux_spec module
      • MessageSendStatus
      • aux_request_handle_func_signature()
    • nvflare.apis.client module
      • Client
    • nvflare.apis.client_engine_spec module
      • ClientEngineSpec
    • nvflare.apis.controller_spec module
      • ClientTask
      • ControllerSpec
      • 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
      • DXO
      • DataKind
      • MetaKey
      • from_bytes()
      • from_shareable()
    • nvflare.apis.dxo_filter module
      • DXOFilter
    • nvflare.apis.event_type module
      • EventType
    • nvflare.apis.executor module
      • Executor
    • nvflare.apis.filter module
      • ContentBlockedException
      • Filter
      • FilterChainType
      • FilterContextKey
      • FilterSource
    • nvflare.apis.fl_component module
      • FLComponent
    • nvflare.apis.fl_constant module
      • AdminCommandNames
      • EventScope
      • FLContextKey
      • FedEventHeader
      • JobConstants
      • LogMessageTag
      • MachineStatus
      • NonSerializableKeys
      • ReservedKey
      • ReservedTopic
      • ReturnCode
      • RunProcessKey
      • ServerCommandKey
      • ServerCommandNames
      • SiteType
      • SnapshotKey
      • SystemComponents
      • WorkspaceConstants
    • nvflare.apis.fl_context module
      • FLContext
      • FLContextManager
    • nvflare.apis.fl_exception module
      • FLCommunicationError
    • nvflare.apis.fl_snapshot module
      • FLSnapshot
      • RunSnapshot
    • nvflare.apis.job_def module
      • Job
      • JobDataKey
      • JobMetaKey
      • RunStatus
      • TopDir
      • job_from_meta()
    • nvflare.apis.job_def_manager_spec module
      • JobDefManagerSpec
    • nvflare.apis.job_scheduler_spec module
      • DispatchInfo
      • JobSchedulerSpec
    • nvflare.apis.overseer_spec module
      • OverseerAgent
      • SP
    • nvflare.apis.persistable module
      • StatePersistable
    • nvflare.apis.resource_manager_spec module
      • ResourceConsumerSpec
      • ResourceManagerSpec
    • nvflare.apis.responder module
      • Responder
    • nvflare.apis.server_engine_spec module
      • ServerEngineSpec
    • nvflare.apis.shareable module
      • ReservedHeaderKey
      • Shareable
      • make_reply()
    • nvflare.apis.signal module
      • Signal
    • nvflare.apis.state_persistor module
      • StatePersistor
    • nvflare.apis.storage module
      • StorageException
      • StorageSpec
    • nvflare.apis.workspace module
      • Workspace
  • Module contents
• nvflare.app_common package
  • Subpackages
    • nvflare.app_common.abstract package
      • Submodules
      • Module contents
    • nvflare.app_common.aggregators package
      • Submodules
      • Module contents
    • nvflare.app_common.decomposers package
      • Submodules
      • Module contents
    • nvflare.app_common.executors package
      • Subpackages
      • Submodules
      • Module contents
    • nvflare.app_common.filters package
      • Submodules
      • Module contents
    • nvflare.app_common.homomorphic_encryption package
      • Submodules
      • Module contents
    • nvflare.app_common.job_schedulers package
      • Submodules
      • Module contents
    • nvflare.app_common.np package
      • Submodules
      • Module contents
    • nvflare.app_common.pt package
      • Submodules
      • Module contents
    • nvflare.app_common.resource_consumers package
      • Submodules
      • Module contents
    • nvflare.app_common.resource_managers package
      • Submodules
      • Module contents
    • nvflare.app_common.shareablegenerators package
      • Submodules
      • Module contents
    • nvflare.app_common.state_persistors package
      • Submodules
      • Module contents
    • nvflare.app_common.statistics package
      • Submodules
      • Module contents
    • nvflare.app_common.storages package
      • Submodules
      • Module contents
    • nvflare.app_common.utils package
      • Submodules
      • Module contents
    • nvflare.app_common.widgets package
      • Submodules
      • Module contents
    • nvflare.app_common.workflows package
      • Submodules
      • Module contents
  • Submodules
    • nvflare.app_common.app_constant module
      • AlgorithmConstants
      • AppConstants
      • DefaultCheckpointFileName
      • EnvironmentKey
      • ExecutorTasks
      • ModelFormat
      • ModelName
      • StatisticsConstants
      • ValidateType
    • nvflare.app_common.app_event_type module
      • AppEventType
    • nvflare.app_common.model_desc module
      • ModelDescriptor
  • Module contents
• nvflare.app_opt package
  • Subpackages
    • nvflare.app_opt.statistics package
      • Subpackages
      • Module contents
    • nvflare.app_opt.xgboost package
      • Subpackages
      • Module contents
  • Module contents
• nvflare.dashboard package
  • Subpackages
    • nvflare.dashboard.application package
      • Submodules
      • Module contents
  • Submodules
    • nvflare.dashboard.cli module
      • define_dashboard_parser()
      • handle_dashboard()
      • has_no_arguments()
      • main()
      • start()
      • stop()
    • nvflare.dashboard.config module
      • Config
    • nvflare.dashboard.wsgi module
  • Module contents
• nvflare.fuel package
  • Subpackages
    • nvflare.fuel.common package
      • Submodules
      • Module contents
    • nvflare.fuel.hci package
      • Subpackages
      • Submodules
      • Module contents
    • nvflare.fuel.sec package
      • Submodules
      • Module contents
    • nvflare.fuel.utils package
      • Subpackages
      • Submodules
      • Module contents
  • Module contents
• nvflare.ha package
  • Subpackages
    • nvflare.ha.overseer package
      • Submodules
      • Module contents
  • Submodules
    • nvflare.ha.dummy_overseer_agent module
      • DummyOverseerAgent
    • nvflare.ha.ha_admin_cmds module
      • HACommandModule
      • get_active_sp()
      • list_sp()
      • promote_sp()
      • shutdown_system()
    • nvflare.ha.overseer_agent module
      • HttpOverseerAgent
    • nvflare.ha.overseer_agent_app module
      • main()
      • setup_basic_info()
      • simple_callback()
  • Module contents
• nvflare.lighter package
  • Subpackages
    • nvflare.lighter.impl package
      • Submodules
      • Module contents
  • Submodules
    • nvflare.lighter.poc module
      • clone_client()
      • clone_poc_folder()
      • copy_from_src()
      • generate_poc()
      • get_dest_poc_dir()
      • get_src_poc_dir()
      • main()
      • unpack_poc()
    • nvflare.lighter.poc_commands module
      • async_process()
      • clean_poc()
      • client_gpu_assignments()
      • def_poc_parser()
      • get_cmd_path()
      • get_gpu_ids()
      • get_local_host_gpu_ids()
      • get_nvflare_home()
      • get_package_command()
      • get_stop_cmd()
      • get_upload_dir()
      • handle_poc_cmd()
      • is_poc()
      • is_poc_ready()
      • prepare_env()
      • prepare_examples()
      • prepare_poc()
      • sort_package_cmds()
      • start_poc()
      • stop_poc()
      • sync_process()
      • validate_gpu_ids()
      • validate_poc_workspace()
    • nvflare.lighter.provision module
      • define_provision_parser()
      • handle_provision()
      • has_no_arguments()
      • main()
    • nvflare.lighter.service_constants module
      • FlareServiceConstants
    • nvflare.lighter.spec module
      • Builder
      • Participant
      • Project
      • Provisioner
    • nvflare.lighter.utils module
      • generate_password()
      • load_yaml()
      • sh_replace()
      • sign_all()
  • Module contents
• nvflare.private package
  • Subpackages
    • nvflare.private.fed package
      • Subpackages
      • Module contents
  • Submodules
    • nvflare.private.admin_defs module
      • Message
      • MsgHeader
      • ReturnCode
      • error_reply()
      • ok_reply()
    • nvflare.private.aux_runner module
      • AuxRunner
    • nvflare.private.defs module
      • AppFolderConstants
      • ClientStatusKey
      • ComponentCallerTopic
      • ControlCommandName
      • ControlCommandTopic
      • EngineConstant
      • InfoCollectorTopic
      • RequestHeader
      • SSLConstants
      • ScopeInfoKey
      • SpecialTaskName
      • SysCommandTopic
      • TaskConstant
      • TrainingTopic
    • nvflare.private.event module
      • fire_event()
    • nvflare.private.fed_json_config module
      • FedJsonConfigurator
      • FilterChain
    • nvflare.private.json_configer module
      • ConfigContext
      • JsonConfigurator
      • get_component_refs()
    • nvflare.private.privacy_manager module
      • PrivacyManager
      • PrivacyService
      • Scope
    • nvflare.private.scheduler_constants module
      • ShareableHeader
  • Module contents
• nvflare.security package
  • Submodules
    • nvflare.security.logging module
      • is_secure()
      • secure_format_exception()
      • secure_format_traceback()
      • secure_log_traceback()
    • nvflare.security.security module
      • CommandCategory
      • EmptyAuthorizer
      • FLAuthorizer
  • Module contents
• nvflare.tool package
  • Subpackages
    • nvflare.tool.package_checker package
      • Submodules
      • Module contents
  • Submodules
    • nvflare.tool.preflight_check module
      • check_packages()
      • define_preflight_check_parser()
      • main()
  • Module contents
• nvflare.widgets package
  • Submodules
    • nvflare.widgets.comp_caller module
      • CallInfo
      • ComponentCaller
    • nvflare.widgets.fed_event module
      • ClientFedEventRunner
      • FedEventRunner
      • ServerFedEventRunner
    • nvflare.widgets.info_collector module
      • GroupInfoCollector
      • InfoCollector
    • nvflare.widgets.widget module
      • Widget
      • WidgetID
  • Module contents

Submodules

• nvflare.cli module
  • check_python_version()
  • def_authz_preview_parser()
  • def_dashboard_parser()
  • def_preflight_check_parser()
  • def_provision_parser()
  • def_simulator_parser()
  • handle_authz_preview()
  • handle_simulator_cmd()
  • main()
  • parse_args()
  • print_help()
  • print_nvflare_version()
  • run()
• nvflare.cli_exception module
  • CLIException

Module contents