Gradio 智能体 & MCP 黑客马拉松
获奖者Gradio 智能体 & MCP 黑客马拉松
获奖者with gradio.Blocks():
import gradio as gr
def update(name):
return f"Welcome to Gradio, {name}!"
with gr.Blocks() as demo:
gr.Markdown("Start typing below and then click **Run** to see the output.")
with gr.Row():
inp = gr.Textbox(placeholder="What is your name?")
out = gr.Textbox()
btn = gr.Button("Run")
btn.click(fn=update, inputs=inp, outputs=out)
demo.launch()
theme: Theme | str | None
= None
主题对象或表示主题的字符串。如果是一个字符串,将查找具有该名称的内置主题(例如“soft”或“default”),或者将尝试从 Hugging Face Hub 加载主题(例如“gradio/monochrome”)。如果为 None,将使用默认主题。
analytics_enabled: bool | None
= None
是否允许基本遥测。如果为 None,将使用 GRADIO_ANALYTICS_ENABLED 环境变量或默认为 True。
css_paths: str | Path | list[str | Path] | None
= None
作为 CSS 文件的 pathlib.Path 或此类路径列表的自定义 CSS。这些 CSS 文件将被读取、连接并包含在演示网页中。如果还设置了 `css` 参数,则 `css` 中的 CSS 将首先包含。
js: str | Literal[True] | None
= None
作为代码字符串的自定义 JS。自定义 JS 应为单个 JS 函数的形式。此函数将在页面加载时自动执行。为了更大的灵活性,请使用 head 参数在 <script> 标签内插入 JS。
head_paths: str | Path | list[str | Path] | None
= None
作为 HTML 文件的 pathlib.Path 或此类路径列表的自定义 HTML 代码。这些 HTML 文件将被读取、连接并包含在演示网页的头部。如果还设置了 `head` 参数,则 `head` 中的 HTML 将首先包含。
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()
gradio.Blocks.launch(···)
启动一个简单的 Web 服务器来提供演示。也可以通过设置 share=True 来创建公共链接,供任何人通过浏览器访问演示。
import gradio as gr
def reverse(text):
return text[::-1]
with gr.Blocks() as demo:
button = gr.Button(value="Reverse")
button.click(reverse, gr.Textbox(), gr.Textbox())
demo.launch(share=True, auth=("username", "password"))
auth: Callable[[str, str], bool] | tuple[str, str] | list[tuple[str, str]] | None
= None
如果提供,访问应用程序所需的用户名和密码(或用户名-密码元组列表)。也可以提供一个函数,该函数接受用户名和密码并在有效登录时返回 True。
prevent_thread_lock: bool
= False
默认情况下,Gradio 应用程序在服务器运行时会阻塞主线程。如果设置为 True,Gradio 应用程序将不会阻塞,并且 Gradio 服务器将在脚本完成后立即终止。
show_error: bool
= False
如果为 True,Gradio 应用程序中的任何错误都将显示在警报模态框中并打印在浏览器控制台日志中。它们也将在 gr.load() 此应用程序的下游应用程序的警报模态框中显示。
server_name: str | None
= None
要在本地网络上访问应用程序,请将其设置为“0.0.0.0”。可以通过环境变量 GRADIO_SERVER_NAME 设置。如果为 None,将使用“127.0.0.1”。
server_port: int | None
= None
将在此端口(如果可用)上启动 Gradio 应用程序。可以通过环境变量 GRADIO_SERVER_PORT 设置。如果为 None,将从 7860 开始搜索可用端口。
allowed_paths: list[str] | None
= None
Gradio 允许提供服务的文件路径或父目录的完整列表。必须是绝对路径。警告:如果提供目录,则这些目录或其子目录中的任何文件都可供应用程序的所有用户访问。可以通过逗号分隔的环境变量 GRADIO_ALLOWED_PATHS 设置。这些文件通常被认为是安全的,并且在可能的情况下将在浏览器中显示。
blocked_paths: list[str] | None
= None
Gradio 不允许提供服务(即应用程序用户不允许访问)的文件路径或父目录的完整列表。必须是绝对路径。警告:此设置优先于 `allowed_paths` 和 Gradio 默认公开的所有其他目录。可以通过逗号分隔的环境变量 GRADIO_BLOCKED_PATHS 设置。
root_path: str | None
= None
应用程序的根路径(或“挂载点”),如果它不是从域的根目录(“/”)提供服务。通常在应用程序位于反向代理之后转发请求到应用程序时使用。例如,如果应用程序在“https://example.com/myapp”提供服务,则 `root_path` 应设置为“/myapp”。可以提供以 http:// 或 https:// 开头的完整 URL,它将作为整个根路径使用。默认为“”。可以通过环境变量 GRADIO_ROOT_PATH 设置。
app_kwargs: dict[str, Any] | None
= None
要作为参数键和参数值字典传递给底层 FastAPI 应用程序的其他关键字参数。例如,`{"docs_url": "/docs"}`
state_session_capacity: int
= 10000
要存储在内存中的会话信息最大数量。如果会话数量超过此数量,最旧的会话将被删除。使用 gradio.State 或从函数返回更新的组件时,请减少容量以减少内存使用。默认为 10000。
auth_dependency: Callable[[fastapi.Request], str | None] | None
= None
一个函数,接受 FastAPI 请求并返回字符串用户 ID 或 None。如果函数对特定请求返回 None,则该用户无权访问应用程序(他们将看到 401 Unauthorized 响应)。用于 OAuth 等外部身份验证系统。不能与 `auth` 一起使用。
max_file_size: str | int | None
= None
可上传的最大文件大小(以字节为单位)。可以是“<value><unit>”形式的字符串,其中 value 是任何正整数,unit 是“b”、“kb”、“mb”、“gb”、“tb”之一。如果为 None,则不设置限制。
enable_monitoring: bool | None
= None
通过 /monitoring 端点启用应用程序的流量监控。默认情况下为 None,这将启用此端点。如果明确设置为 True,还将把监控 URL 打印到控制台。如果为 False,将完全禁用监控。
strict_cors: bool
= True
如果为 True,则阻止外部域向在 localhost 上运行的 Gradio 服务器发出请求。如果为 False,则允许源自 localhost 但也关键是源自“null”的 localhost 请求。此参数通常应为 True 以防止 CSRF 攻击,但在使用 Web 组件嵌入 *本地运行的 Gradio 应用程序* 时可能需要设置为 False。
ssr_mode: bool | None
= None
如果为 True,Gradio 应用程序将使用服务器端渲染模式渲染,该模式通常性能更高并提供更好的 SEO,但这需要在系统上安装 Node 20+。如果为 False,应用程序将使用客户端渲染模式渲染。如果为 None,将使用 GRADIO_SSR_MODE 环境变量或默认为 False。
pwa: bool | None
= None
如果为 True,Gradio 应用程序将被设置为可安装的 PWA (Progressive Web App)。如果设置为 None(默认行为),则此 Gradio 应用程序在 Spaces 上启动时将启用 PWA 功能,否则不启用。
gradio.Blocks.queue(···)
通过启用队列,您可以控制用户何时知道他们在队列中的位置,并设置允许的最大事件数量。
with gr.Blocks() as demo:
button = gr.Button(label="Generate Image")
button.click(fn=image_generator, inputs=gr.Textbox(), outputs=gr.Image())
demo.queue(max_size=10)
demo.launch()
gradio.Blocks.load(block, ···)
当 Blocks 首次在浏览器中加载时,此监听器被触发。
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` 此应用程序的)将无法使用此事件。
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` 长度)。然后,函数 *必须* 返回一个列表元组(即使只有一个输出组件),元组中的每个列表对应一个输出组件。
preprocess: bool
= True
如果为 False,在运行 'fn' 之前将不运行组件数据的预处理(例如,如果此方法与 `Image` 组件一起调用,则将其保留为 base64 字符串)。
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)。