progress

class progress(sequence, desc='Workin on...', total=None, completed=0, upgrade_period=0.1, disable=False, post_desc='')

包装了 rich 进度条的类。

for batch in progress(dataloader):
    # do something

with progress(dataloader) as bar:
    for batch in bar:
        # do something
        bar.set_postfix(Loss=1.0)

bar = progress(dataloader)
for batch in bar:
    # do something
    bar.set_postfix(Loss=1.0)

参数:

• sequence – 需要遍历的序列，需要是一个可以迭代的对象。

• desc (default: 'Workin on...') – 进度条最左侧的描述语句。

• total (default: None) – 遍历对象的总数。如果为 None 则会自动进行计算。

• completed (default: 0) – 标识进度条的总进度。

• upgrade_period (default: 0.1) – 进度条更新的时间间隔。

• disable (default: False) – 调整进度条是否可见。

• post_desc (str, default: '') – 进度条最右侧的补充描述语句。

set_post_desc(post_desc)

设置进度条最右侧的补充描述语句。

bar = progress(dataloader)
dataloader.set_post_desc("Loss=1.0")

set_postfix(**kwargs)

设置进度条最右侧的补充描述语句。

对于传入的每一对 key 和 value 将以 key1: value1, key2: value2, .. 的格式进行显示。

bar = progress(dataloader)
dataloader.set_postfix(Loss=1.0, Batch=1)

set_description(desc)

设置进度条最左侧的描述语句。

reset(desc=None, total=None, completed=0, visible=None, post_desc=None)

重置进度条，可以重置进度条的显示时间。

参数:

• desc (Optional[str], default: None) – 进度条最左侧的描述语句。

• total (Optional[float], default: None) – 遍历对象的总数。如果为 None 则不会发生改变。

• completed (int, default: 0) – 标识进度条的总进度。

• visible (Optional[bool], default: None) – 调整进度条是否可见。

• post_desc (Optional[str], default: None) – 进度条最右侧的补充描述语句。

update(desc=None, total=None, completed=None, advance=None, visible=None, refresh=False, post_desc=None)

对进度条的内容进行更新，可以更加详细地改变进度条的内容。

参数:

• desc (Optional[str], default: None) – 进度条最左侧的描述语句。

• total (Optional[float], default: None) – 遍历对象的总数。如果为 None 则不会发生改变。

• completed (Optional[float], default: None) – 标识进度条的总进度。

• advance (Optional[float], default: None) – 该次进度条更新的进度。

• visible (Optional[bool], default: None) – 调整进度条是否可见。

• refresh (bool, default: False) – 是否强制刷新进度条。

• post_desc (Optional[str], default: None) – 进度条最右侧的补充描述语句。

返回类型:

None