组件
数字

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

MultimodalTextbox

ParamViewer

数字

gradio.Number(···)

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

描述

创建一个数字输入框，供用户输入数字作为输入或显示数字输出。

行为

作为输入组件: 根据 `precision`，将字段值作为 `float` 或 `int` 传递给函数。

您的函数应接受这些类型之一

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

作为输出组件: 期望函数返回一个 `int` 或 `float`，并将其设置为字段值。

您的函数应返回这些类型之一

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

初始化

🔗

value: float | Callable | 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 适用于 Rows，以及 Blocks 中 fill_height=True 的顶级组件。

🔗

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() 函数中，如果组件使用相同的 key 进行重新渲染，则这些（且仅这些）参数将在 UI 中保留（如果它们已被用户或事件监听器更改），而不是基于构造函数中提供的值重新渲染。

🔗

precision: int | None

默认 = None

输入/输出的舍入精度。如果设置为 0，将四舍五入到最近的整数并转换为 int 类型。如果为 None，不进行舍入。

🔗

minimum: float | None

默认 = None

最小值。仅当组件用作输入时应用。如果用户提供的值小于此值，后端将引发 gr.Error 异常。

🔗

maximum: float | None

默认 = None

最大值。仅当组件用作输入时应用。如果用户提供的值大于此值，后端将引发 gr.Error 异常。

🔗

step: float

默认 = 1

组件中允许的数字之间的间隔。可与可选参数 `minimum` 和 `maximum` 一起使用，以创建从 `minimum` 开始并按此参数递增的合法值范围。

快捷方式

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

演示

import gradio as gr def tax_calculator(income, marital_status, assets): tax_brackets = [(10, 0), (25, 8), (60, 12), (120, 20), (250, 30)] total_deductible = sum(assets["Cost"]) taxable_income = income - total_deductible total_tax = 0 for bracket, rate in tax_brackets: if taxable_income > bracket: total_tax += (taxable_income - bracket) * rate / 100 if marital_status == "Married": total_tax *= 0.75 elif marital_status == "Divorced": total_tax *= 0.8 return round(total_tax) demo = gr.Interface( tax_calculator, [ "number", gr.Radio(["Single", "Married", "Divorced"]), gr.Dataframe( headers=["Item", "Cost"], datatype=["str", "number"], label="Assets Purchased this Year", ), ], "number", examples=[ [10000, "Married", [["Suit", 5000], ["Laptop", 800], ["Car", 1800]]], [80000, "Single", [["Suit", 800], ["Watch", 1800], ["Car", 800]]], ], ) demo.launch()

import gradio as gr

def tax_calculator(income, marital_status, assets):
    tax_brackets = [(10, 0), (25, 8), (60, 12), (120, 20), (250, 30)]
    total_deductible = sum(assets["Cost"])
    taxable_income = income - total_deductible

    total_tax = 0
    for bracket, rate in tax_brackets:
        if taxable_income > bracket:
            total_tax += (taxable_income - bracket) * rate / 100

    if marital_status == "Married":
        total_tax *= 0.75
    elif marital_status == "Divorced":
        total_tax *= 0.8

    return round(total_tax)

demo = gr.Interface(
    tax_calculator,
    [
        "number",
        gr.Radio(["Single", "Married", "Divorced"]),
        gr.Dataframe(
            headers=["Item", "Cost"],
            datatype=["str", "number"],
            label="Assets Purchased this Year",
        ),
    ],
    "number",
    examples=[
        [10000, "Married", [["Suit", 5000], ["Laptop", 800], ["Car", 1800]]],
        [80000, "Single", [["Suit", 800], ["Watch", 1800], ["Car", 800]]],
    ],
)

demo.launch()

import gradio as gr demo = gr.Blocks(css="""#btn {color: red} .abc {font-family: "Comic Sans MS", "Comic Sans", cursive !important}""") with demo: default_json = {"a": "a"} num = gr.State(value=0) squared = gr.Number(value=0) btn = gr.Button("Next Square", elem_id="btn", elem_classes=["abc", "def"]) stats = gr.State(value=default_json) table = gr.JSON() def increase(var, stats_history): var += 1 stats_history[str(var)] = var**2 return var, var**2, stats_history, stats_history btn.click(increase, [num, stats], [num, squared, stats, table]) if __name__ == "__main__": demo.launch()

import gradio as gr

demo = gr.Blocks(css="""#btn {color: red} .abc {font-family: "Comic Sans MS", "Comic Sans", cursive !important}""")

with demo:
    default_json = {"a": "a"}

    num = gr.State(value=0)
    squared = gr.Number(value=0)
    btn = gr.Button("Next Square", elem_id="btn", elem_classes=["abc", "def"])

    stats = gr.State(value=default_json)
    table = gr.JSON()

    def increase(var, stats_history):
        var += 1
        stats_history[str(var)] = var**2
        return var, var**2, stats_history, stats_history

    btn.click(increase, [num, stats], [num, squared, stats, table])

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

事件监听器

描述

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

支持的事件监听器

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

监听器	描述
`Number.change(fn, ···)`	当 Number 的值因用户输入（例如用户在文本框中输入）或因函数更新（例如图像从事件触发器的输出接收值）而改变时触发。请参阅 `.input()` 以获取仅由用户输入触发的监听器。
`Number.input(fn, ···)`	当用户更改 Number 的值时触发此监听器。
`Number.submit(fn, ···)`	当用户在 Number 聚焦时按下 Enter 键时触发此监听器。
`Number.focus(fn, ···)`	当 Number 聚焦时触发此监听器。
`Number.blur(fn, ···)`	当 Number 失焦/模糊时触发此监听器。

事件参数

🔗

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 的事件将受最低并发限制设置的限制。

🔗

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() 的此事件监听器的唯一 key。如果设置，当 key 相同时，此值将事件标识为跨重新渲染是相同的。

←

MultimodalTextbox

ParamViewer

→

数字

描述

创建一个数字输入框，供用户输入数字作为输入或显示数字输出。

行为

作为输入组件: 根据 precision，将字段值作为 float 或 int 传递给函数。

您的函数应接受这些类型之一

作为输出组件: 期望函数返回一个 int 或 float，并将其设置为字段值。

您的函数应返回这些类型之一

初始化

快捷方式

演示

事件监听器

描述

支持的事件监听器

事件参数

作为输入组件: 根据 `precision`，将字段值作为 `float` 或 `int` 传递给函数。

作为输出组件: 期望函数返回一个 `int` 或 `float`，并将其设置为字段值。