跳转至

MindStudio msOpGen 开发环境搭建和UT方法


1. 预备知识

进行 msOpGen 开发前,需了解以下基础知识:

  • Python 项目结构:msOpGen 是基于 Python 的命令行工具,源码位于 msopgen/ 目录,使用 setuptools 构建 whl 包。
  • 工具组成:msOpGen 负责算子工程生成(msopgen gen)和仿真流水图解析(msopgen sim);msOpST 负责 ST 测试用例生成与执行(msopst create/run)。
  • 详细的架构设计和模块划分请参考《msOpGen架构设计文档》

2. 开发环境准备

请按照以下文档进行环境配置:《算子工具开发环境安装指导》

3. 一键式构建

python build.py

生成的 whl 包位于 output/ 目录,包含 mindstudio_opgenmindstudio_opst 两个包。

4. 项目目录结构

├── msopgen/          // msopgen 源码目录(核心引擎)
├── tools/msopst/     // msopst 源码目录(ST 测试工具)
├── test/
│   ├── msopgen/      // msopgen 单元测试
│   └── msopst/       // msopst 单元测试
├── example/          // 工具样例
├── docs/             // 项目文档
├── setup.py          // msopgen whl 包构建脚本
├── build.py          // 构建入口脚本
└── requirements.txt  // Python 依赖库

5. UT 测试

python build.py test

5.1 测试覆盖范围

UT 测试覆盖以下核心功能: - 算子工程模板生成(msopgen gen) - 仿真流水图解析(msopgen sim) - ST 测试用例生成(msopst create) - ST 测试用例执行(msopst run

6. 代码规范

  • 新增功能需同步编写 UT 测试用例
  • 公共函数和类需添加 docstring 文档字符串