[Add] Paddle 代码 CI 中引入 xdoctest 检查 #55295
Conversation
|
你的PR提交成功，感谢你对开源项目的贡献! |
python/paddle/distribution/beta.py
Outdated
| >>> beta = paddle.distribution.Beta(alpha=0.5, beta=0.5) | ||
| >>> print(beta.mean) | ||
| Tensor(shape=[1], dtype=float32, place=Place(cpu), stop_gradient=True, | ||
| [0.50000000]) |
There was a problem hiding this comment.
这里是特意用的错误例子还是？0D Tensor 应该就是 shape=[] 的，2.5 应该就已经支持 0D Tensor 了，你那里用的是 2.4 嘛？
There was a problem hiding this comment.
忘了更新 Paddle 了 ...........................................
python/requirements.txt
Outdated
| @@ -7,3 +7,4 @@ decorator | |||
| astor | |||
| paddle_bfloat==0.1.7 | |||
| opt_einsum==3.3.0 | |||
| xdoctest | |||
There was a problem hiding this comment.
xdoctest 的 requirement 看看放在 python 目录下是否合适？
不合适，requirements.txt 会在 setup.py 里用到，作为 paddle 的「依赖项」，用户在安装时候会自动安装
相比于「依赖项」，xdoctest 更类似于「开发依赖项」，不过我们目前是没有一个统一的地方来添加这个的（大多数社区规范是写一个 requirements-dev.txt，但我们没有），我们只有 python/paddle/unittest_py/requirements.txt（即「测试依赖」），但放在里面也是明显不合适的
目前可以添加到流水线中，或许以后可以直接放在 Docker 里
There was a problem hiding this comment.
刚和 @luotao1 讨论了一下，这个还是放在 python/paddle/unittest_py/requirements.txt 吧，PR-CI-Static-Check 是会自动安装这个的
There was a problem hiding this comment.
OK～ 只是 Paddle build 的时候可能也会调用这个代码检查，感觉放哪儿都不太合适～
There was a problem hiding this comment.
刚和 @luotao1 讨论了一下，这个还是放在
python/paddle/unittest_py/requirements.txt吧，PR-CI-Static-Check 是会自动安装这个的
是 Paddle/python/unittest_py/requirements.txt 吧？
There was a problem hiding this comment.
😂 嗯 python/unittest_py/requirements.txt
https://github.com/PaddlePaddle/Paddle/blob/develop/python/unittest_py/requirements.txt
|
辛苦，我看这个 PR 最近还在修改一些文档进行测试，是否已经准备好 review 了呢？准备好的时候可以 @ 一下我 另外我们也测试一下这边和 docs 那边能否正常 copy 这边修改过的源码吧，这边在 commit 里加上 中文文档那边需要新建一个 PR，然后在 PR 描述里添加 |
|
一直在等 review ......... 一直没消息，所以这几天就改了几个 codeblock，暂时也没发现什么问题～
这个是指？ |
docs repo |
关于什么的 PR？ |
|
docs 端才能触发中文文档 preview 呀，随便创建即可 |
@SigureMo 建好了～ |
|
|
||
| ## Paddle docs 需要注意 | ||
|
|
||
| 目前 Paddle docs 对于 `>>> ` 代码的处理是，strip 掉此提示符，然后交给原有代码检查工具进行检测。这种方法在大部分情况下没什么问题，但是，如果代码中有 `requires` 项，则可能检查失败。所以，后续需要修改 Paddle docs 的检查逻辑，建议对于 `>>> ` 直接跳过，与当前 Paddle 的 `sampcd_processor.py` 一致。最后收尾的时候，移除掉 Paddle docs 的代码检查。 |
There was a problem hiding this comment.
最后收尾的时候，移除掉 Paddle docs 的代码检查。
COPY-FROM 任务结束的时候应该就可以移除掉了
There was a problem hiding this comment.
整体上看起来没有问题，但是是否能补充一些原来的文档链接呢？比如 directive 原文档是如何描述的呢？
There was a problem hiding this comment.
整体上看起来没有问题，但是是否能补充一些原来的文档链接呢？比如 directive 原文档是如何描述的呢？
tools/sampcd_processor_xdoctest.py
Outdated
| @@ -0,0 +1,269 @@ | |||
| # Copyright (c) 2019 PaddlePaddle Authors. All Rights Reserved. | |||
tools/sampcd_processor_xdoctest.py
Outdated
|
|
||
| self.directive_pattern = re.compile( | ||
| r""" | ||
| (?<=(\#\s{1})) # positive lookbehind, directive begins |
PR types
New features
PR changes
Others
Description
中国软件开源创新大赛：飞桨框架任务挑战赛
赛题五：将 xdoctest 引入到飞桨框架工作流中
RFC [Add]将 xdoctest 引入到飞桨框架工作流中v1
ISSUE 赛题五：将 xdoctest 引入到飞桨框架工作流中 Tracking Issue
第一阶段
任务：Paddle 代码 CI 中引入 xdoctest 检查
sampcd_processor_readme.md:Xdoctester的详细设计文档sampcd_processor_utils.py: 代码检查的相关工具sampcd_processor_xdoctest.py:Xdoctester的相关实现sampcd_processor.py: 原代码检查工具test_sampcd_processor.py: 原代码检查工具单元测试test_sampcd_processor_xdoctest.py:Xdoctester单元测试requirements.txt: 添加了xdoctestbeta.py: 修改了其中的示例代码样式，用于检查新工具 Paddle CI 的正确性。建议先 review
sampcd_processor_readme.md:Xdoctester的详细设计文档，看看还有哪些需要修改的设计～另外，
xdoctest的requirement看看放在python目录下是否合适？@SigureMo @luotao1 @jzhang533 @sunzhongkai588
请评审，谢谢！：）