Merge pull request #5431 from FederatedAI/feature-2.0-rc-dy

readme fix & add launcher run.sh

README.md

@@ -9,7 +9,6 @@
   <img src="./doc/images/FATE_logo.png">
 </div>
 
-[DOCS](./doc) | [中文](./README_zh.md)
 
 FATE (Federated AI Technology Enabler) is the world's first industrial grade federated learning open source framework to enable enterprises and institutions to collaborate on data while protecting data security and privacy. 
 It implements secure computation protocols based on homomorphic encryption and multi-party computation (MPC). 
@@ -36,8 +35,23 @@ Deploying FATE to multiple nodes to achieve scalability, reliability and managea
 - [Cluster deployment by CLI](./deploy/cluster-deploy): Using CLI to deploy a FATE cluster.
 
 ### Quick Start
-- [Training Demo With Installing FATE AND FATE-Flow From Pypi](doc/2.0/fate/quick_start.md)
 - [Training Demo With Installing FATE Only From Pypi](doc/2.0/fate/ml)
+- [Training Demo With Installing FATE AND FATE-Flow From Pypi](doc/2.0/fate/quick_start.md)
+
+### More examples
+- [ML examples](examples/launchers)
+- [PipeLine examples](examples/pipeline)
+
+## Documentation
+
+### FATE Design
+- [Architecture](./doc/architecture/README.md): Building Unified and Standardized API for Heterogeneous Computing Engines Interconnection
+- [FATE Algorithm Components](./doc/2.0/fate/components/README.md): Building Standardized Algorithm Components for different Scheduling Engines
+- [OSX (Open Site Exchange)](./doc/2.0/osx/osx.md): Building Open Platform for Cross-Site Communication Interconnection
+- [FATE-Flow](https://github.com/FederatedAI/FATE-Flow/blob/main/doc/fate_flow.md): Building Open and Standardized Scheduling Platform for Scheduling Interconnection 
+- [PipeLine Design](https://github.com/FederatedAI/FATE-Client/blob/main/doc/pipeline.md): Building Scalable Federated DSL for Application Layer Interconnection And Providing Tools For Fast Federated Modeling
+- [RoadMap](./doc/images/roadmap.png)
+- [Paper & Conference](./doc/resources/README.md)
 
 ## Related Repositories (Projects)
 - [KubeFATE](https://github.com/FederatedAI/KubeFATE): An operational tool for the FATE platform using cloud native technologies such as containers and Kubernetes.

doc/architecture/README.md

@@ -0,0 +1,18 @@
+### FATE InterOp Goal
+![](../images/interop_goal.png)
+
+### FATE InterOp Principles
+![](../images/interop-principles.png)
+
+###  FATE Overall Architecture
+
+![](../images/fate_arch.png)
+
+###  FATE Core Architecture
+![](../images/fate-core-arch.png)
+
+
+
+
+
+

doc/resources/README.md

@@ -0,0 +1,25 @@
+# Materials
+
+[中文](./README.zh.md)
+
+## Speech and Conference
+
+- [2021. Professor Yang's Seminar Presentation: An Introducton to Federated Learning (2021)](杨强教授：2021联邦学习专题研讨会.pdf)
+- [2019. SecureBoost-ijcai2019-workshop](SecureBoost-ijcai2019-workshop.pdf)
+- [2019. GDPR_Data_Shortage_and_AI-AAAI_2019_PPT](GDPR_Data_Shortage_and_AI-AAAI_2019_PPT.pdf)
+
+
+## Paper
+1. Yang Q, Liu Y, Chen T, et al. Federated machine learning: Concept and applications[J]. ACM Transactions on Intelligent Systems and Technology (TIST), 2019, 10(2): 1-19.
+2. Liu Y, Fan T, Chen T, et al. FATE: An industrial grade platform for collaborative learning with data protection[J]. Journal of Machine Learning Research, 2021, 22(226): 1-6
+3. Cheng K, Fan T, Jin Y, et al. Secureboost: A lossless federated learning framework[J]. IEEE Intelligent Systems, 2021.
+4. Chen W, Ma G, Fan T, et al. SecureBoost+: A High Performance Gradient Boosting Tree Framework for Large Scale Vertical Federated Learning[J]. arXiv preprint arXiv:2110.10927, 2021.
+5. Zhang Q, Wang C, Wu H, et al. GELU-Net: A Globally Encrypted, Locally Unencrypted Deep Neural Network for Privacy-Preserved Learning[C]//IJCAI. 2018: 3933-3939.
+6. Zhang Y, Zhu H. Additively Homomorphical Encryption based Deep Neural Network for Asymmetrically Collaborative Machine Learning[J]. arXiv preprint arXiv:2007.06849, 2020.
+7. Yang K, Fan T, Chen T, et al. A quasi-newton method based vertical federated learning framework for logistic regression[J]. arXiv preprint arXiv:1912.00513, 2019.
+8. Hardy S, Henecka W, Ivey-Law H, et al. Private federated learning on vertically partitioned data via entity resolution and additively homomorphic encryption[J]. arXiv preprint arXiv:1711.10677, 2017.
+9. Chen C, Zhou J, Wang L, et al. When homomorphic encryption marries secret sharing: Secure large-scale sparse logistic regression and applications in risk control[C]//Proceedings of the 27th ACM SIGKDD Conference on Knowledge Discovery & Data Mining. 2021: 2652-2662.
+10. Gu H, Luo J, Kang Y, et al. FedPass: Privacy-Preserving Vertical Federated Deep Learning with Adaptive Obfuscation[J]. arXiv preprint arXiv:2301.12623, 2023.
+
+
+

doc/resources/README.zh.md

@@ -0,0 +1,25 @@
+# 资料
+
+[English](./README.md)
+
+## 演讲 & 会议
+- [2021. 杨强教授：2021联邦学习专题研讨会](杨强教授：2021联邦学习专题研讨会.pdf)
+- [2019. SecureBoost-ijcai2019-workshop](SecureBoost-ijcai2019-workshop.pdf)
+- [2019. GDPR_Data_Shortage_and_AI-AAAI_2019_PPT](GDPR_Data_Shortage_and_AI-AAAI_2019_PPT.pdf)
+
+## 论文
+1. Yang Q, Liu Y, Chen T, et al. Federated machine learning: Concept and applications[J]. ACM Transactions on Intelligent Systems and Technology (TIST), 2019, 10(2): 1-19.
+2. Liu Y, Fan T, Chen T, et al. FATE: An industrial grade platform for collaborative learning with data protection[J]. Journal of Machine Learning Research, 2021, 22(226): 1-6
+3. Cheng K, Fan T, Jin Y, et al. Secureboost: A lossless federated learning framework[J]. IEEE Intelligent Systems, 2021.
+4. Chen W, Ma G, Fan T, et al. SecureBoost+: A High Performance Gradient Boosting Tree Framework for Large Scale Vertical Federated Learning[J]. arXiv preprint arXiv:2110.10927, 2021.
+5. Zhang Q, Wang C, Wu H, et al. GELU-Net: A Globally Encrypted, Locally Unencrypted Deep Neural Network for Privacy-Preserved Learning[C]//IJCAI. 2018: 3933-3939.
+6. Zhang Y, Zhu H. Additively Homomorphical Encryption based Deep Neural Network for Asymmetrically Collaborative Machine Learning[J]. arXiv preprint arXiv:2007.06849, 2020.
+7. Yang K, Fan T, Chen T, et al. A quasi-newton method based vertical federated learning framework for logistic regression[J]. arXiv preprint arXiv:1912.00513, 2019.
+8. Hardy S, Henecka W, Ivey-Law H, et al. Private federated learning on vertically partitioned data via entity resolution and additively homomorphic encryption[J]. arXiv preprint arXiv:1711.10677, 2017.
+9. Chen C, Zhou J, Wang L, et al. When homomorphic encryption marries secret sharing: Secure large-scale sparse logistic regression and applications in risk control[C]//Proceedings of the 27th ACM SIGKDD Conference on Knowledge Discovery & Data Mining. 2021: 2652-2662.
+10. Gu H, Luo J, Kang Y, et al. FedPass: Privacy-Preserving Vertical Federated Deep Learning with Adaptive Obfuscation[J]. arXiv preprint arXiv:2301.12623, 2023.
+
+
+
+
+

examples/launchers/run.sh

@@ -0,0 +1,9 @@
+# examples; you can adjust it if you need.
+
+python sshe_lr_launcher.py --parties guest:9999 host:10000 --log_level INFO --guest_data ./breast_hetero_guest.csv --host_data ./breast_hetero_host.csv
+
+python secureboost_launcher.py --parties guest:9999 host:10000 --log_level INFO
+
+python sshe_nn_launcher.py --parties guest:9999 host:10000 --log_level INFO
+
+python fedpass_nn_launcher.py --parties guest:9999 host:10000 --log_level INFO