已合并
docs(custom_op): 补齐 tilelang 样例英文 README 与中文版对齐 #4853
docs(custom_op): 补齐 tilelang 样例英文 README 与中文版对齐 #4853
已合并
why you创建于 10 天前
why you成员
10 天前

Pull Request

描述

三个 tilelang 样例的英文 README(README_en.md)与中文版(README.md)不一致,英文版缺失大量章节。本 PR 将英文 README 补齐为与中文版逐行对齐的完整翻译,与仓库既有惯例(compilable_add_custom、triton_add_custom 中英 README 行数一致)保持一致。

主要补充内容:

  • tilelang_add_customcall 函数签名及说明、CANN 依赖第 2 条、环境变量表、快速运行 4 步说明与预期输出、关键文件说明、算子规格 Output shape 行、分步运行章节
  • tilelang_add_custom_online:目录结构注释、call 函数签名及说明、CANN 依赖第 2 条、环境变量表、成功输出示例、关键文件说明、算子规格 Output shape 行、分步运行章节、注意事项补全 2 条;修正交叉链接指向英文版 README_en.md
  • tilelang_add_custom_offline:目录结构、核心流程(graph_build/ATC/model_exec 三阶段流程图)、TileLang-Ascend 使用范围说明、环境变量表、快速运行 4 步说明与预期输出、算子规格 Output shape 行、序列化格式、关键文件说明、注意事项补全 4 条

同时修正一处中文 README 与代码不一致的描述:offline 样例"关键文件说明"中 Deserialize 原描述为"写临时文件",与代码实现矛盾(实际链路 Deserialize → LoadSoFromData → WriteVectorToMemfd → memfd_create 从内存加载、不落盘;mkstemps 临时文件仅用于 Compile 阶段),中英文同步修正。

变更类型

请选择本次引入的变更类型:

关联的Issue

如何测试

  1. 文档类改动,无需运行功能测试
  2. 结构校验:三个样例中英 README 的章节标题(h2/h3 数量)、代码围栏数量、总行数逐项对齐(177/208/212 行),且标题与围栏所在行号完全一致
  3. 本地 pre-commit 检查全部通过(codespell、end-of-file-fixer、trailing-whitespace、OAT Compliance 等)

核对清单

其他信息

  • 分支基于 cann/ge develop 创建,仅包含 3 个 README_en.md 补齐与 1 处中英同步修正(offline README.md / README_en.md 各 1 行),不涉及代码改动
likedislike
Pull Request已成功合入, 合并人@CANN-robot
(感谢 why you 的贡献)
Wwhy you成员
10 天前 创建了 pull request,commit 77064ca0
atomgit-bot
atomgit-bot
10 天前 评论:

变更摘要

本 PR 为 tilelang_add_customtilelang_add_custom_onlinetilelang_add_custom_offline 三个 tilelang 样例补齐英文 README_en.md,使其与中文 README.md 逐行对齐(章节标题、代码围栏数量与行号完全一致,行数分别为 177/208/212 行),并顺带修正 offline 样例中文 README 中一处与代码实现矛盾的描述。纯文档改动,不涉及任何代码变更。

主要改动

  • 补齐 tilelang_add_custom 英文 README:新增 call 函数签名及说明、CANN 依赖第 2 条、环境变量表、快速运行 4 步说明与预期输出、关键文件说明、算子规格 Output shape 行及分步运行章节,与中文版对齐。
  • 补齐 tilelang_add_custom_online 英文 README:新增目录结构注释、call 函数签名及说明、CANN 依赖第 2 条、环境变量表、成功输出示例、关键文件说明、Output shape 行、分步运行章节,并补全 2 条注意事项;同时修正文档交叉链接,使其指向英文版 README_en.md 而非中文版。
  • 补齐 tilelang_add_custom_offline 英文 README:新增目录结构、graph_build/ATC/model_exec 三阶段核心流程图、TileLang-Ascend 使用范围说明、环境变量表、快速运行 4 步说明与预期输出、Output shape 行、序列化格式、关键文件说明,并补全 4 条注意事项。
  • 修正 offline 样例中英文 README 的 Deserialize 描述:将"写临时文件"改为与实际代码链路一致的内存加载方式(DeserializeLoadSoFromDataWriteVectorToMemfdmemfd_create,不落盘),并说明 mkstemps 临时文件仅用于 Compile 阶段,中英文同步更新各 1 行。
likedislike
不准确?
atomgit-bot
atomgit-bot
10 天前 评论:

🤖 本次改动均为数据 / 生成 / 二进制文件(如测试用例、锁文件、媒体资源),没有可审查的代码逻辑,已跳过 AI 代码审查。

likedislike
不准确?
CANN-robotCANN-robot成员
10 天前 添加了label:stat/needs-squash
CANN-robotCANN-robot成员
10 天前 添加了label:cann-cla/yes
此处折叠了53条消息 查看更多
ClarkXie
ClarkXie成员
9 天前 评论:

/lgtm

likedislike
CANN-robotCANN-robot成员
9 天前 添加了label:lgtm
yangyongqiang
yangyongqiang成员
9 天前 评论:

/approve

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