组件
Checkbox

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

聊天机器人

复选框组

Checkbox

gradio.Checkbox(···)

import gradio as gr with gr.Blocks() as demo: gr.Checkbox() demo.launch()

描述

创建一个复选框，可以将其设置为 `True` 或 `False`。可用作输入以将布尔值传递给函数，或用作输出以显示布尔值。

行为

作为输入组件: 将复选框的状态作为 `bool` 传递。

您的函数应接受以下类型之一

def predict(
	value: bool | None
)
	...

作为输出组件: 期望一个 `bool` 值，该值将设置为复选框的状态

您的函数应返回以下类型之一

def predict(···) -> bool | None
	...	
	return value

初始化

🔗

value: bool | Callable

default = False

如果为 True，则默认选中。如果提供了函数，则每次应用加载时都会调用该函数，以设置此组件的初始值。

🔗

label: str | I18nData | None

default = None

此组件的标签，如果 `show_label` 为 `True`，则显示在组件上方；如果此组件有示例表格，则也用作表头。如果为 None 且在 `gr.Interface` 中使用，则标签将是此组件对应的参数名称。

🔗

info: str | I18nData | None

default = None

附加组件描述，以较小字体显示在标签下方。支持 Markdown / HTML 语法。

🔗

every: Timer | float | None

default = None

如果 `value` 是一个函数，则持续调用 `value` 以重新计算它（否则无效）。可以提供一个 Timer，其计时器滴答会重置 `value`，或者一个浮点数，提供重置 Timer 的常规间隔。

🔗

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

default = None

如果 `value` 是一个函数，则用作输入以计算 `value` 的组件（否则无效）。每当输入改变时，`value` 都会重新计算。

🔗

show_label: bool | None

default = None

如果为 True，将显示标签。

🔗

container: bool

default = True

如果为 True，将把组件放置在一个容器中，在边框周围提供一些额外的填充。

🔗

scale: int | None

default = None

相对于相邻组件的相对大小。例如，如果组件 A 和 B 位于一行中，并且 A 的 scale=2，B 的 scale=1，则 A 的宽度将是 B 的两倍。应为整数。scale 适用于 Rows 以及 Blocks 中 `fill_height=True` 的顶级组件。

🔗

min_width: int

default = 160

最小像素宽度，如果屏幕空间不足以满足此值，则会换行。如果某个 scale 值导致此组件宽度小于 `min_width`，则 `min_width` 参数将优先受到尊重。

🔗

interactive: bool | None

default = None

如果为 True，则此复选框可以被选中；如果为 False，则禁用选中。如果未提供，则根据组件是用作输入还是输出进行推断。

🔗

visible: bool

default = True

如果为 False，组件将被隐藏。

🔗

elem_id: str | None

default = None

一个可选字符串，在 HTML DOM 中作为此组件的 id。可用于定位 CSS 样式。

🔗

elem_classes: list[str] | str | None

default = None

一个可选字符串列表，在 HTML DOM 中作为此组件的类。可用于定位 CSS 样式。

🔗

render: bool

default = True

如果为 False，组件将不会在 Blocks 上下文中渲染。如果意图是现在分配事件监听器但稍后渲染组件，则应使用此参数。

🔗

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

default = None

在 `gr.render` 中，跨重新渲染具有相同 key 的组件被视为同一组件，而不是新组件。'preserved_by_key' 中设置的属性在重新渲染时不会重置。

🔗

preserved_by_key: list[str] | str | None

default = "value"

此组件构造函数中的参数列表。在 `gr.render()` 函数中，如果组件以相同的 key 重新渲染，则这些（且仅这些）参数将在 UI 中保留（如果它们已被用户或事件监听器更改），而不是根据构造函数中提供的值重新渲染。

快捷方式

类	接口字符串快捷方式	初始化
`gradio.Checkbox`	"checkbox"	使用默认值

演示

import gradio as gr def sentence_builder(quantity, animal, countries, place, activity_list, morning): return f"""The {quantity} {animal}s from {" and ".join(countries)} went to the {place} where they {" and ".join(activity_list)} until the {"morning" if morning else "night"}""" demo = gr.Interface( sentence_builder, [ gr.Slider(2, 20, value=4, label="Count", info="Choose between 2 and 20"), gr.Dropdown( ["cat", "dog", "bird"], label="Animal", info="Will add more animals later!" ), gr.CheckboxGroup(["USA", "Japan", "Pakistan"], label="Countries", info="Where are they from?"), gr.Radio(["park", "zoo", "road"], label="Location", info="Where did they go?"), gr.Dropdown( ["ran", "swam", "ate", "slept"], value=["swam", "slept"], multiselect=True, label="Activity", info="Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed auctor, nisl eget ultricies aliquam, nunc nisl aliquet nunc, eget aliquam nisl nunc vel nisl." ), gr.Checkbox(label="Morning", info="Did they do it in the morning?"), ], "text", examples=[ [2, "cat", ["Japan", "Pakistan"], "park", ["ate", "swam"], True], [4, "dog", ["Japan"], "zoo", ["ate", "swam"], False], [10, "bird", ["USA", "Pakistan"], "road", ["ran"], False], [8, "cat", ["Pakistan"], "zoo", ["ate"], True], ] ) if __name__ == "__main__": demo.launch()

