已合并
docs: 修正dflow设计文档中模块路径和文件索引与代码不一致 #4307
lining23666创建于 23 天前
docs: 修正dflow设计文档中模块路径和文件索引与代码不一致 #4307
已合并
lining23666创建于 23 天前
lining23666成员
23 天前

描述

修正 docs/zh/design/modules/dflow/dflow.mddocs/en/design/modules/dflow/dflow.md 中与实际代码不一致的路径描述。

背景:b336645besession/compiler/executor/ 目录结构调整到 runner/ 下,但设计文档中的模块路径、正文内联路径和附录文件索引未同步更新,导致开发者按文档路径找不到代码。

修改内容

  1. 模块路径添加 runner/ 前缀(6处):范围声明、mermaid 模块全景图、模块表、编译层 mermaid 图中 session/runner/session/compiler/runner/compiler/executor/runner/executor/
  2. 正文内联路径修正(4处):base/model/pne_model.hinc/data_flow/model/pne_model.h,3处 compiler/runner/compiler/
  3. 删除 MultiThreadGraphBuilder 相关表达(3处):8线程描述不准确,仅说明构建为 ComputeGraph
  4. 中英文文档同步修改

变更类型

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

关联的Issue

如何测试

  1. 对照修改后的文件路径,在 dflow/ 目录下验证每个路径存在
  2. 检查中英文文档修改对称一致

核对清单

likedislike
Pull Request已成功合入, 合并人@CANN-robot
(感谢 lining23666 的贡献)
Llining23666成员
23 天前 创建了 pull request,commit d7b310e3
atomgit-bot
atomgit-bot
23 天前 评论:

变更摘要

本次变更修正了 dflow 设计文档中因代码目录重构(b336645besession/compiler/executor/ 迁移至 runner/ 下)而滞后的模块路径、内联路径和文件索引,确保中英文文档与实际代码结构一致。

主要改动

  • 模块路径添加 runner/ 前缀:在 dflow.md 的模块范围声明、mermaid 全景图、模块表及编译层图中,将 session/runner/session/compiler/runner/compiler/executor/runner/executor/,共修复 6 处,使文档中的模块路径与重构后的代码目录对齐。
  • 正文内联路径修正:将 base/model/pne_model.h 更正为 inc/data_flow/model/pne_model.h,并将 3 处 compiler/ 前缀补全为 runner/compiler/,确保开发者按文档路径可定位到对应源文件。
  • 删除 MultiThreadGraphBuilder 相关描述:移除 3 处关于 8 线程的不准确描述,统一表述为构建 ComputeGraph,消除因实现变更导致的文档误导。
  • 附录文件索引路径补全:对 23 条文件索引条目补全完整相对路径,使文档附录中的文件引用与仓库实际结构一致。
  • 中英文文档同步:两处文档(docs/zh/docs/en/)的修改保持对称,确保中英文版本描述一致且均指向正确的代码路径。
likedislike
atomgit-bot
atomgit-bot
23 天前 评论:

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

likedislike
CANN-robotCANN-robot成员
23 天前 添加了label:cann-cla/yes
CANN-robot
CANN-robot成员
23 天前 评论:

CLA Signature Pass

lining23666, thanks for your pull request. All authors of the commits have signed the CLA. 👍

likedislike
CANN-robot
CANN-robot成员
23 天前 评论:

Thanks for your pull-request.
The full list of commands accepted by me can be found at here
You can get sig-info at here


PR Approval Progress

Congratulations! All modules have met the lgtm and approve requirements.

Module Approval Details

module lgtm status approve status
repo-cann/ge 张德鹏, xchu42, stevenaw0 (3/2) 张德鹏 (1/1)

💡 Tip:

  • Committer can comment /approve or /lgtm
  • Commenting /approve implies both code review (lgtm) and intent to merge (approve)

CLA Signature Pass

lining23666, thanks for your pull request. All authors of the commits have signed the CLA. 👍

likedislike
CANN-robotCANN-robot成员
23 天前 将yangyongqiang0606,kobemini,tangqunzhang,xchu42,hugo111,fu-jun2,depeng1994,wqtshg_wt,peiyang,shengnan666,zhangfan_hanq,zhanj,zhujingjing,Mexyy,wangxiaotian995,stevenaw0,yuht9设为评审人
CANN-robotCANN-robot成员
23 天前 将yangyongqiang0606,kobemini,tangqunzhang,xchu42,hugo111,fu-jun2,depeng1994,wqtshg_wt,peiyang,shengnan666,zhangfan_hanq,zhanj,zhujingjing,Mexyy,wangxiaotian995,stevenaw0,yuht9设为审查人
lining23666成员
23 天前 评论:

compile

