Skip to content

Commit b581924

Browse files
clumsyazzhipa
andauthored
docs: fix log_metrics step description (Lightning-AI#21109)
docs: fix log_metrics step description (Lightning-AI#20677) Co-authored-by: Alexander Zhipa <[email protected]>
1 parent 7e9cea4 commit b581924

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed

src/lightning/pytorch/trainer/connectors/logger_connector/logger_connector.py

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -93,8 +93,9 @@ def log_metrics(self, metrics: _OUT_DICT, step: Optional[int] = None) -> None:
9393
9494
Args:
9595
metrics: Metric values
96-
step: Step for which metrics should be logged. Default value is `self.global_step` during training or
97-
the total validation / test log step count during validation and testing.
96+
step: Step for which metrics should be logged. If a `step` metric is logged, this value will
97+
be used else will default to `self.global_step` during training or the total log step count
98+
during validation and testing.
9899
99100
"""
100101
if not self.trainer.loggers or not metrics:

0 commit comments

Comments
 (0)