Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 7 additions & 3 deletions docs/api/paddle/logaddexp_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
logaddexp
-------------------------------

.. py:function:: paddle.logaddexp(x, y, name=None)
.. py:function:: paddle.logaddexp(x, y, name=None, *, out=None)

计算 ``x`` 和 ``y`` 的以 e 为底的指数的和的自然对数。计算公式如下:

Expand All @@ -12,10 +12,14 @@ logaddexp

参数
::::::::::
- **x** (Tensor) - 输入的 Tensor,数据类型为:int32,int64,bfloat16,float16,float32、float64。
- **y** (Tensor) - 输入的 Tensor,数据类型为:int32,int64,bfloat16,float16,float32、float64。
- **x** (Tensor) - 输入的 Tensor,数据类型为:int32,int64,bfloat16,float16,float32、float64。别名 ``input``。
- **y** (Tensor) - 输入的 Tensor,数据类型为:int32,int64,bfloat16,float16,float32、float64。别名 ``other``。
- **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name`,一般无需设置,默认值为 None。

关键字参数
::::::::::
- **out** (Tensor,可选) - 输出 Tensor,若不为 ``None``,计算结果将保存在该 Tensor 中,默认值为 ``None``。

返回
::::::::::
``Tensor``,根据上述公式计算的 logaddexp(x) 结果
Expand Down
12 changes: 9 additions & 3 deletions docs/api/paddle/logspace_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
logspace
-------------------------------

.. py:function:: paddle.logspace(start, stop, num, base=10.0, dtype=None, name=None)
.. py:function:: paddle.logspace(start, stop, num, base=10.0, dtype=None, name=None, *, out=None, device=None, requires_grad=False)

返回一个 Tensor,Tensor 的值为在区间 :math:`[base^{start}, base^{stop}]` 上按对数均匀间隔的 :math:`num` 个值,输出 Tensor 的长度为 num。

Expand All @@ -14,12 +14,18 @@ logspace
::::::::::::

- **start** (int|float|Tensor) – ``start`` 是区间开始值以 ``base`` 为底的指数,可以是一个标量,或是一个 shape 为 [] 的 0-D Tensor,该 Tensor 的数据类型可以是 float32、float64、int32 或者 int64。
- **stop** (int|float|Tensor) – ``stop`` 是区间结束值以 ``base`` 为底的指数,可以是一个标量,或是一个 shape 为 [] 的 0-D Tensor,该 Tensor 的数据类型可以是 float32、float64、int32 或者 int64。
- **num** (int|Tensor) – ``num`` 是给定区间内需要划分的区间数,可以是一个整型标量,或是一个 shape 为 [] 的 0-D Tensor,该 Tensor 的数据类型需为 int32。
- **stop** (int|float|Tensor) – ``stop`` 是区间结束值以 ``base`` 为底的指数,可以是一个标量,或是一个 shape 为 [] 的 0-D Tensor,该 Tensor 的数据类型可以是 float32、float64、int32 或者 int64。别名 ``end``。
- **num** (int|Tensor) – ``num`` 是给定区间内需要划分的区间数,可以是一个整型标量,或是一个 shape 为 [] 的 0-D Tensor,该 Tensor 的数据类型需为 int32。别名 ``steps``。
- **base** (int|float|Tensor) – ``base`` 是对数函数的底数,可以是一个标量,或是一个 shape 为 [] 的 0-D Tensor,该 Tensor 的数据类型可以是 float32、float64、int32 或者 int64。
- **dtype** (str|paddle.dtype|np.dtype,可选) – 输出 Tensor 的数据类型,可以是 float32、float64、int32 或者 int64。如果 dtype 的数据类型为 None,输出 Tensor 数据类型为 float32。
- **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name`,一般无需设置,默认值为 None。

