[xdoctest] reformat example code with google style in No.6-No.10 #56146

longranger2 · 2023-08-10T04:50:53Z

PR types

Others

PR changes

Others

Description

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

python/paddle/reader/init.py
python/paddle/reader/decorator.py
python/paddle/signal.py
python/paddle/regularizer.py
python/paddle/sysconfig.py

@sunzhongkai588 @SigureMo @megemini

decorator.py中的示例代码调用了fluid目录的函数，8/25 号之前 fluid rename 成 base，在之前不要修改 fluid 下的代码，因此该PR delay
[xdoctest] 分批次修改已有代码的示例 #55629

paddle-bot · 2023-08-10T04:50:58Z

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

SigureMo · 2023-08-12T09:30:02Z

python/paddle/reader/decorator.py

+            >>> # All data is cached into memory
+            >>> cached_reader = paddle.io.cache(reader)
+
+            >>> # Output: 0 1 2


已经有输出了，就不需要注释了

SigureMo · 2023-08-12T09:30:21Z

python/paddle/reader/decorator.py

+            >>> # Output: 0 1 2
+            >>> for i in cached_reader():
+            ...     print(i)
+            0 1 2


这里输出是在一行的？

SigureMo · 2023-08-12T09:34:57Z

python/paddle/reader/decorator.py

+            >>> def reader():
+            ...     for i in range(5):
+            ...         yield i
+            >>> shuffled_reader = fluid.io.shuffle(reader, 3)


不要用 fluid API 了，用 paddle.reader.decorator.shuffle 吧

SigureMo · 2023-08-12T09:35:26Z

python/paddle/reader/decorator.py

@@ -142,15 +143,16 @@ def shuffle(reader, buf_size):
    Examples:
        .. code-block:: python

-            import paddle.fluid as fluid
+            >>> # doctest: +SKIP('outputs are 0~4 unordered arrangement')
+            >>> import paddle.fluid as fluid


fluid 相关 import 也要删掉

SigureMo · 2023-08-12T09:35:53Z

python/paddle/reader/decorator.py

+            ...         for i in range(10):
+            ...             yield i
+            ...     return reader
+            >>> reader = fluid.io.compose(reader_creator_10(0), reader_creator_10(0))


这个是否也可以替换成非 fluid API（不一定需要是公开的）

SigureMo · 2023-08-12T09:36:08Z

python/paddle/reader/decorator.py

+            >>> def reader():
+            ...     for i in range(100):
+            ...         yield i
+            >>> firstn_reader = fluid.io.firstn(reader, 5)


SigureMo · 2023-08-12T09:36:17Z

python/paddle/reader/decorator.py

+            >>> firstn_reader = fluid.io.firstn(reader, 5)
+            >>> for e in firstn_reader():
+            ...     print(e)
+            0 1 2 3 4


SigureMo · 2023-08-12T09:36:41Z

python/paddle/reader/decorator.py

-                    # [[[9 10]], [[11 12]]]
-                    # [13,14] will be dropped
-
+        >>> import paddle


528 和 529 中间需要空一行

SigureMo · 2023-08-12T09:37:12Z

python/paddle/signal.py


-            np.allclose(x, x_)  # True
+            >>> np.allclose(x, x_)  # True


后面注释可以删掉了

megemini · 2023-08-13T06:03:22Z

python/paddle/reader/decorator.py

+        >>> import paddle.fluid as fluid
+        >>> from paddle.fluid.io import multiprocess_reader


参考 @SigureMo 的～不要用fluid的api了～

megemini · 2023-08-13T06:04:04Z

python/paddle/regularizer.py

-                    padding=0,
-                    weight_attr=ParamAttr(regularizer=L2Decay(coeff=0.01)),
-                    bias_attr=False)
+            >>> # Example2: set Regularizer in parameters


上面空一行～

megemini · 2023-08-13T06:05:45Z

python/paddle/signal.py

+        >>> y0 = frame(x, frame_length=4, hop_length=2, axis=-1)
+        [[0, 2, 4],
+         [1, 3, 5],
+         [2, 4, 6],
+         [3, 5, 7]]


如果要输出的话，最好 print ～另外，最好 frame -> signal.frame

