DOC: fix spelling and grammar in tqdm_logger

[importstring]

Found and fixed several spelling and grammar errors in comments and docstrings in tqdm_logger.py. No logic or behaviour was changed.

One example:

# Before
progress bar will looks like

# After  
progress bar will look like

Found these issues while working on #3118.

Spelling and grammar suggestions were assisted by an AI tool; all changes were manually reviewed and hand-typed.

cc @vfdev-5

[vfdev-5]

Thanks for the PR @importstring
I left comments to revert some unnecessary changes

[vfdev-5]

Let's remove the new line

Suggested change

[importstring]

There are three instances of this.

Previously

Simple progress bar

.. code-block:: python

    trainer = create_supervised_trainer(model, optimizer, loss)

    pbar = ProgressBar()
    pbar.attach(trainer)

    # Progress bar will looks like
    # Epoch [2/50]: [64/128]  50%|█████      [06:17<12:34]

Log output to a file instead of stderr (tqdm's default output)

.. code-block:: python

    trainer = create_supervised_trainer(model, optimizer, loss)

    log_file = open("output.log", "w")
    pbar = ProgressBar(file=log_file)
    pbar.attach(trainer)

Attach metrics that already have been computed at :attr:`~ignite.engine.events.Events.ITERATION_COMPLETED`
(such as :class:`~ignite.metrics.RunningAverage`)

.. code-block:: python

    trainer = create_supervised_trainer(model, optimizer, loss)

    RunningAverage(output_transform=lambda x: x).attach(trainer, 'loss')

    pbar = ProgressBar()
    pbar.attach(trainer, ['loss'])

    # Progress bar will looks like
    # Epoch [2/50]: [64/128]  50%|█████      , loss=0.123 [06:17<12:34]

Directly attach the engine's output

.. code-block:: python

    trainer = create_supervised_trainer(model, optimizer, loss)

    pbar = ProgressBar()
    pbar.attach(trainer, output_transform=lambda x: {'loss': x})

    # Progress bar will looks like
    # Epoch [2/50]: [64/128]  50%|█████      , loss=0.123 [06:17<12:34]

I think the version history got a bit messed up which is why it shows I deleted the line instead showing the grammar edit.

Would you like me to remove all # Progress bar will looks like, keep them all, or just remove that one?

For now I've fixed the spelling of all three and kept all three. Let me know what you'd prefer.

[importstring]

Thanks for the review, @vfdev-5. I’ve applied all your suggestions (reverted the unnecessary formatting/capitalization changes and the extra test file) and kept only the focused spelling/grammar fixes in tqdm_logger.py. Happy to tweak further if needed.

[aaishwarymishra]

@importstring hi, one of you string update broke an tests regrex, specifically tests/ignite/handlers/test_tqdm_logger.py::test_pbar_errors

[importstring]

Hi @aaishwarymishra
I'll look into that right now. I'll keep you posted.

[importstring]

It's coming from this test case because we changed contrib module to submodule:

try:
    from tqdm.autonotebook import tqdm
except ImportError:
    raise ModuleNotFoundError(
        "This submodule requires tqdm to be installed. Please install it with the command: \n pip install tqdm"
    )

I can either change it back to

"This contrib module requires tqdm to be installed. Please install it with command: \n pip install tqdm"

or I can update the tests but then the scope would be greater. Happy to do whichever you prefer.

For now I've updated the test to match the new error message @vfdev-5 requested.
"This submodule requires tqdm to be installed. Please install it with the command: \n pip install tqdm"