快捷導(dǎo)航

Python中tqdm的使用和例子

更新時間：2022年09月22日 11:52:16 作者：Le0v1n

Tqdm是一個快速,可擴(kuò)展的Python進(jìn)度條,可以在 Python 長循環(huán)中添加一個進(jìn)度提示信息,用戶只需要封裝任意的迭代器tqdm(iterator),下面這篇文章主要給大家介紹了關(guān)于Python中tqdm的使用和例子的相關(guān)資料,需要的朋友可以參考下

1. tqdm的介紹

有時候在使用Python處理比較耗時操作的時候，為了便于觀察處理進(jìn)度，這時候就需要通過進(jìn)度條將處理情況進(jìn)行可視化展示，以便我們能夠及時了解情況。

tqdm就能非常完美的支持和解決這些問題，可以實時輸出處理進(jìn)度而且占用的CPU資源非常少，支持windows、Linux、mac等系統(tǒng)，支持①循環(huán)處理、②多進(jìn)程、③遞歸處理、還可以結(jié)合Linux的命令來查看處理情況，等進(jìn)度展示。

1.1 tqdm導(dǎo)入

# 方法1
import tqdm

# 方法2
from tqdm import tqdm

建議使用方法1，因為方法1導(dǎo)入的是一個lib，而方法2導(dǎo)入的是tqdm.tqdm方法
使用方法2導(dǎo)入就沒辦法使用tqdm.trange()等方法了

2. tqdm.tqdm()對可迭代對象進(jìn)行封裝

2.1 語法

# 方法1
for i in tqdm.tqdm(可迭代對象):
	pass

# 方法2
for idx, i in enumerate(tqdm.tqdm(可迭代對象)):
	pass

對于可以迭代的對象都可以使用tqdm進(jìn)行封裝實現(xiàn)可視化進(jìn)度，使用起來非常方便。

2.2 例子

import tqdm
import time

# 定義一個可迭代對象
a = [1, 2, 3, 4, 5, 6, 7, 8, 9, 10]

# 正常的遍歷（沒有進(jìn)度條）
for idx, element in enumerate(a):
    print(f"No.{idx}: {element}")
    
# 使用tqdm對可迭代對象進(jìn)行包裝，實現(xiàn)進(jìn)度條可視化
for idx, element in enumerate(tqdm.tqdm(a)):
    time.sleep(0.5)
    print(f"No.{idx}: {element}")

結(jié)果如下：

Q：為什么結(jié)果會一直新建一行?

A：這是因為每次的print內(nèi)容都不一樣，為了能夠顯示新的內(nèi)容，所以會這樣。

我們看下面這個程序，它因為沒有控制臺輸出，所以進(jìn)度條就很正常。

2.3 帶有參數(shù)的tqdm.tqdm()

Q：進(jìn)度條可以加一些其他信息嗎？

A：當(dāng)然可以，需要對tqdm進(jìn)行一些參數(shù)調(diào)整

@staticmethod
def format_meter(n, total, elapsed, ncols=None, prefix='', ascii=False, unit='it',
                 unit_scale=False, rate=None, bar_format=None, postfix=None,
                 unit_divisor=1000, initial=0, colour=None, **extra_kwargs):

iterable: 可迭代的對象, 在?動更新時不需要進(jìn)?設(shè)置
desc: 字符串, 左邊進(jìn)度條描述?字
total: 總的項?數(shù)
leave: bool值, 迭代完成后是否保留進(jìn)度條
file: 輸出指向位置, 默認(rèn)是終端, ?般不需要設(shè)置
ncols: 調(diào)整進(jìn)度條寬度, 默認(rèn)是根據(jù)環(huán)境?動調(diào)節(jié)長度, 如果設(shè)置為0, 就沒有進(jìn)度條, 只有輸出的信息
unit: 描述處理項?的?字, 默認(rèn)是it, 例如: 100 it/s, 處理照?的話設(shè)置為img ,則為 100 img/s
unit_scale: ?動根據(jù)國際標(biāo)準(zhǔn)進(jìn)?項?處理速度單位的換算, 例如 100000 it/s >> 100k it/s
colour: 進(jìn)度條顏色

