Skip to content

Commit 78d70c0

Browse files
authored
Update README.md
1 parent d6ed963 commit 78d70c0

File tree

1 file changed

+3
-30
lines changed

1 file changed

+3
-30
lines changed

README.md

Lines changed: 3 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,5 @@
11
# FLGo: A Lightning Framework for Federated Learning
22

3-
This repository is PyTorch implementation for the IJCAI-21 paper [Federated Learning with Fair Averaging](https://fanxlxmu.github.io/publication/ijcai2021/).
4-
53
Our FLGo is a strong and reusable experimental platform for research on federated learning (FL) algorithm, which has provided a few easy-to-use modules to hold out for those who want to do various federated learning experiments.
64

75
## Table of Contents
@@ -15,7 +13,7 @@ Our FLGo is a strong and reusable experimental platform for research on federate
1513
* install pytorch
1614
* install flgo
1715
```sh
18-
pip install -i https://test.pypi.org/simple/ test-flgo-wwwzz
16+
pip install flgo
1917
```
2018
* run test.py
2119
```sh
@@ -33,23 +31,6 @@ python test.py
3331
| FedBuff |<a href='#refer-anchor-2'></a>||
3432
| TiFL |<a href='#refer-anchor-2'></a>||
3533

36-
### Dataset Partition
37-
To divide the dataset using different partitions, make the following changes to the contents of the gen_config.yml file:
38-
```
39-
# I.I.D.
40-
partitioner:
41-
name: IIDPartitioner
42-
para:
43-
num_clients: 100
44-
45-
# Imbalace & dirichlet
46-
partitioner:
47-
name: DirichletPartitioner
48-
para:
49-
num_clients: 100
50-
imbalance: 0.1
51-
alpha: 0.1
52-
```
5334

5435
### Options
5536

@@ -152,23 +133,15 @@ We seperate the FL system into four parts:`algorithm`, `benchmark`, `experiment`
152133
│ ├─ analyzer.py //the class for analyzing and printing experimental results
153134
│ ├─ res_config.yml //hyperparameter file of analyzer.py
154135
│ ├─ run_config.yml //hyperparameter file of runner.py
155-
| └─ runner.py //the class for generating experimental commands based on hyperparameter combinations and processor scheduling for all experimental commands
156-
├─ fedtask
157-
│ ├─ B-mnist_classification_P-dir0.10_N-100_S-0 //a fedtask
158-
│ │ ├─ record //the directionary of the running result
159-
│ | └─ data.json //the splitted federated dataset (fedtask)
160-
| └─ ...
136+
| └─ runner.py //the class for generating experimental commands based on hyperparameter combinations and processor scheduling for all experimental
161137
├─ system_simulator //system heterogeneity simulation module
162138
│ ├─ base.py //the base class for simulate system heterogeneity
163139
│ ├─ default_simulator.py //the default class for simulate system heterogeneity
164140
| └─ ...
165141
├─ utils
166142
│ ├─ fflow.py //option to read, initialize,...
167143
│ └─ fmodule.py //model-level operators
168-
├─ generate_fedtask.py //generate fedtask
169-
├─ gen_config.yml //hyperparameter file of generate_fedtask.py
170-
├─ requirements.txt
171-
└─ main.py //run this file to start easyFL system
144+
└─ requirements.txt
172145
```
173146
174147
### Benchmark

0 commit comments

Comments
 (0)