Gradio 用户月活破百万！

阅读更多
Gradio logo
  1. 组件
  2. 散点图

初次使用 Gradio？从这里开始：快速入门

查看发布历史

←

单选框

侧边栏

→

散点图

gradio.ScatterPlot(···)
import gradio as gr import pandas as pd import numpy as np simple = pd.DataFrame(np.array( [ [1, 23, "USA", "Ford Mustang"], [2, 40, "USA", "Chrysler New Yorker Brougham"], [3, 32, "Japan", "Toyota Corolla"], [4, 32, "Europe", "Mercedes Benz"], [5, 15, "USA", "AMC Matador"], [6, 35, "Europe", "BMW X5"], [7, 28, "Japan", "Honda Civic"], [8, 15, "Japan", "Honda Accord"], [9, 41, "Europe", "Peugeot 208"], ] ), columns=["Age", "Miles Per Gallon", "Origin of Car", "Name"]) with gr.Blocks() as demo: gr.ScatterPlot( value=simple, x="Age", y="Miles Per Gallon", title="Car Data", container=True, width=400, color="Origin of Car", tooltip="Name" ) demo.launch()pandas numpy

描述

创建一个散点图组件以显示来自 pandas DataFrame 的数据。

行为

作为输入组件: 要在线图中显示的数据。

你的函数应该接受以下类型之一
def predict(
	value: AltairPlotData | None
)
	...

作为输出组件: 期望一个 pandas DataFrame，其中包含要在折线图中显示的数据。DataFrame 应至少包含两列，一列用于 x 轴（对应于此组件的 x 参数），一列用于 y 轴（对应于 y）。

你的函数应该返回以下类型之一
def predict(···) -> pd.DataFrame | dict | None
	...	
	return value

初始化

参数
🔗 
value: pd.DataFrame | Callable | None
默认值 = None

包含要在图中显示的数据的 pandas dataframe。

🔗 
x: str | None
默认值 = None

对应于 x 轴的列。列可以是数值、日期时间或字符串/类别。

🔗 
y: str | None
默认值 = None

对应于 y 轴的列。列必须是数值。

🔗 
color: str | None
默认值 = None

对应于系列的列，通过颜色可视化。列必须是字符串/类别。

🔗 
title: str | None
默认值 = None

要在图表顶部显示的标题。

🔗 
x_title: str | None
默认值 = None

给予 x 轴的标题。默认情况下，使用 x 参数的值。

🔗 
y_title: str | None
默认值 = None

给予 y 轴的标题。默认情况下，使用 y 参数的值。

🔗 
color_title: str | None
默认值 = None

给予颜色图例的标题。默认情况下，使用 color 参数的值。

🔗 
x_bin: str | float | None
默认值 = None

用于聚类 x 值的分组。如果 x 列是数值，则应为数字以对 x 值进行分箱。如果 x 列是日期时间，则应为字符串，例如 "1h"、"15m"、"10s"，使用 "s"、"m"、"h"、"d" 后缀。

🔗 
y_aggregate: Literal['sum', 'mean', 'median', 'min', 'max', 'count'] | None
默认值 = None

用于聚合 y 值的聚合函数，如果提供了 x_bin 或 x 是字符串/类别，则使用。必须是 "sum"、"mean"、"median"、"min"、"max" 之一。

🔗 
color_map: dict[str, str] | None
默认值 = None

系列到颜色名称或代码的映射。例如，{"success": "green", "fail": "#FF8888"}。

🔗 
x_lim: list[float] | None
默认值 = None

包含 x 轴限制的元组或列表，指定为 [x_min, x_max]。如果 x 列是日期时间类型，则 x_lim 应为时间戳。

🔗 
y_lim: list[float] | None
默认值 = None

包含 y 轴限制的元组或列表，指定为 [y_min, y_max]。

🔗 
x_label_angle: float
默认值 = 0

x 轴标签的角度，以度为单位顺时针偏移。

🔗 
y_label_angle: float
默认值 = 0

y 轴标签的角度，以度为单位顺时针偏移。

🔗 
x_axis_labels_visible: bool
默认值 = True

x 轴标签是否应该可见。当存在许多 x 轴标签时可以隐藏。

🔗 
caption: str | None
默认值 = None

要在图表下方显示的（可选）标题。

🔗 
sort: Literal['x', 'y', '-x', '-y'] | list[str] | None
默认值 = None

