diff --git a/README.md b/README.md index b5bf0d34486052ae479a47c3c34b31ce73d31bb2..f850402c3deecca5d330609a6d28d5bc19bd2622 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ -[DOC](https://paddlefl.readthedocs.io/en/latest/) | [Quick Start](https://paddlefl.readthedocs.io/en/latest/instruction.html) | [中文](./README_cn.md) +[DOC](https://paddlefl.readthedocs.io/en/latest/) | [Quick Start](https://paddlefl.readthedocs.io/en/latest/compile_and_intall.html) | [中文](./README_cn.md) PaddleFL is an open source federated learning framework based on PaddlePaddle. Researchers can easily replicate and compare different federated learning algorithms with PaddleFL. Developers can also benefit from PaddleFL in that it is easy to deploy a federated learning system in large scale distributed clusters. In PaddleFL, serveral federated learning strategies will be provided with application in computer vision, natural language processing, recommendation and so on. Application of traditional machine learning training strategies such as Multi-task learning, Transfer Learning in Federated Learning settings will be provided. Based on PaddlePaddle's large scale distributed training and elastic scheduling of training job on Kubernetes, PaddleFL can be easily deployed based on full-stack open sourced software. @@ -42,7 +42,7 @@ We **highly recommend** to run PaddleFL in Docker ```sh #Pull and run the docker docker pull hub.baidubce.com/paddlefl/paddle_fl:latest -docker run --name --net=host -it -v $PWD:/root /bin/bash +docker run --name --net=host -it -v $PWD:/paddle /bin/bash #Install paddle_fl pip install paddle_fl diff --git a/README_cn.md b/README_cn.md index 51d0f7ecd71b66fc47916b5ddc1cd696090d162a..f4479d3d28b900f6d694cbeef48cdeee792bfdb3 100644 --- a/README_cn.md +++ b/README_cn.md @@ -39,7 +39,7 @@ PaddleFL 中主要提供两种解决方案：**Data Parallel** 以及 **Federate ```sh #Pull and run the docker docker pull hub.baidubce.com/paddlefl/paddle_fl:latest -docker run --name --net=host -it -v $PWD:/root /bin/bash +docker run --name --net=host -it -v $PWD:/paddle /bin/bash #Install paddle_fl pip install paddle_fl diff --git a/docs/source/_static/FL-framework.png b/docs/source/_static/FL-framework.png index 1cb16f37d00e100aaeb5b62f558e7434f6007571..b2c228e1948c13508fc8433cbc48a6d4d62aa59f 100644 Binary files a/docs/source/_static/FL-framework.png and b/docs/source/_static/FL-framework.png differ diff --git a/docs/source/_static/PFM-design.png b/docs/source/_static/PFM-design.png new file mode 100644 index 0000000000000000000000000000000000000000..cdf823045d2c8017fe43f3d99c0d657efda6ee75 Binary files /dev/null and b/docs/source/_static/PFM-design.png differ diff --git a/docs/source/_static/PFM-overview.png b/docs/source/_static/PFM-overview.png new file mode 100644 index 0000000000000000000000000000000000000000..59ff85861fa13f5598e661823902db3fb04bb2bb Binary files /dev/null and b/docs/source/_static/PFM-overview.png differ diff --git a/docs/source/_static/fl_benchmark.png b/docs/source/_static/fl_benchmark.png new file mode 100644 index 0000000000000000000000000000000000000000..49821627187f4966678ef2d0736e22a4b3324a10 Binary files /dev/null and b/docs/source/_static/fl_benchmark.png differ diff --git a/docs/source/_static/fl_dpsgd_benchmark.png b/docs/source/_static/fl_dpsgd_benchmark.png new file mode 100644 index 0000000000000000000000000000000000000000..6e95d5bfd030dcb10c4c7f8ed952983cf91415f3 Binary files /dev/null and b/docs/source/_static/fl_dpsgd_benchmark.png differ diff --git a/docs/source/examples/md/dpsgd-example.md b/docs/source/examples/md/dpsgd-example.md index 5fc95639b8ac3c29d0772b7ed46daeda60a3f9d1..1397acf3968bf6a9c18933c77c22c3289fa095c3 100644 --- a/docs/source/examples/md/dpsgd-example.md +++ b/docs/source/examples/md/dpsgd-example.md @@ -213,4 +213,4 @@ while not trainer.stop(): To show the effectiveness of DPSGD-based federated learning with PaddleFL, a simulated experiment is conducted on an open source dataset MNIST. From the figure given below, model evaluation results are similar between DPSGD-based federated learning and traditional parameter server training when the overall privacy budget *epsilon* is 1.3 or 0.13. -
+
diff --git a/docs/source/examples/md/gru4rec_examples.md b/docs/source/examples/md/gru4rec_examples.md index 97178aed1c9aae6663c2ce9b1af54f9975994b05..4b49bc408a59870dc1fdd08860441e3088e96f7f 100644 --- a/docs/source/examples/md/gru4rec_examples.md +++ b/docs/source/examples/md/gru4rec_examples.md @@ -109,4 +109,4 @@ wget https://paddle-zwh.bj.bcebos.com/gru4rec_paddlefl_benchmark/gru4rec_benchma | 1/4 of the whole dataset | private training | - | 0.269 | | 1/4 of the whole dataset | private training | - | 0.282 | -
+
diff --git a/docs/source/examples/md/uci_demo.md b/docs/source/examples/md/uci_demo.md index 4fd5d3a7a9254ab1652fe558855d5b4480222388..ccd2b9b826213cab383b264eb700f516cc4d6f48 100644 --- a/docs/source/examples/md/uci_demo.md +++ b/docs/source/examples/md/uci_demo.md @@ -1,7 +1,5 @@ ## Instructions for PaddleFL-MPC UCI Housing Demo -([简体中文](./README_CN.md)|English) - This document introduces how to run UCI Housing demo based on Paddle-MPC, which has two ways of running, i.e., single machine and multi machines. ### 1. Running on Single Machine diff --git a/docs/source/md/introduction.md b/docs/source/md/introduction.md index e283ccd1465b447349ef2387d06586ccc31e3969..8822e48f0179b4b24da0776455778c8ac05a2b86 100644 --- a/docs/source/md/introduction.md +++ b/docs/source/md/introduction.md @@ -8,7 +8,8 @@ Data is becoming more and more expensive nowadays, and sharing of raw data is ve ## Overview of PaddleFL - + + In PaddleFL, horizontal and vertical federated learning strategies will be implemented according to the categorization given in [4]. Application demonstrations in natural language processing, computer vision and recommendation will be provided in PaddleFL. @@ -36,7 +37,7 @@ Besides, PFM is implemented based on secure multi-party computation (MPC) to ena ### Data Parallel - + In Data Parallel, components for defining a federated learning task and training a federated learning job are as follows: @@ -60,7 +61,7 @@ In Data Parallel, components for defining a federated learning task and training ### Federated Learning with MPC - + Paddle FL MPC implements secure training and inference tasks based on the underlying MPC protocol like ABY3[11], which is a high efficient three-party computing model.