Customizing the TQDM Progress Bar

Oct 13, 2025 by wbrum.org 141 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 visualize 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.

Why Use TQDM in Jupyter Notebook?

Jupyter Notebooks are an excellent platform for data science and scientific computing. They allow users to write and execute code in a variety of programming languages, including Python. TQDM is a natural fit for Jupyter Notebooks, as it provides a way to display progress bars that can be easily integrated into the notebook's output.

Basic TQDM Progress Bar

To display a basic TQDM progress bar in a Jupyter Notebook, you can use the following code:

import tqdm
import time
for i in tqdm.tqdm(range(10)):
time.sleep(0.2)

This code will display a progress bar that increments by 1 for each iteration of the loop. The tqdm.tqdm function is used to create the progress bar, and the range(10) function generates a sequence of numbers from 0 to 9.

Customizing the TQDM Progress Bar

To customize the TQDM progress bar, you can use various options provided by the library. One of the most useful options is the desc parameter, which allows you to specify a description for the progress bar. Here's an example:

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

This code will display a progress bar with the description "global progress" in bold text.

Changing the Text Format

To change the text format of the TQDM progress bar, you can use ANSI escape codes. ANSI escape codes are a way to control the formatting of text in a terminal or console. Here's an example:

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

This code will display a progress bar with the description "global progress" in bold and blue text.

Using HTML Tags

TQDM also supports HTML tags, which can be used to format the text of the progress bar. Here's an example:

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

This code will display a progress bar with the description "global progress" in bold text.

Using Markdown

TQDM also supports Markdown syntax, which can be used to format the text of the progress bar. Here's an example:

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

This code will display a progress bar with the description "global progress" in bold text.

Conclusion

In this article, we explored how to customize the TQDM progress bar in a Jupyter Notebook, specifically focusing on changing the text format. We discussed various options provided by the library, including the desc parameter, ANSI escape codes, HTML tags, and Markdown syntax. By using these options, you can create a customized progress bar that meets your specific needs.

Example Use Cases

Here are some example use cases for customizing the TQDM progress bar:

Displaying a progress bar with a custom description
Changing the text format of the progress bar
Using HTML tags to format the text of the progress bar
Using Markdown syntax to format the text of the progress bar

Code Snippets

Here are some code snippets that demonstrate how to customize the TQDM progress bar:

Displaying a progress bar with a custom description:

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

Changing the text format of the progress bar:

import tqdm
import time
for i in tqdm.tqdm(range(10), desc='\x1b[1m\x1b[94mcustom description\x1b[0m'):
time.sleep(0.2)

Using HTML tags to format the text of the progress bar:

import tqdm
import time
for i in tqdm.tqdm(range(10), desc='<b>custom description</b>'):
time.sleep(0.2)

Using Markdown syntax to format the text of the progress bar:

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

Tips and Tricks

Here are some tips and tricks for customizing the TQDM progress bar:

Use the desc parameter to specify a custom description for the progress bar.
Use ANSI escape codes to change the text format of the progress bar.
Use HTML tags to format the text of the progress bar.
Use Markdown syntax to format the text of the progress bar.
Experiment with different options to find the one that works best for your use case.
TQDM Progress Bar Q&A =========================

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 visualize 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 display a progress bar in a Jupyter Notebook?

A: To display a progress bar in a Jupyter Notebook, you can use the following code:

import tqdm
import time
for i in tqdm.tqdm(range(10)):
time.sleep(0.2)

Q: How do I customize the TQDM progress bar?

A: You can customize the TQDM progress bar by using various options provided by the library. Some of the options include:

desc: specifies a custom description for the progress bar
unit: specifies the unit of the progress bar (e.g. "it", "items", etc.)
leave: specifies whether to leave the progress bar after the loop is finished
bar_format: specifies the format of the progress bar

Q: How do I change the text format of the TQDM progress bar?

A: You can change the text format of the TQDM progress bar by using ANSI escape codes. For example:

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

This code will display a progress bar with the description "global progress" in bold and blue text.

Q: How do I use HTML tags to format the text of the TQDM progress bar?

A: You can use HTML tags to format the text of the TQDM progress bar by passing the HTML code as the desc parameter. For example:

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

This code will display a progress bar with the description "global progress" in bold text.

Q: How do I use Markdown syntax to format the text of the TQDM progress bar?

A: You can use Markdown syntax to format the text of the TQDM progress bar by passing the Markdown code as the desc parameter. For example:

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

