[xdoctest] reformat example code with google style No.116-119 #56118

AndSonder · 2023-08-09T11:13:13Z

PR types

Others

PR changes

Others

Description

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

python/paddle/optimizer/optimizer.py
python/paddle/quantization/config.py
python/paddle/quantization/factory.py
python/paddle/quantization/imperative/qat.py

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

paddle-bot · 2023-08-09T11:13:18Z

你的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-10T01:40:14Z

python/paddle/optimizer/optimizer.py

+                ...     adam.set_lr(lr_list[i])
+                ...     lr = adam.get_lr()
+                ...     print("current lr is {}".format(lr))
+                Print:


输出结果里没有 Print:

SigureMo · 2023-08-10T01:41:23Z

python/paddle/quantization/imperative/qat.py

+            >>> from paddle.static.quantization \
+            ...     import ImperativeQuantAware


import 代码风格改一下吧

>>> from paddle.static.quantization import ( ... ImperativeQuantAware, ... )

SigureMo · 2023-08-10T01:43:48Z

python/paddle/quantization/config.py

-          print(q_config)
+          >>> quanter = FakeQuanterWithAbsMaxObserver(moving_rate=0.9)
+          >>> q_config = QuantConfig(activation=quanter, weight=quanter)
+          >>> print(q_config)


这里输出方便打印么？方便的话最好加一下输出，如果输出随机可以考虑 skip，如果输出太多可以考虑用 ... 或者不写

AndSonder · 2023-08-10T06:08:28Z

@SigureMo Done~

SigureMo

都一样哈，如果合适就贴一下输出，不合适就不用了

SigureMo · 2023-08-10T06:11:40Z

python/paddle/quantization/config.py

+             >>> quanter = FakeQuanterWithAbsMaxObserver(moving_rate=0.9)
+             >>> q_config = QuantConfig(activation=None, weight=None)
+             >>> q_config.add_layer_config([model.fc], activation=quanter, weight=quanter)
+             >>> print(q_config)


SigureMo · 2023-08-10T06:11:55Z

python/paddle/quantization/config.py

+             >>> quanter = FakeQuanterWithAbsMaxObserver(moving_rate=0.9)
+             >>> q_config = QuantConfig(activation=None, weight=None)
+             >>> q_config.add_name_config([model.fc.full_name()], activation=quanter, weight=quanter)
+             >>> print(q_config)


还有这里

SigureMo · 2023-08-10T06:12:03Z

python/paddle/quantization/config.py

+            >>> quanter = FakeQuanterWithAbsMaxObserver(moving_rate=0.9)
+            >>> q_config = QuantConfig(activation=None, weight=None)
+            >>> q_config.add_type_config([Linear], activation=quanter, weight=quanter)
+            >>> print(q_config)


SigureMo · 2023-08-10T06:28:20Z

python/paddle/quantization/config.py

+             Global config:
+             None
+             Layer prefix config: 
+             {'linear_0': <paddle.quantization.config.SingleLayerConfig object at 0x7fe41a680ee0>}


这里有内存地址的肯定不能保证输出一致的，可以用 # doctest: +SKIP 跳过输出检查

这里有内存地址的肯定不能保证输出一致的，可以用 # doctest: +SKIP 跳过输出检查

done

SigureMo · 2023-08-11T03:02:44Z

code style 需要处理一下

SigureMo · 2023-08-11T05:06:29Z

codestyle 流水线，应该是有 trailing whitespace，pre-commit 处理一下就行了

SigureMo · 2023-08-12T09:06:14Z

python/paddle/quantization/factory.py

+            >>> arg1_value = "test"
+            >>> kwarg1_value = 20
+            >>> quanter = CustomizedQuanter(arg1_value, kwarg1=kwarg1_value)
+            >>> q_config = QuantConfig(activation=quanter, weight=quanter)



这段代码看起来不能在 xdoctest 环境跑，skip 掉吧

SigureMo

LGTMeow 🐾

megemini · 2023-08-13T05:42:14Z

python/paddle/quantization/config.py

