[Docathon][Fix COPY-FROM No.11-15] #6310

Turingg · 2023-11-12T10:49:48Z

PR types
Bug fixes

PR changes
Docs

Description
Issue from：#6300 中文文档 copy-from 清理
涉及到的API有：
paddle.distributed.fleet.Fleet
paddle.optimizer.Adadelta
paddle.optimizer.AdamW
paddle.optimizer.Adam
paddle.optimizer.Adamax
以上文档中部分.. code-block:: python 之后没有空行（在不需要 name: code_id 标识符时）：添加空行

@ooooo-create @sunzhongkai588

paddle-bot · 2023-11-12T10:49:53Z

感谢你贡献飞桨文档，文档预览构建中，Docs-New 跑完后即可预览，预览链接：http://preview-pr-6310.paddle-docs-preview.paddlepaddle.org.cn/documentation/docs/zh/api/index_cn.html
预览工具的更多说明，请参考：飞桨文档预览工具

CLAassistant · 2023-11-12T10:49:54Z

All committers have signed the CLA.

把 ..code-block 删了改成copyfrom的形式

ooooo-create

赞！还有一些问题需要改一改~

ooooo-create · 2023-11-14T08:09:20Z

docs/api/paddle/distributed/fleet/Fleet_cn.rst

@@ -29,29 +29,29 @@ None

 **代码示例 1**

-.. code-block:: python
+COPY-FROM: paddle.distributed.fleet.Fleet


这里是属于 init 函数叭，改成COPY-FROM: paddle.distributed.fleet.Fleet.init:code-example1，后面类似~。
参考下面的
https://github.com/PaddlePaddle/Paddle/blob/816b34e729568fc244a7ac205df9d140f59a5ac0/python/paddle/distributed/fleet/fleet.py#L203C1-L207C33

同时，删除 .. code-block:: python 的时候也把下面的代码顺带一起删了~

ooooo-create · 2023-11-14T08:09:35Z

docs/api/paddle/distributed/fleet/Fleet_cn.rst


    import paddle.distributed.fleet as fleet
    fleet.init()

 **代码示例 2**

-.. code-block:: python
+COPY-FROM: paddle.distributed.fleet.Fleet


ooooo-create · 2023-11-14T08:09:41Z

docs/api/paddle/distributed/fleet/Fleet_cn.rst


    import paddle.distributed.fleet as fleet
    fleet.init(is_collective=True)

 **代码示例 3**

-.. code-block:: python
+COPY-FROM: paddle.distributed.fleet.Fleet


ooooo-create · 2023-11-14T08:09:51Z

docs/api/paddle/distributed/fleet/Fleet_cn.rst


    import paddle.distributed.fleet as fleet
    role = fleet.PaddleCloudRoleMaker()
    fleet.init(role)

 **代码示例 4**

-.. code-block:: python
+COPY-FROM: paddle.distributed.fleet.Fleet


ooooo-create · 2023-11-14T12:04:15Z

docs/api/paddle/distributed/fleet/Fleet_cn.rst

@@ -485,8 +485,7 @@ distributed_model(model)

 **代码示例**

-.. code-block:: python
-
+COPY-FROM: paddle.distributed.fleet.Fleet.distributed_model


这些包含下图的，暂时不用管，等孙师傅来看~~ @sunzhongkai588

现在这些都变回原来的样子叭

ooooo-create · 2023-11-14T12:09:52Z

docs/api/paddle/optimizer/Adamax_cn.rst

@@ -146,6 +146,7 @@ set_lr_scheduler(scheduler)
 **代码示例**

 .. code-block:: python


改成 copy-from 的形式叭~

ooooo-create · 2023-11-14T12:10:07Z

docs/api/paddle/optimizer/Adadelta_cn.rst

@@ -139,6 +139,7 @@ set_lr_scheduler(scheduler)
 **代码示例**

 .. code-block:: python
+


改成 copy-from 的形式叭~

ooooo-create · 2023-11-14T12:10:13Z

docs/api/paddle/optimizer/AdamW_cn.rst

@@ -143,6 +143,7 @@ set_lr_scheduler(scheduler)
 **代码示例**

 .. code-block:: python
+


改成 copy-from 的形式叭~

ooooo-create · 2023-11-14T12:10:17Z

docs/api/paddle/optimizer/Adam_cn.rst

@@ -162,6 +162,7 @@ set_lr_scheduler(scheduler)
 **代码示例**

 .. code-block:: python
+


改成 copy-from 的形式叭~

修正COPY-FROM: paddle.distributed.fleet.Fleet.init:code-example1 删去.. code-block:: python下面的代码顺带一起删了

改成 copy-from 的形式

…learning rate; 中文文档对应添加其中 start_lr 是初始学习率，而 end_lr 是最终学习率；

ooooo-create

修改一下~~

ooooo-create · 2023-11-18T02:35:03Z

docs/api/paddle/distributed/fleet/Fleet_cn.rst

