[分类名称] api 全称¶

为了文档整体的一致性，我们统一了 API 映射关系的分类名称，共分为 7 大类：

注：第 1~3 类均为 API 层面一对一映射，根据参数层面的映射关系将其细分为三类。

• 第 1 类又分为五种情况：无参数、参数完全一致、仅参数名不一致、仅 paddle 参数更多、仅参数默认值不一致。

注：分类优先级依次递增，即如果同时 参数名不一致 + 仅 paddle 参数更多，则写成后者 仅 paddle 参数更多 。

• 第 2 类为 torch 参数更多。如果 torch 和 paddle 都支持更多参数，统一写成torch 参数更多。

• 第 3 类又分为三种情况：输入参数类型不一致、输入参数用法不一致、返回参数类型不一致。

注意：这里的不一致都是从 torch 的角度来看，如果 paddle 可涵盖 torch，即 torch 是 paddle 的功能子集，则认定为一致（例如：torch 参数仅支持 list，paddle 参数支持 list/tuple），反之才认定为不一致。

• 第 4 类为 组合替代实现 ，表示该 API 没有可直接对应的 API，需要通过多个 API 组合实现。

• 第 5 类为 涉及上下文修改 ，表示涉及到上下文的分析，需要修改其他位置的代码。

举例：所有的 torch.optim.lr_scheduler.*、torch.nn.init.*、torch.nn.utils.clip* 都为该类。此类 API 由于两者在设计上具有较大的差异，需要对上下文进行分析，涉及到上下文代码的联动修改。

• 第 6 类为 可删除 。表示可直接删除该 API，则无需写差异分析文档，仅标注即可

• 第 7 类为 功能缺失 ，表示 Paddle 当前无对应 API，则无需写差异分析文档，仅标注即可。

注意：

1. 分类优先级依次递增，即如果同时 第 2 类：torch 参数更多 与 第 3 类：参数不一致 ，则写成后者 第 3 类：参数不一致 。

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

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

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

PyTorch API 签名

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

Paddle API 签名

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

参数映射¶

参数映射表的左边是PyTorch 对应参数，右边是Paddle对应参数，表格参数顺序按 PyTorch 参数顺序来。

• 如果 无参数，则没有参数映射这一栏。

• 如果 参数完全一致，无需转写示例。

• 如果 仅参数名不一致，无需转写示例，需要在备注栏里对该参数加一句 仅参数名不一致。

• 如果 仅 paddle 参数更多，无需转写示例，需要在备注栏加一句 PyTorch 无此参数，（Paddle 应如何设置此参数） 。如果默认无影响，则写 PyTorch 无此参数，Paddle 保持默认即可。

• 如果 仅参数默认值不一致，无需转写示例，需要在备注栏里加一句 与 PyTorch 默认值不同，（Paddle 应如何设置此参数） 。

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

• 如果 参数不一致，对每个不一致的参数都需要转写示例，需要在备注栏里写 （说明不一致的用法），需要转写；如确实无法转写，需要在备注里写 （说明不一致的用法），暂无转写方式。

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

转写示例¶

除第 1 类 API 映射关系较为简单，无需写转写示例，其他类 API 都需要写转写示例，否则需说明：Paddle 暂无转写方式。

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

# PyTorch 写法
torch.xxx()

# Paddle 写法
paddle.xxx()

# PyTorch 写法
torch.xxx()

# Paddle 写法
paddle.xxx()

模板 1¶

torch.Tensor.t()

paddle.Tensor.t()

模板 2¶

torch.Tensor.clip(min=None, max=None)

paddle.Tensor.clip(min=None, max=None, name=None)

模板 3¶

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

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

模板 4¶

torch.nn.ZeroPad2d(padding)

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

模板 5¶

[ 仅参数默认值不一致 ] torch.linalg.svd¶

torch.linalg.svd(A, full_matrices=True)

paddle.linalg.svd(x, full_matrices=False, name=None)

模板 6¶

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

paddle.abs(x,
           name=None)

# PyTorch 写法
torch.empty(3, 5)

# Paddle 写法
paddle.empty([3, 5])

# 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(input,
                dim0,
                dim1)

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

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

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

affine=False 时，表示不更新：

# PyTorch 写法
m = torch.nn.BatchNorm1D(24, affine=False)

# Paddle 写法
weight_attr = paddle.ParamAttr(learning_rate=0.0)
bias_attr = paddle.ParamAttr(learning_rate=0.0)
m = paddle.nn.BatchNorm1D(24, weight_attr=weight_attr, bias_attr=bias_attr)

affine=True 时，表示更新：

# PyTorch 写法
m = torch.nn.BatchNorm1D(24)

# Paddle 写法
m = paddle.nn.BatchNorm1D(24)

模板 8¶

torch.addcmul(input, tensor1, tensor2, *, value=1, out=None)

# PyTorch 写法
torch.addcmul(input, tensor1, tensor2, value=value)

# Paddle 写法
paddle.add(input, value * tensor1 * tensor2)

模板 9¶

torch.nn.utils.clip_grad_value_(parameters,
                                clip_value)

paddle.nn.ClipGradByValue(max,
                          min=None)

# torch ⽤法
net = Model()
sgd = torch.optim.SGD(net.parameters(), lr=0.1)
for i in range(10):
    loss = net(x)
    loss.backward()
    torch.nn.utils.clip_grad_value_(net.parameters(), 1.)
    sgd.step()

# paddle ⽤法
net = Model()
sgd = paddle.optim.SGD(net.parameters(), lr=0.1,
grad_clip=paddle.nn.ClipGradByValue(), 1.)
for i in range(10):
    loss = net(x)
    loss.backward()
    sgd.step()