关键字参数
::::::::::::
- **out** (Tensor,可选) - 输出 Tensor,若不为 ``None``,计算结果将保存在该 Tensor 中,默认值为 ``None``。
- **device** (str|paddle.CUDAPlace|paddle.CPUPlace,可选) - 指定输出 Tensor 所在的设备,默认值为 ``None``,表示使用当前默认设备。
- **requires_grad** (bool,可选) - 是否需要计算梯度,若为 ``True``,则输出 Tensor 的 ``stop_gradient`` 属性将被设置为 ``False``,默认值为 ``False``。


返回
::::::::::::
Expand Down
2 changes: 1 addition & 1 deletion docs/api/paddle/moveaxis_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ moveaxis
:width: 600
参数
:::::::::
- **x** (Tensor) - 输入的 N-D Tensor,数据类型为:bool、int32、int64、float32、float64、complex64、complex128。
- **x** (Tensor) - 输入的 N-D Tensor,数据类型为:bool、int32、int64、float32、float64、complex64、complex128。别名 ``input``。
- **source** (int|tuple|list) - 将被移动的轴的位置,其每个元素必须为不同的整数。
- **destination** (int|tuple|list) - 轴被移动后的目标位置,其每个元素必须为不同的整数。
- **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name`,一般无需设置,默认值为 None。
Expand Down
8 changes: 6 additions & 2 deletions docs/api/paddle/nan_to_num_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,18 +3,22 @@
nan_to_num
-------------------------------

.. py:function:: paddle.nan_to_num(x, nan=0.0, posinf=None, neginf=None, name=None)
.. py:function:: paddle.nan_to_num(x, nan=0.0, posinf=None, neginf=None, name=None, *, out=None)

替换 x 中的 NaN、+inf、-inf 为指定值。

参数
:::::::::
- **x** (Tensor) - 输入变量,类型为 Tensor, 支持 float32、float64 数据类型。
- **x** (Tensor) - 输入变量,类型为 Tensor, 支持 float32、float64 数据类型。别名 ``input``。
- **nan** (float,可选) - NaN 的替换值,默认为 0。
- **posinf** (float,可选) - +inf 的替换值,默认为 None,表示使用输入 Tensor 的数据类型所能表示的最大值作为 +inf 的替换值。
- **neginf** (float,可选) - -inf 的替换值,默认为 None,表示使用输入 Tensor 的数据类型所能表示的最小值作为 -inf 的替换值。
- **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name` ,一般无需设置,默认值为 None。

关键字参数
:::::::::
- **out** (Tensor,可选) - 输出 Tensor,若不为 ``None``,计算结果将保存在该 Tensor 中,默认值为 ``None``。

返回
:::::::::
- Tensor (Tensor),将输入 Tensor 中的 NaN、+inf、-inf 替换后的结果。
Expand Down
11 changes: 8 additions & 3 deletions docs/api/paddle/nanmean_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,18 +3,23 @@
nanmean
-------------------------------

.. py:function:: paddle.nanmean(x, axis=None, keepdim=False, name=None)
.. py:function:: paddle.nanmean(x, axis=None, keepdim=False, name=None, dtype=None, *, out=None)



沿 ``axis`` 计算 ``x`` 的平均值,且忽略掉 ``NaNs`` 值。

