Clarify lr scheduler frequency (#9843)

This commit is contained in:
Gili Tzabari 2021-10-11 21:44:07 -04:00 committed by GitHub
parent 83acb8671d
commit 4afe53791b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 3 additions and 0 deletions

View File

@ -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".
},
}