[xdoctest] reformat example code with google style in No.1-No.5 #55804

longranger2 · 2023-07-29T08:43:48Z

PR types

Others

PR changes

Others

Description

修改如下文件的示例代码为新的格式，并通过 xdoctest 检查：

python/paddle/batch.py
python/paddle/dataset/image.py
python/paddle/fft.py
python/paddle/metric/metrics.py
python/paddle/onnx/export.py

@sunzhongkai588 @SigureMo @megemini

[xdoctest] 分批次修改已有代码的示例 #55629

paddle-bot · 2023-07-29T08:43:53Z

你的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.

megemini

@SigureMo 对于 image 这种，CI 环境里没有吧？跳过测试？

megemini · 2023-07-29T09:26:21Z

python/paddle/batch.py

+            ...     print(data)
+            ...
+            >>> # Output is
+            >>> # [0, 1]
+            >>> # [2, 3]
+            >>> # [4, 5]
+            >>> # [6, 7]
+            >>> # [8, 9]


把 >>> # Output is 去掉，后面输出前面的 # 也去掉，这样xdoctest就可以比对输出的正确性了～

>>> for data in batch_reader(): ... print(data) [0, 1] [2, 3] [4, 5] [6, 7] [8, 9]

megemini · 2023-07-29T09:28:16Z

python/paddle/dataset/image.py

+        >>> with open('cat.jpg') as f:
+        ...     im = load_image_bytes(f.read())
+        ...


这个 cat.jpg CI 环境中应该没有吧？如果 CI 这里出错了，可以用 # doctest: +SKIP 把这部分示例跳过～

>>> # doctest: +SKIP >>> with open('cat.jpg') as f: ... im = load_image_bytes(f.read()) ...

@SigureMo 对于 image 这种，CI 环境里没有吧？跳过测试？

先不 skip 试试吧，如果没有的话之前也是过不了的，当时只能豁免，如果真的没有再 skip

另外确认一下，我们也是支持在 SKIP 后面加 skip reason 的吧

如果支持的话，还是建议加一下 reason，不然得翻 PR 才知道这段代码为啥 skip 了

如果支持的话，还是建议加一下 reason

必须支持！不过，当时在写 convert_directive 的 regex pattern 的时候，写的太严了，导致不能兼容带有描述的 skip～

#55811 已修改～

megemini · 2023-07-29T09:28:51Z

python/paddle/dataset/image.py

@@ -148,7 +148,7 @@ def load_image(file, is_color=True):

    .. code-block:: python

-        im = load_image('cat.jpg')
+        >>> im = load_image('cat.jpg')


megemini · 2023-07-29T09:29:04Z

python/paddle/dataset/image.py

+        >>> im = load_image('cat.jpg')
+        >>> im = resize_short(im, 256)


megemini · 2023-07-29T09:29:15Z

python/paddle/dataset/image.py

+        >>> im = load_image('cat.jpg')
+        >>> im = resize_short(im, 256)
+        >>> im = to_chw(im)


megemini · 2023-07-29T09:51:08Z

python/paddle/fft.py

+            >>> # Tensor(shape=[5], dtype=float32, place=Place(gpu:0), stop_gradient=True,
+            >>> #        [ 1.33333337, -1.33333337, -0.66666669,  0.        ,  0.66666669])


megemini · 2023-07-29T09:51:38Z

python/paddle/metric/metrics.py

+            >>> correct = m.compute(x, y)
+            >>> m.update(correct)
+            >>> res = m.accumulate()
+            >>> print(res) # 0.75


这里确少输出

megemini · 2023-07-29T09:51:54Z

python/paddle/metric/metrics.py

+            >>> m = paddle.metric.Precision()
+            >>> m.update(x, y)
+            >>> res = m.accumulate()
+            >>> print(res) # 1.0


缺少输出

megemini · 2023-07-29T09:52:07Z

python/paddle/metric/metrics.py

