Pull Request已成功合入, 合并人@CANN-robot
(感谢 lining23666 的贡献)变更摘要
此 PR 主要新增了 dflow(DataFlow)异步流水框架和 UDF(用户自定义函数)子模块的特性设计文档,并在 AGENTS.md 中注册了 dflow.md 的触发词与涉及目录。文档以中文编写,系统性地覆盖了 dflow 的背景动机、用户场景、对外接口、核心实现架构(PNE 编译引擎、FlowModel/ModelRelation 模型抽象层、多节点主从部署、异构执行器与数据对齐),以及 UDF 框架的完整设计(SO 加载注册、状态机调度、消息抽象、异常处理、内置 UDF 与进程层级体系),为后续特性开发提供了详细的设计参考。
主要改动
- 新增
docs/dflow.md设计文档:全面阐述 dflow 异步流水框架的特性背景、用户场景、C++/Python 对外接口、PNE 编译引擎机制、FlowModel/ModelRelation模型抽象、多节点主从部署策略及异构执行器数据对齐等实现细节。 - 新增
docs/zh/udf.md独立设计文档:详细定义 UDF 子模块的 SO 动态加载注册、状态机调度流程、消息抽象接口、异常处理机制、内置 UDF 清单及头节点→从调度节点→子从调度节点→执行器进程的层级部署架构。 - 更新
AGENTS.md架构文档表:将dflow.md纳入架构文档索引,注册其触发词和涉及目录,便于后续 AI 辅助开发时自动检索相关设计上下文。


代码审查
审查总结
本次审查了 3 个文件的所有变更:
| 文件 | 结果 |
|---|---|
AGENTS.md |
无问题 — 新增的表格行格式正确,与现有条目一致,触发词和目录路径与实际代码结构匹配 |
docs/zh/design/modules/dflow/dflow.md |
无问题 — 纯设计文档,无不安全命令、无硬编码密钥、无默认不安全配置、Mermaid 图表语法正确 |
docs/zh/design/modules/dflow/udf.md |
1 个 P3 发现 — 状态机图中 kSuspend 状态缺失入边 |
发现统计:P0: 0, P1: 0, P2: 0, P3: 1
整体风险评估:低风险。本次变更为纯文档新增,内容为 dflow 异步流水框架及 UDF 子模块的特性设计文档。唯一发现的问题是 udf.md 中状态机 Mermaid 图的一处不完整性(kSuspend 状态缺少入边),正文已覆盖该信息,不影响安全或生产使用,属于文档一致性改进建议。
⚠️ 已识别出整体风险,但无法提取行内评论,请参考整体评估。


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 | ✅ stevenaw0, xchu42, zhanj (3/2) | ✅ zhanj (1/1) |
💡 Tip:
- Committer can comment
/approveor/lgtm- Commenting
/approveimplies 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. 👍


/lgtm


/approve


Pull Request
描述
新增 dflow (DataFlow) 异步流水框架的设计文档,以及 UDF(用户自定义函数)子模块的独立设计文档。
dflow.md 覆盖以下内容:
udf.md 覆盖以下内容:
同时在 AGENTS.md 架构文档表中注册 dflow.md 的触发词和涉及目录。
变更类型
关联的Issue
无
如何测试
核对清单
feat:,fix:)其他信息
变更文件:AGENTS.md(+1)、dflow.md(+646)、udf.md(+464),共 1111 行新增。