Gradio logo
  1. 使用积木构建
  2. 块和事件监听器
←

四种接口

控制布局

→

块和事件监听器

我们在快速入门中简要介绍了Blocks类，作为一种构建自定义演示的方法。让我们深入探讨。

区块结构

看看下面的演示。

import gradio as gr


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


with gr.Blocks() as demo:
    name = gr.Textbox(label="Name")
    output = gr.Textbox(label="Output Box")
    greet_btn = gr.Button("Greet")
    greet_btn.click(fn=greet, inputs=name, outputs=output, api_name="greet")

demo.launch()

  • 首先，注意with gr.Blocks() as demo:子句。Blocks应用程序代码将包含在此子句中。
  • 接下来是组件。这些组件与Interface中使用的组件相同。然而，与传递给某些构造函数不同，组件在with子句中创建时会自动添加到块中。
  • 最后是click()事件监听器。事件监听器定义了应用程序内的数据流。在上面的示例中，监听器将两个文本框绑定在一起。文本框name作为输入，文本框output作为greet方法的输出。当点击按钮greet_btn时，这个数据流会被触发。像接口一样，事件监听器可以接受多个输入或输出。

你也可以使用装饰器来附加事件监听器 - 跳过 fn 参数并直接分配 inputs 和 outputs：

import gradio as gr

with gr.Blocks() as demo:
    name = gr.Textbox(label="Name")
    output = gr.Textbox(label="Output Box")
    greet_btn = gr.Button("Greet")

    @greet_btn.click(inputs=name, outputs=output)
    def greet(name):
        return "Hello " + name + "!"

demo.launch()

事件监听器和交互性

在上面的例子中，你会注意到你可以编辑文本框 name，但不能编辑文本框 output。这是因为任何作为事件监听器输入的组件都被设置为可交互的。然而，由于文本框 output 仅作为输出，Gradio 决定它不应该被设置为可交互的。你可以通过布尔值 interactive 关键字参数来覆盖默认行为并直接配置组件的交互性，例如 gr.Textbox(interactive=True)。

output = gr.Textbox(label="Output", interactive=True)

注意: 如果一个Gradio组件既不是输入也不是输出会发生什么？如果一个组件是用默认值构建的，那么它被认为是显示内容的，并且被渲染为非交互式的。否则，它将被渲染为交互式的。再次强调，这种行为可以通过为interactive参数指定一个值来覆盖。

事件监听器的类型

看看下面的演示：

import gradio as gr

def welcome(name):
    return f"Welcome to Gradio, {name}!"

with gr.Blocks() as demo:
    gr.Markdown(
    """
    # Hello World!
    Start typing below to see the output.
    """)
    inp = gr.Textbox(placeholder="What is your name?")
    out = gr.Textbox()
    inp.change(welcome, inp, out)

demo.launch()

不是通过点击触发，welcome 函数是通过在文本框 inp 中输入触发的。这是由于 change() 事件监听器的作用。不同的组件支持不同的事件监听器。例如，Video 组件支持 play() 事件监听器，当用户按下播放时触发。请参阅 Docs 了解每个组件的事件监听器。

多数据流

一个Blocks应用程序不像Interfaces那样仅限于单一的数据流。看看下面的演示：

import gradio as gr

def increase(num):
    return num + 1

with gr.Blocks() as demo:
    a = gr.Number(label="a")
    b = gr.Number(label="b")
    atob = gr.Button("a > b")
    btoa = gr.Button("b > a")
    atob.click(increase, a, b)
    btoa.click(increase, b, a)

demo.launch()

请注意，num1 可以作为 num2 的输入，反之亦然！随着你的应用程序变得更加复杂，你将会有许多数据流连接各种组件。

这是一个“多步骤”演示的示例，其中一个模型（语音转文本模型）的输出被输入到下一个模型（情感分类器）中。

from transformers import pipeline

import gradio as gr

asr = pipeline("automatic-speech-recognition", "facebook/wav2vec2-base-960h")
classifier = pipeline("text-classification")

def speech_to_text(speech):
    text = asr(speech)["text"]  
    return text

def text_to_sentiment(text):
    return classifier(text)[0]["label"]  

demo = gr.Blocks()

with demo:
    audio_file = gr.Audio(type="filepath")
    text = gr.Textbox()
    label = gr.Label()

    b1 = gr.Button("Recognize Speech")
    b2 = gr.Button("Classify Sentiment")

    b1.click(speech_to_text, inputs=audio_file, outputs=text)
    b2.click(text_to_sentiment, inputs=text, outputs=label)

