Skip to content

Commit 17c1aa7

Browse files
[API Compatibility] Add C Sink API expand_as, logsumexp, argmax, argmin, all (PaddlePaddle#7404)
* feat(C API Sink) * feat(C API Sink) * feat(C API Sink)
1 parent b1e41fa commit 17c1aa7

File tree

5 files changed

+30
-2
lines changed

5 files changed

+30
-2
lines changed

docs/api/paddle/all_cn.rst

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,16 +3,22 @@
33
all
44
-------------------------------
55

6-
.. py:function:: paddle.all(x, axis=None, keepdim=False, name=None)
6+
.. py:function:: paddle.all(x, axis=None, keepdim=False, name=None, *, out=None)
77
88
对指定维度上的 Tensor 元素进行逻辑与运算,并输出相应的计算结果。
99

10+
.. note::
11+
别名支持: 参数名 ``input`` 可替代 ``x``, ``dim`` 可替代 ``axis``。
12+
1013
参数
1114
:::::::::
1215
- **x** (Tensor)- 输入变量为多维 Tensor,数据类型为 bool、float32、float64、int32、int64。
16+
别名: ``input``
1317
- **axis** (int | list | tuple,可选)- 计算逻辑与运算的维度。如果为 None,则计算所有元素的逻辑与并返回包含单个元素的 Tensor 变量,否则必须在 :math:`[−rank(x),rank(x)]` 范围内。如果 :math:`axis [i] <0`,则维度将变为 :math:`rank+axis[i]`,默认值为 None。
18+
别名: ``dim``
1419
- **keepdim** (bool,可选) - 是否在输出 Tensor 中保留减小的维度。除非 keepdim 为 True,否则输出 Tensor 的维度将比输入 Tensor 小一维,默认值为 False。
1520
- **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name`,一般无需设置,默认值为 None。
21+
- **out** (Tensor,可选) - 指定输出结果的 `Tensor`,默认值为 None。
1622

1723
返回
1824
:::::::::

docs/api/paddle/argmax_cn.rst

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,16 @@ argmax
88
99
沿参数 ``axis`` 计算输入 ``x`` 的最大元素的索引。
1010

11+
.. note::
12+
别名支持: 参数名 ``input`` 可替代 ``x``, ``dim`` 可替代 ``axis``。
13+
14+
1115
参数
1216
::::::::
1317
- **x** (Tensor) - 输入的多维 ``Tensor``,支持的数据类型:float16、float32、float64、int16、int32、int64、uint8。
18+
别名: ``input``
1419
- **axis** (int,可选) - 指定对输入 Tensor 进行运算的轴,``axis`` 的有效范围是[-R, R),R 是输入 ``x`` 的维度个数,``axis`` 为负数时,进行计算的 ``axis`` 与 ``axis`` + R 一致。默认值为 None,将会对输入的 `x` 进行平铺展开,返回最大值的索引。
20+
别名: ``dim``
1521
- **keepdim** (bool,可选) - 是否在输出 Tensor 中保留减小的维度。如果 keepdim 为 True,则输出 Tensor 和 x 具有相同的维度(减少的维度除外,减少的维度的大小为 1),默认值为 False。
1622
- **dtype** (str|paddle.dtype|np.dtype,可选) - 输出 Tensor 的数据类型,可选值为 int32,int64,默认值为 int64,将返回 int64 类型的结果。
1723
- **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name`,一般无需设置,默认值为 None。

docs/api/paddle/argmin_cn.rst

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,15 @@ argmin
88
99
沿参数 ``axis`` 计算输入 ``x`` 的最小元素的索引。
1010

11+
.. note::
12+
别名支持: 参数名 ``input`` 可替代 ``x``, ``dim`` 可替代 ``axis``。
13+
1114
参数
1215
::::::::
1316
- **x** (Tensor) - 输入的多维 ``Tensor``,支持的数据类型:float16、float32、float64、int16、int32、int64、uint8。
17+
别名: ``input``
1418
- **axis** (int,可选) - 指定对输入 Tensor 进行运算的轴, ``axis`` 的有效范围是[-R, R),R 是输入 ``x`` 的维度个数, ``axis`` 为负数时,进行计算的 ``axis`` 与 ``axis`` + R 一致。默认值为 None,将会对输入的 `x` 进行平铺展开,返回最小值的索引。
19+
别名: ``dim``
1520
- **keepdim** (bool,可选) - 是否保留进行最小值索引操作的轴,默认值为 False。
1621
- **dtype** (str|paddle.dtype|np.dtype,可选) - 输出 Tensor 的数据类型,可选值为 int32、int64,默认值为'int64',将返回 int64 类型的结果。
1722
- **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name`,一般无需设置,默认值为 None。

docs/api/paddle/expand_as_cn.rst

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,10 +15,15 @@ expand_as
1515
:width: 500
1616
:alt: 图例
1717

18+
.. note::
19+
别名支持: 参数名 ``input`` 可替代 ``x``, ``other`` 可替代 ``y``。
20+
1821
参数
1922
:::::::::
2023
- **x** (Tensor) - 输入的 Tensor,数据类型为:bool、float32、float64、int32 或 int64。
24+
别名: ``input``
2125
- **y** (Tensor) - 给定输入 ``x`` 扩展后的形状。
26+
别名: ``other``
2227
- **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name`,一般无需设置,默认值为 None。
2328
返回
2429
:::::::::

docs/api/paddle/logsumexp_cn.rst

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,19 +3,25 @@
33
logsumexp
44
-------------------------------
55

6-
.. py:function:: paddle.logsumexp(x, axis=None, keepdim=False, name=None)
6+
.. py:function:: paddle.logsumexp(x, axis=None, keepdim=False, name=None, *, out=None)
77
88
沿着参数 ``axis`` 计算 ``x`` 的以 e 为底的指数的和的自然对数。计算公式如下:
99

1010
.. math::
1111
logsumexp(x) = \log\sum exp(x)
1212
13+
.. note::
14+
别名支持: 参数名 ``input`` 可替代 ``x``, ``dim`` 可替代 ``axis``。
15+
1316
参数
1417
::::::::::
1518
- **x** (Tensor) - 输入的 Tensor,数据类型为:float16,float32、float64,维度不超过 4 。
19+
别名: ``input``
1620
- **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`` 的全部元素计算 logsumexp。默认值为 None。
21+
别名: ``dim``
1722
- **keepdim** (bool,可选) - 是否在输出 Tensor 中保留减小的维度。如果 ``keepdim`` 为 True,则输出 Tensor 和 ``x`` 具有相同的维度(减少的维度除外,减少的维度的大小为 1)。否则,输出 Tensor 的形状会在 ``axis`` 上进行 squeeze 操作。默认值为 False。
1823
- **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name`,一般无需设置,默认值为 None。
24+
- **out** (Tensor,可选) - 指定输出结果的 `Tensor`,默认值为 None。
1925

2026
返回
2127
::::::::::

0 commit comments

Comments
 (0)