已关闭
[Requirement|需求建议] 完善QUICKSTART快速入门文档 #707
ayuemoon创建于  8月5日关闭于  8月6日
ayuemoon
ayuemoon
8月5日 创建

Backgroud(背景信息)

QUICKSTART.md 快速入门文档需要进一步完善,包括标题格式统一、编译命令参数修正、性能采集命令更新、预期输出描述完善等改进。

Origin(信息来源)

PR #1235 自动分析

Benefit / Necessity(价值/作用)

  1. 统一文档标题格式(### 1. xxx),提升阅读体验
  2. 增加环境变量设置说明,帮助用户避免编译失败
  3. 修正编译命令中硬编码的 --soc 参数为变量形式,增强通用性
  4. 更新 msprof 命令为 msprof op,与最新工具版本保持一致
  5. 完善预期输出描述,帮助用户正确判断运行结果

Design(设计方案)

对 docs/QUICKSTART.md 进行以下改进:

  • 标题格式:去除编号后的空格(### 1. xxx → ### 1.xxx)
  • 编译步骤:增加 set_env.sh 环境变量说明
  • 命令参数:ascend910b → ,增加变量格式说明
  • 性能采集:msprof → msprof op,更新输出文件路径描述
  • 输出描述:增加随机种子说明,完善乘法验证输出描述
likedislike
ayuemoon
ayuemoon
8月5日 评论:

/assign

likedislike
CANN-robotCANN-robot成员
8月5日 将 ayuemoon 设为负责人
CANN-robotCANN-robot成员
8月6日 关闭了 issue
CANN-robotCANN-robot成员
8月6日 添加了label:resolved