组件
ParamViewer

初次使用 Gradio？从这里开始：入门指南

Number

Plot

ParamViewer

gradio.ParamViewer(···)

import gradio as gr with gr.Blocks() as demo: gr.Markdown("Python 中的 `round()` 函数接受两个参数") gr.ParamViewer( { "number": { "type": "int | float", "description": "要四舍五入的数字", "default": None }, "ndigits": { "type": "int", "description": "要四舍五入到的小数位数", "default": "0" } } ) demo.launch()

描述

显示一个交互式表格，包含参数及其描述和默认值，并带有语法高亮。对于每个参数，用户应提供类型（例如 `str`）、人类可读的描述和默认值。由于此组件不接受用户输入，因此很少用作输入组件。在内部，此组件用于在自定义组件库 (https://gradio.org.cn/custom-components/gallery) 中显示组件的参数。

行为

作为输入组件: （很少使用）将值作为 `dict[str, dict]` 传递。外层字典中的键是参数名称，而内层字典对于每个参数都具有键 "type"、"description" 和 "default"。

你的函数应接受以下类型之一

def predict(
	value: dict[str, Parameter]
)
	...

作为输出组件: 期望值作为 `dict[str, dict]`。外层字典中的键是参数名称，而内层字典对于每个参数都具有键 "type"、"description" 和 "default"。

你的函数应返回以下类型之一

def predict(···) -> dict[str, Parameter]
	...	
	return value

初始化

🔗

value: dict[str, Parameter] | None

默认 = None

字典的字典。外层字典中的键是参数名称，而内层字典对于每个参数都具有键 "type"、"description" 和 "default"。"description" 中支持 Markdown 链接。

🔗

language: Literal['python', 'typescript']

默认 = "python"

用于显示代码的语言。可以是 "python" 或 "typescript" 之一。

🔗

linkify: list[str] | None

默认 = None

要链接的字符串列表。如果在描述中找到任何这些字符串，它将呈现为链接。

🔗

every: Timer | float | None

默认 = None

如果 `value` 是一个函数，则持续调用 `value` 以重新计算（否则无效）。可以提供一个 Timer，其刻度重置 `value`，或者提供一个浮点数作为重置 Timer 的固定间隔。

🔗

inputs: Component | list[Component] | set[Component] | None

默认 = None

如果 `value` 是一个函数，则用作输入以计算 `value` 的组件（否则无效）。每当输入更改时，`value` 都会重新计算。

🔗

render: bool

默认 = True

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

🔗

key: int | str | None

默认 = None

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

🔗

header: str | None

默认 = "Parameters"

要在参数表上方显示的标题，还包括一个切换按钮，可一次性关闭/打开所有详细信息。如果为 None，则不显示标题。

🔗

anchor_links: bool | str

默认 = False

如果为 True，则为每个参数创建锚链接，可用于直接链接到该参数。如果是字符串，则使用给定的字符串作为前缀创建锚链接，以防止与其他 ParamViewer 组件冲突。

快捷方式

类	界面字符串快捷方式	初始化
`gradio.ParamViewer`	"paramviewer"	使用默认值

事件监听器

描述

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

支持的事件监听器

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

监听器	描述
`ParamViewer.change(fn, ···)`	当 ParamViewer 的值因用户输入（例如，用户在文本框中键入内容）或函数更新（例如，图像从事件触发器的输出接收到一个值）而更改时触发。有关仅由用户输入触发的监听器，请参阅 `.input()`。
`ParamViewer.upload(fn, ···)`	当用户将文件上传到 ParamViewer 时触发此监听器。

事件参数

🔗

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

可选的前端 js 方法，用于在运行 'fn' 之前运行。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 应用程序的“view API”页面或 Gradio 客户端的 “.view_api()” 方法中显示此事件。与将 api_name 设置为 False 不同，将 show_api 设置为 False 仍然允许下游应用程序以及客户端使用此事件。如果 fn 为 None，show_api 将自动设置为 False。

🔗