fedn.network package

The statestore package is responsible for storing various states of the federated network. Such as announced combiners and assigned clients. It also stores metadata about models, rounds, sessions, compute packages and model validations.

Subpackages

• fedn.network.api package
  • Submodules
  • fedn.network.api.client module
    • APIClient
      • APIClient.download_package()
      • APIClient.get_active_clients()
      • APIClient.get_client_config()
      • APIClient.get_combiner()
      • APIClient.get_controller_status()
      • APIClient.get_events()
      • APIClient.get_initial_model()
      • APIClient.get_latest_model()
      • APIClient.get_model_trail()
      • APIClient.get_package()
      • APIClient.get_package_checksum()
      • APIClient.get_round()
      • APIClient.get_session()
      • APIClient.list_clients()
      • APIClient.list_combiners()
      • APIClient.list_rounds()
      • APIClient.list_sessions()
      • APIClient.list_validations()
      • APIClient.set_initial_model()
      • APIClient.set_package()
      • APIClient.start_session()
  • fedn.network.api.interface module
    • API
      • API.add_client()
      • API.add_combiner()
      • API.download_compute_package()
      • API.get_active_clients()
      • API.get_all_combiners()
      • API.get_all_rounds()
      • API.get_all_sessions()
      • API.get_all_validations()
      • API.get_checksum()
      • API.get_client_config()
      • API.get_clients()
      • API.get_combiner()
      • API.get_compute_package()
      • API.get_controller_status()
      • API.get_events()
      • API.get_initial_model()
      • API.get_latest_model()
      • API.get_model_trail()
      • API.get_models()
      • API.get_plot_data()
      • API.get_round()
      • API.get_session()
      • API.list_combiners_data()
      • API.set_compute_package()
      • API.set_initial_model()
      • API.start_session()
  • fedn.network.api.network module
    • Network
      • Network.add_client()
      • Network.add_combiner()
      • Network.describe()
      • Network.find_available_combiner()
      • Network.get_client()
      • Network.get_client_info()
      • Network.get_combiner()
      • Network.get_combiners()
      • Network.handle_unavailable_combiner()
      • Network.remove_combiner()
      • Network.update_client_data()
• fedn.network.clients package
  • Submodules
  • fedn.network.clients.client module
    • Client
      • Client.get_model()
      • Client.process_request()
      • Client.run()
      • Client.set_model()
    • GrpcAuth
  • fedn.network.clients.connect module
    • ConnectorClient
      • ConnectorClient.assign()
    • Status
      • Status.Assigned
      • Status.TryAgain
      • Status.UnAuthorized
      • Status.UnMatchedConfig
      • Status.Unassigned
  • fedn.network.clients.package module
    • PackageRuntime
      • PackageRuntime.dispatcher()
      • PackageRuntime.download()
      • PackageRuntime.unpack()
      • PackageRuntime.validate()
  • fedn.network.clients.state module
    • ClientState
      • ClientState.idle
      • ClientState.training
      • ClientState.validating
    • ClientStateToString()
• fedn.network.combiner package
  • Subpackages
    • fedn.network.combiner.aggregators package
      • Submodules
      • fedn.network.combiner.aggregators.aggregatorbase module
      • fedn.network.combiner.aggregators.fedavg module
  • Submodules
  • fedn.network.combiner.connect module
    • ConnectorCombiner
      • ConnectorCombiner.announce()
    • Status
      • Status.Assigned
      • Status.TryAgain
      • Status.UnAuthorized
      • Status.UnMatchedConfig
      • Status.Unassigned
  • fedn.network.combiner.interfaces module
    • Channel
      • Channel.get_channel()
    • CombinerInterface
      • CombinerInterface.allowing_clients()
      • CombinerInterface.configure()
      • CombinerInterface.flush_model_update_queue()
      • CombinerInterface.from_json()
      • CombinerInterface.get_certificate()
      • CombinerInterface.get_key()
      • CombinerInterface.get_model()
      • CombinerInterface.list_active_clients()
      • CombinerInterface.report()
      • CombinerInterface.submit()
      • CombinerInterface.to_dict()
      • CombinerInterface.to_json()
    • CombinerUnavailableError
  • fedn.network.combiner.modelservice module
    • ModelService
      • ModelService.Download()
      • ModelService.Upload()
      • ModelService.exist()
      • ModelService.get_model()
      • ModelService.get_tmp_path()
      • ModelService.load_model_from_BytesIO()
      • ModelService.serialize_model_to_BytesIO()
      • ModelService.set_model()
  • fedn.network.combiner.round module
    • ModelUpdateError
    • RoundController
      • RoundController.execute_training_round()
      • RoundController.execute_validation_round()
      • RoundController.load_model_update()
      • RoundController.load_model_update_str()
      • RoundController.push_round_config()
      • RoundController.run()
      • RoundController.stage_model()
      • RoundController.waitforit()
  • fedn.network.combiner.server module
    • Combiner
      • Combiner.AcceptingClients()
      • Combiner.Configure()
      • Combiner.FlushAggregationQueue()
      • Combiner.ListActiveClients()
      • Combiner.ModelUpdateRequestStream()
      • Combiner.ModelUpdateStream()
      • Combiner.ModelValidationRequestStream()
      • Combiner.ModelValidationStream()
      • Combiner.Report()
      • Combiner.SendHeartbeat()
      • Combiner.SendModelUpdate()
      • Combiner.SendModelUpdateRequest()
      • Combiner.SendModelValidation()
      • Combiner.SendModelValidationRequest()
      • Combiner.SendStatus()
      • Combiner.Start()
      • Combiner.Stop()
      • Combiner.flush_model_update_queue()
      • Combiner.get_active_trainers()
      • Combiner.get_active_validators()
      • Combiner.nr_active_trainers()
      • Combiner.nr_active_validators()
      • Combiner.register_model_validation()
      • Combiner.report_status()
      • Combiner.request_model_update()
      • Combiner.request_model_validation()
      • Combiner.run()
    • Role
      • Role.COMBINER
      • Role.OTHER
      • Role.REDUCER
      • Role.WORKER
    • role_to_proto_role()
