Skip to content
Merged
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
32 changes: 32 additions & 0 deletions docs/api/paddle/addmv_cn.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
.. _cn_api_paddle_addmv:

addmv
-------------------------------

.. py:function:: paddle.addmv(input, mat, vec, beta=1, alpha=1, name=None, *, out=None)

执行矩阵 ``mat`` 和向量 ``vec`` 的矩阵-向量乘法,并将其加到输入 Tensor 上。

公式为:out = beta * input + alpha * (mat @ vec)

参数
:::::::::
- **input** (Tensor) - 待加的输入 Tensor。
- **mat** (Tensor) - 待乘的矩阵。
- **vec** (Tensor) - 待乘的向量。
- **beta** (float,可选) - input 的乘数,默认值为 1。
- **alpha** (float,可选) - mat @ vec 的乘数,默认值为 1。
- **name** (str,可选) - 操作名称,默认值为 None。

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

返回
:::::::::
Tensor:计算结果 Tensor。

代码示例
:::::::::

COPY-FROM: paddle.addmv
32 changes: 32 additions & 0 deletions docs/api/paddle/addr_cn.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
.. _cn_api_paddle_addr:

addr
-------------------------------

.. py:function:: paddle.addr(input, vec1, vec2, beta=1, alpha=1, name=None, *, out=None)

执行向量 ``vec1`` 和向量 ``vec2`` 的外积,并将其加到输入矩阵上。

公式为:out = beta * input + alpha * (vec1 outer vec2)

参数
:::::::::
- **input** (Tensor) - 待加的输入 Tensor。
- **vec1** (Tensor) - 第一个向量。
- **vec2** (Tensor) - 第二个向量。
- **beta** (float,可选) - input 的乘数,默认值为 1。
- **alpha** (float,可选) - 外积的乘数,默认值为 1。
- **name** (str,可选) - 操作名称,默认值为 None。

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

返回
:::::::::
Tensor:计算结果 Tensor。

代码示例
:::::::::

COPY-FROM: paddle.addr
4 changes: 4 additions & 0 deletions docs/api/paddle/erf__cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,3 +10,7 @@ Inplace 版本的 :ref:`cn_api_paddle_erf` API,对输入 x 采用 Inplace 策
更多关于 inplace 操作的介绍请参考 `3.1.3 原位(Inplace)操作和非原位操作的区别`_ 了解详情。

.. _3.1.3 原位(Inplace)操作和非原位操作的区别: https://www.paddlepaddle.org.cn/documentation/docs/zh/develop/guides/beginner/tensor_cn.html#id3

.. note::

别名支持:参数名 ``input`` 可替代 ``x``,如 ``erf_(input=tensor_x)`` 等价于 ``erf_(x=tensor_x)``。
4 changes: 4 additions & 0 deletions docs/api/paddle/expm1__cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,3 +10,7 @@ Inplace 版本的 :ref:`cn_api_paddle_expm1` API,对输入 ``x`` 采用 Inplac
更多关于 inplace 操作的介绍请参考 `3.1.3 原位(Inplace)操作和非原位操作的区别`_ 了解详情。

.. _3.1.3 原位(Inplace)操作和非原位操作的区别: https://www.paddlepaddle.org.cn/documentation/docs/zh/develop/guides/beginner/tensor_cn.html#id3

.. note::

别名支持:参数名 ``input`` 可替代 ``x``,如 ``expm1_(input=tensor_x)`` 等价于 ``expm1_(x=tensor_x)``。
26 changes: 26 additions & 0 deletions docs/api/paddle/fix_cn.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
.. _cn_api_paddle_fix:

fix
-------------------------------

.. py:function:: paddle.fix(input, name=None, *, out=None)

返回输入 Tensor 的截断整数值。与 ``paddle.trunc`` 功能相同。

参数
:::::::::
- **input** (Tensor) - 输入 Tensor,数据类型为 int32、int64、float32、float64。别名 ``x``。
- **name** (str,可选) - 操作名称,默认值为 None。

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

返回
:::::::::
Tensor:截断后的 Tensor。

代码示例
:::::::::

COPY-FROM: paddle.fix
31 changes: 31 additions & 0 deletions docs/api/paddle/histc_cn.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
.. _cn_api_paddle_histc:

histc
-------------------------------

.. py:function:: paddle.histc(input, bins=100, min=0.0, max=0.0, name=None, *, out=None)

计算 Tensor 的直方图。

元素被分配到 min 和 max 之间的等宽区间中。如果 min 和 max 都为零,则使用数据的最小值和最大值。

参数
:::::::::
- **input** (Tensor) - 输入 Tensor。
- **bins** (int,可选) - 直方图区间数,默认值为 100。
- **min** (float,可选) - 范围的下端(包含),默认值为 0.0。
- **max** (float,可选) - 范围的上端(包含),默认值为 0.0。
- **name** (str,可选) - 操作名称,默认值为 None。

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

返回
:::::::::
Tensor:直方图 Tensor,数据类型为 float32。

代码示例
:::::::::

COPY-FROM: paddle.histc
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** (PlaceLike,可选) - 输出 Tensor 的设备,默认值为 ``None``。
- **requires_grad** (bool,可选) - 是否计算梯度,默认值为 ``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,19 +3,24 @@
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,可选) - 输出变量的数据类型。若参数为空,则输出变量的数据类型和输入变量相同,默认值为 None。
- **out** (Tensor,可选) - 输出 Tensor,若不为 ``None``,计算结果将保存在该 Tensor 中,默认值为 ``None``。

返回
::::::::::
``Tensor``,沿着 ``axis`` 进行平均值计算的结果且忽略掉 ``NaNs`` 值,数据类型和 ``x`` 相同。
Expand Down
15 changes: 12 additions & 3 deletions docs/api/paddle/nansum_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,18 +3,27 @@
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。

.. note::
此 API 有两种调用方式:
1. ``paddle.nansum(x, axis=None, dtype=None, keepdim=False, name=None, *, out=None)`` (Paddle 风格)
2. ``paddle.nansum(input, dim=None, keepdim=False, *, dtype=None, out=None)`` (PyTorch 风格)

参数
:::::::::
- **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
4 changes: 2 additions & 2 deletions docs/api/paddle/select_scatter_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,8 @@
select_scatter
-------------------------------

.. py:function:: paddle.select_scatter(x, values, axis, index, name=None)
.. py:function:: paddle.select_scatter(x, values, axis, index)

将 ``values`` 矩阵的值嵌入到 ``x`` 矩阵的第 ``axis`` 维的 ``index`` 列

参数
Expand All @@ -12,7 +13,6 @@ select_scatter
- **values** (Tensor) - 需要插入的值,形状需要与 ``x`` 矩阵除去第 ``axis`` 维后的形状一致,数据类型为: ``bool``、 ``float16``、 ``float32``、 ``float64``、 ``uint8``、 ``int8``、 ``int16``、 ``int32``、 ``int64``、 ``bfloat16``、 ``complex64``、 ``complex128``。别名 ``src``。
- **axis** (int) - 指定沿着哪个维度嵌入对应的值,数据类型为:int。别名 ``dim``。
- **index** (int) - 指定沿着 ``axis`` 维的哪一列嵌入对应的值,数据类型为:int。
- **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name`,一般无需设置,默认值为 None。

返回
:::::::::
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
Loading