@@ -155,20 +163,25 @@ def add_name_config(
         Examples:
        .. code-block:: python


.. code-block::python 要缩进

megemini · 2023-08-13T05:42:23Z

python/paddle/quantization/config.py

@@ -200,20 +213,25 @@ def add_type_config(
        Examples:
        .. code-block:: python


megemini · 2023-08-13T05:42:36Z

python/paddle/quantization/config.py

@@ -242,16 +260,16 @@ def add_qat_layer_mapping(self, source: type, target: type):
        Examples:
        .. code-block:: python


megemini · 2023-08-13T05:42:43Z

python/paddle/quantization/config.py

@@ -274,11 +292,11 @@ def add_customized_leaf(self, layer_type: type):
        Examples:
        .. code-block:: python


megemini · 2023-08-13T05:42:51Z

python/paddle/quantization/config.py

@@ -381,20 +399,20 @@ def _specify(self, model: Layer):
        Examples:
        .. code-block:: python


megemini · 2023-08-13T05:45:07Z

python/paddle/quantization/imperative/qat.py

@@ -247,37 +250,38 @@ def quantize(self, model):
        Examples:
        .. code-block:: python


megemini · 2023-08-13T05:47:42Z

python/paddle/optimizer/optimizer.py

+                ...     input = paddle.randint(low=0, high=5, shape=[5])
+                ...     out = emb(input)
+                ...     out.backward()
+                ...     print("Learning rate of step{}: {}".format(batch, adam.get_lr())) # 0.01


这里要有输出～

megemini · 2023-08-13T05:51:51Z

python/paddle/optimizer/optimizer.py

+                ...     print("Learning rate of step{}: {}".format(batch, adam.get_lr())) # 0.5->0.05...
+                ...     adam.step()
+                ...     scheduler.step()


这里要有输出～

megemini · 2023-08-13T05:52:13Z

python/paddle/optimizer/optimizer.py

+                ...     print("Learning rate of step{}: {}", adam.get_lr())     # 0.5->0.05->0.005...
+                ...     out = exe.run(main_prog, feed={'x': np.random.randn(3, 10).astype('float32')})
+                ...     scheduler.step()


要有输出～

megemini · 2023-08-13T05:56:50Z

python/paddle/quantization/factory.py

+            >>> # Given codes in ./customized_quanter.py
+            >>> from paddle.quantization import quanter
+            >>> from paddle.quantization import BaseQuanter
+            >>> @quanter("CustomizedQuanter")
+            >>> class CustomizedQuanterLayer(BaseQuanter):
+            ...     def __init__(self, arg1, kwarg1=None):
+            ...         pass
+
+            >>> # Used in ./test.py
+            >>> # from .customized_quanter import CustomizedQuanter
+            >>> from paddle.quantization import QuantConfig
+            >>> # doctest: +SKIP
+            >>> arg1_value = "test"
+            >>> kwarg1_value = 20
+            >>> quanter = CustomizedQuanter(arg1_value, kwarg1=kwarg1_value)
+            >>> q_config = QuantConfig(activation=quanter, weight=quanter)


整段 skip 吧～

AndSonder · 2023-08-13T09:52:18Z

麻烦再review一下~ @megemini

megemini

Examples 1: 要改一下哈～

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

python/paddle/optimizer/optimizer.py

+                Learning rate of step{}: {} 0.5
+                Learning rate of step{}: {} 0.5
+                Learning rate of step{}: {} 0.05
+                Learning rate of step{}: {} 0.05
+                Learning rate of step{}: {} 0.005000000000000001
+                Learning rate of step{}: {} 0.005000000000000001
+                Learning rate of step{}: {} 0.0005000000000000001
+                Learning rate of step{}: {} 0.0005000000000000001
+                Learning rate of step{}: {} 5.000000000000001e-05
+                Learning rate of step{}: {} 5.000000000000001e-05


print("Learning rate of step{}: {}", adam.get_lr()) -> print("Learning rate of step{}: {}", batch, adam.get_lr())

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

python/paddle/quantization/config.py

         Examples:
        .. code-block:: python


.. code-block:: python 要有缩进～

这居然还反向缩进了:joy:，缩退么 [doge]

整段 docstring 的缩进都有问题，不要多余的一个空格

这个是原来的缩进就有问题，我改漏了, 已经改过来了, 实在不好意思，改的时候可能整段的缩进出问题了

SigureMo · 2023-08-14T13:32:33Z

python/paddle/quantization/imperative/qat.py

+                >>> # Save quant model for the inference.
+                >>> imperative_qat.save_quantized_model(
+                ...    layer=model,
+                ...    model_path="./imperative_model_qat")


不要写成

Examples: .. code-block:: python >>> xxxxx Examples: .. code-block:: python >>> yyyyy

而是写成

Examples: .. code-block:: python :name: code-example-1 >>> xxxxx .. code-block:: python :name: code-example-2 >>> yyyyy

因为本 API 非公开 API，所以就不用添加 name 了，写成下面即可：

Examples: .. code-block:: python >>> xxxxx .. code-block:: python >>> yyyyy

简单来说就是删除第二个 Examples: 这一行

SigureMo

LGTMeow 🐾

AndSonder added 2 commits August 9, 2023 11:06

update

53e6fbf

update

7757ffa

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

SigureMo reviewed Aug 10, 2023

View reviewed changes

AndSonder added 4 commits August 10, 2023 14:01

Update optimizer.py

1c556a8

Update config.py

4512536

Update qat.py

ff8cade

Update qat.py

b7e140f

SigureMo previously approved these changes Aug 10, 2023

View reviewed changes

Update config.py

fbd15b0

AndSonder dismissed SigureMo’s stale review via fbd15b0 August 10, 2023 06:17

SigureMo reviewed Aug 10, 2023

View reviewed changes

Update config.py

bf8e8a1

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

AndSonder added 2 commits August 11, 2023 05:16

update test=docs_preview

1b1c300

update

717ffca

SigureMo reviewed Aug 12, 2023

View reviewed changes

Update factory.py

36ad3c8

SigureMo previously approved these changes Aug 12, 2023

View reviewed changes

megemini reviewed Aug 13, 2023

View reviewed changes

fix docs

0d0728a

AndSonder dismissed SigureMo’s stale review via 0d0728a August 13, 2023 09:51

megemini reviewed Aug 14, 2023

View reviewed changes

AndSonder added 2 commits August 14, 2023 05:38

update

ceaa0ef

update

e9b30d9

SigureMo reviewed Aug 14, 2023

View reviewed changes

Update qat.py

25779f7

SigureMo approved these changes Aug 14, 2023

View reviewed changes

luotao1 merged commit 0c5781e into PaddlePaddle:develop Aug 15, 2023

luotao1 mentioned this pull request Aug 15, 2023

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

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[xdoctest] reformat example code with google style No.116-119 #56118

[xdoctest] reformat example code with google style No.116-119 #56118

AndSonder commented Aug 9, 2023

paddle-bot bot commented Aug 9, 2023

SigureMo Aug 10, 2023

SigureMo Aug 10, 2023

SigureMo Aug 10, 2023

AndSonder commented Aug 10, 2023

SigureMo left a comment

SigureMo Aug 10, 2023

SigureMo Aug 10, 2023

SigureMo Aug 10, 2023

AndSonder Aug 10, 2023

SigureMo Aug 10, 2023

AndSonder Aug 10, 2023

SigureMo commented Aug 11, 2023

SigureMo commented Aug 11, 2023

SigureMo Aug 12, 2023

SigureMo left a comment

megemini Aug 13, 2023

megemini Aug 13, 2023

megemini Aug 13, 2023

megemini Aug 13, 2023

megemini Aug 13, 2023

megemini Aug 13, 2023

megemini Aug 13, 2023

megemini Aug 13, 2023

megemini Aug 13, 2023

megemini Aug 13, 2023

AndSonder commented Aug 13, 2023

megemini left a comment

megemini Aug 14, 2023

megemini Aug 14, 2023

SigureMo Aug 14, 2023 •

edited

Loading

AndSonder Aug 14, 2023 •

edited

Loading

SigureMo Aug 14, 2023

SigureMo left a comment

		>>> from paddle.static.quantization \
		... import ImperativeQuantAware

		@@ -155,20 +163,25 @@ def add_name_config(
		Examples:
		.. code-block:: python

		@@ -200,20 +213,25 @@ def add_type_config(
		Examples:
		.. code-block:: python

		@@ -242,16 +260,16 @@ def add_qat_layer_mapping(self, source: type, target: type):
		Examples:
		.. code-block:: python

		@@ -274,11 +292,11 @@ def add_customized_leaf(self, layer_type: type):
		Examples:
		.. code-block:: python

		@@ -381,20 +399,20 @@ def _specify(self, model: Layer):
		Examples:
		.. code-block:: python

		@@ -247,37 +250,38 @@ def quantize(self, model):
		Examples:
		.. code-block:: python

[xdoctest] reformat example code with google style No.116-119 #56118

[xdoctest] reformat example code with google style No.116-119 #56118

Conversation

AndSonder commented Aug 9, 2023

PR types

PR changes

Description

paddle-bot bot commented Aug 9, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

AndSonder commented Aug 10, 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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

SigureMo commented Aug 11, 2023

SigureMo commented Aug 11, 2023

Choose a reason for hiding this comment

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

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

AndSonder commented Aug 13, 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

SigureMo Aug 14, 2023 • edited Loading

Choose a reason for hiding this comment

AndSonder Aug 14, 2023 • edited Loading

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

SigureMo Aug 14, 2023 •

edited

Loading

AndSonder Aug 14, 2023 •

edited

Loading