Gradio Agents & MCP 黑客马拉松

获奖者
Gradio logo
  1. 组件
  2. 标签

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

查看 发布历史

←

JSON

LinePlot

→

标签

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，或者指向包含上述格式之一的 JSON 字典的 .json 文件的 str 路径。

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

初始化

参数
🔗 
value: dict[str, float] | str | float | Callable | None
默认值 = None

要在组件中显示的默认值。如果提供字符串或数字，则仅显示字符串或数字。如果提供包含类别和置信度的 {Dict[str, float]}，则在顶部显示置信度最高的类别，并在下方显示 `num_top_classes` 个类别及其置信度条。如果提供函数，则每次应用程序加载时都会调用该函数以设置此组件的初始值。

🔗 
num_top_classes: int | None
默认值 = None

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

🔗 
label: str | I18nData | None
默认值 = None

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

🔗 
every: Timer | float | None
默认值 = None

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

🔗 
inputs: Component | list[Component] | set[Component] | None
默认值 = None

如果 `value` 是一个函数（否则无效），则用作计算 `value` 的输入组件。任何时候输入发生变化，`value` 都会重新计算。

🔗 
show_label: bool | None
默认值 = None

如果为 True，将显示标签。

🔗 
container: bool
默认值 = True

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

🔗 
scale: int | None
默认值 = None

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

🔗 
min_width: int
默认值 = 160

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

🔗 
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` 中，跨重新渲染具有相同 key 的组件被视为同一组件，而不是新组件。在重新渲染时，'preserved_by_key' 中设置的属性不会被重置。

🔗 
preserved_by_key: list[str] | str | None
默认值 = "value"

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

🔗 
color: str | None
默认值 = None

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

🔗 
show_heading: bool
默认值 = True

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

快捷方式

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

gradio.Label

"label"

 使用默认值

事件监听器

描述

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

支持的事件监听器

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

监听器 描述

Label.change(fn, ···)

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

Label.select(fn, ···)

当用户选择或取消选择 Label 时触发的事件监听器。使用事件数据 gradio.SelectData 携带引用 Label 值的 value 和引用 Label 状态的 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

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

指南

PyTorch 中的图像分类

使用 Vision Transformers 进行图像分类

←

JSON

LinePlot

→