>>> import paddle >>> from paddle import signal >>> # 1D >>> x = paddle.arange(8) >>> y0 = signal.frame(x, frame_length=4, hop_length=2, axis=-1) >>> print(y0) Tensor(shape=[4, 3], dtype=int64, place=Place(cpu), stop_gradient=True, [[0, 2, 4], [1, 3, 5], [2, 4, 6], [3, 5, 7]])

下同～

megemini · 2023-08-13T06:12:24Z

python/paddle/signal.py


-            paddle.seed(0)
+            >>> paddle.seed(0)convert-doctest --debug doctest


这里语法错误了，导致测试跳过～

emmm，这个问题也得记一下，最好有办法检测这个

megemini

有个临时生成的文件 sample_file_1 不要加进来～

最好不要用 git add .

megemini · 2023-08-16T06:04:50Z

python/paddle/reader/__init__.py

+    >>> def reader_creator_random_image(width, height):
+    ...     def reader():
+    ...         while True:
+    ...             yield numpy.random.uniform(-1, 1, size=width*height)
+    >>> return reader


>>> def reader_creator_random_image(width, height): ... def reader(): ... while True: ... yield numpy.random.uniform(-1, 1, size=width*height) >>> return reader

应该在内部返回

>>> def reader_creator_random_image(width, height): ... def reader(): ... while True: ... yield numpy.random.uniform(-1, 1, size=width*height) ... return reader

megemini · 2023-08-16T06:05:08Z

python/paddle/reader/__init__.py

+    >>> def reader_creator_random_image_and_label(width, height, label):
+    ...     def reader():
+    ...         while True:
+    ...             yield numpy.random.uniform(-1, 1, size=width*height), label
+    >>> return reader


megemini · 2023-08-16T06:09:01Z

python/paddle/reader/decorator.py

@@ -524,59 +528,55 @@ def multiprocess_reader(readers, use_pipe=True, queue_size=1000):
    Example:

    .. code-block:: python


.. code-block:: python 要相对 Examples: 有缩进～

python/paddle/reader/decorator.py 下的 multiprocess_reader 里面的 .. code-block:: python 木有缩进～是我这边没更新？！？！

这里确实没解决呢 @longranger2

megemini · 2023-08-16T06:20:32Z

python/paddle/reader/decorator.py

+        >>> def fake_input_files():
+        ...     with open(sample_files[0], 'w') as f:
+        ...         np.savez(f, a=np.array([1, 2]), b=np.array([3, 4]), c=np.array([5, 6]), d=np.array([7, 8]))
+        ...     with open(sample_files[1], 'w') as f:
+        ...         np.savez(f, a=np.array([9, 10]), b=np.array([11, 12]), c=np.array([13, 14]))


np.savez 直接传文件名称的字符串，或者用 'wb' ~

megemini · 2023-08-16T06:22:47Z

python/paddle/regularizer.py

+            >>> from paddle.regularizer import L2Decay
+
+            >>> my_conv2d = Conv2D(
+            ...         in_channels=10,
+            ...         out_channels=10,
+            ...         kernel_size=1,
+            ...         stride=1,
+            ...         padding=0,
+            ...         weight_attr=ParamAttr(regularizer=L2Decay(coeff=0.01)),
+            ...         bias_attr=False)


这里是 L1Decay 吧～

这里是 L1Decay 吧～

@megemini 这是为什么呢？

@megemini 标 WIP 的可以暂缓 review 吧，我看你 review 了一些 WIP 的 PR

@megemini 标 WIP 的可以暂缓 review 吧，我看你 review 了一些 WIP 的 PR

OK

这里是 L1Decay 吧～

@megemini 这是为什么呢？

这个是在 L1Decay 里面的示例啊～

这里是 L1Decay 吧～

@megemini 这是为什么呢？

这个是在 L1Decay 里面的示例啊～

哦哦好的，现在才发现[捂脸]

megemini · 2023-08-16T06:24:35Z

python/paddle/signal.py

@@ -51,58 +51,52 @@ def frame(x, frame_length, hop_length, axis=-1, name=None):

    .. code-block:: python


.. code-block:: python 与上面的 Examples: 要有缩进～

megemini · 2023-08-16T06:26:36Z

python/paddle/signal.py