+            >>> m = paddle.metric.Recall()
+            >>> m.update(x, y)
+            >>> res = m.accumulate()
+            >>> print(res) # 2.0 / 3.0


megemini · 2023-07-29T09:52:42Z

python/paddle/metric/metrics.py

+            >>> predictions = paddle.to_tensor([[0.2, 0.1, 0.4, 0.1, 0.1], [0.2, 0.3, 0.1, 0.15, 0.25]], dtype='float32')
+            >>> label = paddle.to_tensor([[2], [0]], dtype="int64")
+            >>> result = paddle.metric.accuracy(input=predictions, label=label, k=1)
+            >>> # 0.5


用 print 显性的输出结果～

SigureMo

~~有一些应该是因为格式上对不上导致的错误，需要修正一下，有使用 convert-doctest doctest 进行本地测试吗？~~

秒修了啊，那我溜了

longranger2 · 2023-07-31T07:28:20Z

~~有一些应该是因为格式上对不上导致的错误，需要修正一下，有使用 convert-doctest doctest 进行本地测试吗？~~

秒修了啊，那我溜了

哈哈有的，本地是OK的，但看了CI的报错，好像是把空格也进行了识别

本地运行结果图：

CI的报错：

megemini · 2023-07-31T10:19:43Z

哈哈有的，本地是OK的，但看了CI的报错，好像是把空格也进行了识别

空格不影响的，这里只是日志打印的时候显示原始字符串～

看日志应该是 空行 的原因～ xdoctest 识别到空行会认为输出已经结束，所以只比对了 tensor 的一部分，并抛出错误～

megemini

对齐一下缩进吧～没用的空格删一下～

另外，

- im = center_crop(im, 224)
+ >>> im = center_crop(im, 224)

是不是应该先初始化一下

>>> im = load_image('cat.jpg')
>>> im = center_crop(im, 224)

megemini · 2023-07-31T10:41:46Z

python/paddle/fft.py

+        >>> x = paddle.to_tensor([0.0, 1.0, 0.0, 0.0])
+        >>> print(paddle.fft.rfft(x))
+        Tensor(shape=[3], dtype=complex64, place=Place(cpu), stop_gradient=True,
+                [ (1+0j), -1j    , (-1+0j)])


这里缩进对齐一下吧

Tensor(shape=[3], dtype=complex64, place=Place(cpu), stop_gradient=True, [ (1+0j), -1j , (-1+0j)])

megemini · 2023-07-31T10:42:14Z

python/paddle/fft.py

+            Tensor(shape=[4], dtype=float32, place=Place(cpu), stop_gradient=True,
+                    [0., 1., 0., 0.])


同上，对齐一下缩进～

megemini · 2023-07-31T10:42:26Z

python/paddle/fft.py

+            Tensor(shape=[4], dtype=float32, place=Place(cpu), stop_gradient=True,
+                    [0., 0., 0., 4.])


对齐缩进～

megemini · 2023-07-31T10:43:46Z

python/paddle/fft.py

+        Tensor(shape=[6], dtype=complex64, place=Place(cpu), stop_gradient=True,
+                [(-0.1666666716337204+0j),  (1-0j)                 ,
+                (2.3333334922790527-0j),  (3.5+0j)               ,
+                (2.3333334922790527+0j),  (1+0j)                 ])
+
+        >>> print(paddle.fft.ihfft(spectrum))
+        Tensor(shape = [4], dtype = complex64, place = Place(cpu), stop_gradient = True,
+                [(-0.1666666716337204+0j),  (1-0j),
+                (2.3333334922790527-0j),  (3.5+0j)])


对齐缩进，另外，没必要的空格也删一下吧～

Tensor(shape=[6], dtype=complex64, place=Place(cpu), stop_gradient=True, [(-0.1666666716337204+0j), (1-0j), (2.3333334922790527-0j), (3.5+0j), (2.3333334922790527+0j), (1+0j)])

megemini · 2023-07-31T10:44:24Z

python/paddle/fft.py

