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

阅读更多
Gradio logo
  1. 组件
  2. 标签

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

查看 发布历史

←

JSON

折线图

→

标签

gradio.Label(···)
import gradio as gr with gr.Blocks() as demo: gr.Label(value={"First Label": 0.7, "Second Label": 0.2, "Third Label": 0.1}) demo.launch()

描述

显示分类标签，以及顶部类别的置信度分数（如果提供）。由于此组件不接受用户输入，因此很少用作输入组件。

行为

作为输入组件: 根据值，将标签作为 str | int | float，或将标签和置信度作为 dict[str, float] 传递。

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

作为输出组件: 期望一个 dict[str, float] 的类和置信度，或 str 仅包含类，或一个 int | float 用于回归输出，或一个 str 指向 .json 文件的路径，该文件包含前述格式之一的 json 字典。

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

初始化

参数
🔗 
value: dict[str, float] | str | float | Callable | None
default = None

组件中显示的默认值。如果提供字符串或数字，则简单地显示字符串或数字。如果提供 {Dict[str, float]} 类型的类和置信度，则将顶部类显示在上方，并将 `num_top_classes` 显示在下方，以及它们的置信度条。如果提供了函数，则每次应用加载时都会调用该函数以设置此组件的初始值。

🔗 
num_top_classes: int | None
default = None

要显示的最自信的类别的数量。

🔗 
label: str | None
default = None

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

🔗 
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 应用于行，以及 Blocks 中 fill_height=True 的顶级组件。

🔗 
min_width: int
default = 160

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

🔗 
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

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

🔗 
color: str | None
default = None

标签的背景颜色（可以是有效的 css 颜色名称或十六进制字符串）。

🔗 
show_heading: bool
default = True

如果为 False，则在提供标签和置信度的字典时，标题将不会显示。如果值为字符串或数字，标题仍然可见。

快捷方式

类 界面字符串快捷方式 初始化

gradio.Label

"label"

 使用默认值

事件监听器

描述

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

支持的事件监听器

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

监听器 描述

Label.change(fn, ···)

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

Label.select(fn, ···)

当用户选择或取消选择 Label 时触发的事件监听器。使用事件数据 gradio.SelectData 来传递 value，该值引用 Label 的标签，以及 selected，该值引用 Label 的状态。请参阅 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 应用的“查看 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

指南

Pytorch 中的图像分类

Tensorflow 中的图像分类

使用 Vision Transformers 的图像分类

←

JSON

折线图

→