pyhpc-benchmarks 项目使用教程

1. 项目目录结构及介绍

pyhpc-benchmarks/
├── benchmarks/
│   ├── <benchmark_folder1>/
│   ├── <benchmark_folder2>/
│   └── ...
├── results/
│   ├── <result_file1>.md
│   ├── <result_file2>.md
│   └── ...
├── backends/
│   ├── <backend_file1>.py
│   ├── <backend_file2>.py
│   └── ...
├── environment-cpu.yml
├── environment-gpu.yml
├── run.py
├── plot.py
├── utilities.py
├── README.md
├── LICENSE
└── ...

目录结构介绍

• benchmarks/: 包含各种基准测试的文件夹，每个文件夹对应一个特定的基准测试。
• results/: 包含基准测试结果的文件，通常是 Markdown 格式。
• backends/: 包含不同计算后端的实现文件。
• environment-cpu.yml: CPU 环境的 Conda 配置文件。
• environment-gpu.yml: GPU 环境的 Conda 配置文件。
• run.py: 项目的启动文件，用于运行基准测试。
• plot.py: 用于绘制基准测试结果的脚本。
• utilities.py: 包含项目中使用的各种实用工具函数。
• README.md: 项目的主文档，包含项目的介绍、安装、使用说明等。
• LICENSE: 项目的开源许可证文件。

2. 项目的启动文件介绍

run.py

run.py 是项目的启动文件，用于运行基准测试。它支持多种选项来配置测试的参数，如数组大小、后端选择、设备类型等。

使用示例

python run.py --help

主要选项

• -s, --size: 指定数组大小，可以重复使用以测试多个大小。
• -b, --backend: 指定要使用的后端，可以重复使用以测试多个后端。
• -r, --repetitions: 指定每个大小和后端的迭代次数。
• --burnin: 指定初始迭代次数，这些迭代结果不计入最终统计。
• --device: 指定运行基准测试的设备类型（CPU、GPU、TPU）。

3. 项目的配置文件介绍

environment-cpu.yml 和 environment-gpu.yml

这两个文件是 Conda 环境的配置文件，分别用于配置 CPU 和 GPU 环境。它们列出了项目所需的依赖包及其版本。

使用示例

# 创建 CPU 环境
conda env create -f environment-cpu.yml
conda activate pyhpc-bench-cpu

# 创建 GPU 环境
conda env create -f environment-gpu.yml
conda activate pyhpc-bench-gpu

配置文件内容示例

name: pyhpc-bench-cpu
channels:
  - conda-forge
dependencies:
  - python=3.8
  - numpy
  - numba
  - jax
  - tensorflow
  - pytorch
  - cupy
  - taichi
  - ...

通过这些配置文件，用户可以轻松创建适合项目的开发环境，确保所有依赖项都正确安装。