Merge branch 'alibaba:master' into readme_scripts

alibaba · Aug 9, 2022 · ed30653 · ed30653
2 parents 743e2db + 180f3a9
commit ed30653
Show file tree

Hide file tree

Showing 30 changed files with 580 additions and 326 deletions.
diff --git a/README.md b/README.md
@@ -22,6 +22,40 @@ A detailed tutorial is provided on our [website](https://federatedscope.io/).
 - [05-25-2022] Our paper [FederatedScope-GNN](https://arxiv.org/abs/2204.05562) has been accepted by KDD'2022!
 - [05-06-2022] We release FederatedScope v0.1.0! 
 
+## Code Structure
+```
+FederatedScope
+├── federatedscope
+│   ├── core           
+│   |   ├── workers              # Behaviors of participants (i.e., server and clients)
+│   |   ├── trainers             # Details of local training
+│   |   ├── aggregators          # Details of federated aggregation
+│   |   ├── configs              # Customizable configurations
+│   |   ├── monitors             # The monitor module for logging and demonstrating  
+│   |   ├── communication.py     # Implementation of communication among participants   
+│   |   ├── fed_runner.py        # The runner for building and running an FL course
+│   |   ├── ... ..
+│   ├── cv                       # Federated learning in CV        
+│   ├── nlp                      # Federated learning in NLP          
+│   ├── gfl                      # Graph federated learning          
+│   ├── autotune                 # Auto-tunning for federated learning         
+│   ├── contrib                          
+│   ├── main.py           
+│   ├── ... ...          
+├── scripts                      # Scripts for reproducing existing algorithms
+├── benchmark                    # We release several benchmarks for convenient and fair comparisons
+├── doc                          # For automatic documentation
+├── enviornment                  # Installation requirements and provided docker files
+├── materials                    # Materials of related topics (e.g., paper lists)
+│   ├── notebook                        
+│   ├── paper_list                                        
+│   ├── tutorial                                       
+│   ├── ... ...                                      
+├── tests                        # Unittest modules for continuous integration
+├── LICENSE
+└── setup.py
+```
+
 ## Quick Start
 
 We provide an end-to-end example for users to start running a standard FL course with FederatedScope.

diff --git a/benchmark/pFL-Bench/yaml_best_runs_example/Ditto_FEMNIST-s02.yaml b/benchmark/pFL-Bench/yaml_best_runs_example/Ditto_FEMNIST-s02.yaml
@@ -20,6 +20,7 @@ cfg_file: ''
 criterion:
   type: CrossEntropyLoss
 data:
+  save_data: false
   args: []
   batch_size: 32
   cSBM_phi:
@@ -75,7 +76,6 @@ eval:
   - avg
   - fairness
   - raw
-  save_data: false
   split:
   - test
   - val

diff --git a/benchmark/pFL-Bench/yaml_best_runs_example/FedAvg-FT_FEMNIST-s02.yaml b/benchmark/pFL-Bench/yaml_best_runs_example/FedAvg-FT_FEMNIST-s02.yaml
@@ -20,6 +20,7 @@ cfg_file: ''
 criterion:
   type: CrossEntropyLoss
 data:
+  save_data: false
   args: []
   batch_size: 32
   cSBM_phi:
@@ -75,7 +76,6 @@ eval:
   - avg
   - fairness
   - raw
-  save_data: false
   split:
   - test
   - val

diff --git a/benchmark/pFL-Bench/yaml_best_runs_example/FedEM-FedBN-FedOPT-FT_FEMNIST-s02.yaml b/benchmark/pFL-Bench/yaml_best_runs_example/FedEM-FedBN-FedOPT-FT_FEMNIST-s02.yaml
@@ -20,6 +20,7 @@ cfg_file: ''
 criterion:
   type: CrossEntropyLoss
 data:
+  save_data: false
   args: []
   batch_size: 32
   cSBM_phi:
@@ -76,7 +77,6 @@ eval:
   - avg
   - fairness
   - raw
-  save_data: false
   split:
   - test
   - val

diff --git a/federatedscope/attack/worker_as_attacker/server_attacker.py b/federatedscope/attack/worker_as_attacker/server_attacker.py
@@ -1,4 +1,4 @@
-from federatedscope.core.worker import Server
+from federatedscope.core.workers import Server
 from federatedscope.core.message import Message
 
 from federatedscope.core.auxiliaries.criterion_builder import get_criterion

diff --git a/federatedscope/autotune/fedex/client.py b/federatedscope/autotune/fedex/client.py
@@ -3,7 +3,7 @@
 import copy
 
 from federatedscope.core.message import Message
-from federatedscope.core.worker import Client
+from federatedscope.core.workers import Client
 
 logger = logging.getLogger(__name__)
 

diff --git a/federatedscope/autotune/fedex/server.py b/federatedscope/autotune/fedex/server.py
@@ -9,7 +9,7 @@
 from scipy.special import logsumexp
 
 from federatedscope.core.message import Message
-from federatedscope.core.worker import Server
+from federatedscope.core.workers import Server
 from federatedscope.core.auxiliaries.utils import merge_dict
 
 logger = logging.getLogger(__name__)

diff --git a/federatedscope/core/aggregator.py b/federatedscope/core/aggregator.py