组件
滑块

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

默认值 = 0

滑块的最小值。

🔗

maximum: float

默认值 = 100

滑块的最大值。

🔗

value: float | Callable | None

默认值 = None

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

🔗

step: float | None

默认值 = None

滑块值之间的增量。

🔗

label: str | I18nData | None

默认值 = None

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

🔗

info: str | I18nData | None

默认值 = None

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

🔗

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，则显示标签。

🔗

container: bool

默认值 = True

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

🔗

scale: int | None

默认值 = None

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

🔗

min_width: int

默认值 = 160

最小像素宽度，如果屏幕空间不足以满足此值，则会换行。如果某个 scale 值导致此组件的宽度小于 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() 函数中，如果组件以相同的键重新渲染，则这些（且仅这些）参数将在 UI 中保留（如果它们已被用户或事件监听器更改），而不是根据构造函数期间提供的值重新渲染。

🔗

randomize: bool

默认值 = False

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

🔗

show_reset_button: bool

默认值 = True

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

快捷方式

类	接口字符串快捷方式	初始化
`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, ···)`	当 Slider 的值因用户输入（例如用户在文本框中输入）或函数更新（例如图像从事件触发器的输出接收值）而改变时触发。有关仅由用户输入触发的监听器，请参阅 `.input()`。
`Slider.input(fn, ···)`	当用户更改 Slider 的值时触发此监听器。
`Slider.release(fn, ···)`	当用户在此 Slider 上释放鼠标时触发此监听器。

事件参数

🔗

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

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

指南

使用 GAN 创建你自己的朋友

←

SimpleImage

State

→

滑块

描述

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

行为

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

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

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

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

初始化

快捷方式

演示

事件监听器

描述

支持的事件监听器

事件参数

指南

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

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

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