ops-transformer/docs/zh/develop · wuxuening/ops-transformer

cann-robotdocs(pre-commit): 修复 git pc 别名对含空格/非 ASCII 路径的静默漏检

Files	Last commit	Last update
aicore_develop_guide.md	docs: fix BlitzSparseAttention types and documentation typos Co-authored-by: zzzzzzyf_<zhouyunfei10@huawei.com> # message auto-generated for no-merge-commit merge: !13770 merge fix/documentation-issues-20261013 into master docs: fix BlitzSparseAttention types and documentation typos Created-by: zzzzzzyf_ Commit-by: zzzzzzyf_ Merged-by: cann-robot Description: ## 描述合并修复当前指派给贡献者的 9 个文档 Issue。共修改 26 个 Markdown 文件，新增 49 行、删除 50 行；修正错字、重复文字、标题层级、术语及 BlitzSparseAttention 量化参数表。参数类型按源码注册核对；将 quantScale2/quantOffset2 表对齐为 FLOAT32/BFLOAT16，保留产品与输入场景约束。空 Tensor 处理按实际 aclnn 实现描述，不机械替换成 AscendCL。不改算子实现、编译脚本或计算逻辑。文档 C++ 示例仅统一 gama/gamma 变量拼写，benchmark 示例仅补全注释。 ## 关联的Issue - [#5853](https://gitcode.com/cann/ops-transformer/issues/5853)：修正 BlitzSparseAttention 量化参数表，与当前 OpDef 对齐并保留场景限制。 - [#5969](https://gitcode.com/cann/ops-transformer/issues/5969)：修正指定 attention 文档的拼写、重复词、标点和标题层级。 - [#5977](https://gitcode.com/cann/ops-transformer/issues/5977)：修正指定 docs/zh 文档的术语、拼写及重复描述。 - [#5981](https://gitcode.com/cann/ops-transformer/issues/5981)：补全 BNSD 注释，修正空 Tensor 处理的 aclnn 表述。 - [#6003](https://gitcode.com/cann/ops-transformer/issues/6003)：修正 rope_matrix 文档三处英文拼写。 - [#6038](https://gitcode.com/cann/ops-transformer/issues/6038)：修正 combine_add_rms_norm 文档的错字和冗余文字。 - [#6041](https://gitcode.com/cann/ops-transformer/issues/6041)：修正 dispatch 文档的量化参数列举、默认值及重复词。 - [#6073](https://gitcode.com/cann/ops-transformer/issues/6073)：修正 lightning_indexer 测试文档标题层级及重复条目。 - [#6075](https://gitcode.com/cann/ops-transformer/issues/6075)：修正 PromptFlashAttention 的 AI Core 和 aclnn 表述。本轮另核查 #6045、#5733：#6045 原问题段落已从 master 移除，无需修改；#5733 涉及编译目标兼容性，不纳入纯文档提交。 ## 测试 - 38 组定向修改均核对旧文本与匹配次数；确认仅包含目标 Markdown 文件。 - 修改前后链接目标、代码块数量与语言标记不变；示例除变量一致性重命名、注释及围栏中的说明文字外不变。 - 参数表与当前 OpDef、空 Tensor 处理代码核对。 - 保留原文件换行方式；`git -c core.whitespace=cr-at-eol diff --check` 通过。 - 按 CI 同版本 pre-commit-hooks v4.6.0 对全部 26 个文档执行 trailing-whitespace（保留 Markdown 双空格换行）和 end-of-file-fixer，均通过；修正 benchmark README 原有的单个行尾空格。 - 未编译文档示例或执行 NPU 测试，本次为静态文档核查。 ## 文档更新涉及 attention、docs/zh、experimental 与 mc2 下的指定 README 和接口文档。 ## 类型标签 - [x] 📝 文档更新 See merge request: cann/ops-transformer!13770	1 month ago
aicpu_develop_guide.md	fix product master2 Co-authored-by: caiwenwen<caiwenwen6@h-partners.com> # message auto-generated for no-merge-commit merge: !13074 merge master into master fix product master2 Created-by: caiwenwen Commit-by: caiwenwen Merged-by: cann-robot Description: ## 描述 <!--在这里详细描述你的改动，包括改动的原因和所采取的方法。--> AI处理器对应的产品型号名称更新 ## 关联的Issue <!-- 如果这个PR是为了解决特定的Issue，请在这里提供Issue链接。--> <!-- 如果这个PR是为了解决特定的问题单，请在这里描述问题单单号。--> [#3258](https://gitcode.com/cann/ops-math/issues/3258) ## 测试 <!--描述进行了哪些测试来验证你的改动。包括但不限于二级冒烟、算子泛化等。--> ok ## 文档更新 <!--如果这个PR包含文档的更新，请在这里指出。例如：更新了README.md文件。--> *.md ## 类型标签 <!-- [x] 表示选中 --> - [ ] Bug修复 - [ ] 新特性 - [ ] 性能优化 - [x] 文档更新 - [ ] 其他，请描述： See merge request: cann/ops-transformer!13074	1 month ago
cross_platform_migration_guide.md	修改moe/gmm/mhc/posembedding的aidd问题 Co-authored-by: caiwenwen<caiwenwen6@h-partners.com> # message auto-generated for no-merge-commit merge: !13838 merge master into master 修改moe/gmm/mhc/posembedding的aidd问题 Created-by: caiwenwen Commit-by: caiwenwen Merged-by: cann-robot Description: ## 描述 aidd扫描问题修改master分支 ## 关联的Issue 关联issue [#3309](https://gitcode.com/cann/ops-math/issues/3309) ## 测试 md文档更新不涉及测试 ## 文档更新主要是docs / zh、examples 、experimental、gmm、mc2、mhc、moe、posembedding文件 ## 类型标签 <!-- [x] 表示选中 --> - [ ] 🐛 Bug修复 - [ ] ✨ 新特性 - [ ] ⚡ 性能优化 - [ ] ♻️ 重构 - [ ] 🧪 测试 - [ ] 📦 构建/CI - [ ] 🔧 配置变更 - [x] 📝 文档更新 - [ ] ⬆️ 依赖升级 - [ ] 🔒 安全修复 - [ ] 🧹 代码清理 - [ ] ❓ 其他，请描述： See merge request: cann/ops-transformer!13838	1 month ago
graph_develop_guide.md	fix: Modify the AIDD docs issue Co-authored-by: zwj223<zhangwenjing55@h-partners.com> # message auto-generated for no-merge-commit merge: !9326 merge master into master fix: Modify the AIDD docs issue Created-by: zwj223 Commit-by: zwj223 Merged-by: cann-robot Description: ## 描述 <!--在这里详细描述你的改动，包括改动的原因和所采取的方法。--> 修改AIDD扫描的核心资料问题 ## 关联的Issue <!-- 如果这个PR是为了解决特定的Issue，请在这里提供Issue链接。例如：关联Issue #000--> <!-- 如果这个PR是为了解决特定的问题单，请在这里描述问题单单号。--> [#3995](https://gitcode.com/cann/ops-transformer/issues/3995) ## 文档更新 <!--如果这个PR包含文档的更新，请在这里指出。例如：更新了README.md文件。--> torch_api_list.md op_list.md ascend950_op_list.md aclnn返回码.md 互推导关系.md ... ## 类型标签 <!-- [x] 表示选中 --> - [ ] 🐛 Bug修复 - [ ] ✨ 新特性 - [ ] ⚡ 性能优化 - [ ] ♻️ 重构 - [ ] 🧪 测试 - [ ] 📦 构建/CI - [ ] 🔧 配置变更 - [x] 📝 文档更新 - [ ] ⬆️ 依赖升级 - [ ] 🔒 安全修复 - [ ] 🧹 代码清理 - [ ] ❓ 其他，请描述： See merge request: cann/ops-transformer!9326	3 months ago
metadata_develop_guide.md	[Docs]Metadata算子开发指南 Co-authored-by: ChengjiaWu<wuchengjia1@h-partners.com> # message auto-generated for no-merge-commit merge: !14856 merge master into master [Docs]Metadata算子开发指南 Created-by: ChengjiaWu Commit-by: ChengjiaWu Merged-by: cann-robot Description: ## 描述 <!--在这里详细描述你的改动，包括改动的原因和所采取的方法。--> 添加Metadata算子开发指南，提供原理解释和开发指导 ## 关联的Issue <!-- 如果这个PR是为了解决特定的Issue，请在这里提供Issue链接。例如：关联Issue #000--> <!-- 如果这个PR是为了解决特定的问题单，请在这里描述问题单单号。--> Issue [#6912](https://gitcode.com/cann/ops-transformer/issues/6912) ## 测试 <!--描述进行了哪些测试来验证你的改动。包括但不限于二级冒烟、算子泛化等。--> ## 文档更新 <!--如果这个PR包含文档的更新，请在这里指出。例如：更新了README.md文件。--> ## 类型标签 <!-- [x] 表示选中 --> - [ ] 🐛 Bug修复 - [ ] ✨ 新特性 - [ ] ⚡ 性能优化 - [ ] ♻️ 重构 - [ ] 🧪 测试 - [ ] 📦 构建/CI - [ ] 🔧 配置变更 - [x] 📝 文档更新 - [ ] ⬆️ 依赖升级 - [ ] 🔒 安全修复 - [ ] 🧹 代码清理 - [ ] ❓ 其他，请描述： See merge request: cann/ops-transformer!14856	16 days ago
pre-commit_guide.md	docs(pre-commit): 修复 git pc 别名对含空格/非 ASCII 路径的静默漏检 Co-authored-by: gitcode_lijd<lijiandong20@huawei.com> # message auto-generated for no-merge-commit merge: !15505 merge fix_2 into master docs(pre-commit): 修复 git pc 别名对含空格/非 ASCII 路径的静默漏检 Created-by: gitcode_lijd Commit-by: gitcode_lijd Merged-by: cann-robot Description: ## 描述 ### 问题 `docs/zh/develop/pre-commit_guide.md` 中 `git pc` 别名存在静默漏检： `bash # 原写法 git config --global alias.pc '!f() { pre-commit run --files $(git diff --name-only "$@"); }; f'` 1. `$(...)` 展开按空白切分——含空格的路径被拆碎，pre-commit 收到不存在的文件名 2. Git 对非 ASCII 路径（中文文件名）默认输出带引号的转义形式——pre-commit 拿到带引号路径，文件找不到两种情况下 hook 均跳过对应文件并报告成功——改了中文文件名或含空格路径的文件后跑 `git pc`，实际未被检查但显示全绿（假收敛）。 ### 修复改为 NUL 分隔输出 + xargs -0 传输（文件名二进制安全），并加 `-r` 避免无差异时空参数误跑全仓： `bash git config --global alias.pc '!f() { git diff --name-only -z "$@" \| xargs -0 -r pre-commit run --files; }; f'` 两处别名示例（快速配置两节）同步修改。 ### 实测原生 trailing-whitespace 钩子复现：旧写法对中文路径与含空格路径双双跳过；新写法检出并修复后复跑通过。 > 说明：`-r`（--no-run-if-empty）为 GNU xargs 选项，防无差异时空参数触发全仓检查；macOS/BSD xargs 默认空输入不执行（无此选项），不影响。 > 同款修复已提交 cannbot-skills 仓（PR #1700，issue #1021），本 PR 对齐该口径。 ## 测试 - 真实 Git + 原生 pre-commit 钩子复现验证（中文路径/含空格路径/无差异三场景） - 文档改动仅 2 行别名示例，无代码影响 ## 类型标签 - [x] 📝 文档更新 - [x] 🐛 Bug 修复 See merge request: cann/ops-transformer!15505	6 days ago