构建演示
Interface

初次使用 Gradio？从这里开始：入门

ChatInterface

Interface

gradio.Interface(···)

描述

Interface 是 Gradio 主要的高级类，它允许您通过几行代码为机器学习模型（或任何 Python 函数）创建基于 Web 的 GUI/演示。您必须指定三个参数：(1) 用于创建 GUI 的函数，(2) 所需的输入组件，以及 (3) 所需的输出组件。可以使用附加参数来控制演示的外观和行为。

示例用法

import gradio as gr

def image_classifier(inp):
    return {'cat': 0.3, 'dog': 0.7}

demo = gr.Interface(fn=image_classifier, inputs="image", outputs="label")
demo.launch()

初始化

🔗

fn: Callable

用于封装界面的函数。通常是机器学习模型的预测函数。函数的每个参数对应一个输入组件，函数应返回单个值或一个值元组，其中元组中的每个元素对应一个输出组件。

🔗

inputs: str | Component | list[str | Component] | None

单个 Gradio 组件，或 Gradio 组件列表。组件可以作为实例化对象传递，也可以通过其字符串快捷方式引用。输入组件的数量应与 fn 中的参数数量匹配。如果设置为 None，则只显示输出组件。

🔗

outputs: str | Component | list[str | Component] | None

单个 Gradio 组件，或 Gradio 组件列表。组件可以作为实例化对象传递，也可以通过其字符串快捷方式引用。输出组件的数量应与 fn 返回值的数量匹配。如果设置为 None，则只显示输入组件。

🔗

examples: list[Any] | list[list[Any]] | str | None

默认值 = None

函数的示例输入；如果提供，将显示在 UI 组件下方，可点击以填充界面。应为嵌套列表，其中外层列表由样本组成，每个内层列表由与每个输入组件对应的输入组成。也可以提供示例目录的字符串路径，但它应位于运行 Gradio 应用的 Python 文件所在的目录中。如果存在多个输入组件并提供了目录，则目录中必须存在一个 log.csv 文件以链接相应的输入。

🔗

cache_examples: bool | None

默认值 = None

如果为 True，则在服务器中缓存示例以加快示例的运行时。如果为 "lazy"（懒惰模式），则示例在首次使用后（由应用程序的任何用户）被缓存（适用于应用程序的所有用户）。如果为 None，将使用 GRADIO_CACHE_EXAMPLES 环境变量，该变量应为 "true" 或 "false"。在 HuggingFace Spaces 中，此参数默认为 True（只要也提供了 `fn` 和 `outputs`）。请注意，示例与 Gradio 的 queue() 是分开缓存的，因此某些功能，例如 gr.Progress()、gr.Info()、gr.Warning() 等，不会在 Gradio 的 UI 中显示缓存的示例。

🔗

cache_mode: Literal['eager', 'lazy'] | None

默认值 = None

如果为 "lazy"（懒惰模式），示例将在首次使用后缓存。如果为 "eager"（积极模式），所有示例将在应用程序启动时缓存。如果为 None，将使用 GRADIO_CACHE_MODE 环境变量（如果已定义），否则默认为 "eager"。在 HuggingFace Spaces 中，此参数默认为 "eager"，ZeroGPU Spaces 除外，在这种情况下默认为 "lazy"。

🔗

examples_per_page: int

默认值 = 10

如果提供了示例，每页显示多少个。

🔗

example_labels: list[str] | None

默认值 = None

每个示例的标签列表。如果提供，此列表的长度应与示例数量相同，并且这些标签将在 UI 中使用，而不是渲染示例值。

🔗

preload_example: int | Literal[False]

默认值 = False

如果提供了整数（并且示例正在缓存），则 Gradio 应用首次加载时，将预加载示例列表中该索引处的示例。如果为 False，则不会预加载任何示例。

🔗

live: bool

默认值 = False

如果任何输入发生变化，界面是否应自动重新运行。

🔗

title: str | I18nData | None

默认值 = None

