From 4afe53791b2667f2c6e110046b3633062a6b812f Mon Sep 17 00:00:00 2001
From: Gili Tzabari <cowwoc2020@gmail.com>
Date: Mon, 11 Oct 2021 21:44:07 -0400
Subject: [PATCH] Clarify lr scheduler frequency (#9843)

---
 pytorch_lightning/core/lightning.py | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/pytorch_lightning/core/lightning.py b/pytorch_lightning/core/lightning.py
index 00eeae5f13..08c3309762 100644
--- a/pytorch_lightning/core/lightning.py
+++ b/pytorch_lightning/core/lightning.py
@@ -1264,6 +1264,9 @@ class LightningModule(
                     "lr_scheduler": {
                         "scheduler": ReduceLROnPlateau(optimizer, ...),
                         "monitor": "metric_to_track",
+                        "frequency": "indicates how often the metric is updated"
+                        # If "monitor" references validation metrics, then "frequency" should be set to a
+                        # multiple of "trainer.check_val_every_n_epoch".
                     },
                 }