Merged
docs: add English translations for markdown files #15306
docs: add English translations for markdown files #15306
Merged
jenny_xiangAdd on 4 days ago
jenny_xiang
4 days ago

描述

新增仓库Markdown文档英文译稿(第一批,共42个被其他译稿引用的文件):根README_en.md、CONTRIBUTING_en.md、SECURITY_en.md;各算子设计文档英文版(ChunkKdaFwd/FA/FAG/MlaProlog/FFN/AllGatherAdd等design文档)及ascendir系列接口文档;examples系列说明(含fast_kernel_launch_example、mc2/all_gather_add、flash_attn L0_minimal等);以及gmm/grouped_matmul_activation、attention/nsa_compress_attention_infer、attention/nsa_compress_with_cache、attention/recurrent_kda、ffn/ffn、mhc/mhc_sinkhorn、posembedding/partial_rotary_mul_quant共7个算子的README译稿与相关测试/示例说明。
本批为后续批量英文文档提交做前置:本批文件合入master后,其余281篇译稿中的仓内链接(均指向master已有文件或本批文件)即可生效,避免链接失效拦截。7个算子相关文档已全部集中于本批提交,未拆散。

关联的Issue

无

测试

文档类变更,无需算子测试;已通过链接有效性校验(第一批内全部相对链接仅指向master已有文件或本批新增文件),并完成逐篇翻译规范自查与语义校对(含支持状态表、限定词、术语、数值符号核对)。

文档更新

新增41个英文译稿文件,重命名1个中文设计文档(ffn/ffn/docs/FFN算子设计介绍.md → FFN_design.md),不修改其他任何现有文件。

类型标签

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

变更摘要

本 PR 为仓库新增第一批英文译稿(共 42 个文件,其中 1 个为中文设计文档重命名),核心目的是为后续批量英文文档提交建立链接基础:本批文件覆盖仓库根文档、主要算子设计文档与接口文档、examples 示例说明、测试框架说明,以及 7 个算子的 README 译稿。变更以文档新增为主,不涉及算子实现代码;此外,attention/pool_key_indexer/docs/torchapi_pool_key_indexer_en.md 在译稿之外还同步更新了接口能力描述。

主要改动

  • 仓库根文档英文版: 新增 README_en.md、CONTRIBUTING_en.md、SECURITY_en.md,覆盖版本动态、环境准备、贡献流程(新算子/缺陷修复/优化/文档纠错)、算子交付物与合规检查项、文件权限与公网地址声明等表格与流程说明。

  • 算子设计文档英文版: 新增 ChunkKdaFwd_design_en.md、FA_design_en.md、FAG_design_en.md、MlaProlog_design_en.md、FFN_design_en.md、AllGatherAdd_design_en.md,包含计算流程、Tiling/TilingKey 划分、多模板与流水设计、Verification Matrix 等内容;同时新增 ascendir_FlashAttentionScore_en.md、ascendir_FlashAttentionScoreGrad_en.md 等 ascendir 接口文档,给出 REG_OP 定义、参数表与 GE 图模式调用样例。

  • 7 个算子 README 英文版: 新增 grouped_matmul_activation、nsa_compress_attention_infer、nsa_compress_with_cache、recurrent_kda、ffn、mhc_sinkhorn、partial_rotary_mul_quant 的 README_en.md,统一包含产品支持状态表、计算公式、参数表(含可选属性与默认值)、约束说明及 aclnn/PyTorch 调用入口。

  • examples 与测试框架英文说明: 新增 examples/README_en.md、fast_kernel_launch_example(含 moe_distribute_dispatch_v2 的 ascend910_93/ascend950 版本与 update_context MC2 Context 创建流程)、mc2/all_gather_add、ccu_alltoall、flash_attn/L0_minimal 的 README_en.md 与 FA_IMPL_en.md,以及 flash_attn/tests/pytests/readme_en.md、chunk_kda_fwd/recurrent_kda 的 pytest README_en.md,说明用例格式、命令行参数、精度判定与性能采集方式。

  • pool_key_indexer 接口文档更新: 在 torchapi_pool_key_indexer_en.md 中新增 quant_mode=2 的 int8 量化说明(query/pool_key 为 INT8、weights 与 q_descale/k_descale 为 FLOAT16)、纯尾块模式(0 pool)的 pool_tail_k 语义、sparse_indices 紧凑输出布局说明,并补充 128K decode 场景的 int8 量化调用示例。

  • 另新增 torch_extension/cann_ops_transformer/docs/torch_extension_guidelines_en.md,规范算子 API 的目录组织、命名约定、C++/Python/图模式各层实现与文档编写要求。


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

