Fix ci parameter checking script #6864

fufu0615 · 2024-09-13T08:55:34Z

尝试修复ci参数检查

为方便描述，以下称图中红框部分为文档的标题 API 字符串，蓝框部分为文档的参数板块：

本pr的大致贡献如下：

完善提取intitle参数的代码

之前的只能提取文档标题 API 字符串 .. py:function:: func() 的 args 参数，完善后可以提取 API 中所有类型的参数；

添加更详细的文档参数检查日志

添加了更详细的日志来帮助排查文档的格式问题：

Something wrong with the format of params list in description, check it please.

表示文档的参数板块存在格式问题
Params section in description is empty, check it please.

表示文档的参数板块内容为空
The number of params in title does not match the params in description: {len(params_intitle)} != {len(items)}.

表示文档标题 API 字符串的参数数量 len(params_intitle) 与参数板块中的参数数量 len(items) 不符
the following param in title does not match the param in description: {pname_intitle} != {pname_indesc}

表示文档标题 API 字符串中的参数 pname_intitle 与参数板块中对应位置参数 pname_indesc 的名称不符
param name '{pname_intitle}' not matched in description line{i+1}, check it please.

表示文档标题 API 字符串中的参数 pname_intitle 在参数板块中对应位置（第 i+1 行处）没有找到相应的描述
params section not found in description, check it please.

表示文档中没有参数板块

修复现有问题文档

修正了之前发现的存在格式问题的文档，具体列表见 #6839

统一用 Inplace 文档链接 Outplace 文档

将以下文档改为将 Inplace 版本的 API 文档的参数介绍链接向 Outplace 版本的 API 文档，与其他文档统一：

"api/paddle/index_fill_cn.rst",
"api/paddle/index_fill__cn.rst",
"api/paddle/index_put_cn.rst",
"api/paddle/index_fill__cn.rst",

总览和 Inplace 文档跳过参数检查

在参数检查时，将总览文档（api/paddle/Overview_cn.rst）和所有 Inplace 版本的 API 文档自动跳过

开启参数检查功能

paddle-bot · 2024-09-13T08:55:38Z

感谢你贡献飞桨文档，文档预览构建中，Docs-New 跑完后即可预览，预览链接：http://preview-pr-6864.paddle-docs-preview.paddlepaddle.org.cn/documentation/docs/zh/api/index_cn.html
预览工具的更多说明，请参考：飞桨文档预览工具

SigureMo · 2024-09-14T04:29:41Z

docs/api/paddle/einsum_cn.rst

@@ -68,9 +68,9 @@ Einsum 求和过程理论上等价于如下四步，但实现中实际执行的
 :::::


-    **equation** (str)：求和标记
+    - **equation** (str)：求和标记



Suggested change

这个空行删一下吧

SigureMo · 2024-09-14T04:30:55Z

docs/api/paddle/unstack_cn.rst

@@ -13,11 +13,9 @@ unstack
 参数
 ::::::::::::

-      - **x** (Tensor) – 输入 x 为 ``dim > 0`` 的 Tensor，
-      支持的数据类型：float32，float64，int32，int64， complex64，complex128。
+      - **x** (Tensor) – 输入 x 为 ``dim > 0`` 的 Tensor，支持的数据类型：float32，float64，int32，int64， complex64，complex128。



Suggested change

SigureMo · 2024-09-14T04:31:04Z

docs/api/paddle/unstack_cn.rst


-      - **axis** (int | 可选) – 输入 Tensor 进行 unpack 运算所在的轴，axis 的范围为：``[-D, D)`` ，
-      如果 ``axis < 0``，则 :math:`axis = axis + dim(x)`，axis 的默认值为 0。
+      - **axis** (int | 可选) – 输入 Tensor 进行 unpack 运算所在的轴，axis 的范围为：``[-D, D)`` ，如果 ``axis < 0``，则 :math:`axis = axis + dim(x)`，axis 的默认值为 0。



Suggested change

SigureMo · 2024-09-14T04:35:12Z

ci_scripts/check_api_parameters.py

+                default_value = ast.dump(
+                    fake_func.body[0].args.defaults[
+                        i - (num_args - num_defaults)
+                    ]
+                )