demo.launch()

函数输入列表与字典

到目前为止，您所见的事件监听器只有一个输入组件。如果您希望有多个输入组件将数据传递给函数，您有两种方式可以让函数接受输入组件的值：

  1. 作为参数列表，或
  2. 作为值的单一字典，由组件键控

让我们看一个每种情况的例子：

import gradio as gr

with gr.Blocks() as demo:
    a = gr.Number(label="a")
    b = gr.Number(label="b")
    with gr.Row():
        add_btn = gr.Button("Add")
        sub_btn = gr.Button("Subtract")
    c = gr.Number(label="sum")

    def add(num1, num2):
        return num1 + num2
    add_btn.click(add, inputs=[a, b], outputs=c)

    def sub(data):
        return data[a] - data[b]
    sub_btn.click(sub, inputs={a, b}, outputs=c)

demo.launch()

无论是 add() 还是 sub() 都接受 a 和 b 作为输入。然而，这些监听器之间的语法是不同的。

  1. 对于add_btn监听器，我们将输入作为列表传递。函数add()将这些输入中的每一个作为参数。值a映射到参数num1，值b映射到参数num2。
  2. 对于sub_btn监听器，我们将输入作为集合传递（注意花括号！）。函数sub()接受一个字典参数data，其中键是输入组件，值是这些组件的值。

选择哪种语法是个人偏好的问题！对于具有许多输入组件的函数，选项2可能更容易管理。

函数返回列表与字典

同样，您可以返回多个输出组件的值，如下所示：

  1. 值的列表，或
  2. 一个由组件作为键的字典

首先我们来看一个例子（1），在这个例子中，我们通过返回两个值来设置两个输出组件的值：

with gr.Blocks() as demo:
    food_box = gr.Number(value=10, label="Food Count")
    status_box = gr.Textbox()

    def eat(food):
        if food > 0:
            return food - 1, "full"
        else:
            return 0, "hungry"

    gr.Button("Eat").click(
        fn=eat,
        inputs=food_box,
        outputs=[food_box, status_box]
    )

上面，每个返回语句分别返回与food_box和status_box对应的两个值。

除了返回与每个输出组件对应的值列表外，您还可以返回一个字典，其中键对应于输出组件，值作为新值。这也允许您跳过更新某些输出组件。

with gr.Blocks() as demo:
    food_box = gr.Number(value=10, label="Food Count")
    status_box = gr.Textbox()

    def eat(food):
        if food > 0:
            return {food_box: food - 1, status_box: "full"}
        else:
            return {status_box: "hungry"}

    gr.Button("Eat").click(
        fn=eat,
        inputs=food_box,
        outputs=[food_box, status_box]
    )

注意当没有食物时，我们只更新了status_box元素。我们跳过了更新food_box组件。

当事件监听器影响返回时的许多组件，或者有条件地影响某些输出而不影响其他输出时，字典返回非常有用。

请记住，在使用字典返回时，我们仍然需要在事件监听器中指定可能的输出。

更新组件配置

事件监听器函数的返回值通常是对应输出组件的更新值。有时我们也希望更新组件的配置，例如可见性。在这种情况下，我们返回一个新的组件，设置我们想要更改的属性。

import gradio as gr

def change_textbox(choice):
    if choice == "short":
        return gr.Textbox(lines=2, visible=True)
    elif choice == "long":
        return gr.Textbox(lines=8, visible=True, value="Lorem ipsum dolor sit amet")
    else:
        return gr.Textbox(visible=False)

with gr.Blocks() as demo:
    radio = gr.Radio(
        ["short", "long", "none"], label="What kind of essay would you like to write?"
    )
    text = gr.Textbox(lines=2, interactive=True, show_copy_button=True)
    radio.change(fn=change_textbox, inputs=radio, outputs=text)

demo.launch()

了解我们如何通过新的gr.Textbox()方法配置文本框本身。value=参数仍然可以用于更新值以及组件配置。我们未设置的任何参数将保留其先前的值。

不改变组件的值

在某些情况下，您可能希望保持组件的值不变。Gradio 包含一个特殊函数 gr.skip()，您可以从函数中返回它。返回此函数将保持输出组件（或多个组件）的值不变。让我们通过一个示例来说明：

import random
import gradio as gr