界面标题；如果提供，将以大字体显示在输入和输出组件上方。当在浏览器窗口中打开时，也用作选项卡标题。

🔗

description: str | None

默认值 = None

界面描述；如果提供，将以常规字体显示在输入和输出组件上方和标题下方。接受 Markdown 和 HTML 内容。

🔗

article: str | None

默认值 = None

解释界面的扩展文章；如果提供，将以常规字体显示在输入和输出组件下方。接受 Markdown 和 HTML 内容。如果它是指向可下载远程文件的 HTTP(S) 链接，则显示此文件的内容。

🔗

theme: Theme | str | None

默认值 = None

一个 Theme 对象或表示主题的字符串。如果是字符串，将查找具有该名称的内置主题（例如 "soft" 或 "default"），或者尝试从 Hugging Face Hub 加载主题（例如 "gradio/monochrome"）。如果为 None，将使用默认主题。

🔗

flagging_mode: Literal['never'] | Literal['auto'] | Literal['manual'] | None

默认值 = None

"never"（从不）、"auto"（自动）或 "manual"（手动）之一。如果为 "never" 或 "auto"，用户将看不到标记输入和输出的按钮。如果为 "manual"，用户将看到标记按钮。如果为 "auto"，用户提交的每个输入都将自动标记，以及生成的输出。如果为 "manual"，则在用户点击标记按钮时标记输入和输出。此参数可以使用环境变量 GRADIO_FLAGGING_MODE 进行设置；否则默认为 "manual"。

🔗

flagging_options: list[str] | list[tuple[str, str]] | None

默认值 = None

如果提供，允许用户在标记时从选项列表中选择。仅在 flagging_mode 为 "manual" 时适用。可以是一个元组列表，形式为 (label, value)，其中 label 是将在按钮上显示的字符串，value 是将存储在标记 CSV 中的字符串；或者它可以是一个字符串列表 ["X", "Y"]，在这种情况下，values 将是字符串列表，labels 将是 ["Flag as X", "Flag as Y"] 等。

🔗

flagging_dir: str

默认值 = ".gradio/flagged"

存储已标记数据的目录路径。如果目录不存在，将创建它。

🔗

flagging_callback: FlaggingCallback | None

默认值 = None

None 或 FlaggingCallback 子类的实例，当样本被标记时将调用该实例。如果设置为 None，将创建一个 gradio.flagging.CSVLogger 实例，并将日志保存到 flagging_dir 中的本地 CSV 文件。默认为 None。

🔗

analytics_enabled: bool | None

默认值 = None

是否允许基本遥测。如果为 None，将使用 GRADIO_ANALYTICS_ENABLED 环境变量（如果已定义），否则默认为 True。

🔗

batch: bool

默认值 = False

如果为 True，则函数应处理一批输入，这意味着它应接受每个参数的输入值列表。这些列表的长度应相等（并且长度不超过 `max_batch_size`）。然后，函数*必须*返回一个列表元组（即使只有一个输出组件），其中元组中的每个列表对应一个输出组件。

🔗

max_batch_size: int

默认值 = 4

如果从队列调用（仅在 batch=True 时相关），最大批量输入的数量。

🔗

api_name: str | Literal[False] | None

默认值 = "predict"

定义预测端点在 API 文档中的显示方式。可以是字符串、None 或 False。如果设置为字符串，则该端点将以给定名称在 API 文档中公开。如果为 None，则预测函数的名称将用作 API 端点。如果为 False，则该端点将不会在 API 文档中公开，并且下游应用程序（包括通过 `gr.load` 加载此应用程序的应用程序）将无法使用此预测端点。

🔗

allow_duplication: bool

默认值 = False

如果为 True，则会在 Hugging Face Spaces 上显示“复制 Space”按钮。

🔗

concurrency_limit: int | None | Literal['default']

默认值 = "default"

如果设置，这是此事件可以同时运行的最大数量。可以设置为 None 表示没有并发限制（此事件可以同时运行任意数量）。设置为 "default" 以使用默认并发限制（由 `.queue()` 中的 `default_concurrency_limit` 参数定义，该参数本身默认为 1）。

