组件
数字

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

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

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

🔗

precision: int | None

default = None

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

🔗

minimum: float | None

default = None

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

🔗

maximum: float | None

default = None

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

🔗

step: float

default = 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 组件的交互。当用户与元素交互时，例如更改滑块值或上传图像，将调用一个函数。

支持的事件监听器

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

监听器	描述
`Number.change(fn, ···)`	当 Number 的值因用户输入（例如，用户在文本框中键入）或函数更新（例如，图像接收来自事件触发器的输出值）而更改时触发。有关仅由用户输入触发的侦听器，请参见 `.input()`。
`Number.input(fn, ···)`	当用户更改 Number 的值时，将触发此侦听器。
`Number.submit(fn, ···)`	当用户在 Number 获得焦点时按下 Enter 键时，将触发此侦听器。
`Number.focus(fn, ···)`	当 Number 获得焦点时，将触发此侦听器。

事件参数

🔗

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”以使用默认并发限制（由 `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。

🔗