已关闭
[Documentation|文档反馈]: 修复RFC和自定义算子样例中英文文档审计问题 #719
DiJIa2.0创建于  9月15日关闭于  9月16日
DiJIa2.0
DiJIa2.0成员
9月15日 创建

问题描述

文档审计发现RFC和自定义通信算子样例存在中英文信息不对应、错误目录指引、英文拼写错误,以及中文Markdown围栏被缩进导致的渲染问题。

已核实的问题与修正范围

  • RFC 0002英文架构图引用中文图片,图中文字未翻译;提供保留组件、接口与回退关系的英文PNG图片。
  • RFC 0003类图的AlgAttrs类型名拼写不一致;中英文均应区分UT计划覆盖范围与当前仅交付algo_desc组的状态。
  • AllGather和ReduceScatter AIV样例中文缺少安装信息,英文缺少测试源码位置和从仓库根目录开始执行的说明。
  • CCU样例英文缺少测试源码位置,AllGather CCU英文执行目录错误;AllGather CCU以及ReduceScatter AIV/CCU目录树还列出了不存在的引擎内testcase目录。
  • 修正P2P和AllGather AICPU中文验签说明的Markdown缩进、日志全角冒号、ReduceScatter中文源码路径编号,以及英文date/data拼写和a/an冠词错误。
  • 统一中英文目录树符号和相对路径写法,将运行参数解释移出shell代码块;同步中英文图题与pre-commit表格格式及OAT检查范围,并在recursive_executor中英文参考链接中注明目标为中文。

验收标准

CI双语配对修改检查通过,中英文运行指引和命令对应,相关源码路径与仓库结构一致,代码块与英文架构图可正确渲染。仅修改文档,不改变算子实现、接口或构建逻辑。

likedislike
DiJIa2.0DiJIa2.0成员
9月15日 关联了pull request:[docs] 修复RFC与自定义算子样例的中英文文档问题
DiJIa2.0DiJIa2.0成员
9月15日 修改了issue 的描述
DiJIa2.0DiJIa2.0成员
9月15日 修改了issue 的描述
Leewis成员
9月16日 评论:
likedislike
CANN-robotCANN-robot成员
9月16日 将 weixin_43960572 设为负责人
LLeewis成员
9月16日 issue类型由 任务 改变为 文档
DiJIa2.0DiJIa2.0成员
9月16日 关联了pull request:[docs][9.2.0] 修复RFC与自定义算子样例的中英文文档问题
LLeewis成员
9月16日 关联了看板:HCCL
LLeewis成员
9月16日 添加了label:documentation
Leewis成员
9月16日 评论:
likedislike
LLeewis成员
9月16日 issue状态由 进行中 改变为 已完成
LLeewis成员
9月16日 关闭了 issue
CANN-robotCANN-robot成员
9月16日 添加了label:resolved
LLeewis成员
9月21日 移除了看板:HCCL