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_model()
      • APIClient.download_package()
      • APIClient.get_active_clients()
      • APIClient.get_active_model()
      • APIClient.get_active_package()
      • APIClient.get_client()
      • APIClient.get_client_config()
      • APIClient.get_clients()
      • APIClient.get_clients_count()
      • APIClient.get_combiner()
      • APIClient.get_combiners()
      • APIClient.get_combiners_count()
      • APIClient.get_controller_status()
      • APIClient.get_model()
      • APIClient.get_model_trail()
      • APIClient.get_models()
      • APIClient.get_models_count()
      • APIClient.get_package()
      • APIClient.get_package_checksum()
      • APIClient.get_packages()
      • APIClient.get_packages_count()
      • APIClient.get_round()
      • APIClient.get_rounds()
      • APIClient.get_rounds_count()
      • APIClient.get_session()
      • APIClient.get_session_status()
      • APIClient.get_sessions()
      • APIClient.get_sessions_count()
      • APIClient.get_status()
      • APIClient.get_statuses()
      • APIClient.get_statuses_count()
      • APIClient.get_validation()
      • APIClient.get_validations()
      • APIClient.get_validations_count()
      • APIClient.session_is_finished()
      • APIClient.set_active_model()
      • APIClient.set_active_package()
      • APIClient.start_session()
  • fedn.network.api.interface module
    • API
      • API.add_client()
      • API.add_combiner()
      • API.download_compute_package()
      • 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()
      • API.get_model_ancestors()
      • API.get_model_descendants()
      • API.get_model_trail()
      • API.get_models()
      • API.get_round()
      • API.get_session()
      • API.list_combiners_data()
      • API.list_compute_packages()
      • API.set_active_compute_package()
      • API.set_compute_package()
      • API.set_current_model()
      • API.set_initial_model()
      • API.start_session()
  • fedn.network.api.network module
    • Network
      • Network.add_client()
      • Network.add_combiner()
      • 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.api.tests module
    • NetworkAPITests
      • NetworkAPITests.setUp()
      • NetworkAPITests.test_add_client()
      • NetworkAPITests.test_add_combiner()
      • NetworkAPITests.test_get_active_clients()
      • NetworkAPITests.test_get_client_config()
      • NetworkAPITests.test_get_combiner()
      • NetworkAPITests.test_get_controller_status()
      • NetworkAPITests.test_get_events()
      • NetworkAPITests.test_get_initial_model()
      • NetworkAPITests.test_get_latest_model()
      • NetworkAPITests.test_get_model_trail()
      • NetworkAPITests.test_get_package()
      • NetworkAPITests.test_get_round()
      • NetworkAPITests.test_get_status()
      • NetworkAPITests.test_list_clients()
      • NetworkAPITests.test_list_combiners()
      • NetworkAPITests.test_list_compute_packages()
      • NetworkAPITests.test_list_models()
      • NetworkAPITests.test_list_rounds()
      • NetworkAPITests.test_list_sessions()
      • NetworkAPITests.test_set_initial_model()
      • NetworkAPITests.test_start_session()
• fedn.network.clients package
  • Submodules
  • fedn.network.clients.client module
    • Client
      • Client.assign()
      • Client.connect()
      • Client.disconnect()
      • Client.get_model_from_combiner()
      • Client.process_request()
      • Client.run()
      • Client.send_model_to_combiner()
      • Client.send_status()
      • Client.untar_package()
    • GrpcAuth
  • fedn.network.clients.connect module
    • ConnectorClient
      • ConnectorClient.assign()
      • ConnectorClient.refresh_token()
    • 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.inferencing
      • ClientState.training
      • ClientState.validating
    • ClientStateToString()
  • fedn.network.clients.test_client module
    • TestClient
      • TestClient.setUp()
      • TestClient.test_add_grpc_metadata()
