Skip to content

Commit 571310f

Browse files
authored
docs: add note on TorchMetrics integration for logging best practices (#21103)
1 parent ff64a92 commit 571310f

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

docs/source-pytorch/extensions/logging.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -120,6 +120,10 @@ methods to log from anywhere in a :doc:`LightningModule <../common/lightning_mod
120120
.. note::
121121
Everything explained below applies to both :meth:`~lightning.pytorch.core.LightningModule.log` or :meth:`~lightning.pytorch.core.LightningModule.log_dict` methods.
122122

123+
.. note::
124+
125+
When using TorchMetrics with Lightning, we recommend referring to the `TorchMetrics Lightning integration documentation <https://lightning.ai/docs/torchmetrics/stable/pages/lightning.html>`_ for logging best practices, common pitfalls, and proper usage patterns.
126+
123127
Depending on where the :meth:`~lightning.pytorch.core.LightningModule.log` method is called, Lightning auto-determines
124128
the correct logging mode for you. Of course you can override the default behavior by manually setting the
125129
:meth:`~lightning.pytorch.core.LightningModule.log` parameters.

0 commit comments

Comments
 (0)