+        >>> # 1D
+        >>> x = paddle.arange(8)
+        >>> y0 = signal.frame(x, frame_length=4, hop_length=2, axis=-1)
+        >>> print(y0)
+        [[0, 2, 4],
+         [1, 3, 5],
+         [2, 4, 6],
+         [3, 5, 7]]
+
+        >>> y1 = signal.frame(x, frame_length=4, hop_length=2, axis=0)
+        >>> print(y1)
+        [[0, 1, 2, 3],
+         [2, 3, 4, 5],
+         [4, 5, 6, 7]]
+
+        >>> # 2D
+        >>> x0 = paddle.arange(16).reshape([2, 8])
+        >>> y0 = signal.frame(x0, frame_length=4, hop_length=2, axis=-1)
+        >>> print(y0)
+        [[[0, 2, 4],
+          [1, 3, 5],
+          [2, 4, 6],
+          [3, 5, 7]],
+         [[8 , 10, 12],
+          [9 , 11, 13],
+          [10, 12, 14],
+          [11, 13, 15]]]


这里的输出应该是 Tensor 吧～

megemini · 2023-08-16T06:27:16Z

python/paddle/signal.py

@@ -169,34 +163,44 @@ def overlap_add(x, hop_length, axis=-1, name=None):

    .. code-block:: python


.. code-block:: python 与上面的 Examples: 要有缩进～

megemini · 2023-08-16T06:27:55Z

python/paddle/signal.py

+        >>> # 2D
+        >>> x0 = paddle.arange(16).reshape([8, 2])
+        >>> print(x0)
+        [[0 , 1 ],
+         [2 , 3 ],
+         [4 , 5 ],
+         [6 , 7 ],
+         [8 , 9 ],
+         [10, 11],
+         [12, 13],
+         [14, 15]]
+
+        >>> y0 = overlap_add(x0, hop_length=2, axis=-1)
+        >>> print(y0)
+        [0 , 2 , 5 , 9 , 13, 17, 21, 25, 13, 15]
+
+        >>> x1 = paddle.arange(16).reshape([2, 8])
+        >>> print(x1)
+        [[0 , 1 , 2 , 3 , 4 , 5 , 6 , 7 ],
+         [8 , 9 , 10, 11, 12, 13, 14, 15]]
+
+        >>> y1 = overlap_add(x1, hop_length=2, axis=0)
+        >>> print(y1)
+        [0 , 1 , 10, 12, 14, 16, 18, 20, 14, 15]


megemini · 2023-08-16T06:28:25Z

python/paddle/signal.py

+
+        >>> x1 = paddle.arange(32).reshape([2, 8, 1, 2])
+        >>> y1 = overlap_add(x1, hop_length=2, axis=0)
+        >>> print(y1)


这里应该是输出的 y1.shape

paddle-ci-bot · 2023-08-23T03:02:08Z

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

SigureMo

根据群里讨论，无法替代的 fluid 改动暂时不改即可，这个 PR 可以修改推动一下了

SigureMo · 2023-08-24T11:49:34Z

sample_file_1

这个是？

megemini · 2023-08-28T04:14:07Z

python/paddle/reader/__init__.py

+    ...     def reader():
+    ...         while True:
+    ...             yield numpy.random.uniform(-1, 1, size=width*height)
+    >>>     return reader


这里应该用 ... 而不是 >>> ～

虽然从代码测试的角度，用 >>> 也能过测，但是，return reader 实际上是 def reader_creator_random_image(width, height): 这个函数的一部分，而不是单独的一句，所以，用 ... 更合适。

megemini · 2023-08-28T04:14:25Z

python/paddle/reader/__init__.py

+    ...     def reader():
+    ...         while True:
+    ...             yield numpy.random.uniform(-1, 1, size=width*height), label
+    >>>     return reader


SigureMo

ฅ LGTMeow ฅ

@megemini 确认一下？

megemini

python/paddle/reader/decorator.py 下的 multiprocess_reader 里面的 .. code-block:: python 木有缩进～是我这边没更新？！？！

longranger2 · 2023-08-29T06:36:08Z

python/paddle/reader/decorator.py 下的 multiprocess_reader 里面的 .. code-block:: python 木有缩进～是我这边没更新？！？！

done

megemini

LGTM ～辛苦！：）

luotao1 · 2023-08-29T07:21:06Z

需要解决下 PR-CI-Codestyle-Check 的问题

longranger2 · 2023-08-29T09:56:00Z

