Gradio 用户月活突破 100 万！

阅读更多
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'，黑色背景白色文本（与 Hugging Face 的按钮样式一致）使用 'huggingface'。

🔗 
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 | None
default = None

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

🔗 
scale: int | None
default = 0

与相邻组件相比的相对大小。例如，如果组件 A 和 B 在一行中，并且 A 的 scale=2，而 B 的 scale=1，则 A 的宽度将是 B 的两倍。应为整数。scale 应用于行，以及 Blocks 中 fill_height=True 的顶级组件。

🔗 
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
←

Dropdown

File

→