组件
Image

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

HTML

ImageEditor

Image

gradio.Image(···)

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

描述

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

行为

作为输入组件: 根据 `type` 参数，将上传的图像作为 `numpy.array`、`PIL.Image` 或 `str` 文件路径传递。

您的函数应接受其中一种类型

def predict(
	value: np.ndarray | PIL.Image.Image | str | None
)
	...

作为输出组件: 期望 `numpy.array`、`PIL.Image`，或 `str` 或 `pathlib.Path` 的图像文件路径进行显示。

您的函数应返回其中一种类型

def predict(···) -> np.ndarray | PIL.Image.Image | str | Path | None
	...	
	return value

初始化

🔗

value: str | PIL.Image.Image | np.ndarray | Callable | None

默认值 = None

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

🔗

format: str

默认值 = "webp"

文件格式（例如“png”或“gif”）。用于在图像没有有效格式（例如，如果图像作为 numpy 数组或 PIL 图像返回到前端）时保存图像。该格式应受 PIL 库支持。此参数在组件用作输入或输出时都适用。此参数对 SVG 文件无效。

🔗

height: int | str | None

默认值 = None

组件的高度，如果传入数字则以像素为单位，如果传入字符串则以 CSS 单位表示。这不影响预处理的图像文件或 numpy 数组，但会影响显示的图像。

🔗

width: int | str | None

默认值 = None

组件的宽度，如果传入数字则以像素为单位，如果传入字符串则以 CSS 单位表示。这不影响预处理的图像文件或 numpy 数组，但会影响显示的图像。

🔗

image_mode: Literal['1', 'L', 'P', 'RGB', 'RGBA', 'CMYK', 'YCbCr', 'LAB', 'HSV', 'I', 'F'] | None

默认值 = "RGB"

图像应加载和预处理的像素格式和颜色深度。“RGB”将图像加载为彩色图像，“L”加载为黑白图像。有关其他支持的图像模式及其含义，请参阅 https://pillow.ac.cn/en/stable/handbook/concepts.html。此参数对 SVG 或 GIF 文件无效。如果设置为 None，图像模式将从图像文件类型推断（例如，.png 图像为“RGBA”，在大多数其他情况下为“RGB”）。

🔗

sources: list[Literal['upload', 'webcam', 'clipboard']] | Literal['upload', 'webcam', 'clipboard'] | None

默认值 = None

图像来源列表。“upload”创建一个用户可以放置图像文件的框，“webcam”允许用户从网络摄像头拍摄快照，“clipboard”允许用户从剪贴板粘贴图像。如果为 None，则在 streaming 为 False 时默认为 [“upload”、“webcam”、“clipboard”]，否则默认为 [“webcam”]。

🔗

type: Literal['numpy', 'pil', 'filepath']

默认值 = "numpy"

图像在传递给预测函数之前转换的格式。“numpy”将图像转换为形状为 (height, width, 3)、值为 0 到 255 的 numpy 数组，“pil”将图像转换为 PIL 图像对象，“filepath”传递包含图像的临时文件的字符串路径。为了支持输入中的动画 GIF，`type` 应设置为“filepath”或“pil”。为了支持 SVG，`type` 应设置为“filepath”。

🔗

label: str | I18nData | None

默认值 = None

此组件的标签。显示在组件上方，如果组件有示例表格，也用作表头。如果为 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，将显示下载图像按钮。仅当 interactive 为 False 时（例如组件用作输出时）适用。

🔗

container: bool

默认值 = True

如果为 True，会将组件放置在容器中 - 在边框周围提供额外的填充。

🔗

scale: int | None

默认值 = None

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

🔗

min_width: int

默认值 = 160

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

🔗

interactive: bool | None

默认值 = None

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

🔗

visible: bool

默认值 = True

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

🔗

streaming: bool

默认值 = False

如果在 `live` 界面中使用时为 True，将自动流式传输网络摄像头。仅当 source 为 'webcam' 时有效。如果组件是输出组件，将自动将图像转换为 base64。

🔗

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

🔗

mirror_webcam: bool | None

默认值 = None

如果为 True，网络摄像头将镜像。默认为 True。

🔗

webcam_options: WebcamOptions | None

默认值 = None

🔗

show_share_button: bool | None

默认值 = None

如果为 True，将在组件角落显示一个分享图标，允许用户将输出分享到 Hugging Face Spaces 讨论区。如果为 False，则不显示图标。如果设置为 None（默认行为），则仅当此 Gradio 应用程序在 Spaces 上启动时显示图标，否则不显示。

🔗

placeholder: str | None

默认值 = None

上传区域的自定义文本。提供时会覆盖默认的上传消息。支持换行符和 `#` 来指定标题。

🔗

show_fullscreen_button: bool

默认值 = True

如果为 True，将在组件角落显示一个全屏图标，允许用户以全屏模式查看图像。如果为 False，则不显示图标。

🔗

webcam_constraints: dict[str, Any] | None

默认值 = None

一个字典，允许开发者指定网络摄像头流的自定义媒体约束。此参数提供了灵活性，可控制视频流的属性，例如移动设备上的分辨率以及前置或后置摄像头。请参阅 demo/webcam_constraints

快捷方式

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

`GIF` 和 `SVG` 图像格式

gr.Image 组件可以处理或显示 PIL 库支持的任何图像格式，包括动画 GIF。此外，它还支持 SVG 图像格式。

当 gr.Image 组件用作输入组件时，图像会根据 type 参数转换为 str 文件路径、PIL.Image 对象或 numpy.array。但是，动画 GIF 和 SVG 图像的处理方式有所不同

