From 008941991d46883a602f08e9c8c96d1483929914 Mon Sep 17 00:00:00 2001 From: bhimrazy Date: Thu, 21 Aug 2025 15:55:36 +0545 Subject: [PATCH] docs: add note on TorchMetrics integration for logging best practices --- docs/source-pytorch/extensions/logging.rst | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/source-pytorch/extensions/logging.rst b/docs/source-pytorch/extensions/logging.rst index 55196506aa333..081a3298e0f5d 100644 --- a/docs/source-pytorch/extensions/logging.rst +++ b/docs/source-pytorch/extensions/logging.rst @@ -120,6 +120,10 @@ methods to log from anywhere in a :doc:`LightningModule <../common/lightning_mod .. note:: Everything explained below applies to both :meth:`~lightning.pytorch.core.LightningModule.log` or :meth:`~lightning.pytorch.core.LightningModule.log_dict` methods. +.. note:: + + When using TorchMetrics with Lightning, we recommend referring to the `TorchMetrics Lightning integration documentation `_ for logging best practices, common pitfalls, and proper usage patterns. + Depending on where the :meth:`~lightning.pytorch.core.LightningModule.log` method is called, Lightning auto-determines the correct logging mode for you. Of course you can override the default behavior by manually setting the :meth:`~lightning.pytorch.core.LightningModule.log` parameters.