2.3.1 例子1

import tqdm
import time
d = {'loss':0.2,'learn':0.8}

"""
    desc設(shè)置名稱
    ncols設(shè)置進(jìn)度條長度 -> 建議設(shè)置在100以內(nèi)
    postfix以字典形式傳入詳細(xì)信息
"""
for i in tqdm.tqdm(range(50),desc='名稱',ncols=100,postfix=d):
    time.sleep(0.1)
    pass

其中xxxit/s表示每秒迭代的次數(shù)

2.3.2 例子2

import tqdm
import time

iter_object = range(10, 21)
pbar = tqdm.tqdm(iter_object, 
                 total=len(iter_object),
                 leave=True, 
                 ncols=100, 
                 unit="個", 
                 unit_scale=False, 
                 colour="red")

for idx, element in enumerate(pbar):
    time.sleep(0.5)
    pbar.set_description(f"No.{idx}")
    pbar.set_postfix({"正在處理的元素為": element})

3. 自定義進(jìn)度條顯示信息

Q：我就是想print一些東西，可以嗎？

A：當(dāng)然可以，tqdm提供了兩個個方法：

set_description()
???????set_postfix()

這兩個方法就類似于print，可以在進(jìn)度條中顯示一些變動的信息

3.1 例子1

import tqdm
import time


# 在使用set_description時一般會創(chuàng)建一個tqdm.tqdm()對象
pbar = tqdm.tqdm(["a", "b", "c", "d", "e", "f", "g"])

for idx, element in enumerate(pbar):
    time.sleep(1)
    pbar.set_description(f"No.{idx}: {element}")

3.2 例子2

import tqdm
import time
import random

epochs = 150

# 在使用set_description()和set_postfix()時一般會創(chuàng)建一個tqdm.tqdm()對象
pbar = tqdm.tqdm(range(epochs), ncols=100)  # ncols設(shè)置進(jìn)度條顯示的字符長度，小了就顯示不全了

for idx, element in enumerate(pbar):
    time.sleep(0.01)
    pbar.set_description(f"Epoch {idx}/{epochs}")
    pbar.set_postfix({"class": element}, loss=random.random(), cost_time = random.randrange(0, 100))

3.3 兩種方法傳參注意事項

set_description和set_postfix都用的kwargs傳參，所以我們可以：

用字典傳參 -> pbar.set_postfix({"key_1": "value_1", ...})
直接用關(guān)鍵字傳參 -> pbar.set_postfix(key_1 = value_1, key_2 = value_2, ...)
混著用 -> pbar.set_postfix({"key_1": value_1, "key_2": value_2, ...}, key_3 = value_3, ...)

4. tqdm內(nèi)置生成可迭代對象方法 —— trange()

除了tqdm.tqdm(range(xxx))這樣的寫法外，tqdm也提供了類似的方法，即tqdm.trange(xxx)，例子如下：

import tqdm
import time

pbar = tqdm.trange(300, 400, 1)

for idx, element in enumerate(pbar):
    time.sleep(0.01)
    pbar.set_description(f"No.{idx} -> {element}")

5. 自定義方法更新進(jìn)度

有時候我們不僅僅是通過一個for訓(xùn)練來更新進(jìn)度條，我們也希望在做完某些操作后更新一次進(jìn)度條，代碼如下：

import tqdm
import time

with tqdm.tqdm(total=10) as bar:  # total為進(jìn)度條總的迭代次數(shù)
    # 操作1
    time.sleep(1)
    # 更新進(jìn)度條
    bar.update(1)  # bar.update()里面的數(shù)表示更新的次數(shù)，和optimizer.step方法類似
    
    # 操作2
    time.sleep(2)
    # 更新進(jìn)度條
    bar.update(3)
    
    # 操作3
    time.sleep(1)
    # 更新進(jìn)度條
    bar.update(6)  # 建議不要超過total