likedislike
Llining23666成员
23 天前 update merge request[project id: 8824148, iid: 4307, commit_id: 6fdcc7bc757e0ba0ed99e8c93981d3fb1f751ea3] virtual merging success
CANN-robotCANN-robot成员
23 天前 添加了label:ci-pipeline-running
CANN-robot
CANN-robot成员
23 天前 评论:

流水线任务触发成功
任务链接 [39e8d6a5c9f04d9eb2dc1ef7537715f0][流水线指导]

任务名称状态日志下载链接
pre_comment ✅ SUCCESS >>>>>
Compile_ARM_compiler ✅ SUCCESS >>>>> >>>>>
Compile_ARM_executor ✅ SUCCESS >>>>> >>>>>
Compile_ARM_dflow ✅ SUCCESS >>>>> >>>>>
API_Check ✅ SUCCESS >>>>>
PreSmoke_A900_npupool ✅ SUCCESS >>>>>

[2026-08-07 17:01:08]    CI执行结束

likedislike
CANN-robot
CANN-robot成员
23 天前 评论:

流水线任务触发成功
任务链接 [56baec2730cf4cf6bfcdbca50e5947a7][流水线指导]

任务名称状态日志下载链接
pre_comment ✅ SUCCESS >>>>>
Compile_X86_compiler ✅ SUCCESS >>>>> >>>>>
Compile_X86_executor ✅ SUCCESS >>>>> >>>>>
Compile_X86_dflow ✅ SUCCESS >>>>> >>>>>
UT_Test_dflow ✅ SUCCESS
UT_Test_ge_common ✅ SUCCESS
UT_Test_parser ✅ SUCCESS
UT_Test_python ✅ SUCCESS >>>>>
UT_Test_rt ✅ SUCCESS
UT_Test_acl ✅ SUCCESS
UT_Test_autofuse ✅ SUCCESS
UT_Test_executor ✅ SUCCESS
UT_Test_autofuse_ascendc_api ✅ SUCCESS
ST_Test_dflow ✅ SUCCESS
ST_Test_ge_common ✅ SUCCESS
ST_Test_parser ✅ SUCCESS
ST_Test_python ✅ SUCCESS >>>>>
ST_Test_rt ✅ SUCCESS
ST_Test_autofuse ✅ SUCCESS
ST_Test_executor ✅ SUCCESS
ST_Test_hetero ✅ SUCCESS
ST_Test_autofuse_ascendc_api ✅ SUCCESS
ST_Test_autofuse_e2e ✅ SUCCESS
UT_Test_fe ✅ SUCCESS
UT_Test_tefusion ✅ SUCCESS
ST_Test_fe ✅ SUCCESS
ST_Test_tefusion ✅ SUCCESS
ST_Test_ge_common_atc ✅ SUCCESS
UT_Test_Report_graphengine ✅ SUCCESS >>>>>
UT_Test_Report_ge_executor_c ✅ SUCCESS >>>>>
UT_Test_Report_ge_autofuse ✅ SUCCESS >>>>>
ST_Test_Report_graphengine ✅ SUCCESS >>>>>
ST_Test_Report_ge_executor_c ✅ SUCCESS >>>>>
ST_Test_Report_ge_autofuse ✅ SUCCESS >>>>>
UT_Test_Report_fe ✅ SUCCESS >>>>>
ST_Test_Report_fe ✅ SUCCESS >>>>>

[2026-08-07 17:02:02]    CI执行结束

likedislike
CANN-robot
CANN-robot成员
23 天前 评论:

流水线任务触发成功
任务链接 [c56f515a3777497f8b8d730a72b13dda][流水线指导]

任务名称状态日志下载链接
codecheck_Pr ✅ SUCCESS
antipoison ✅ SUCCESS >>>>>
SCA ✅ SUCCESS >>>>>
codecheck_dt ✅ SUCCESS >>>>>
codecheck_precommit ✅ SUCCESS >>>>>
StaticCheck_codespell ⚠️ WARNING >>>>>
StaticCheck_link_validity ✅ SUCCESS
StaticCheck_resource_existence ✅ SUCCESS
StaticCheck_tag_closed ✅ SUCCESS
StaticCheck_markdownlint ✅ SUCCESS

[2026-08-07 17:00:58]    CI执行结束

likedislike
CANN-robotCANN-robot成员
23 天前 添加了label:api-check-pass
此处折叠了7条事件消息 查看更多
CANN-robotCANN-robot成员
23 天前 删除了label:ci-pipeline-passed
CANN-robot
CANN-robot成员
23 天前 评论:

Notification

This pull request has been changed(code update) or closed, so removes the following label(s): ci-pipeline-passed.

likedislike
CANN-robotCANN-robot成员
23 天前 添加了label:cann-cla/yes
lining23666成员
23 天前 评论:

compile

