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

阅读更多
Gradio logo
  1. Blocks 布局
  2. 折叠面板

初次使用 Gradio?从这里开始: 入门指南

查看发布历史

折叠面板

gradio.Accordion(···)

描述

折叠面板是一种布局元素,可以切换以显示/隐藏包含的内容。

示例用法

with gr.Accordion("See Details"):
    gr.Markdown("lorem ipsum")

初始化

参数
🔗
label: str | None
default = None

折叠面板部分的名称。

🔗
open: bool
default = True

如果为 True,则默认情况下折叠面板是打开的。

🔗
visible: bool
default = True
🔗
elem_id: str | None
default = None

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

🔗
elem_classes: list[str] | str | None
default = None

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

🔗
render: bool
default = True

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

方法

展开

gradio.Accordion.expand(···)

描述

当折叠面板展开时,将触发此监听器。

参数
🔗
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 应用程序的“view 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

折叠

gradio.Accordion.collapse(···)

描述

当折叠面板折叠时,将触发此监听器。

参数
🔗
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 应用程序的“view 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