• fedn.network.controller package
  • Submodules
  • fedn.network.controller.control module
    • CombinersNotDoneException
    • Control
      • Control.infer_instruct()
      • Control.inference_round()
      • Control.reduce()
      • Control.round()
      • Control.session()
    • MisconfiguredStorageBackend
    • NoModelException
    • UnsupportedStorageBackend
• fedn.network.dashboard package
  • Submodules
  • fedn.network.dashboard.plots module
    • Plot
      • Plot.create_box_plot()
      • Plot.create_client_histogram_plot()
      • Plot.create_client_plot()
      • Plot.create_client_training_distribution()
      • Plot.create_combiner_plot()
      • Plot.create_cpu_plot()
      • Plot.create_round_plot()
      • Plot.create_table_plot()
      • Plot.create_timeline_plot()
      • Plot.fetch_valid_metrics()
      • Plot.get_client_df()
      • Plot.make_netgraph_plot()
      • Plot.make_single_node_plot()
  • fedn.network.dashboard.restservice module
    • ReducerRestService
      • ReducerRestService.authorize()
      • ReducerRestService.check_compute_package()
      • ReducerRestService.check_configured()
      • ReducerRestService.check_configured_response()
      • ReducerRestService.check_initial_model()
      • ReducerRestService.run()
      • ReducerRestService.to_dict()
    • allowed_file()
    • decode_auth_token()
    • encode_auth_token()
• fedn.network.loadbalancer package
  • Submodules
  • fedn.network.loadbalancer.firstavailable module
    • LeastPacked
      • LeastPacked.find_combiner()
  • fedn.network.loadbalancer.leastpacked module
    • LeastPacked
      • LeastPacked.find_combiner()
  • fedn.network.loadbalancer.loadbalancerbase module
    • LoadBalancerBase
      • LoadBalancerBase.find_combiner()
• fedn.network.statestore package
  • Submodules
  • fedn.network.statestore.mongostatestore module
    • MongoStateStore
      • MongoStateStore.delete_combiner()
      • MongoStateStore.get_client()
      • MongoStateStore.get_combiner()
      • MongoStateStore.get_combiners()
      • MongoStateStore.get_compute_package()
      • MongoStateStore.get_config()
      • MongoStateStore.get_events()
      • MongoStateStore.get_helper()
      • MongoStateStore.get_initial_model()
      • MongoStateStore.get_latest_model()
      • MongoStateStore.get_latest_round()
      • MongoStateStore.get_model_trail()
      • MongoStateStore.get_reducer()
      • MongoStateStore.get_round()
      • MongoStateStore.get_rounds()
      • MongoStateStore.get_session()
      • MongoStateStore.get_sessions()
      • MongoStateStore.get_storage_backend()
      • MongoStateStore.get_validations()
      • MongoStateStore.is_inited()
      • MongoStateStore.list_clients()
      • MongoStateStore.list_combiners_data()
      • MongoStateStore.list_models()
      • MongoStateStore.set_client()
      • MongoStateStore.set_combiner()
      • MongoStateStore.set_compute_package()
      • MongoStateStore.set_helper()
      • MongoStateStore.set_latest_model()
      • MongoStateStore.set_reducer()
      • MongoStateStore.set_storage_backend()
      • MongoStateStore.state()
      • MongoStateStore.transition()
      • MongoStateStore.update_client_status()
  • fedn.network.statestore.statestorebase module
    • StateStoreBase
      • StateStoreBase.get_latest_model()
      • StateStoreBase.is_inited()
      • StateStoreBase.set_latest_model()
      • StateStoreBase.state()
      • StateStoreBase.transition()

Submodules

fedn.network.config module

class fedn.network.config.Config

Bases: ABC

class fedn.network.config.ReducerConfig

Bases: Config

Configuration for the Reducer component.

compute_bundle_dir = None

initial_model = None

models_dir = None

storage_backend = {'settings': {'bucket': 'models'}, 'type': 's3'}

fedn.network.reducer module

exception fedn.network.reducer.InvalidReducerConfiguration

Bases: Exception

exception fedn.network.reducer.MissingReducerConfiguration

Bases: Exception

class fedn.network.reducer.Reducer(statestore)

Bases: object

A class used to instantiate the Reducer service.

Parameters:

statestore (fedn.network.statestore.statestorebase.StateStoreBase) – The backend statestore object.

control_loop()

Manage and report the state of the Reducer.

run()

Start REST service and control loop.

fedn.network.state module

class fedn.network.state.ReducerState(value)

Bases: Enum

Enum for representing the state of a reducer.

idle = 2

instructing = 3

monitoring = 4

setup = 1

fedn.network.state.ReducerStateToString(state)

Convert ReducerState to string.

Parameters:

state (fedn.network.state.ReducerState) – The state.

Returns:

The state as string.

Return type:

str

fedn.network.state.StringToReducerState(state)

Convert string to ReducerState.

Parameters:

state (str) – The state as string.

Returns:

The state.

Return type:

fedn.network.state.ReducerState