Skip to content

Commit f1c4b19

Browse files
authored
[Docathon][Update Doc No.28] add the LRScheduler (#7182)
* add the LRScheduler * fix ref rendering
1 parent dfef91b commit f1c4b19

File tree

2 files changed

+7
-2
lines changed

2 files changed

+7
-2
lines changed

docs/api_guides/low_level/layers/learning_rate_scheduler.rst

+5-2
Original file line numberDiff line numberDiff line change
@@ -60,10 +60,13 @@
6060
相关 API Reference 请参考 :ref:`cn_api_paddle_optimizer_lr_OneCycleLR`
6161

6262
* :code:`CyclicLR`: 学习率根据指定的缩放策略以固定频率在最小和最大学习率之间进行循环。
63-
相关 API Reference 请参考 :ref:`_cn_api_paddle_optimizer_lr_CyclicLR`
63+
相关 API Reference 请参考 :ref:`cn_api_paddle_optimizer_lr_CyclicLR`
6464

6565
* :code:`LinearLR`: 学习率随 step 数线性增加到指定学习率。
66-
相关 API Reference 请参考 :ref:`_cn_api_paddle_optimizer_lr_LinearLR`
66+
相关 API Reference 请参考 :ref:`cn_api_paddle_optimizer_lr_LinearLR`
6767

6868
* :code:`CosineAnnealingWarmRestarts`: 余弦退火学习率,即学习率随 step 数变化呈余弦函数周期变化。
6969
相关 API Reference 请参考 :ref:`cn_api_paddle_optimizer_lr_CosineAnnealingWarmRestarts`
70+
71+
* :code:`LRScheduler`: 学习率策略基类,所有具体策略均继承自此类,需重写 get_lr() 方法实现自定义逻辑。
72+
相关 API Reference 请参考 :ref:`cn_api_paddle_optimizer_lr_LRScheduler`

docs/api_guides/low_level/layers/learning_rate_scheduler_en.rst

+2
Original file line numberDiff line numberDiff line change
@@ -48,3 +48,5 @@ The following content describes the APIs related to the learning rate scheduler:
4848
* :code:`LinearLR`: Linear decay. That is, the learning rate will be firstly multiplied by start_factor and linearly increase to end learning rate. For related API Reference please refer to :ref:`api_paddle_optimizer_lr_LinearLR`
4949

5050
* :code:`CosineAnnealingWarmRestarts`: Cosine attenuation. It means the learning rate changes with the number of steps in the form of a cosine function. For related API Reference please refer to :ref:`api_paddle_optimizer_lr_CosineAnnealingWarmRestarts`
51+
52+
* :code:`LRScheduler`: Learning rate scheduling base class. All specific learning rate scheduling strategies inherit from this class. For related API Reference please refer to :ref:`api_paddle_optimizer_lr_LRScheduler`

0 commit comments

Comments
 (0)