组件
滑块

初次使用 Gradio？从这里开始：开始使用

SimpleImage

State

滑块

gradio.Slider(···)

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

描述

创建一个滑块，范围从 `minimum` 到 `maximum`，步长为 `step`。

行为

作为输入组件: 将滑块值作为 `float` 传递到函数中。

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

def predict(
	value: float
)
	...

作为输出组件: 期望从函数返回一个 `int` 或 `float`，并将滑块值设置为该值，只要它在范围内（否则，设置为最小值）。

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

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

初始化

🔗

minimum: float

default = 0

滑块的最小值。

🔗

maximum: float

default = 100

滑块的最大值。

🔗

value: float | Callable | None

default = None

滑块的默认值。如果提供了函数，则每次应用加载时都会调用该函数以设置此组件的初始值。如果 randomized=True，则忽略。

🔗

step: float | None

default = None

滑块值之间的增量。

🔗

label: str | None

default = None

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

🔗

info: str | None

default = None

额外的组件描述，以较小的字体显示在标签下方。支持 markdown / HTML 语法。

🔗

every: Timer | float | None

default = None

如果 `value` 是一个函数，则持续调用 `value` 以重新计算它（否则无效）。可以提供一个 Timer，其刻度重置 `value`，或者提供重置 Timer 的常规间隔的浮点数。

🔗

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

default = None

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

🔗

show_label: bool | None

default = None

如果为 True，将显示标签。

🔗

container: bool

default = True

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

🔗

scale: int | None

default = None

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

🔗

min_width: int

default = 160

最小像素宽度，如果没有足够的屏幕空间来满足此值，则将换行。如果某个 scale 值导致此组件比 min_width 窄，则将首先遵守 min_width 参数。

🔗

interactive: bool | None

default = None

如果为 True，滑块将是可调整的；如果为 False，则将禁用调整。如果未提供，则根据组件是否用作输入或输出来推断。

🔗

visible: 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

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

🔗

randomize: bool

default = False

如果为 True，则应用加载时滑块的值是从最小值和最大值给定的范围中均匀随机选取的。

🔗

show_reset_button: bool

default = True

如果为 False，将隐藏用于将滑块重置为默认值的按钮。

快捷方式

类	Interface 字符串快捷方式	初始化
`gradio.Slider`	"slider"	使用默认值

演示

import gradio as gr def sentence_builder(quantity, animal, countries, place, activity_list, morning): return f"""The {quantity} {animal}s from {" and ".join(countries)} went to the {place} where they {" and ".join(activity_list)} until the {"morning" if morning else "night"}""" demo = gr.Interface( sentence_builder, [ gr.Slider(2, 20, value=4, label="Count", info="Choose between 2 and 20"), gr.Dropdown( ["cat", "dog", "bird"], label="Animal", info="Will add more animals later!" ), gr.CheckboxGroup(["USA", "Japan", "Pakistan"], label="Countries", info="Where are they from?"), gr.Radio(["park", "zoo", "road"], label="Location", info="Where did they go?"), gr.Dropdown( ["ran", "swam", "ate", "slept"], value=["swam", "slept"], multiselect=True, label="Activity", info="Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed auctor, nisl eget ultricies aliquam, nunc nisl aliquet nunc, eget aliquam nisl nunc vel nisl." ), gr.Checkbox(label="Morning", info="Did they do it in the morning?"), ], "text", examples=[ [2, "cat", ["Japan", "Pakistan"], "park", ["ate", "swam"], True], [4, "dog", ["Japan"], "zoo", ["ate", "swam"], False], [10, "bird", ["USA", "Pakistan"], "road", ["ran"], False], [8, "cat", ["Pakistan"], "zoo", ["ate"], True], ] ) if __name__ == "__main__": demo.launch()

import gradio as gr

def sentence_builder(quantity, animal, countries, place, activity_list, morning):
    return f"""The {quantity} {animal}s from {" and ".join(countries)} went to the {place} where they {" and ".join(activity_list)} until the {"morning" if morning else "night"}"""

demo = gr.Interface(
    sentence_builder,
    [
        gr.Slider(2, 20, value=4, label="Count", info="Choose between 2 and 20"),
        gr.Dropdown(
            ["cat", "dog", "bird"], label="Animal", info="Will add more animals later!"
        ),
        gr.CheckboxGroup(["USA", "Japan", "Pakistan"], label="Countries", info="Where are they from?"),
        gr.Radio(["park", "zoo", "road"], label="Location", info="Where did they go?"),
        gr.Dropdown(
            ["ran", "swam", "ate", "slept"], value=["swam", "slept"], multiselect=True, label="Activity", info="Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed auctor, nisl eget ultricies aliquam, nunc nisl aliquet nunc, eget aliquam nisl nunc vel nisl."
        ),
        gr.Checkbox(label="Morning", info="Did they do it in the morning?"),
    ],
    "text",
    examples=[
        [2, "cat", ["Japan", "Pakistan"], "park", ["ate", "swam"], True],
        [4, "dog", ["Japan"], "zoo", ["ate", "swam"], False],
        [10, "bird", ["USA", "Pakistan"], "road", ["ran"], False],
        [8, "cat", ["Pakistan"], "zoo", ["ate"], True],
    ]
)

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

