组件
数据集

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

数据帧

日期时间

数据集

gradio.Dataset(···)

import gradio as gr with gr.Blocks() as demo: gr.Dataset(components=[gr.Textbox(visible=False)], label="Text Dataset", samples=[ ["The quick brown fox jumps over the lazy dog"], ["Build & share delightful machine learning apps"], ["She sells seashells by the seashore"], ["Supercalifragilisticexpialidocious"], ["Lorem ipsum"], ["That's all folks!"] ], ) demo.launch()

描述

创建一个画廊或表格来显示数据样本。此组件主要设计用于内部以显示示例。但是，它也可以直接用于显示数据集并让用户选择示例。

行为

作为输入组件: 传递所选样本，可以是对应于每个输入组件的 `list` 数据（如果 `type` 是 “value”），也可以是 `int` 索引（如果 `type` 是 “index”），或者是一个包含索引和数据的 `tuple` （如果 `type` 是 “tuple”）。

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

def predict(
	value: int | list | None
)
	...

作为输出组件: 期望一个 `int` 索引或 `list` 样本数据。返回数据集中样本的索引，或者如果未找到样本，则返回 `None`。

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

def predict(···) -> list[list]
	...	
	return value

初始化

🔗

label: str | None

default = None

此组件的标签，显示在组件上方。

🔗

show_label: bool

default = True

如果为 True，标签将显示在组件上方。

🔗

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

default = None

要在此数据集小部件中显示的组件类型，可以作为字符串名称列表或组件实例传入。数据集支持以下组件：音频、复选框、复选框组、颜色选择器、数据帧、下拉菜单、文件、HTML、图像、Markdown、3D 模型、数字、单选按钮、滑块、文本框、时间序列、视频

🔗

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

default = None

🔗

samples: list[list[Any]] | None

default = None

样本的嵌套列表。外层列表中的每个子列表代表一个数据样本，而子列表中的每个元素代表每个组件的值

🔗

headers: list[str] | None

default = None

数据集小部件中的列标题，应与组件的长度相同。如果未提供，则从组件标签推断

🔗

type: Literal['values', 'index', 'tuple']

default = "values"

“values”：如果单击样本应传递样本的值；“index”：如果应传递样本的索引；或 “tuple”：如果应同时传递样本的索引和值。

🔗

layout: Literal['gallery', 'table'] | None

default = None

“gallery”：如果数据集应显示为画廊，每个样本都在一个可点击的卡片中；或 “table”：如果应显示为表格，每个样本都在一行中。默认情况下，如果只有一个组件，则使用 “gallery”，如果有多个组件，则使用 “table”。如果有多个组件，则布局只能是 “table”。

🔗

samples_per_page: int

default = 10

每页显示多少示例。

🔗

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

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

🔗

container: bool

default = True

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

🔗

scale: int | None

default = None

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

🔗

min_width: int

default = 160

最小像素宽度，如果没有足够的屏幕空间来满足此值，则将换行。如果某个 scale 值导致此组件比 min_width 更窄，则将首先遵守 min_width 参数。

🔗

proxy_url: str | None

default = None

用于加载此组件的外部 Space 的 URL。使用 `gr.load()` 时自动设置。不应手动设置。

🔗

sample_labels: list[str] | None

default = None

每个样本的标签列表。如果提供，则此列表的长度应与样本数相同，并且这些标签将用于 UI 中，而不是渲染样本值。

快捷方式

类	Interface 字符串快捷方式	初始化
`gradio.Dataset`	“dataset”	使用默认值

示例

更新数据集

在此示例中，我们使用 `gr.Dataset` 显示文本数据集，然后在用户单击按钮时更新它

import gradio as gr

philosophy_quotes = [
    ["I think therefore I am."],
    ["The unexamined life is not worth living."]
]

startup_quotes = [
    ["Ideas are easy. Implementation is hard"],
    ["Make mistakes faster."]
]

def show_startup_quotes():
    return gr.Dataset(samples=startup_quotes)

with gr.Blocks() as demo:
    textbox = gr.Textbox()
    dataset = gr.Dataset(components=[textbox], samples=philosophy_quotes)
    button = gr.Button()

    button.click(show_startup_quotes, None, dataset)

demo.launch()

事件侦听器

描述

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

支持的事件侦听器

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

侦听器	描述
`Dataset.click(fn, ···)`	当单击数据集时触发。
`Dataset.select(fn, ···)`	当用户选择或取消选择数据集时的事件侦听器。使用事件数据 gradio.SelectData 来传递 `value`，指代数据集的标签，以及 `selected`，指代数据集的状态。请参阅 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” 以使用默认的 concurrency_limit（由 `Blocks.queue()` 中的 `default_concurrency_limit` 参数定义，该参数本身默认为 1）。

🔗

concurrency_id: str | None

default = None

如果设置，则这是 concurrency 组的 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。

🔗