修复 paddle.argmax 等 API 的文档 (PaddlePaddle#6159)

* 修改文档 * Update docs/api/paddle/create_parameter_cn.rst Co-authored-by: zachary sun <[email protected]> * Apply suggestions from code review Co-authored-by: zachary sun <[email protected]> * Update Transformer_cn.rst * Update Transformer_cn.rst --------- Co-authored-by: zachary sun <[email protected]>
MarisaSparkL · Sep 19, 2023 · 7ab9aa5 · 7ab9aa5
1 parent c576467
commit 7ab9aa5
Show file tree

Hide file tree

Showing 4 changed files with 7 additions and 4 deletions.
diff --git a/docs/api/paddle/argmax_cn.rst b/docs/api/paddle/argmax_cn.rst
@@ -6,7 +6,7 @@ argmax
 .. py:function:: paddle.argmax(x, axis=None, keepdim=False, dtype='int64', name=None)
 
 
-沿参数``axis`` 计算输入 ``x`` 的最大元素的索引。
+沿参数 ``axis`` 计算输入 ``x`` 的最大元素的索引。
 
 参数
 ::::::::

diff --git a/docs/api/paddle/create_parameter_cn.rst b/docs/api/paddle/create_parameter_cn.rst
@@ -9,7 +9,8 @@ create_parameter
 
 创建一个参数。该参数是一个可学习的变量，拥有梯度并且可优化。
 
-**注意：这是一个低级别的 API。如果您希望自己创建新的 op，这个 API 将非常有用，无需使用 layers。**
+.. note::
+    这是一个低级别的 API。如果您希望自己创建新的 op，这个 API 将非常有用，无需使用 layers。
 
 参数
 ::::::::::::

diff --git a/docs/api/paddle/nn/Transformer_cn.rst b/docs/api/paddle/nn/Transformer_cn.rst
@@ -58,6 +58,7 @@ forward(self, src, tgt, src_mask=None, tgt_mask=None, memory_mask=None)
 
 
 **返回**
+
 Tensor，Transformer 解码器的输出。其形状和数据类型与 ``tgt`` 相同。
 
 
@@ -74,6 +75,7 @@ generate_square_subsequent_mask(self, length)
 
 
 **返回**
+
 Tensor，根据输入的 ``length`` 具体的大小生成的形状为 ``[length, length]`` 方形的掩码。
 
 

diff --git a/docs/api/paddle/optimizer/lr/CosineAnnealingDecay_cn.rst b/docs/api/paddle/optimizer/lr/CosineAnnealingDecay_cn.rst
@@ -26,8 +26,8 @@ CosineAnnealingDecay
 参数
 ::::::::::::
 
-    - **learning_rate** (float) - 初始学习率，也就是公式中的 :math:`\eta_{max}`，数据类型为 Python float。
-    - **T_max** (float|int) - 训练的上限轮数，是余弦衰减周期的一半。
+    - **learning_rate** (float) - 初始学习率，也就是公式中的 :math:`\eta_{max}`，数据类型为 Python float 或 int。
+    - **T_max** (float|int) - 训练的上限轮数，是余弦衰减周期的一半。必须是一个正整数。
     - **eta_min** (float|int，可选) - 学习率的最小值，即公式中的 :math:`\eta_{min}`。默认值为 0。
     - **last_epoch** (int，可选) - 上一轮的轮数，重启训练时设置为上一轮的 epoch 数。默认值为 -1，则为初始学习率。
     - **verbose** (bool，可选) - 如果是 ``True``，则在每一轮更新时在标准输出 `stdout` 输出一条信息。默认值为 ``False`` 。
-Original file line number
+Diff line change
@@ Expand Up @@
     **返回**
     Tensor，Transformer 解码器的输出。其形状和数据类型与 ``tgt`` 相同。
@@ Expand All / @@ -74,6 +75,7 @@ generate_square_subsequent_mask(self, length) @@
     **返回**
     Tensor，根据输入的 ``length`` 具体的大小生成的形状为 ``[length, length]`` 方形的掩码。
@@ Expand Down @@