nvflare.edge package

Subpackages

• nvflare.edge.aggregators package
  • Submodules
    • nvflare.edge.aggregators.edge_dict_accumulator module
      • EdgeDictAccumulator
    • nvflare.edge.aggregators.edge_json_accumulator module
      • EdgeJsonAccumulator
    • nvflare.edge.aggregators.edge_result_accumulator module
      • EdgeResultAccumulator
    • nvflare.edge.aggregators.edge_survey_aggr module
      • EdgeSurveyAggregator
    • nvflare.edge.aggregators.num_dxo module
      • NumDXOAggregator
    • nvflare.edge.aggregators.num_dxo_factory module
      • NumDXOAggrFactory
  • Module contents
• nvflare.edge.assessors package
  • Submodules
    • nvflare.edge.assessors.async_num module
      • AsyncNumAssessor
    • nvflare.edge.assessors.count module
      • CountAssessor
    • nvflare.edge.assessors.sgap module
      • SGAPAssessor
    • nvflare.edge.assessors.timeout module
      • TimeoutAssessor
  • Module contents
• nvflare.edge.controllers package
  • Submodules
    • nvflare.edge.controllers.sage module
      • ScatterAndGatherForEdge
      • TaskDoneReason
  • Module contents
• nvflare.edge.device_simulator package
  • Submodules
    • nvflare.edge.device_simulator.config module
      • ConfigParser
      • load_class()
    • nvflare.edge.device_simulator.device_simulator module
      • DeviceSimulator
    • nvflare.edge.device_simulator.device_task_processor module
      • DeviceTaskProcessor
    • nvflare.edge.device_simulator.feg_api module
      • FegApi
    • nvflare.edge.device_simulator.run_device_simulator module
      • device_run()
      • main()
      • run_device_simulator()
  • Module contents
• nvflare.edge.devices package
  • Submodules
    • nvflare.edge.devices.num module
      • NumDevice
      • NumDeviceFactory
  • Module contents
• nvflare.edge.executors package
  • Submodules
    • nvflare.edge.executors.edge_model_executor module
      • CookieKey
      • EdgeModelExecutor
    • nvflare.edge.executors.edge_survey_executor module
      • EdgeSurveyExecutor
    • nvflare.edge.executors.edge_torch_executor module
    • nvflare.edge.executors.ete module
      • EdgeTaskExecutor
    • nvflare.edge.executors.hug module
      • HierarchicalUpdateGatherer
      • TaskInfo
    • nvflare.edge.executors.simple_edge_executor module
      • SimpleEdgeExecutor
  • Module contents
• nvflare.edge.filters package
  • Submodules
    • nvflare.edge.filters.add_update_header module
      • AddUpdateHeader
  • Module contents
• nvflare.edge.models package
  • Submodules
    • nvflare.edge.models.model module
  • Module contents
• nvflare.edge.updaters package
  • Submodules
    • nvflare.edge.updaters.aggr module
      • AggrUpdater
    • nvflare.edge.updaters.emd module
      • AggregatorFactory
      • EdgeModelUpdater
      • ModelAggrState
  • Module contents
• nvflare.edge.web package
  • Subpackages
    • nvflare.edge.web.handlers package
      • Submodules
      • Module contents
    • nvflare.edge.web.models package
      • Submodules
      • Module contents
    • nvflare.edge.web.views package
      • Submodules
      • Module contents
  • Submodules
    • nvflare.edge.web.routing_proxy module
      • LcpMapper
      • handle_api_error()
      • routing_proxy()
      • validate_content()
      • validate_path()
    • nvflare.edge.web.web_server module
      • FilteredJSONProvider
      • clean_dict()
      • handle_api_error()
      • run_server()
  • Module contents
• nvflare.edge.widgets package
  • Submodules
    • nvflare.edge.widgets.device_runner module
      • DeviceRunner
    • nvflare.edge.widgets.etd module
      • EdgeTaskDispatcher
    • nvflare.edge.widgets.etg module
      • EdgeTaskGenerator
    • nvflare.edge.widgets.evaluator module
      • GlobalEvaluator
    • nvflare.edge.widgets.web_agent module
      • WebAgent
  • Module contents

Submodules

• nvflare.edge.assessor module
  • Assessment
    • Assessment.CONTINUE
    • Assessment.TASK_DONE
    • Assessment.WORKFLOW_DONE
  • Assessor
    • Assessor.assess()
    • Assessor.end_task()
    • Assessor.finalize()
    • Assessor.process_child_update()
    • Assessor.start_task()