参数
::::::::::
- **x** (Tensor) - 输入的 Tensor,数据类型为:bfloat16、float16、float32、float64。
- **axis** (int|list|tuple,可选) - 指定对 ``x`` 进行计算的轴。``axis`` 可以是 int、list(int)、tuple(int)。如果 ``axis`` 包含多个维度,则沿着 ``axis`` 中的所有轴进行计算。``axis`` 或者其中的元素值应该在范围[-D, D)内,D 是 ``x`` 的维度。如果 ``axis`` 或者其中的元素值小于 0,则等价于 :math:`axis + D`。如果 ``axis`` 是 None,则对 ``x`` 的全部元素计算平均值。默认值为 None。
- **x** (Tensor) - 输入的 Tensor,数据类型为:bfloat16、float16、float32、float64。别名 ``input``。
- **axis** (int|list|tuple,可选) - 指定对 ``x`` 进行计算的轴。``axis`` 可以是 int、list(int)、tuple(int)。如果 ``axis`` 包含多个维度,则沿着 ``axis`` 中的所有轴进行计算。``axis`` 或者其中的元素值应该在范围[-D, D)内,D 是 ``x`` 的维度。如果 ``axis`` 或者其中的元素值小于 0,则等价于 :math:`axis + D`。如果 ``axis`` 是 None,则对 ``x`` 的全部元素计算平均值。默认值为 None。别名 ``dim``。
- **keepdim** (bool,可选) - 是否在输出 Tensor 中保留减小的维度。如果 ``keepdim`` 为 True,则输出 Tensor 和 ``x`` 具有相同的维度(减少的维度除外,减少的维度的大小为 1)。否则,输出 Tensor 的形状会在 ``axis`` 上进行 squeeze 操作。默认值为 False。
- **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name`,一般无需设置,默认值为 None。
- **dtype** (str|paddle.dtype|np.dtype,可选) - 输出 Tensor 的数据类型,若为 None,则与输入 ``x`` 相同,默认值为 None。

关键字参数
::::::::::
- **out** (Tensor,可选) - 输出 Tensor,若不为 ``None``,计算结果将保存在该 Tensor 中,默认值为 ``None``。

返回
::::::::::
Expand Down
10 changes: 7 additions & 3 deletions docs/api/paddle/nansum_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,18 +3,22 @@
nansum
-------------------------------

.. py:function:: paddle.nansum(x, axis=None, dtype=None, keepdim=False, name=None)
.. py:function:: paddle.nansum(x, axis=None, dtype=None, keepdim=False, name=None, *, out=None)

计算给定轴上的元素之和,并将非数字元素(NaNs)视为 0。

参数
:::::::::
- **x** (Tensor) - 输入的 Tensor,数据类型为:bfloat16、float16、float32、float64、int32 或 int64。
- **axis** (int|list|tuple,可选) - 求和运算的维度。如果为 None,则计算所有元素的和并返回包含单个元素的 Tensor 变量,否则必须在 :math:`[−rank(x),rank(x)]` 范围内。如果 :math:`axis [i] <0`,则维度将变为 :math:`rank+axis[i]`,默认值为 None。
- **x** (Tensor) - 输入的 Tensor,数据类型为:bfloat16、float16、float32、float64、int32 或 int64。别名 ``input``。
- **axis** (int|list|tuple,可选) - 求和运算的维度。如果为 None,则计算所有元素的和并返回包含单个元素的 Tensor 变量,否则必须在 :math:`[−rank(x),rank(x)]` 范围内。如果 :math:`axis [i] <0`,则维度将变为 :math:`rank+axis[i]`,默认值为 None。别名 ``dim``。
- **dtype** (str|paddle.dtype|np.dtype,可选) - 输出变量的数据类型。若参数为空,则输出变量的数据类型和输入变量相同,默认值为 None。
- **keepdim** (bool) - 是否在输出 Tensor 中保留减小的维度。如 keepdim 为 True,否则结果 Tensor 的维度将比输入 Tensor 小,默认值为 False。
- **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name`,一般无需设置,默认值为 None。

关键字参数
:::::::::
- **out** (Tensor,可选) - 输出 Tensor,若不为 ``None``,计算结果将保存在该 Tensor 中,默认值为 ``None``。

返回
:::::::::
``Tensor``,在指定维度上进行求和运算的 Tensor,数据类型和输入数据类型一致。
Expand Down
8 changes: 6 additions & 2 deletions docs/api/paddle/sgn_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,17 +3,21 @@
sgn
-------------------------------

.. py:function:: paddle.sgn(x, name=None)
.. py:function:: paddle.sgn(x, name=None, *, out=None)

对于复数 Tensor,此函数返回一个新的 Tensor,其元素与 input 元素的角度相同且绝对值为 1。

对于实数 Tensor,对输入参数 ``x`` 中每个元素进行正负判断,并且输出正负判断值:1 代表正,-1 代表负,0 代表零。

