compat-doc-authoring
编写或更新 Paddle 与 PyTorch C++ API 兼容性文档。Use when: 添加兼容文档、补充 API 对比表、补全兼容性统计、拆分 typeid 类级文档、统一文档格式。
Codex 또는 Claude로 설치 이 Prompt를 복사해 Codex, Claude 또는 다른 어시스턴트에 붙여 넣으면 Skill 페이지를 검토하고 설치를 진행할 수 있습니다.
메뉴
编写或更新 Paddle 与 PyTorch C++ API 兼容性文档。Use when: 添加兼容文档、补充 API 对比表、补全兼容性统计、拆分 typeid 类级文档、统一文档格式。
Codex 또는 Claude로 설치 이 Prompt를 복사해 Codex, Claude 또는 다른 어시스턴트에 붙여 넣으면 Skill 페이지를 검토하고 설치를 진행할 수 있습니다.
SOC 직업 분류 기준
循环新增 Paddle 对 PyTorch C++ 兼容接口。Use when: 有新增 PyTorch C++ API 需求时,在 Paddle compat 层新增接口与测试,并执行双仓编译、ctest、wheel 安装和回归验证。
根据 PR 链接、GitHub Actions 链接或 review/comment 链接定位问题并修复 Paddle C++ compat 接口。Use when: 需要按外部链接驱动修复 c10/ATen/torch 兼容层接口并完成编译、测试和回归。
定期触发验证并自动更新 API 映射表。基于 verify_api_mapping.py 全量验证,检测分类漂移,自动修复高置信度问题,低置信度进入Agent 审核队列。
按需验证单个或批次 API 的映射准确性,基于 Step 2-1 追踪方法深入 PyTorch 实现链路。支持发现问题、给出修复建议、执行修复。
编写或更新 Paddle 与 PyTorch C++ API 兼容性文档。Use when: 添加兼容文档、补充 API 对比表、补全兼容性统计、拆分 typeid 类级文档、统一文档格式。
PaddlePaddle 与 PyTorch C++ API 兼容性测试开发规范。适用于:编写或扩展 test/ 目录下的兼容性测试、验证 Paddle 兼容层与 PyTorch 同一 API 的行为一致性、定位接口输出差异、新增算子测试、覆盖 Shape/Dtype/值域/API 变体。Use when: writing compatibility tests, adding operator tests, checking ATen/c10 API behavior differences between Paddle and PyTorch.
| name | compat-doc-authoring |
| description | 编写或更新 Paddle 与 PyTorch C++ API 兼容性文档。Use when: 添加兼容文档、补充 API 对比表、补全兼容性统计、拆分 typeid 类级文档、统一文档格式。 |
| argument-hint | 要编写的头文件或模块,例如 typeid.h、Stream.h、TensorBase.h |
面向 doc/ 目录的 API 兼容文档生产与维护流程,目标是输出可审阅、可追踪、可统计的对比文档。
本 skill 可被独立调用(用户直接传入头文件名按"标准模板"产出新文档), 也可被上游驱动型 skill 在收尾阶段调用:
| 上游 skill | 调用时机 | 期望传入字段 | 处理策略 |
|---|---|---|---|
| add-compat-api | "文档归档"小节 | PCAT_ROOT / 调用模式=append-to-existing / 目标文档 / 上游模板名=对齐迭代记录 / 已填段落 | 把已填段落原样追加到目标文档尾部;联动回填本 skill 维护的对比表、## 兼容性统计、"关键差异说明" |
| fix-compat-api | "文档归档"小节 | PCAT_ROOT / 调用模式=append-to-existing / 目标文档 / 上游模板名=Compat 修复记录 / 已填段落 | 同上;额外检查"修复内容"是否涉及对比表状态符号变更(🔧 ↔ ✅),若有则同步改表 |
模板归属规则:
append-to-existing 模式下,禁止改写"已填段落"内文字(除非格式非法),
只允许在文档其他位置(对比表、统计表、关键差异说明)做关联更新。被上游调用时,本 skill 不反向调用任何上游 skill,也不触发其他 skill。 完成归档与校验后,返回结论文字(如"对齐迭代记录已追加; 兼容性统计已回填 ✅ 12 / 🔧 3 / ❌ 1;3 个 🔧 条目均已在'关键差异说明'追加小节")给上游。
typeid)TensorBase 风格doc/)✅/🔧/❌)> YYYY-MM-DD 编制/复核:...)✅/🔧/❌/🟦 含义)## 兼容性统计(简化2列表)## 关键差异说明(按序列号)## 备注(实现细节、编译依赖等)| torch API | paddle API 兼容性 | 测试用例状态 | 优先级 | 备注 |
|-----------|------------------|------------|-------|------|
约定:
paddle API 兼容性:使用符号 ✅/🔧/❌/🟦测试用例状态:使用 checkbox - [ ] 或 - [x]优先级:使用 P0/P1/P2/P3 标记
| 状态 | 数量 |
|---|---|
| ✅ 已实现 | N1 |
| 🔧 部分兼容 | N2 |
| ❌ 未实现 | N3 |
.cpp).cpp)✅:接口与语义一致🔧:接口在,但实现路径或边界行为不同❌:Torch 有、Paddle 缺失*.mdREADME.md)### 兼容性统计
| 状态 | 数量 |
|---|---|
| ✅ 已实现 | N1 |
| 🔧 部分兼容 | N2 |
| ❌ 未实现 | N3 |
发布前必须检查:
## 兼容性统计(2级标题)- [ ] / - [x].h,备注写“仅基于声明”.cpp.cpp”### 兼容性统计触发条件:verify_api_mapping.py 验证报告发现映射表分类错误或别名映射失效。
处理流程:
读取验证报告
doc/mapping/verification_output/mapping_correction_report.md修复别名映射
doc/mapping/cpp_api_alias_mapping.json修复映射表分类
doc/mapping/cpp_api_mapping_cn.md清理差异文档
验证修复结果
python doc/mapping/verify_api_mapping.py --op <api> 确认常见修复场景:
| 场景 | 修复操作 | 涉及文件 |
|---|---|---|
| API 实际为别名但标记为差异 | 移到"API 别名",更新别名映射 | cpp_api_mapping_cn.md, cpp_api_alias_mapping.json |
| API 别名映射无效(Paddle 无实现) | 移到"功能缺失",移除别名映射 | cpp_api_mapping_cn.md, cpp_api_alias_mapping.json |
| API 有 kernel 但未暴露到 api.h | 标记为 kernel_only,文档说明 | cpp_api_mapping_cn.md |
| 同一 API 出现在多个分类中 | 删除重复条目,保留正确分类 | cpp_api_mapping_cn.md |
❌ 错误:有的行用 P0,有的用 高/中/低,有的用 H/M/L
✅ 要求:全文统一用 P0/P1/P2/P3
❌ 错误:用 ✅/⚠️/❌ 或 过 / 漏
✅ 要求:全文统一用 checkbox - [ ] 和 - [x]
❌ 错误:表格有 15 行,但统计 ✅:9 + 🔧:4 = 13 ✅ 要求:逐行数清,再填入统计表
❌ 错误:只写 🔧 不说明差异在哪
✅ 要求:每个 🔧 都在"关键差异说明"中有小节说明
xxx.h 写兼容文档”