组件
SimpleImage

Gradio 新手？从这里开始：开始入门

侧边栏

滑块

SimpleImage

gradio.SimpleImage(···)

描述

创建一个图像组件，可用于上传图像（作为输入）或显示图像（作为输出）。

行为

作为输入组件: 一个包含图像路径的 `str`。

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

def predict(
	value: str | None
)
	...

作为输出组件: 期望一个包含图像路径的 `str` 或 `pathlib.Path` 对象。

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

def predict(···) -> str | Path | None
	...	
	return value

初始化

🔗

value: str | None

默认值 = None

SimpleImage 组件将采用的默认值的路径或 URL。如果提供函数，则每次应用程序加载时都会调用该函数以设置此组件的初始值。

🔗

label: str | I18nData | None

默认值 = None

此组件的标签，如果 `show_label` 为 `True` 则显示在组件上方，如果此组件有示例表格，则也用作标题。如果为 None 并在 `gr.Interface` 中使用，则标签将是此组件对应的参数名称。

🔗

every: Timer | float | None

默认值 = None

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

🔗

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

默认值 = None

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

🔗

show_label: bool | None

默认值 = None

如果为 True，将显示标签。

🔗

show_download_button: bool

默认值 = True

如果为 True，将显示下载图像按钮。

🔗

container: bool

默认值 = True

如果为 True，将把组件放置在容器中——在边框周围提供一些额外填充。

🔗

scale: int | None

默认值 = None

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

🔗

min_width: int

默认值 = 160

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

🔗

interactive: bool | None

默认值 = None

如果为 True，将允许用户上传和编辑图像；如果为 False，则只能用于显示图像。如果未提供，则根据组件是用作输入还是输出进行推断。

🔗

visible: bool

默认值 = True

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

🔗

elem_id: str | None

默认值 = None

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

🔗

elem_classes: list[str] | str | None

默认值 = None

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

🔗

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

快捷方式

类	接口字符串快捷方式	初始化
`gradio.SimpleImage`	"simpleimage"	使用默认值

事件监听器

描述

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

支持的事件监听器

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

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

事件参数

🔗

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

此事件监听器的唯一 key，用于 @gr.render()。如果设置，此值将标识在 key 相同的情况下，跨重新渲染的相同事件。

←

侧边栏

滑块

→

SimpleImage

描述

创建一个图像组件，可用于上传图像（作为输入）或显示图像（作为输出）。

行为

作为输入组件: 一个包含图像路径的 str。

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

作为输出组件: 期望一个包含图像路径的 str 或 pathlib.Path 对象。

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

初始化

快捷方式

事件监听器

描述

支持的事件监听器

事件参数

作为输入组件: 一个包含图像路径的 `str`。

作为输出组件: 期望一个包含图像路径的 `str` 或 `pathlib.Path` 对象。