Lightning-AI/pytorch-lightning

Make logging_mode (`on_step` or `on_epoch`) available to loggers

Open

#20,502 opened on Dec 17, 2024

View on GitHub
 (5 comments) (0 reactions) (0 assignees)Python (3,233 forks)batch import
featurehelp wanted

Repository metrics

Stars
 (26,687 stars)
PR merge metrics
 (Avg merge 9d 15h) (3 merged PRs in 30d)

Description

Description & Motivation

Lightning lets you log on_step, or on_epoch. However, even when using on_epoch, the global step is logged on the x-axis, not the epoch number.

Loggers can manually extract epoch from the logged metrics and pass that as the step. However, this would break on_step logging.

Making the logging mode for a logging call available would let loggers conditionally use either the global_step or current_epoch as the step for that particular metric.

Pitch

No response

Alternatives

No response

Additional context

No response

cc @lantiga @borda

Contributor guide

Research direction
Look at the Logger base class and the logging internals to find where logging mode is stored. Then modify the log method to pass logging mode to the logger's log method.
Tech stack
python
Domain
backend
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
None
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70