x 值的排序顺序，如果 x 列是字符串/类别类型。可以是 "x"、"y"、"-x"、"-y"，或表示类别顺序的字符串列表。

🔗 
tooltip: Literal['axis', 'none', 'all'] | list[str]
默认值 = "axis"

悬停在点上时显示的工具提示。"axis" 显示轴列的值，"all" 显示所有列值，"none" 显示无工具提示。也可以提供表示要在工具提示中显示的列的字符串列表，这些列将与轴值一起显示。

🔗 
height: int | None
默认值 = None

图表的高度，以像素为单位。

🔗 
label: str | None
默认值 = None

要在图表左上角显示的（可选）标签。

🔗 
show_label: bool | None
默认值 = None

是否应显示标签。

🔗 
container: bool
默认值 = True

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

🔗 
scale: int | None
默认值 = None

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

🔗 
min_width: int
默认值 = 160

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

🔗 
every: Timer | float | None
默认值 = None

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

🔗 
inputs: Component | list[Component] | Set[Component] | None
默认值 = None

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

🔗 
visible: bool
默认值 = True

图表是否应该可见。

🔗 
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 | None
默认值 = None

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

快捷方式

类 界面字符串快捷方式 初始化

gradio.ScatterPlot

"scatterplot"

 使用默认值

演示

import pandas as pd
from random import randint, random
import gradio as gr


temp_sensor_data = pd.DataFrame(
    {
        "time": pd.date_range("2021-01-01", end="2021-01-05", periods=200),
        "temperature": [randint(50 + 10 * (i % 2), 65 + 15 * (i % 2)) for i in range(200)],
        "humidity": [randint(50 + 10 * (i % 2), 65 + 15 * (i % 2)) for i in range(200)],
        "location": ["indoor", "outdoor"] * 100,
    }
)

food_rating_data = pd.DataFrame(
    {
        "cuisine": [["Italian", "Mexican", "Chinese"][i % 3] for i in range(100)],
        "rating": [random() * 4 + 0.5 * (i % 3) for i in range(100)],
        "price": [randint(10, 50) + 4 * (i % 3) for i in range(100)],
        "wait": [random() for i in range(100)],
    }
)

with gr.Blocks() as scatter_plots:
    with gr.Row():
        start = gr.DateTime("2021-01-01 00:00:00", label="Start")
        end = gr.DateTime("2021-01-05 00:00:00", label="End")
        apply_btn = gr.Button("Apply", scale=0)
    with gr.Row():
        group_by = gr.Radio(["None", "30m", "1h", "4h", "1d"], value="None", label="Group by")
        aggregate = gr.Radio(["sum", "mean", "median", "min", "max"], value="sum", label="Aggregation")

    temp_by_time = gr.ScatterPlot(
        temp_sensor_data,
        x="time",
        y="temperature",
    )
    temp_by_time_location = gr.ScatterPlot(
        temp_sensor_data,
        x="time",
        y="temperature",
        color="location",
    )

    time_graphs = [temp_by_time, temp_by_time_location]
    group_by.change(
        lambda group: [gr.ScatterPlot(x_bin=None if group == "None" else group)] * len(time_graphs),
        group_by,
        time_graphs
    )
    aggregate.change(
        lambda aggregate: [gr.ScatterPlot(y_aggregate=aggregate)] * len(time_graphs),
        aggregate,
        time_graphs
    )

    price_by_cuisine = gr.ScatterPlot(
        food_rating_data,
        x="cuisine",
        y="price",
    )
    with gr.Row():
        price_by_rating = gr.ScatterPlot(
            food_rating_data,
            x="rating",
            y="price",
            color="wait",
            show_actions_button=True,
        )
        price_by_rating_color = gr.ScatterPlot(
            food_rating_data,
            x="rating",
            y="price",
            color="cuisine",
        )

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

事件监听器

描述

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

支持的事件监听器

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

监听器 描述

ScatterPlot.select(fn, ···)

用户选择或取消选择 NativePlot 时的事件侦听器。使用事件数据 gradio.SelectData 来传递 value，该 value 指的是 NativePlot 的标签，selected 指的是 NativePlot 的状态。请参阅 EventData 文档，了解如何使用此事件数据

ScatterPlot.double_click(fn, ···)

当 NativePlot 被双击时触发。

事件参数

参数
🔗 
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，表示没有 concurrency_limit（可以同时运行任意数量的此事件）。设置为 "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
←

单选框

侧边栏

→