进度

gradio.Progress(···)

描述

Progress 类提供了一个自定义进度跟踪器，用于函数签名中。要将 Progress 跟踪器附加到函数，只需在输入参数之后添加一个参数，该参数的默认值设置为 `gradio.Progress()` 实例。然后可以通过调用 Progress 对象或在 Iterable 上使用 `tqdm` 方法在函数中更新 Progress 跟踪器。Progress 跟踪器目前仅在 `queue()` 中可用。

使用示例

import gradio as gr
import time
def my_function(x, progress=gr.Progress()):
    progress(0, desc="Starting...")
    time.sleep(1)
    for i in progress.tqdm(range(100)):
        time.sleep(0.1)
    return x
gr.Interface(my_function, gr.Textbox(), gr.Textbox()).queue().launch()

初始化

🔗

track_tqdm: bool

default = False

如果为 True，Progress 对象将使用函数中的 tqdm 库跟踪任何 tqdm.tqdm 迭代。

方法

call

gradio.Progress.__call__(progress, ···)

描述

使用进度和消息文本更新进度跟踪器。

🔗

progress: float | tuple[int, int | None] | None

如果是浮点数，则应介于 0 和 1 之间，表示完成百分比。如果是元组，则第一个数字表示已完成的步骤，第二个值表示总步骤数，如果未知，则为 None。如果为 None，则隐藏进度条。

🔗

desc: str | None

default = None

要显示的描述。

🔗

total: int | None

default = None

估计的总步数。

🔗

unit: str

default = "steps"

迭代单位。

tqdm

gradio.Progress.tqdm(iterable, ···)

描述

将进度跟踪器附加到可迭代对象，例如 tqdm。

🔗

iterable: Iterable | None

要将进度跟踪器附加到的可迭代对象。

🔗

desc: str | None

default = None

要显示的描述。

🔗

total: int | None

default = None

估计的总步数。

🔗

unit: str

default = "steps"

迭代单位。

←

示例

依赖项

→