[API compatibility] add docs for alias func (PaddlePaddle#7388)

* add docs for alias api

* Update docs/api/paddle/bitwise_or_cn.rst

* Update docs/api/paddle/broadcast_to_cn.rst

* Update docs/api/paddle/diff_cn.rst

* Update docs/api/paddle/median_cn.rst

* Update docs/api/paddle/prod_cn.rst

* Update docs/api/paddle/repeat_interleave_cn.rst

* Update docs/api/paddle/take_along_axis_cn.rst

* Update docs/api/paddle/unique_consecutive_cn.rst

* Update docs/api/paddle/var_cn.rst

* Update docs/api/paddle/zeros_cn.rst

---------

Co-authored-by: zachary sun <[email protected]>

Author: 2 people

docs/api/paddle/Tensor_cn.rst

@@ -1149,9 +1149,13 @@ exponential_(lam=1.0, name=None)
 
     f(x) = \lambda e^{-\lambda x}
 
+.. note::
+    别名支持: 参数名 ``lambd`` 可替代 ``lam``，如 ``lambd=1.0`` 等价于 ``lam=1.0``。
+
 参数：
     - **x** (Tensor) - 输入 Tensor，数据类型为 float32/float64。
     - **lam** (float) - 指数分布的 :math:`\lambda` 参数。
+    - **lambd** - ``lam`` 的别名，行为完全一致。
     - **name** (str，可选) - 具体用法请参见 :ref:`api_guide_Name`，一般无需设置，默认值为 None。
 
 

docs/api/paddle/bitwise_or_cn.rst

@@ -15,11 +15,16 @@ bitwise_or
 
     .. _Tensor 介绍: ../../guides/beginner/tensor_cn.html#id7
 
+.. note::
+    别名支持: 参数名 ``input`` 可替代 ``x`` 和 ``other`` 可替代 ``y``，如 ``input=tensor_x`` 等价于 ``x=tensor_x``， ``other=tensor_y`` 等价于 ``y=tensor_y``。
+
 参数
 ::::::::::::
 
         - **x** （Tensor）- 输入的 N-D `Tensor`，数据类型为：bool，uint8，int8，int16，int32，int64。
+        - **input** - ``x`` 的别名，行为完全一致。
         - **y** （Tensor）- 输入的 N-D `Tensor`，数据类型为：bool，uint8，int8，int16，int32，int64。
+        - **other** - ``y`` 的别名，行为完全一致。
         - **out** （Tensor，可选）- 输出的结果 `Tensor`，是与输入数据类型相同的 N-D `Tensor`。默认值为 None，此时将创建新的 Tensor 来保存输出结果。
         - **name** (str，可选) - 具体用法请参见 :ref:`api_guide_Name`，一般无需设置，默认值为 None。
 

docs/api/paddle/broadcast_to_cn.rst

@@ -15,11 +15,16 @@ broadcast_to
     :width: 500
     :align: center
 
+.. note::
+    别名支持: 参数名 ``input`` 可替代 ``x`` 和 ``size`` 可替代 ``shape``，如 ``input=tensor_x`` 等价于 ``x=tensor_x``， ``size=[2, 3]`` 等价于 ``shape=[2, 3]``。
+
 参数
 :::::::::
 
     - **x** (Tensor) - 输入的 Tensor，数据类型为：bool、float16、float32、float64、int32、int64、uint8 或 uint16。
+    - **input** - ``x`` 的别名，行为完全一致。
     - **shape** (tuple|list|Tensor) - 给定输入 ``x`` 扩展后的形状，若 ``shape`` 为 list 或者 tuple，则其中的元素值应该为整数或者是形状为 1-D 或 0-D 的 Tensor，若 ``shape`` 类型为 Tensor，则其应该为 1-D Tensor。
+    - **size** - ``shape`` 的别名，行为完全一致。
     - **name** (str，可选) - 具体用法请参见 :ref:`api_guide_Name`，一般无需设置，默认值为 None。
 
 返回

docs/api/paddle/diff_cn.rst

@@ -13,6 +13,9 @@ diff
 .. note::
     高阶的前向差值可以通过递归的方式进行计算，`n`的值支持任意正整数。
 
+.. note::
+    别名支持: 参数名 ``input`` 可替代 ``x`` 和 ``dim`` 可替代 ``axis``，如 ``input=tensor_x`` 等价于 ``x=tensor_x``， ``dim=1`` 等价于 ``axis=1``。
+
 参数
 ::::::::::::
 

docs/api/paddle/median_cn.rst

@@ -7,12 +7,18 @@ median
 
 沿给定的轴 ``axis`` 计算 ``x`` 中元素的中位数。
 
+.. note::
+    别名支持: 参数名 ``input`` 可替代 ``x`` 和 ``dim`` 可替代 ``axis``，如 ``input=tensor_x`` 等价于 ``x=tensor_x``， ``dim=1`` 等价于 ``axis=1``。
+    当出现别名替换时， ``mode`` 设置默认参数为 ``min`` 而不是 ``avg``。
+
 参数
 ::::::::::
    - **x** (Tensor) - 输入的 Tensor，数据类型为：bfloat16、float16、float32、float64、int32、int64。
+   - **input** - ``x`` 的别名，行为完全一致。
    - **axis** (int，可选) - 指定对 ``x`` 进行计算的轴。``axis`` 可以是 int。``axis`` 值应该在范围 [-D, D) 内，D 是 ``x`` 的维度。如果 ``axis`` 或者其中的元素值小于 0，则等价于 :math:`axis + D`。如果 ``axis`` 是 None，则对 ``x`` 的全部元素计算中位数。默认值为 None。
+   - **dim** - ``axis`` 的别名，行为完全一致。
    - **keepdim** (bool，可选) - 是否在输出 Tensor 中保留输入的维度。除非 keepdim 为 True，否则输出 Tensor 的维度将比输入 Tensor 小一维，默认值为 False。
-   - **mode** (str，可选) - 当输入 Tensor ``x`` 在 ``axis`` 轴上有偶数个元素时，可选择按照中间两个数的平均值或最小值确定中位数。可选的值是 'avg' 或 'min'。默认为 'avg'。
+   - **mode** (str，可选) - 当输入 Tensor ``x`` 在 ``axis`` 轴上有偶数个元素时，可选择按照中间两个数的平均值或最小值确定中位数。可选的值是 'avg' 或 'min'。默认为 'avg'。当出现别名替换时， ``mode`` 设置默认参数为 ``min`` 而不是 ``avg``。
    - **name** (str，可选) - 具体用法请参见 :ref:`api_guide_Name`，一般无需设置，默认值为 None。
 
 返回

docs/api/paddle/nn/functional/embedding_cn.rst

@@ -7,13 +7,16 @@ embedding
 
 
 
-嵌入层(Embedding Layer)，根据 input 中的 id 信息从 embedding 矩阵中查询对应 embedding 信息，并会根据输入的 size (vocab_size, emb_size)和 dtype 自动构造一个二维 embedding 矩阵。
+嵌入层(Embedding Layer)，根据 x 中的 id 信息从 embedding 矩阵中查询对应 embedding 信息，并会根据输入的 size (vocab_size, emb_size)和 dtype 自动构造一个二维 embedding 矩阵。
 
 输出的 Tensor 的 shape 是将输入 Tensor shape 后追加一维 emb_size。
 
 .. note::
 
-   input 中的 id 必须满足 ``0 =< id < size[0]``，否则程序会抛异常退出。
+   x 中的 id 必须满足 ``0 =< id < size[0]``，否则程序会抛异常退出。
+
+.. note::
+    别名支持: 参数名 ``input`` 可替代 ``x``，如 ``input=tensor_x`` 等价于 ``x=tensor_x``。
 
 
 .. code-block:: text
@@ -39,7 +42,8 @@ embedding
 ::::::::::::
 
 
-    - **input** (Tensor) - 存储 id 信息的 Tensor，数据类型必须为：int32/int64。input 中的 id 必须满足 ``0 =< id < size[0]`` 。
+    - **x** (Tensor) - 存储 id 信息的 Tensor，数据类型必须为：int32/int64。input 中的 id 必须满足 ``0 =< id < size[0]`` 。
+    - **input** - ``x`` 的别名，行为完全一致。
     - **weight** (Tensor) - 存储词嵌入权重参数的 Tensor，形状为(num_embeddings, embedding_dim)。
     - **padding_idx** (int|long|None，可选) - padding_idx 的配置区间为 ``[-weight.shape[0], weight.shape[0]``，如果配置了 padding_idx，那么在训练过程中遇到此 id 时，其参数及对应的梯度将会以 0 进行填充。如果 padding_idx < 0 ，则 padding_idx 将自动转换到 ``weight.shape[0] + padding_idx`` 。如果设置为 "None"，则不会对输出产生影响。默认值：None。
     - **max_norm** (float，可选) - 若声明，会将范数大于此值的词嵌入向量重新归一化，使其范数等于此值。在动态图模式下会对 ``weight`` 产生 inplace 修改。默认值为 None。
@@ -51,7 +55,7 @@ embedding
 
 返回
 ::::::::::::
-Tensor, input 映射后得到的 Embedding Tensor，数据类型和权重定义的类型一致。
+Tensor, x 映射后得到的 Embedding Tensor，数据类型和权重定义的类型一致。
 
 
 代码示例

docs/api/paddle/no_grad_cn.rst

@@ -11,6 +11,9 @@ no_grad
 
 也可以用作一个装饰器（需要创建实例对象作为装饰器）。
 
+.. note::
+    别名支持: 参数名 ``orig_func`` 可替代 ``func``。
+
 代码示例
 ::::::::::::
 

docs/api/paddle/ones_like_cn.rst

@@ -8,9 +8,13 @@ ones_like
 
 返回一个和输入参数 ``x`` 具有相同形状的数值都为 1 的 Tensor，数据类型为 ``dtype`` 或者和 ``x`` 相同，如果 ``dtype`` 为 None，则输出 Tensor 的数据类型与 ``x`` 相同。
 
+.. note::
+    别名支持: 参数名 ``input`` 可替代 ``x``，如 ``input=tensor_x`` 等价于 ``x=tensor_x``。
+
 参数
 ::::::::::
     - **x** (Tensor) – 输入的 Tensor，数据类型可以是 bool，float16，float32，float64，int32，int64。
+    - **input** - ``x`` 的别名，行为完全一致。
     - **dtype** (str|np.dtype，可选) - 输出 Tensor 的数据类型，支持 bool，float16, float32，float64，int32，int64。当该参数值为 None 时，输出 Tensor 的数据类型与 ``x`` 相同。默认值为 None。
     - **name** (str，可选) - 具体用法请参见 :ref:`api_guide_Name`，一般无需设置，默认值为 None。
 

docs/api/paddle/prod_cn.rst

@@ -9,11 +9,16 @@ prod
 
 对指定维度上的 Tensor 元素进行求乘积运算，并输出相应的计算结果。
 
+.. note::
+    别名支持: 参数名 ``input`` 可替代 ``x`` 和 ``dim`` 可替代 ``axis``，如 ``input=tensor_x`` 等价于 ``x=tensor_x``， ``dim=1`` 等价于 ``axis=1``。
+
 参数
 ::::::::::::
 
     - **x** (Tensor) - 输入的 Tensor，数据类型为：bfloat16、float16、float32、float64、int32、int64、complex64、complex128。
+    - **input** - ``x`` 的别名，行为完全一致。
     - **axis** (int|list|tuple，可选) - 求乘积运算的维度。如果是 None，则计算所有元素的乘积并返回包含单个元素的 Tensor，否则该参数必须在 :math:`[-x.ndim, x.ndim)` 范围内。如果 :math:`axis[i] < 0`，则维度将变为 :math:`x.ndim + axis[i]`，默认为 None。
+    - **dim** - ``axis`` 的别名，行为完全一致。
     - **keepdim** (bool，可选) - 是否在输出 Tensor 中保留输入的维度。除非 keepdim 为 True，否则输出 Tensor 的维度将比输入 Tensor 小一维，默认值为 False。
     - **dtype** (str，可选) - 输出 Tensor 的数据类型，支持 int32、int64、float32、float64。如果指定了该参数，那么在执行操作之前，输入 Tensor 将被转换为 dtype 类型。这对于防止数据类型溢出非常有用。若参数为空，则输出变量的数据类型和输入变量相同，默认为：None。
     - **name** (str，可选) - 具体用法请参见 :ref:`api_guide_Name`，一般无需设置，默认值为 None。

docs/api/paddle/repeat_interleave_cn.rst

@@ -17,11 +17,16 @@ repeat_interleave
        :alt: 示例一图示
        :align: center
 
+.. note::
+    别名支持: 参数名 ``input`` 可替代 ``x`` 和 ``dim`` 可替代 ``axis``，如 ``input=tensor_x`` 等价于 ``x=tensor_x``， ``dim=1`` 等价于 ``axis=1``。
+
 参数
 :::::::::
     - **x** （Tensor）– 输入 Tensor。 ``x`` 的数据类型可以是 float32，float64，int32，int64。
+    - **input** - ``x`` 的别名，行为完全一致。
     - **repeats** （Tensor, int）– 包含复制次数的 1-D Tensor 或指定的复制次数。
     - **axis**    (int，可选) – 指定对输入 ``x`` 进行运算的轴，若未指定，默认值为 None，使用输入 Tensor 的 flatten 形式。
+    - **dim** - ``axis`` 的别名，行为完全一致。
     - **name** (str，可选) - 具体用法请参见 :ref:`api_guide_Name`，一般无需设置，默认值为 None。