Lightning-AI / Lightning-AI/pytorch-lightning

Enable external configuration of max refresh rate and ascii mode in progress bars

Open
#18,428 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

feature progress bar: rich progress bar: tqdm
Dominant language
Python
Stars
31.4k
Forks
3.8k
Avg merge
6d 7h
Merged PRs (30d)
6

Description

### Description & Motivation

Certain environments/platforms have constraints about how fast they can refresh the log stream or what character set they can display. Currently, the user can configure the refresh interval via the `TQDMProgressBar` callback, but it requires code changes. Furthermore, `tqdm` has an ascii mode that can be enabled via `tqdm(ascii=True)` but it is not configureable by the Lightning user.

### Pitch

Expose environment variables that can control these two settings for our progress bars.

### Alternatives

Keep as is. The only way to control this would be to patch the tqdm classes.

### Additional context

_No response_

cc @borda @awaelchli

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

Locate the TQDMProgressBar implementation and its existing refresh-interval callback, then inspect how progress-bar options are passed to tqdm. Add externally configurable controls for refresh rate and ASCII mode, and verify both settings through the relevant progress-bar tests.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
cli
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.