This code will display a progress bar with the description "global progress" in bold text.

Q: How do I reset the TQDM progress bar?

A: You can reset the TQDM progress bar by calling the reset method on the tqdm object. For example:

import tqdm
import time
t = tqdm.tqdm(range(10))
for i in range(10):
time.sleep(0.2)
t.reset()

This code will reset the progress bar to 0.

Q: How do I get the current value of the TQDM progress bar?

A: You can get the current value of the TQDM progress bar by accessing the n attribute of the tqdm object. For example:

import tqdm
import time
t = tqdm.tqdm(range(10))
for i in range(10):
time.sleep(0.2)
print(t.n)

This code will print the current value of the progress bar.

Q: How do I get the total number of iterations of the TQDM progress bar?

A: You can get the total number of iterations of the TQDM progress bar by accessing the total attribute of the tqdm object. For example:

import tqdm
import time
t = tqdm.tqdm(range(10))
for i in range(10):
time.sleep(0.2)
print(t.total)

This code will print the total number of iterations of the progress bar.

Q: How do I get the current percentage of the TQDM progress bar?

A: You can get the current percentage of the TQDM progress bar by accessing the percentage attribute of the tqdm object. For example:

import tqdm
import time
t = tqdm.tqdm(range(10))
for i in range(10):
time.sleep(0.2)
print(t.percentage)

This code will print the current percentage of the progress bar.

Q: How do I get the current bar length of the TQDM progress bar?

A: You can get the current bar length of the TQDM progress bar by accessing the bar_length attribute of the tqdm object. For example:

import tqdm
import time
t = tqdm.tqdm(range(10))
for i in range(10):
time.sleep(0.2)
print(t.bar_length)

This code will print the current bar length of the progress bar.

Q: How do I get the current bar format of the TQDM progress bar?

A: You can get the current bar format of the TQDM progress bar by accessing the bar_format attribute of the tqdm object. For example:

import tqdm
import time
t = tqdm.tqdm(range(10))
for i in range(10):
time.sleep(0.2)
print(t.bar_format)

This code will print the current bar format of the progress bar.

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

A: You can get the current description of the TQDM progress bar by accessing the desc attribute of the tqdm object. For example:

import tqdm
import time
t = tqdm.tqdm(range(10))
for i in range(10):
time.sleep(0.2)
print(t.desc)

This code will print the current description of the progress bar.

Q: How do I get the current unit of the TQDM progress bar?

A: You can get the current unit of the TQDM progress bar by accessing the unit attribute of the tqdm object. For example:

import tqdm
import time
t = tqdm.tqdm(range(10))
for i in range(10):
time.sleep(0.2)
print(t.unit)

This code will print the current unit of the progress bar.

Q: How do I get the current leave status of the TQDM progress bar?

A: You can get the current leave status of the TQDM progress bar by accessing the leave attribute of the tqdm object. For example:

import tqdm
import time
t = tqdm.tqdm(range(10))
for i in range(10):
time.sleep(0.2)
print(t.leave)

This code will print the current leave status of the progress bar.

Q: How do I get the current file descriptor of the TQDM progress bar?

A: You can get the current file descriptor of the TQDM progress bar by accessing the file attribute of the tqdm object. For example:

import tqdm
import time
t = tqdm.tqdm(range(10))
for i in range(10):
time.sleep(0.2)
print(t.file)

This code will print the current file descriptor of the progress bar.

Q: How do I get the current flush status of the TQDM progress bar?

A: You can get the current flush status of the TQDM progress bar by accessing the flush attribute of the tqdm object. For example:

import tqdm
import time
t = tqdm.tqdm(range(10))
for i in range(10):
time.sleep(0.2)
print(t.flush)

This code will print the current flush status of the progress bar.

Q: How do I get the current close status of the TQDM progress bar?

A: You can get the current close status of the TQDM progress bar by accessing the close attribute of the tqdm object. For example:

import tqdm
import time
t = tqdm.tqdm(range(10))
for i in range(10):
time.sleep(0.2)
print(t.close)

This code will print the current close status of the progress bar.

Q: How do I get the current disable status of the TQDM progress bar?

A: You can get the current disable status of the TQDM progress bar by accessing the disable attribute of the tqdm object. For example:

import tqdm
import time
t = tqdm.tqdm(range(10))
for i in range(10):
time.sleep(0.2)
print(t.disable)

This code will print the current disable status of the progress bar.

**Q: How do I get the current miniters status