Skip to content

docs: fix log_metrics step description #21109

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 23, 2025
Merged

docs: fix log_metrics step description #21109

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions src/lightning/pytorch/trainer/connectors/logger_connector/logger_connector.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -93,8 +93,9 @@ def log_metrics(self, metrics: _OUT_DICT, step: Optional[int] = None) -> None:

Args:
metrics: Metric values
step: Step for which metrics should be logged. Default value is `self.global_step` during training or
the total validation / test log step count during validation and testing.
step: Step for which metrics should be logged. If a `step` metric is logged, this value will
be used else will default to `self.global_step` during training or the total log step count
during validation and testing.

"""
if not self.trainer.loggers or not metrics:
Expand Down
Loading