Gradio Agent & MCP 黑客松

获奖者
Gradio logo
  1. Blocks 布局
  2. Tab

Gradio 新手?从这里开始:开始入门

查看 发布历史

Tab

gradio.Tab(···)

描述

Tab(或其别名 TabItem)是一个布局元素。在此 Tab 中定义的组件将在该 Tab 被选中时可见。

使用示例

with gr.Blocks() as demo:
    with gr.Tab("Lion"):
        gr.Image("lion.jpg")
        gr.Button("New Lion")
    with gr.Tab("Tiger"):
        gr.Image("tiger.jpg")
        gr.Button("New Tiger")

初始化

参数
🔗
label: str | I18nData | None
默认 = None

Tab 的视觉标签

🔗
visible: bool
默认 = True

如果为 False,Tab 将被隐藏。

🔗
interactive: bool
默认 = True

如果为 False,Tab 将不可点击。

🔗
id: int | str | None
默认 = None

Tab 的一个可选标识符,如果您希望从预测函数中控制选定的 Tab,则需要此参数。

🔗
elem_id: str | None
默认 = None

一个可选字符串,作为包含 Tab 布局内容的 <div> 元素的 id。相同字符串后跟“-button”将附加到 Tab 按钮上。可用于 CSS 样式定位。

🔗
elem_classes: list[str] | str | None
默认 = None

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

🔗
scale: int | None
默认 = None

相对于相邻元素的相对大小。1 或更大表示 Tab 将扩展大小。

🔗
render: bool
默认 = True

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

🔗
key: int | str | tuple[int | str, ...] | None
默认 = None
🔗
preserved_by_key: list[str] | str | None
默认 = None

方法

select

gradio.Tab.select(···)

描述

当用户选择或取消选择 Tab 时触发的事件监听器。使用事件数据 gradio.SelectData 携带 `value`(指 Tab 的标签)和 `selected`(指 Tab 的状态)。请参阅 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 docs 中的显示方式。可以是字符串、None 或 False。如果设置为字符串,则端点将以给定名称在 API docs 中公开。如果为 None(默认),函数名称将用作 API 端点。如果为 False,则端点将不会在 API docs 中公开,并且下游应用程序(包括那些 `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 表示没有 concurrency_limit(此事件可以同时运行任意数量)。设置为“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() 中的此事件监听器的唯一键。如果设置,此值会在键相同时,将事件在重新渲染之间识别为相同。

指南