Sfl

<div align="center"> <img src="docs/_static/logo-light.png"> </div>

---

<p align="center"> <a href="./README.zh-CN.md">简体中文</a>｜<a href="./README.md">English</a> </p>

SecretFlow is a unified framework for privacy-preserving data intelligence and machine learning. To achieve this goal, it provides:

• An abstract device layer consists of plain devices and secret devices which encapsulate various cryptographic protocols.
• A device flow layer modeling higher algorithms as device object flow and DAG.
• An algorithm layer to do data analysis and machine learning with horizontal or vertical partitioned data.
• A workflow layer that seamlessly integrates data processing, model training, and hyperparameter tuning.

<div align="center"> <img src="docs/_static/secretflow_arch.svg"> </div>

Documentation

• SecretFlow
  • Getting Started
  • User Guide
  • API Reference
  • Tutorial

SecretFlow Related Projects

• Kuscia: A lightweight privacy-preserving computing task orchestration framework based on K3s.
• SCQL: A system that allows multiple distrusting parties to run joint analysis without revealing their private data.
• SPU: A provable, measurable secure computation device, which provides computation ability while keeping your private data protected.
• HEU: A high-performance homomorphic encryption algorithm library.
• YACL: A C++ library that contains cryptography, network and io modules which other SecretFlow code depends on.

Install

Please check INSTALLATION.md

Deployment

Please check DEPLOYMENT.md

Learn PETs

We also provide a curated list of papers and SecretFlow's tutorials on Privacy-Enhancing Technologies (PETs).

Please check AWESOME-PETS.md

Contributing

• Contributor Rewards: Thank you for contributing to SecretFlow! All contributors will receive: A SecretFlow Open Source Contributor Certificate & An exclusive SecretFlow T-shirt 📌 Apply Now

Good First Issues

We have a list of good first issues. This is a great place for newcomers and beginners alike to get started, gain experience, and get familiar with our contribution process.

Contribution Map

We also welcome community collaboration on more advanced initiatives! Whether you're refining features, optimizing workflows, or proposing new ideas – there are opportunities for contributors of all skill levels to shape SecretFlow's future.

Benchmarks

Please check OVERALL_BENCHMARK.md

Disclaimer

Non-release versions of SecretFlow are prohibited from using in any production environment due to possible bugs, glitches, lack of functionality, security issues or other problems.