Skip to content

[docs] fix some api docs style #7525

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 7 commits into
base: develop
Choose a base branch
from
Open

[docs] fix some api docs style #7525

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
6fc61a5
docs: fix some style
ooooo-create Oct 7, 2025
15d45ff
test ci
ooooo-create Oct 8, 2025
96be73c
fix ci, in cat << -EOF here-document mean command substitution
ooooo-create Oct 8, 2025
bc5d8c5
fix typos
ooooo-create Oct 8, 2025
1638da3
apply review
ooooo-create Oct 8, 2025
95b1017
revert ci_scripts/report_preview_url.sh change
ooooo-create Oct 10, 2025
e01dbcd
Merge branch 'develop' into doc/style_patch1
SigureMo Oct 10, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions ci_scripts/report_preview_url.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,9 @@ done

if [ ${#output_lines[@]} -gt 0 ]; then
cat <<-EOF
> [!CAUTION]
> 如果你不清楚这个 pr 的修改内容（特别是修改了 \`report_preview_url.sh\` 或 \`preview-url-generate.yml\`），请不要随便点击链接！！！
Copy link
Member

@SigureMo SigureMo Oct 8, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

这里是想说什么呢？加一个 CAUTION 感觉很奇怪

Copy link
Member

@SigureMo SigureMo Oct 8, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

不过是不是要提示等渲染流水线跑完上传完再看，不然可能是旧的

Copy link
Collaborator Author

@ooooo-create ooooo-create Oct 8, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

不过是不是要提示等渲染流水线跑完上传完再看，不然可能是旧的

哦对，这个用 NOTE 可以吧

这里是想说什么呢？加一个 CAUTION 感觉很奇怪

因为之前搞了实时查看和验证被更新过的 report_preview_url 的功能，怕有人 pr 搞了恶意链接别人不知道点了，其实我也不想加这个（doge，我准备把这个删了，因为我加的这个别人也能改掉_(:з」∠)_，我相信他们不会乱点，不然只能用 pull_request_target 舍弃这个实时功能了，或者修改了这两个文件的只能 approve 之后才能跑

突然又想到那个 mac 流水线，我改了一个 cmake 就影响物理机器了，别人是不是也可以下载了病毒啥的，哦对，好像陌生 id 需要 approve 才能运行流水线

Copy link
Collaborator Author

@ooooo-create ooooo-create Oct 10, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

修改移到这个 pr 里啦 #7528


<details>
<summary>📚 本次 PR 文档预览链接 (点击展开)</summary>

Expand Down
2 changes: 1 addition & 1 deletion docs/api/paddle/abs_cn.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ abs

参数
:::::::::
- **x** (Tensor) - 输入的 Tensor，数据类型为：int32、int64、float16、float32、float64、complex64、complex128。
- **x** (Tensor) - 输入的 Tensor，数据类型为：int32、int64、float16、float32、float64、complex64 或 complex128。
- **name** (str，可选) - 具体用法请参见 :ref:`api_guide_Name`，一般无需设置，默认值为 None。

返回
Expand Down
2 changes: 1 addition & 1 deletion docs/api/paddle/amax_cn.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ amax

参数
:::::::::
- **x** (Tensor) - Tensor，支持数据类型为 float32、float64、int32、int64，维度不超过 4 维。
- **x** (Tensor) - Tensor，支持数据类型为 float32、float64、int32 或 int64，维度不超过 4 维。
``别名：input``
- **axis** (int|list|tuple，可选) - 求最大值运算的维度。如果为 None，则计算所有元素的最大值并返回包含单个元素的 Tensor 变量，否则必须在 :math:`[-x.ndim, x.ndim]` 范围内。如果 :math:`axis[i] <0`，则维度将变为 :math:`x.ndim+axis[i]`，默认值为 None。
``别名：dim``
Expand Down
2 changes: 1 addition & 1 deletion docs/api/paddle/linalg/eig_cn.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ eig
参数
::::::::::::

- **x** (Tensor) - 输入一个或一批矩阵。``x`` 的形状应为 ``[*, M, M]``，数据类型支持 float32、float64、complex64 和 complex128。
- **x** (Tensor) - 输入一个或一批矩阵。``x`` 的形状应为 ``[*, M, M]``，数据类型支持 float32、float64、complex64 或 complex128。
Copy link
Member

@SigureMo SigureMo Oct 10, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

这里是不是就应该是「和」？@sunzhongkai588

Copy link
Collaborator

@sunzhongkai588 sunzhongkai588 Oct 17, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

这里是不是就应该是「和」？@sunzhongkai588

有..什么区别嘛

Copy link
Collaborator

@Echo-Nie Echo-Nie Oct 17, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

严谨来说可能‘或’更好些。‘和’可能会被理解成： [f32，f64，c64 和 c128]，‘或’就是[f32，f64，c64，c128]；不过感觉无伤大雅....

Copy link
Collaborator Author

@ooooo-create ooooo-create Oct 17, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

噢噢，当时没仔细看，直接替换的。当时就是因为没什么区别才改的，本来想统一一下描述输入类型的写法（结果没仔细看句子）。现在让我新增 api 文档我肯定就是复制其他的改，复制不同的写法可能就不同，其实不改也没关系，当时只是为了测试 ci

Copy link
Member

@SigureMo SigureMo Oct 17, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  • 支持 A、B 和 C
  • 允许传入 A、B 或 C

- **name** (str，可选) - 具体用法请参见 :ref:`api_guide_Name`，一般无需设置，默认值为 None。

返回
Expand Down
52 changes: 26 additions & 26 deletions docs/api/paddle/linalg/norm_cn.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,32 +18,32 @@ norm

**Paddle 支持以下范数:**

+----------------+--------------------------------+--------------------------------+
| porder | norm for matrices | norm for vectors |
+================+================================+================================+
| None(default) | frobenius norm | 2 范数 |
+----------------+--------------------------------+--------------------------------+
| fro | frobenius norm | 不支持 |
+----------------+--------------------------------+--------------------------------+
| nuc | nuclear norm | 不支持 |
+----------------+--------------------------------+--------------------------------+
| inf | max(sum(abs(x), dim=1)) | max(abs(x)) |
+----------------+--------------------------------+--------------------------------+
| -inf | min(sum(abs(x), dim=1)) | min(abs(x)) |
+----------------+--------------------------------+--------------------------------+
| 0 | 不支持 | sum(x != 0) |
+----------------+--------------------------------+--------------------------------+
| 1 | max(sum(abs(x), dim=0)) | 同下 |
+----------------+--------------------------------+--------------------------------+
| -1 | min(sum(abs(x), dim=0)) | 同下 |
+----------------+--------------------------------+--------------------------------+
| 2 | 由 axis 组成矩阵的最大奇异值 | 同下 |
+----------------+--------------------------------+--------------------------------+
| -2 | 由 axis 组成矩阵的最大奇异值 | 同下 |
+----------------+--------------------------------+--------------------------------+
| 其他 int 或 | 不支持 | sum(abs(x)^{porder})^ |
| float | | {(1 / porder)} |
+----------------+--------------------------------+--------------------------------+
+---------------+------------------------------+-----------------------+
| porder | norm for matrices | norm for vectors |
+===============+==============================+=======================+
| None(default) | frobenius norm | 2 范数 |
+---------------+------------------------------+-----------------------+
| fro | frobenius norm | 不支持 |
+---------------+------------------------------+-----------------------+
| nuc | nuclear norm | 不支持 |
+---------------+------------------------------+-----------------------+
| inf | max(sum(abs(x), dim=1)) | max(abs(x)) |
+---------------+------------------------------+-----------------------+
| -inf | min(sum(abs(x), dim=1)) | min(abs(x)) |
+---------------+------------------------------+-----------------------+
| 0 | 不支持 | sum(x != 0) |
+---------------+------------------------------+-----------------------+
| 1 | max(sum(abs(x), dim=0)) | 同下 |
+---------------+------------------------------+-----------------------+
| -1 | min(sum(abs(x), dim=0)) | 同下 |
+---------------+------------------------------+-----------------------+
| 2 | 由 axis 组成矩阵的最大奇异值 | 同下 |
+---------------+------------------------------+-----------------------+
| -2 | 由 axis 组成矩阵的最大奇异值 | 同下 |
+---------------+------------------------------+-----------------------+
| 其他 int 或 | 不支持 | sum(abs(x)^{porder})^ |
| float | | {(1 / porder)} |
+---------------+------------------------------+-----------------------+


参数
Expand Down
2 changes: 1 addition & 1 deletion docs/api/paddle/meshgrid_cn.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ meshgrid
参数
::::::::::::

- **args** (Tensor|Tensor 数组) - 输入变量为 k 个一维 Tensor，形状分别为(N1,), (N2,), ..., (Nk, )。支持数据类型为 bfloat16、float16、float32、float64、int32、int64、complex64 和 complex128。
- **args** (Tensor|Tensor 数组) - 输入变量为 k 个一维 Tensor，形状分别为(N1,), (N2,), ..., (Nk, )。支持数据类型为 bfloat16、float16、float32、float64、int32、int64、complex64 或 complex128。
- **kargs** (可选) - 目前只接受 name 参数（str），具体用法请参见 :ref:`api_guide_Name`，一般无需设置，默认值为 None。


Expand Down
2 changes: 1 addition & 1 deletion docs/api/paddle/nn/functional/sequence_mask_cn.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ sequence_mask

返回
:::::::::
mask Tensor，Tensor，形状为 ``[d_1, d_2，… ，d_n, maxlen]``，数据类型由 ``dtype`` 指定，支持 float32、float64、int32 和 int64，默认为 int64。
mask Tensor，Tensor，形状为 ``[d_1, d_2，… ，d_n, maxlen]``，数据类型由 ``dtype`` 指定，支持 float32、float64、int32 或 int64，默认为 int64。

代码示例
:::::::::
Expand Down