Keras2Circom 使用指南

Keras2Circom 是一个将 TensorFlow Keras 模型转换成 Circom 电路的Python工具，旨在支持零知识证明（Zero-Knowledge Proofs, ZKP）在机器学习模型验证场景中的应用，特别是在区块链环境下的隐私保护和计算效率优化。

1. 项目目录结构及介绍

以下是 Keras2Circom 的典型项目结构，说明了其主要组件和功能：

├── keras2circom            # 主项目根目录
│   ├── main.py             # 项目的主入口脚本，用于模型到Circom电路的转换操作。
│   ├── environment.yml     # Conda 环境配置文件，用于设置项目运行所需环境。
│   ├── requirements.txt    # Python依赖库列表，用于pip安装项目运行所需的Python包。
│   ├── setup-circom.sh      # 脚本文件，帮助安装Circom和其他相关工具链。
│   ├── tests                # 测试文件夹，存放测试案例。
│   └── models               # 示例模型文件夹，可能包含示例Keras模型。
│
├── README.md               # 项目说明文档，包含基本介绍和快速入门指南。
└── LICENSE                 # 许可证文件，说明软件使用的授权方式（MIT许可证）。

• main.py: 核心脚本，负责接收命令行参数，调用模型转译逻辑。
• environment.yml: 配置文件，定义了一个Conda环境的所有依赖项，便于快速搭建开发或运行环境。
• requirements.txt: 定义了所有通过pip安装的Python依赖。
• setup-circom.sh: 提供了自动安装Circom编译器及其必要工具的简便方法。
• tests 和 models: 分别是测试代码和可能提供的预训练模型样例。

2. 项目的启动文件介绍

• 文件名: main.py
• 作用: 这个脚本是程序的主要执行入口，它实现了以下功能：
  • 解析命令行参数，包括输入模型路径、输出目录、是否输出原始模型结果而非最大值输出等。
  • 调用circomlib-ml相关功能来转译Keras模型为Circom电路。

使用示例:

python main.py models/model.h5 -o output_directory --raw

该命令会将位于models/model.h5的Keras模型转译为Circom电路，并将结果保存在指定的输出目录下，同时输出模型的原始输出而不是经过处理的最大值。

3. 项目的配置文件介绍

3.1 环境配置 - environment.yml

这个文件不是传统意义上的“配置文件”，而是专为Conda设计的环境配置文件，用来定义一个完整的软件环境，包括Python版本和所有的第三方依赖。通过运行以下命令创建并激活环境：

conda env create -f environment.yml

3.2 Python依赖配置 - requirements.txt

与environment.yml相辅相成，但用于pip管理的环境。当不使用Conda时，可以通过下面的命令直接安装所有必需的Python库：

pip install -r requirements.txt

此文档提供了快速上手Keras2Circom的指导，确保用户能够顺利搭建环境并执行模型转换任务。