Skip to content

Commit

Permalink
易用性提升已修改的58个API核对 - part1 (PaddlePaddle#6848)
Browse files Browse the repository at this point in the history
  • Loading branch information
NKNaN authored and molly committed Sep 4, 2024
1 parent 0f1efa3 commit 026ba06
Show file tree
Hide file tree
Showing 6 changed files with 11 additions and 23 deletions.
2 changes: 1 addition & 1 deletion docs/api/paddle/all_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ all

参数
:::::::::
- **x** (Tensor)- 输入变量为多维 Tensor,数据类型为 bool。
- **x** (Tensor)- 输入变量为多维 Tensor,数据类型为 bool、float32、float64、int32、int64
- **axis** (int | list | tuple,可选)- 计算逻辑与运算的维度。如果为 None,则计算所有元素的逻辑与并返回包含单个元素的 Tensor 变量,否则必须在 :math:`[−rank(x),rank(x)]` 范围内。如果 :math:`axis [i] <0`,则维度将变为 :math:`rank+axis[i]`,默认值为 None。
- **keepdim** (bool,可选) - 是否在输出 Tensor 中保留减小的维度。除非 keepdim 为 True,否则输出 Tensor 的维度将比输入 Tensor 小一维,默认值为 False。
- **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name`,一般无需设置,默认值为 None。
Expand Down
2 changes: 1 addition & 1 deletion docs/api/paddle/any_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ any

参数
:::::::::
- **x** (Tensor) - 输入变量为多维 Tensor,数据类型为 bool。
- **x** (Tensor) - 输入变量为多维 Tensor,数据类型为 bool、float32、float64、int32、int64
- **axis** (int|list|tuple,可选) - 计算逻辑或运算的维度。如果为 None,则计算所有元素的逻辑或并返回包含单个元素的 Tensor,否则必须在 :math:`[−rank(x),rank(x)]` 范围内。如果 :math:`axis [i] <0`,则维度将变为 :math:`rank+axis[i]`,默认值为 None。
- **keepdim** (bool,可选) - 是否在输出 Tensor 中保留输入的维度。除非 keepdim 为 True,否则输出 Tensor 的维度将比输入 Tensor 小一维,默认值为 False。
- **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name`,一般无需设置,默认值为 None。
Expand Down
7 changes: 2 additions & 5 deletions docs/api/paddle/floor_divide_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ floor_divide

.. py:function:: paddle.floor_divide(x, y, name=None)
逐元素整除算子,将输入 ``x`` 与输入 ``y`` 逐元素整除(商被朝 0 方向舍入到最接近的整数值),并将各个位置的输出元素保存到返回结果中。
逐元素整除算子,将输入 ``x`` 与输入 ``y`` 逐元素整除(商被朝 -inf 方向舍入到最接近的整数值),并将各个位置的输出元素保存到返回结果中。

.. note::
输入 ``x`` 与输入 ``y`` 必须和广播为相同形状,关于广播规则,请参见 `Tensor 介绍`_ .
Expand All @@ -15,14 +15,11 @@ floor_divide
等式为:

.. math::
Out = trunc(X / Y)
Out = floor(X / Y)
- :math:`X`:多维 Tensor。
- :math:`Y`:多维 Tensor。

注意
:::::::::
`floor_divide`的名称可能带来误导,因为商被向零而非向负无穷舍入。

参数
:::::::::
Expand Down
2 changes: 1 addition & 1 deletion docs/api/paddle/round__cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
round\_
-------------------------------

.. py:function:: paddle.round_(x, name=None)
.. py:function:: paddle.round_(x, decimals=0, name=None)
Inplace 版本的 :ref:`cn_api_paddle_round` API,对输入 `x` 采用 Inplace 策略。

Expand Down
2 changes: 1 addition & 1 deletion docs/api/paddle/round_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
round
-------------------------------

.. py:function:: paddle.round(x, name=None)
.. py:function:: paddle.round(x, decimals=0, name=None)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,27 +21,18 @@ PyTorch 相比 Paddle 支持更多其他参数,具体如下:
| PyTorch | PaddlePaddle | 备注 |
| ------------- | ------------ | ------------------------------------------------------ |
| input | x | 输入的 Tensor ,仅参数名不一致。 |
| decimals | - | 要舍入到的小数位数,Paddle 无此参数,需要转写|
| decimals | decimals | 要舍入到的小数位数。 |
| out | - | 表示输出的 Tensor,Paddle 无此参数,需要转写。 |


### 转写示例
#### decimals:要舍入到的小数位数
```python
# PyTorch 写法
torch.round([3.345, 5.774], decimals=2)

# Paddle 写法
paddle.round(1e2 * [3.345, 5.774]) / 1e2

# 注:Paddle 可使用 10 的 decimals 次方来实现
```

#### out:指定输出
```python
# PyTorch 写法
torch.round([3, 5], out=y)
x = torch.tensor([3, 5])
torch.round(x, out=y)

# Paddle 写法
paddle.assign(paddle.round([3, 5]), y)
x = paddle.to_tensor([3, 5])
paddle.assign(paddle.round(x), y)
```

0 comments on commit 026ba06

Please sign in to comment.