Python常用库：tqdm——构建进度条

介绍

功能：构建进度条，共有两种构建策略，一个是基于可迭代的对象构建进度条，做for循环迭代时会自动更新进度条；另一个是构建手动更新的进度条，这种方式灵活性更强

class tqdm(Comparable):
    
    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.0, gui=False,
                     **kwargs):

常用参数介绍：

• iterable：可迭代的对象，如果想设置手动更新的进度条，就不需要传入这一参数；
• desc：用于放在进度条左边的描述文字，字符串格式；
• total：进度条总长度，整数形式；
• leave：迭代完之后是否保留进度条，布尔格式；

常用方法

• tqdm.set_description(desc)：设置进度条的描述信息，传入字符串数据，这里会和定义tqdm时传入的desc参数相冲突，二者功能类似；
• tqdm.set_postfix(**kwargs)：设置进度条后缀，可以用来显示额外的信息，传入字典格式的数据；

基于可迭代对象构建

代码案例

​ 在训练神经网络时，常常把构建的数据加载器传入tqdm中，构建进度条，做for循环遍历数据做训练的时候，会可视化出训练过程。

from tqdm import tqdm
import time


dataloader = range(10)
tqds = tqdm(dataloader, desc="train")
for i in tqds:
    tqds.set_postfix({'Iteration': i})
    time.sleep(0.1)

输出

train: 100%|██████████| 10/10 [00:01<00:00,  9.45it/s, Iteration=9]

手动构建

代码案例

from tqdm import tqdm
import time


# total表示进度条总长度
with tqdm(total=10) as pbar:
    for i in range(10):
        pbar.set_description('iter {}'. format(i))
        time.sleep(0.1)
        # 进行进度条更新，这里传入1表示往前进1格
        pbar.update(1)

输出

iter 9: 100%|██████████| 10/10 [00:01<00:00,  9.49it/s]

官方文档

tqdm.tqdm：https://tqdm.github.io/docs/tqdm/