[Change] 不再兼容旧格式示例代码 #56573
[Change] 不再兼容旧格式示例代码 #56573
Conversation
|
如果旧格式没有了，旧检查也删除吧，以后也没有人会维护了呢 |
嗯，中文下的也可以一并删除了 |
这个是 docs 下面的检查是吧？ 我在 docs 那边另起 PR 哈 ～ |
我们是不是应该检测到旧格式时进行提醒，并指引参考 https://www.paddlepaddle.org.cn/documentation/docs/zh/develop/dev_guides/style_guide_and_references/code_example_writing_specification_cn.html ，而不是新旧格式一并使用 xdoctest 直接检查？ |
tools/sampcd_processor.py
Outdated
| usage: python sample_test.py {cpu or gpu} | ||
| usage: python sampcd_processor_xdoctest.py {cpu or gpu} | ||
| {cpu or gpu}: running in cpu version or gpu version | ||
|
|
||
| for example, you can run cpu version testing like this: | ||
|
|
||
| python sampcd_processor.py cpu |
呃 ... ... 我之前就是这么做的，可是你们说干脆删掉就行了 ... ... 而且，最麻烦的地方是，旧格式其实没有一个检查标准，对于 xdoctest 来说，旧格式就是在 这样吧，我在 sampcd_processor_utils.py 里面加个检查试试看 ~ |
嗯，我觉得以前那种检查就挺好的（ 文档的 copy button 当时给他们的 demo 也是用的这个逻辑（当然是改成 JS），毕竟 copy button 还是要同时兼容新旧格式的 |
|
现在报错怎么不在最下面了呢 
后面还有些其他信息，不太容易找到有效报错信息 |
There was a problem hiding this comment.
arguments = [
# flags, dest, type, default, help
['--gpu_id', 'gpu_id', int, 0, 'GPU device id to use [0]'],
['--logf', 'logf', str, None, 'file for logging'],
['--threads', 'threads', int, 0, 'sub processes number'],
]这里这个直接展开写成
parser.add_argument('--debug', dest='debug', action="store_true")
parser.add_argument('--full-test', dest='full_test', action="store_true")
parser.add_argument('mode', type=str, help='run on device', default='cpu')的形式吧，docs repo 那边也一样，这种写法很奇怪，也没必要
可能是 logger 的问题 ～ 我改一下试试 ～ |
tools/sampcd_processor_utils.py
Outdated
| type=int, | ||
| default=0, | ||
| help='sub processes number', | ||
| ) | ||
|
|
||
| if len(sys.argv) == 1: |
There was a problem hiding this comment.
这里的逻辑判断好奇怪，明明 required 还要设置默认值
我们修改一下吧，把 mode 改成 --mode，当然 CI 里的调用也需要改一下，这里的 if 也不需要了
python/paddle/tensor/creation.py
Outdated
* [Change] forbid legacy sample code style * [Change] remove legacy sampcd_processor.py * [Fix] fix command * [Change] check plain style sample code * [Fix] fix logger * [Change] remove arguments * [Change] remove cb_required * [Change] change parse args * [Change] restore creation.py
PR types
Others
PR changes
Others
Description
中国软件开源创新大赛：飞桨框架任务挑战赛
赛题五：将 xdoctest 引入到飞桨框架工作流中
RFC [Add]将 xdoctest 引入到飞桨框架工作流中v1
ISSUE 赛题五：将 xdoctest 引入到飞桨框架工作流中 Tracking Issue
第二阶段
任务：不再兼容旧格式
这里没有直接删除旧格式的检查。-
-
-
-
- 这里先没有使用
- 后面会修改 commit，检查
如果 commit 中包含
test=document_legacy，则开启旧格式的检查，以保持兼容性，或可以比对之前的检查结果（典型的如 distributed 目录）。此参数默认不开启，即，默认不支持旧格式，如果检查出来，则直接报错并退出。
涉及文件：
paddle/scripts/paddle_build.sh用于检查 commit 中test=document_legacy关键字。tools/sampcd_processor.py如果不使用 legacy，并检查出示例代码，则出错。tools/sampcd_processor_utils.py添加 legacy 关键字。python/paddle/tensor/creation.py临时文件，用于检查修改的正确性。test=document_legacy，预期 CI 会报错并退出。test=document_legacy关键字可用。直接删除掉原有
sampcd_processor.py用sampcd_processor_xdoctest.py代替。替换后，检查为
failed,timeout,nocode(无新样式示例代码或语法错误) 则提示错误并退出。涉及文件：
sampcd_processor.py删除sampcd_processor_xdoctest.py更名为sampcd_processor.pytest_sampcd_processor.py删除test_sampcd_processor_xdoctest.py更名为test_sampcd_processor.pypython/paddle/tensor/creation.py临时文件，用于检查修改的正确性。预期为：全部 nocode@SigureMo @luotao1 @jzhang533 @sunzhongkai588
请评审，谢谢！：）