dump 是用来可视化的，一般只用于 debug，这里有必要 dump 么？

收到，当时貌似是把调试的代码直接粘贴过去了

SigureMo · 2024-09-14T04:35:57Z

ci_scripts/check_api_parameters.py

@@ -56,76 +56,130 @@ def parse_args():

 def _check_params_in_description(rstfilename, paramstr):
    flag = True
+    info = ""
    params_intitle = []


intitle 拆成 in_title 吧，这样看着很奇怪，其他地方也都改一下吧

SigureMo · 2024-09-14T04:36:14Z

ci_scripts/check_api_parameters.py

            params_intitle.append(arg.arg)
+        # vararh(*args)


Suggested change

# vararh(*args)

# vararg(*args)

SigureMo · 2024-09-14T05:14:35Z

ci_scripts/check_api_parameters.py

@@ -220,9 +277,11 @@ def check_api_parameters(rstfiles, apiinfo):
    result = True
    if check_failed:
        result = False
-        print(f"check_api_parameters failed: {check_failed}")
+        for path, info in check_failed.items():
+            print(f"Checking failed file:{path}\nError:{info}\n")


这里的 path 是生成的 html 文件路径还是原始的 rst 文件路径？从提示角度来看，使用源文件 rst 是更推荐的

path是rst文件的路径文件名，例如"api/paddle/unstack_cn.rst"，是要改一下变量名吗？

path是rst文件的路径文件名，例如"api/paddle/unstack_cn.rst"，是要改一下变量名吗？

这个倒不用，只是确认下

SigureMo

LGTMeow

This was referenced Sep 13, 2024

Uniformly use Inplace to link Outplace documents PaddlePaddle/Paddle#68206

Merged

CI脚本检查api参数存在的问题 #6839

Open

paddle-bot bot added the contributor label Sep 13, 2024

luotao1 assigned sunzhongkai588 and luotao1 Sep 14, 2024

luotao1 added the HappyOpenSource 快乐开源活动issue与PR label Sep 14, 2024

sunzhongkai588 requested a review from SigureMo September 14, 2024 03:53

SigureMo reviewed Sep 14, 2024

View reviewed changes

fufu0615 added 7 commits September 14, 2024 14:00

完善提取intitle参数的代码

05dfd54

添加更详细的文档参数检查日志

b3b266d

修复现有问题文档

d6f77bf

统一用Inplace文档链接Outplace文档

bd44773

总览和Inplace文档跳过参数检查

eecd660

开启参数检查功能

2362db1

部分勘误

d8703a2

fufu0615 force-pushed the ci_fix branch from 9b347c4 to d8703a2 Compare September 14, 2024 06:03

fufu0615 requested a review from SigureMo September 14, 2024 06:11

SigureMo approved these changes Sep 19, 2024

View reviewed changes

luotao1 merged commit b41831d into PaddlePaddle:develop Sep 19, 2024
2 checks passed

sunzhongkai588 mentioned this pull request Sep 25, 2024

「Paddle Docathon」文档系列活动 📃 #6165

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix ci parameter checking script #6864

Fix ci parameter checking script #6864

fufu0615 commented Sep 13, 2024 •

edited

Loading

paddle-bot bot commented Sep 13, 2024

SigureMo Sep 14, 2024

SigureMo Sep 14, 2024

SigureMo Sep 14, 2024

SigureMo Sep 14, 2024

fufu0615 Sep 14, 2024

SigureMo Sep 14, 2024

SigureMo Sep 14, 2024

SigureMo Sep 14, 2024

fufu0615 Sep 14, 2024

SigureMo Sep 14, 2024

SigureMo left a comment

Fix ci parameter checking script #6864

Fix ci parameter checking script #6864

Conversation

fufu0615 commented Sep 13, 2024 • edited Loading

尝试修复ci参数检查

完善提取intitle参数的代码

添加了更详细的日志来帮助排查文档的格式问题：

修复现有问题文档

统一用 Inplace 文档链接 Outplace 文档

总览和 Inplace 文档跳过参数检查

开启参数检查功能

paddle-bot bot commented Sep 13, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

SigureMo left a comment

Choose a reason for hiding this comment

fufu0615 commented Sep 13, 2024 •

edited

Loading