Gradio 代理与 MCP 黑客马拉松
获奖者
- 组件
- 图库
图库
gradio.Gallery(···)描述
创建一个图库组件，允许显示图像或视频网格，并可选地添加标题。如果用作输入，用户可以将图像或视频上传到图库。如果用作输出，用户可以单击单个图像或视频以更高分辨率查看它们。
行为
作为输入组件: 以（媒体文件，标题）元组列表的形式传递图像或视频列表，如果没有提供标题，则传递（媒体文件，None）元组列表（通常如此）。图像可以是 str 文件路径、numpy 数组或 PIL.Image 对象，具体取决于 type。视频始终是 str 文件路径。
您的函数应接受以下类型之一
def predict(
value: List[tuple[str, str | None]] | List[tuple[PIL.Image.Image, str | None]] | List[tuple[np.ndarray, str | None]] | None
)
...作为输出组件: 期望函数返回图像或视频的 list，或（媒体文件，str 标题）元组的 list。每个图像可以是 str 文件路径、numpy 数组或 PIL.Image 对象。每个视频可以是 str 文件路径。
您的函数应返回以下类型之一
def predict(···) -> list[GalleryImageType | CaptionedGalleryImageType] | None
...
return value初始化
参数
value: list[np.ndarray | PIL.Image.Image | str | Path | tuple] | Callable | None
value: list[np.ndarray | PIL.Image.Image | str | Path | tuple] | Callable | None默认
= None默认显示在图库中的图像或视频列表。如果提供了函数，每次应用程序加载时都会调用该函数以设置此组件的初始值。
format: str
format: str默认
= "webp"在返回前端之前保存图像的格式，例如 'jpeg' 或 'png'。此参数仅适用于以 numpy 数组或 PIL 图像形式从预测函数返回的图像。该格式应受 PIL 库支持。
file_types: list[str] | None
file_types: list[str] | None默认
= None当用作输入组件时，要上传的文件扩展名或文件类型列表（例如 ['image', '.mp4']）。"image" 仅允许上传图像文件，"video" 仅允许上传视频文件，".mp4" 仅允许上传 mp4 文件等。如果为 None，则允许任何图像和视频文件类型。
label: str | I18nData | None
label: str | I18nData | None默认
= None此组件的标签。显示在组件上方，如果此组件有示例表格，也用作表头。如果为 None 且在 `gr.Interface` 中使用，则标签将是此组件所分配参数的名称。
every: Timer | float | None
every: Timer | float | None默认
= None如果 `value` 是一个函数，则持续调用 `value` 以重新计算它（否则无效）。可以提供一个计时器，其滴答声会重置 `value`，或者提供一个浮点数作为重置计时器的常规间隔。
inputs: Component | list[Component] | set[Component] | None
inputs: Component | list[Component] | set[Component] | None默认
= None如果 `value` 是一个函数（否则无效），则用作计算 `value` 的输入组件。每当输入更改时，`value` 都会重新计算。
scale: int | None
scale: int | None默认
= None相对于相邻组件的相对大小。例如，如果组件 A 和 B 在一行中，A 的 scale=2，B 的 scale=1，则 A 将是 B 的两倍宽。应为整数。scale 适用于行，以及 Blocks 中 fill_height=True 的顶级组件。
key: int | str | tuple[int | str, ...] | None
key: int | str | tuple[int | str, ...] | None默认
= None在 gr.render 中，跨重新渲染具有相同键的组件被视为同一组件，而不是新组件。在重新渲染中，'preserved_by_key' 中设置的属性不会被重置。
preserved_by_key: list[str] | str | None
preserved_by_key: list[str] | str | None默认
= "value"此组件构造函数中的参数列表。在 gr.render() 函数中，如果组件以相同的键重新渲染，这些（且仅这些）参数将在 UI 中保留（如果它们已被用户或事件监听器更改），而不是根据构造函数中提供的值重新渲染。
height: int | float | str | None
height: int | float | str | None默认
= None图库组件的高度，如果传入数字则以像素为单位，如果传入字符串则以 CSS 单位指定。如果显示的图像多于高度所能容纳的数量，则会出现滚动条。
preview: bool | None
preview: bool | None默认
= None如果为 True，图库将以预览模式启动，该模式将所有图像显示为缩略图，并允许用户单击它们以全尺寸查看。仅当 allow_preview 为 True 时才有效。
selected_index: int | None
selected_index: int | None默认
= None最初应选定图像的索引。如果为 None，则启动时不会选定任何图像。如果提供，将把图库设置为预览模式，除非 allow_preview 设置为 False。
object_fit: Literal['contain', 'cover', 'fill', 'none', 'scale-down'] | None
object_fit: Literal['contain', 'cover', 'fill', 'none', 'scale-down'] | None默认
= None图库中缩略图图像的 CSS object-fit 属性。可以是 "contain"、"cover"、"fill"、"none" 或 "scale-down"。
快捷方式
| 类 | 接口字符串快捷方式 | 初始化 |
|---|---|---|
| "gallery" | 使用默认值 |
演示
# This demo needs to be run from the repo folder.
# python demo/fake_gan/run.py
import random
import gradio as gr
def fake_gan():
images = [
(random.choice(
[
"http://www.marketingtool.online/en/face-generator/img/faces/avatar-1151ce9f4b2043de0d2e3b7826127998.jpg",
"http://www.marketingtool.online/en/face-generator/img/faces/avatar-116b5e92936b766b7fdfc242649337f7.jpg",
"http://www.marketingtool.online/en/face-generator/img/faces/avatar-1163530ca19b5cebe1b002b8ec67b6fc.jpg",
"http://www.marketingtool.online/en/face-generator/img/faces/avatar-1116395d6e6a6581eef8b8038f4c8e55.jpg",
"http://www.marketingtool.online/en/face-generator/img/faces/avatar-11319be65db395d0e8e6855d18ddcef0.jpg",
]
), f"label {i}")
for i in range(3)
]
return images
with gr.Blocks() as demo:
gallery = gr.Gallery(
label="Generated images", show_label=False, elem_id="gallery"
, columns=1, object_fit="contain", height="auto")
btn = gr.Button("Generate images", scale=0)
btn.click(fake_gan, None, gallery)
if __name__ == "__main__":
demo.launch()
事件监听器
描述
事件监听器允许您响应用户与您在 Gradio Blocks 应用程序中定义的 UI 组件的交互。当用户与某个元素（例如更改滑块值或上传图像）交互时，会调用一个函数。
支持的事件监听器
Gallery 组件支持以下事件监听器。每个事件监听器都采用相同的参数，这些参数列在下面的事件参数表中。
| 监听器 | 描述 |
|---|---|
| 当用户选择或取消选择图库时的事件监听器。使用事件数据 gradio.SelectData 来携带 |
| 当用户上传文件到图库时触发此监听器。 |
| 当图库的值因用户输入（例如用户在文本框中输入）或函数更新（例如图像从事件触发器输出接收值）而更改时触发。有关仅由用户输入触发的监听器，请参阅 |
| 当用户关闭图库预览时，此事件被触发 |
| 当用户打开图库预览时，此事件被触发 |
事件参数
参数
fn: Callable | None | Literal['decorator']
fn: Callable | None | Literal['decorator']默认
= "decorator"此事件触发时要调用的函数。通常是机器学习模型的预测函数。函数的每个参数对应一个输入组件，函数应返回单个值或值元组，其中元组中的每个元素对应一个输出组件。
inputs: Component | BlockContext | list[Component | BlockContext] | Set[Component | BlockContext] | None
inputs: Component | BlockContext | list[Component | BlockContext] | Set[Component | BlockContext] | None默认
= None用作输入的 gradio.components 列表。如果函数不接受任何输入，则此应为空列表。
outputs: Component | BlockContext | list[Component | BlockContext] | Set[Component | BlockContext] | None
outputs: Component | BlockContext | list[Component | BlockContext] | Set[Component | BlockContext] | None默认
= None用作输出的 gradio.components 列表。如果函数不返回任何输出，则此应为空列表。
api_name: str | None | Literal[False]
api_name: str | None | Literal[False]默认
= None定义端点在 API 文档中的显示方式。可以是字符串、None 或 False。如果设置为字符串，则端点将以给定名称在 API 文档中公开。如果为 None（默认），则函数的名称将用作 API 端点。如果为 False，则端点将不会在 API 文档和下游应用程序（包括那些 `gr.load` 此应用程序的应用程序）中公开，并且无法使用此事件。
show_progress: Literal['full', 'minimal', 'hidden']
show_progress: Literal['full', 'minimal', 'hidden']默认
= "full"事件运行时如何显示进度动画：“full”显示一个覆盖输出组件区域以及右上角运行时显示的旋转器，“minimal”仅显示运行时显示，“hidden”根本不显示进度动画。
show_progress_on: Component | list[Component] | None
show_progress_on: Component | list[Component] | None默认
= None在其上显示进度动画的组件或组件列表。如果为 None，则将在所有输出组件上显示进度动画。
queue: bool
queue: bool默认
= True如果为 True，则会将请求放入队列中（如果队列已启用）。如果为 False，则即使队列已启用，也不会将此事件放入队列中。如果为 None，则将使用 Gradio 应用程序的队列设置。
batch: bool
batch: bool默认
= False如果为 True，则函数应处理一批输入，这意味着它应接受每个参数的输入值列表。这些列表的长度应相等（并且长度最多为 `max_batch_size`）。函数随后 *必须* 返回一个列表元组（即使只有一个输出组件），其中元组中的每个列表对应一个输出组件。
preprocess: bool
preprocess: bool默认
= True如果为 False，则在运行 'fn' 之前不会运行组件数据预处理（例如，如果使用 `Image` 组件调用此方法，则将其保留为 base64 字符串）。
cancels: dict[str, Any] | list[dict[str, Any]] | None
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
trigger_mode: Literal['once', 'multiple', 'always_last'] | None默认
= None如果为 "once"（除 `.change()` 之外的所有事件的默认值），则在事件待处理时不允许任何提交。如果设置为 "multiple"，则在待处理时允许无限次提交，而 "always_last"（`.change()` 和 `.key_up()` 事件的默认值）则允许在待处理事件完成后进行第二次提交。
js: str | Literal[True] | None
js: str | Literal[True] | None默认
= None在运行 'fn' 之前要运行的可选前端 js 方法。js 方法的输入参数是 'inputs' 和 'outputs' 的值，返回值应是输出组件的值列表。
concurrency_limit: int | None | Literal['default']
concurrency_limit: int | None | Literal['default']默认
= "default"如果设置，这是可以同时运行的此事件的最大数量。可以设置为 None 表示没有并发限制（可以同时运行任意数量的此事件）。设置为 "default" 以使用默认并发限制（由 `Blocks.queue()` 中的 `default_concurrency_limit` 参数定义，其本身默认为 1）。
concurrency_id: str | None
concurrency_id: str | None默认
= None如果设置，这是并发组的 ID。具有相同 concurrency_id 的事件将受最低设置的 concurrency_limit 限制。