Merged
docs: add English translations for markdown files #15372
docs: add English translations for markdown files #15372
Merged
jenny_xiangAdd on 3 days ago
jenny_xiang
3 days ago

描述

新增仓库Markdown文档英文译稿(第二批,共275个文件),为第一批(已合入)之外的其余全部译稿:

  • 新增263个英文译稿文件(含上游新增算子 attention/flash_kda_grad 的README与测试说明2篇,及14篇基于最新源文档的增量更新)
  • 重命名12个中文设计文档为英文名(Xxx算子设计介绍.md → Xxx_design.md,与第一批FFN_design.md策略一致)
  • 更新7个README中的设计文档引用链接
  • 更新.pre-commit-config.yaml中codespell忽略词表

本批内全部仓内链接均指向master已有文件(含第一批已合入的42篇译稿),合入后本仓英文文档全部就位、链接完整生效。

关联的Issue

无

测试

文档类变更,无需算子测试;已通过链接有效性校验、残留中文/全角标点扫描、EOF换行规范检查,并完成逐篇翻译规范自查与独立语义审查(含支持状态表、限定词、术语、数值符号核对)。

文档更新

新增263个英文译稿文件、重命名12个中文设计文档、更新8个现有文件,不修改算子源码。

类型标签

likedislike
Pull Request has been successfully merged by CANN-robot.
(Thank you for jenny_xiang's contribution.)
Jjenny_xiang
3 days ago Created pull request, commit 957e48ef
atomgit-bot
atomgit-bot
3 days ago Comments:

变更摘要

本 PR 为仓库 Markdown 文档补齐第二批英文译稿(共 275 个文件),覆盖 attention、mc2、gmm、moe、mla、posembedding、ffn、mamba、mhc 等目录下大量算子说明文档,并统一采用 *_en.md 命名与「English | [简体中文]」语言切换头。除算子 README 外,还包含测试框架说明(pytest / TTK / 用例转换工具)、工具与设计文档的英文版本,以及仓库级英文 PR 模板与英文变更日志;同时将若干中文设计文档改为英文文件名 Xxx_design.md 并补充对应 *_design_en.md,同步修正 README 中的设计文档引用链接。

主要改动

  • 算子与测试文档英文译稿批量新增:为 attention、mc2、gmm、moe、posembedding 等目录下的算子 README 新增 README_en.md,内容涵盖产品支持情况、功能与计算公式、参数表、约束说明和调用示例,并在文件头加入 English | [简体中文](./README.md) 双语入口。
  • 测试框架与用例工具英文说明:新增 attention/chunk_gated_delta_rule/tests/assets/README_en.md、attention/compressor/tests/pytest/README_en.md、attention/kv_quant_sparse_flash_attention/tests/assets/case_converter/README_en.md、tests/mc2_mock_test_frame/README_en.md、mc2/tools/dump_analysis/README_en.md 等,说明 pytest/TTK 执行方式、精度对比标准、Excel 转 CSV 用例转换和 dump 数据分析流程。
  • 中文设计文档更名并补充英文版:attention/flash_attention_score/docs/FA_design.md、attention/flash_attention_score_grad/docs/FAG_design.md、attention/incre_flash_attention/docs/IFA_design.md、attention/prompt_flash_attention/docs/PFA_design.md、attention/mla_prolog*/docs/MlaProlog*_design.md、attention/chunk_kda_fwd/docs/ChunkKdaFwd_design.md、mc2/moe_distribute_dispatch_v2/docs/MoeDistributeDispatch-Combine_design.md、gmm/grouped_matmul/docs/grouped_matmul_design_en.md、examples/mc2/all_gather_add/docs/AllGatherAdd_design.md 等以英文文件名落地,并新增对应 *_design_en.md 译稿。
  • README 设计文档链接改为指向英文文档:attention/flash_attention_score/README_en.md、attention/flash_attention_score_grad/README_en.md、attention/chunk_kda_fwd/README_en.md、attention/fused_floyd_attention/README_en.md、attention/mla_prolog*/README_en.md、mc2/all_gather_matmul_v2/tests/bi/README_en.md 等中的引用改为 FA_design_en.md、FAG_design_en.md、ChunkKdaFwd_design_en.md、FFA_design_en.md 等英文设计文档路径。
  • 仓库级英文配套文件新增:新增 .gitcode/PULL_REQUEST_TEMPLATE.en-US.md(英文 PR 模板,含描述、关联 Issue、测试、文档更新与类型标签)与 CHANGELOG_en.md(按版本倒序记录 8.5.0-beta.1 的版本地址、兼容性矩阵、关键特性与问题修复),以及 torch_extension/README_en.md(cann_ops_transformer 的构建、安装、全量与子包共存机制及新增算子开发说明)。

🧩 本次 Review 已使用自定义 Skill:

likedislike
Incorrect?
CANN-robotCANN-robotCollaborators
3 days ago Added label: cann-cla/yes
CANN-robot
CANN-robotCollaborators
3 days ago Comments:

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
.gitcode/** ✅ Larry_liuyi, 刘丹, 俞郑中 (3/2) ✅ Larry_liuyi (1/1)
*/*/docs/acl*.md ✅ 俞郑中, zzzzzzyf_, 刘丹, cc-z (4/2) ✅ zzzzzzyf_ (1/1)
attention ✅ 刘丹, cc-z, 俞郑中, wangxun21 (4/2) ✅ cc-z, 俞郑中, wangxun21, 刘丹 (4/1)
examples ✅ 俞郑中, 刘丹, zzzzzzyf_ (3/2) ✅ zzzzzzyf_, 俞郑中, 刘丹 (3/1)
ffn ✅ 刘丹, 俞郑中 (2/2) ✅ 刘丹, 俞郑中 (2/1)
gmm ✅ 刘丹, cc-z, 俞郑中 (3/2) ✅ 刘丹, cc-z, 俞郑中 (3/1)
mc2 ✅ 刘丹, 俞郑中 (2/2) ✅ 刘丹, 俞郑中 (2/1)
mhc ✅ wangxun21, 刘丹, 俞郑中 (3/2) ✅ wangxun21 (1/1)
moe ✅ 俞郑中, 刘丹, cc-z (3/2) ✅ 刘丹, cc-z, 俞郑中 (3/1)
posembedding ✅ 刘丹, cc-z, 俞郑中, wangxun21 (4/2) ✅ 刘丹, cc-z, 俞郑中, wangxun21 (4/1)
sig-ops-transformer ✅ 刘丹, 俞郑中 (2/2) ✅ 刘丹, 俞郑中 (2/1)
tests ✅ 刘丹, zzzzzzyf_, 俞郑中 (3/2) ✅ 刘丹, zzzzzzyf_, 俞郑中 (3/1)

💡 Tip:

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

CLA Signature Pass

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

likedislike
jenny_xiang
3 days ago Comments:

/compile

likedislike
Jjenny_xiang
3 days ago Pre merge succeeded (commit_id: 3f092df51c27a7af3cd598a3c877b339d1ab01d3)
CANN-robot
CANN-robotCollaborators
3 days ago Comments:
🚀 CI 流水线已启动
📋 执行详情: 点击查看流水线
likedislike
CANN-robotCANN-robotCollaborators
3 days ago Added label: ci-pipeline-running
CANN-robotCANN-robotCollaborators
3 days ago Removed label: ci-pipeline-running
CANN-robotCANN-robotCollaborators
3 days ago Added label: ci-pipeline-failed
CANN-robot
CANN-robotCollaborators
3 days ago Comments:

流水线分析报告 — ops-transformer run#14316

流水线: https://gitcode.com/cann/ops-transformer/actions/runs/13ec6442c0da4ac48094f5010c195e71 | PR#15372 | 2026-11-05 16:59:25 ~ 2026-11-05 17:02:33 | 失败 Job 1 个

定界结论: 代码问题 / 代码检查错误 — trim trailing whitespace 未通过
  • 失败类型: 代码问题
  • 根因: pre-commit 检查项 trim trailing whitespace 未通过,两个文档文件存在行尾多余空白(hook 已自动标记并修改)
  • 处置建议: 通知 PR 提交者修复(见下方根因 #1 的具体文件与建议)
  • 排除项: 其余 36 个 Job 均 COMPLETED;6 个 INIT 为前置失败后的级联未启动,无独立失败。

失败根因分析

根因 #1: 代码问题 / 代码检查错误 — trim trailing whitespace 未通过
  • 判据: pre-commit 检查项不通过: trim trailing whitespace(本地执行 pre-commit run trailing-whitespace 修复)
  • 定位步骤: CodeCheck_precommit → 3_precommit.log
  • 影响 Job: CodeCheck_precommit
  • 需修复文件:
    • attention/mla_prolog_v2/docs/MlaPrologV2_design.md
    • attention/mla_prolog/docs/MlaProlog_design.md
  • 根因证据(日志原文):
[2026-11-05 17:01:43.164+08:00] trim trailing whitespace.................................................Failed
[2026-11-05 17:01:43.165+08:00] - hook id: trailing-whitespace
[2026-11-05 17:01:43.167+08:00] - files were modified by this hook
[2026-11-05 17:01:43.169+08:00] Fixing attention/mla_prolog_v2/docs/MlaPrologV2_design.md
[2026-11-05 17:01:43.170+08:00] Fixing attention/mla_prolog/docs/MlaProlog_design.md
  • 建议: 本地执行 pre-commit run trailing-whitespace --all-files(或按上方指导书配置 pre-commit hook)自动删除行尾空白,确认两处文档无差异后重新提交推送。
结构化定界摘要
[{"repo": "ops-transformer", "run_number": 14316, "Failed_Type": "代码问题", "Failed_Sub_Type": "代码检查错误", "Failed_Reason": "pre-commit 的 trim trailing whitespace 检查未通过,attention/mla_prolog_v2/docs/MlaPrologV2_design.md 与 attention/mla_prolog/docs/MlaProlog_design.md 存在行尾多余空白", "evidence": "[2026-11-05 17:01:43.164+08:00] trim trailing whitespace.................................................Failed", "suggestion": "执行 pre-commit run trailing-whitespace --all-files 删除两处文档行尾空白后重新提交推送", "jobs": "CodeCheck_precommit"}]

由门禁失败定界分析自动生成 | repo: ops-transformer | run: 13ec6442c0da4ac48094f5010c195e71 | PR#15372

likedislike
Jjenny_xiang
3 days ago Pre merge succeeded (commit_id: 469ec135e6f7eb191434a41b6716315063478fa6)
Jjenny_xiang
3 days ago Force-pushed 24 commits:46e308d4-23 commits from branch master,9b693530-docs: add English translations for markdown files
Jjenny_xiang
3 days ago Pre merge succeeded (commit_id: c46d40d3cd8a2cd159ab60dc2eccf3a719df681f)
CANN-robotCANN-robotCollaborators
3 days ago Removed label: cann-cla/yes
CANN-robotCANN-robotCollaborators
3 days ago Added label: cann-cla/yes
jenny_xiang
3 days ago Comments:

/compile

likedislike
Jjenny_xiang
3 days ago Pre merge succeeded (commit_id: 5d61ba92068ba619986a99f6d1a9824e030a1785)
CANN-robot
CANN-robotCollaborators
3 days ago Comments:
🚀 CI 流水线已启动
📋 执行详情: 点击查看流水线
likedislike
CANN-robotCANN-robotCollaborators
3 days ago Removed label: ci-pipeline-failed
7 event messages are collapsed here。 See more
CANN-robotCANN-robotCollaborators
3 days ago Added label: ci-pipeline-passed
赵臣臣Collaborators
3 days ago Comments:

/lgtm
/approve

likedislike
周云飞
周云飞Collaborators
3 days ago Comments:

/lgtm
/approve

likedislike
YuZhengzhongCollaborators
3 days ago Comments:

/approve
/lgtm

likedislike
wangxun21Collaborators
3 days ago Comments:

/approve
/lgtm

likedislike
刘怡Collaborators
3 days ago Comments:

/approve
/lgtm

likedislike
CANN-robotCANN-robotCollaborators
3 days ago Added label: approved
liudan12Collaborators
3 days ago Comments:

/lgtm
/approve

likedislike
CANN-robotCANN-robotCollaborators
3 days ago Added label: lgtm
CANN-robotCANN-robotCollaborators
3 days ago Merged pull request