🔗

css: str | None

默认值 = None

自定义 CSS 代码字符串。此 CSS 将包含在演示网页中。

🔗

css_paths: str | Path | list[str | Path] | None

默认值 = None

自定义 CSS，可以是 CSS 文件（pathlib.Path 对象）或此类路径的列表。这些 CSS 文件将被读取、连接并包含在演示网页中。如果还设置了 `css` 参数，则 `css` 中的 CSS 将首先包含。

🔗

js: str | Literal[True] | None

默认值 = None

自定义 JS 代码字符串。自定义 JS 应为单个 JS 函数的形式。此函数将在页面加载时自动执行。为了获得更大的灵活性，请使用 head 参数将 JS 插入 <script> 标签内。

🔗

head: str | None

默认值 = None

要插入到演示网页 <head> 部分的自定义 HTML 代码。这可用于向页面添加自定义元标签、多个脚本、样式表等。

🔗

head_paths: str | Path | list[str | Path] | None

默认值 = None

自定义 HTML 代码，可以是 HTML 文件（pathlib.Path 对象）或此类路径的列表。这些 HTML 文件将被读取、连接并包含在演示网页的 <head> 部分。如果还设置了 `head` 参数，则 `head` 中的 HTML 将首先包含。

🔗

additional_inputs: str | Component | list[str | Component] | None

默认值 = None

单个 Gradio 组件，或 Gradio 组件列表。组件可以作为实例化对象传递，也可以通过其字符串快捷方式引用。这些组件将显示在主输入组件下方的可折叠面板（accordion）中。默认情况下，不会显示其他输入组件。

🔗

additional_inputs_accordion: str | Accordion | None

默认值 = None

如果提供了字符串，这是用于包含附加输入的 `gr.Accordion` 的标签。也可以提供 `gr.Accordion` 对象来配置包含附加输入的容器的其他属性。默认为 `gr.Accordion(label="Additional Inputs", open=False)`。此参数仅在提供了 `additional_inputs` 时使用。

🔗

submit_btn: str | Button

默认值 = "Submit"

用于提交输入的按钮。默认为 `gr.Button("Submit", variant="primary")`。如果 Interface 仅为输出模式，则此参数不适用，在这种情况下，提交按钮始终显示“生成”。可以设置为字符串（成为按钮标签）或 `gr.Button` 对象（允许更多自定义）。

🔗

stop_btn: str | Button

默认值 = "Stop"

用于停止界面的按钮。默认为 `gr.Button("Stop", variant="stop", visible=False)`。可以设置为字符串（成为按钮标签）或 `gr.Button` 对象（允许更多自定义）。

🔗

clear_btn: str | Button | None

默认值 = "Clear"

用于清除输入的按钮。默认为 `gr.Button("Clear", variant="secondary")`。可以设置为字符串（成为按钮标签）或 `gr.Button` 对象（允许更多自定义）。可以设置为 None，以隐藏按钮。

🔗

delete_cache: tuple[int, int] | None

默认值 = None

一个元组，对应 [频率, 时间]，均以秒为单位表示。每隔 `frequency` 秒，如果文件创建时间超过 `age` 秒，则此 Blocks 实例创建的临时文件将被删除。例如，将其设置为 (86400, 86400) 将每天删除临时文件。服务器重启时，缓存将完全删除。如果为 None，则不会发生缓存删除。

🔗

show_progress: Literal['full', 'minimal', 'hidden']

默认值 = "full"

事件运行时如何显示进度动画：“full”（完全）显示一个覆盖输出组件区域和右上角运行时显示的小圆圈，“minimal”（最小）只显示运行时显示，“hidden”（隐藏）完全不显示进度动画。

🔗

fill_width: bool

默认值 = False

是否水平扩展以完全填充容器。如果为 False，则将应用程序居中并限制最大宽度。

🔗