import gradio as gr def identity(x, state): state += 1 return x, state, state with gr.Blocks() as demo: slider = gr.Slider(0, 100, step=0.1) state = gr.State(value=0) with gr.Row(): number = gr.Number(label="On release") number2 = gr.Number(label="Number of events fired") slider.release(identity, inputs=[slider, state], outputs=[number, state, number2], api_name="predict") if __name__ == "__main__": print("here") demo.launch() print(demo.server_port)

import gradio as gr

def identity(x, state):
    state += 1
    return x, state, state

with gr.Blocks() as demo:
    slider = gr.Slider(0, 100, step=0.1)
    state = gr.State(value=0)
    with gr.Row():
        number = gr.Number(label="On release")
        number2 = gr.Number(label="Number of events fired")
    slider.release(identity, inputs=[slider, state], outputs=[number, state, number2], api_name="predict")

if __name__ == "__main__":
    print("here")
    demo.launch()
    print(demo.server_port)

import gradio as gr def func(slider_1, slider_2, *args): return slider_1 + slider_2 * 5 demo = gr.Interface( func, [ gr.Slider(minimum=1.5, maximum=250000.89, randomize=True, label="Random Big Range"), gr.Slider(minimum=-1, maximum=1, randomize=True, step=0.05, label="Random only multiple of 0.05 allowed"), gr.Slider(minimum=0, maximum=1, randomize=True, step=0.25, label="Random only multiples of 0.25 allowed"), gr.Slider(minimum=-100, maximum=100, randomize=True, step=3, label="Random between -100 and 100 step 3"), gr.Slider(minimum=-100, maximum=100, randomize=True, label="Random between -100 and 100"), gr.Slider(value=0.25, minimum=5, maximum=30, step=-1), ], "number", ) if __name__ == "__main__": demo.launch()

import gradio as gr

def func(slider_1, slider_2, *args):
    return slider_1 + slider_2 * 5

demo = gr.Interface(
    func,
    [
        gr.Slider(minimum=1.5, maximum=250000.89, randomize=True, label="Random Big Range"),
        gr.Slider(minimum=-1, maximum=1, randomize=True, step=0.05, label="Random only multiple of 0.05 allowed"),
        gr.Slider(minimum=0, maximum=1, randomize=True, step=0.25, label="Random only multiples of 0.25 allowed"),
        gr.Slider(minimum=-100, maximum=100, randomize=True, step=3, label="Random between -100 and 100 step 3"),
        gr.Slider(minimum=-100, maximum=100, randomize=True, label="Random between -100 and 100"),
        gr.Slider(value=0.25, minimum=5, maximum=30, step=-1),
    ],
    "number",
)

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

import gradio as gr def func(slider_1, slider_2): return slider_1 * 5 + slider_2 with gr.Blocks() as demo: slider = gr.Slider(minimum=-10.2, maximum=15, label="Random Slider (Static)", randomize=True) slider_1 = gr.Slider(minimum=100, maximum=200, label="Random Slider (Input 1)", randomize=True) slider_2 = gr.Slider(minimum=10, maximum=23.2, label="Random Slider (Input 2)", randomize=True) slider_3 = gr.Slider(value=3, label="Non random slider") btn = gr.Button("Run") btn.click(func, inputs=[slider_1, slider_2], outputs=gr.Number()) if __name__ == "__main__": demo.launch()


import gradio as gr

def func(slider_1, slider_2):
    return slider_1 * 5 + slider_2

with gr.Blocks() as demo:
    slider = gr.Slider(minimum=-10.2, maximum=15, label="Random Slider (Static)", randomize=True)
    slider_1 = gr.Slider(minimum=100, maximum=200, label="Random Slider (Input 1)", randomize=True)
    slider_2 = gr.Slider(minimum=10, maximum=23.2, label="Random Slider (Input 2)", randomize=True)
    slider_3 = gr.Slider(value=3, label="Non random slider")
    btn = gr.Button("Run")
    btn.click(func, inputs=[slider_1, slider_2], outputs=gr.Number())

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

事件侦听器

描述

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

支持的事件侦听器

Slider 组件支持以下事件侦听器。每个事件侦听器都采用相同的参数，这些参数在下面的事件参数表中列出。

侦听器	描述
`Slider.change(fn, ···)`	当滑块的值因用户输入（例如，用户在文本框中键入）或因函数更新（例如，图像接收来自事件触发器输出的值）而更改时触发。有关仅由用户输入触发的侦听器，请参阅 `.input()`。
`Slider.input(fn, ···)`	当用户更改滑块的值时，将触发此侦听器。
`Slider.release(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" 以使用默认的 concurrency limit（由 `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

指南

使用 Gan 创建你自己的朋友

←

SimpleImage

State

→

滑块

描述

创建一个滑块，范围从 minimum 到 maximum，步长为 step。

行为

作为输入组件: 将滑块值作为 float 传递到函数中。

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

作为输出组件: 期望从函数返回一个 int 或 float，并将滑块值设置为该值，只要它在范围内（否则，设置为最小值）。

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

初始化

快捷方式

演示

事件侦听器

描述

支持的事件侦听器

事件参数

指南

创建一个滑块，范围从 `minimum` 到 `maximum`，步长为 `step`。

作为输入组件: 将滑块值作为 `float` 传递到函数中。

作为输出组件: 期望从函数返回一个 `int` 或 `float`，并将滑块值设置为该值，只要它在范围内（否则，设置为最小值）。