Gradio Agents & MCP 黑客马拉松

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

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

查看发布历史

←

ImageEditor

JSON

→

ImageSlider

gradio.ImageSlider(···)
import gradio as gr with gr.Blocks() as demo: gr.ImageSlider(("https://raw.githubusercontent.com/gradio-app/gradio/refs/heads/js/_website/src/lib/assets/img/header-image.jpg", "https://raw.githubusercontent.com/gradio-app/gradio/refs/heads/js/_website/src/lib/assets/img/header-faded.jpg")) demo.launch()

描述

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

行为

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

您的函数应接受其中一种类型
def predict(
	value: tuple[
    str | PIL.Image.Image | np.ndarray | None, str | PIL.Image.Image | np.ndarray | None
]
)
	...

作为输出组件: 预期返回一个numpy.array、PIL.Image、str或pathlib.Path图像文件路径的元组，该图像将被显示。

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

初始化

参数
🔗 
value: image_tuple | Callable | None
默认值 = None

一个PIL Image、numpy数组、路径或URL的元组，用于ImageSlider组件的默认值，这对图像应具有相同的大小。如果提供了函数，每次应用加载时都会调用该函数以设置此组件的初始值。

🔗 
format: str
默认值 = "webp"

文件格式（例如“png”或“gif”）。用于保存图像，如果它尚不具有有效格式（例如，如果图像以numpy数组或PIL Image形式返回到前端）。该格式应受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”）。

🔗 
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 | 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适用于行，以及在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 中，跨重新渲染具有相同键的组件被视为同一组件，而不是新组件。'preserved_by_key' 中设置的属性不会在重新渲染时重置。

🔗 
preserved_by_key: list[str] | str | None
默认值 = "value"

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

🔗 
show_fullscreen_button: bool
默认值 = True

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

🔗 
slider_position: float
默认值 = 50

滑块位置，以图像宽度的百分比表示，介于0和100之间。

🔗 
max_height: int
默认值 = 500

图像的最大高度。

快捷方式

类 接口字符串快捷方式 初始化

gradio.ImageSlider

"imageslider"

 使用默认值

演示

import gradio as gr
from PIL import ImageFilter


def img_to_slider(im):
    if not im:
        return im
    return (im, im.filter(filter=ImageFilter.GaussianBlur(radius=10)))


def slider_to_self(im):
    if not im or not im[0]:
        return im
    return (im[0], im[0].filter(filter=ImageFilter.GaussianBlur(radius=10)))


def slider_to_self_two(im):
    return im


def position_to_slider(pos):
    return gr.ImageSlider(slider_position=pos)


with gr.Blocks() as demo:
    gr.Markdown("## img to image slider")
    with gr.Row():
        img1 = gr.Image(label="Blur image", type="pil")
        img2 = gr.ImageSlider(label="Blur image", type="pil")
    btn = gr.Button("Blur image")
    btn.click(img_to_slider, inputs=img1, outputs=img2)
    gr.Markdown("## unified image slider")
    with gr.Row():
        img3 = gr.ImageSlider(label="Blur image", type="pil")
        img3.upload(slider_to_self, inputs=img3, outputs=img3)
    pos = gr.Slider(label="Position", value=50, minimum=0, maximum=100, step=0.01)
    pos.change(position_to_slider, inputs=pos, outputs=img3, show_progress="hidden")

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

事件监听器

描述

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

支持的事件监听器

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

监听器 描述

ImageSlider.clear(fn, ···)

当用户使用组件的清除按钮清除ImageSlider时触发此监听器。

ImageSlider.change(fn, ···)

当ImageSlider的值因用户输入（例如用户在文本框中输入）或函数更新（例如图像从事件触发器的输出接收值）而改变时触发。请参阅.input()以了解仅由用户输入触发的监听器。

ImageSlider.stream(fn, ···)

当用户流式传输ImageSlider时触发此监听器。

ImageSlider.select(fn, ···)

当用户选择或取消选择ImageSlider时触发的事件监听器。使用事件数据gradio.SelectData来携带指示ImageSlider标签的value，以及指示ImageSlider状态的selected。有关如何使用此事件数据的详细信息，请参阅EventData文档。

ImageSlider.upload(fn, ···)

当用户上传文件到ImageSlider时触发此监听器。

ImageSlider.input(fn, ···)

当用户更改ImageSlider的值时触发此监听器。

事件参数

参数
🔗 
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

可选的前端js方法，在运行“fn”之前运行。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

此事件监听器的唯一键，用于 @gr.render()。如果设置，此值将标识跨重新渲染的相同事件（当键相同时）。

←

ImageEditor

JSON

→