+            Tensor(shape=[4, 4, 4], dtype=complex128, place=Place(cpu), stop_gradient=True,
+                    [[[(24+0j),  0j    ,  0j    ,  -0j   ],
+                    [(-8+8j),  0j    ,  0j    ,  -0j   ],
+                    [(-8+0j),  0j    ,  0j    ,  -0j   ],
+                    [(-8-8j),  0j    ,  0j    ,  -0j   ]],
+                    [[(24+0j),  0j    ,  0j    ,  -0j   ],
+                    [(-8+8j),  0j    ,  0j    ,  -0j   ],
+                    [(-8+0j),  0j    ,  0j    ,  -0j   ],
+                    [(-8-8j),  0j    ,  0j    ,  -0j   ]],
+                    [[(24+0j),  0j    ,  0j    ,  -0j   ],
+                    [(-8+8j),  0j    ,  0j    ,  -0j   ],
+                    [(-8+0j),  0j    ,  0j    ,  -0j   ],
+                    [(-8-8j),  0j    ,  0j    ,  -0j   ]],
+                    [[(24+0j),  0j    ,  0j    ,  -0j   ],
+                    [(-8+8j),  0j    ,  0j    ,  -0j   ],
+                    [(-8+0j),  0j    ,  0j    ,  -0j   ],
+                    [(-8-8j),  0j    ,  0j    ,  -0j   ]]])


对齐一下缩进～

megemini · 2023-07-31T10:46:07Z

python/paddle/fft.py

+            Tensor(shape=[2, 2], dtype=complex128, place=Place(cpu), stop_gradient=True,
+                    [[ (0.5+0j),  0j      ],
+                    [(-0.5+0j),  0j      ]])


对齐缩进

megemini · 2023-07-31T10:46:21Z

python/paddle/fft.py

+            Tensor(shape=[2, 4], dtype=float32, place=Place(cpu), stop_gradient=True,
+                    [[ 2.37500000, -1.12500000,  0.37500000,  0.87500000],
+                    [ 0.12500000,  0.12500000,  0.12500000,  0.12500000]])


对齐缩进

megemini · 2023-07-31T10:46:29Z

python/paddle/fft.py

+            Tensor(shape=[2, 4], dtype=float32, place=Place(cpu), stop_gradient=True,
+                    [[19.,  7.,  3., -9.],
+                    [ 1.,  1.,  1.,  1.]])


对齐缩进

megemini · 2023-07-31T10:46:39Z

python/paddle/fft.py

+            Tensor(shape=[5, 5], dtype=float64, place=Place(cpu), stop_gradient=True,
+                    [[0., 0., 0., 0., 0.],
+                    [1., 1., 1., 1., 1.],
+                    [2., 2., 2., 2., 2.],
+                    [3., 3., 3., 3., 3.],
+                    [4., 4., 4., 4., 4.]])


对齐缩进

megemini · 2023-07-31T10:46:51Z

python/paddle/fft.py

+            >>> fftfreq_xp = paddle.fft.fftfreq(5, d=scalar_temp)
+            >>> print(fftfreq_xp)
+            Tensor(shape=[5], dtype=float32, place=Place(cpu), stop_gradient=True,
+                    [ 0.        ,  0.40000001,  0.80000001, -0.80000001, -0.40000001])


对齐缩进

后面的相应也都对齐一下吧～

longranger2 · 2023-07-31T23:21:12Z

@megemini @SigureMo 修改好了，辛苦review下～

SigureMo

括号对齐一下会好看些

SigureMo · 2023-08-01T01:44:28Z

python/paddle/fft.py

+            [[(24+0j), 0j, 0j, -0j],
+            [(-8+8j), 0j, 0j, -0j],
+            [(-8+0j), 0j, 0j, -0j],
+            [(-8-8j), 0j, 0j, -0j]]])


- [[[1, 2], - [3, 4]]] + [[[1, 2], + [3, 4]]]

括号对齐一下吧

SigureMo · 2023-08-01T01:44:41Z

