Gradio Agents & MCP 黑客马拉松

获奖者
Gradio logo
  1. 组件
  2. BarPlot

Gradio 新手?从这里开始: 入门

查看 发布历史

BarPlot

gradio.BarPlot(···)
import gradio as gr import pandas as pd import numpy as np simple = pd.DataFrame(np.array( [ ["A", 28], ["B", 55], ["C", 43], ["D", 91], ["E", 81], ["F", 53], ["G", 19], ["H", 87], ["I", 52], ] ), columns=["item", "inventory"]) with gr.Blocks() as demo: gr.BarPlot( value=simple, x="item", y="inventory", title="Simple Bar Plot", container=True, width=400 ) demo.launch()pandas

描述

创建一个条形图组件,用于显示 pandas DataFrame 中的数据。

行为

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

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

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

您的函数应返回以下类型之一
def predict(···) -> pd.DataFrame | 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 | I18nData | 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 | I18nData | 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 上下文中渲染。如果目的是现在分配事件监听器但稍后渲染组件,则应使用此参数。

🔗
show_fullscreen_button: bool
默认 = False

如果为 True,将显示一个按钮,使图在全屏模式下可见。

🔗
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 中保留(如果它们已被用户或事件监听器更改),而不是根据构造函数中提供的值重新渲染。

快捷方式

接口字符串快捷方式 初始化

gradio.BarPlot

"barplot"

使用默认值

演示

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 bar_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.BarPlot(
        temp_sensor_data,
        x="time",
        y="temperature",
    )
    temp_by_time_location = gr.BarPlot(
        temp_sensor_data,
        x="time",
        y="temperature",
        color="location",
    )

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

    def rescale(select: gr.SelectData):
        return select.index
    rescale_evt = gr.on([plot.select for plot in time_graphs], rescale, None, [start, end])

    for trigger in [apply_btn.click, rescale_evt.then]:
        trigger(
            lambda start, end: [gr.BarPlot(x_lim=[start, end])] * len(time_graphs), [start, end], time_graphs
        )

    with gr.Row():
        price_by_cuisine = gr.BarPlot(
            food_rating_data,
            x="cuisine",
            y="price",
        )
        with gr.Column(scale=0):
            gr.Button("Sort $ > $$$").click(lambda: gr.BarPlot(sort="y"), None, price_by_cuisine)
            gr.Button("Sort $$$ > $").click(lambda: gr.BarPlot(sort="-y"), None, price_by_cuisine)
            gr.Button("Sort A > Z").click(lambda: gr.BarPlot(sort=["Chinese", "Italian", "Mexican"]), None, price_by_cuisine)

    with gr.Row():
        price_by_rating = gr.BarPlot(
            food_rating_data,
            x="rating",
            y="price",
            x_bin=1,
        )
        price_by_rating_color = gr.BarPlot(
            food_rating_data,
            x="rating",
            y="price",
            color="cuisine",
            x_bin=1,
            color_map={"Italian": "red", "Mexican": "green", "Chinese": "blue"},
        )

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

		

事件监听器

描述

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

支持的事件监听器

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

监听器 描述

BarPlot.select(fn, ···)

当用户选择或取消选择 NativePlot 时的事件监听器。使用事件数据 gradio.SelectData 来承载指代 NativePlot 标签的 value 和指代 NativePlot 状态的 selected。有关如何使用此事件数据,请参阅 EventData 文档。

BarPlot.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 表示没有并发限制(此事件可以同时运行任意数量)。设置为“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() 中。如果设置,当键相同时,此值会将事件识别为跨重新渲染是相同的。