allow_flagging: Literal['never'] | Literal['auto'] | Literal['manual'] | None

默认值 = None

🔗

time_limit: int | None

默认值 = 30

流运行的时间限制。默认为 30 秒。此参数仅在界面处于实时状态且输入组件设置为 "streaming=True" 时用于流式传输图像或音频。

🔗

stream_every: float

默认值 = 0.5

流数据块发送到后端时的延迟（以秒为单位）。默认为 0.5 秒。此参数仅在界面处于实时状态且输入组件设置为 "streaming=True" 时用于流式传输图像或音频。

🔗

deep_link: str | DeepLinkButton | bool | None

默认值 = None

一个字符串或 `gr.DeepLinkButton` 对象，用于创建一个唯一的 URL，您可以用来与他人共享您的应用程序及其所有组件的**当前状态**。在 Hugging Face Spaces 上会自动启用，除非明确设置为 False。

演示

import gradio as gr def greet(name): return "Hello " + name + "!" demo = gr.Interface(fn=greet, inputs="textbox", outputs="textbox") if __name__ == "__main__": demo.launch()

import gradio as gr


def greet(name):
    return "Hello " + name + "!"


demo = gr.Interface(fn=greet, inputs="textbox", outputs="textbox")

if __name__ == "__main__":
    demo.launch()

import gradio as gr def greet(name, intensity): return "Hello, " + name + "!" * intensity demo = gr.Interface( fn=greet, inputs=["text", gr.Slider(value=2, minimum=1, maximum=10, step=1)], outputs=[gr.Textbox(label="greeting", lines=3)], ) if __name__ == "__main__": demo.launch()

import gradio as gr

def greet(name, intensity):
    return "Hello, " + name + "!" * intensity

demo = gr.Interface(
    fn=greet,
    inputs=["text", gr.Slider(value=2, minimum=1, maximum=10, step=1)],
    outputs=[gr.Textbox(label="greeting", lines=3)],
)

if __name__ == "__main__":
    demo.launch()

import gradio as gr def greet(name, is_morning, temperature): salutation = "Good morning" if is_morning else "Good evening" greeting = f"{salutation} {name}. It is {temperature} degrees today" celsius = (temperature - 32) * 5 / 9 return greeting, round(celsius, 2) demo = gr.Interface( fn=greet, inputs=["text", "checkbox", gr.Slider(0, 100)], outputs=["text", "number"], ) if __name__ == "__main__": demo.launch()

import gradio as gr

def greet(name, is_morning, temperature):
    salutation = "Good morning" if is_morning else "Good evening"
    greeting = f"{salutation} {name}. It is {temperature} degrees today"
    celsius = (temperature - 32) * 5 / 9
    return greeting, round(celsius, 2)

demo = gr.Interface(
    fn=greet,
    inputs=["text", "checkbox", gr.Slider(0, 100)],
    outputs=["text", "number"],
)
if __name__ == "__main__":
    demo.launch()

方法

launch

gradio.Interface.launch(···)

描述

启动一个简单的 Web 服务器来提供演示。也可以通过设置 share=True 来创建可由任何人通过浏览器访问演示的公共链接。

示例用法

import gradio as gr
def reverse(text):
    return text[::-1]
demo = gr.Interface(reverse, "text", "text")
demo.launch(share=True, auth=("username", "password"))

🔗

inline: bool | None

默认值 = None

是否在 Gradio 应用中以 iframe 形式内联显示。在 Python Notebooks 中默认为 True；否则为 False。

🔗

inbrowser: bool

默认值 = False

是否在默认浏览器的新标签页中自动启动 Gradio 应用。

🔗

share: bool | None

默认值 = None

是否为 Gradio 应用创建可公开共享的链接。创建一个 SSH 隧道，使您的 UI 可以从任何地方访问。如果未提供，则每次默认为 False，但在 Google Colab 中运行时除外。当 localhost 无法访问时（例如 Google Colab），不支持设置 share=False。可以通过环境变量 GRADIO_SHARE=True 进行设置。