• fedn.network.combiner package
  • Subpackages
    • fedn.network.combiner.aggregators package
      • Submodules
      • fedn.network.combiner.aggregators.aggregator module
      • fedn.network.combiner.aggregators.aggregatorbase module
      • fedn.network.combiner.aggregators.fedavg module
      • fedn.network.combiner.aggregators.fedopt module
  • Submodules
  • fedn.network.combiner.combiner module
    • Combiner
      • Combiner.AcceptingClients()
      • Combiner.FlushAggregationQueue()
      • Combiner.ListActiveClients()
      • Combiner.SendHeartbeat()
      • Combiner.SendModelUpdate()
      • Combiner.SendModelValidation()
      • Combiner.SendStatus()
      • Combiner.SetAggregator()
      • Combiner.Start()
      • Combiner.Stop()
      • Combiner.TaskStream()
      • Combiner.get_active_trainers()
      • Combiner.get_active_validators()
      • Combiner.nr_active_trainers()
      • Combiner.register_model_validation()
      • Combiner.request_model_inference()
      • 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.combiner.combiner_tests module
  • 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.flush_model_update_queue()
      • CombinerInterface.from_json()
      • CombinerInterface.get_certificate()
      • CombinerInterface.get_key()
      • CombinerInterface.get_model()
      • CombinerInterface.list_active_clients()
      • CombinerInterface.set_aggregator()
      • 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.set_model()
    • get_tmp_path()
    • load_model_from_BytesIO()
    • model_as_bytesIO()
    • serialize_model_to_BytesIO()
    • upload_request_generator()
  • fedn.network.combiner.roundhandler module
    • ModelUpdateError
    • RoundConfig
      • RoundConfig.aggregator
      • RoundConfig.committed_at
      • RoundConfig.helper_type
      • RoundConfig.model_id
      • RoundConfig.model_metadata
      • RoundConfig.model_parameters
      • RoundConfig.model_size
      • RoundConfig.model_type
      • RoundConfig.model_version
      • RoundConfig.round_id
      • RoundConfig.round_timeout
      • RoundConfig.rounds
      • RoundConfig.session_id
      • RoundConfig.task
    • RoundHandler
      • RoundHandler.execute_inference_round()
      • RoundHandler.execute_training_round()
      • RoundHandler.execute_validation_round()
      • RoundHandler.load_model_update()
      • RoundHandler.load_model_update_str()
      • RoundHandler.push_round_config()
      • RoundHandler.run()
      • RoundHandler.set_aggregator()
      • RoundHandler.stage_model()
      • RoundHandler.waitforit()
• fedn.network.controller package
  • Submodules
  • fedn.network.controller.control module
    • CombinersNotDoneException
    • Control
      • Control.infer_instruct()
      • Control.inference_round()
      • Control.inference_session()
      • Control.reduce()
      • Control.round()
      • Control.session()
      • Control.start_session()
    • MisconfiguredStorageBackend
    • NoModelException
    • SessionTerminatedException
    • UnsupportedStorageBackend
  • fedn.network.controller.controlbase module
    • ControlBase
      • ControlBase.commit()
      • ControlBase.create_round()
      • ControlBase.create_session()
      • ControlBase.evaluate_round_participation_policy()
      • ControlBase.evaluate_round_start_policy()
      • ControlBase.evaluate_round_validity_policy()
      • ControlBase.get_combiner()
      • ControlBase.get_compute_package()
      • ControlBase.get_compute_package_name()
      • ControlBase.get_events()
      • ControlBase.get_helper()
      • ControlBase.get_latest_round()
      • ControlBase.get_latest_round_id()
      • ControlBase.get_model_info()
      • ControlBase.get_participating_combiners()
      • ControlBase.get_session_status()
      • ControlBase.get_state()
      • ControlBase.idle()
      • ControlBase.reduce()
      • ControlBase.request_model_updates()
      • ControlBase.round()
      • ControlBase.session()
      • ControlBase.set_compute_package()
      • ControlBase.set_round_config()
      • ControlBase.set_round_data()
      • ControlBase.set_round_status()
      • ControlBase.set_session_config()
      • ControlBase.set_session_status()
      • ControlBase.state()
    • MisconfiguredHelper
    • MisconfiguredStorageBackend
    • UnsupportedStorageBackend
• 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.storage package
  • Subpackages
    • fedn.network.storage.models package
      • Submodules
      • fedn.network.storage.models.memorymodelstorage module
      • fedn.network.storage.models.modelstorage module
      • fedn.network.storage.models.tempmodelstorage module
    • fedn.network.storage.s3 package
      • Submodules
      • fedn.network.storage.s3.base module
      • fedn.network.storage.s3.miniorepository module
      • fedn.network.storage.s3.repository module
    • fedn.network.storage.statestore package
      • Submodules
      • fedn.network.storage.statestore.mongostatestore module
      • fedn.network.storage.statestore.statestorebase module

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.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