ge/docs/ge_python · CANN/ge - AtomGit | GitCode

0

0

cann-robotdocs: 优化融合 pattern pass 文档&&Python pass API/行为调整

a02cfb0a创建于 3 天前历史提交

文件	最后提交记录	最后更新时间
api	docs: 优化融合 pattern pass 文档&&Python pass API/行为调整 Co-authored-by: kobemini<gengchao4@huawei.com> # message auto-generated for no-merge-commit merge: !3248 merge doc/pass-reade-me into develop docs: 优化融合 pattern pass 文档&&Python pass API/行为调整 Created-by: kobemini Commit-by: kobemini Merged-by: cann-robot Description: # Pull Request ## 描述本 PR 优化融合 Pattern Pass 的机制说明、开发指南和 Python 写法体验，目标是让用户能按文档理解机制并完成自定义融合 pass 开发。主要变更： - 新增融合 Pattern Pass 特性文档，按“匹配 → 条件过滤 → 替换 → 边界规则 → capture tensor → DecomposePass → 执行阶段”说明统一机制。 - 新增 Python / C++ 融合 Pass 开发指南，Python 侧突出运行时接入、`@pattern` 表达式写法和 replacement 表达式返回。 - 删除旧的混合指南，将内容拆分到特性文档和 C++/Python 指南中，并更新 examples、架构文档和 `ASCEND_GE_PY_PASS_PATH` 文档入口。 - 收口 Python capture tensor 写法：去掉公开的独立 `capture_tensor()` helper，统一使用 `Pattern.capture_tensor(...)`。 - 增强 `Pattern.capture_tensor`：支持直接传入 `TensorHolder`、`Node` 或 `NodeIo`，示例写法从 `pat.capture_tensor(capture_tensor(matmul))` 简化为 `pat.capture_tensor(matmul)`。 - 增强 `@pattern` 自动 capture 规则：从“只捕获已访问输入”提升为“先捕获已访问输入，再捕获 `return` 的 pattern 输出”，并在文档中明确 capture 顺序。 ## 变更类型 - [ ] Bug 修复 - [x] 新功能 - [ ] 代码风格更新（格式化，局部变量） - [ ] 重构（既不修复错误也不增加功能的代码变动） - [ ] 构建过程或辅助工具的变动 - [x] 文档内容更新 ## 关联的 Issue 无 ## 如何测试已执行： - `git diff --check` - `python3 -m py_compile` 检查修改过的 Python pass 框架文件、示例和 Python 测试文件 - 检查本 PR 修改文档中的相对链接均存在 - 检索确认旧的 `capture_tensor(capture_tensor(...))` 嵌套写法、独立 `capture_tensor` 导出和旧文档入口已清理 - `python3 -m pytest tests/ge/ut/ge/graph/pyge_tests/python_pattern_pass_test.py::...` - `ut_fusion_pass_executor_utest` ## 核对清单 - [x] 我的代码遵循了项目的代码风格 - [x] 我已对代码进行了自测 - [x] 我已更新了相关的文档 - [x] 我在标题中使用了合适的类型标签（如：`feat:`, `fix:`） - [x] 我已经详细阅读了贡献指南（CONTRIBUTING.md） ## 其他信息当前 PR 包含文档和 Python pass API/行为调整。`@pattern` 自动 capture 顺序为：先按输入序号捕获已访问的 `inputs`，再按 `return` 结构顺序捕获 pattern 输出。 See merge request: cann/ge!3248	3 天前
design	docs: 优化融合 pattern pass 文档&&Python pass API/行为调整 Co-authored-by: kobemini<gengchao4@huawei.com> # message auto-generated for no-merge-commit merge: !3248 merge doc/pass-reade-me into develop docs: 优化融合 pattern pass 文档&&Python pass API/行为调整 Created-by: kobemini Commit-by: kobemini Merged-by: cann-robot Description: # Pull Request ## 描述本 PR 优化融合 Pattern Pass 的机制说明、开发指南和 Python 写法体验，目标是让用户能按文档理解机制并完成自定义融合 pass 开发。主要变更： - 新增融合 Pattern Pass 特性文档，按“匹配 → 条件过滤 → 替换 → 边界规则 → capture tensor → DecomposePass → 执行阶段”说明统一机制。 - 新增 Python / C++ 融合 Pass 开发指南，Python 侧突出运行时接入、`@pattern` 表达式写法和 replacement 表达式返回。 - 删除旧的混合指南，将内容拆分到特性文档和 C++/Python 指南中，并更新 examples、架构文档和 `ASCEND_GE_PY_PASS_PATH` 文档入口。 - 收口 Python capture tensor 写法：去掉公开的独立 `capture_tensor()` helper，统一使用 `Pattern.capture_tensor(...)`。 - 增强 `Pattern.capture_tensor`：支持直接传入 `TensorHolder`、`Node` 或 `NodeIo`，示例写法从 `pat.capture_tensor(capture_tensor(matmul))` 简化为 `pat.capture_tensor(matmul)`。 - 增强 `@pattern` 自动 capture 规则：从“只捕获已访问输入”提升为“先捕获已访问输入，再捕获 `return` 的 pattern 输出”，并在文档中明确 capture 顺序。 ## 变更类型 - [ ] Bug 修复 - [x] 新功能 - [ ] 代码风格更新（格式化，局部变量） - [ ] 重构（既不修复错误也不增加功能的代码变动） - [ ] 构建过程或辅助工具的变动 - [x] 文档内容更新 ## 关联的 Issue 无 ## 如何测试已执行： - `git diff --check` - `python3 -m py_compile` 检查修改过的 Python pass 框架文件、示例和 Python 测试文件 - 检查本 PR 修改文档中的相对链接均存在 - 检索确认旧的 `capture_tensor(capture_tensor(...))` 嵌套写法、独立 `capture_tensor` 导出和旧文档入口已清理 - `python3 -m pytest tests/ge/ut/ge/graph/pyge_tests/python_pattern_pass_test.py::...` - `ut_fusion_pass_executor_utest` ## 核对清单 - [x] 我的代码遵循了项目的代码风格 - [x] 我已对代码进行了自测 - [x] 我已更新了相关的文档 - [x] 我在标题中使用了合适的类型标签（如：`feat:`, `fix:`） - [x] 我已经详细阅读了贡献指南（CONTRIBUTING.md） ## 其他信息当前 PR 包含文档和 Python pass API/行为调整。`@pattern` 自动 capture 顺序为：先按输入序号捕获已访问的 `inputs`，再按 `return` 结构顺序捕获 pattern 输出。 See merge request: cann/ge!3248	3 天前
env	docs: 优化融合 pattern pass 文档&&Python pass API/行为调整 Co-authored-by: kobemini<gengchao4@huawei.com> # message auto-generated for no-merge-commit merge: !3248 merge doc/pass-reade-me into develop docs: 优化融合 pattern pass 文档&&Python pass API/行为调整 Created-by: kobemini Commit-by: kobemini Merged-by: cann-robot Description: # Pull Request ## 描述本 PR 优化融合 Pattern Pass 的机制说明、开发指南和 Python 写法体验，目标是让用户能按文档理解机制并完成自定义融合 pass 开发。主要变更： - 新增融合 Pattern Pass 特性文档，按“匹配 → 条件过滤 → 替换 → 边界规则 → capture tensor → DecomposePass → 执行阶段”说明统一机制。 - 新增 Python / C++ 融合 Pass 开发指南，Python 侧突出运行时接入、`@pattern` 表达式写法和 replacement 表达式返回。 - 删除旧的混合指南，将内容拆分到特性文档和 C++/Python 指南中，并更新 examples、架构文档和 `ASCEND_GE_PY_PASS_PATH` 文档入口。 - 收口 Python capture tensor 写法：去掉公开的独立 `capture_tensor()` helper，统一使用 `Pattern.capture_tensor(...)`。 - 增强 `Pattern.capture_tensor`：支持直接传入 `TensorHolder`、`Node` 或 `NodeIo`，示例写法从 `pat.capture_tensor(capture_tensor(matmul))` 简化为 `pat.capture_tensor(matmul)`。 - 增强 `@pattern` 自动 capture 规则：从“只捕获已访问输入”提升为“先捕获已访问输入，再捕获 `return` 的 pattern 输出”，并在文档中明确 capture 顺序。 ## 变更类型 - [ ] Bug 修复 - [x] 新功能 - [ ] 代码风格更新（格式化，局部变量） - [ ] 重构（既不修复错误也不增加功能的代码变动） - [ ] 构建过程或辅助工具的变动 - [x] 文档内容更新 ## 关联的 Issue 无 ## 如何测试已执行： - `git diff --check` - `python3 -m py_compile` 检查修改过的 Python pass 框架文件、示例和 Python 测试文件 - 检查本 PR 修改文档中的相对链接均存在 - 检索确认旧的 `capture_tensor(capture_tensor(...))` 嵌套写法、独立 `capture_tensor` 导出和旧文档入口已清理 - `python3 -m pytest tests/ge/ut/ge/graph/pyge_tests/python_pattern_pass_test.py::...` - `ut_fusion_pass_executor_utest` ## 核对清单 - [x] 我的代码遵循了项目的代码风格 - [x] 我已对代码进行了自测 - [x] 我已更新了相关的文档 - [x] 我在标题中使用了合适的类型标签（如：`feat:`, `fix:`） - [x] 我已经详细阅读了贡献指南（CONTRIBUTING.md） ## 其他信息当前 PR 包含文档和 Python pass API/行为调整。`@pattern` 自动 capture 顺序为：先按输入序号捕获已访问的 `inputs`，再按 `return` 结构顺序捕获 pattern 输出。 See merge request: cann/ge!3248	3 天前
README.md	docs: 新增 GE-Python API 参考文档及环境变量说明 Co-authored-by: kobemini<gengchao4@huawei.com> # message auto-generated for no-merge-commit merge: !3181 merge docs/ge-python-api-doc into develop docs: 新增 GE-Python API 参考文档及环境变量说明 Created-by: kobemini Commit-by: kobemini Merged-by: cann-robot Description: # Pull Request ## 描述为 ge-python 模块全部公开接口生成标准化 API 参考文档，并补充环境变量说明。 ## 变更类型请选择本次引入的变更类型（勾选对应项）： - [ ] 🐛 Bug 修复 - [ ] ✨ 新功能 - [ ] 💄 代码风格更新（格式化，局部变量） - [ ] ♻️ 重构（既不修复错误也不增加功能的代码变动） - [ ] 📦 构建过程或辅助工具的变动 - [x] 📝 文档内容更新 ## 关联的Issue 无 ## 如何测试 - 确认所有 Markdown 文件可正常渲染，无格式错误 - 确认文档中的模块导入路径与源码一致 - 确认文档中引用的接口与源码签名一致 ## 核对清单 - [x] 我的代码遵循了项目的代码风格 - [x] 我已对代码进行了自测 - [x] 我已更新了相关的文档 - [x] 我在标题中使用了合适的类型标签（如：`feat:`, `fix:`） - [x] 我已经详细阅读了贡献指南（CONTRIBUTING.md） ## 其他信息 ### 新增文件（16 个） API 参考文档（`docs/ge_python/api/`）： \| 文件 \| 模块/类 \| \|---\|---\| \| Graph.md \| graph 模块 — Graph 类 \| \| Node.md \| graph 模块 — Node 类 \| \| Tensor.md \| graph 模块 — Tensor 类 \| \| TensorDesc.md \| graph 模块 — TensorDesc 类 \| \| Shape.md \| graph 模块 — Shape 类 \| \| DataType.md \| graph 模块 — DataType 枚举 \| \| Session.md \| session 模块 — Session 类 \| \| Allocator.md \| allocator 模块 — Allocator/MemBlock \| \| GeApi.md \| ge_global 模块 — GeApi 类 \| \| OfflineCompile.md \| offline_compile 模块 \| \| GraphBuilder.md \| es 模块 — GraphBuilder 类 \| \| TensorHolder.md \| es 模块 — TensorHolder 类 \| \| GeUtils.md \| utils 模块 — GeUtils 类 \| \| Passes.md \| passes 模块 — FusionBasePass/PatternFusionPass/DecomposePass \| \| pyatc.md \| pyatc 模块 \| 环境变量文档（`docs/ge_python/env/`）： \| 文件 \| 说明 \| \|---\|---\| \| ASCEND_GE_PY_PASS_PATH.md \| Python Pass 插件路径发现环境变量 \| ### 修改文件 - `docs/ge_python/README.md` — 新增"API 参考"和"环境变量"导航章节 - `docs/es/README.md` — 链接修正 See merge request: cann/ge!3181	6 天前