🔗

debug: bool

默认值 = False

如果为 True，则阻止主线程运行。如果在 Google Colab 中运行，则需要此项才能在单元格输出中打印错误。

🔗

max_threads: int

默认值 = 40

Gradio 应用可以并行生成的最大线程总数。默认值继承自 Starlette 库（目前为 40）。

🔗

auth: Callable[[str, str], bool] | tuple[str, str] | list[tuple[str, str]] | None

默认值 = None

如果提供，访问应用程序所需的用户名和密码（或用户名-密码元组列表）。也可以提供一个函数，该函数接受用户名和密码并在登录有效时返回 True。

🔗

auth_message: str | None

默认值 = None

如果提供，登录页面上提供的 HTML 消息。

🔗

prevent_thread_lock: bool

默认值 = False

默认情况下，Gradio 应用程序在服务器运行时会阻塞主线程。如果设置为 True，Gradio 应用程序将不会阻塞，并且 Gradio 服务器将在脚本完成后立即终止。

🔗

show_error: bool

默认值 = False

如果为 True，则 Gradio 应用中的任何错误都将显示在警报模态框中，并打印到浏览器控制台日志中。它们也将在通过 gr.load() 加载此应用程序的下游应用程序的警报模态框中显示。

🔗

server_name: str | None

默认值 = None

要使应用程序在本地网络上可访问，请将其设置为 "0.0.0.0"。可以通过环境变量 GRADIO_SERVER_NAME 进行设置。如果为 None，将使用 "127.0.0.1"。

🔗

server_port: int | None

默认值 = None

将在此端口（如果可用）上启动 Gradio 应用。可以通过环境变量 GRADIO_SERVER_PORT 进行设置。如果为 None，将从 7860 开始搜索可用端口。

🔗

height: int

默认值 = 500

包含 Gradio 应用的 iframe 元素的高度（以像素为单位）（如果 inline=True 则使用）。

🔗

width: int | str

默认值 = "100%"

包含 Gradio 应用的 iframe 元素的宽度（以像素为单位）（如果 inline=True 则使用）。

🔗

favicon_path: str | Path | None

默认值 = None

如果提供了文件（.png、.gif 或 .ico）的路径，它将用作网页的图标。

🔗

ssl_keyfile: str | None

默认值 = None

如果提供了文件路径，将使用此文件作为私钥文件，以创建在 HTTPS 上运行的本地服务器。

🔗

ssl_certfile: str | None

默认值 = None

如果提供了文件路径，将使用此文件作为 HTTPS 的签名证书。如果提供了 ssl_keyfile，则必须提供此文件。

🔗

ssl_keyfile_password: str | None

默认值 = None

如果提供了密码，将与 SSL 证书一起用于 HTTPS。

🔗

ssl_verify: bool

默认值 = True

如果为 False，则跳过证书验证，允许使用自签名证书。

🔗

quiet: bool

默认值 = False

如果为 True，则抑制大多数打印语句。

🔗

show_api: bool

默认值 = True

如果为 True，则在应用程序的页脚显示 API 文档。默认为 True。

🔗

allowed_paths: list[str] | None

默认值 = None

Gradio 允许提供服务的完整文件路径或父目录列表。必须是绝对路径。警告：如果提供目录，则这些目录或其子目录中的任何文件都可供应用程序的所有用户访问。可以通过逗号分隔的环境变量 GRADIO_ALLOWED_PATHS 进行设置。这些文件通常被认为是安全的，并且在可能的情况下会在浏览器中显示。

🔗

blocked_paths: list[str] | None

默认值 = None

Gradio 不允许提供服务的完整文件路径或父目录列表（即您的应用程序用户不允许访问）。必须是绝对路径。警告：此设置优先于 `allowed_paths` 以及 Gradio 默认公开的所有其他目录。可以通过逗号分隔的环境变量 GRADIO_BLOCKED_PATHS 进行设置。

🔗

