Feature Request: Option to disable automatic epoch display in ProgressBar

Open
#3,659 4 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
42/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Stale
Tech stack
python

Research direction

Start at ignite.handlers.ProgressBar and trace how desc and bar_format are combined with the automatic epoch text. Compare the proposed show_epoch and description_format approaches against the alignment and dynamic-desc requirements; done means users can disable epoch text without losing desc customization.

Written by the indexing model from the issue text.

Description

needs-discussion waiting-for-response

Problem

Currently ignite.handlers.ProgressBar automatically appends epoch
information like [epoch/max_epochs] to the description when max_epochs > 1.

Example:

Training [1/4]
Training [2/4]

This behavior can make it difficult to align multiple progress bars
(e.g. trainer and evaluator) or customize the display layout.

Current Workaround

Users can redefine the entire bar_format, but this requires rewriting
the full format string even if they only want to remove the epoch display.

Also, removing {desc} from bar_format disables the dynamic desc
argument from tqdm.

Proposed Solution

Allow users to control how the description is formatted.

Possible approaches:

  1. show_epoch boolean flag
  2. description_format parameter

Example:

ProgressBar(desc="Training", show_epoch=False)
Dominant language
Python
Stars
4.8k
Forks
726
Avg merge
5d 21h
Merged PRs (30d)
5

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.

More from pytorch/ignite

All issues in pytorch/ignite

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.