[分类名称] api 全称

由于 API 映射关系的复杂性，为了保证文档格式的规范性，我们将所有 API 映射关系分为 12 类，并制定了统一的 分类名称：

1. 参数与 API 名均一致

2. 参数一致但 API 名不一致

3. 仅参数名不一致

4. paddle 参数更多

5. 参数默认值不一致

6. torch 参数更多

7. 输入参数用法不一致

8. 输入参数类型不一致

9. 返回参数类型不一致

10. 组合替代实现

11. 可删除

12. 功能缺失

注意：

1. 分类的优先级依次递增，例如：如果同时 仅参数名不一致 + paddle 参数更多，则分类为后者 paddle 参数更多 ，如果同时 paddle 参数更多 + torch 参数更多，则分类为后者 torch 参数更多。

2. 输入参数用法不一致、输入参数类型不一致、返回参数类型不一致 其中的不一致都是从 torch 的角度来看，只要 torch 能被 paddle 全覆盖，则将其视作一致（例如：torch 参数仅支持 list 用法，而 paddle 参数支持 list/tuple 用法，则视作用法一致），如果 torch 无法被 paddle 全覆盖，才认定为 不一致。

3. 可删除 表示转写时可直接删除该 API，并不会对代码运行结果有影响，无需写映射文档，仅标注即可。功能缺失 表示 Paddle 当前无对应 API 功能，则无需写映射文档，仅标注即可。

4. 所有的 Paddle API 无需关注 name 参数，直接忽略即可。

5. 将类成员 API 映射为非类成员 API，则无需对比第一个参数。例如将 torch.Tensor.outer(vec2) 映射为 paddle.outer(x, y)，则忽略 paddle 的第一个参数 x ，直接从 torch 的 vec2 和 paddle 的 y 开始对比参数。

[pytorch api 全称] (pytorch api 链接)

PyTorch API 签名

[paddle api 全称] (paddle api 链接)

Paddle API 签名

一句话总结。整体概述总结两个 API 的差异。例如 输入参数用法不一致 ，需要简述下有参数哪些用法不一致的地方。在描写参数时，需要用 ` ` 来加深其底色。

参数映射

参数映射以表格的形式呈现，表格的第 1 列是PyTorch 所有参数，第 2 列是Paddle对应参数，表格顺序按第 1 列 PyTorch 的参数顺序来。

1. 参数与 API 名均一致：无需映射文档与转写示例。

2. 参数一致但 API 名不一致：无需映射文档与转写示例。

3. 仅参数名不一致：无需转写示例，但需要在备注列里注明哪些参数 仅参数名不一致。

4. paddle 参数更多：无需转写示例，但需要在备注列里注明 PyTorch 无此参数，[Paddle 应如何设置此参数]。如果无需特殊设置，则写 PyTorch 无此参数，Paddle 保持默认即可。

5. 参数默认值不一致：无需转写示例，但需要在备注列里注明 参数默认值不一致，[Paddle 应如何设置此参数，设置为多少]。

6. torch 参数更多：对每个 torch 多的参数都需要转写示例，同时需要在备注列里注明 Paddle 无此参数，需要转写 ；如确实无法转写，则注明 Paddle 无此参数，暂无转写方式 ；若可直接删除，则需要写 Paddle 无此参数，一般对网络训练结果影响不大，可直接删除 。

7. 输入参数用法不一致、输入参数类型不一致、返回参数类型不一致：对每个不一致的参数都需要转写示例，同时需要在备注列里注明 [不一致的用法说明]，需要转写；如确实无法转写，需要在备注里写 [不一致的用法说明]，暂无转写方式。

8. 组合替代实现：无需参数映射，需要写 转写示例 。

9. 每个备注都需要以句号结尾。

转写示例

转写示例需要写得精简和一目了然。一般情形下只需写两行代码，无需打印各种结果，需要保证转写前后的输出结果是一致的。另外需要先描述下转写的是 torch api 的哪个参数及其功能。

# PyTorch 写法
torch.xxx()

# Paddle 写法
paddle.xxx()

# PyTorch 写法
torch.xxx()

# Paddle 写法
paddle.xxx()

分类 3：仅参数名不一致

torch.dist(input,
           other,
           p=2)

paddle.dist(x,
            y,
            p=2)

分类 4：paddle 参数更多

torch.nn.ZeroPad2d(padding)

paddle.nn.ZeroPad2D(padding,
                    data_format='NCHW',
                    name=None)

分类 5：参数默认值不一致

torch.linalg.diagonal(A, *, offset=0, dim1=-2, dim2=-1)

paddle.diagonal(x,
                offset=0,
                axis1=0,
                axis2=1,
                name=None)

分类 6：torch 参数更多

torch.abs(input,
          *,
          out=None)

paddle.abs(x,
           name=None)

# PyTorch 写法
torch.abs([-3, -5], out=y)

# Paddle 写法
paddle.assign(paddle.abs([-3, -5]), y)

# PyTorch 写法
torch.zeros_like(x, device=torch.device('cpu'))

# Paddle 写法
y = paddle.zeros_like(x)
y.cpu()

# PyTorch 写法
x = torch.zeros_like(x, requires_grad=True)

# Paddle 写法
x = paddle.zeros_like(x)
x.stop_gradient = False

# PyTorch 写法
x = torch.empty_like((2, 3), pin_memory=True)

# Paddle 写法
x = paddle.empty_like([2, 3]).pin_memory()

# PyTorch 的 size_average、reduce 参数转为 Paddle 的 reduction 参数
if size_average is None:
    size_average = True
if reduce is None:
    reduce = True

if size_average and reduce:
    reduction = 'mean'
elif reduce:
    reduction = 'sum'
else:
    reduction = 'none'

分类 7：输入参数用法不一致

[ 输入参数用法不一致 ] torch.transpose

torch.transpose(input,
                dim0,
                dim1)

paddle.transpose(x,
                 perm,
                 name=None)

# PyTorch 写法:
torch.transpose(x, dim0=0, dim1=1)

# Paddle 写法:
paddle.transpose(x, perm=[1, 0, 2])

# 注：x 为 3D Tensor

分类 8：输入参数类型不一致

torch.broadcast_tensors(*tensors)

paddle.broadcast_tensors(inputs,
                         name=None)

# PyTorch 写法
torch.broadcast_tensors(x, y)

# Paddle 写法
paddle.broadcast_tensors([x, y])

分类 9：返回参数类型不一致

torch.equal(input,
            other)

paddle.equal_all(x,
                 y,
                 name=None)

# PyTorch 写法
out = torch.equal(x, y)

# Paddle 写法
out = paddle.equal_all(x, y)
out = out.item()

分类 10：组合替代实现

torch.aminmax(input, *, dim=None, keepdim=False, out=None)

# PyTorch 写法
y = torch.aminmax(input, dim=-1, keepdim=True)

# Paddle 写法
y = tuple([paddle.amin(input, axis=-1, keepdim=True), paddle.amax(input, axis=-1, keepdim=True)])