已关闭
[Documentation|文档反馈]: 项目标准算子交付件说明与全量目录结构存在差异,子场景 Tiling 文件命名规则缺失 #2314
shaoyf创建于 7月24日关闭于 25 天前
陈思
7月25日 评论:
7月25日 评论:
你好,感谢反馈。问题确认修复中,请耐心等待。


7月27日 关联了pull request:docs(contributing): 补充子场景 Tiling 文件与 _tiling 命名约束
7月28日 将 chensi79 设为负责人
25 天前 关闭了 issue
25 天前 添加了label:resolved
一、文档链接 (必填)
https://gitcode.com/cann/ops-math/blob/master/CONTRIBUTING.md#附录
https://gitcode.com/cann/ops-math/blob/master/docs/zh/install/dir_structure.md#项目目录
二、问题文档片段 (必填)
片段 1:CONTRIBUTING.md 附录中 op_host 目录的交付件清单
片段 2:dir_structure.md 中 op_host 目录下针对子场景的可选 Tiling 文件
💡 存在的问题
在按照贡献指南(CONTRIBUTING.md 附录)准备项目标准算子交付件时,发现附录中给出的交付件清单与
docs/zh/install/dir_structure.md中的全量目录结构存在差异,且缺失一个关键的命名约束说明,对开发者不够友好。具体如下:1. 附录未列出针对子场景的可选 Tiling 文件
CONTRIBUTING.md 附录中 op_host 目录下的交付件仅包含
${op_name}_def.cpp、${op_name}_tiling.cpp、CMakeLists.txt,而 dir_structure.md 中 op_host 目录下还包含针对子场景 Tiling 优化的可选文件${op_name}_tiling_${sub_case}.cpp和${op_name}_tiling_${sub_case}.h。对于复杂算子,往往需要按子场景(如特定架构 arch35)拆分 Tiling 实现为多个文件承载。附录中未提及这一可选交付件,开发者无法从贡献指南中得知该机制的存在。2. 附录未提供指向全量目录结构的链接
CONTRIBUTING.md 附录在介绍"项目标准算子交付件"时,未提供指向
docs/zh/install/dir_structure.md的链接,开发者难以从交付件说明自然过渡到完整的目录结构说明,容易遗漏可选交付件或对目录组织方式产生疑问。3. 关键命名规则缺失:文件名必须包含
_tiling才能被编译dir_structure.md 在列出
${op_name}_tiling_${sub_case}.cpp和${op_name}_tiling_${sub_case}.h时,仅说明了这两个文件"可选"及其用途,但未说明这样的命名并非随意——文件名中必须包含_tiling标识才能被编译系统识别并参与编译。这一隐式约束在贡献指南和全量目录说明中均未提及,开发者如果按子场景拆分 Tiling 实现但未遵循_tiling命名规则,将面临文件未被编译、问题难定位的情况。改进建议
${op_name}_tiling_${sub_case}.cpp和${op_name}_tiling_${sub_case}.h复杂场景可能需要用的的目录的说明,考虑在附录中增加指向docs/zh/install/dir_structure.md的链接,提示开发者可参考全量目录结构。${op_name}_tiling_${sub_case}.cpp/.h的说明里,补充命名规则约束:文件名必须包含_tiling才能被编译系统识别参与编译,并简述其背景原因。