Gradio 迈向每月 100 万用户的旅程！

阅读更多
Gradio logo
  1. 组件
  2. CheckboxGroup

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

查看 发布历史

←

Checkbox

ClearButton

→

CheckboxGroup

gradio.CheckboxGroup(···)
import gradio as gr with gr.Blocks() as demo: gr.CheckboxGroup(["First Choice", "Second Choice", "Third Choice"]) demo.launch()

描述

创建一组复选框。可以用作输入以将一组值传递给函数，或用作输出以显示值，其中一部分值被选中。

行为

作为输入组件: 将选中的复选框列表作为 list[str | int | float] 或它们的索引作为 list[int] 传递到函数中，具体取决于 type。

您的函数应接受以下类型之一
def predict(
	value: list[str | int | float] | list[int | None]
)
	...

作为输出组件: 期望一个 list[str | int | float] 的值或单个 str | int | float 值，具有这些值的复选框将被选中。

您的函数应返回以下类型之一
def predict(···) -> list[str | int | float] | str | int | float | None
	...	
	return value

初始化

参数
🔗 
choices: list[str | int | float | tuple[str, str | int | float]] | None
default = None

从中选择的字符串或数字选项列表。选项也可以是 (name, value) 形式的元组，其中 name 是复选框按钮的显示名称，value 是要传递给函数或由函数返回的值。

🔗 
value: list[str | float | int] | str | float | int | Callable | None
default = None

默认选定的选项列表。如果选择了单个选项，则可以作为字符串或数字类型传入。如果提供了函数，则每次应用程序加载时都会调用该函数以设置此组件的初始值。

🔗 
type: Literal['value', 'index']
default = "value"

组件返回的值的类型。“value” 返回所选选项的字符串列表，“index” 返回所选选项的索引列表。

🔗 
label: str | None
default = None

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

🔗 
info: str | 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

与 Row 中相邻组件相比的相对宽度。例如，如果组件 A 的 scale=2，组件 B 的 scale=1，则 A 将是 B 的两倍宽。应为整数。

🔗 
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 | None
default = None

如果分配，将用于在重新渲染时假定身份。在重新渲染中具有相同键的组件将保留其值。

快捷方式

类 Interface 字符串快捷方式 初始化

gradio.CheckboxGroup

"checkboxgroup"

 使用默认值

演示

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

事件监听器

描述

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

支持的事件监听器

该 CheckboxGroup 组件支持以下事件监听器。每个事件监听器都采用相同的参数，这些参数在 事件参数 下表中列出。

监听器 描述

CheckboxGroup.change(fn, ···)

当 CheckboxGroup 的值因用户输入（例如，用户在文本框中键入）或函数更新（例如，图像从事件触发器的输出接收值）而更改时触发。请参阅 .input() 以获取仅由用户输入触发的监听器。

CheckboxGroup.input(fn, ···)

当用户更改 CheckboxGroup 的值时，将触发此监听器。

CheckboxGroup.select(fn, ···)

当用户选择或取消选择 CheckboxGroup 时的事件监听器。使用事件数据 gradio.SelectData 来携带 value 指 CheckboxGroup 的标签，以及 selected 指 CheckboxGroup 的状态。请参阅 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 以表示没有 concurrency_limit（可以同时运行任意数量的此事件）。设置为“default”以使用默认并发限制（由 `Blocks.queue()` 中的 `default_concurrency_limit` 参数定义，默认值为 1）。

🔗 
concurrency_id: str | None
default = None

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

🔗 
show_api: bool
default = True

是否在 Gradio 应用程序的“view 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
←

Checkbox

ClearButton

→