已合并
docs: QuickStart输出样例改用通用占位符,避免随机数导致的输出差异 #4103
songkai111创建于 28 天前
docs: QuickStart输出样例改用通用占位符,避免随机数导致的输出差异 #4103
已合并
songkai111创建于 28 天前
songkai111成员
28 天前

描述

QuickStart.md 中算子示例的输出样例使用了固定种子随机数产生的具体数值,但不同环境(CANN版本、驱动版本等)下随机数结果可能不一致,导致用户运行示例时输出与文档描述不匹配。将具体数值替换为通用占位符表示形式,并简化输出示例行数。

改动内容

  • 将 Add 示例和 Mul 示例的输出样例从 8 组具体数值简化为 2 组通用占位符格式
  • 更新描述文字:"每次运行结果一致,示例如下(此处展示前8组)" → "输出格式如下"
  • 涉及文件:docs/QUICKSTART.md

关联的Issue

  • #2246

测试

  • 文档预览确认格式正确
  • 文档中所有链接和代码块完整

文档更新

  • docs/QUICKSTART.md

类型标签

  • Bug修复
  • 新特性
  • 性能优化
  • 文档更新
  • 其他,请描述:
likedislike
Pull Request已成功合入, 合并人@CANN-robot
(感谢 songkai111 的贡献)
Ssongkai111成员
28 天前 创建了 pull request,commit 2883728f
atomgit-bot
atomgit-bot
28 天前 评论:

变更摘要

此 PR 主要对 QuickStart 文档中的输出样例进行修订,将原先包含随机数的具体输出示例替换为通用占位符,以避免因随机数变化导致文档输出内容不一致的问题。改动涉及 1 个文件,净减少 14 行,使文档输出更稳定、可复现。

主要改动

  • 输出样例占位符化:将 QuickStart 文档中原有的具体输出示例(包含随机数值)统一替换为 通用占位符,消除因随机数每次不同而导致的输出不一致。
  • 文档内容精简:在替换占位符的同时,合并和删除了冗余的输出展示内容,最终新增 6 行、删除 20 行,使文档更加简洁。
likedislike
atomgit-bot
atomgit-bot
28 天前 评论:

代码审查

经过对 docs/QUICKSTART.md 的全面审查,该变更仅将文档中两处示例输出从具体数值替换为通用占位符((随机值)(Add结果)(Mul结果)),以解决因随机数导致输出不一致的问题。

