Gradio Agents & MCP 黑客马拉松

获奖者
Gradio logo
  1. 组件
  2. DuplicateButton

刚接触 Gradio？从这里开始：快速入门

查看发布历史

←

Dropdown

File

→

DuplicateButton

gradio.DuplicateButton(···)
import gradio as gr with gr.Blocks() as demo: gr.DuplicateButton() demo.launch()

描述

该按钮在 Hugging Face Spaces 上运行时会触发 Spaces 复制。在本地不起作用。

行为

作为输入组件: (很少使用) 点击按钮时对应的按钮标签的 str

您的函数应接受其中一种类型
def predict(
	value: str | None
)
	...

作为输出组件: 对应按钮标签的字符串

您的函数应返回其中一种类型
def predict(···) -> str | None
	...	
	return value

初始化

参数
🔗 
value: str
default = "Duplicate Space"

按钮显示的默认文本。如果提供函数，则每次应用加载时都会调用该函数来设置此组件的初始值。

🔗 
every: Timer | float | None
default = None

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

🔗 
inputs: Component | list[Component] | set[Component] | None
default = None

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

🔗 
variant: Literal['primary', 'secondary', 'stop', 'huggingface']
default = "huggingface"

设置按钮的背景和文本颜色。使用 'primary' 表示主要行动号召按钮，'secondary' 表示更柔和的样式，'stop' 表示停止按钮，'huggingface' 表示黑色背景白色文本，与 Hugging Face 的按钮样式一致。

🔗 
size: Literal['sm', 'md', 'lg']
default = "sm"

按钮的大小。可以是 "sm", "md", 或 "lg"。

🔗 
icon: str | Path | None
default = None

要显示在按钮内的图标文件的 URL 或路径。如果为 None，则不显示图标。

🔗 
visible: bool
default = True

如果为 False，组件将被隐藏。

🔗 
interactive: bool
default = True

如果为 False，按钮将处于禁用状态。

🔗 
elem_id: str | None
default = None

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

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

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

🔗 
render: bool
default = True

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

🔗 
key: int | str | tuple[int | str, ...] | None
default = None

在 gr.render 中，在重新渲染过程中具有相同 key 的组件被视为同一组件，而不是新组件。在 'preserved_by_key' 中设置的属性在重新渲染时不会重置。

🔗 
preserved_by_key: list[str] | str | None
default = "value"

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

🔗 
scale: int | None
default = 0

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

🔗 
min_width: int | None
default = None

最小像素宽度，如果屏幕空间不足以满足此值，则会换行。如果某个 scale 值导致此组件窄于 min_width，则优先遵守 min_width 参数。

快捷方式

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

gradio.DuplicateButton

"duplicatebutton"

 使用默认值

事件监听器

描述

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

支持的事件监听器

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

监听器 描述

DuplicateButton.click(fn, ···)

按钮被点击时触发。

事件参数

参数
🔗 
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 应用的“查看 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
🔗 
key: int | str | tuple[int | str, ...] | None
default = None

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

←

Dropdown

File

→