gradio如何实现修改代码后自动重载运行

news2024/10/1 23:32:21

使用自动重载加速开发

前提条件：本指南要求你了解 Blocks。在阅读本指南之前，请确保你已经阅读了Blocks指南。

本指南涵盖自动重载、在Python IDE中的重载，以及在Jupyter Notebooks中使用Gradio。

为什么需要自动重载？

当你使用 Blocks 构建 Gradio 演示时，你可能会发现每次测试更改时都要重新运行代码非常麻烦。

为了让你更快、更方便地编写代码，我们简化了在 Python IDE（如 VS Code、Sublime Text、PyCharm 等）中开发时，快速“重载”Gradio应用的过程。我们还开发了一种类似的“魔法命令”，可以在你使用 Jupyter Notebooks（或类似环境如 Colab）时更快地重新运行单元格。

本指南将涵盖这两种方法，因此无论你如何编写Python代码，学习完本指南后，你都能更快地构建Gradio应用。

Python IDE 重载 🔥

如果你使用Python IDE构建Gradio Blocks，你的代码文件（假设名为 run.py）可能如下所示：

import gradio as gr

with gr.Blocks() as demo:
    gr.Markdown("# Greetings from Gradio!")
    inp = gr.Textbox(placeholder="What is your name?")
    out = gr.Textbox()

    inp.change(fn=lambda x: f"Welcome, {x}!",
               inputs=inp,
               outputs=out)

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

问题是，每次你想更改布局、事件或组件时，都需要关闭并重新运行应用，即使用 python run.py。

你可以通过将 python 改为 gradio，以 重载模式 运行代码来避免这种情况：

在终端中运行 gradio run.py。就是这么简单！

现在，你会看到类似如下的内容：

Watching: '/Users/freddy/sources/gradio/gradio', '/Users/freddy/sources/gradio/demo/'

Running on local URL:  http://127.0.0.1:7860

关键是包含 Watching... 的这一行。Gradio 会观察 run.py 文件所在的目录，如果文件发生更改，它将自动重新运行文件。这样你就可以专注于编写代码，而你的Gradio演示将自动刷新 🥳

提示：gradio 命令无法检测 launch() 方法中传递的参数，因为在重载模式下，launch() 方法不会被调用。例如，设置 auth 或 show_error 将不会在应用中反映出来。

在使用重载模式时，还有一个重要事项：Gradio 会特意寻找代码中名为 demo 的Gradio Blocks/Interface演示。如果你将演示命名为其他名称，则需要将演示名称作为第二个参数传递。因此，如果你的 run.py 文件如下所示：

import gradio as gr

with gr.Blocks() as my_demo:
    gr.Markdown("# Greetings from Gradio!")
    inp = gr.Textbox(placeholder="What is your name?")
    out = gr.Textbox()

    inp.change(fn=lambda x: f"Welcome, {x}!",
               inputs=inp,
               outputs=out)

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

那么你需要像这样启动重载模式：gradio run.py --demo-name=my_demo。

默认情况下，Gradio 对脚本使用 UTF-8 编码。对于重载模式，如果你使用的是 UTF-8 以外的编码格式（如 cp1252），请确保按照以下步骤进行操作：

配置Python脚本的编码声明，例如：# -*- coding: cp1252 -*-
确保你的代码编辑器已识别该编码格式。
以如下方式运行：gradio run.py --encoding cp1252

🔥 如果你的应用程序接受命令行参数，也可以传递它们。例如：

import gradio as gr
import argparse

parser = argparse.ArgumentParser()
parser.add_argument("--name", type=str, default="User")
args, unknown = parser.parse_known_args()

with gr.Blocks() as demo:
    gr.Markdown(f"# Greetings {args.name}!")
    inp = gr.Textbox()
    out = gr.Textbox()

    inp.change(fn=lambda x: x, inputs=inp, outputs=out)

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

可以这样运行：gradio run.py --name Gretel

顺便提一下，如果你更改了 run.py 源代码或 Gradio 源代码，自动重载都会触发。这意味着，如果你决定为Gradio做贡献，这也会很有用 ✅

控制重载 🎛️

默认情况下，重载模式会在每次修改时重新运行整个脚本。但有些情况下这并不可取。例如，加载机器学习模型通常只需执行一次以节省时间。此外，一些使用 C 或 Rust 扩展的Python库（如 numpy 和 tiktoken）在重载时会抛出错误。

在这些情况下，你可以将不希望重新运行的代码放在 if gr.NO_RELOAD: 代码块中。以下是一个示例，展示如何在开发过程中仅加载一次 transformers 模型。

提示：gr.NO_RELOAD 的值为 True。因此，在完成开发并想在生产环境中运行时，你无需更改脚本，只需使用 python 而不是 gradio 运行文件即可。

import gradio as gr

if gr.NO_RELOAD:
    from transformers import pipeline
    pipe = pipeline("text-classification", model="cardiffnlp/twitter-roberta-base-sentiment-latest")

demo = gr.Interface(lambda s: pipe(s), gr.Textbox(), gr.Label())

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

Jupyter Notebook 魔法命令 🔮

如果你在 Jupyter Notebooks（或 Colab Notebooks 等）中开发代码，怎么办？我们也有适合你的工具！

我们开发了一个 魔法命令，可以为你创建并运行 Blocks 演示。要使用它，在笔记本的顶部加载 Gradio 扩展：

%load_ext gradio

然后，在你开发Gradio演示的单元格中，简单地在顶部编写魔法命令 %%blocks，然后像往常一样编写布局和组件：

%%blocks

import gradio as gr

with gr.Blocks() as demo:
    gr.Markdown(f"# Greetings {args.name}!")
    inp = gr.Textbox()
    out = gr.Textbox()

    inp.change(fn=lambda x: x, inputs=inp, outputs=out)