diff --git a/docs/api/paddle/any_cn.rst b/docs/api/paddle/any_cn.rst index 7765af8f606..46b63c4277e 100644 --- a/docs/api/paddle/any_cn.rst +++ b/docs/api/paddle/any_cn.rst @@ -3,17 +3,24 @@ any ------------------------------- -.. py:function:: paddle.any(x, axis=None, keepdim=False, name=None) +.. py:function:: paddle.any(x, axis=None, keepdim=False, name=None, *, out=None) 对指定维度上的 Tensor 元素进行逻辑或运算,并输出相应的计算结果。 +.. note:: + 别名支持: 参数名 ``input`` 可替代 ``x``,参数名 ``dim`` 可替代 ``axis``,如 ``any(input=tensor_x, dim=1, ...)`` 等价于 ``any(x=tensor_x, axis=1, ...)``。 + 参数 ::::::::: - - **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。 + - **x** (Tensor) - 输入变量为多维 Tensor,数据类型为 bool、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``。 - **keepdim** (bool,可选) - 是否在输出 Tensor 中保留输入的维度。除非 keepdim 为 True,否则输出 Tensor 的维度将比输入 Tensor 小一维,默认值为 False。 - **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name`,一般无需设置,默认值为 None。 +关键字参数 +:::::::::::: + - **out** (Tensor,可选) - 输出 Tensor。默认值为 None。 + 返回 ::::::::: Tensor,在指定维度上进行逻辑或运算的 Tensor,数据类型和输入数据类型一致。 diff --git a/docs/api/paddle/argsort_cn.rst b/docs/api/paddle/argsort_cn.rst index 195058413d5..09587a7e4d7 100644 --- a/docs/api/paddle/argsort_cn.rst +++ b/docs/api/paddle/argsort_cn.rst @@ -8,12 +8,14 @@ argsort 对输入变量沿给定轴进行排序,输出排序好的数据的相应索引,其维度和输入相同。默认升序排列,如果需要降序排列设置 ``descending=True`` 。 +.. note:: + 别名支持: 参数名 ``input`` 可替代 ``x``,参数名 ``dim`` 可替代 ``axis``,如 ``argsort(input=tensor_x, dim=1, ...)`` 等价于 ``argsort(x=tensor_x, axis=1, ...)``。 参数 :::::::::::: - - **x** (Tensor) - 输入的多维 ``Tensor``,支持的数据类型:float16、bfloat16、float32、float64、int16、int32、int64、uint8。 - - **axis** (int,可选) - 指定对输入 Tensor 进行运算的轴,``axis`` 的有效范围是 [-R, R),R 是输入 ``x`` 的 Rank, ``axis`` 为负时与 ``axis`` + R 等价。默认值为 -1。 + - **x** (Tensor) - 输入的多维 ``Tensor``,支持的数据类型:float16、bfloat16、float32、float64、int16、int32、int64、uint8。别名: ``input``。 + - **axis** (int,可选) - 指定对输入 Tensor 进行运算的轴,``axis`` 的有效范围是 [-R, R),R 是输入 ``x`` 的 Rank, ``axis`` 为负时与 ``axis`` + R 等价。默认值为 -1。别名: ``dim``。 - **descending** (bool,可选) - 指定算法排序的方向。如果设置为 True,算法按照降序排序。如果设置为 False 或者不设置,按照升序排序。默认值为 False。 - **stable** (bool,可选) - 是否使用稳定排序算法。若设置为 True,则使用稳定排序算法,即相同元素的顺序在排序结果中将会被保留。默认值为 False,此时的算法不一定是稳定排序算法。 - **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name`,一般无需设置,默认值为 None。 diff --git a/docs/api/paddle/chunk_cn.rst b/docs/api/paddle/chunk_cn.rst index c6e34575bb3..ab514395160 100644 --- a/docs/api/paddle/chunk_cn.rst +++ b/docs/api/paddle/chunk_cn.rst @@ -7,12 +7,15 @@ chunk 将输入 Tensor 分割成多个子 Tensor。 +.. note:: + 别名支持: 参数名 ``input`` 可替代 ``x``,参数名 ``dim`` 可替代 ``axis``,如 ``chunk(input=tensor_x, chunks=2, dim=1)`` 等价于 ``chunk(x=tensor_x, chunks=2, axis=1)``。 + 参数 ::::::::: - - **x** (Tensor) - 输入变量,数据类型为 bool, float16, float32,float64,int32,int64 的多维 Tensor。 + - **x** (Tensor) - 输入变量,数据类型为 bool, float16, float32,float64,int32,int64 的多维 Tensor。别名: ``input``。 - **chunks** (int) - ``chunks`` 是一个整数,表示将输入 Tensor 划分成多少个相同大小的子 Tensor。 - - **axis** (int|Tensor,可选) - 整数或者形状为[]的 0-D Tensor,数据类型为 int32 或 int64。表示需要分割的维度。如果 ``axis < 0``,则划分的维度为 ``rank(x) + axis``。默认值为 0。 + - **axis** (int|Tensor,可选) - 整数或者形状为[]的 0-D Tensor,数据类型为 int32 或 int64。表示需要分割的维度。如果 ``axis < 0``,则划分的维度为 ``rank(x) + axis``。默认值为 0。别名: ``dim``。 - **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name`,一般无需设置,默认值为 None。 下图展示了一个例子,设 x 的尺寸为(3,3,3),chunks 值为 3,axis 值为 0。 diff --git a/docs/api/paddle/clip_cn.rst b/docs/api/paddle/clip_cn.rst index 0c94bc76a21..31dc1a55b20 100644 --- a/docs/api/paddle/clip_cn.rst +++ b/docs/api/paddle/clip_cn.rst @@ -3,7 +3,7 @@ clip ------------------------------- -.. py:function:: paddle.clip(x, min=None, max=None, name=None) +.. py:function:: paddle.clip(x, min=None, max=None, name=None, *, out=None) @@ -14,14 +14,21 @@ clip Out = MIN(MAX(x, min), max) +.. note:: + 别名支持: 参数名 ``input`` 可替代 ``x``,如 ``clip(input=tensor_x, min=0.3, max=0.7)`` 等价于 ``clip(x=tensor_x, min=0.3, max=0.7)``。 + 参数 :::::::::::: - - **x** (Tensor) - 输入的 Tensor,数据类型为:bfloat16、float16、float32、float64、int32、int64。 + - **x** (Tensor) - 输入的 Tensor,数据类型为:bfloat16、float16、float32、float64、int32、int64。别名: ``input``。 - **min** (float|int|Tensor,可选) - 裁剪的最小值,输入中小于该值的元素将由该元素代替,若参数为空,则不对输入的最小值做限制。数据类型可以是 float32 或形状为[]的 0-D Tensor,类型可以为 bfloat16、float16、float32、float64、int32,默认值为 None。 - **max** (float|int|Tensor,可选) - 裁剪的最大值,输入中大于该值的元素将由该元素代替,若参数为空,则不对输入的最大值做限制。数据类型可以是 float32 或形状为[]的 0-D Tensor,类型可以为 bfloat16、float16、float32、float64、int32,默认值为 None。 - **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name`,一般无需设置,默认值为 None。 +关键字参数 +:::::::::::: + - **out** (Tensor,可选) - 输出 Tensor。默认值为 None。 + 返回 :::::::::::: 输出 Tensor,与 ``x`` 维度相同。当 ``x`` 数据类型为 int32 或 int64 并且 ``min`` 或 ``max`` 有一个为 float 类型时,输出 Tensor 的数据类型为 float32,否则与输入 ``x`` 的数据类型相同。 diff --git a/docs/api/paddle/squeeze_cn.rst b/docs/api/paddle/squeeze_cn.rst index 6cf0021bb26..65a1cb82da3 100644 --- a/docs/api/paddle/squeeze_cn.rst +++ b/docs/api/paddle/squeeze_cn.rst @@ -50,10 +50,13 @@ squeeze :width: 600 :alt: 图例 +.. note:: + 别名支持: 参数名 ``input`` 可替代 ``x``,参数名 ``dim`` 可替代 ``axis``,如 ``squeeze(input=tensor_x, dim=1)`` 等价于 ``squeeze(x=tensor_x, axis=1)``。 + 参数 ::::::::: - - **x** (Tensor) - 输入的 `Tensor` ,数据类型为:float32、float64、bool、int8、int32、int64。 - - **axis** (int|list|tuple,可选) - 输入一个或一列整数,代表要压缩的轴。axis 的范围: [−ndim(x), ndim(x)) 。 如果 axis 为负数, 则 axis=axis+ndim(x) 。默认为 None,表示对所有尺寸为 1 的维度进行压缩。 + - **x** (Tensor) - 输入的 `Tensor` ,数据类型为:float32、float64、bool、int8、int32、int64。别名: ``input``。 + - **axis** (int|list|tuple,可选) - 输入一个或一列整数,代表要压缩的轴。axis 的范围: [−ndim(x), ndim(x)) 。 如果 axis 为负数, 则 axis=axis+ndim(x) 。默认为 None,表示对所有尺寸为 1 的维度进行压缩。别名: ``dim``。 - **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name`,一般无需设置,默认值为 None。 返回 diff --git a/docs/api/paddle/transpose_cn.rst b/docs/api/paddle/transpose_cn.rst index 5bdf71ce9ce..5a67a0c95cf 100644 --- a/docs/api/paddle/transpose_cn.rst +++ b/docs/api/paddle/transpose_cn.rst @@ -10,10 +10,14 @@ transpose 根据 perm 对输入的多维 Tensor 进行数据重排。返回多维 Tensor 的第 i 维对应输入 Tensor 的 perm[i]维。 +.. note:: + 别名支持: 参数名 ``input`` 可替代 ``x``,参数 ``dim0`` 与 ``dim1`` 可替代 ``axis`` ,如 ``transpose(input=x, dim0=0, dim1=1)`` 等价于 ``transpose(x=x, perm=[1, 0, 2])`` 。 + + 参数 :::::::::::: - - **x** (Tensor) - 输入:x:[N_1, N_2, ..., N_k, D]多维 Tensor,可选的数据类型为 bool, float16, bfloat16, float32, float64, int8, int16, int32, int64, uint8, uint16, complex64, complex128。 + - **x** (Tensor) - 输入:x:[N_1, N_2, ..., N_k, D]多维 Tensor,可选的数据类型为 bool, float16, bfloat16, float32, float64, int8, int16, int32, int64, uint8, uint16, complex64, complex128。别名: ``input``。 - **perm** (list|tuple) - perm 长度必须和 X 的维度相同,并依照 perm 中数据进行重排。 - **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name`,一般无需设置,默认值为 None。 diff --git a/docs/api/paddle/unsqueeze_cn.rst b/docs/api/paddle/unsqueeze_cn.rst index 74b5749a0f7..de1b67338c3 100644 --- a/docs/api/paddle/unsqueeze_cn.rst +++ b/docs/api/paddle/unsqueeze_cn.rst @@ -18,10 +18,13 @@ unsqueeze 额外的,当需要在多个位置增加维度时, ``unsqueeze`` 方法会按顺序依次增加维度。例如 Shape 为 [2, 3] 的 Tensor 在 axis = [0, 2] 处增加维度, ``unsqueeze`` 方法会先在 axis = 0 前插入一个维度, Shape 变为 [1, 2, 3],接着在 axis = 2 前插入一个维度, Shape 最终变为 [1, 2, 1, 3]。 +.. note:: + 别名支持: 参数名 ``input`` 可替代 ``x``,参数名 ``dim`` 可替代 ``axis``,如 ``unsqueeze(input=tensor_x, dim=1)`` 等价于 ``unsqueeze(x=tensor_x, axis=1)``。 + 参数 ::::::::: - - **x** (Tensor) - 输入的 `Tensor`,数据类型为:bfloat16、float32、float64、bool、int8、int32、int64。 - - **axis** (int|list|tuple|Tensor) - 表示要插入维度的位置。数据类型是 int32。如果 axis 的类型是 list 或 tuple,它的元素可以是整数或者形状为[]的 0-D Tensor。如果 axis 的类型是 Tensor,则是 1-D Tensor。如果 axis 是负数,则 axis=axis+ndim(x)+1 。 + - **x** (Tensor) - 输入的 `Tensor`,数据类型为:bfloat16、float32、float64、bool、int8、int32、int64。别名: ``input``。 + - **axis** (int|list|tuple|Tensor) - 表示要插入维度的位置。数据类型是 int32。如果 axis 的类型是 list 或 tuple,它的元素可以是整数或者形状为[]的 0-D Tensor。如果 axis 的类型是 Tensor,则是 1-D Tensor。如果 axis 是负数,则 axis=axis+ndim(x)+1 。别名: ``dim``。 - **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name`,一般无需设置,默认值为 None。 返回