Basic Usage of TQDM in Jupyter Notebook

Oct 13, 2025 by miodeya.com 88 views

Introduction

TQDM is a popular Python library used to display progress bars in various applications, including Jupyter Notebooks. It provides a simple and efficient way to track the progress of long-running tasks. In this article, we will explore how to customize the TQDM progress bar in a Jupyter Notebook, specifically focusing on changing the text format of the description preceding the bar.

Why Use TQDM in Jupyter Notebook?

Jupyter Notebooks are an excellent platform for data science and scientific computing. They provide an interactive environment for exploring and visualizing data, as well as a simple way to share results with others. However, when working with large datasets or complex computations, it can be challenging to track the progress of these tasks. This is where TQDM comes in – it helps to alleviate this issue by providing a clear and concise progress bar that updates in real-time.

Basic Usage of TQDM in Jupyter Notebook

To use TQDM in a Jupyter Notebook, you can simply import the library and use the tqdm function to create a progress bar. Here's an example:

import tqdm
for i in tqdm.tqdm(range(10), desc='global progress'):
    time.sleep(0.2)

This code will create a progress bar that updates every 0.2 seconds, with the description "global progress" preceding the bar.

Changing the Text Format of the Description

By default, the description preceding the TQDM progress bar is displayed in a plain text format. However, you can customize this by using ANSI escape codes to change the text format. For example, to display the description in bold, you can use the \x1b[1m code:

for i in tqdm.tqdm(range(10), desc='\x1b[1mglobal progress'):
    time.sleep(0.2)

This will display the description "global progress" in bold.

Using HTML Tags to Customize the Description

In addition to ANSI escape codes, you can also use HTML tags to customize the description. For example, to display the description in italics, you can use the <i> tag:

for i in tqdm.tqdm(range(10), desc='<i>global progress</i>'):
    time.sleep(0.2)

This will display the description "global progress" in italics.

Using Markdown to Customize the Description

If you want to use a more readable format for your description, you can use Markdown syntax. For example, to display the description in bold and italics, you can use the following code:

for i in tqdm.tqdm(range(10), desc='**_global progress_**'):
    time.sleep(0.2)

This will display the description "global progress" in bold and italics.

Using Strong Tags to Customize the Description

You can also use strong tags to customize the description. For example, to display the description in bold, you can use the <strong> tag:

for i in tqdm.tqdm(range(10), desc='<strong>global progress</strong>'):
    time.sleep(0.2)

This will display the description "global progress" in bold.

Conclusion

In this article, we explored how to customize the TQDM progress bar in a Jupyter Notebook, specifically focusing on changing the text format of the description preceding the bar. We discussed how to use ANSI escape codes, HTML tags, Markdown syntax, and strong tags to customize the description. By using these techniques, you can create a progress bar that is tailored to your specific needs and provides a clear and concise view of the progress of your tasks.

Tips and Variations

Here are some additional tips and variations to help you customize the TQDM progress bar:

Use different colors: You can use ANSI escape codes to change the color of the description and the progress bar. For example, to display the description in red, you can use the \x1b[31m code.
Add a prefix: You can add a prefix to the description using the prefix parameter. For example:

for i in tqdm.tqdm(range(10), desc='global progress', prefix='Task: '): time.sleep(0.2)

    This will display the description "Task: global progress" preceding the bar.
*   **Use a custom template**: You can use a custom template to display the description and the progress bar. For example:
    ```python
from tqdm import tqdm
class CustomTQDM(tqdm):
def init(self, *args, **kwargs):
super().init(*args, **kwargs)
self.template = 'l_bar}{bar}|{n_fmt}/{total_fmt} [{percentage3.0f%]'
for i in CustomTQDM(range(10), desc='global progress'):
time.sleep(0.2)

This will display a custom progress bar with a specific template.

Q: What is TQDM?

A: TQDM is a popular Python library used to display progress bars in various applications, including Jupyter Notebooks. It provides a simple and efficient way to track the progress of long-running tasks.

Q: How do I install TQDM?

A: You can install TQDM using pip:

pip install tqdm

Q: How do I use TQDM in a Jupyter Notebook?

A: To use TQDM in a Jupyter Notebook, you can simply import the library and use the tqdm function to create a progress bar. Here's an example:

import tqdm
for i in tqdm.tqdm(range(10), desc='global progress'):
    time.sleep(0.2)

Q: How do I customize the description of the TQDM progress bar?

A: You can customize the description of the TQDM progress bar by using ANSI escape codes, HTML tags, Markdown syntax, or strong tags. For example, to display the description in bold, you can use the \x1b[1m code:

for i in tqdm.tqdm(range(10), desc='\x1b[1mglobal progress'):
    time.sleep(0.2)

Q: How do I add a prefix to the description of the TQDM progress bar?

A: You can add a prefix to the description of the TQDM progress bar using the prefix parameter. For example:

for i in tqdm.tqdm(range(10), desc='global progress', prefix='Task: '):
    time.sleep(0.2)

Q: How do I use a custom template to display the TQDM progress bar?

A: You can use a custom template to display the TQDM progress bar by creating a custom class that inherits from tqdm. For example:

from tqdm import tqdm
class CustomTQDM(tqdm):
def init(self, *args, **kwargs):
super().init(*args, **kwargs)
self.template = 'l_bar}{bar}|{n_fmt}/{total_fmt} [{percentage3.0f%]'
for i in CustomTQDM(range(10), desc='global progress'):
time.sleep(0.2)

Q: How do I use TQDM with other libraries, such as Pandas or NumPy?

A: TQDM can be used with other libraries, such as Pandas or NumPy, by using the tqdm function to create a progress bar and then passing the data to the library's functions. For example:

import pandas as pd
import numpy as np
from tqdm import tqdm
data = pd.DataFrame(np.random.rand(100, 100))
for i in tqdm.tqdm(range(100)):
data[i] = data[i] * 2

Q: How do I troubleshoot issues with TQDM?

A: If you encounter issues with TQDM, you can try the following:

Check the TQDM documentation for the latest version and any known issues.
Search online for solutions to similar issues.
Use the TQDM issue tracker to report any bugs or feature requests.
Try using a different version of TQDM or a different library.

Q: How do I contribute to the TQDM project?

A: If you would like to contribute to the TQDM project, you can:

Report any bugs or feature requests on the TQDM issue tracker.
Submit pull requests with code changes or new features.
Participate in the TQDM community by answering questions or providing feedback.
Donate to the TQDM project to support its development.