修改 COPY-FROM No.6 metric

[RedContritio]

PR types

Others

PR changes

Docs

Description

• 修改目前 Paddle docs 中仍使用 code-block 的示例代码为 COPY-FROM docs#5957
• 修改 COPY-FROM No.6 metric docs#5971
• @sunzhongkai588 （这边 at 有用吗？）

更新 paddle.metric 中部分类与接口的 docstring，使支持新的中文文档生成方式。

[paddle-bot]

你的PR提交成功，感谢你对开源项目的贡献!
请关注后续CI自动化测试结果，详情请参考Paddle-CI手册。
Your PR has been submitted. Thanks for your contribution!
Please wait for the result of CI firstly. See Paddle CI Manual for details.

[RedContritio]

@sunzhongkai588

paddle.metric.Metric_example_1.py 和 paddle.metric.Metric_example_2.py 都是代码片段，所以无法运行，除非进行修改。

paddle.metric.Accuracy_example_2.py 包含训练过程，因此超过 10s 运行。

能否豁免 Static-Check？

[SigureMo]

paddle.metric.Metric_example_1.py 和 paddle.metric.Metric_example_2.py 都是代码片段，所以无法运行，除非进行修改。

按理说这样的函数没有调用不可能会出问题的，这里是解析出现了问题

@megemini 可否麻烦有时间看一下这里为什么解析出了问题呢？按理说这里不应该少这个缩进

[megemini]

问题是 extract_code_blocks_from_docstr 里面的这个 inspect.cleandoc 方法导致的。

参考 PEP 257 – Docstring Conventions

inspect.cleandoc 这个方法本来不是为 code 准备的，而是为 docstring 使用的。

而，docstring 中，默认第一行的缩进是无意义的：

Docstring processing tools will strip a uniform amount of indentation from the second and further lines of the docstring, equal to the minimum indentation of all non-blank lines after the first line. Any indentation in the first line of the docstring (i.e., up to the first newline) is insignificant and removed. Relative indentation of later lines in the docstring is retained.

也就是说，这个方法是按照第二行的缩进进行删减的，从而导致，如下的代码块可以正常解析：

In [80]: f
Out[80]: 
['            import paddle',
 '            with paddle.static.program_guard(main_program, startup_program):',
 "                data = paddle.static.data(name='image', shape=[None, 784, 784], dtype='float32')"]

In [81]: print(inspect.cleandoc('\n'.join(f)))
import paddle
with paddle.static.program_guard(main_program, startup_program):
    data = paddle.static.data(name='image', shape=[None, 784, 784], dtype='float32')

而，如下的代码块缩进会出问题：

In [82]: e
Out[82]: 
['            with paddle.static.program_guard(main_program, startup_program):',
 "                data = paddle.static.data(name='image', shape=[None, 784, 784], dtype='float32')"]

In [83]: print(inspect.cleandoc('\n'.join(e)))
with paddle.static.program_guard(main_program, startup_program):
data = paddle.static.data(name='image', shape=[None, 784, 784], dtype='float32')

解决办法可以有以下办法：

• 写 example 的时候，第一行加个 import xxx 之类无意义的东西
• 或者，修改 extract_code_blocks_from_docstr 中的 _append_code_block 方法，让 inspect.cleandoc 里面的这个代码块，追加一个空白的行（含缩进，与代码第一行相同的缩进）在第一个元素，如：

In [86]: ee = ['            '] + e

In [87]: print(inspect.cleandoc('\n'.join(ee)))
with paddle.static.program_guard(main_program, startup_program):
    data = paddle.static.data(name='image', shape=[None, 784, 784], dtype='float32')

[SigureMo]

或者，修改 extract_code_blocks_from_docstr 中的 _append_code_block 方法，让 inspect.cleandoc 里面的这个代码块，追加一个空白的行（含缩进，与代码第一行相同的缩进）在第一个元素，如：

我觉得后者可以试试，不过是否可以不加缩进呢？直接加 \n

我这边试了下貌似直接加 \n 就可以～

[megemini]

只要是空白行都可以 ～～～

那我提个 PR 改改？ Paddle 那边的 CI 也有这部分代码，要改吗？

[SigureMo]

嗯嗯，要改的，不然会有正确性问题的～正好拿这个作为测试样例

修改后 CI 通过就没问题啦～

[megemini]

docs PR

[Fix]fix cleandoc with a first blank line

Paddle PR

[Fix]fix cleandoc with a first blank line

[SigureMo]

paddle.metric.Accuracy_example_2.py 包含训练过程，因此超过 10s 运行。

看样子正确性是有保证的，这个不清楚是否可以豁免，如果不可以的话可以考虑 mock 一个数据集之类的

[paddle-ci-bot]

Sorry to inform you that 7afeac5's CIs have passed for more than 7 days. To prevent PR conflicts, you need to re-run all CIs manually.

[paddle-bot]

很抱歉，经过我们的反复讨论，你的PR暂未达到合入标准，请阅读飞桨原生算子开发规范，你可以重新提交新的PR，我们先将此PR关闭，感谢你的贡献。
Sorry to inform you that through our discussion, your PR fails to meet the merging standard (Reference: Paddle Custom Operator Design Doc). You can also submit an new one. Thank you.

[luotao1]

@megemini @SigureMo 请问任务6的这个PR 还需要继续进行么？

[megemini]

@megemini @SigureMo 请问任务6的这个PR 还需要继续进行么？

#55052 已经合入了，任务6应该已经完成，整体进度那边 Paddle 的 PR 改为 #55052 吧？

可否 @SigureMo ?

[SigureMo]

#55052 已经合入了，任务6应该已经完成，整体进度那边 Paddle 的 PR 改为 #55052 吧？

嗯嗯，本任务是英文 #55052 完成，中文 PaddlePaddle/docs#5971 完成