审查结论:

  • 安全性:未引入任何不安全命令、配置或依赖。
  • 正确性:新占位符准确描述了用户应预期的输出格式;旧版关于"固定种子随机数,每次运行结果一致"的描述已随输出不一致问题一并移除,描述更加诚实。
  • 一致性:所有旧的具体数值引用已彻底清理,无残留。
  • 格式:第一个示例区块的代码围栏(```bash)被移除而第二个保留,存在轻微的不一致,但根据审查规则,这属于纯文档排版问题,不构成安全风险、生产误用或数据破坏,不予报告。

审查总结

文件 审查结果
docs/QUICKSTART.md 无问题
  • P0–P2 问题:0
  • P3 问题:0
  • 整体风险评估:低风险。这是一个纯粹的文档改进,将因随机数不一致的具体数值替换为通用占位符,变更安全且合理。

⚠️ 已识别出整体风险,但无法提取行内评论,请参考整体评估。

likedislike
CANN-robotCANN-robot成员
28 天前 添加了label:cann-cla/yes
songkai111成员
28 天前 评论:

compile

likedislike
CANN-robot
CANN-robot成员
28 天前 评论:

CLA Signature Pass

songkai111, thanks for your pull request. All authors of the commits have signed the CLA. 👍

likedislike
CANN-robot
CANN-robot成员
28 天前 评论:

Thanks for your pull-request.
The full list of commands accepted by me can be found at here
You can get sig-info at here


PR Approval Progress

Congratulations! All modules have met the lgtm and approve requirements.

Module Approval Details

module lgtm status approve status
repo-cann/ops-math zhanw_coding, wangrui_ (2/2) zhanw_coding (1/1)

💡 Tip:

  • Committer can comment /approve or /lgtm
  • Commenting /approve implies both code review (lgtm) and intent to merge (approve)
likedislike
Ssongkai111成员
28 天前 update merge request[project id: 7649531, iid: 4103, commit_id: 8b8cf84e95826d74b990ca55b3592d4cd055efc3] virtual merging success
CANN-robotCANN-robot成员
28 天前 将zhou-qilong,wangrui_,rxtfeng,loov1,zhangzijie,jia0liang,zl_hw,llimwang,gubaocheng,andong_hw,zhanw_coding设为评审人
CANN-robotCANN-robot成员
28 天前 将zhou-qilong,wangrui_,rxtfeng,loov1,zhangzijie,jia0liang,zl_hw,llimwang,gubaocheng,andong_hw,zhanw_coding设为审查人
songkai111成员
28 天前 评论:

compile

likedislike
CANN-robotCANN-robot成员
28 天前 添加了label:ci-pipeline-running
CANN-robotCANN-robot成员
28 天前 删除了label:ci-pipeline-running
CANN-robotCANN-robot成员
28 天前 添加了label:ci-pipeline-running
CANN-robot
CANN-robot成员
28 天前 评论:

流水线任务触发成功
任务链接 [9c7355f675f24580bf447a0019ccb740][流水线指导]

任务名称状态日志下载链接

[2026-07-16 11:15:48]    CI执行结束

likedislike
CANN-robot
CANN-robot成员
28 天前 评论:

流水线任务触发成功
任务链接 [41808554c05b4248b932a84fd743b34c][流水线指导]

任务名称状态日志下载链接
codecheck_Pr ✅ SUCCESS
StaticCheck_codespell ✅ SUCCESS
StaticCheck_link_validity ✅ SUCCESS
StaticCheck_resource_existence ✅ SUCCESS
StaticCheck_tag_closed ✅ SUCCESS
StaticCheck_markdownlint ✅ SUCCESS

[2026-07-16 11:15:52]    CI执行结束

likedislike
CANN-robot
CANN-robot成员
28 天前 评论:

流水线任务触发成功
任务链接 [5b2b4bc4607b4aedbf2b721209ff3ada][流水线指导]

任务名称状态日志下载链接
pre_comment ✅ SUCCESS >>>>>
Compile_Ascend_X86_ubuntu24 ✅ SUCCESS >>>>> >>>>>
Compile_Ascend_X86_mobile_station_ubuntu24 ✅ SUCCESS >>>>> >>>>>
Compile_Ascend_X86_experimental_ubuntu24 ✅ SUCCESS >>>>> >>>>>
Compile_Ascend_X86_A5_ubuntu24 ✅ SUCCESS >>>>> >>>>>
Compile_harmony-infer ✅ SUCCESS >>>>>
Compile_Ascend_ARM_ubuntu24 ✅ SUCCESS >>>>> >>>>>
Compile_Ascend_ARM_experimental_ubuntu24 ✅ SUCCESS >>>>> >>>>>
Compile_Ascend_single_ubuntu24 ✅ SUCCESS >>>>> >>>>>
Compile_Ascend_ARM_A5_ubuntu24 ✅ SUCCESS >>>>> >>>>>
Compile_X86_monitor_910b ✅ SUCCESS >>>>> >>>>>
Compile_X86_monitor_910c ✅ SUCCESS >>>>> >>>>>
Compile_X86_monitor_950 ✅ SUCCESS >>>>> >>>>>
UT_Test ✅ SUCCESS
UT_Test_experimental ✅ SUCCESS
UT_Test_kernel ✅ SUCCESS
PreSmoke_A900 ✅ SUCCESS >>>>>
API_Check ✅ SUCCESS >>>>>
PreSmoke_ATK_Test_A2 ✅ SUCCESS >>>>>
UT_Test_harmony-infer-chs-math ✅ SUCCESS

[2026-07-16 11:25:21]    CI执行结束

likedislike
Ssongkai111成员
28 天前 修改标题为 “docs: QuickStart输出样例改用通用占位符,避免随机数导致的输出差异”,原标题为“docs: QuickStart输出样例改为通用占位符,避免随机数导致输出不一致”
Ssongkai111成员
28 天前 修改了pull request 的描述
CANN-robot
CANN-robot成员
28 天前 评论:

流水线任务触发成功
任务链接 [c1e33c256d0d4994b065bdb25b1e6672][流水线指导]

任务名称状态日志下载链接
codecheck ✅ SUCCESS >>>>>
SCA ✅ SUCCESS >>>>>
antipoison ✅ SUCCESS >>>>>
codecheck_Pr ✅ SUCCESS
StaticCheck_codespell ✅ SUCCESS
StaticCheck_link_validity ✅ SUCCESS
StaticCheck_resource_existence ✅ SUCCESS
StaticCheck_tag_closed ✅ SUCCESS
StaticCheck_markdownlint ✅ SUCCESS
codecheck_codestyle ✅ SUCCESS >>>>>
codecheck_precommit ✅ SUCCESS >>>>>

[2026-07-16 11:19:28]    CI执行结束

likedislike
CANN-robotCANN-robot成员
28 天前 添加了label:api-check-pass
CANN-robotCANN-robot成员
28 天前 删除了label:ci-pipeline-running
CANN-robotCANN-robot成员
28 天前 添加了label:ci-pipeline-passed
RuiWang_成员
27 天前 评论:

/lgtm

likedislike
zhanw_coding
zhanw_coding成员
27 天前 评论:

/lgtm
/approve

likedislike
CANN-robotCANN-robot成员
27 天前 添加了label:lgtmapproved
CANN-robotCANN-robot成员
27 天前 关闭了关联的issue
CANN-robotCANN-robot成员
27 天前 合入了pull request