likedislike
Incorrect?
CANN-robotCANN-robotCollaborators
4 days ago Added label: cann-cla/yes
CANN-robot
CANN-robotCollaborators
4 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
attention ✅ 刘丹, cc-z, 於欣洁, 俞郑中, wangxun21 (5/2) ✅ 於欣洁, 俞郑中, wangxun21, 刘丹, cc-z (5/1)
examples ✅ 刘丹, 於欣洁, wang-minbo, zzzzzzyf_, 俞郑中, xtqh (6/2) ✅ 俞郑中, 刘丹, 於欣洁, wang-minbo, zzzzzzyf_ (5/1)
ffn ✅ 俞郑中, 刘丹, 唐超 (3/2) ✅ 俞郑中, 刘丹, 唐超 (3/1)
gmm ✅ cc-z, 唐超, 俞郑中, 刘丹 (4/2) ✅ cc-z, 唐超, 俞郑中, 刘丹 (4/1)
mhc ✅ wangxun21, 刘丹, 俞郑中 (3/2) ✅ wangxun21 (1/1)
posembedding ✅ cc-z, 於欣洁, 俞郑中, wangxun21, 刘丹 (5/2) ✅ cc-z, 於欣洁, 俞郑中, wangxun21, 刘丹 (5/1)
sig-ops-transformer ✅ 俞郑中, 刘丹 (2/2) ✅ 刘丹, 俞郑中 (2/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
CANN-robotCANN-robotCollaborators
4 days ago Set guijianwei,hz36amy_00,yangziqi_007,coder_linx,cheng_zhiwei,chenkang30,juyangokok,monologue815,chaotang233,wuyi_huawei,xuanyuandy,chen-linxin4,crystalhu,yu-xinjie62,huangwei791,jiang-lirui,yang-binrong,Allan_Yu,wang-minbo,huang-wei-chen,xtqh,songkai111,liudan12,shasha_an,wangzhe123456789,Wei_NaChuan,zhangshuoleiokok,shi-rui,luwei_1104,cc-z,kdy18482276080,xuchengyang,shen_weiling,kknan,gaoxiang618,songjionghui,lining_210,wenxin_fight,miaofangzheng,mabing1118,tang-hao-hw-gitcode,haijie_699874,xuejinghui,zzy__,Julius47,yuhao_,L_Euler,jiangjiawei,wangxun21,zzzzzzyf_ as approver
CANN-robotCANN-robotCollaborators
4 days ago Set guijianwei,hz36amy_00,yangziqi_007,coder_linx,cheng_zhiwei,chenkang30,juyangokok,monologue815,chaotang233,wuyi_huawei,xuanyuandy,chen-linxin4,crystalhu,yu-xinjie62,huangwei791,jiang-lirui,yang-binrong,Allan_Yu,wang-minbo,huang-wei-chen,xtqh,songkai111,liudan12,shasha_an,wangzhe123456789,Wei_NaChuan,zhangshuoleiokok,shi-rui,luwei_1104,cc-z,kdy18482276080,xuchengyang,shen_weiling,kknan,gaoxiang618,songjionghui,lining_210,wenxin_fight,miaofangzheng,mabing1118,tang-hao-hw-gitcode,haijie_699874,xuejinghui,zzy__,Julius47,yuhao_,L_Euler,jiangjiawei,wangxun21,zzzzzzyf_ as approver
jenny_xiang
4 days ago Comments:

/compile

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

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

流水线: https://gitcode.com/CANN/ops-transformer/actions/runs/a648e6ca81304e0d9a6a489b1b930dcc | PR#15306 | 2026-11-04 17:25:47 ~ 17:28:40 | 失败 Job 1 个

定界结论: 代码问题 / 代码检查错误 — Check_Example 门禁: 7 个算子缺 examples/UT
  • 失败类型: 代码问题
  • 根因: PR 直接涉及的 19 个算子中 7 个不满足 Check_Example 完整性门禁 —— 1 个缺 examples、6 个缺 ut
  • 处置: 由 PR 提交者补齐对应算子的 examples 与 UT 后重新触发流水线
  • 排除项: 非环境/网络问题;本次仅 Check_examples_ut 单 Job 失败,其余 Job 无独立失败

失败根因分析

根因 #1: 代码问题 / 代码检查错误 — Check_Example 门禁拦截
  • 判据: check_example_failed= 非空且 Job 为 Check_examples_ut
  • 定位步骤: 3_check_examples_ut.log
  • 影响 Job: Check_examples_ut
  • 缺 examples(1 个):
    • gmm/grouped_matmul_activation
  • 缺 UT(6 个):
    • attention/nsa_compress_attention_infer
    • attention/nsa_compress_with_cache
    • attention/recurrent_kda
    • ffn/ffn
    • mhc/mhc_sinkhorn
    • posembedding/partial_rotary_mul_quant
  • 根因证据(日志原文):
pr_filelist涉及算子(依赖展开可用时包含依赖): 19个
算子总数: 19, 正常: 12, 异常: 7
  examples 缺失/为空: 1
  ut 缺失/为空: 6
缺 examples:
  gmm/grouped_matmul_activation
缺 ut:
  attention/nsa_compress_attention_infer
  attention/nsa_compress_with_cache
  attention/recurrent_kda
  ffn/ffn
  mhc/mhc_sinkhorn
  posembedding/partial_rotary_mul_quant
check_example_failed=ffn,grouped_matmul_activation,mhc_sinkhorn,nsa_compress_attention_infer,nsa_compress_with_cache,partial_rotary_mul_quant,recurrent_kda
::error::Process exited with code 1
结构化定界摘要
[{"repo": "ops-transformer", "run_number": 14112, "Failed_Type": "代码问题", "Failed_Sub_Type": "代码检查错误", "Failed_Reason": "Check_Example 门禁: PR 直接涉及 19 个算子中 7 个不完整, grouped_matmul_activation 缺 examples, nsa_compress_attention_infer/nsa_compress_with_cache/recurrent_kda/ffn/mhc_sinkhorn/partial_rotary_mul_quant 缺 UT", "evidence": "check_example_failed=ffn,grouped_matmul_activation,mhc_sinkhorn,nsa_compress_attention_infer,nsa_compress_with_cache,partial_rotary_mul_quant,recurrent_kda", "suggestion": "补齐 gmm/grouped_matmul_activation 的 examples 及 6 个算子的 UT 后重新触发流水线", "jobs": "Check_examples_ut"}]

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

likedislike
CANN-robotCANN-robotCollaborators
4 days ago Added label: ci-pipeline-passed; Removed label: ci-pipeline-failed
wang-minboCollaborators
4 days ago Comments:

纯 doc/docs/examples/tests/ut 或 .md 文档修改(42 个文件),直接加分,无需进一步代码检视。

likedislike
赵臣臣Collaborators
4 days ago Comments:

/lgtm
/approve

likedislike
於欣洁Collaborators
4 days ago Comments:

/lgtm
/approve

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

/lgtm
/approve

likedislike
唐超Collaborators
4 days ago Comments:

/lgtm
/approve

likedislike
wang-minboCollaborators
4 days ago Comments:

/lgtm
/approve

likedislike
YuZhengzhongCollaborators
4 days ago Comments:

/approve
/lgtm

likedislike
jenny_xiang
4 days ago Comments:

@wang-minbo :烦请加个分呢,多谢~

likedislike
xtqhCollaborators
4 days ago Comments:

/lgtm

likedislike
liudan12Collaborators
4 days ago Comments:

/approve
/lgtm

likedislike
CANN-robotCANN-robotCollaborators
4 days ago Added label: lgtm
wangxun21Collaborators
3 days ago Comments:

/lgtm
/approve

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