参数
::::::::::::
- **x** (Tensor) – 输入 Tensor,数据类型为 float16、float32、float64、complex64 或 complex128。
- **x** (Tensor) – 输入 Tensor,数据类型为 float16、float32、float64、complex64 或 complex128。别名 ``input``。
- **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name`,一般无需设置,默认值为 None。

关键字参数
::::::::::::
- **out** (Tensor,可选) - 输出 Tensor,若不为 ``None``,计算结果将保存在该 Tensor 中,默认值为 ``None``。

返回
::::::::::::
Tensor,输出正负号或复数的单位向量,数据的 shape 大小及数据类型和输入 ``x`` 一致。
Expand Down
8 changes: 6 additions & 2 deletions docs/api/paddle/signbit_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,19 @@
signbit
-------------------------------

.. py:function:: paddle.signbit(x, name=None)
.. py:function:: paddle.signbit(x, name=None, *, out=None)

对输入参数 ``x`` 的每个元素判断是否设置了其符号位,并输出判断值。若存在符号位,则输出 True,否则输出 False。

参数
::::::::::::
- **x** (Tensor) – 进行符号位判断的多维 Tensor,数据类型为 uint8,int8,int16,int32,int64,bfloat16,float16,float32 或 float64。
- **x** (Tensor) – 进行符号位判断的多维 Tensor,数据类型为 uint8,int8,int16,int32,int64,bfloat16,float16,float32 或 float64。别名 ``input``。
- **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name`,一般无需设置,默认值为 None。

关键字参数
::::::::::::
- **out** (Tensor,可选) - 输出 Tensor,若不为 ``None``,计算结果将保存在该 Tensor 中,默认值为 ``None``。

返回
::::::::::::
Tensor,输出掩码,数据的 shape 大小及数据类型和输入 ``x`` 一致。
Expand Down
12 changes: 6 additions & 6 deletions docs/api/paddle/slice_scatter_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,12 +16,12 @@ slice_scatter

