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.auth module
- fedn.network.api.client module
APIClientAPIClient.__init__()APIClient.add_attributes()APIClient.continue_session()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_current_attributes()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_predictions()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_predictions()APIClient.start_session()APIClient.start_splitlearning_session()
- fedn.network.api.gunicorn_app module
- fedn.network.api.network module
- fedn.network.api.shared module
- fedn.network.clients package
- Submodules
- fedn.network.clients.client_v2 module
- fedn.network.clients.connect module
- fedn.network.clients.fedn_client module
ConnectToApiResultFednClientFednClient.__init__()FednClient.backward_gradients()FednClient.connect_to_api()FednClient.create_backward_completion_message()FednClient.create_prediction_message()FednClient.create_update_message()FednClient.create_validation_message()FednClient.default_telemetry_loop()FednClient.download_compute_package()FednClient.forward_embeddings()FednClient.get_model_from_combiner()FednClient.get_or_set_environment()FednClient.init_grpchandler()FednClient.init_local_compute_package()FednClient.init_remote_compute_package()FednClient.listen_to_task_stream()FednClient.log_attributes()FednClient.log_metric()FednClient.log_telemetry()FednClient.logging_context()FednClient.predict_global_model()FednClient.run()FednClient.send_heartbeats()FednClient.send_model_prediction()FednClient.send_model_to_combiner()FednClient.send_model_update()FednClient.send_model_validation()FednClient.send_status()FednClient.set_backward_callback()FednClient.set_client_id()FednClient.set_compute_package_checksum()FednClient.set_dispatcher()FednClient.set_forward_callback()FednClient.set_name()FednClient.set_predict_callback()FednClient.set_train_callback()FednClient.set_validate_callback()FednClient.unpack_compute_package()FednClient.update_local_model()FednClient.validate_compute_package()FednClient.validate_global_model()
GrpcConnectionOptionsLoggingContextget_compute_package_dir_path()
- fedn.network.clients.grpc_handler module
GrpcAuthGrpcHandlerGrpcHandler.__init__()GrpcHandler.create_backward_completion_message()GrpcHandler.create_metric_message()GrpcHandler.create_prediction_message()GrpcHandler.create_update_message()GrpcHandler.create_validation_message()GrpcHandler.get_model_from_combiner()GrpcHandler.heartbeat()GrpcHandler.listen_to_task_stream()GrpcHandler.send_attributes()GrpcHandler.send_backward_completion()GrpcHandler.send_heartbeats()GrpcHandler.send_model_metric()GrpcHandler.send_model_prediction()GrpcHandler.send_model_to_combiner()GrpcHandler.send_model_update()GrpcHandler.send_model_validation()GrpcHandler.send_status()GrpcHandler.send_telemetry()
RetryExceptiongrpc_retry()
- fedn.network.clients.package_runtime module
- fedn.network.clients.state module
- fedn.network.combiner package
- Subpackages
- fedn.network.combiner.aggregators package
- fedn.network.combiner.hooks package
- Submodules
- fedn.network.combiner.hooks.allowed_import module
- fedn.network.combiner.hooks.grpc_wrappers module
- fedn.network.combiner.hooks.hook_client module
- fedn.network.combiner.hooks.hooks module
- fedn.network.combiner.hooks.serverfunctionsbase module
- fedn.network.combiner.hooks.serverfunctionstest module
- Submodules
- fedn.network.combiner.combiner module
CombinerCombiner.AcceptingClients()Combiner.FlushAggregationQueue()Combiner.ListActiveClients()Combiner.SendAttributeMessage()Combiner.SendBackwardCompletion()Combiner.SendHeartbeat()Combiner.SendModelMetric()Combiner.SendModelPrediction()Combiner.SendModelUpdate()Combiner.SendModelValidation()Combiner.SendStatus()Combiner.SendTelemetryMessage()Combiner.SetAggregator()Combiner.SetServerFunctions()Combiner.Start()Combiner.Stop()Combiner.TaskStream()Combiner.__init__()Combiner.create_instance()Combiner.get_active_trainers()Combiner.get_active_validators()Combiner.instance()Combiner.nr_active_trainers()Combiner.register_model_validation()Combiner.request_backward_pass()Combiner.request_forward_pass()Combiner.request_model_prediction()Combiner.request_model_update()Combiner.request_model_validation()Combiner.run()
CombinerConfigCombinerConfig.cert_pathCombinerConfig.discover_hostCombinerConfig.discover_portCombinerConfig.fqdnCombinerConfig.hostCombinerConfig.ipCombinerConfig.key_pathCombinerConfig.logfileCombinerConfig.max_clientsCombinerConfig.nameCombinerConfig.network_idCombinerConfig.parentCombinerConfig.portCombinerConfig.secureCombinerConfig.tokenCombinerConfig.verbosityCombinerConfig.verify
Rolerole_to_proto_role()
- fedn.network.combiner.connect module
- fedn.network.combiner.interfaces module
ChannelCombinerInterfaceCombinerInterface.__init__()CombinerInterface.allowing_clients()CombinerInterface.flush_model_update_queue()CombinerInterface.from_json()CombinerInterface.get_certificate()CombinerInterface.get_key()CombinerInterface.list_active_clients()CombinerInterface.set_aggregator()CombinerInterface.set_server_functions()CombinerInterface.submit()CombinerInterface.to_dict()CombinerInterface.to_json()
CombinerUnavailableError
- fedn.network.combiner.modelservice module
- fedn.network.combiner.roundhandler module
RoundConfigRoundConfig.aggregatorRoundConfig.client_settingsRoundConfig.committed_atRoundConfig.helper_typeRoundConfig.model_idRoundConfig.model_metadataRoundConfig.model_parametersRoundConfig.model_sizeRoundConfig.model_typeRoundConfig.model_versionRoundConfig.round_idRoundConfig.round_timeoutRoundConfig.roundsRoundConfig.selected_clientsRoundConfig.session_idRoundConfig.task
RoundHandlerRoundHandler.__init__()RoundHandler.execute_backward_pass()RoundHandler.execute_forward_pass()RoundHandler.execute_prediction_round()RoundHandler.execute_training_round()RoundHandler.execute_validation_round()RoundHandler.push_round_config()RoundHandler.run()RoundHandler.set_aggregator()RoundHandler.set_server_functions()RoundHandler.stage_model()
- fedn.network.combiner.shared module
- fedn.network.combiner.updatehandler module
ModelUpdateErrorUpdateHandlerUpdateHandler.__init__()UpdateHandler.clear_backward_completions()UpdateHandler.delete_model()UpdateHandler.load_model()UpdateHandler.load_model_update()UpdateHandler.load_model_update_byte()UpdateHandler.load_model_update_bytesIO()UpdateHandler.next_model_update()UpdateHandler.on_model_update()UpdateHandler.waitforbackwardcompletion()UpdateHandler.waitforit()
- Subpackages
- fedn.network.controller package
- fedn.network.grpc package
- fedn.network.loadbalancer package
- fedn.network.storage package
- Subpackages
- Submodules
- fedn.network.storage.dbconnection module
DatabaseConnectionDatabaseConnection.__init__()DatabaseConnection.attribute_storeDatabaseConnection.client_storeDatabaseConnection.combiner_storeDatabaseConnection.initialize_connection()DatabaseConnection.metric_storeDatabaseConnection.model_storeDatabaseConnection.package_storeDatabaseConnection.prediction_storeDatabaseConnection.round_storeDatabaseConnection.run_storeDatabaseConnection.session_storeDatabaseConnection.status_storeDatabaseConnection.telemetry_storeDatabaseConnection.validation_store
Submodules
fedn.network.config module
fedn.network.state module
- class fedn.network.state.ReducerState(value)[source]
Bases:
EnumEnum for representing the state of a reducer.
- idle = 2
- instructing = 3
- monitoring = 4
- setup = 1
- fedn.network.state.ReducerStateToString(state)[source]
Convert ReducerState to string.
- Parameters:
state (
fedn.network.state.ReducerState) – The state.- Returns:
The state as string.
- Return type: