Skip to content

Commit 7d518eb

Browse files
ooooo-createNoai-ossCopilot
authored
[Docs] Fix RST formatting issues in diagonal, diff, and diagflat API docs (#7792)
Co-authored-by: cutetocute <jiuwoxiao@outlook.com> Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
1 parent 0478ea7 commit 7d518eb

3 files changed

Lines changed: 10 additions & 10 deletions

File tree

docs/api/paddle/diagflat_cn.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ diagflat
1818

1919
参数
2020
:::::::::
21-
- **x** (Tensor) - 输入的 `Tensor`。它的形状可以是任意维度。其数据类型应为 float16,float32,float64,int32,int64。
21+
- **x** (Tensor) - 输入的 ``Tensor``。它的形状可以是任意维度。其数据类型应为 float16,float32,float64,int32,int64。
2222
- **offset** (int,可选) - 对角线偏移量。正值表示上对角线,0 表示主对角线,负值表示下对角线。
2323
- **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name`,一般无需设置,默认值为 None。
2424

docs/api/paddle/diagonal_cn.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -20,15 +20,15 @@ diagonal
2020

2121
参数
2222
:::::::::
23-
- **x** (Tensor)输入变量,类型为 Tensor,支持 bool、int32、int64、bfloat16、float16、float32、float64 数据类型。
24-
- **offset** int,可选- 从指定的二维平面中获取对角线的位置,默认值为 0,既主对角线
25-
- **axis1** int,可选- 获取对角线的二维平面的第一维,默认值为 0。
26-
- **axis2** int,可选- 获取对角线的二维平面的第二维,默认值为 1。
23+
- **x** (Tensor) - 输入变量,类型为 Tensor,支持 bool、int32、int64、bfloat16、float16、float32、float64 数据类型。
24+
- **offset** (int,可选) - 从指定的二维平面中获取对角线的位置,默认值为 0,即主对角线
25+
- **axis1** (int,可选) - 获取对角线的二维平面的第一维,默认值为 0。
26+
- **axis2** (int,可选) - 获取对角线的二维平面的第二维,默认值为 1。
2727
- **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name`,一般无需设置,默认值为 None。
2828

2929
返回
3030
:::::::::
31-
- Tensor (Tensor),输入 `Tensor` 在指定二维平面的局部视图,数据类型和输入数据类型一致。
31+
``Tensor``,输入 ``Tensor`` 在指定二维平面的局部视图,数据类型和输入数据类型一致。
3232

3333

3434
代码示例

docs/api/paddle/diff_cn.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,16 +11,16 @@ diff
1111
out[i] = x[i+1] - x[i]
1212
1313
.. note::
14-
高阶的前向差值可以通过递归的方式进行计算,`n`的值支持任意正整数。
14+
高阶的前向差值可以通过递归的方式进行计算,``n`` 的值支持任意正整数。
1515

1616
.. note::
1717
别名支持: 参数名 ``input`` 可替代 ``x`` 和 ``dim`` 可替代 ``axis``,如 ``input=tensor_x`` 等价于 ``x=tensor_x``, ``dim=1`` 等价于 ``axis=1``。
1818

1919
参数
2020
::::::::::::
2121

22-
- **x** (Tensor) - 待计算前向差值的输入 `Tensor`,支持 bool、int32、int64、float16、float32、float64 数据类型。别名 ``input``。
23-
- **n** (int,可选) - 需要计算前向差值的次数,`n`的值支持任意正整数,默认值为 1。
22+
- **x** (Tensor) - 待计算前向差值的输入 ``Tensor``,支持 bool、int32、int64、float16、float32、float64 数据类型。别名 ``input``。
23+
- **n** (int,可选) - 需要计算前向差值的次数,``n`` 的值支持任意正整数,默认值为 1。
2424
- **axis** (int,可选) - 沿着哪一维度计算前向差值,默认值为-1,也即最后一个维度。别名 ``dim``。
2525
- **prepend** (Tensor,可选) - 在计算前向差值之前,沿着指定维度 axis 附加到输入 x 的前面,它的维度需要和输入一致,并且除了 axis 维外,其他维度的形状也要和输入一致,默认值为 None。
2626
- **append** (Tensor,可选) - 在计算前向差值之前,沿着指定维度 axis 附加到输入 x 的后面,它的维度需要和输入一致,并且除了 axis 维外,其他维度的形状也要和输入一致,默认值为 None。
@@ -35,7 +35,7 @@ diff
3535
:::::::::
3636
前向差值计算后的 Tensor,数据类型和输入一致。
3737

38-
代码示例
38+
代码示例
3939
:::::::::
4040

4141
COPY-FROM: paddle.diff

0 commit comments

Comments
 (0)