Merge pull request #131 from SMILELab-FL/v1.1-dev

V1.1 dev

Author: dunzeng

.gitignore

@@ -148,6 +148,16 @@ dmypy.json
 cython_debug/
 
 # dataset
+fedlab_benchmarks/algorithm/fedavg/scale/shakespeare-rnn/pkl_dataset/*
+
+fedlab_benchmarks/datasets/data/mnist/*
+!fedlab_benchmarks/datasets/data/mnist/*.py
+
+
+fedlab_benchmarks/datasets/data/cifar10/*
+!fedlab_benchmarks/datasets/data/cifar10/*.py
+
+
 fedlab_benchmarks/datasets/data/*/data
 fedlab_benchmarks/datasets/data/*/meta
 tests/data/mnist/*

README.md

@@ -2,7 +2,7 @@
 
 # FedLab: A Flexible Federated Learning Framework
 
-[![Documentation Status](https://readthedocs.org/projects/fedlab/badge/?version=latest)](https://fedlab.readthedocs.io/en/latest/?badge=latest) [![License](https://img.shields.io/github/license/SMILELab-FL/FedLab)](https://opensource.org/licenses/Apache-2.0) [![arXiv](https://img.shields.io/badge/arXiv-2107.11621-red.svg)](https://arxiv.org/abs/2107.11621) [![GH Actions Tests](https://github.com/SMILELab-FL/FedLab/actions/workflows/CI.yml/badge.svg)](https://github.com/SMILELab-FL/FedLab/actions) [![codecov](https://codecov.io/gh/SMILELab-FL/FedLab/branch/v1.0/graph/badge.svg?token=4HHB5JCSC6)](https://codecov.io/gh/SMILELab-FL/FedLab)
+[![GH Actions Tests](https://github.com/SMILELab-FL/FedLab/actions/workflows/CI.yml/badge.svg)](https://github.com/SMILELab-FL/FedLab/actions) [![Documentation Status](https://readthedocs.org/projects/fedlab/badge/?version=latest)](https://fedlab.readthedocs.io/en/latest/?badge=latest) [![License](https://img.shields.io/github/license/SMILELab-FL/FedLab)](https://opensource.org/licenses/Apache-2.0) [![codecov](https://codecov.io/gh/SMILELab-FL/FedLab/branch/v1.0/graph/badge.svg?token=4HHB5JCSC6)](https://codecov.io/gh/SMILELab-FL/FedLab) [![arXiv](https://img.shields.io/badge/arXiv-2107.11621-red.svg)](https://arxiv.org/abs/2107.11621) [![Pyversions](https://img.shields.io/pypi/pyversions/fedlab.svg?style=flat-square)](https://pypi.python.org/pypi/fedlab)
 
 
 _Read this in other languages: [English](README.md), [简体中文](README.zh-cn.md)._

docs/source/contributing.rst

@@ -23,10 +23,12 @@ We encourage you to contribute to the improvement of FedLab or the FedLab reprod
 
     fedlab
     │   ├── core 
+    │   │   ├── communicator            # communication module of FedLab 
     │   │   ├── client                  # client related implementations
-    │   │   ├── communicator            # communication module of FedLab
-    │   │   ├── hierarchical            # hierarchical communication pattern modules
+    │   │   │   └── scale               # scale manager and serial trainer
     │   │   └── server                  # server related implementations
+    │   │       └── scale               # scale manager
+    │   │           └── hierarchical    # hierarchical communication pattern modules
     │   └── utils                       # functional modules
     │       └── dataset                 # functional modules associated with dataset
     │

docs/source/examples.rst

@@ -19,7 +19,7 @@ FedLab provides the necessary modules for FL simulation, including communication
 
    overview
    install
-   examples
+   tutorial
    contributing
    reference
 
@@ -35,7 +35,7 @@ Gallery
             :shadow: md
             :img-bottom: ../imgs/ex-results/fedavg-CNN-MLP-acc-dark.png
             :class-card: sd-rounded-3
-            :link: examples
+            :link: tutorial
             :link-type: ref
 
     .. grid-item::
@@ -45,7 +45,7 @@ Gallery
             :shadow: md
             :img-bottom: ../imgs/ex-results/fedavg-CNN-MLP-loss-dark.png
             :class-card: sd-rounded-3
-            :link: examples
+            :link: tutorial
             :link-type: ref
 
 

docs/source/index.rst

@@ -1,12 +1,12 @@
 .. _installation:
 
 Installation & Set up
-======================
+=====================
 
 FedLab can be installed by source code or pip.
 
 Source Code
-^^^^^^^^^^^^^^
+^^^^^^^^^^^
 
 Download source code from GitHub:
 
@@ -22,9 +22,13 @@ Install dependencies:
    $ pip install -r requirements.txt
 
 Pip
-^^^^
+^^^
 
-Pip install is coming soon.
+We support install FedLab with pip:
+
+.. code-block:: shell-session
+
+   $ pip install fedlab
 
 Dataset Download
 ^^^^^^^^^^^^^^^^

docs/source/install.rst

@@ -182,6 +182,6 @@ How to use FedLab?
 ==================
 
 - :ref:`installation`.
-- :ref:`examples`.
+- :ref:`tutorial`.