组件
Markdown

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

LoginButton

Model3D

Markdown

gradio.Markdown(···)

import gradio as gr with gr.Blocks() as demo: with gr.Group(): gr.Markdown(value="This _example_ was **written** in [Markdown](https://en.wikipedia.org/wiki/Markdown)\n") demo.launch()

描述

用于渲染任意 Markdown 输出。也可以渲染由美元符号括起来的 LaTeX。由于此组件不接受用户输入，因此很少用作输入组件。

行为

作为输入组件: 传递对应于显示值的 Markdown `str`。

您的函数应接受以下类型之一

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

作为输出组件: 期望一个可以渲染为 Markdown 的有效 `str`。

您的函数应返回以下类型之一

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

初始化

🔗

value: str | I18nData | Callable | None

默认值 = None

要在 Markdown 组件中显示的值。如果提供了函数，则每次应用程序加载时都会调用该函数以设置此组件的初始值。

🔗

label: str | I18nData | None

默认值 = None

此参数无效

🔗

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

此参数无效。

🔗

rtl: bool

默认值 = False

如果为 True，则将渲染文本的方向设置为从右到左。默认值为 False，即从左到右渲染文本。

🔗

latex_delimiters: list[dict[str, str | bool]] | None

默认值 = None

一个字典列表，形式为 {"left": 开定界符 (str)，"right": 闭定界符 (str)，"display": 是否换行显示 (bool)}，用于渲染 LaTeX 表达式。如果未提供，`latex_delimiters` 将设置为 `[{ "left": "$$", "right": "$$", "display": True }]`，因此只有用 $$ 定界符括起来的表达式才会渲染为 LaTeX，并换行显示。传入空列表以禁用 LaTeX 渲染。更多信息请参阅 KaTeX 文档。

🔗

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

🔗

sanitize_html: bool

默认值 = True

如果为 False，将禁用从 markdown 转换时 HTML 的安全过滤。不建议这样做，因为可能导致安全漏洞。

🔗

line_breaks: bool

默认值 = False

如果为 True，将在聊天机器人消息中启用 Github 风格的 Markdown 换行符。如果为 False（默认），则会忽略单个新行。

🔗

header_links: bool

默认值 = False

如果为 True，将自动为标题创建锚点，并在悬停时显示链接图标。

🔗

height: int | str | None

默认值 = None

组件的高度，如果传入数字则以像素为单位，如果传入字符串则以 CSS 单位表示。如果 Markdown 内容超出高度，组件将滚动。

🔗

max_height: int | str | None

默认值 = None

组件的最大高度，如果传入数字则以像素为单位，如果传入字符串则以 CSS 单位表示。如果 Markdown 内容超出高度，组件将滚动。如果 Markdown 内容短于高度，组件将收缩以适应内容。如果 `height` 已设置且小于 `max_height`，则不会有任何效果。

🔗

min_height: int | str | None

默认值 = None

组件的最小高度，如果传入数字则以像素为单位，如果传入字符串则以 CSS 单位表示。如果 Markdown 内容超出高度，组件将展开以适应内容。如果 `height` 已设置且大于 `min_height`，则不会有任何效果。

🔗

show_copy_button: bool

默认值 = False

如果为 True，包含一个复制按钮以复制 Markdown 组件中的文本。默认值为 False。

🔗

container: bool

默认值 = False

如果为 True，Markdown 组件将显示在一个容器中。默认值为 False。

🔗

padding: bool

默认值 = False

如果为 True，Markdown 组件将在所有方向上具有一定的填充（由 `--block-padding` CSS 变量设置）。默认值为 False。

快捷方式

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

演示

import gradio as gr def welcome(name): return f"Welcome to Gradio, {name}!" with gr.Blocks() as demo: gr.Markdown( """ # Hello World! Start typing below to see the output. """) inp = gr.Textbox(placeholder="What is your name?") out = gr.Textbox() inp.change(welcome, inp, out) if __name__ == "__main__": demo.launch()

