Skip to content

Commit bd441cc

Browse files
committed
add docstring
1 parent f83183a commit bd441cc

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

src/lightning/pytorch/cli.py

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -66,6 +66,13 @@
6666

6767

6868
class ReduceLROnPlateau(torch.optim.lr_scheduler.ReduceLROnPlateau):
69+
"""Custom ReduceLROnPlateau scheduler that extends PyTorch's ReduceLROnPlateau.
70+
71+
This class adds a `monitor` attribute to the standard PyTorch ReduceLROnPlateau to specify which metric should be
72+
tracked for learning rate adjustment.
73+
74+
"""
75+
6976
def __init__(self, optimizer: Optimizer, monitor: str, *args: Any, **kwargs: Any) -> None:
7077
super().__init__(optimizer, *args, **kwargs)
7178
self.monitor = monitor

0 commit comments

Comments
 (0)