python/paddle/fft.py

+            [0j, 0j, 0j]],
+            [[0j, 0j, 0j],
+            [0j, 0j, 0j],
+            [0j, 0j, 0j]]])


下面还有一些

longranger2 · 2023-08-01T02:04:26Z

括号对齐一下会好看些

好的，我修改下～

megemini · 2023-08-01T06:43:08Z

xdoctest
doc preview(抽看了几个，copy from 的代码没问题)

LGTM ：）

SigureMo

LGTM~

fix sample for batch.py, image.py, fft.py, metrics.py, export.py

2ba235a

paddle-bot bot added contributor External developers status: proposed labels Jul 29, 2023

megemini reviewed Jul 29, 2023

View reviewed changes

longranger2 added 2 commits July 30, 2023 09:10

fix errors

4963dac

fix error test=docs_preview

a496ed8

longranger2 force-pushed the xdoctest1 branch from 036ea7b to a496ed8 Compare July 31, 2023 03:24

SigureMo mentioned this pull request Jul 31, 2023

[xdoctest] 分批次修改已有代码的示例 #55629

Closed

luotao1 added the HappyOpenSource 快乐开源活动issue与PR label Jul 31, 2023

paddle-bot bot removed the status: proposed label Jul 31, 2023

luotao1 assigned luotao1, SigureMo and sunzhongkai588 Jul 31, 2023

SigureMo reviewed Jul 31, 2023

View reviewed changes

fix errors

a04cf6e

longranger2 requested review from megemini and SigureMo July 31, 2023 10:09

megemini reviewed Jul 31, 2023

View reviewed changes

longranger2 requested a review from megemini July 31, 2023 15:20

fix style

791900d

longranger2 force-pushed the xdoctest1 branch from a7d523b to 791900d Compare July 31, 2023 15:22

SigureMo reviewed Aug 1, 2023

View reviewed changes

fix style

4645d6e

longranger2 requested a review from SigureMo August 1, 2023 05:13

SigureMo approved these changes Aug 1, 2023

View reviewed changes

luotao1 merged commit 9084a03 into PaddlePaddle:develop Aug 1, 2023

longranger2 deleted the xdoctest1 branch August 1, 2023 07:56

luotao1 added HappyOpenSource Pro 进阶版快乐开源活动，更具挑战性的任务 and removed HappyOpenSource 快乐开源活动issue与PR labels Aug 7, 2023

		>>> im = load_image('cat.jpg')
		>>> im = resize_short(im, 256)

		>>> # Tensor(shape=[5], dtype=float32, place=Place(gpu:0), stop_gradient=True,
		>>> # [ 1.33333337, -1.33333337, -0.66666669, 0. , 0.66666669])

		Tensor(shape=[4], dtype=float32, place=Place(cpu), stop_gradient=True,
		[0., 1., 0., 0.])

		Tensor(shape=[4], dtype=float32, place=Place(cpu), stop_gradient=True,
		[0., 0., 0., 4.])

[xdoctest] reformat example code with google style in No.1-No.5 #55804

[xdoctest] reformat example code with google style in No.1-No.5 #55804

Conversation

longranger2 commented Jul 29, 2023 • edited Loading

PR types

PR changes

Description

paddle-bot bot commented Jul 29, 2023

megemini left a 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

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 • edited Loading

Choose a reason for hiding this comment

longranger2 commented Jul 31, 2023 • edited Loading

megemini commented Jul 31, 2023

megemini left a 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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

longranger2 commented Jul 31, 2023

SigureMo left a comment

Choose a reason for hiding this comment

SigureMo Aug 1, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

longranger2 commented Aug 1, 2023

megemini commented Aug 1, 2023

SigureMo left a comment

Choose a reason for hiding this comment

longranger2 commented Jul 29, 2023 •

edited

Loading

SigureMo left a comment •

edited

Loading

longranger2 commented Jul 31, 2023 •

edited

Loading

SigureMo Aug 1, 2023 •

edited

Loading