update readme

SMILELab-FL · Aug 9, 2021 · 54e1c8d · 54e1c8d
1 parent c22d6d2
commit 54e1c8d
Show file tree

Hide file tree

Showing 4 changed files with 24 additions and 24 deletions.
diff --git a/README.md b/README.md
@@ -6,19 +6,29 @@
 
 _Read this in other languages: [English](README.md), [简体中文](README.zh-cn.md)._
 
-## Table of Contents
+`FedLab` is an open-source Federated Learning framework based on Python and PyTorch.
 
-- [FedLab: A Flexible Federated Learning Framework](#fedlab-a-flexible-federated-learning-framework)
-  - [Table of Contents](#table-of-contents)
-  - [Documentation](#documentation)
-  - [Citation](#citation)
-  - [Contribution Guideline](#contribution-guideline)
-  - [Contact](#contact)
+Federated learning (FL), proposed by Google at the very beginning, is recently a burgeoning research area of machine learning, which aims to protect individual data privacy in distributed machine learning process, especially in ﬁnance, smart healthcare and edge computing. Different from traditional data-centered distributed machine learning, participants in FL setting utilize localized data to train local model, then leverages speciﬁc strategies with other participants to acquire the ﬁnal model collaboratively, avoiding direct data sharing behavior.
+
+To relieve the burden of researchers in implementing FL algorithms and emancipate FL scientists from repetitive implementation of basic FL setting, we introduce highly customizable framework __FedLab__ in this work. __FedLab__ provides the necessary modules for FL simulation, including ***communication***, ***compression***, ***model optimization***, ***data partition*** and other ***functional modules***. __FedLab__ users can build FL simulation environment with custom modules like playing with LEGO bricks. For better understanding and easy usage, FL algorithm benchmark implemented in __FedLab__ are also presented.
+
+- [Documentation](https://fedlab.readthedocs.io/en/latest/)
+- [Overview of FedLab](https://fedlab.readthedocs.io/en/latest/overview.html)
+- [Installation & Setup](https://fedlab.readthedocs.io/en/latest/install.html)
+- [Examples](https://fedlab.readthedocs.io/en/latest/example.html)
+- [Contribute Guideline](https://fedlab.readthedocs.io/en/latest/contributing.html)
+- [API Reference](https://fedlab.readthedocs.io/en/latest/autoapi/index.html)
+
+## Contribution
+
+You're welcome to contribute to this project through _Pull Request_.
+
+- By contributing, you agree that your contributions will be licensed under [Apache License, Version 2.0](https://www.apache.org/licenses/LICENSE-2.0.html) 
+- Docstring  and code should follow Google Python Style Guide: [中文版](https://zh-google-styleguide.readthedocs.io/en/latest/google-python-styleguide/python_style_rules/)|[English](https://google.github.io/styleguide/pyguide.html)
+- The code should provide test cases using `unittest.TestCase`
 
 
-## Documentation
 
-[FedLab Docs (prototype)](https://fedlab.readthedocs.io/en/latest/)
 
 ## Citation
 
@@ -33,18 +43,6 @@ Please cite __FedLab__ in your publications if it helps your research:
 }
 ```
 
-
-
-## Contribution Guideline
-
-You're welcome to contribute to this project through _Pull Request_.
-
-- By contributing, you agree that your contributions will be licensed under [Apache License, Version 2.0](https://www.apache.org/licenses/LICENSE-2.0.html) 
-- Docstring  and code should follow Google Python Style Guide: [中文版](https://zh-google-styleguide.readthedocs.io/en/latest/google-python-styleguide/python_style_rules/)|[English](https://google.github.io/styleguide/pyguide.html)
-- The code should provide test cases using `unittest.TestCase`
-
-
-
 ## Contact
 
 Contact the __FedLab__ development team through Github issues or email: 

diff --git a/docs/source/contributing.rst b/docs/source/contributing.rst
@@ -1,7 +1,7 @@
 .. _contributing:
 
-Contributing
-==============
+Contributing to FedLab
+========================
 
 You're welcome to contribute to this project through **Pull Request**.
 

diff --git a/docs/source/example.rst b/docs/source/example.rst
@@ -1,6 +1,6 @@
 .. _examples:
 
-Quick Start & Examples
+Examples
 =======================
 
 

diff --git a/requirements.txt b/requirements.txt
@@ -1,4 +1,6 @@
 numpy
 spacy
+pynvml
+
 torch>=1.7.1
 torchvision>=0.8.2