---

简体中文｜English

SecretFlow 是一个用于隐私保护数据智能与机器学习的统一框架。为实现这一目标，它提供了：

• 一个抽象的设备层，由普通设备和秘密设备组成，封装了多种密码学协议；
• 一个设备流层，将高级算法建模为设备对象流和有向无环图（DAG）；
• 一个算法层，用于处理水平或垂直划分的数据进行数据分析和机器学习；
• 一个工作流层，可无缝集成数据处理、模型训练和超参数调优。

文档

• SecretFlow
  • 入门指南
  • 用户手册
  • API 参考
  • 教程

SecretFlow 相关项目

• Kuscia：基于 K3s 的轻量级隐私保护计算任务编排框架。
• SCQL：允许多个互不信任的参与方在不泄露各自隐私数据的情况下进行联合分析的系统。
• SPU：一种可证明、可度量的安全计算设备，在保护用户隐私数据的同时提供计算能力。
• HEU：高性能同态加密算法库。
• YACL：包含密码学、网络和 I/O 模块的 C++ 库，SecretFlow 的其他代码均依赖于此。

安装

请参阅 INSTALLATION.md

部署

请参阅 DEPLOYMENT.md

学习隐私增强技术（PETs）

我们还提供了一份精心整理的论文列表以及 SecretFlow 关于隐私增强技术（PETs）的教程。

请参阅 AWESOME-PETS.md

贡献

• 贡献者奖励：感谢您对 SecretFlow 的贡献！所有贡献者都将获得：SecretFlow 开源贡献者证书及专属 SecretFlow T 恤 📌 立即申请

初次贡献的好机会

我们准备了一份[初次贡献的好机会]列表（https://github.com/orgs/secretflow/projects/12/）。这对于新手和初学者来说都是一个很好的起点，可以帮助大家积累经验并熟悉我们的贡献流程。

贡献地图

我们也欢迎社区成员参与到[更高级别的项目]中来（https://github.com/orgs/secretflow/projects/11/）！无论您是完善功能、优化流程，还是提出新想法，各个技能水平的贡献者都有机会共同塑造 SecretFlow 的未来。

基准测试

请参阅 OVERALL_BENCHMARK.md

免责声明

由于可能存在 bug、故障、功能缺失、安全问题或其他隐患，SecretFlow 的非正式发布版本严禁用于任何生产环境。

SecretFlow 快速上手指南

SecretFlow 是一个统一的隐私保护数据智能与机器学习框架，支持在水平或垂直分割的数据上进行安全计算和模型训练。

1. 环境准备

在开始之前，请确保您的开发环境满足以下要求：

• 操作系统：Linux (推荐 Ubuntu 20.04/22.04) 或 macOS。Windows 用户建议使用 WSL2。
• Python 版本：3.8 - 3.10。
• 前置依赖：
  • pip (包管理工具)
  • git (用于克隆代码库，可选)
  • 编译工具链 (如 build-essential, cmake)，用于安装底层密码学库。

注意：生产环境请勿使用非发布版本（Non-release versions），以免遇到安全性或稳定性问题。

2. 安装步骤

推荐使用 Python 包管理器直接安装最新稳定版。国内开发者若遇到网络延迟，可配置国内镜像源加速。

方式一：使用 pip 安装（推荐）

# 使用阿里云镜像源加速安装
pip install secretflow -i https://mirrors.aliyun.com/pypi/simple/

方式二：从源码安装（适用于开发者）

如果您需要贡献代码或使用最新特性：

git clone https://github.com/secretflow/secretflow.git
cd secretflow
pip install -e . -i https://mirrors.aliyun.com/pypi/simple/

详细的环境依赖和编译说明请参考官方文档：INSTALLATION.md

3. 基本使用

SecretFlow 的核心概念是“设备（Device）”。以下示例展示如何初始化一个本地模拟集群，并在不同设备间进行简单的安全计算。

最小化示例：安全加法

此示例演示了如何创建两个参与方（Alice 和 Bob），将数据秘密分享，并在密文状态下完成加法运算。

import secretflow as sf

# 1. 初始化环境
sf.init(['alice', 'bob'], address='local')

# 2. 定义设备
alice = sf.PYU('alice')
bob = sf.PYU('bob')

# 3. 准备数据 (分别在 Alice 和 Bob 的设备上创建数据)
def get_data_alice():
    return [1, 2, 3]

def get_data_bob():
    return [4, 5, 6]

data_alice = alice(get_data_alice)()
data_bob = bob(get_data_bob)()

# 4. 将数据转换为秘密状态 (Secret)
# 这里使用 SPU 设备作为安全计算后端
spu = sf.SPU(sf.utils.testing.cluster_spec(['alice', 'bob']))
sec_a = spu.secret(data_alice)
sec_b = spu.secret(data_bob)

# 5. 执行安全计算 (密文加法)
result_sec = sec_a + sec_b

# 6. 揭示结果 (仅在需要时由授权方解密)
result = sf.reveal(result_sec)
print("计算结果:", result)

# 7. 关闭环境
sf.shutdown()

下一步学习

• 用户指南：深入了解设备流、算法层及工作流编排 User Guide
• 教程集合：查看针对隐私增强技术 (PETs) 的实战教程 Tutorial
• 相关项目：探索 Kuscia (任务编排)、SCQL (联合分析) 等生态组件。