with gr.Blocks() as demo:
    with gr.Row():
        clear_button = gr.Button("Clear")
        skip_button = gr.Button("Skip")
        random_button = gr.Button("Random")
    numbers = [gr.Number(), gr.Number()]

    clear_button.click(lambda : (None, None), outputs=numbers)
    skip_button.click(lambda : [gr.skip(), gr.skip()], outputs=numbers)
    random_button.click(lambda : (random.randint(0, 100), random.randint(0, 100)), outputs=numbers)

demo.launch()

注意返回None（通常将组件的值重置为空状态）与返回gr.skip()（保持组件值不变）之间的区别。

提示： 如果你有多个输出组件，并且你想保持它们的所有值不变，你可以只返回一个 `gr.skip()`，而不是为每个元素返回一个跳过的元组。

连续运行事件

你也可以通过使用事件监听器的then方法来连续运行事件。这将在前一个事件运行完成后运行一个事件。这对于以多个步骤更新组件的事件运行非常有用。

例如，在下面的聊天机器人示例中，我们首先立即用用户消息更新聊天机器人，然后在模拟延迟后用计算机响应更新聊天机器人。

import gradio as gr
import random
import time

with gr.Blocks() as demo:
    chatbot = gr.Chatbot()
    msg = gr.Textbox()
    clear = gr.Button("Clear")

    def user(user_message, history):
        return "", history + [[user_message, None]]

    def bot(history):
        bot_message = random.choice(["How are you?", "I love you", "I'm very hungry"])
        time.sleep(2)
        history[-1][1] = bot_message
        return history

    msg.submit(user, [msg, chatbot], [msg, chatbot], queue=False).then(
        bot, chatbot, chatbot
    )
    clear.click(lambda: None, None, chatbot, queue=False)

demo.launch()

事件监听器的.then()方法会执行后续事件，无论前一个事件是否引发了任何错误。如果您希望仅在前一个事件成功执行时才运行后续事件，请使用.success()方法，该方法接受与.then()相同的参数。

将多个触发器绑定到一个函数

很多时候，您可能希望将多个触发器绑定到同一个函数。例如，您可能希望允许用户点击提交按钮，或按回车键提交表单。您可以使用gr.on方法并将触发器列表传递给trigger来实现这一点。

import gradio as gr

with gr.Blocks() as demo:
    name = gr.Textbox(label="Name")
    output = gr.Textbox(label="Output Box")
    greet_btn = gr.Button("Greet")
    trigger = gr.Textbox(label="Trigger Box")

    def greet(name, evt_data: gr.EventData):
        return "Hello " + name + "!", evt_data.target.__class__.__name__

    def clear_name(evt_data: gr.EventData):
        return ""

    gr.on(
        triggers=[name.submit, greet_btn.click],
        fn=greet,
        inputs=name,
        outputs=[output, trigger],
    ).then(clear_name, outputs=[name])

demo.launch()

你也可以使用装饰器语法：

import gradio as gr

with gr.Blocks() as demo:
    name = gr.Textbox(label="Name")
    output = gr.Textbox(label="Output Box")
    greet_btn = gr.Button("Greet")

    @gr.on(triggers=[name.submit, greet_btn.click], inputs=name, outputs=output)
    def greet(name):
        return "Hello " + name + "!"

demo.launch()

你可以使用gr.on通过绑定到实现它的组件的change事件来创建“实时”事件。如果你没有指定任何触发器，该函数将自动绑定到所有包含change事件的输入组件的change事件（例如gr.Textbox有一个change事件，而gr.Button则没有）。

import gradio as gr

with gr.Blocks() as demo:
    with gr.Row():
        num1 = gr.Slider(1, 10)
        num2 = gr.Slider(1, 10)
        num3 = gr.Slider(1, 10)
    output = gr.Number(label="Sum")

    @gr.on(inputs=[num1, num2, num3], outputs=output)
    def sum(a, b, c):
        return a + b + c

demo.launch()

你可以像任何常规的事件监听器一样，在gr.on之后使用.then。这个方便的方法应该可以让你免于编写大量重复的代码！

将组件值直接绑定到其他组件的函数

如果你想将一个组件的值始终设置为其他组件值的函数，你可以使用以下简写：

with gr.Blocks() as demo:
  num1 = gr.Number()
  num2 = gr.Number()
  product = gr.Number(lambda a, b: a * b, inputs=[num1, num2])

这在功能上是相同的：

with gr.Blocks() as demo:
  num1 = gr.Number()
  num2 = gr.Number()
  product = gr.Number()

  gr.on(
    [num1.change, num2.change, demo.load], 
    lambda a, b: a * b, 
    inputs=[num1, num2], 
    outputs=product
  )
←

四种接口

控制布局

→