需要解决下 PR-CI-Codestyle-Check 的问题

done

SigureMo

LGTMeow 🐾

…dlePaddle#56146) * fix sample code * fix bug * fix bug * Update regularizer.py * Update __init__.py * Update decorator.py * fix code-style

fix sample code

11c2b9b

paddle-bot bot added contributor External developers status: proposed labels Aug 10, 2023

luotao1 assigned luotao1, SigureMo and sunzhongkai588 Aug 10, 2023

luotao1 added the HappyOpenSource Pro 进阶版快乐开源活动，更具挑战性的任务 label Aug 10, 2023

paddle-bot bot removed the status: proposed label Aug 10, 2023

Merge branch 'PaddlePaddle:develop' into xdoctest2

11b634e

SigureMo reviewed Aug 12, 2023

View reviewed changes

megemini reviewed Aug 13, 2023

View reviewed changes

longranger2 changed the title ~~[xdoctest] reformat example code with google style in No.6-No.10~~ [WIP] [xdoctest] reformat example code with google style in No.6-No.10 Aug 14, 2023

fix bug

cca196f

megemini reviewed Aug 16, 2023

View reviewed changes

SigureMo changed the title ~~[WIP] [xdoctest] reformat example code with google style in No.6-No.10~~ [waiting for fluid rename][xdoctest] reformat example code with google style in No.6-No.10 Aug 18, 2023

SigureMo changed the title ~~[waiting for fluid rename][xdoctest] reformat example code with google style in No.6-No.10~~ [xdoctest] reformat example code with google style in No.6-No.10 Aug 24, 2023

SigureMo reviewed Aug 24, 2023

View reviewed changes

sample_file_1 Outdated

Copy link

Member

SigureMo Aug 24, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

这个是？

fix bug

79762d8

longranger2 mentioned this pull request Aug 27, 2023

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

Closed

Update regularizer.py

4e74fee

megemini reviewed Aug 28, 2023

View reviewed changes

longranger2 added 2 commits August 29, 2023 10:08

Update __init__.py

bc010f1

Merge branch 'PaddlePaddle:develop' into xdoctest2

19b24f9

SigureMo previously approved these changes Aug 29, 2023

View reviewed changes

megemini reviewed Aug 29, 2023

View reviewed changes

Update decorator.py

e91b28f

longranger2 dismissed SigureMo’s stale review via e91b28f August 29, 2023 06:35

megemini approved these changes Aug 29, 2023

View reviewed changes

fix code-style

3535106

longranger2 requested a review from SigureMo August 30, 2023 01:04

SigureMo approved these changes Aug 30, 2023

View reviewed changes

luotao1 merged commit fc1e505 into PaddlePaddle:develop Aug 30, 2023
24 of 26 checks passed

longranger2 deleted the xdoctest2 branch August 30, 2023 03:03

		>>> import paddle.fluid as fluid
		>>> from paddle.fluid.io import multiprocess_reader


		paddle.seed(0)
		>>> paddle.seed(0)convert-doctest --debug doctest

		@@ -524,59 +528,55 @@ def multiprocess_reader(readers, use_pipe=True, queue_size=1000):
		Example:

		.. code-block:: python

		@@ -51,58 +51,52 @@ def frame(x, frame_length, hop_length, axis=-1, name=None):

		.. code-block:: python

		@@ -169,34 +163,44 @@ def overlap_add(x, hop_length, axis=-1, name=None):

		.. code-block:: python

[xdoctest] reformat example code with google style in No.6-No.10 #56146

[xdoctest] reformat example code with google style in No.6-No.10 #56146

Conversation

longranger2 commented Aug 10, 2023 • edited

PR types

PR changes

Description

paddle-bot bot commented Aug 10, 2023

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

Choose a reason for hiding this comment

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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

paddle-ci-bot bot commented Aug 23, 2023

SigureMo 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

SigureMo left a comment

Choose a reason for hiding this comment

megemini left a comment

Choose a reason for hiding this comment

longranger2 commented Aug 29, 2023

megemini left a comment

Choose a reason for hiding this comment

luotao1 commented Aug 29, 2023

longranger2 commented Aug 29, 2023

SigureMo left a comment

Choose a reason for hiding this comment

longranger2 commented Aug 10, 2023 •

edited