| 文件 | 最后提交记录 | 最后更新时间 |
|---|---|---|
docs: 修正dflow设计文档中模块路径和文件索引与代码不一致 Co-authored-by: lining23666<lining.li@huawei.com> # message auto-generated for no-merge-commit merge: !4307 merge fix-dflow-doc-paths into develop docs: 修正dflow设计文档中模块路径和文件索引与代码不一致 Created-by: lining23666 Commit-by: lining23666 Merged-by: cann-robot Description: ## 描述 修正 docs/zh/design/modules/dflow/dflow.md 和 docs/en/design/modules/dflow/dflow.md 中与实际代码不一致的路径描述。 背景:b336645be 将 session/、compiler/、executor/ 目录结构调整到 runner/ 下,但设计文档中的模块路径、正文内联路径和附录文件索引未同步更新,导致开发者按文档路径找不到代码。 ### 修改内容 1. **模块路径添加 runner/ 前缀**(6处):范围声明、mermaid 模块全景图、模块表、编译层 mermaid 图中 session/→runner/session/、compiler/→runner/compiler/、executor/→runner/executor/ 2. **正文内联路径修正**(4处):base/model/pne_model.h→inc/data_flow/model/pne_model.h,3处 compiler/→runner/compiler/ 3. **删除 MultiThreadGraphBuilder 相关表达**(3处):8线程描述不准确,仅说明构建为 ComputeGraph 4. **中英文文档同步修改** ## 变更类型 请选择本次引入的变更类型: <!-- [x] 表示选中 --> - [ ] 🐛 Bug 修复 - [ ] ✨ 新功能 - [ ] 💄 代码风格更新(格式化,局部变量) - [ ] ♻️ 重构(既不修复错误也不增加功能的代码变动) - [ ] 📦 构建过程或辅助工具的变动 - [x] 📝 文档内容更新 ## 关联的Issue 无 ## 如何测试 1. 对照修改后的文件路径,在 dflow/ 目录下验证每个路径存在 2. 检查中英文文档修改对称一致 ## 核对清单 <!-- [x] 表示选中 --> - [x] 我的代码遵循了项目的代码风格 - [x] 我已对代码进行了自测 - [x] 我已更新了相关的文档 - [x] 我在标题中使用了合适的类型标签(如:feat:, fix:) - [x] 我已经详细阅读了贡献指南(CONTRIBUTING.md),并遵守了其中的所有规定 See merge request: cann/ge!4307 | 5 天前 | |
docs: 新增dflow异步流水框架和UDF子模块设计文档 Co-authored-by: lining23666<lining.li@huawei.com> # message auto-generated for no-merge-commit merge: !4043 merge delete_code into develop docs: 新增dflow异步流水框架和UDF子模块设计文档 Created-by: lining23666 Commit-by: lining23666 Merged-by: cann-robot Description: # Pull Request ## 描述 新增 dflow (DataFlow) 异步流水框架的设计文档,以及 UDF(用户自定义函数)子模块的独立设计文档。 **dflow.md** 覆盖以下内容: - 特性背景:host-device 交互瓶颈痛点,DataFlow 的核心价值(多模型串接下沉执行、异步流水、低门槛自定义处理) - 用户使用场景:多模型串接、UDF 自定义处理、批处理聚合、多实例负载均衡 - 对外接口:C++/Python 构图 API(FlowGraph/FlowNode/ProcessPoint)、运行接口(DFlowSession)、数据类型(FlowMsg/rtMbuf) - 具体实现: - 编译层:PNE 引擎机制(NPU/CPU/UDF 三引擎)、多级缓存、编译 Pass - 模型抽象层:FlowModel/UdfModel/GraphModel/SerializedModel、ModelRelation、OM 序列化 - 部署层:多节点主从部署(头节点→从调度节点→子从调度节点→执行器进程)、进程层级体系、通信链路、模型执行(Host/NPU 静态/NPU 动态) - 执行层:异构执行器、数据对齐、事务追踪 - UDF 执行位置与多实例部署配置 - 端到端数据流和关键设计总结 **udf.md** 覆盖以下内容: - UDF 框架调用链路(SO 加载注册、Processor 初始化、运行时调度) - 调度核心:FlowFuncProcessor 10 态状态机、事件驱动重调度、看门狗、挂起/恢复 - 数据对齐与两种输入模式(Reader 驱动/FlowMsgQueue 流式) - 上下文体系、消息抽象、负载均衡、异常处理、内置 UDF(TimeBatch/CountBatch) 同时在 AGENTS.md 架构文档表中注册 dflow.md 的触发词和涉及目录。 ## 变更类型 - [ ] 🐛 Bug 修复 - [ ] ✨ 新功能 - [ ] 💄 代码风格更新(格式化,局部变量) - [ ] ♻️ 重构(既不修复错误也不增加功能的代码变动) - [ ] 📦 构建过程或辅助工具的变动 - [x] 📝 文档内容更新 ## 关联的Issue 无 ## 如何测试 1. 检查文档格式和链接是否正确 2. 检查 Mermaid 图表是否可正常渲染 ## 核对清单 - [x] 我的代码遵循了项目的代码风格 - [x] 我已对代码进行了自测 - [x] 我已更新了相关的文档 - [x] 我在标题中使用了合适的类型标签(如: feat:, fix:) - [x] 我已经详细阅读了贡献指南(CONTRIBUTING.md),并遵守了其中的所有规定 ## 其他信息 变更文件:AGENTS.md(+1)、dflow.md(+646)、udf.md(+464),共 1111 行新增。 See merge request: cann/ge!4043 | 25 天前 |