likedislike
Llining23666成员
23 天前 update merge request[project id: 8824148, iid: 4307, commit_id: 0a6a9828c1cecf22ff7a351fe9ab85662042b13f] virtual merging success
CANN-robotCANN-robot成员
23 天前 添加了label:ci-pipeline-running
CANN-robot
CANN-robot成员
23 天前 评论:

流水线任务触发成功
任务链接 [c3cfcb49bf574406b5f12d267c128563][流水线指导]

任务名称状态日志下载链接
pre_comment ✅ SUCCESS >>>>>
Compile_ARM_compiler ✅ SUCCESS >>>>> >>>>>
Compile_ARM_executor ✅ SUCCESS >>>>> >>>>>
Compile_ARM_dflow ✅ SUCCESS >>>>> >>>>>
API_Check ✅ SUCCESS >>>>>
PreSmoke_A900_npupool ✅ SUCCESS >>>>>

[2026-08-07 17:18:45]    CI执行结束

likedislike
CANN-robot
CANN-robot成员
23 天前 评论:

流水线任务触发成功
任务链接 [6f602b0b643a40038344cc96092393f5][流水线指导]

任务名称状态日志下载链接
pre_comment ✅ SUCCESS >>>>>
Compile_X86_compiler ✅ SUCCESS >>>>> >>>>>
Compile_X86_executor ✅ SUCCESS >>>>> >>>>>
Compile_X86_dflow ✅ SUCCESS >>>>> >>>>>
UT_Test_dflow ✅ SUCCESS
UT_Test_ge_common ✅ SUCCESS
UT_Test_parser ✅ SUCCESS
UT_Test_python ✅ SUCCESS >>>>>
UT_Test_rt ✅ SUCCESS
UT_Test_acl ✅ SUCCESS
UT_Test_autofuse ✅ SUCCESS
UT_Test_executor ✅ SUCCESS
UT_Test_autofuse_ascendc_api ✅ SUCCESS
ST_Test_dflow ✅ SUCCESS
ST_Test_ge_common ✅ SUCCESS
ST_Test_parser ✅ SUCCESS
ST_Test_python ✅ SUCCESS >>>>>
ST_Test_rt ✅ SUCCESS
ST_Test_autofuse ✅ SUCCESS
ST_Test_executor ✅ SUCCESS
ST_Test_hetero ✅ SUCCESS
ST_Test_autofuse_ascendc_api ✅ SUCCESS
ST_Test_autofuse_e2e ✅ SUCCESS
UT_Test_fe ✅ SUCCESS
UT_Test_tefusion ✅ SUCCESS
ST_Test_fe ✅ SUCCESS
ST_Test_tefusion ✅ SUCCESS
ST_Test_ge_common_atc ✅ SUCCESS
UT_Test_Report_graphengine ✅ SUCCESS >>>>>
UT_Test_Report_ge_executor_c ✅ SUCCESS >>>>>
UT_Test_Report_ge_autofuse ✅ SUCCESS >>>>>
ST_Test_Report_graphengine ✅ SUCCESS >>>>>
ST_Test_Report_ge_executor_c ✅ SUCCESS >>>>>
ST_Test_Report_ge_autofuse ✅ SUCCESS >>>>>
UT_Test_Report_fe ✅ SUCCESS >>>>>
ST_Test_Report_fe ✅ SUCCESS >>>>>

[2026-08-07 17:19:21]    CI执行结束

likedislike
CANN-robotCANN-robot成员
23 天前 添加了label:api-check-pass
CANN-robot
CANN-robot成员
23 天前 评论:

流水线任务触发成功
任务链接 [9c419e517ffa45b2873518aab77f293d][流水线指导]

任务名称状态日志下载链接
codecheck_Pr ✅ SUCCESS
antipoison ✅ SUCCESS >>>>>
SCA ✅ SUCCESS >>>>>
codecheck_dt ✅ SUCCESS >>>>>
codecheck_precommit ✅ SUCCESS >>>>>
StaticCheck_codespell ⚠️ WARNING >>>>>
StaticCheck_link_validity ✅ SUCCESS
StaticCheck_resource_existence ✅ SUCCESS
StaticCheck_tag_closed ✅ SUCCESS
StaticCheck_markdownlint ✅ SUCCESS

[2026-08-07 17:18:51]    CI执行结束

likedislike
CANN-robotCANN-robot成员
23 天前 删除了label:api-check-pass
CANN-robotCANN-robot成员
23 天前 删除了label:ci-pipeline-running
CANN-robotCANN-robot成员
23 天前 添加了label:ci-pipeline-passed
Llining23666成员
23 天前 修改了pull request 的描述
xchu42
xchu42成员
23 天前 评论:

/lgtm

likedislike
Llining23666成员
23 天前 修改了pull request 的描述
黄桂军
黄桂军成员
23 天前 评论:

/lgtm

likedislike
CANN-robotCANN-robot成员
23 天前 添加了label:lgtm
张德鹏成员
21 天前 评论:

/approve

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