动画 GIF 图像只能转换为 str 文件路径或 PIL.Image 对象。如果它们转换为 numpy.array（这是默认行为），则只会使用第一帧。因此，如果您的演示期望输入 GIF 图像，请确保相应地设置 type 参数，例如：

import gradio as gr

demo = gr.Interface(
    fn=lambda x:x, 
    inputs=gr.Image(type="filepath"), 
    outputs=gr.Image()
)
    
demo.launch()

对于 SVG 图像，type 参数将完全被忽略，图像始终作为图像文件路径返回。这是因为 SVG 图像无法作为 PIL.Image 或 numpy.array 对象进行处理。

演示

import numpy as np import gradio as gr def sepia(input_img): sepia_filter = np.array([ [0.393, 0.769, 0.189], [0.349, 0.686, 0.168], [0.272, 0.534, 0.131] ]) sepia_img = input_img.dot(sepia_filter.T) sepia_img /= sepia_img.max() return sepia_img demo = gr.Interface(sepia, gr.Image(), "image") if __name__ == "__main__": demo.launch()

import numpy as np
import gradio as gr

def sepia(input_img):
    sepia_filter = np.array([
        [0.393, 0.769, 0.189],
        [0.349, 0.686, 0.168],
        [0.272, 0.534, 0.131]
    ])
    sepia_img = input_img.dot(sepia_filter.T)
    sepia_img /= sepia_img.max()
    return sepia_img

demo = gr.Interface(sepia, gr.Image(), "image")
if __name__ == "__main__":
    demo.launch()

import gradio as gr import numpy as np import time def fake_diffusion(steps): rng = np.random.default_rng() for i in range(steps): time.sleep(1) image = rng.random(size=(600, 600, 3)) yield image image = np.ones((1000,1000,3), np.uint8) image[:] = [255, 124, 0] yield image demo = gr.Interface(fake_diffusion, inputs=gr.Slider(1, 10, 3, step=1), outputs="image") if __name__ == "__main__": demo.launch()

import gradio as gr
import numpy as np
import time

def fake_diffusion(steps):
    rng = np.random.default_rng()
    for i in range(steps):
        time.sleep(1)
        image = rng.random(size=(600, 600, 3))
        yield image
    image = np.ones((1000,1000,3), np.uint8)
    image[:] = [255, 124, 0]
    yield image

demo = gr.Interface(fake_diffusion,
                    inputs=gr.Slider(1, 10, 3, step=1),
                    outputs="image")

if __name__ == "__main__":
    demo.launch()

事件监听器

描述

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

支持的事件监听器

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

监听器	描述
`Image.clear(fn, ···)`	当用户使用组件的清除按钮清除图像时，此监听器被触发。
`Image.change(fn, ···)`	当图像的值因用户输入（例如用户在文本框中输入）或函数更新（例如图像从事件触发器的输出接收值）而改变时触发。有关仅由用户输入触发的监听器，请参阅 `.input()`。
`Image.stream(fn, ···)`	当用户流式传输图像时，此监听器被触发。
`Image.select(fn, ···)`	当用户选择或取消选择图像时触发的事件监听器。使用事件数据 gradio.SelectData 来携带指向图像标签的 `value`，以及指向图像状态的 `selected`。有关如何使用此事件数据，请参阅 EventData 文档。
`Image.upload(fn, ···)`	当用户将文件上传到图像时，此监听器被触发。
`Image.input(fn, ···)`	当用户更改图像的值时，此监听器被触发。

事件参数

🔗

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 表示没有 concurrency_limit（此事件可以同时运行任意数量）。设置为“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() 中使用的唯一键。如果设置，当键相同时，此值将标识事件在重新渲染时是相同的。

辅助类

网络摄像头选项

gradio.WebcamOptions(···)

描述

一个数据类，用于指定 ImageEditor 组件中网络摄像头工具的选项。此类的实例可以传递给 `gr.ImageEditor` 的 `webcam_options` 参数。

初始化

🔗

mirror: bool

默认值 = True

如果为 True，网络摄像头将镜像。

🔗

constraints: dict[str, Any] | None

默认值 = None

网络摄像头的约束字典。

指南

PyTorch 中的图像分类

使用视觉 Transformer 进行图像分类

使用 GAN 创建您自己的朋友

←

HTML

ImageEditor

→

Image

描述

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

行为

作为输入组件: 根据 type 参数，将上传的图像作为 numpy.array、PIL.Image 或 str 文件路径传递。

您的函数应接受其中一种类型

作为输出组件: 期望 numpy.array、PIL.Image，或 str 或 pathlib.Path 的图像文件路径进行显示。

您的函数应返回其中一种类型

初始化

快捷方式

GIF 和 SVG 图像格式

演示

事件监听器

描述

支持的事件监听器

事件参数

辅助类

网络摄像头选项

描述

一个数据类，用于指定 ImageEditor 组件中网络摄像头工具的选项。此类的实例可以传递给 gr.ImageEditor 的 webcam_options 参数。

初始化

指南

作为输入组件: 根据 `type` 参数，将上传的图像作为 `numpy.array`、`PIL.Image` 或 `str` 文件路径传递。

作为输出组件: 期望 `numpy.array`、`PIL.Image`，或 `str` 或 `pathlib.Path` 的图像文件路径进行显示。

`GIF` 和 `SVG` 图像格式

一个数据类，用于指定 ImageEditor 组件中网络摄像头工具的选项。此类的实例可以传递给 `gr.ImageEditor` 的 `webcam_options` 参数。