root_path: str | None

默认值 = None

应用程序的根路径（或“挂载点”），如果它不是从域的根路径 (“/”) 提供服务。通常在应用程序位于将请求转发到应用程序的反向代理后面时使用。例如，如果应用程序在 "https://example.com/myapp" 上提供服务，则 `root_path` 应设置为 "/myapp"。可以提供以 http:// 或 https:// 开头的完整 URL，它将用作整个根路径。可以通过环境变量 GRADIO_ROOT_PATH 进行设置。默认为 ""。

🔗

app_kwargs: dict[str, Any] | None

默认值 = None

要传递给底层 FastAPI 应用程序的额外关键字参数，作为参数键和参数值的字典。例如，`{"docs_url": "/docs"}`

🔗

state_session_capacity: int

默认值 = 10000

要在内存中存储信息的最大会话数。如果会话数超过此限制，最旧的会话将被删除。在使用 gradio.State 或从函数返回更新的组件时，减少容量以降低内存使用。默认为 10000。

🔗

share_server_address: str | None

默认值 = None

用于指定自定义 FRP 服务器和端口以共享 Gradio 应用程序（仅在 share=True 时适用）。如果未提供，将使用默认的 FRP 服务器 https://gradio.live。有关更多信息，请参阅 https://github.com/huggingface/frp。

🔗

share_server_protocol: Literal['http', 'https'] | None

默认值 = None

用于指定共享链接所使用的协议。默认为 "https"，除非提供了自定义的 share_server_address，在这种情况下默认为 "http"。如果您使用自定义的 share_server_address 并希望使用 https，则必须将其设置为 "https"。

🔗

share_server_tls_certificate: str | None

默认值 = None

连接到自定义共享服务器时使用的 TLS 证书文件的路径。此参数不与默认的 FRP 服务器 https://gradio.live 一起使用。否则，您必须提供相对于当前工作目录的有效 TLS 证书文件（例如 "cert.pem"），否则连接将不使用 TLS 加密，这是不安全的。

🔗

auth_dependency: Callable[[fastapi.Request], str | None] | None

默认值 = None

一个函数，接受 FastAPI 请求并返回字符串用户 ID 或 None。如果函数对特定请求返回 None，则该用户无权访问应用程序（他们将看到 401 未授权响应）。用于与 OAuth 等外部身份验证系统结合使用。不能与 `auth` 一起使用。

🔗

max_file_size: str | int | None

默认值 = None

可上传的最大文件大小（以字节为单位）。可以是 "<值><单位>" 形式的字符串，其中 value 是任何正整数，unit 是 "b"、"kb"、"mb"、"gb"、"tb" 之一。如果为 None，则不设置限制。

🔗

enable_monitoring: bool | None

默认值 = None

通过 /monitoring 端点启用应用程序流量监控。默认为 None，启用此端点。如果明确设置为 True，还会将监控 URL 打印到控制台。如果为 False，将完全禁用监控。

🔗

strict_cors: bool

默认值 = True

如果为 True，则阻止外部域向在 localhost 上运行的 Gradio 服务器发出请求。如果为 False，则允许源自 localhost 但也（关键地）源自 "null" 的 localhost 请求。此参数通常应为 True 以防止 CSRF 攻击，但在使用 Web 组件嵌入*本地运行的 Gradio 应用*时可能需要设置为 False。

🔗

node_server_name: str | None

默认值 = None

🔗

node_port: int | None

默认值 = None

🔗

ssr_mode: bool | None

默认值 = None

如果为 True，Gradio 应用将使用服务器端渲染模式呈现，这通常性能更好并提供更好的 SEO，但这需要系统上安装 Node 20+。如果为 False，则应用将使用客户端渲染模式呈现。如果为 None，将使用 GRADIO_SSR_MODE 环境变量或默认为 False。

🔗

pwa: bool | None

默认值 = None

如果为 True，Gradio 应用将被设置为可安装的 PWA（Progressive Web App）。如果设置为 None（默认行为），则此 Gradio 应用在 Spaces 上启动时将启用 PWA 功能，否则不启用。

