组件
单选框

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

Plot

ScatterPlot

单选框

gradio.Radio(···)

import gradio as gr with gr.Blocks() as demo: gr.Radio(choices=["First Choice", "Second Choice", "Third Choice"]) demo.launch()

描述

创建一组（字符串或数字类型）单选按钮，其中只能选择一个。

行为

作为输入组件: 将所选单选按钮的值作为 `str | int | float`，或将其索引作为 `int` 传递给函数，具体取决于 `type`。

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

def predict(
	value: str | int | float | None
)
	...

作为输出组件: 期望一个与待选单选按钮值对应的 `str | int | float`

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

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

初始化

🔗

choices: list[str | int | float | tuple[str, str | int | float]] | None

默认 = None

要选择的字符串或数字选项列表。选项也可以是 (name, value) 元组的形式，其中 name 是单选按钮的显示名称，value 是要传递给函数或由函数返回的值。

🔗

value: str | int | float | Callable | None

默认 = None

默认选中的选项。如果为 None，则默认不选择任何选项。如果提供了函数，则每次应用加载时都会调用该函数以设置此组件的初始值。

🔗

type: Literal['value', 'index']

默认 = "value"

组件返回值的类型。"value" 返回所选选项的字符串，"index" 返回所选选项的索引。

🔗

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 的 scale=2，组件 B 的 scale=1，则 A 的宽度将是 B 的两倍。应为整数。

🔗

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

🔗

preserved_by_key: list[str] | str | None

默认 = "value"

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

🔗

rtl: bool

默认 = False

如果为 True，单选按钮将以从右到左的顺序显示。默认值为 False。

快捷方式

类	界面字符串快捷方式	初始化
`gradio.Radio`	"radio"	使用默认值

演示

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 countries_cities_dict = { "USA": ["New York", "Los Angeles", "Chicago"], "Canada": ["Toronto", "Montreal", "Vancouver"], "Pakistan": ["Karachi", "Lahore", "Islamabad"], } def change_textbox(choice): if choice == "short": return gr.Textbox(lines=2, visible=True), gr.Button(interactive=True) elif choice == "long": return gr.Textbox(lines=8, visible=True, value="Lorem ipsum dolor sit amet"), gr.Button(interactive=True) else: return gr.Textbox(visible=False), gr.Button(interactive=False) with gr.Blocks() as demo: radio = gr.Radio( ["short", "long", "none"], label="What kind of essay would you like to write?" ) text = gr.Textbox(lines=2, interactive=True, show_copy_button=True) with gr.Row(): num = gr.Number(minimum=0, maximum=100, label="input") out = gr.Number(label="output") minimum_slider = gr.Slider(0, 100, 0, label="min") maximum_slider = gr.Slider(0, 100, 100, label="max") submit_btn = gr.Button("Submit", variant="primary") with gr.Row(): country = gr.Dropdown(list(countries_cities_dict.keys()), label="Country") cities = gr.Dropdown([], label="Cities") @country.change(inputs=country, outputs=cities) def update_cities(country): cities = list(countries_cities_dict[country]) return gr.Dropdown(choices=cities, value=cities[0], interactive=True) def reset_bounds(minimum, maximum): return gr.Number(minimum=minimum, maximum=maximum) radio.change(fn=change_textbox, inputs=radio, outputs=[text, submit_btn]) gr.on( [minimum_slider.change, maximum_slider.change], reset_bounds, [minimum_slider, maximum_slider], outputs=num, ) num.submit(lambda x: x, num, out) if __name__ == "__main__": demo.launch()

import gradio as gr

countries_cities_dict = {
    "USA": ["New York", "Los Angeles", "Chicago"],
    "Canada": ["Toronto", "Montreal", "Vancouver"],
    "Pakistan": ["Karachi", "Lahore", "Islamabad"],
}

def change_textbox(choice):
    if choice == "short":
        return gr.Textbox(lines=2, visible=True), gr.Button(interactive=True)
    elif choice == "long":
        return gr.Textbox(lines=8, visible=True, value="Lorem ipsum dolor sit amet"), gr.Button(interactive=True)
    else:
        return gr.Textbox(visible=False), gr.Button(interactive=False)

with gr.Blocks() as demo:
    radio = gr.Radio(
        ["short", "long", "none"], label="What kind of essay would you like to write?"
    )
    text = gr.Textbox(lines=2, interactive=True, show_copy_button=True)

    with gr.Row():
        num = gr.Number(minimum=0, maximum=100, label="input")
        out = gr.Number(label="output")
    minimum_slider = gr.Slider(0, 100, 0, label="min")
    maximum_slider = gr.Slider(0, 100, 100, label="max")
    submit_btn = gr.Button("Submit", variant="primary")

    with gr.Row():
        country = gr.Dropdown(list(countries_cities_dict.keys()), label="Country")
        cities = gr.Dropdown([], label="Cities")
    @country.change(inputs=country, outputs=cities)
    def update_cities(country):
        cities = list(countries_cities_dict[country])
        return gr.Dropdown(choices=cities, value=cities[0], interactive=True)

    def reset_bounds(minimum, maximum):
        return gr.Number(minimum=minimum, maximum=maximum)

    radio.change(fn=change_textbox, inputs=radio, outputs=[text, submit_btn])
    gr.on(
        [minimum_slider.change, maximum_slider.change],
        reset_bounds,
        [minimum_slider, maximum_slider],
        outputs=num,
    )
    num.submit(lambda x: x, num, out)

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

事件监听器

描述

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

支持的事件监听器

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

监听器	描述
`Radio.select(fn, ···)`	当用户选择或取消选择 Radio 时触发的事件监听器。使用事件数据 gradio.SelectData 来携带指代 Radio 标签的 `value` 和指代 Radio 状态的 `selected`。请参阅 EventData 文档了解如何使用此事件数据。
`Radio.change(fn, ···)`	当 Radio 的值发生变化时触发，无论是由于用户输入（例如用户在文本框中输入）还是由于函数更新（例如图像从事件触发器的输出接收值）。有关仅由用户输入触发的监听器，请参阅 `.input()`。
`Radio.input(fn, ···)`	当用户更改 Radio 的值时，此监听器被触发。

事件参数

🔗

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() 中使用的唯一键。如果设置，此值在键相同时，将事件标识为跨重新渲染是相同的。

←

Plot

ScatterPlot

→

单选框

描述

创建一组（字符串或数字类型）单选按钮，其中只能选择一个。

行为

作为输入组件: 将所选单选按钮的值作为 str | int | float，或将其索引作为 int 传递给函数，具体取决于 type。

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

作为输出组件: 期望一个与待选单选按钮值对应的 str | int | float

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

初始化

快捷方式

演示

事件监听器

描述

支持的事件监听器

事件参数

作为输入组件: 将所选单选按钮的值作为 `str | int | float`，或将其索引作为 `int` 传递给函数，具体取决于 `type`。

作为输出组件: 期望一个与待选单选按钮值对应的 `str | int | float`