| name | select-solution |
| description | 负责《Paddle API 对齐 PyTorch 项目》中 Step1 选择方案,分析 PyTorch API 与 Paddle API 之间的差异,制定合适的 API 改动方案 |
| disable-model-invocation | false |
一、候选方案
方案 1:Python 装饰器
适用场景:
参数顺序不同、参数个数不同、参数类型不同、参数名不同
适用条件(必须满足):
- API 路径一致
- 重载条件:两套签名必须存在参数特征差异(个数、类型、名称至少一项不同),且根据调用时传入的参数能够唯一判定应该使用哪个签名:
- 参数个数不同:如 func(a) vs func(a, b),根据传入的参数个数不同,可以唯一确定调用的是哪个函数。(默认参数可不传入,不计入个数)
- 参数类型不同:如 func(x: Tensor, y: Tensor) vs func(x: Tensor, y: int),根据传入的第二个位置参数的类型不同,可以唯一确定调用的是哪个函数。
- 参数名称不同:如 func(a, b) vs func(a, c),根据调用时使用的关键字参数名不同(如
func(a=1, b=2) vs func(a=1, c=2)),可以唯一确定调用的是哪个函数。
优点:灵活性强,兼容性好
缺点:性能低于 C++ 下沉实现
方案 2:C++ 下沉
适用场景:
仅涉及参数名不同或仅多 out 参数的情况
适用条件(必须全部满足):
- API 路径一致
- API 名称和
_C_ops.xxx 的 OP 名称一致
- ✅ 正确示例:
paddle.atan 调用 _C_ops.atan
- ❌ 错误示例:
paddle.select_scatter 调用 _C_ops.set_value_with_tensor(名称不一致)
- API 差异仅涉及以下情况之一或组合:
- 仅参数名不同
- 仅多 out 参数
- 参数名不同 + 仅多 out 参数
- ❌ 不符合:多两个及以上参数、多的参数不是
out、涉及参数顺序差异、存在其他额外参数
说明:当满足此条件时,参数名映射和 out 参数都在 C++ 层统一处理,无需额外组合其他方案。
- Python 实现中仅有一次
_C_ops.xxx 调用
- Python 实现中不涉及其他 Paddle API 调用
- ❌ 禁止:调用任何其他 paddle API(如
paddle.where、paddle.abs、paddle.flatten、paddle.full、paddle.cast 等)
- ❌ 禁止:调用 Tensor 方法(如
x.flatten()、x.reshape()、x.unsqueeze()、x.cast() 等,这些等同于调用 paddle API)
- ❌ 禁止:使用
paddle.full_like、paddle.zeros_like、paddle.cast 等
- ✅ 允许:Python 内置函数(如
len()、isinstance()、list()、range() 等)
- ✅ 允许:简单的属性访问(如
x.shape、x.dtype、x.ndim 等)
- ✅ 允许:简单的算术运算(如
index + 1、axis < 0 等)
_C_ops.xxx 前面无复杂前处理逻辑,前处理逻辑(如存在)容易改写为 C++
- ❌ 复杂前处理(不满足条件):
- 涉及多个 paddle API 调用的逻辑(如
fill_constant、paddle.where、paddle.cast 等)
- 复杂的 shape 处理逻辑(如
reshape、transpose、flatten 等)
- 条件分支中的 paddle API 调用
- 循环中的 paddle API 调用
- ✅ 简单前处理(满足条件):
- 仅做参数校验(如
isinstance()、类型检查、范围检查)
- 仅做参数类型转换(如
convert_np_dtype_to_dtype_)
- 仅做简单参数处理(如负索引转正索引、默认值设置)
- 仅做属性获取(如
x.shape、x.dtype)
优点:性能最优
缺点:限制条件很多,需严格满足
方案 3:修改原有 API
适用场景:
同方案 1(参数顺序、个数、类型、名称差异),但通过直接修改原 API 实现而非装饰器
适用条件(必须全部满足):
- API 路径一致
- 修改必须能保持后向兼容性
不适用条件(❌ 禁止):
- 改变已有参数顺序
- 改变已有参数名称
- 修改返回值类型
- 删除现有参数
- 修改现有参数的默认行为
修改模式:
- 新增参数:向现有 API 添加新参数
- 扩展参数类型/功能:对已有参数扩展新功能同时保留原有功能
方案 4:新增 API
适用场景:
- API 路径不一致
- 仅 API 调用方式不一致
- 组合替代实现
- API 别名
- 功能缺失
修改模式:
- 新增 API 别名:PyTorch API 与 Paddle API 功能完全一致,仅 API 路径/名称不同
- 新增 Python 层 API:需在 Python 层实现新 API
- 新增 OP:需在 C++ 层新增底层算子
方案 5:新增 compat 类型 API
适用条件(必须全部满足):
- API 路径一致
- 不满足方案 1/2/3 的适用条件
典型场景:
- API 路径一致,但修改原有 API 会破坏后向兼容性(如修改返回值类型)
- API 路径一致,但不满足装饰器的重载条件
不适用条件(❌ 禁止):
实现要点:
- 新增兼容 API 位于
paddle.compat.* 路径下,不影响原 Paddle API
二、标准工作流程
Step 1: 获取差异信息
三种信息源均需获取,综合判断,且遵循以下核心原则:
信息更新延迟说明:可能存在 Paddle 源码已修改,但差异文档或转写配置还未来得及更新的情况。因此需要综合三种信息源判断,源码反映真实情况。
信息 1:差异文档
查阅路径:
${ROOT_DIR}/docs/docs/guides/model_convert/convert_from_pytorch/api_difference/torch.{api_name}.md
注意事项:
- 文档可能滞后或有误:发现问题时应自行分析,或结合转写配置/Paddle 源码进一步确认
- 标题不代表全部:一个 API 可能涉及多种差异,文档标题仅反映主要分类,必须通读完整参数映射表提取所有差异,不能仅看标题
- 忽略参数规则:
- torch 侧忽略:
generator、memory_format、layout
- paddle 侧忽略:
name
- 其他参数不可忽略
信息 2:转写配置
查阅路径:
${ROOT_DIR}/PaConvert/paconvert/api_mapping.json
${ROOT_DIR}/PaConvert/paconvert/attribute_mapping.json
根据 Matcher 类型分析差异分类:
| Matcher 类型 | 对应差异分类 |
|---|
ChangePrefixMatcher | API 完全一致 |
ChangeAPIMatcher / NumelMatcher / TensorFunc2PaddleFunc / Func2Attribute / Attribute2Func | 仅 API 调用方式不一致(若同时包含 unsupport_args、kwargs_change 字段,则存在多重差异) |
GenericMatcher | 参数名不一致 / paddle 参数更多 / 参数默认值不一致 / torch 参数更多 |
| 其他自定义 Matcher | 参数用法/类型不一致 / 组合替代实现 |
根据配置字段分析差异:
| 字段名 | 对应差异分类 |
|---|
paddle_api | API 映射关系 |
kwargs_change | 参数名不一致 |
unsupport_args | torch 参数更多(部分不支持) |
paddle_default_kwargs | 参数默认值不一致 / paddle 参数更多 |
注意:更多 Matcher 类型可参考 api_matcher.py 源码分析。
信息 3:源码分析
自行获取 PyTorch API 和 Paddle API 的信息,进行对比分析。
获取方式请参考api-compatibility/SKILL.md 中的「API 信息获取方式」内容。
综合判定规则
- 优先级规则:若任意一种信息源判定为"API 完全一致",则最终结果为"API 完全一致"
- 多数一致规则:若多种信息源对同一差异点有一致的判定,采纳该判定
- 源码优先规则:当信息源之间判定不一致时,以源码分析结果为准(源码反映真实情况)
Step 2:提取差异信息
根据获取到的 PyTorch API 与 Paddle API 信息,提取以下内容:
| 项目 | 内容 |
|---|
| API 映射 | PyTorch API vs 对应的 Paddle API(可能为空) |
| 差异分类 | 可包含多种差异分类 |
| 参数映射 | 参数对应关系和差异说明 |
| 转写示例 | 代码转换示例 |
候选差异分类为:
| 序号 | 差异分类 | 说明 |
|---|
| 1 | API 完全一致 | 无差异,无需改动 |
| 2 | 仅 API 调用方式不一致 | API 路径不一致,但参数完全相同 |
| 3 | 仅参数名不一致 | 参数功能相同但参数名称不同 |
| 4 | paddle 参数更多 | Paddle 支持更多参数 |
| 5 | 参数默认值不一致 | 参数默认值不同 |
| 6 | torch 参数更多 | PyTorch 支持更多参数 |
| 7 | 输入参数用法不一致 | 参数处理方式不同 |
| 8 | 输入参数类型不一致 | 参数类型要求不同 |
| 9 | 返回参数类型不一致 | 返回值类型或结构不同 |
| 10 | 组合替代实现 | PyTorch API 需多个 Paddle API 组合实现 |
| 11 | 可删除 | PyTorch API 在 Paddle 中可直接删除 |
| 12 | API 别名 | PyTorch API 是其他 API 的别名 |
| 13 | 功能缺失 | Paddle 暂无等效实现 |
Step 3: 方案选择
3.1 判断 API 路径一致性
定义:API 路径 = 去掉框架前缀后的调用路径(包括名称)。
判断方法:执行 python -c "import paddle; paddle.{path}" 验证是否存在。
| PyTorch API | API 路径 | Paddle 对应 | 路径一致性 |
|---|
torch.trunc | trunc | paddle.trunc | ✅ 一致 |
torch.histc | histc | paddle.histogram | ❌ 不一致 |
torch.Tensor.addmv_ | Tensor.addmv_ | 无 | ❌ 不一致 |
torch.autograd.enable_grad | autograd.enable_grad | paddle.autograd.enable_grad | ✅ 一致 |
示例:
python -c "import paddle; paddle.trunc"
python -c "import paddle; paddle.addmv"
python -c "import paddle; paddle.Tensor.addmv_"
输出:记录路径一致性结果(一致/不一致),用于选择流程图。
3.2 执行选择流程
根据 3.1 的路径一致性结果选择流程图:路径不一致 → 选择流程图 A;路径一致 → 选择流程图 B。
针对每个差异分类独立执行流程图,得到对应方案:
- 仅一个差异分类 → 直接输出该方案
- 多个差异分类 → 按 3.3 规则组合
选择流程图 A:路径不一致
API 路径不一致
│
├──→ 1. API 完全一致 → 方案 4(新增 API 别名)→ 得到方案
│
├──→ 2. 仅 API 调用方式不一致 → 方案 4(新增 API 别名)→ 得到方案
│
├──→ 3. 仅参数名不一致 → 满足方案 2 条件?
│ ├──→ 是 → 方案 2(C++ 下沉)+ 方案 4(新增 API 别名)→ 得到方案
│ └──→ 否 → 方案 1(Python 装饰器)+ 方案 4(新增 API 别名)→ 得到方案
│
├──→ 4. paddle 参数更多 → 是否影响对齐?
│ ├──→ 否 → 无需修改 → 得到方案
│ └──→ 是 → 满足方案 3 条件?
│ ├──→ 是 → 方案 3(修改原有 API)+ 方案 4(新增 API 别名)→ 得到方案
│ └──→ 否 → 方案 4(新增 Python 层 API)→ 得到方案
│
├──→ 5. 参数默认值不一致 → 是否影响对齐?
│ ├──→ 否 → 无需修改 → 得到方案
│ └──→ 是 → 满足方案 3 条件?
│ ├──→ 是 → 方案 3(修改原有 API)+ 方案 4(新增 API 别名)→ 得到方案
│ └──→ 否 → 方案 4(新增 Python 层 API)→ 得到方案
│
├──→ 6. torch 参数更多
│ │
│ ├──→ 仅多 out 参数 → 满足方案 2 条件?
│ │ ├──→ 是 → 方案 2(C++ 下沉)+ 方案 4(新增 API 别名)→ 得到方案
│ │ └──→ 否 → 方案 3(修改原有 API,新增 out 参数)+ 方案 4(新增 API 别名)→ 得到方案
│ │
│ └──→ 多其他参数(非仅 out)→ 满足方案 3 条件?
│ ├──→ 是 → 方案 3(修改原有 API)+ 方案 4(新增 API 别名)→ 得到方案
│ └──→ 否 → 满足方案 1 条件?
│ ├──→ 是 → 方案 1(Python 装饰器)+ 方案 4(新增 API 别名)→ 得到方案
│ └──→ 否 → 方案 4(新增 Python 层 API)→ 得到方案
│
├──→ 7. 输入参数用法不一致 → 满足方案 3 条件?
│ ├──→ 是 → 方案 3(修改原有 API)+ 方案 4(新增 API 别名)→ 得到方案
│ └──→ 否 → 满足方案 1 条件?
│ ├──→ 是 → 方案 1(Python 装饰器)+ 方案 4(新增 API 别名)→ 得到方案
│ └──→ 否 → 方案 4(新增 Python 层 API)→ 得到方案
│
├──→ 8. 输入参数类型不一致 → 满足方案 3 条件?
│ ├──→ 是 → 方案 3(修改原有 API)+ 方案 4(新增 API 别名)→ 得到方案
│ └──→ 否 → 满足方案 1 条件?
│ ├──→ 是 → 方案 1(Python 装饰器)+ 方案 4(新增 API 别名)→ 得到方案
│ └──→ 否 → 方案 4(新增 Python 层 API)→ 得到方案
│
├──→ 9. 返回参数类型不一致 → 方案 4(新增 Python 层 API)→ 得到方案
│
├──→ 10. 组合替代实现 → 方案 4(新增 Python 层 API)→ 得到方案
│
├──→ 11. 可删除 → 无需修改 → 得到方案
│
├──→ 12. API 别名 → 方案 4(新增 API 别名)→ 得到方案
│
└──→ 13. 功能缺失 → 方案 4(新增 Python 层 API 或 C++ 算子)→ 得到方案
选择流程图 B:路径一致
API 路径一致
│
├──→ 1. API 完全一致 → 无需修改 → 得到方案
│
├──→ 2. 仅 API 调用方式不一致 → 不可能出现(路径一致时此分类不存在)
│
├──→ 3. 仅参数名不一致 → 满足方案 2 条件?
│ ├──→ 是 → 方案 2(C++ 下沉)→ 得到方案
│ └──→ 否 → 方案 1(Python 装饰器)→ 得到方案
│
├──→ 4. paddle 参数更多 → 是否影响对齐?
│ ├──→ 否 → 无需修改 → 得到方案
│ └──→ 是 → 满足方案 3 条件?
│ ├──→ 是 → 方案 3(修改原有 API)→ 得到方案
│ └──→ 否 → 方案 5(新增 compat 类型 API)→ 得到方案
│
├──→ 5. 参数默认值不一致 → 是否影响对齐?
│ ├──→ 否 → 无需修改 → 得到方案
│ └──→ 是 → 满足方案 3 条件?
│ ├──→ 是 → 方案 3(修改原有 API)→ 得到方案
│ └──→ 否 → 方案 5(新增 compat 类型 API)→ 得到方案
│
├──→ 6. torch 参数更多
│ │
│ ├──→ 仅多 out 参数 → 满足方案 2 条件?
│ │ ├──→ 是 → 方案 2(C++ 下沉)→ 得到方案
│ │ └──→ 否 → 方案 3(修改原有 API,新增 out 参数)→ 得到方案
│ │
│ └──→ 多其他参数(非仅 out)→ 满足方案 3 条件?
│ ├──→ 是 → 方案 3(修改原有 API)→ 得到方案
│ └──→ 否 → 满足方案 1 条件?
│ ├──→ 是 → 方案 1(Python 装饰器)→ 得到方案
│ └──→ 否 → 方案 5(新增 compat 类型 API)→ 得到方案
│
├──→ 7. 输入参数用法不一致 → 满足方案 3 条件?
│ ├──→ 是 → 方案 3(修改原有 API)→ 得到方案
│ └──→ 否 → 满足方案 1 条件?
│ ├──→ 是 → 方案 1(Python 装饰器)→ 得到方案
│ └──→ 否 → 方案 5(新增 compat 类型 API)→ 得到方案
│
├──→ 8. 输入参数类型不一致 → 满足方案 3 条件?
│ ├──→ 是 → 方案 3(修改原有 API)→ 得到方案
│ └──→ 否 → 满足方案 1 条件?
│ ├──→ 是 → 方案 1(Python 装饰器)→ 得到方案
│ └──→ 否 → 方案 5(新增 compat 类型 API)→ 得到方案
│
├──→ 9. 返回参数类型不一致 → 方案 5(新增 compat 类型 API)→ 得到方案
│
├──→ 10. 组合替代实现 → 不可能出现(路径一致时此分类不存在)
│
├──→ 11. 可删除 → 无需修改 → 得到方案
│
├──→ 12. API 别名 → 不可能出现(路径一致时此分类不存在)
│
└──→ 13. 功能缺失 → 不可能出现(路径一致时此分类不存在)
3.3 多差异分类组合选择
当 API 存在多个差异分类时,逐个差异分类独立查阅流程图,再合并方案。
合并规则:
| 规则 | 条件 | 操作 |
|---|
| 去重 | 多个差异分类对应相同方案 | 只保留一个 |
| 互斥 | 方案 2 与方案 1 同时出现 | 仅保留方案 2 |
| 组合 | 不同方案且不互斥 | 按编号升序,用 + 连接 |
示例:
| API | 差异分类 | 查流程图结果 | 合并结果 |
|---|
| torch.atan | 参数名不一致 + torch 参数更多(仅多 out 参数) | 参数名不一致 → 方案 2;torch 参数更多(仅多 out 参数) → 方案 2 | 方案 2(去重) |
| torch.logspace | 参数名不一致 + torch 参数更多 | 参数名不一致 → 方案 1;torch 参数更多 → 方案 3 | 方案 3 + 方案 1 |
三、输出要求
重要:本 SKILL 以 agent 模式执行,上下文不共享。完成选择后,必须按以下格式输出完整信息,供后续步骤使用。
输出格式
### [序号] PyTorch API 名称
**基本信息**
- PyTorch API:`完整签名`
- Paddle API:`完整签名`(如无对应则填"无")
- 实现位置:`文件路径:行号`(如未获取则填"未获取")
**差异分析**
- API 路径一致性:一致 / 不一致
- 差异分类:`分类名称`(多个分类用" + "连接)
- 具体差异:
- 参数名映射:`torch 参数 → paddle 参数`(如有)
- 额外参数:torch 多出 `xxx, yyy`(如有)
- 参数类型:`参数名: torch 类型 vs paddle 类型`(如有)
**方案选择**
- 选择方案:`方案 N(方案名称)` 或 `方案 N1 + 方案 N2`
- 选择理由:`简述选择理由`
- 组合说明:`分别说明各方案解决的差异点`(仅组合方案需要)
示例
示例 1:单方案
### [1] torch.atan
**基本信息**
- PyTorch API:`torch.atan(input, *, out=None)`
- Paddle API:`paddle.atan(x, name=None, *, out=None)`
- 实现位置:`python/paddle/tensor/math.py:45`
**差异分析**
- API 路径一致性:一致
- 差异分类:参数名不一致 + torch 参数更多(仅多 out 参数)
- 具体差异:
- 参数名映射:`input → x`
- 额外参数:torch 多出 `out`
**方案选择**
- 选择方案:方案 2(C++ 下沉)
- 选择理由:API 路径一致;差异为"参数名不同 + 仅多 out 参数",满足方案 2 条件 3;且满足 C++ 下沉全部其他条件(调用 `_C_ops.atan`、无其他 Paddle API 调用、无复杂前处理)。
示例 2:组合方案
### [2] torch.logspace
**基本信息**
- PyTorch API:`torch.logspace(start, end, steps, base=10.0, *, out=None, dtype=None, layout=None, device=None, requires_grad=False)`
- Paddle API:`paddle.logspace(start, stop, num, base=10.0, dtype=None, name=None)`
- 实现位置:`python/paddle/tensor/creation.py:557-749`
**差异分析**
- API 路径一致性:一致
- 差异分类:参数名不一致 + torch 参数更多(多 out/device/requires_grad 等参数)
- 具体差异:
- 参数名映射:`end → stop, steps → num`
- 额外参数:torch 多出 `out, device, requires_grad`
**方案选择**
- 选择方案:方案 3 + 方案 1
- 选择理由:API 路径一致;新增 out/device/requires_grad 参数可保持后向兼容;参数名差异需通过装饰器适配。
- 组合说明:方案 3 处理 torch 参数更多(新增参数);方案 1 处理参数名不一致。
四、注意事项
读取或修改 Python 实现时,忽略静态图部分(LayerHelper 分支代码不再维护)
五、常见问题处理
Q1:为什么 torch.histc 不能选择方案 5?
答:方案 5(新增 compat 类型 API)要求 API 路径一致。torch.histc 对应的 Paddle API 是 paddle.histogram,API 路径不一致(histc vs histogram),所以必须选择方案 4。
Q2:API 路径不一致时,方案 1/2/3 还能用吗?
答:可以组合使用,但执行顺序很重要:
- 先执行方案 1/2/3:修改原 Paddle API(如新增参数、适配参数名等)
- 再执行方案 4:新增 API 别名指向修改后的原 API
示例:torch.histc vs paddle.histogram
- 步骤 1:方案 3 修改
paddle.histogram,新增 out 参数支持
- 步骤 2:方案 4 新增
paddle.histc 作为 paddle.histogram 的别名
输出方案:方案 3 + 方案 4(新增 API 别名)