-
-    import paddle.distributed.fleet as fleet
-    fleet.init(is_collective=True)
+COPY-FROM: paddle.distributed.fleet.Fleet.init:code-example1


Suggested change

COPY-FROM: paddle.distributed.fleet.Fleet.init:code-example1

COPY-FROM: paddle.distributed.fleet.Fleet.init:code-example2

ooooo-create · 2023-11-18T02:35:09Z

docs/api/paddle/distributed/fleet/Fleet_cn.rst

-    import paddle.distributed.fleet as fleet
-    role = fleet.PaddleCloudRoleMaker()
-    fleet.init(role)
+COPY-FROM: paddle.distributed.fleet.Fleet.init:code-example1


Suggested change

COPY-FROM: paddle.distributed.fleet.Fleet.init:code-example1

COPY-FROM: paddle.distributed.fleet.Fleet.init:code-example3

ooooo-create · 2023-11-18T02:35:18Z

docs/api/paddle/distributed/fleet/Fleet_cn.rst

-    import paddle.distributed.fleet as fleet
-    strategy = fleet.DistributedStrategy()
-    fleet.init(strategy=strategy)
+COPY-FROM: paddle.distributed.fleet.Fleet.init:code-example1


Suggested change

COPY-FROM: paddle.distributed.fleet.Fleet.init:code-example1

COPY-FROM: paddle.distributed.fleet.Fleet.init:code-example4

ooooo-create · 2023-11-18T02:37:40Z

docs/api/paddle/optimizer/AdamW_cn.rst

-    lr = adam.get_lr()
-    print("current lr is {}".format(lr))
-    #    current lr is 0.1
+COPY-FROM: paddle.optimizer.set_lr_scheduler


Suggested change

COPY-FROM: paddle.optimizer.set_lr_scheduler

COPY-FROM: paddle.optimizer.AdamW.set_lr_scheduler

ooooo-create · 2023-11-18T02:38:16Z

docs/api/paddle/optimizer/Adam_cn.rst

-    lr = adam.get_lr()
-    print("current lr is {}".format(lr))
-    #    current lr is 0.1
+COPY-FROM: paddle.optimizer.set_lr_scheduler


Suggested change

COPY-FROM: paddle.optimizer.set_lr_scheduler

COPY-FROM: paddle.optimizer.Adam.set_lr_scheduler

ooooo-create · 2023-11-21T09:20:57Z

docs/api/paddle/distributed/fleet/Fleet_cn.rst

-    if paddle.is_compiled_with_cuda() and len(paddle.static.cuda_places()) > 0:
-        run_example_code()
-
+COPY-FROM: paddle.distributed.fleet.Fleet.qat_init


这个改回原来的吧~，麻烦了~~

ooooo-create · 2023-11-21T09:21:35Z

docs/api/paddle/distributed/fleet/Fleet_cn.rst

@@ -485,8 +485,7 @@ distributed_model(model)

 **代码示例**

-.. code-block:: python
-
+COPY-FROM: paddle.distributed.fleet.Fleet.distributed_model


现在这些都变回原来的样子叭

ooooo-create · 2023-11-21T09:25:33Z

docs/api/paddle/optimizer/lr/LinearWarmup_cn.rst

@@ -13,6 +13,7 @@ LinearWarmup

    lr = start\_lr + (end\_lr - start\_lr) * \frac{epoch}{warmup\_steps}

+其中 start_lr 是初始学习率，而 end_lr 是最终学习率；


这个先不修改，另外提一个叭~~

sunzhongkai588 · 2023-11-23T03:28:23Z

docs/api/paddle/distributed/fleet/Fleet_cn.rst

针对Fleet 下的 init 方法，copy from 后面的 name id 变了，详情请看 PaddlePaddle/Paddle#58626 (comment)

所以，针对 init 方法的代码示例，应该进行如下修改（中间加个init） @Turingg ，如

COPY-FROM: paddle.distributed.fleet.Fleet.init:code-example1
改为
COPY-FROM: paddle.distributed.fleet.Fleet.init:code-init-example1

另外，据以往的经验， Fleet 比较特殊，该类下的方法（不只是init）很多代码示例都有可能 copy-from 不成功（即使已经符合写作要求）。如果按要求改动之后，在预览里还是无法显示正常代码，那么就不用 copy-from 的形式，直接贴上源码即可。如

code-block:: python import paddle.distributed.fleet as fleet fleet.init()

Fleet 下的 init 方法:中间加个init qat_init:改回了原来的包含fleetrun变回了原来的

COPY-FROM: paddle.optimizer.set_lr_scheduler 修改：COPY-FROM: paddle.optimizer.AdamW.set_lr_scheduler

COPY-FROM: paddle.optimizer.set_lr_scheduler 修改：paddle.optimizer.Adam.set_lr_scheduler

.. code-block:: python 之后添加空行（在不需要 name: code_id 标识符时）

b268010

paddle-bot bot added the contributor label Nov 12, 2023

