align the CN docs Name parameter annotation/全量搜索，统一中文文档中Name参数的说明; te…

…st=document_fix (#4669)
PaddlePaddle · Apr 24, 2022 · a461db8 · a461db8
1 parent f1fff45
commit a461db8
Show file tree

Hide file tree

Showing 23 changed files with 23 additions and 23 deletions.
diff --git a/docs/api/paddle/rand_cn.rst b/docs/api/paddle/rand_cn.rst
@@ -11,7 +11,7 @@ rand
 ::::::::::
     - **shape** (list|tuple|Tensor) - 生成的随机Tensor的形状。如果 ``shape`` 是list、tuple，则其中的元素可以是int，或者是形状为[1]且数据类型为int32、int64的Tensor。如果 ``shape`` 是Tensor，则是数据类型为int32、int64的1-D Tensor。
     - **dtype** (str|np.dtype, 可选) - 输出Tensor的数据类型，支持float32、float64。当该参数值为None时， 输出Tensor的数据类型为float32。默认值为None.
-    - **name** (str, 可选) - 输出的名字。一般无需设置，默认值为None。该参数供开发人员打印调试信息时使用，具体用法请参见 :ref:`api_guide_Name` 。
+    - **name** (str, 可选) - 操作的名称(可选，默认值为None）。更多信息请参见 :ref:`api_guide_Name`。
 
 返回
 ::::::::::

diff --git a/docs/api/paddle/randint_cn.rst b/docs/api/paddle/randint_cn.rst
@@ -13,7 +13,7 @@ randint
     - **high** (int, 可选) - 要生成的随机值范围的上限，``high`` 不包含在范围中。默认值为None，此时范围是[0, ``low``)。
     - **shape** (list|tuple|Tensor) - 生成的随机Tensor的形状。如果 ``shape`` 是list、tuple，则其中的元素可以是int，或者是形状为[1]且数据类型为int32、int64的Tensor。如果 ``shape`` 是Tensor，则是数据类型为int32、int64的1-D Tensor。。默认值为[1]。
     - **dtype** (str|np.dtype|core.VarDesc.VarType, 可选) - 输出Tensor的数据类型，支持int32、int64。当该参数值为None时， 输出Tensor的数据类型为int64。默认值为None.
-    - **name** (str, 可选) - 输出的名字。一般无需设置，默认值为None。该参数供开发人员打印调试信息时使用，具体用法请参见 :ref:`api_guide_Name` 。
+    - **name** (str, 可选) - 操作的名称(可选，默认值为None）。更多信息请参见 :ref:`api_guide_Name`。
 
 返回
 ::::::::::

diff --git a/docs/api/paddle/randint_like_cn.rst b/docs/api/paddle/randint_like_cn.rst
@@ -13,7 +13,7 @@ randint_like
     - **low** (int) - 要生成的随机值范围的下限，``low`` 包含在范围中。当 ``high`` 为None时，均匀采样的区间为[0, ``low``)。默认值为0。
     - **high** (int, 可选) - 要生成的随机值范围的上限，``high`` 不包含在范围中。默认值为None，此时范围是[0, ``low``)。
     - **dtype** (str|np.dtype, 可选) - 输出Tensor的数据类型，支持bool，int32，int64，float16，float32，float64。当该参数值为None时， 输出Tensor的数据类型与输入Tensor的数据类型一致。默认值为None。
-    - **name** (str, 可选) - 输出的名字。一般无需设置，默认值为None。该参数供开发人员打印调试信息时使用，具体用法请参见 :ref:`api_guide_Name` 。
+    - **name** (str, 可选) - 操作的名称(可选，默认值为None）。更多信息请参见 :ref:`api_guide_Name`。
 
 返回
 ::::::::::

diff --git a/docs/api/paddle/randn_cn.rst b/docs/api/paddle/randn_cn.rst
@@ -11,7 +11,7 @@ randn
 ::::::::::
   - **shape** (list|tuple|Tensor) - 生成的随机Tensor的形状。如果 ``shape`` 是list、tuple，则其中的元素可以是int，或者是形状为[1]且数据类型为int32、int64的Tensor。如果 ``shape`` 是Tensor，则是数据类型为int32、int64的1-D Tensor。
   - **dtype** (str|np.dtype, 可选) - 输出Tensor的数据类型，支持float32、float64。当该参数值为None时， 输出Tensor的数据类型为float32。默认值为None.
-  - **name** (str, 可选) - 输出的名字。一般无需设置，默认值为None。该参数供开发人员打印调试信息时使用，具体用法请参见 :ref:`api_guide_Name` 。
+  - **name** (str, 可选) - 操作的名称(可选，默认值为None）。更多信息请参见 :ref:`api_guide_Name`。
 
 返回
 ::::::::::

diff --git a/docs/api/paddle/randperm_cn.rst b/docs/api/paddle/randperm_cn.rst
@@ -13,7 +13,7 @@ randperm
 ::::::::::
   - **n** (int) - 随机序列的上限（不包括在序列中），应该大于0。 
   - **dtype** (str|np.dtype, 可选) - 输出Tensor的数据类型，支持int32、int64、float32、float64。默认值为"int64".
-  - **name** (str, 可选) - 输出的名字。一般无需设置，默认值为None。该参数供开发人员打印调试信息时使用，具体用法请参见 :ref:`api_guide_Name` 。
+  - **name** (str, 可选) - 操作的名称(可选，默认值为None）。更多信息请参见 :ref:`api_guide_Name`。
 
 返回
 ::::::::::

diff --git a/docs/api/paddle/rot90_cn.rst b/docs/api/paddle/rot90_cn.rst
@@ -15,7 +15,7 @@ rot90
     - **x** (Tensor) - 输入张量。维度为多维，数据类型为bool, int32, int64, float16, float32或float64。float16只在gpu上支持。
     - **k** (int, 可选) - 旋转方向和次数，默认值：1。
     - **axes** (list|tuple, 可选) - axes指定旋转的平面，维度必须为2。默认值为[0, 1]。
-    - **name** (str|None, 可选) - 该参数供开发人员打印调试信息时使用，具体用法请参见 :ref:`api_guide_Name` 。默认值为None。
+    - **name** (str|None, 可选) - 操作的名称(可选，默认值为None）。更多信息请参见 :ref:`api_guide_Name`。
 
 返回
 ::::::::::

diff --git a/docs/api/paddle/rsqrt_cn.rst b/docs/api/paddle/rsqrt_cn.rst
@@ -22,7 +22,7 @@ rsqrt激活函数。
 ::::::::::::
 
     - **x** (Tensor) – 输入是多维Tensor，数据类型可以是float32和float64。 
-    - **name** (str，可选）— 这一层的名称（可选）。如果设置为None，则将自动命名这一层。默认值为None。
+    - **name** (str，可选）— 操作的名称(可选，默认值为None）。更多信息请参见 :ref:`api_guide_Name`。
 
 返回
 ::::::::::::

diff --git a/docs/api/paddle/scatter_nd_add_cn.rst b/docs/api/paddle/scatter_nd_add_cn.rst
@@ -48,7 +48,7 @@ scatter_nd_add
     - **x** (Tensor) - 输入张量，数据类型可以是int32，int64，float32，float64。
     - **index** (Tensor) - 输入的索引张量，数据类型为非负int32或非负int64。它的维度 :code:`index.ndim` 必须大于1，并且 :code:`index.shape[-1] <= x.ndim`
     - **updates** (Tensor) - 输入的更新张量，它必须和 :code:`x` 有相同的数据类型。形状必须是 :code:`index.shape[:-1] + x.shape[index.shape[-1]:]` 。
-    - **name** (string) - 该层的名字，默认值为None，表示会自动命名。
+    - **name** (string) - 操作的名称(可选，默认值为None）。更多信息请参见 :ref:`api_guide_Name`。
 
 返回
 ::::::::::::

diff --git a/docs/api/paddle/scatter_nd_cn.rst b/docs/api/paddle/scatter_nd_cn.rst
@@ -16,7 +16,7 @@ scatter_nd
     - **index** (Tensor) - 输入的索引张量，数据类型为非负int32或非负int64。它的维度 :code:`index.ndim` 必须大于1，并且 :code:`index.shape[-1] <= len(shape)`
     - **updates** (Tensor) - 输入的更新张量。形状必须是 :code:`index.shape[:-1] + shape[index.shape[-1]:]` 。数据类型可以是float32，float64。
     - **shape** (tuple|list) - 要求输出张量的形状。类型是tuple或者list。
-    - **name** (string) - 该层的名字，默认值为None，表示会自动命名。
+    - **name** (string) - 操作的名称(可选，默认值为None）。更多信息请参见 :ref:`api_guide_Name`。
 
 返回
 ::::::::::::

diff --git a/docs/api/paddle/standard_normal_cn.rst b/docs/api/paddle/standard_normal_cn.rst
@@ -11,7 +11,7 @@ standard_normal
 ::::::::::
   - **shape** (list|tuple|Tensor) - 生成的随机Tensor的形状。如果 ``shape`` 是list、tuple，则其中的元素可以是int，或者是形状为[1]且数据类型为int32、int64的Tensor。如果 ``shape`` 是Tensor，则是数据类型为int32、int64的1-D Tensor。
   - **dtype** (str|np.dtype, 可选) - 输出Tensor的数据类型，支持float32、float64。当该参数值为None时， 输出Tensor的数据类型为float32。默认值为None.
-  - **name** (str, 可选) - 输出的名字。一般无需设置，默认值为None。该参数供开发人员打印调试信息时使用，具体用法请参见 :ref:`api_guide_Name` 。
+  - **name** (str, 可选) - 操作的名称(可选，默认值为None）。更多信息请参见 :ref:`api_guide_Name`。
 
 返回
 ::::::::::

diff --git a/docs/api/paddle/t_cn.rst b/docs/api/paddle/t_cn.rst
@@ -10,7 +10,7 @@ t
 参数
 ::::::::
     - **input** (Tensor) - 输入：N维(N<=2)Tensor，可选的数据类型为float16、float32、float64、int32、int64，默认值为None。
-    - **name** (str，可选)- 该参数供开发人员打印调试信息时使用，具体用法请参见 :ref:`api_guide_Name` ，默认值为None。
+    - **name** (str，可选)- 操作的名称(可选，默认值为None）。更多信息请参见 :ref:`api_guide_Name`。
 
 返回
 ::::::::

diff --git a/docs/api/paddle/tan_cn.rst b/docs/api/paddle/tan_cn.rst
@@ -15,7 +15,7 @@ tan
 :::::::::
 
   - **x** (Tensor) – 该OP的输入为Tensor。数据类型为float32，float64。 
-  - **name** (str，可选) – 该参数供开发人员打印调试信息时使用，具体用法请参见 :ref:`api_guide_Name` ，默认值为None。
+  - **name** (str，可选) – 操作的名称(可选，默认值为None）。更多信息请参见 :ref:`api_guide_Name`。
 
 
 返回

diff --git a/docs/api/paddle/tanh_cn.rst b/docs/api/paddle/tanh_cn.rst
@@ -16,7 +16,7 @@ tanh 激活函数
 
 
     - **x** (Tensor) - Tanh算子的输入, 多维Tensor，数据类型为 float16，float32或float64。
-    - **name** (str, 可选) - 该层名称（可选，默认为None）。具体用法请参见 :ref:`api_guide_Name`。
+    - **name** (str, 可选) - 操作的名称(可选，默认值为None）。更多信息请参见 :ref:`api_guide_Name`。
 
 返回
 :::::::::

diff --git a/docs/api/paddle/tensordot_cn.rst b/docs/api/paddle/tensordot_cn.rst
@@ -21,7 +21,7 @@ tensordot
         3. ``axes`` 可以是一个tuple或list，其中包含一个或两个一维的整数tuple|list|Tensor。如果 ``axes`` 包含一个tuple|list|Tensor, 则对 ``x`` 和 ``y`` 的相同轴做缩并运算，具体轴下标由该tuple|list|Tensor中的整数值指定。如果 ``axes`` 包含两个tuple|list|Tensor，则第一个指定 ``x`` 做缩并运算的轴下标，第二个指定 ``y`` 的对应轴下标。 如果 ``axes`` 包含两个以上的tuple|list|Tensor，只有前两个会被作为轴下标序列使用，其它的将被忽略。
 
         4. ``axes`` 可以是一个张量，这种情况下该张量会被转换成list，然后应用前述规则确定做缩并运算的轴。请注意，输入Tensor类型的 ``axes`` 只在动态图模式下可用。
-    - **name** （str，可选） - 默认值为None，一般无需设置，具体用法请参见 :ref:`api_guide_Name` 。
+    - **name** （str，可选） - 操作的名称(可选，默认值为None）。更多信息请参见 :ref:`api_guide_Name`。
 
 返回
 ::::::::::::

diff --git a/docs/api/paddle/topk_cn.rst b/docs/api/paddle/topk_cn.rst
@@ -15,7 +15,7 @@ topk
     - **axis** （int，可选） - 指定对输入Tensor进行运算的轴， ``axis`` 的有效范围是[-R, R），R是输入 ``x`` 的Rank， ``axis`` 为负时与 ``axis`` + R 等价。默认值为-1。
     - **largest** （bool，可选） - 指定算法排序的方向。如果设置为True，排序算法按照降序的算法排序，否则按照升序排序。默认值为True。
     - **sorted** （bool，可选） - 控制返回的结果是否按照有序返回，默认为True。在gpu上总是返回有序的结果。
-    - **name** （str，可选） – 具体用法请参见 :ref:`api_guide_Name` ，一般无需设置，默认值为None。
+    - **name** （str，可选） – 操作的名称(可选，默认值为None）。更多信息请参见 :ref:`api_guide_Name`。
 
 返回
 :::::::::

diff --git a/docs/api/paddle/trace_cn.rst b/docs/api/paddle/trace_cn.rst
@@ -24,7 +24,7 @@ trace
     - **offset** （int ，可选）- 从指定的二维平面中获取对角线的位置，默认值为 0，既主对角线。
     - **axis1** （int ， 可选）- 获取对角线的二维平面的第一维，默认值为 0。
     - **axis2** （int ， 可选）- 获取对角线的二维平面的第二维，默认值为 1。
-    - **name** (str，可选)- 具体用法请参见 :ref:`api_guide_Name` ，一般无需设置，默认值为None。
+    - **name** (str，可选)- 操作的名称(可选，默认值为None）。更多信息请参见 :ref:`api_guide_Name`。
 
 返回
 :::::::::

diff --git a/docs/api/paddle/transpose_cn.rst b/docs/api/paddle/transpose_cn.rst
@@ -15,7 +15,7 @@ transpose
 
     - **x** (Tensor) - 输入：x:[N_1, N_2, ..., N_k, D]多维Tensor，可选的数据类型为bool, float16, float32, float64, int32, int64。
     - **perm** (list|tuple) - perm长度必须和X的维度相同，并依照perm中数据进行重排。
-    - **name** (str) - 该层名称（可选）。
+    - **name** (str) - 操作的名称(可选，默认值为None）。更多信息请参见 :ref:`api_guide_Name`。
 
 返回
 ::::::::::::

diff --git a/docs/api/paddle/tril_cn.rst b/docs/api/paddle/tril_cn.rst
@@ -15,7 +15,7 @@ tril
 :::::::::
     - **input** (Tensor) : 输入Tensor input，数据类型支持 `bool`,  `float32`, `float64`, `int32`, `int64` 。
     - **diagonal** (int，可选) : 指定的对角线，默认值为0。如果diagonal = 0，表示主对角线; 如果diagonal是正数，表示主对角线之上的对角线; 如果diagonal是负数，表示主对角线之下的对角线。
-    - **name** (str，可选)- 具体用法请参见 :ref:`api_guide_Name` ，一般无需设置，默认值为None。
+    - **name** (str，可选)- 操作的名称(可选，默认值为None）。更多信息请参见 :ref:`api_guide_Name`。
 
 返回
 :::::::::

diff --git a/docs/api/paddle/triu_cn.rst b/docs/api/paddle/triu_cn.rst
@@ -13,7 +13,7 @@ triu
 :::::::::
     - **input** (Tensor) : 输入Tensor input，数据类型支持 `float32`, `float64`, `int32`, `int64` 。
     - **diagonal** (int，可选) : 指定的对角线，默认值为0。如果diagonal = 0，表示主对角线; 如果diagonal是正数，表示主对角线之上的对角线; 如果diagonal是负数，表示主对角线之下的对角线。
-    - **name** (str，可选)- 具体用法请参见 :ref:`api_guide_Name` ，一般无需设置，默认值为None。
+    - **name** (str，可选)- 操作的名称(可选，默认值为None）。更多信息请参见 :ref:`api_guide_Name`。
 
 返回
 :::::::::

diff --git a/docs/api/paddle/uniform_cn.rst b/docs/api/paddle/uniform_cn.rst
@@ -26,7 +26,7 @@ uniform
     - **min** (float|int，可选) - 要生成的随机值范围的下限，min包含在范围中。支持的数据类型：float、int。默认值为-1.0。
     - **max** (float|int，可选) - 要生成的随机值范围的上限，max不包含在范围中。支持的数据类型：float、int。默认值为1.0。
     - **seed** (int，可选) - 随机种子，用于生成样本。0表示使用系统生成的种子。注意如果种子不为0，该操作符每次都生成同样的随机数。支持的数据类型：int。默认为 0。
-    - **name** (str, 可选) - 输出的名字。一般无需设置，默认值为None。该参数供开发人员打印调试信息时使用，具体用法请参见 :ref:`api_guide_Name` 。
+    - **name** (str, 可选) - 操作的名称(可选，默认值为None）。更多信息请参见 :ref:`api_guide_Name`。
 
 返回
 ::::::::::::

diff --git a/docs/api/paddle/where_cn.rst b/docs/api/paddle/where_cn.rst
@@ -28,7 +28,7 @@ where
     - **condition** （Tensor）- 选择 ``x`` 或 ``y`` 元素的条件 。为 ``True`` （非零值）时，选择 ``x`` ，否则选择 ``y`` 。
     - **x** （Tensor，Scalar，可选）- 多维 ``Tensor`` 或 ``Scalar``，数据类型为 ``float32`` 或 ``float64`` 或 ``int32`` 或 ``int64`` 。``x`` 和 ``y`` 必须都给出或者都不给出。
     - **y** （Tensor，Scalar，可选）- 多维 ``Tensor`` 或 ``Scalar``，数据类型为 ``float32`` 或 ``float64`` 或 ``int32`` 或 ``int64`` 。``x`` 和 ``y`` 必须都给出或者都不给出。
-    - **name** （str，可选）- 具体用法请参见 :ref:`api_guide_Name` ，一般无需设置，默认值为None。
+    - **name** （str，可选）- 操作的名称(可选，默认值为None）。更多信息请参见 :ref:`api_guide_Name`。
 
 返回
 ::::::::::::

diff --git a/docs/api/paddle/zeros_cn.rst b/docs/api/paddle/zeros_cn.rst
@@ -14,7 +14,7 @@ zeros
 
     - **shape** (tuple|list|Tensor) - 输出Tensor的形状， ``shape`` 的数据类型为int32或者int64。
     - **dtype** (np.dtype|str，可选) - 输出Tensor的数据类型，数据类型必须为bool、float16、float32、float64、int32或int64。若为None，数据类型为float32， 默认为None。
-    - **name** (str, 可选) - 输出的名字。一般无需设置，默认值为None。该参数供开发人员打印调试信息时使用，具体用法请参见 :ref:`api_guide_Name` 。
+    - **name** (str, 可选) - 操作的名称(可选，默认值为None）。更多信息请参见 :ref:`api_guide_Name`。
 
 返回
 ::::::::::::

diff --git a/docs/api/paddle/zeros_like_cn.rst b/docs/api/paddle/zeros_like_cn.rst
@@ -12,7 +12,7 @@ zeros_like
 ::::::::::
     - **x** (Tensor) – 输入的多维Tensor，数据类型可以是bool，float16, float32，float64，int32，int64。输出Tensor的形状和 ``x`` 相同。如果 ``dtype`` 为None，则输出Tensor的数据类型与 ``x`` 相同。
     - **dtype** (str|np.dtype, 可选) - 输出Tensor的数据类型，支持bool，float16, float32，float64，int32，int64。当该参数值为None时， 输出Tensor的数据类型与 ``x`` 相同。默认值为None.
-    - **name** (str, 可选) - 输出的名字。一般无需设置，默认值为None。该参数供开发人员打印调试信息时使用，具体用法请参见 :ref:`api_guide_Name` 。
+    - **name** (str, 可选) - 操作的名称(可选，默认值为None）。更多信息请参见 :ref:`api_guide_Name`。
 
 返回
 ::::::::::