Lightning-AI / Lightning-AI/pytorch-lightning

[RFC] Deprecate `log_every_n_steps` from Trainer

Open
#9,726 13 comments 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

design logging trainer: argument
Dominant language
Python
Stars
31.4k
Forks
3.8k
Avg merge
6d 7h
Merged PRs (30d)
6

Description

## Proposed refactoring or deprecation

Deprecate `log_every_n_steps` from Trainer and make it available as a parameter to loggers that have this capability.

### Motivation

Same reasons as #8991. How often to log should be considered an internal implementation detail of each logger

### Pitch

Deprecate `log_every_n_steps` from Trainer, and move it to the init for logger classes that support this functionality (e.g. CSVLogger).

______________________________________________________________________

#### If you enjoy Lightning, check out our other projects! ⚡

- [**Metrics**](https://github.com/PyTorchLightning/metrics): Machine learning metrics for distributed, scalable PyTorch applications.

- [**Flash**](https://github.com/PyTorchLightning/lightning-flash): The fastest way to get a Lightning baseline! A collection of tasks for fast prototyping, baselining, finetuning and solving problems with deep learning

- [**Bolts**](https://github.com/PyTorchLightning/lightning-bolts): Pretrained SOTA Deep Learning models, callbacks and more for research and production with PyTorch Lightning and PyTorch

- [**Lightning Transformers**](https://github.com/PyTorchLightning/lightning-transformers): Flexible interface for high performance research using SOTA Transformers leveraging Pytorch Lightning, Transformers, and Hydra.

cc @tchaton @justusschock @awaelchli @borda @carmocca @edward-io @ananthsub @rohitgr7 @kamil-kaczmarek @Raalsky @Blaizzy @kaushikb11 @akihironitta

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the Trainer's log_every_n_steps parameter and logger classes that support logging frequency, including CSVLogger. Determine which loggers need the parameter, then deprecate it on Trainer and expose it through the applicable logger initializers, with tests confirming the updated configuration.

Written by the indexing model from the issue text.

Assessment

Tech stack
python, pytorch
Domain
machine-learning
Issue type
Refactor
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.