• nvflare.edge.constants module
  • EdgeApiKey
    • EdgeApiKey.JOB_DONE
  • EdgeApiStatus
    • EdgeApiStatus.DONE
    • EdgeApiStatus.ERROR
    • EdgeApiStatus.NO_JOB
    • EdgeApiStatus.NO_TASK
    • EdgeApiStatus.OK
    • EdgeApiStatus.RETRY
  • EdgeContextKey
    • EdgeContextKey.EDGE_CAPABILITIES
    • EdgeContextKey.JOB_ID
    • EdgeContextKey.REPLY_TO_EDGE
    • EdgeContextKey.REQUEST_FROM_EDGE
  • EdgeEventType
    • EdgeEventType.EDGE_JOB_REQUEST_RECEIVED
    • EdgeEventType.EDGE_REQUEST_RECEIVED
  • EdgeProtoKey
    • EdgeProtoKey.DATA
    • EdgeProtoKey.STATUS
  • EdgeTaskHeaderKey
    • EdgeTaskHeaderKey.HAS_UPDATE_DATA
    • EdgeTaskHeaderKey.TASK_SEQ
    • EdgeTaskHeaderKey.UPDATE_INTERVAL
  • MsgKey
    • MsgKey.MODE
    • MsgKey.MODEL_VERSION
    • MsgKey.NUM_DEVICES
    • MsgKey.PAYLOAD
    • MsgKey.RESULT
    • MsgKey.TASK_DONE
    • MsgKey.TASK_ID
    • MsgKey.WEIGHTS
  • Status
    • Status.NO_JOB
    • Status.NO_TASK
• nvflare.edge.model_protocol module
  • ModelBufferType
    • ModelBufferType.EXECUTORCH
    • ModelBufferType.PYTORCH
  • ModelEncoding
    • ModelEncoding.ASCII
    • ModelEncoding.BASE64
    • ModelEncoding.HEX
    • ModelEncoding.NONE
    • ModelEncoding.UTF8
  • ModelExchangeFormat
    • ModelExchangeFormat.MODEL_BUFFER
    • ModelExchangeFormat.MODEL_BUFFER_ENCODING
    • ModelExchangeFormat.MODEL_BUFFER_NATIVE_FORMAT
    • ModelExchangeFormat.MODEL_BUFFER_SIZE
    • ModelExchangeFormat.MODEL_BUFFER_TYPE
    • ModelExchangeFormat.MODEL_VERSION
  • ModelNativeFormat
    • ModelNativeFormat.BINARY
    • ModelNativeFormat.STRING
  • verify_payload()
• nvflare.edge.mud module
  • BaseState
    • BaseState.from_shareable()
    • BaseState.is_device_selected()
    • BaseState.to_shareable()
  • Device
    • Device.from_dict()
    • Device.to_dict()
  • ModelUpdate
    • ModelUpdate.from_dict()
    • ModelUpdate.to_dict()
  • PropKey
    • PropKey.CLIENT_NAME
    • PropKey.DEVICES
    • PropKey.DEVICE_ID
    • PropKey.DEVICE_LAST_ALIVE_TIME
    • PropKey.DEVICE_PROPS
    • PropKey.DEVICE_SELECTION
    • PropKey.DEVICE_SELECTION_VERSION
    • PropKey.MODEL
    • PropKey.MODEL_UPDATES
    • PropKey.MODEL_VERSION
    • PropKey.SELECTION_ID
  • StateUpdateReply
    • StateUpdateReply.from_shareable()
    • StateUpdateReply.to_shareable()
  • StateUpdateReport
    • StateUpdateReport.from_shareable()
    • StateUpdateReport.to_shareable()
• nvflare.edge.simulated_device module
  • DeviceFactory
    • DeviceFactory.make_device()
    • DeviceFactory.shutdown()
  • DeviceState
    • DeviceState.DONE
    • DeviceState.IDLE
    • DeviceState.LEARNING
  • SimulatedDevice
    • SimulatedDevice.do_task()
    • SimulatedDevice.get_device_info()
    • SimulatedDevice.get_user_info()
• nvflare.edge.tree_prov module
  • PortManager
    • PortManager.get_port()
    • PortManager.last_port_number
  • Stats
    • Stats.num_clients
    • Stats.num_leaf_clients
    • Stats.num_leaf_relays
    • Stats.num_non_leaf_clients
    • Stats.num_non_leaf_relays
    • Stats.num_relays
  • main()
• nvflare.edge.updater module
  • Updater
    • Updater.end_task()
    • Updater.get_current_state()
    • Updater.prepare_update_for_parent()
    • Updater.process_child_update()
    • Updater.process_parent_update_reply()
    • Updater.start_task()
• nvflare.edge.utils module
  • message_topic_for_task_end()
  • message_topic_for_task_update()
  • process_update_from_child()

Module contents