tqdm
v4.67.0 stable
tqdm derives from the Arabic word taqaddum (تقدّم) which can mean "progress,"
and is an abbreviation for "I love you so much" in Spanish (te quiero demasiado).
Instantly make your loops show a smart progress meter - just wrap any
iterable with tqdm(iterable), and you're done!
from tqdm import tqdm
for i in tqdm(range(10000)):
...76%|████████████████████████ | 7568/10000 [00:33<00:10, 229.00it/s]
trange(N) can be also used as a convenient shortcut for
tqdm(range(N)).
It can also be executed as a module with pipes:
$ seq 9999999 | tqdm --bytes | wc -l
75.2MB [00:00, 217MB/s]
9999999
$ tar -zcf - docs/ | tqdm --bytes --total `du -sb docs/ | cut -f1`
> backup.tgz
32%|██████████▍ | 8.89G/27.9G [00:42<01:31, 223MB/s]Overhead is low -- about 60ns per iteration (80ns with tqdm.gui), and is
unit tested against performance regression.
By comparison, the well-established
ProgressBar has
an 800ns/iter overhead.
In addition to its low overhead, tqdm uses smart algorithms to predict
the remaining time and to skip unnecessary iteration displays, which allows
for a negligible overhead in most cases.
tqdm works on any platform
(Linux, Windows, Mac, FreeBSD, NetBSD, Solaris/SunOS),
in any console or in a GUI, and is also friendly with IPython/Jupyter notebooks.
tqdm does not require any dependencies (not even curses!), just
Python and an environment supporting carriage return r and
line feed n control characters.
Table of contents
contribasynciologging
pip install tqdm
Pull and install pre-release devel branch:
pip install "git+https://github.com/tqdm/tqdm.git@devel#egg=tqdm"conda install -c conda-forge tqdmThere are 3 channels to choose from:
snap install tqdm # implies --stable, i.e. latest tagged release
snap install tqdm --candidate # master branch
snap install tqdm --edge # devel branchNote that snap binaries are purely for CLI use (not import-able), and
automatically set up bash tab-completion.
docker pull tqdm/tqdm
docker run -i --rm tqdm/tqdm --helpThere are other (unofficial) places where tqdm may be downloaded, particularly for CLI use:
The list of all changes is available either on GitHub's Releases: , on the wiki, or on the website.
tqdm is very versatile and can be used in a number of ways.
The three main ones are given below.
Wrap tqdm() around any iterable:
from tqdm import tqdm
from time import sleep
text = ""
for char in tqdm(["a", "b", "c", "d"]):
sleep(0.25)
text = text + chartrange(i) is a special optimised instance of tqdm(range(i)):
from tqdm import trange
for i in trange(100):
sleep(0.01)Instantiation outside of the loop allows for manual control over tqdm():
pbar = tqdm(["a", "b", "c", "d"])
for char in pbar:
sleep(0.25)
pbar.set_description("Processing %s" % char)Manual control of tqdm() updates using a with statement:
with tqdm(total=100) as pbar:
for i in range(10):
sleep(0.1)
pbar.update(10)If the optional variable total (or an iterable with len()) is
provided, predictive stats are displayed.
with is also optional (you can just assign tqdm() to a variable,
but in this case don't forget to del or close() at the end:
pbar = tqdm(total=100)
for i in range(10):
sleep(0.1)
pbar.update(10)
pbar.close()Perhaps the most wonderful use of tqdm is in a script or on the command
line. Simply inserting tqdm (or python -m tqdm) between pipes will pass
through all stdin to stdout while printing progress to stderr.
The example below demonstrate counting the number of lines in all Python files in the current directory, with timing information included.
$ time find . -name '*.py' -type f -exec cat {} ; | wc -l
857365
real 0m3.458s
user 0m0.274s
sys 0m3.325s
$ time find . -name '*.py' -type f -exec cat {} ; | tqdm | wc -l
857366it [00:03, 246471.31it/s]
857365
real 0m3.585s
user 0m0.862s
sys 0m3.358sNote that the usual arguments for tqdm can also be specified.
$ find . -name '*.py' -type f -exec cat {} ; |
tqdm --unit loc --unit_scale --total 857366 >> /dev/null
100%|█████████████████████████████████| 857K/857K [00:04<00:00, 246Kloc/s]Backing up a large directory?
$ tar -zcf - docs/ | tqdm --bytes --total `du -sb docs/ | cut -f1`
> backup.tgz
44%|██████████████▊ | 153M/352M [00:14<00:18, 11.0MB/s]This can be beautified further:
$ BYTES=$(du -sb docs/ | cut -f1)
$ tar -cf - docs/
| tqdm --bytes --total "$BYTES" --desc Processing | gzip
| tqdm --bytes --total "$BYTES" --desc Compressed --position 1
> ~/backup.tgz
Processing: 100%|██████████████████████| 352M/352M [00:14<00:00, 30.2MB/s]
Compressed: 42%|█████████▎ | 148M/352M [00:14<00:19, 10.9MB/s]Or done on a file level using 7-zip:
$ 7z a -bd -r backup.7z docs/ | grep Compressing
| tqdm --total $(find docs/ -type f | wc -l) --unit files
| grep -v Compressing
100%|██████████████████████████▉| 15327/15327 [01:00<00:00, 712.96files/s]Pre-existing CLI programs already outputting basic progress information will
benefit from tqdm's --update and --update_to flags:
$ seq 3 0.1 5 | tqdm --total 5 --update_to --null
100%|████████████████████████████████████| 5.0/5 [00:00<00:00, 9673.21it/s]
$ seq 10 | tqdm --update --null # 1 + 2 + ... + 10 = 55 iterations
55it [00:00, 90006.52it/s]The most common issues relate to excessive output on multiple lines, instead of a neat one-line progress bar.
CR, r).r properly
(cloudwatch,
K8s) may benefit from
export TQDM_POSITION=-1.colorama
to ensure nested bars stay within their respective lines.ascii-only bar.tqdm does not.tqdm(enumerate(...)) with enumerate(tqdm(...)) or
tqdm(enumerate(x), total=len(x), ...).
The same applies to numpy.ndenumerate.tqdm(zip(a, b)) with zip(tqdm(a), b) or even
zip(tqdm(a), tqdm(b)).itertools.tqdm.contrib.docker-compose run instead of docker-compose up and tty: true.export TQDM_MININTERVAL=5 to avoid log spam.
This override logic is handled by the tqdm.utils.envwrap decorator
(useful independent of tqdm).If you come across any other difficulties, browse and file .
(Since 19 May 2016)
class tqdm():
"""
Decorate an iterable object, returning an iterator which acts exactly
like the original iterable, but prints a dynamically updating
progressbar every time a value is requested.
"""
@envwrap("TQDM_") # override defaults via env vars
def __init__(self, iterable=None, desc=None, total=None, leave=True,
file=None, ncols=None, mininterval=0.1,
maxinterval=10.0, miniters=None, ascii=None, disable=False,
unit='it', unit_scale=False, dynamic_ncols=False,
smoothing=0.3, bar_format=None, initial=0, position=None,
postfix=None, unit_divisor=1000, write_bytes=False,
lock_args=None, nrows=None, colour=None, delay=0):Iterable to decorate with a progressbar. Leave blank to manually manage the updates.
Prefix for the progressbar.
The number of expected iterations. If unspecified,
len(iterable) is used if possible. If float("inf") or as a last
resort, only basic progress statistics are displayed
(no ETA, no progressbar).
If gui is True and this parameter needs subsequent updating,
specify an initial arbitrary large positive number,
e.g. 9e9.
If [default: True], keeps all traces of the progressbar
upon termination of iteration.
If None, will leave only if position is 0.
io.TextIOWrapper or io.StringIO, optional
Specifies where to output the progress messages
(default: sys.stderr). Uses file.write(str) and file.flush()
methods. For encoding, see write_bytes.
The width of the entire output message. If specified, dynamically resizes the progressbar to stay within this bound. If unspecified, attempts to use environment width. The fallback is a meter width of 10 and no limit for the counter and statistics. If 0, will not print any meter (only stats).
Minimum progress display update interval [default: 0.1] seconds.
Maximum progress display update interval [default: 10] seconds.
Automatically adjusts miniters to correspond to mininterval
after long display update lag. Only works if dynamic_miniters
or monitor thread is enabled.
Minimum progress display update interval, in iterations.
If 0 and dynamic_miniters, will automatically adjust to equal
mininterval (more CPU efficient, good for tight loops).
If > 0, will skip display of specified number of iterations.
Tweak this and mininterval to get very efficient loops.
If your progress is erratic with both fast and slow iterations
(network, skipping items, etc) you should set miniters=1.
If unspecified or False, use unicode (smooth blocks) to fill the meter. The fallback is to use ASCII characters " 123456789#".
Whether to disable the entire progressbar wrapper [default: False]. If set to None, disable on non-TTY.
String that will be used to define the unit of each iteration [default: it].
If 1 or True, the number of iterations will be reduced/scaled
automatically and a metric prefix following the
International System of Units standard will be added
(kilo, mega, etc.) [default: False]. If any other non-zero
number, will scale total and n.
If set, constantly alters ncols and nrows to the
environment (allowing for window resizes) [default: False].
Exponential moving average smoothing factor for speed estimates (ignored in GUI mode). Ranges from 0 (average speed) to 1 (current/instantaneous speed) [default: 0.3].
Specify a custom bar string formatting. May impact performance. [default: '{l_bar}{bar}{r_bar}'], where l_bar='{desc}: {percentage:3.0f}%|' and r_bar='| {n_fmt}/{total_fmt} [{elapsed}<{remaining}, ' '{rate_fmt}{postfix}]' Possible vars: l_bar, bar, r_bar, n, n_fmt, total, total_fmt, percentage, elapsed, elapsed_s, ncols, nrows, desc, unit, rate, rate_fmt, rate_noinv, rate_noinv_fmt, rate_inv, rate_inv_fmt, postfix, unit_divisor, remaining, remaining_s, eta. Note that a trailing ": " is automatically removed after {desc} if the latter is empty.
The initial counter value. Useful when restarting a progress
bar [default: 0]. If using float, consider specifying {n:.3f}
or similar in bar_format, or specifying unit_scale.
Specify the line offset to print this bar (starting from 0) Automatic if unspecified. Useful to manage multiple bars at once (eg, from threads).
*, optional
Specify additional stats to display at the end of the bar.
Calls set_postfix(**postfix) if possible (dict).
[default: 1000], ignored unless unit_scale is True.
Whether to write bytes. If (default: False) will write unicode.
Passed to refresh for intermediate output
(initialisation, iterating, and updating).
The screen height. If specified, hides nested bars outside this bound. If unspecified, attempts to use environment height. The fallback is 20.
Bar colour (e.g. 'green', '#00ff00').
Don't display until [default: 0] seconds have elapsed.
delim is specified.delim, and default
unit_scale to True, unit_divisor to 1024, and unit to 'B'.stdin to both stderr and stdout.update(). Note that this is slow
(~2e5 it/s) since every input must be decoded as a number.self.n. Note that this is slow
(~2e5 it/s) since every input must be decoded as a number.class tqdm():
def update(self, n=1):
"""
Manually update the progress bar, useful for streams
such as reading files.
E.g.:
>>> t = tqdm(total=filesize) # Initialise
>>> for current_buffer in stream:
... ...
... t.update(len(current_buffer))
>>> t.close()
The last line is highly recommended, but possibly not necessary if
``t.update()`` will be called in such a way that ``filesize`` will be
exactly reached and printed.
Parameters
----------
n : int or float, optional
Increment to add to the internal counter of iterations
[default: 1]. If using float, consider specifying ``{n:.3f}``
or similar in ``bar_format``, or specifying ``unit_scale``.
Returns
-------
out : bool or None
True if a ``display()`` was triggered.
"""
def close(self):
"""Cleanup and (if leave=False) close the progressbar."""
def clear(self, nomove=False):
"""Clear current bar display."""
def refresh(self):
"""
Force refresh the display of this bar.
Parameters
----------
nolock : bool, optional
If ``True``, does not lock.
If [default: ``False``]: calls ``acquire()`` on internal lock.
lock_args : tuple, optional
Passed to internal lock's ``acquire()``.
If specified, will only ``display()`` if ``acquire()`` returns ``True``.
"""
def unpause(self):
"""Restart tqdm timer from last print time."""
def reset(self, total=None):
"""
Resets to 0 iterations for repeated use.
Consider combining with ``leave=True``.
Parameters
----------
total : int or float, optional. Total to use for the new bar.
"""
def set_description(self, desc=None, refresh=True):
"""
Set/modify description of the progress bar.
Parameters
----------
desc : str, optional
refresh : bool, optional
Forces refresh [default: True].
"""
def set_postfix(self, ordered_dict=None, refresh=True, **tqdm_kwargs):
"""
Set/modify postfix (additional stats)
with automatic formatting based on datatype.
Parameters
----------
ordered_dict : dict or OrderedDict, optional
refresh : bool, optional
Forces refresh [default: True].
kwargs : dict, optional
"""
@classmethod
def write(cls, s, file=sys.stdout, end="n"):
"""Print a message via tqdm (without overlap with bars)."""
@property
def format_dict(self):
"""Public API for read-only member access."""
def display(self, msg=None, pos=None):
"""
Use ``self.sp`` to display ``msg`` in the specified ``pos``.
Consider overloading this function when inheriting to use e.g.:
``self.some_frontend(**self.format_dict)`` instead of ``self.sp``.
Parameters
----------
msg : str, optional. What to display (default: ``repr(self)``).
pos : int, optional. Position to ``moveto``
(default: ``abs(self.pos)``).
"""
@classmethod
@contextmanager
def wrapattr(cls, stream, method, total=None, bytes=True, **tqdm_kwargs):
"""
stream : file-like object.
method : str, "read" or "write". The result of ``read()`` and
the first argument of ``write()`` should have a ``len()``.
>>> with tqdm.wrapattr(file_obj, "read", total=file_obj.size) as fobj:
... while True:
... chunk = fobj.read(chunk_size)
... if not chunk:
... break
"""
@classmethod
def pandas(cls, *targs, **tqdm_kwargs):
"""Registers the current `tqdm` class with `pandas`."""
def trange(*args, **tqdm_kwargs):
"""Shortcut for `tqdm(range(*args), **tqdm_kwargs)`."""def tqdm.contrib.tenumerate(iterable, start=0, total=None,
tqdm_class=tqdm.auto.tqdm, **tqdm_kwargs):
"""Equivalent of `numpy.ndenumerate` or builtin `enumerate`."""
def tqdm.contrib.tzip(iter1, *iter2plus, **tqdm_kwargs):
"""Equivalent of builtin `zip`."""
def tqdm.contrib.tmap(function, *sequences, **tqdm_kwargs):
"""Equivalent of builtin `map`."""class tqdm.notebook.tqdm(tqdm.tqdm):
"""IPython/Jupyter Notebook widget."""
class tqdm.auto.tqdm(tqdm.tqdm):
"""Automatically chooses beween `tqdm.notebook` and `tqdm.tqdm`."""
class tqdm.asyncio.tqdm(tqdm.tqdm):
"""Asynchronous version."""
@classmethod
def as_completed(cls, fs, *, loop=None, timeout=None, total=None,
**tqdm_kwargs):
"""Wrapper for `asyncio.as_completed`."""
class tqdm.gui.tqdm(tqdm.tqdm):
"""Matplotlib GUI version."""
class tqdm.tk.tqdm(tqdm.tqdm):
"""Tkinter GUI version."""
class tqdm.rich.tqdm(tqdm.tqdm):
"""`rich.progress` version."""
class tqdm.keras.TqdmCallback(keras.callbacks.Callback):
"""Keras callback for epoch and batch progress."""
class tqdm.dask.TqdmCallback(dask.callbacks.Callback):
"""Dask callback for task progress."""contribThe tqdm.contrib package also contains experimental modules:
tqdm.contrib.itertools: Thin wrappers around itertools
tqdm.contrib.concurrent: Thin wrappers around concurrent.futures
tqdm.contrib.slack: Posts to Slack botstqdm.contrib.discord: Posts to Discord botstqdm.contrib.telegram: Posts to Telegram botstqdm.contrib.bells: Automagically enables all optional featuresauto, pandas, slack, discord, telegram
help();Custom information can be displayed and updated dynamically on tqdm bars
with the desc and postfix arguments:
from tqdm import tqdm, trange
from random import random, randint
from time import sleep
with trange(10) as t:
for i in t:
# Description will be displayed on the left
t.set_description('GEN %i' % i)
# Postfix will be displayed on the right,
# formatted automatically based on argument's datatype
t.set_postfix(loss=random(), gen=randint(1,999), str='h',
lst=[1, 2])
sleep(0.1)
with tqdm(total=10, bar_format="{postfix[0]} {postfix[1][value]:>8.2g}",
postfix=["Batch", {"value": 0}]) as t:
for i in range(10):
sleep(0.1)
t.postfix[1]["value"] = i / 2
t.update()Points to remember when using {postfix[...]} in the bar_format string:
postfix also needs to be passed as an initial argument in a compatible
format, andpostfix will be auto-converted to a string if it is a dict-like
object. To prevent this behaviour, insert an extra item into the dictionary
where the key is not a string.Additional bar_format parameters may also be defined by overriding
format_dict, and the bar itself may be modified using ascii:
from tqdm import tqdm
class TqdmExtraFormat(tqdm):
"""Provides a `total_time` format parameter"""
@property
def format_dict(self):
d = super().format_dict
total_time = d["elapsed"] * (d["total"] or 0) / max(d["n"], 1)
d.update(total_time=self.format_interval(total_time) + " in total")
return d
for i in TqdmExtraFormat(
range(
