Document behaviour when setting both on_step=True and on_epoch=True in self.log (#4327)

* update logging.rst

* logger of choice

Co-authored-by: Nicki Skafte <[email protected]>

* add metrics reference

* trigger ci

* Revert "trigger ci"

This reverts commit 97bf461.

Co-authored-by: Nicki Skafte <[email protected]>
Co-authored-by: chaton <[email protected]>
Co-authored-by: Roger Shieh <[email protected]>
Co-authored-by: Ananya Harsh Jha <[email protected]>
(cherry picked from commit e971437)

Author: 5 people

docs/source/logging.rst

@@ -85,7 +85,14 @@ The :func:`~~pytorch_lightning.core.lightning.LightningModule.log` method has a
 * `logger`: Logs to the logger like Tensorboard, or any other custom logger passed to the :class:`~pytorch_lightning.trainer.trainer.Trainer`.
 
 
-.. note:: Setting `on_epoch=True` will accumulate your logged values over the full training epoch.
+.. note::
+
+    -   Setting ``on_epoch=True`` will cache all your logged values during the full training epoch and perform a
+        reduction `on_epoch_end`. We recommend using the :ref:`metrics` API when working with custom reduction.
+
+    -   Setting both ``on_step=True`` and ``on_epoch=True`` will create two keys per metric you log with
+        suffix ``_step`` and ``_epoch``, respectively. You can refer to these keys e.g. in the `monitor`
+        argument of :class:`~pytorch_lightning.callbacks.model_checkpoint.ModelCheckpoint` or in the graphs plotted to the logger of your choice.
 
 
 Manual logging