构建演示
界面

Gradio 新手？从这里开始：入门

ChatInterface

界面

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`）。否则，默认选项为 False。

🔗

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

默认 = None

如果为“lazy”，则在首次使用后缓存示例。如果为“eager”，则在应用程序启动时缓存所有示例。如果为 None，则将使用 GRADIO_CACHE_MODE 环境变量（如果已定义），否则默认为“eager”。

🔗

examples_per_page: int

默认 = 10

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

🔗

example_labels: list[str] | None

默认 = None

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

🔗

live: bool

默认 = False

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

🔗

title: str | 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"]，在这种情况下，值将是字符串列表，标签将是 ["标记为 X", "标记为 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 上显示“Duplicate Spaces”按钮。

🔗

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

默认 = "default"

如果设置，这是可以同时运行的此事件的最大数量。可以设置为 None 表示没有 concurrency_limit（可以同时运行任意数量的此事件）。设置为“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 | 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 组件列表。组件可以作为实例化的对象传递，也可以通过其字符串快捷方式引用。这些组件将呈现在主输入组件下方的手风琴中。默认情况下，不显示其他输入组件。

🔗

additional_inputs_accordion: str | Accordion | None

默认 = None

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

🔗

submit_btn: str | Button

默认 = "提交"

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

🔗

stop_btn: str | Button

默认 = "停止"

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

🔗

clear_btn: str | Button | None

默认 = "清除"

用于清除输入的按钮。默认为 `gr.Button("清除", 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”。

演示

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 笔记本中默认为 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 应用程序中的任何错误都将显示在警报模态框中，并在浏览器控制台日志中打印

🔗

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 | 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

如果提供了密码，则将其与 https 的 ssl 证书一起使用。

🔗

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

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

🔗

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

默认 = None

使用此选项可以指定用于共享链接的协议。默认为“https”，除非提供了自定义 share_server_address，在这种情况下默认为“http”。如果您使用的是自定义 share_server_address 并且想要使用 https，则必须将其设置为“https”。

🔗

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

默认 = None

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

🔗

max_file_size: str | int | None

默认 = None

可以上传的最大文件大小（以字节为单位）。可以是“<value><unit>”形式的字符串，其中 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”的请求。此参数通常应为 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（渐进式 Web 应用程序）。如果设置为 None（默认行为），则如果在 Spaces 上启动此 Gradio 应用程序，则将启用 PWA 功能，否则不启用。

加载

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

描述

当界面最初在浏览器中加载时，将触发此监听器。

🔗

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

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

🔗

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 | None

默认 = None

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

🔗

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

默认 = "default"

如果设置，这是可以同时运行的此事件的最大数量。可以设置为 None 以表示没有 concurrency_limit（可以同时运行任意数量的此事件）。设置为 "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

from_pipeline

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

描述

从 Hugging Face transformers.Pipeline 或 diffusers.DiffusionPipeline 对象构建 Interface 的类方法。输入和输出组件将自动从 pipeline 确定。

用法示例

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

🔗

pipeline: Pipeline | DiffusionPipeline

要使用的 pipeline 对象。

集成

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 仪表板上

队列

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

→