参数
:::::::::
- **x** (Tensor) - 输入的 Tensor 作为目标矩阵,数据类型为: ``bool``、 ``float16``、 ``float32``、 ``float64``、 ``uint8``、 ``int8``、 ``int16``、 ``int32``、 ``int64``、 ``bfloat16``、 ``complex64``、 ``complex128``。
- **value** (Tensor) - 需要插入的值,数据类型为: ``bool``、 ``float16``、 ``float32``、 ``float64``、 ``uint8``、 ``int8``、 ``int16``、 ``int32``、 ``int64``、 ``bfloat16``、 ``complex64``、 ``complex128``。
- **axes** (list|tuple) - 指定沿着哪几个维度嵌入对应的值。
- **starts** (list|tuple) - 嵌入的起始索引。
- **ends** (list|tuple) - 嵌入的截止索引。
- **strides** (list|tuple) - 嵌入的步长。
- **x** (Tensor) - 输入的 Tensor 作为目标矩阵,数据类型为: ``bool``、 ``float16``、 ``float32``、 ``float64``、 ``uint8``、 ``int8``、 ``int16``、 ``int32``、 ``int64``、 ``bfloat16``、 ``complex64``、 ``complex128``。别名 ``input``。
- **value** (Tensor) - 需要插入的值,数据类型为: ``bool``、 ``float16``、 ``float32``、 ``float64``、 ``uint8``、 ``int8``、 ``int16``、 ``int32``、 ``int64``、 ``bfloat16``、 ``complex64``、 ``complex128``。别名 ``src``。
- **axes** (int|list|tuple) - 指定沿着哪几个维度嵌入对应的值。别名 ``dim``
- **starts** (int|list|tuple) - 嵌入的起始索引。别名 ``start``
- **ends** (int|list|tuple) - 嵌入的截止索引。别名 ``end``
- **strides** (int|list|tuple) - 嵌入的步长。别名 ``step``
Comment on lines +21 to +24
- **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name`,一般无需设置,默认值为 ``None``。

返回
Expand Down
2 changes: 1 addition & 1 deletion docs/api/paddle/take_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ take
参数
:::::::::

- **x** (Tensor) - 输入的 Tensor,支持 int32、int64、float32、float64 数据类型。
- **x** (Tensor) - 输入的 Tensor,支持 int32、int64、float32、float64 数据类型。别名 ``input``。
- **index** (Tensor) - 索引矩阵,支持 int32、int64 数据类型。
- **mode** (str,可选) - 索引越界处理,可选 ``'raise'``,``'wrap'``,``'clip'``,默认为 ``'raise'``。

Expand Down
12 changes: 8 additions & 4 deletions docs/api/paddle/tensordot_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
tensordot
-------------------------------

.. py:function:: paddle.tensordot(x, y, axes=2, name=None)
.. py:function:: paddle.tensordot(x, y, axes=2, name=None, *, out=None)

Tensor 缩并运算(Tensor Contraction),即沿着 axes 给定的多个轴对两个 Tensor 对应元素的乘积进行加和操作。

Expand All @@ -20,9 +20,9 @@ shape = [2,2,3]的 ``res`` 张量为 a,b 两个张量沿着 a 张量的最后一
参数
::::::::::::

- **x** (Tensor)- 缩并运算操作的左 Tensor,数据类型为 ``float16`` 或 ``float32`` 或 ``float64``。
- **y** (Tensor)- 缩并运算操作的右 Tensor,与 ``x`` 具有相同的数据类型。
- **axes** (int|tuple|list|Tensor)- 指定对 ``x`` 和 ``y`` 做缩并运算的轴,默认值为整数 2。
- **x** (Tensor)- 缩并运算操作的左 Tensor,数据类型为 ``float16`` 或 ``float32`` 或 ``float64``。别名 ``a``。
- **y** (Tensor)- 缩并运算操作的右 Tensor,与 ``x`` 具有相同的数据类型。别名 ``b``。
- **axes** (int|tuple|list|Tensor)- 指定对 ``x`` 和 ``y`` 做缩并运算的轴,默认值为整数 2。别名 ``dims``。

1. ``axes`` 可以是一个非负整数。若输入的是一个整数 ``n``,则表示对 ``x`` 的后 ``n`` 个轴和对 ``y`` 的前 ``n`` 个轴进行缩并运算。

Expand All @@ -33,6 +33,10 @@ shape = [2,2,3]的 ``res`` 张量为 a,b 两个张量沿着 a 张量的最后一
4. ``axes`` 可以是一个 Tensor,这种情况下该 Tensor 会被转换成 list,然后应用前述规则确定做缩并运算的轴。请注意,输入 Tensor 类型的 ``axes`` 只在动态图模式下可用。
- **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name`,一般无需设置,默认值为 None。

关键字参数
::::::::::::
- **out** (Tensor,可选) - 输出 Tensor,若不为 ``None``,计算结果将保存在该 Tensor 中,默认值为 ``None``。

返回
::::::::::::
一个 ``Tensor``,表示 Tensor 缩并的结果,数据类型与 ``x`` 和 ``y`` 相同。一般情况下,有 :math:`output.ndim = x.ndim + y.ndim - 2 \times n_{axes}`,其中 :math:`n_{axes}` 表示做 Tensor 缩并的轴数量。
Expand Down
2 changes: 1 addition & 1 deletion docs/api/paddle/vander_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ vander
参数
::::::::::
- **x** (Tensor) - 输入的 Tensor,必须是 1-D Tensor, 支持的数据类型:int32、int64、float32、float64、complex64、complex128。
- **n** (int,可选) - 输出中的列数。如果未指定 n,则返回一个方阵(n = len(x))。
- **n** (int,可选) - 输出中的列数。如果未指定 n,则返回一个方阵(n = len(x))。别名 ``N``。
- **increasing** (bool,可选) - 列的幂次顺序。如果为 True,则幂次从左到右增加,如果为 False(默认值),则幂次顺序相反。
- **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name`,一般无需设置,默认值为 None。

Expand Down