Update Fleet_cn.rst

d3831d3

把 ..code-block 删了改成copyfrom的形式

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

luotao1 assigned luotao1 and sunzhongkai588 Nov 13, 2023

luotao1 mentioned this pull request Nov 13, 2023

[Docathon] 中文文档 copy-from 清理 #6300

Closed

ooooo-create reviewed Nov 14, 2023

View reviewed changes

Turingg and others added 7 commits November 14, 2023 22:31

Update Fleet_cn.rst

c6d7070

修正COPY-FROM: paddle.distributed.fleet.Fleet.init:code-example1 删去.. code-block:: python下面的代码顺带一起删了

Update Adadelta_cn.rst

4f90eed

改成 copy-from 的形式

Update AdamW_cn.rst

036f604

改成 copy-from 的形式

Update Adam_cn.rst

6286ad9

改成 copy-from 的形式

Update Adamax_cn.rst

0d48fcf

改成 copy-from 的形式

where start_lr is the initial learning rate, and end_lr is the final …

1f110a7

…learning rate; 中文文档对应添加其中 start_lr 是初始学习率，而 end_lr 是最终学习率；

Merge remote-tracking branch 'origin/develop' into develop

daf24c7

ooooo-create reviewed Nov 21, 2023

View reviewed changes

sunzhongkai588 reviewed Nov 23, 2023

View reviewed changes

Turingg added 3 commits November 23, 2023 14:07

Update Fleet_cn.rst

539d995

Fleet 下的 init 方法:中间加个init qat_init:改回了原来的包含fleetrun变回了原来的

Update AdamW_cn.rst

0d105bf

COPY-FROM: paddle.optimizer.set_lr_scheduler 修改：COPY-FROM: paddle.optimizer.AdamW.set_lr_scheduler

Update Adam_cn.rst

0f0c00d

COPY-FROM: paddle.optimizer.set_lr_scheduler 修改：paddle.optimizer.Adam.set_lr_scheduler

Turingg closed this by deleting the head repository Nov 23, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Docathon][Fix COPY-FROM No.11-15] #6310

[Docathon][Fix COPY-FROM No.11-15] #6310

Turingg commented Nov 12, 2023

paddle-bot bot commented Nov 12, 2023

CLAassistant commented Nov 12, 2023 •

edited

Loading

ooooo-create left a comment

ooooo-create Nov 14, 2023

ooooo-create Nov 14, 2023

ooooo-create Nov 14, 2023

ooooo-create Nov 14, 2023

ooooo-create Nov 14, 2023

ooooo-create Nov 21, 2023

ooooo-create Nov 14, 2023

ooooo-create Nov 14, 2023

ooooo-create Nov 14, 2023

ooooo-create Nov 14, 2023

ooooo-create left a comment

ooooo-create Nov 18, 2023

ooooo-create Nov 18, 2023

ooooo-create Nov 18, 2023

ooooo-create Nov 18, 2023

ooooo-create Nov 18, 2023

ooooo-create Nov 21, 2023

ooooo-create Nov 21, 2023

ooooo-create Nov 21, 2023

sunzhongkai588 Nov 23, 2023 •

edited

Loading

		@@ -146,6 +146,7 @@ set_lr_scheduler(scheduler)
		代码示例

		.. code-block:: python

		@@ -139,6 +139,7 @@ set_lr_scheduler(scheduler)
		代码示例

		.. code-block:: python

		@@ -143,6 +143,7 @@ set_lr_scheduler(scheduler)
		代码示例

		.. code-block:: python

		@@ -162,6 +162,7 @@ set_lr_scheduler(scheduler)
		代码示例

		.. code-block:: python

	COPY-FROM: paddle.distributed.fleet.Fleet.init:code-example1
	COPY-FROM: paddle.distributed.fleet.Fleet.init:code-example2

	COPY-FROM: paddle.optimizer.set_lr_scheduler
	COPY-FROM: paddle.optimizer.AdamW.set_lr_scheduler

	COPY-FROM: paddle.optimizer.set_lr_scheduler
	COPY-FROM: paddle.optimizer.Adam.set_lr_scheduler

		@@ -13,6 +13,7 @@ LinearWarmup

		lr = start\_lr + (end\_lr - start\_lr) * \frac{epoch}{warmup\_steps}

		其中 start_lr 是初始学习率，而 end_lr 是最终学习率；

[Docathon][Fix COPY-FROM No.11-15] #6310

[Docathon][Fix COPY-FROM No.11-15] #6310

Conversation

Turingg commented Nov 12, 2023

paddle-bot bot commented Nov 12, 2023

CLAassistant commented Nov 12, 2023 • edited Loading

ooooo-create 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

ooooo-create 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

sunzhongkai588 Nov 23, 2023 • edited Loading

Choose a reason for hiding this comment

CLAassistant commented Nov 12, 2023 •

edited

Loading

sunzhongkai588 Nov 23, 2023 •

edited

Loading