import gradio as gr

def sentence_builder(quantity, animal, countries, place, activity_list, morning):
    return f"""The {quantity} {animal}s from {" and ".join(countries)} went to the {place} where they {" and ".join(activity_list)} until the {"morning" if morning else "night"}"""

demo = gr.Interface(
    sentence_builder,
    [
        gr.Slider(2, 20, value=4, label="Count", info="Choose between 2 and 20"),
        gr.Dropdown(
            ["cat", "dog", "bird"], label="Animal", info="Will add more animals later!"
        ),
        gr.CheckboxGroup(["USA", "Japan", "Pakistan"], label="Countries", info="Where are they from?"),
        gr.Radio(["park", "zoo", "road"], label="Location", info="Where did they go?"),
        gr.Dropdown(
            ["ran", "swam", "ate", "slept"], value=["swam", "slept"], multiselect=True, label="Activity", info="Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed auctor, nisl eget ultricies aliquam, nunc nisl aliquet nunc, eget aliquam nisl nunc vel nisl."
        ),
        gr.Checkbox(label="Morning", info="Did they do it in the morning?"),
    ],
    "text",
    examples=[
        [2, "cat", ["Japan", "Pakistan"], "park", ["ate", "swam"], True],
        [4, "dog", ["Japan"], "zoo", ["ate", "swam"], False],
        [10, "bird", ["USA", "Pakistan"], "road", ["ran"], False],
        [8, "cat", ["Pakistan"], "zoo", ["ate"], True],
    ]
)

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

事件监听器

描述

事件监听器允许您响应用户与您在 Gradio Blocks 应用中定义的 UI 组件的交互。当用户与某个元素交互时，例如更改滑块值或上传图像，将调用一个函数。

支持的事件监听器

Checkbox 组件支持以下事件监听器。每个事件监听器都接受相同的参数，这些参数列在下面的事件参数表中。

监听器	描述
`Checkbox.change(fn, ···)`	当 Checkbox 的值发生变化时触发，无论是由于用户输入（例如用户在文本框中输入）还是由于函数更新（例如图像从事件触发器的输出接收值）。请参阅 `.input()` 以获取仅由用户输入触发的监听器。
`Checkbox.input(fn, ···)`	当用户更改 Checkbox 的值时触发此监听器。
`Checkbox.select(fn, ···)`	当用户选中或取消选中 Checkbox 时触发的事件监听器。使用事件数据 gradio.SelectData 来携带 `value`（指 Checkbox 的标签）和 `selected`（指 Checkbox 的状态）。请参阅 EventData 文档以了解如何使用此事件数据。

事件参数

🔗

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

default = "decorator"

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

🔗

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

default = None

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

🔗

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

default = None

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

🔗

api_name: str | None | Literal[False]

default = None

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

🔗

scroll_to_output: bool

default = False

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

🔗

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

default = "full"

事件运行时如何显示进度动画：“full”显示一个覆盖输出组件区域的旋转器以及右上角的运行时显示；“minimal”仅显示运行时显示；“hidden”完全不显示进度动画。

🔗

show_progress_on: Component | list[Component] | None

default = None

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

🔗

queue: bool

default = True

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

🔗

batch: bool

default = False

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

🔗

max_batch_size: int

default = 4

如果从队列调用此事件（仅当 `batch=True` 时相关），则最多可批量处理的输入数量。

🔗

preprocess: bool

default = True

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

🔗

postprocess: bool

default = True

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

🔗

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

default = None

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

🔗

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

default = None

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

🔗

js: str | Literal[True] | None

default = None

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

🔗

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

default = "default"

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

🔗

concurrency_id: str | None

default = None

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

🔗

show_api: bool

default = True

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

🔗

time_limit: int | None

default = None

🔗

stream_every: float

default = 0.5

🔗

like_user_message: bool

default = False

🔗

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

default = None

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

←

聊天机器人

复选框组

→

Checkbox

描述

创建一个复选框，可以将其设置为 True 或 False。可用作输入以将布尔值传递给函数，或用作输出以显示布尔值。

行为

作为输入组件: 将复选框的状态作为 bool 传递。

您的函数应接受以下类型之一

作为输出组件: 期望一个 bool 值，该值将设置为复选框的状态

您的函数应返回以下类型之一

初始化

快捷方式

演示

事件监听器

描述

支持的事件监听器

事件参数

创建一个复选框，可以将其设置为 `True` 或 `False`。可用作输入以将布尔值传递给函数，或用作输出以显示布尔值。

作为输入组件: 将复选框的状态作为 `bool` 传递。

作为输出组件: 期望一个 `bool` 值，该值将设置为复选框的状态