FEDn
v0.6.1
Table of Contents
Introduction to Federated Learning
Quick Start
Architecture overview
Distributed Deployment
User interfaces
Tutorial: Compute Package
Frequently asked questions
API reference
FEDn
Index
Edit on GitHub
Index
A
|
C
|
D
|
E
|
F
|
G
|
H
|
I
|
L
|
M
|
N
|
O
|
P
|
R
|
S
|
T
|
U
|
V
|
W
A
AcceptingClients() (fedn.network.combiner.server.Combiner method)
add_client() (fedn.network.api.interface.API method)
(fedn.network.api.network.Network method)
add_combiner() (fedn.network.api.interface.API method)
(fedn.network.api.network.Network method)
Aggregator (class in fedn.network.combiner.aggregators.fedavg)
AggregatorBase (class in fedn.network.combiner.aggregators.aggregatorbase)
allowed_file() (in module fedn.network.dashboard.restservice)
allowing_clients() (fedn.network.combiner.interfaces.CombinerInterface method)
announce() (fedn.network.combiner.connect.ConnectorCombiner method)
API (class in fedn.network.api.interface)
APIClient (class in fedn.network.api.client)
assign() (fedn.network.clients.connect.ConnectorClient method)
Assigned (fedn.network.clients.connect.Status attribute)
(fedn.network.combiner.connect.Status attribute)
authorize() (fedn.network.dashboard.restservice.ReducerRestService method)
C
Channel (class in fedn.network.combiner.interfaces)
check_compute_package() (fedn.network.dashboard.restservice.ReducerRestService method)
check_configured() (fedn.network.dashboard.restservice.ReducerRestService method)
check_configured_response() (fedn.network.dashboard.restservice.ReducerRestService method)
check_initial_model() (fedn.network.dashboard.restservice.ReducerRestService method)
Client (class in fedn.network.clients.client)
ClientState (class in fedn.network.clients.state)
ClientStateToString() (in module fedn.network.clients.state)
combine_models() (fedn.network.combiner.aggregators.aggregatorbase.AggregatorBase method)
(fedn.network.combiner.aggregators.fedavg.Aggregator method)
Combiner (class in fedn.network.combiner.server)
COMBINER (fedn.network.combiner.server.Role attribute)
CombinerInterface (class in fedn.network.combiner.interfaces)
CombinersNotDoneException
CombinerUnavailableError
compute_bundle_dir (fedn.network.config.ReducerConfig attribute)
Config (class in fedn.network.config)
configure() (fedn.network.combiner.interfaces.CombinerInterface method)
Configure() (fedn.network.combiner.server.Combiner method)
ConnectorClient (class in fedn.network.clients.connect)
ConnectorCombiner (class in fedn.network.combiner.connect)
Control (class in fedn.network.controller.control)
control_loop() (fedn.network.reducer.Reducer method)
create_box_plot() (fedn.network.dashboard.plots.Plot method)
create_client_histogram_plot() (fedn.network.dashboard.plots.Plot method)
create_client_plot() (fedn.network.dashboard.plots.Plot method)
create_client_training_distribution() (fedn.network.dashboard.plots.Plot method)
create_combiner_plot() (fedn.network.dashboard.plots.Plot method)
create_cpu_plot() (fedn.network.dashboard.plots.Plot method)
create_round_plot() (fedn.network.dashboard.plots.Plot method)
create_table_plot() (fedn.network.dashboard.plots.Plot method)
create_timeline_plot() (fedn.network.dashboard.plots.Plot method)
D
decode_auth_token() (in module fedn.network.dashboard.restservice)
delete_combiner() (fedn.network.statestore.mongostatestore.MongoStateStore method)
describe() (fedn.network.api.network.Network method)
Dispatcher (class in fedn.utils.dispatcher)
dispatcher() (fedn.network.clients.package.PackageRuntime method)
download() (fedn.network.clients.package.PackageRuntime method)
Download() (fedn.network.combiner.modelservice.ModelService method)
download_compute_package() (fedn.network.api.interface.API method)
download_package() (fedn.network.api.client.APIClient method)
E
encode_auth_token() (in module fedn.network.dashboard.restservice)
execute_training_round() (fedn.network.combiner.round.RoundController method)
execute_validation_round() (fedn.network.combiner.round.RoundController method)
exist() (fedn.network.combiner.modelservice.ModelService method)
F
fedn
module
fedn.network
module
fedn.network.api
module
fedn.network.api.client
module
fedn.network.api.interface
module
fedn.network.api.network
module
fedn.network.clients
module
fedn.network.clients.client
module
fedn.network.clients.connect
module
fedn.network.clients.package
module
fedn.network.clients.state
module
fedn.network.combiner
module
fedn.network.combiner.aggregators
module
fedn.network.combiner.aggregators.aggregatorbase
module
fedn.network.combiner.aggregators.fedavg
module
fedn.network.combiner.connect
module
fedn.network.combiner.interfaces
module
fedn.network.combiner.modelservice
module
fedn.network.combiner.round
module
fedn.network.combiner.server
module
fedn.network.config
module
fedn.network.controller
module
fedn.network.controller.control
module
fedn.network.dashboard
module
fedn.network.dashboard.plots
module
fedn.network.dashboard.restservice
module
fedn.network.loadbalancer
module
fedn.network.loadbalancer.firstavailable
module
fedn.network.loadbalancer.leastpacked
module
fedn.network.loadbalancer.loadbalancerbase
module
fedn.network.reducer
module
fedn.network.state
module
fedn.network.statestore
module
fedn.network.statestore.mongostatestore
module
fedn.network.statestore.statestorebase
module
fedn.utils
module
fedn.utils.checksum
module
fedn.utils.dispatcher
module
fedn.utils.helpers
module
fedn.utils.logger
module
fedn.utils.plugins
module
fedn.utils.plugins.helperbase
module
fedn.utils.plugins.kerashelper
module
fedn.utils.plugins.numpyarrayhelper
module
fedn.utils.plugins.pytorchhelper
module
fedn.utils.process
module
fetch_valid_metrics() (fedn.network.dashboard.plots.Plot method)
find_available_combiner() (fedn.network.api.network.Network method)
find_combiner() (fedn.network.loadbalancer.firstavailable.LeastPacked method)
(fedn.network.loadbalancer.leastpacked.LeastPacked method)
(fedn.network.loadbalancer.loadbalancerbase.LoadBalancerBase method)
flush_model_update_queue() (fedn.network.combiner.interfaces.CombinerInterface method)
(fedn.network.combiner.server.Combiner method)
FlushAggregationQueue() (fedn.network.combiner.server.Combiner method)
from_json() (fedn.network.combiner.interfaces.CombinerInterface class method)
G
get_active_clients() (fedn.network.api.client.APIClient method)
(fedn.network.api.interface.API method)
get_active_trainers() (fedn.network.combiner.server.Combiner method)
get_active_validators() (fedn.network.combiner.server.Combiner method)
get_aggregator() (in module fedn.network.combiner.aggregators.aggregatorbase)
get_all_combiners() (fedn.network.api.interface.API method)
get_all_rounds() (fedn.network.api.interface.API method)
get_all_sessions() (fedn.network.api.interface.API method)
get_all_validations() (fedn.network.api.interface.API method)
get_certificate() (fedn.network.combiner.interfaces.CombinerInterface method)
get_channel() (fedn.network.combiner.interfaces.Channel method)
get_checksum() (fedn.network.api.interface.API method)
get_client() (fedn.network.api.network.Network method)
(fedn.network.statestore.mongostatestore.MongoStateStore method)
get_client_config() (fedn.network.api.client.APIClient method)
(fedn.network.api.interface.API method)
get_client_df() (fedn.network.dashboard.plots.Plot method)
get_client_info() (fedn.network.api.network.Network method)
get_clients() (fedn.network.api.interface.API method)
get_combiner() (fedn.network.api.client.APIClient method)
(fedn.network.api.interface.API method)
(fedn.network.api.network.Network method)
(fedn.network.statestore.mongostatestore.MongoStateStore method)
get_combiners() (fedn.network.api.network.Network method)
(fedn.network.statestore.mongostatestore.MongoStateStore method)
get_compute_package() (fedn.network.api.interface.API method)
(fedn.network.statestore.mongostatestore.MongoStateStore method)
get_config() (fedn.network.statestore.mongostatestore.MongoStateStore method)
get_controller_status() (fedn.network.api.client.APIClient method)
(fedn.network.api.interface.API method)
get_events() (fedn.network.api.client.APIClient method)
(fedn.network.api.interface.API method)
(fedn.network.statestore.mongostatestore.MongoStateStore method)
get_helper() (fedn.network.statestore.mongostatestore.MongoStateStore method)
(in module fedn.utils.helpers)
get_initial_model() (fedn.network.api.client.APIClient method)
(fedn.network.api.interface.API method)
(fedn.network.statestore.mongostatestore.MongoStateStore method)
get_key() (fedn.network.combiner.interfaces.CombinerInterface method)
get_latest_model() (fedn.network.api.client.APIClient method)
(fedn.network.api.interface.API method)
(fedn.network.statestore.mongostatestore.MongoStateStore method)
(fedn.network.statestore.statestorebase.StateStoreBase method)
get_latest_round() (fedn.network.statestore.mongostatestore.MongoStateStore method)
get_model() (fedn.network.clients.client.Client method)
(fedn.network.combiner.interfaces.CombinerInterface method)
(fedn.network.combiner.modelservice.ModelService method)
get_model_trail() (fedn.network.api.client.APIClient method)
(fedn.network.api.interface.API method)
(fedn.network.statestore.mongostatestore.MongoStateStore method)
get_models() (fedn.network.api.interface.API method)
get_package() (fedn.network.api.client.APIClient method)
get_package_checksum() (fedn.network.api.client.APIClient method)
get_plot_data() (fedn.network.api.interface.API method)
get_reducer() (fedn.network.statestore.mongostatestore.MongoStateStore method)
get_round() (fedn.network.api.client.APIClient method)
(fedn.network.api.interface.API method)
(fedn.network.statestore.mongostatestore.MongoStateStore method)
get_rounds() (fedn.network.statestore.mongostatestore.MongoStateStore method)
get_session() (fedn.network.api.client.APIClient method)
(fedn.network.api.interface.API method)
(fedn.network.statestore.mongostatestore.MongoStateStore method)
get_sessions() (fedn.network.statestore.mongostatestore.MongoStateStore method)
get_state() (fedn.network.combiner.aggregators.aggregatorbase.AggregatorBase method)
get_storage_backend() (fedn.network.statestore.mongostatestore.MongoStateStore method)
get_tmp_path() (fedn.network.combiner.modelservice.ModelService method)
(fedn.utils.plugins.helperbase.HelperBase method)
get_validations() (fedn.network.statestore.mongostatestore.MongoStateStore method)
GrpcAuth (class in fedn.network.clients.client)
H
handle_unavailable_combiner() (fedn.network.api.network.Network method)
Helper (class in fedn.utils.plugins.kerashelper)
(class in fedn.utils.plugins.numpyarrayhelper)
(class in fedn.utils.plugins.pytorchhelper)
HelperBase (class in fedn.utils.plugins.helperbase)
I
idle (fedn.network.clients.state.ClientState attribute)
(fedn.network.state.ReducerState attribute)
increment_average() (fedn.utils.plugins.helperbase.HelperBase method)
(fedn.utils.plugins.kerashelper.Helper method)
(fedn.utils.plugins.numpyarrayhelper.Helper method)
(fedn.utils.plugins.pytorchhelper.Helper method)
increment_average_add() (fedn.utils.plugins.kerashelper.Helper method)
infer_instruct() (fedn.network.controller.control.Control method)
inference_round() (fedn.network.controller.control.Control method)
initial_model (fedn.network.config.ReducerConfig attribute)
instructing (fedn.network.state.ReducerState attribute)
InvalidReducerConfiguration
is_inited() (fedn.network.statestore.mongostatestore.MongoStateStore method)
(fedn.network.statestore.statestorebase.StateStoreBase method)
L
LeastPacked (class in fedn.network.loadbalancer.firstavailable)
(class in fedn.network.loadbalancer.leastpacked)
list_active_clients() (fedn.network.combiner.interfaces.CombinerInterface method)
list_clients() (fedn.network.api.client.APIClient method)
(fedn.network.statestore.mongostatestore.MongoStateStore method)
list_combiners() (fedn.network.api.client.APIClient method)
list_combiners_data() (fedn.network.api.interface.API method)
(fedn.network.statestore.mongostatestore.MongoStateStore method)
list_models() (fedn.network.statestore.mongostatestore.MongoStateStore method)
list_rounds() (fedn.network.api.client.APIClient method)
list_sessions() (fedn.network.api.client.APIClient method)
list_validations() (fedn.network.api.client.APIClient method)
ListActiveClients() (fedn.network.combiner.server.Combiner method)
load() (fedn.utils.plugins.helperbase.HelperBase method)
(fedn.utils.plugins.kerashelper.Helper method)
(fedn.utils.plugins.numpyarrayhelper.Helper method)
(fedn.utils.plugins.pytorchhelper.Helper method)
load_model_from_BytesIO() (fedn.network.combiner.modelservice.ModelService method)
load_model_update() (fedn.network.combiner.round.RoundController method)
load_model_update_str() (fedn.network.combiner.round.RoundController method)
LoadBalancerBase (class in fedn.network.loadbalancer.loadbalancerbase)
Logger (class in fedn.utils.logger)
M
make_netgraph_plot() (fedn.network.dashboard.plots.Plot method)
make_single_node_plot() (fedn.network.dashboard.plots.Plot method)
MisconfiguredStorageBackend
MissingReducerConfiguration
models_dir (fedn.network.config.ReducerConfig attribute)
ModelService (class in fedn.network.combiner.modelservice)
ModelUpdateError
ModelUpdateRequestStream() (fedn.network.combiner.server.Combiner method)
ModelUpdateStream() (fedn.network.combiner.server.Combiner method)
ModelValidationRequestStream() (fedn.network.combiner.server.Combiner method)
ModelValidationStream() (fedn.network.combiner.server.Combiner method)
module
fedn
fedn.network
fedn.network.api
fedn.network.api.client
fedn.network.api.interface
fedn.network.api.network
fedn.network.clients
fedn.network.clients.client
fedn.network.clients.connect
fedn.network.clients.package
fedn.network.clients.state
fedn.network.combiner
fedn.network.combiner.aggregators
fedn.network.combiner.aggregators.aggregatorbase
fedn.network.combiner.aggregators.fedavg
fedn.network.combiner.connect
fedn.network.combiner.interfaces
fedn.network.combiner.modelservice
fedn.network.combiner.round
fedn.network.combiner.server
fedn.network.config
fedn.network.controller
fedn.network.controller.control
fedn.network.dashboard
fedn.network.dashboard.plots
fedn.network.dashboard.restservice
fedn.network.loadbalancer
fedn.network.loadbalancer.firstavailable
fedn.network.loadbalancer.leastpacked
fedn.network.loadbalancer.loadbalancerbase
fedn.network.reducer
fedn.network.state
fedn.network.statestore
fedn.network.statestore.mongostatestore
fedn.network.statestore.statestorebase
fedn.utils
fedn.utils.checksum
fedn.utils.dispatcher
fedn.utils.helpers
fedn.utils.logger
fedn.utils.plugins
fedn.utils.plugins.helperbase
fedn.utils.plugins.kerashelper
fedn.utils.plugins.numpyarrayhelper
fedn.utils.plugins.pytorchhelper
fedn.utils.process
MongoStateStore (class in fedn.network.statestore.mongostatestore)
monitoring (fedn.network.state.ReducerState attribute)
N
Network (class in fedn.network.api.network)
next_model_update() (fedn.network.combiner.aggregators.aggregatorbase.AggregatorBase method)
NoModelException
nr_active_trainers() (fedn.network.combiner.server.Combiner method)
nr_active_validators() (fedn.network.combiner.server.Combiner method)
O
on_model_update() (fedn.network.combiner.aggregators.aggregatorbase.AggregatorBase method)
OTHER (fedn.network.combiner.server.Role attribute)
P
PackageRuntime (class in fedn.network.clients.package)
Plot (class in fedn.network.dashboard.plots)
process_request() (fedn.network.clients.client.Client method)
push_round_config() (fedn.network.combiner.round.RoundController method)
R
reduce() (fedn.network.controller.control.Control method)
Reducer (class in fedn.network.reducer)
REDUCER (fedn.network.combiner.server.Role attribute)
ReducerConfig (class in fedn.network.config)
ReducerRestService (class in fedn.network.dashboard.restservice)
ReducerState (class in fedn.network.state)
ReducerStateToString() (in module fedn.network.state)
register_model_validation() (fedn.network.combiner.server.Combiner method)
remove_combiner() (fedn.network.api.network.Network method)
report() (fedn.network.combiner.interfaces.CombinerInterface method)
Report() (fedn.network.combiner.server.Combiner method)
report_status() (fedn.network.combiner.server.Combiner method)
request_model_update() (fedn.network.combiner.server.Combiner method)
request_model_validation() (fedn.network.combiner.server.Combiner method)
Role (class in fedn.network.combiner.server)
role_to_proto_role() (in module fedn.network.combiner.server)
round() (fedn.network.controller.control.Control method)
RoundController (class in fedn.network.combiner.round)
run() (fedn.network.clients.client.Client method)
(fedn.network.combiner.round.RoundController method)
(fedn.network.combiner.server.Combiner method)
(fedn.network.dashboard.restservice.ReducerRestService method)
(fedn.network.reducer.Reducer method)
run_cmd() (fedn.utils.dispatcher.Dispatcher method)
run_process() (in module fedn.utils.process)
S
save() (fedn.utils.plugins.helperbase.HelperBase method)
(fedn.utils.plugins.kerashelper.Helper method)
(fedn.utils.plugins.numpyarrayhelper.Helper method)
(fedn.utils.plugins.pytorchhelper.Helper method)
save_metadata() (in module fedn.utils.helpers)
save_metrics() (in module fedn.utils.helpers)
SendHeartbeat() (fedn.network.combiner.server.Combiner method)
SendModelUpdate() (fedn.network.combiner.server.Combiner method)
SendModelUpdateRequest() (fedn.network.combiner.server.Combiner method)
SendModelValidation() (fedn.network.combiner.server.Combiner method)
SendModelValidationRequest() (fedn.network.combiner.server.Combiner method)
SendStatus() (fedn.network.combiner.server.Combiner method)
serialize_model_to_BytesIO() (fedn.network.combiner.modelservice.ModelService method)
session() (fedn.network.controller.control.Control method)
set_client() (fedn.network.statestore.mongostatestore.MongoStateStore method)
set_combiner() (fedn.network.statestore.mongostatestore.MongoStateStore method)
set_compute_package() (fedn.network.api.interface.API method)
(fedn.network.statestore.mongostatestore.MongoStateStore method)
set_helper() (fedn.network.statestore.mongostatestore.MongoStateStore method)
set_initial_model() (fedn.network.api.client.APIClient method)
(fedn.network.api.interface.API method)
set_latest_model() (fedn.network.statestore.mongostatestore.MongoStateStore method)
(fedn.network.statestore.statestorebase.StateStoreBase method)
set_model() (fedn.network.clients.client.Client method)
(fedn.network.combiner.modelservice.ModelService method)
set_package() (fedn.network.api.client.APIClient method)
set_reducer() (fedn.network.statestore.mongostatestore.MongoStateStore method)
set_storage_backend() (fedn.network.statestore.mongostatestore.MongoStateStore method)
setup (fedn.network.state.ReducerState attribute)
sha() (in module fedn.utils.checksum)
stage_model() (fedn.network.combiner.round.RoundController method)
Start() (fedn.network.combiner.server.Combiner method)
start_session() (fedn.network.api.client.APIClient method)
(fedn.network.api.interface.API method)
state() (fedn.network.statestore.mongostatestore.MongoStateStore method)
(fedn.network.statestore.statestorebase.StateStoreBase method)
StateStoreBase (class in fedn.network.statestore.statestorebase)
Status (class in fedn.network.clients.connect)
(class in fedn.network.combiner.connect)
Stop() (fedn.network.combiner.server.Combiner method)
storage_backend (fedn.network.config.ReducerConfig attribute)
StringToReducerState() (in module fedn.network.state)
submit() (fedn.network.combiner.interfaces.CombinerInterface method)
T
to_dict() (fedn.network.combiner.interfaces.CombinerInterface method)
(fedn.network.dashboard.restservice.ReducerRestService method)
to_json() (fedn.network.combiner.interfaces.CombinerInterface method)
training (fedn.network.clients.state.ClientState attribute)
transition() (fedn.network.statestore.mongostatestore.MongoStateStore method)
(fedn.network.statestore.statestorebase.StateStoreBase method)
TryAgain (fedn.network.clients.connect.Status attribute)
(fedn.network.combiner.connect.Status attribute)
U
Unassigned (fedn.network.clients.connect.Status attribute)
(fedn.network.combiner.connect.Status attribute)
UnAuthorized (fedn.network.clients.connect.Status attribute)
(fedn.network.combiner.connect.Status attribute)
UnMatchedConfig (fedn.network.clients.connect.Status attribute)
(fedn.network.combiner.connect.Status attribute)
unpack() (fedn.network.clients.package.PackageRuntime method)
UnsupportedStorageBackend
update_client_data() (fedn.network.api.network.Network method)
update_client_status() (fedn.network.statestore.mongostatestore.MongoStateStore method)
Upload() (fedn.network.combiner.modelservice.ModelService method)
V
validate() (fedn.network.clients.package.PackageRuntime method)
validating (fedn.network.clients.state.ClientState attribute)
W
waitforit() (fedn.network.combiner.round.RoundController method)
WORKER (fedn.network.combiner.server.Role attribute)