🔗

mcp_server: bool | None

默认值 = None

如果为 True，Gradio 应用将被设置为 MCP 服务器，并且文档化的函数将作为 MCP 工具添加。如果为 None（默认行为），则将使用 GRADIO_MCP_SERVER 环境变量来确定是否应启用 MCP 服务器（在 Hugging Face Spaces 上为 "True"）。

🔗

i18n: I18n | None

默认值 = None

一个 I18n 实例，包含自定义翻译，用于翻译我们组件中的字符串（例如组件的标签或 Markdown 字符串）。此功能只能用于翻译前端中的静态文本，不能翻译后端中的值。

load

gradio.Interface.load(block, ···)

描述

当 Interface 在浏览器中首次加载时触发此监听器。

🔗

block: Block | None

🔗

fn: Callable | None | Literal['decorator']

默认值 = "decorator"

此事件触发时要调用的函数。通常是机器学习模型的预测函数。函数的每个参数对应一个输入组件，函数应返回单个值或一个值元组，其中元组中的每个元素对应一个输出组件。

🔗

inputs: Component | BlockContext | list[Component | BlockContext] | Set[Component | BlockContext] | None

默认值 = None

用作输入的 gradio.components 列表。如果函数不接受任何输入，则此项应为空列表。

🔗

outputs: Component | BlockContext | list[Component | BlockContext] | Set[Component | BlockContext] | None

默认值 = None

用作输出的 gradio.components 列表。如果函数不返回任何输出，则此项应为空列表。

🔗

api_name: str | None | Literal[False]

默认值 = None

定义端点在 API 文档中的显示方式。可以是字符串、None 或 False。如果设置为字符串，则该端点将以给定名称在 API 文档中公开。如果为 None（默认），则函数的名称将用作 API 端点。如果为 False，则该端点将不会在 API 文档中公开，并且下游应用程序（包括通过 `gr.load` 加载此应用程序的应用程序）将无法使用此事件。

🔗

scroll_to_output: bool

默认值 = False

如果为 True，则在完成后将滚动到输出组件。

🔗

show_progress: Literal['full', 'minimal', 'hidden']

默认值 = "full"

🔗

show_progress_on: Component | list[Component] | None

默认值 = None

显示进度动画的组件或组件列表。如果为 None，将在所有输出组件上显示进度动画。

🔗

queue: bool

默认值 = True

如果为 True，如果队列已启用，则会将请求放入队列。如果为 False，即使队列已启用，也不会将此事件放入队列。如果为 None，将使用 Gradio 应用的队列设置。

🔗

batch: bool

默认值 = False

🔗

max_batch_size: int

默认值 = 4

如果从队列调用（仅在 batch=True 时相关），最大批量输入的数量。

🔗

preprocess: bool

默认值 = True

如果为 False，则在运行 'fn' 之前不会对组件数据进行预处理（例如，如果使用 `Image` 组件调用此方法，则将其保留为 base64 字符串）。

🔗

postprocess: bool

默认值 = True

如果为 False，则在将 'fn' 输出返回到浏览器之前不会对组件数据进行后处理。

🔗

cancels: dict[str, Any] | list[dict[str, Any]] | None

默认值 = None

当此监听器触发时要取消的其他事件列表。例如，设置 cancels=[click_event] 将取消 click_event，其中 click_event 是另一个组件的 .click 方法的返回值。尚未运行的函数（或正在迭代的生成器）将被取消，但当前正在运行的函数将被允许完成。

🔗

trigger_mode: Literal['once', 'multiple', 'always_last'] | None

默认值 = None

如果为 "once"（除 `.change()` 之外所有事件的默认值），则在事件待处理时不允许任何提交。如果设置为 "multiple"（多次），则在待处理时允许无限次提交，而 "always_last"（`.change()` 和 `.key_up()` 事件的默认值）则允许在待处理事件完成后进行第二次提交。

