github/ColossalAI
1
0
Fork 0
mirror of https://github.com/hpcaitech/ColossalAI.git synced 2025-09-09 04:50:17 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update layer integration documentations (#108)

Browse Source 
Update the documentations of layer integration

Update _log_hook.py

Update _operation.py
This commit is contained in:
BoxiangW
2022-01-10 18:05:58 +08:00
committed by GitHub
parent 3a61d785b5
commit 4a3d3446b0
25 changed files with 1020 additions and 98 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
colossalai/trainer/hooks/_lr_scheduler_hook.py
View File

@@ -8,14 +8,14 @@ from ._metric_hook import LearningRateMetric, MetricHook
class LRSchedulerHook(MetricHook):
"""Build LR scheduler
:param trainer: Trainer attached with current hook
:type trainer: Trainer
:param lr_scheduler_cfg: The config of LR scheduler
:type lr_scheduler_cfg: dict
:param by_epoch: If `True`, the LR will be scheduled every epoch. Else, the LR will be scheduled every batch. Defaults to `True`.
:param lr_scheduler: LR scheduler
:param by_epoch: If `True`, the LR will be scheduled every epoch. Else, the LR will be scheduled every batch
:type by_epoch: bool
:param priority: Priority in the printing, hooks with small priority will be printed in front
:param store_lr_in_state: If `True`, store the learning rate in each state, defaults to `True`
:type store_lr_in_state: bool, optional
:param priority: Priority in the printing, hooks with small priority will be printed in front, defaults to 1
:type priority: int, optional
:param trainer: Trainer attached with current hook
"""
def __init__(
self,