已合并
docs: convert Pro documentation figures to editable SVG #7162
xuxinlei321创建于 7 天前
docs: convert Pro documentation figures to editable SVG #7162
已合并
xuxinlei321创建于 7 天前
xuxinlei321
7 天前

PR 应该避免没有描述信息,描述信息的最重要的作用是描述修改意图,应该清晰明了。例如:标题中包含了 fix 标签,如果没有描述信息,就需要Review人员猜测PR具体修复了哪些内容,或者怀疑修改的必要性。如果PR和特定的Issue相关,可以单独包含一行 Related Issue: 放到描述信息最后。

下面是一个典型的PR描述信息:

The origin issue template brings too many noise, it's not suitable for git message. eg: comments
are not removed, labels are redundant as the PR tile already contains the tag.

The guide gives a clear suggestion on how to write the PR body.

Related Issue: #1234,#5678

更多描述信息见:Commit Message 规范

likedislike
Pull Request已成功合入, 合并人@CANN-robot
(感谢 xuxinlei321 的贡献)
Xxuxinlei321
7 天前 创建了 pull request,commit 7c8e5be9
atomgit-bot
atomgit-bot
7 天前 评论:

变更摘要

本次变更将 Pro 相关文档中的示意图从位图格式(.jpg/.png)统一替换为可编辑的矢量图 .svg,涉及 docs/zh/api/pro_api/SIMD-API 下 Reg-API 各接口文档(如 vf.add、vf.load_align、vf.astype、vf.gather、vf.histograms 等)以及 docs/zh/guide/programming_guide/pro 下的编程指南与编程范式文档(Cube 计算、Tiling、Reg/Tile 计算、SIMD/SIMT 硬件架构与编程模型等)。改动内容为 Markdown 图片引用路径的扩展名替换,图片说明文字(替代文本与 title)保持不变,文档正文与接口描述未作调整。

主要改动

  • Reg-API 接口文档图示改为 SVG:docs/zh/api/pro_api/SIMD-API/Reg-API 下算术运算、数据搬运、掩码操作、类型转换、归约、排序统计等各接口文档中的 figures/*.jpg 引用统一改为 figures/*.svg,使示意图可直接编辑与无损缩放。
  • 编程指南与编程范式图示改为 SVG:docs/zh/guide/programming_guide/pro 下 figures/pro/*.png 与 figures/pro/*.jpg 引用改为对应的 .svg 文件,覆盖 abstract_hardware_architecture.md、programming_paradigm.md、cube_computation.md、reg_computation.md、tile_computation.md、multi_core_tiling.md 等页面的架构图与流程图。
  • SIMD 资源与调度相关页面同步替换:load_tile.md、store_tile.md、make_tensor.md、make_tile.md、make_tile_group.md 等涉及 Tile/Tensor 视图与双缓冲轮转的示意图也改为 .svg 引用。
  • 仅变更图片链接、不改文档语义:所有改动均保持原有图片描述文本与上下文段落一致,仅替换文件扩展名,因此不影响接口原型、参数说明和数据结构的描述内容。
likedislike
不准确?
atomgit-bot
atomgit-bot
7 天前 评论:

代码审查

✅ 未发现问题

likedislike
不准确?
CANN-robotCANN-robot成员
7 天前 添加了label:cann-cla/yes
CANN-robot
CANN-robot成员
7 天前 评论:

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.
You can self-configure the PR merge rules for this repository. For more details, please refer to Here.
For more, you also can visit HICANN.


PR Approval Progress

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

Module Approval Details

module lgtm status approve status
docs ✅ lyz0328, gaoxiang618 (2/2) ✅ lyz0328 (1/1)

💡 Tip:

  • Committer can comment /approve or /lgtm
  • Commenting /approve implies both code review (lgtm) and intent to merge (approve)

CLA Signature Pass

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

likedislike
CANN-robotCANN-robot成员
7 天前 将xinweiliu,lyz0328,cam_bxh,dai-zhentao,lululu40888,shi-dingkun,gguuaanngg,codehjp423,gaoxiang618,wangzheng97,DCGDDD,syfeng,jason_yuan_ye,foundea,ym-HW,hw_zhangzhiqi,yinjie27_,congqiannan,zhangyuebing,tsungl4,gaoxingwang,zhiweiyuan,caodongdong,make_pto,zhoubotcam,linjiashu,wangbing110,WenboCodes设为评审人
CANN-robotCANN-robot成员
7 天前 将lyz0328,foundea,yinjie27_,linjiashu设为审查人
xuxinlei321
7 天前 评论:

compile

likedislike
Xxuxinlei321
7 天前 预合并成功(commit_id: 640af8f2b46b81493143d19279f0d4f83b0b610f)
CANN-robot
CANN-robot成员
7 天前 评论:
🚀 CI 流水线已启动
📋 执行详情: 点击查看流水线
likedislike
CANN-robotCANN-robot成员
7 天前 添加了label:ci-pipeline-running
CANN-robotCANN-robot成员
7 天前 删除了label:ci-pipeline-running
CANN-robotCANN-robot成员
7 天前 添加了label:ci-pipeline-passed
lyz0328
lyz0328成员
7 天前 评论:

/approve

likedislike
CANN-robotCANN-robot成员
7 天前 添加了label:approved
gaoxiang618成员
7 天前 评论:

/approve
/lgtm

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

The following users do not have permission to comment /lgtm or /approve on any module in this PR:
/approve: gaoxiang618

likedislike
CANN-robotCANN-robot成员
7 天前 添加了label:lgtm
CANN-robotCANN-robot成员
7 天前 合入了pull request