组件
数据集

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

数据框

日期时间

数据集

gradio.Dataset(···)

import gradio as gr with gr.Blocks() as demo: gr.Dataset(components=[gr.Textbox(visible=False)], label="Text Dataset", samples=[ ["敏捷的棕色狐狸跳过懒狗"], ["构建并分享令人愉快的机器学习应用"], ["她在海边卖贝壳"], ["Supercalifragilisticexpialidocious"], ["Lorem ipsum"], ["就这样，各位！"] ], ) 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 | I18nData | None

默认 = None

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

🔗

show_label: bool

默认 = True

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

🔗

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

默认 = None

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

🔗

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

默认 = None

🔗

samples: list[list[Any]] | None

默认 = None

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

🔗

headers: list[str] | None

默认 = None

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

🔗

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

默认 = "values"

如果点击样本应传递样本的值，则为“values”；如果应传递样本的索引，则为“index”；如果应同时传递样本的索引和值，则为“tuple”。

🔗

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

默认 = None

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

🔗

samples_per_page: int

默认 = 10

每页显示多少个示例。

🔗

visible: bool

默认 = True

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

🔗

elem_id: str | None

默认 = None

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

🔗

elem_classes: list[str] | str | None

默认 = None

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

🔗

render: bool

默认 = True

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

🔗

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

默认 = None

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

🔗

preserved_by_key: list[str] | str | None

默认 = "value"

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

🔗

container: bool

默认 = True

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

🔗

scale: int | None

默认 = None

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

🔗

min_width: int

默认 = 160

最小像素宽度，如果屏幕空间不足以满足此值，则会换行。如果某个 scale 值导致此组件的宽度小于 min_width，则将首先遵守 min_width 参数。

🔗

proxy_url: str | None

默认 = None

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

🔗

sample_labels: list[str] | None

默认 = None

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

快捷方式

类	接口字符串快捷方式	初始化
`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']

默认 = "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"

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

🔗

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 | Literal[True] | None

默认 = None

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

🔗

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

默认 = "default"

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

🔗

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

默认 = None

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

←

数据框

日期时间

→

数据集

描述

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

行为

作为输入组件: 将选定的样本作为对应于每个输入组件的数据list（如果type为“value”），或作为int索引（如果type为“index”），或作为索引和数据的tuple（如果type为“tuple”）传递。

您的函数应该接受其中一种类型

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

您的函数应该返回其中一种类型

初始化

快捷方式

示例

事件监听器

描述

支持的事件监听器

事件参数

作为输入组件: 将选定的样本作为对应于每个输入组件的数据`list`（如果`type`为“value”），或作为`int`索引（如果`type`为“index”），或作为索引和数据的`tuple`（如果`type`为“tuple”）传递。

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