https://github.com/YanshiShield/YanshiShield

https://github.com/YanshiShield/YanshiShield

Last synced: 3 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/YanshiShield/YanshiShield
• Owner: YanshiShield
• License: apache-2.0
• Created: 2022-04-29T01:59:29.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-07-30T03:04:05.000Z (3 months ago)
• Last Synced: 2024-07-30T09:39:13.410Z (3 months ago)
• Language: Python
• Size: 6.34 MB
• Stars: 24
• Watchers: 1
• Forks: 11
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

• FLsystem-paper - `Github`

README

        
# YanshiShield

[![logo](https://avatars.githubusercontent.com/u/104555770?s=200&v=4)

[![license](https://img.shields.io/github/license/ChengMingZhang-ZTE/federated-learning)](https://opensource.org/licenses/Apache-2.0)[![Neursafe_FL_C](https://github.com/neursafe/federated-learning/actions/workflows/ci.yml/badge.svg)](https://github.com/neursafe/federated-learning/actions/workflows/ci.yml)[![Build docker images](https://github.com/neursafe/federated-learning/actions/workflows/build_image.yml/badge.svg)](https://github.com/neursafe/federated-learning/actions/workflows/build_image.yml)[![Build wheel packages](https://github.com/neursafe/federated-learning/actions/workflows/build_whl.yml/badge.svg)](https://github.com/neursafe/federated-learning/actions/workflows/build_whl.yml)

[中文](README_zh.md)

**YanshiShield** is an open source community and software development product that focuses on AI Security and Safety and provides federated learning solutions. Its objective is to boost the security and safety of AI systems in the fields of AI security detection and evaluation, AI security reinforcement, AI fairness detection and evaluation, AI fairness improvement, and AI interpretation. It can be uesed for computer software consultancy, research in the field of artificial intelligence and telecommunication network security consulting. Federated learning is a privacy preserving machine learning method that utilizes a large number of decentralized data remaining on client devices collaborates to complete the training of machine learning models. The goal of YanshiShield is to create a reliable, efficient, easy-to-use federated learning and federated computing platform under the premise of privacy and security. YanshiShield features the following:

* Use cryptographic algorithms such as differential privacy, multi-party secure computing (MPC) and homomorphic encryption to ensure privacy and the security of intermediate data.

* Provide a variety of federated aggregation algorithms to ensure the convergence and convergence efficiency of the model under different data distributions.

* Provide a low-cost migration solution from existing machine learning to federation, currently supports Pytorch, Tensorflow/Keras

## Getting Started

### Build

The source code can be downloaded through the green "<>Code" button on.

[![Download](https://img.shields.io/badge/%3C%3E%20Code-blue)](https://github.com/YanshiShield/YanshiShield-FL/archive/refs/heads/main.zip)

YanshiShield support two installation modes, the minimal installation mode of standalone and cluster mode based on Kubernetes, as follow:

- standalone mode:  In this mode, only federated training of a single job can be performed. During the training process, only the coordinator and clients of the job are required to participate, which is suitable for scenarios where you can quickly experience YanshiShield or locally verify the correctness of the federated learning code.

- cluster mode: There are complete functions and features of YanshiShield, such as job management and scheduling, client management and selection, etc.

System components in standalone mode support running as processes  or containers, while all components in cluster mode must run as containers. Please refer to the [Build](docs/build.md) document to select the correct build mode and required  YanshiShield components.

### Install

See the [install](./docs/install.md)  documentation for YanshiShield installation. YanshiShield support install as standalone mode or cluster mode.

### Quick Start

See the [quick start](./docs/quick_start.md) documentation to learn how to use YanshiShield for federated training, using standalone deployment mode in this example.

## Design and Interface

### Design

- [architecutrue](./docs/architecture.md)

### Algorithms

- [secure](./docs/algorithms/secure_algos.md)

- [aggregation](./docs/algorithms/aggregation_algos.md)

### Interface

- [Developer guide](./docs/develop.md)

## Contributing

We welcome all kinds of contributions, please refer to the [CONTRIBUTING](CONTRIBUTING.md) to get started.