ops-transformer/docs/zh/install · azyuli/ops-transformer

Files	Last commit	Last update
build.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
compile.md	960芯片型号支持 Co-authored-by: yangyajie<yangyajie3@huawei.com> # message auto-generated for no-merge-commit merge: !14638 merge master into master 960芯片型号支持 Created-by: yangyajie Commit-by: yangyajie Merged-by: cann-robot Description: ## 描述 <!--在这里详细描述你的改动，包括改动的原因和所采取的方法。--> ## 关联的Issue <!-- 如果这个PR是为了解决特定的Issue，请在这里提供Issue链接。例如：关联Issue #000--> <!-- 如果这个PR是为了解决特定的问题单，请在这里描述问题单单号。--> ## 测试 <!--描述进行了哪些测试来验证你的改动。包括但不限于二级冒烟、算子泛化等。--> ## 文档更新 <!--如果这个PR包含文档的更新，请在这里指出。例如：更新了README.md文件。--> ## 类型标签 <!-- [x] 表示选中 --> - [ ] 🐛 Bug修复 - [ ] ✨ 新特性 - [ ] ⚡ 性能优化 - [ ] ♻️ 重构 - [ ] 🧪 测试 - [ ] 📦 构建/CI - [ ] 🔧 配置变更 - [ ] 📝 文档更新 - [ ] ⬆️ 依赖升级 - [ ] 🔒 安全修复 - [ ] 🧹 代码清理 - [ ] ❓ 其他，请描述： See merge request: cann/ops-transformer!14638	17 days ago
dir_structure.md	torch_extension资料迁移 Co-authored-by: chenyifan<chenyifan66@h-partners.com> # message auto-generated for no-merge-commit merge: !11507 merge mv_torch_docs into master torch_extension资料迁移 Created-by: mutex_lock Commit-by: chenyifan Merged-by: cann-robot Description: ## 描述将 torch 扩展接口文档从集中目录 `torch_extension/cann_ops_transformer/docs/zh/` 迁移到各算子目录 `<category>/<op>/docs/`，并统一命名为 `torchapi_${op_api}.md`，使接口文档与 aclnn 文档同目录、与对外 Python API 主名一致。同步更新： - `docs/zh/menu_torch_api.md`、`docs/zh/torch_api_list.md`（链接改写、补齐未入索引接口、menu 字母序） - `docs/zh/install/dir_structure.md`、`torch_extension_guidelines.md`（文档落位约定） - 相关算子 `README.md` 及文档内相对链接 ## 关联的Issue https://gitcode.com/cann/ops-transformer/issues/5123 ## 测试 - 校验 59 篇迁移文档与 menu/list 一一覆盖，相对链接可解析 - 全仓检索确认无残留 `cann_ops_transformer/docs/zh` 引用 - 对照迁移前后正文：除相对路径改写外无内容篡改 - 文档规则三轮检视通过 ## 文档更新 - 迁移并重命名全部 torch 接口 md 至各算子 `docs/torchapi_*.md` - 更新 `menu_torch_api.md`、`torch_api_list.md` - 更新目录结构说明与 torch_extension 开发规范中的文档路径约定 - 更新相关算子 README 中的接口文档链接 ## 类型标签 <!-- [x] 表示选中 --> - [ ] 🐛 Bug修复 - [ ] ✨ 新特性 - [ ] ⚡ 性能优化 - [ ] ♻️ 重构 - [ ] 🧪 测试 - [ ] 📦 构建/CI - [ ] 🔧 配置变更 - [x] 📝 文档更新 - [ ] ⬆️ 依赖升级 - [ ] 🔒 安全修复 - [ ] 🧹 代码清理 - [ ] ❓ 其他，请描述： See merge request: cann/ops-transformer!11507	2 months ago
quick_install.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