🔗

js: str | Literal[True] | None

默认值 = None

在运行 'fn' 之前运行的可选前端 JS 方法。JS 方法的输入参数是 'inputs' 和 'outputs' 的值，返回值应是输出组件的值列表。

🔗

concurrency_limit: int | None | Literal['default']

默认值 = "default"

如果设置，这是此事件可以同时运行的最大数量。可以设置为 None 表示没有并发限制（此事件可以同时运行任意数量）。设置为 "default" 以使用默认并发限制（由 `Blocks.queue()` 中的 `default_concurrency_limit` 参数定义，该参数本身默认为 1）。

🔗

concurrency_id: str | None

默认值 = None

如果设置，这是并发组的 ID。具有相同 concurrency_id 的事件将受限于最低设置的 concurrency_limit。

🔗

show_api: bool

默认值 = True

是否在 Gradio 应用的“查看 API”页面或 Gradio 客户端的 ".view_api()" 方法中显示此事件。与将 api_name 设置为 False 不同，将 show_api 设置为 False 仍然允许下游应用程序和客户端使用此事件。如果 fn 为 None，show_api 将自动设置为 False。

🔗

time_limit: int | None

默认值 = None

🔗

stream_every: float

默认值 = 0.5

🔗

like_user_message: bool

默认值 = False

🔗

key: int | str | tuple[int | str, ...] | None

默认值 = None

此事件监听器的唯一键，用于 @gr.render()。如果设置，此值会在键相同的情况下将事件标识为跨重新渲染是相同的。

from_pipeline

gradio.Interface.from_pipeline(pipeline, ···)

描述

从 Hugging Face `transformers.Pipeline` 或 `diffusers.DiffusionPipeline` 对象构造 `Interface` 的类方法。输入和输出组件会自动从管道中确定。

示例用法

import gradio as gr
from transformers import pipeline
pipe = pipeline("image-classification")
gr.Interface.from_pipeline(pipe).launch()

🔗

pipeline: Pipeline | DiffusionPipeline

要使用的管道对象。

integrate

gradio.Interface.integrate(···)

描述

用于与其他库集成的包罗万象的方法。此方法应在 launch() 之后运行。

🔗

comet_ml: <class 'inspect._empty'>

默认值 = None

如果提供了 comet_ml Experiment 对象，将与实验集成并显示在 Comet 仪表板上。

🔗

wandb: ModuleType | None

默认值 = None

如果提供了 wandb 模块，将与它集成并显示在 WandB 仪表板上。

🔗

mlflow: ModuleType | None

默认值 = None

如果提供了 mlflow 模块，将与实验集成并显示在 ML Flow 仪表板上。

queue

gradio.Interface.queue(···)

描述

通过启用队列，您可以控制用户何时知道他们在队列中的位置，并设置允许的最大事件数量限制。

示例用法

demo = gr.Interface(image_generator, gr.Textbox(), gr.Image())
demo.queue(max_size=20)
demo.launch()

🔗

status_update_rate: float | Literal['auto']

默认值 = "auto"

如果为 "auto"，队列将在作业完成时向所有客户端发送状态估计。否则，队列将按照此参数设置的秒数定期发送状态。

🔗

api_open: bool | None

默认值 = None

如果为 True，则后端 REST 路由将开放，允许直接向这些端点发出的请求跳过队列。

🔗

max_size: int | None

默认值 = None

队列在任何给定时刻将存储的最大事件数。如果队列已满，则不会添加新事件，用户将收到一条消息，指出队列已满。如果为 None，则队列大小将不受限制。

🔗

default_concurrency_limit: int | None | Literal['not_set']

默认值 = "not_set"

未指定值的事件监听器使用的 `concurrency_limit` 的默认值。可以通过环境变量 GRADIO_DEFAULT_CONCURRENCY_LIMIT 进行设置。如果未另外设置，则默认为 1。

指南

快速开始

共享您的应用

界面状态

响应式界面

ChatInterface

→