Gradio Agents & MCP 黑客马拉松

获奖者
Gradio logo
  1. 组件
  2. 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"（默认值）键。描述中支持 Markdown 链接。

🔗 
language: Literal['python', 'typescript']
默认值 = "python"

显示代码的语言。可选值包括 "python" 或 "typescript"。

🔗 
linkify: list[str] | None
默认值 = None

要链接化的字符串列表。如果描述中找到这些字符串中的任何一个，它将被渲染为链接。

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

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

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

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

🔗 
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 中被保留（如果它们已被用户或事件监听器更改），而不是根据构造函数中提供的值重新渲染。

🔗 
header: str | None
默认值 = "Parameters"

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

快捷方式

类 接口字符串快捷方式 初始化

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

在运行 '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

此事件监听器在 `@gr.render()` 中使用的唯一键。如果设置，当键相同时，此值会将跨重新渲染的事件识别为相同。

←

Number

Plot

→