Bellperson 项目使用教程

1. 项目目录结构及介绍

Bellperson 项目的目录结构如下：

bellperson/
├── .github/
│   └── workflows/
├── src/
├── tests/
├── verifier-bench/
├── .gitignore
├── COPYRIGHT
├── Cargo.toml
├── LICENSE-APACHE
├── LICENSE-MIT
├── README.md
├── README_AMD.md
├── SECURITY.md
├── build.rs
├── rust-toolchain

目录结构介绍

• .github/workflows: 包含 GitHub Actions 的工作流配置文件。
• src: 项目的源代码目录，包含主要的 Rust 代码文件。
• tests: 包含项目的测试代码。
• verifier-bench: 包含验证器的基准测试代码。
• .gitignore: Git 忽略文件配置。
• COPYRIGHT: 版权声明文件。
• Cargo.toml: Rust 项目的依赖和元数据配置文件。
• LICENSE-APACHE: Apache 许可证文件。
• LICENSE-MIT: MIT 许可证文件。
• README.md: 项目的主 README 文件，包含项目的基本介绍和使用说明。
• README_AMD.md: 针对 AMD GPU 的 README 文件。
• SECURITY.md: 项目的安全性说明文件。
• build.rs: Rust 项目的构建脚本。
• rust-toolchain: Rust 工具链配置文件。

2. 项目启动文件介绍

Bellperson 项目的主要启动文件是 src/lib.rs，该文件是项目的入口点，包含了项目的核心逻辑和模块的初始化代码。

src/lib.rs 文件介绍

• 模块导入: 导入了项目所需的各种模块和依赖。
• 函数和结构体定义: 定义了项目中使用的各种函数和结构体。
• 初始化逻辑: 包含了项目的初始化逻辑，如 GPU 加速的初始化等。

3. 项目的配置文件介绍

Bellperson 项目的主要配置文件是 Cargo.toml，该文件包含了项目的依赖、构建配置和其他元数据。

Cargo.toml 文件介绍

• 依赖管理: 列出了项目所需的所有依赖包及其版本。
• 构建配置: 定义了项目的构建配置，如编译选项、构建脚本等。
• 元数据: 包含了项目的名称、版本、作者等基本信息。

环境变量配置

Bellperson 项目还支持通过环境变量进行配置，以下是一些常用的环境变量：

• BELLMAN_NO_GPU: 禁用 GPU 功能，强制使用 CPU。
• BELLMAN_VERIFIER: 选择批量验证器运行的设备，可以是 cpu、gpu 或 auto。
• RUST_GPU_TOOLS_CUSTOM_GPU: 允许添加不在测试列表中的 GPU，需要指定 GPU 名称和核心数。
• BELLMAN_CPU_UTILIZATION: 设置多重指数计算中 CPU 的使用比例。
• RAYON_NUM_THREADS: 限制库中使用的线程数。
• EC_GPU_NUM_THREADS: 限制 FFT 和多重指数计算中使用的线程数。
• BELLMAN_GPU_FRAMEWORK: 设置 GPU 框架，可以是 cuda 或 opencl。
• BELLMAN_CUDA_NVCC_ARGS: 自定义 CUDA 内核的编译参数。
• BELLPERSON_GPUS_PER_LOCK: 限制 FFT 和多重指数计算中使用的设备数。

通过这些配置文件和环境变量，用户可以根据自己的需求定制 Bellperson 项目的运行环境。