import gradio as gr

def welcome(name):
    return f"Welcome to Gradio, {name}!"

with gr.Blocks() as demo:
    gr.Markdown(
    """
    # Hello World!
    Start typing below to see the output.
    """)
    inp = gr.Textbox(placeholder="What is your name?")
    out = gr.Textbox()
    inp.change(welcome, inp, out)

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

import pandas as pd import numpy as np import gradio as gr def plot(v, a): g = 9.81 theta = a / 180 * 3.14 tmax = ((2 * v) * np.sin(theta)) / g timemat = tmax * np.linspace(0, 1, 40) x = (v * timemat) * np.cos(theta) y = ((v * timemat) * np.sin(theta)) - ((0.5 * g) * (timemat**2)) df = pd.DataFrame({"x": x, "y": y}) return df demo = gr.Blocks() with demo: gr.Markdown( r"Let's do some kinematics! Choose the speed and angle to see the trajectory. Remember that the range $R = v_0^2 \cdot \frac{\sin(2\theta)}{g}$" ) with gr.Row(): speed = gr.Slider(1, 30, 25, label="Speed") angle = gr.Slider(0, 90, 45, label="Angle") output = gr.LinePlot( x="x", y="y", overlay_point=True, tooltip=["x", "y"], x_lim=[0, 100], y_lim=[0, 60], width=350, height=300, ) btn = gr.Button(value="Run") btn.click(plot, [speed, angle], output) if __name__ == "__main__": demo.launch()

import pandas as pd
import numpy as np

import gradio as gr

def plot(v, a):
    g = 9.81
    theta = a / 180 * 3.14
    tmax = ((2 * v) * np.sin(theta)) / g
    timemat = tmax * np.linspace(0, 1, 40)

    x = (v * timemat) * np.cos(theta)
    y = ((v * timemat) * np.sin(theta)) - ((0.5 * g) * (timemat**2))
    df = pd.DataFrame({"x": x, "y": y})
    return df

demo = gr.Blocks()

with demo:
    gr.Markdown(
        r"Let's do some kinematics! Choose the speed and angle to see the trajectory. Remember that the range $R = v_0^2 \cdot \frac{\sin(2\theta)}{g}$"
    )

    with gr.Row():
        speed = gr.Slider(1, 30, 25, label="Speed")
        angle = gr.Slider(0, 90, 45, label="Angle")
    output = gr.LinePlot(
        x="x",
        y="y",
        overlay_point=True,
        tooltip=["x", "y"],
        x_lim=[0, 100],
        y_lim=[0, 60],
        width=350,
        height=300,
    )
    btn = gr.Button(value="Run")
    btn.click(plot, [speed, angle], output)

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

事件监听器

描述

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

支持的事件监听器

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

监听器	描述
`Markdown.change(fn, ···)`	当 Markdown 的值因用户输入（例如用户在文本框中输入）或函数更新（例如图像从事件触发器的输出接收值）而更改时触发。有关仅由用户输入触发的监听器，请参阅 `.input()`。
`Markdown.copy(fn, ···)`	当用户从 Markdown 复制内容时触发此监听器。使用事件数据 gradio.CopyData 携带有关复制内容的信息。有关如何使用此事件数据，请参阅 EventData 文档。

事件参数

🔗

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

←

LoginButton

Model3D

→

Markdown

描述

用于渲染任意 Markdown 输出。也可以渲染由美元符号括起来的 LaTeX。由于此组件不接受用户输入，因此很少用作输入组件。

行为

作为输入组件: 传递对应于显示值的 Markdown str。

您的函数应接受以下类型之一

作为输出组件: 期望一个可以渲染为 Markdown 的有效 str。

您的函数应返回以下类型之一

初始化

快捷方式

演示

事件监听器

描述

支持的事件监听器

事件参数

作为输入组件: 传递对应于显示值的 Markdown `str`。

作为输出组件: 期望一个可以渲染为 Markdown 的有效 `str`。