全网最详细Gradio教程系列2——Gradio的安装与运行

龙焰智能

已于 2025-02-06 15:28:46 修改

阅读量1.2w

点赞数 36

分类专栏： Gradio全解教程文章标签： Gradio 安装运行热重载

于 2024-06-28 17:52:04 首次发布

本文链接：https://blog.csdn.net/shao918516/article/details/140050236

版权

Gradio全解教程专栏收录该内容

18 篇文章 ¥49.90 ¥99.00

订阅专栏

超级会员免费看

全网最详细Gradio教程系列2——Gradio的安装与运行

前言
实战导论：
2. Gradio的安装与运行
参考文献

前言

本系列文章主要介绍WEB界面工具Gradio。Gradio是Hugging Face发布的简易webui开发框架，它基于FastAPI和svelte，便于部署人工智能模型，是当前热门的非常易于开发和展示机器学习大语言模型LLM及扩散模型DM的UI框架。本系列文章分为前置概念和实战演练两部分。前置概念先介绍Gradio的详细技术架构、历史、应用场景、与其他框架Gradio/NiceGui/StreamLit/Dash/PyWebIO的区别，然后详细介绍了大模型及数据的资源网站Hugging Face，包括三种资源models/datasets/spaces、六类开源库transformers/diffusers/datasets/PEFT/accelerate/optimum实战。实战演练部分先讲解了多种不同的安装、运行和部署方式，安装包括Linux/Win/Mac三类系统安装，运行包括普通方式和热重载方式，部署包括本地部署、HuggingFace托管、FastAPI挂载和Gradio-Lite浏览器集成；然后按照先整体再细节的逻辑，讲解Gradio的多种高级特性：三种Gradio Clients（python/javascript/curl）、Gradio Tools、Gradio的模块架构和环境变量等，方便读者对Gradio整体把握；最后深入细节，也是本系列文章的核心，先实践基础功能Interface、Blocks和Additional Features，再详解高级功能Chatbots、Data Science And Plots和Streaming。本系列文章注解详细，代码均可运行并附有大量运行截图，方便读者理解，Gradio一定会成为每个技术人员实现奇思妙想的最称手工具。

本系列文章目录如下：

《Gradio全解系列1——Gradio简介》
《Gradio全解系列1——Gradio的安装与运行》
《Gradio全解系列2——Gradio的3+1种部署方式实践》
《Gradio全解系列2——浏览器集成Gradio-Lite》
《Gradio全解系列3——Gradio Client：python客户端》
《Gradio全解系列3——Gradio Client：javascript客户端》
《Gradio全解系列3——Gradio Client：curl客户端》
《Gradio全解系列4——Gradio Tools：将Gradio用于LLM Agents》
《Gradio全解系列5——Gradio库的模块架构和环境变量》
《Gradio全解系列6——Interface：高级抽象界面类（上）》
《Gradio全解系列6——Interface：高级抽象界面类（下）》
《Gradio全解系列7——Blocks：底层区块类（上）》
《Gradio全解系列7——Blocks：底层区块类（下）》
《Gradio全解系列8——Additional Features：附加功能（上）》
《Gradio全解系列8——Additional Features：附加功能（下）》
《Gradio全解系列9——Chatbots：聊天机器人（上）》
《Gradio全解系列9——Chatbots：聊天机器人（下）》
《Gradio全解系列10——Data Science And Plots：数据科学与绘图》
《Gradio全解系列11——Streaming：数据流（上）》
《Gradio全解系列11——Streaming：数据流（下）》

实战导论：

从本章起进入Gradio实战部分，实战内容较多，分多个章节讲解。首先，我们来看一下gradio的安装、运行和部署，着重理解热重载运行技术，然后讲解基本组件Interfaces、Blocks和Components，通常WEB拥有复杂多样的组件，Gradio也不例外，本章挑选一些典型、复杂且常用的组件进行讲解。最后讲解Gradio的高级功能，比如Gradio-Lite、Gradio Client和数据科学的表格化与渲染操作等。

2. Gradio的安装与运行

本章详细介绍Gradio的安装和运行，其中着重讲解热重载运行技术。

2.1 安装

建议在Python中的虚拟环境安装Gradio，因为特定虚拟环境可以指定特定版本Python，同时和其他虚拟环境隔离，避免与其他Python项目冲突。当不同的项目需要同一库的不同版本时，这一点尤其有用。它还简化了依赖关系管理并增强了可重复性，方便与他人共享。

本篇示例均运行在Jupyter Notebook，所以除了Gradio，还需要在虚拟环境中安装Jupyter Notebook。

2.1.1 Windows安装Gradio

在Windows的虚拟环境中安装Gradio，分步如下：

安装Python：从python官网下载安装即可。需要Python 3.8或更高版本，推荐使用最新版本。使用命令python --version或python3 --version查看版本。
创建虚拟环境：打开命令行并切换到指定的项目目录，执行以下命令创建虚拟环境：

python -m venv gradio-env

激活虚拟环境：

.\gradio-env\Scripts\activate

安装Gradio：在虚拟环境中安装Gradio，命令如下

pip install gradio

为了更快安装，可以使用清华镜像源。同时为保证安装最新版，加入参数upgrade，如下：

pip install -i https://pypi.tuna.tsinghua.edu.cn/simple --upgrade gradio

验证：运行python并输入：

import gradio as gr
print(gr.__version__)    #当前最新版本5.12.0

2.1.2 MacOS/Linux安装Gradio

在MacOS/Linux安装Gradio与Windows下类似，在激活部分有所不同，分步如下：

安装Python。一般MacOS/Linux会预装Python，只需python --verison/python3 --version验证版本即可。
创建虚拟环境：打开终端并切换到项目目录，执行以下命令创建虚拟环境：

python -m venv gradio-env

激活虚拟环境：

source gradio-env/bin/activate

安装Gradio：在虚拟环境中安装Gradio，命令如下

pip install gradio

为了更快安装，可以使用清华镜像源。同时为保证安装最新版，加入参数upgrade，如下：

pip install -i https://pypi.tuna.tsinghua.edu.cn/simple --upgrade gradio

验证：运行python并输入：

import gradio as gr
print(gr.__version__)    #当前最新版本5.12.0

当在anaconda下使用时，同样需要创建虚拟环境并激活：conda create -n gradio-env&conda activate gradio-env，然后使用pip命令安装即可。

2.2 运行

Gradio程序运行方式包括两种：普通方式运行和热重载运行。其中热重载运行又包括命令行式热重载和Notebook热重载，最后讲述如何控制热重载。本小节先用一个例程demo来讲解如何运行gradio。
首先看例程demo，在代码编辑器、Jupyter Notebook、Google Colab或其他任何编写Python的地方编写你的第一个Gradio应用：

import gradio as gr

def greet(name, intensity):
    return "Hello " * intensity + name + "!"

demo = gr.Interface(
    fn=greet,
    inputs=["text", "slider"],
    outputs=["text"],
)

demo.launch()

在上面的代码中，我们定义了一个名为greet的函数，该函数接受一个名为name的文本输入，并返回一个包含问候语的文本输出。然后，我们使用gr.Interface类创建一个新的Gradio界面，并将greet函数作为输入和输出函数传递给它，关于Interface类请参考后续章节。最后，我们调用了launch方法来启动Gradio应用程序。

2.2.1 普通方式运行

可以在Jupyter Notebook或Google Colab中直接运行代码，或者保存在一个名为app.py的文件中，在终端使用命令python app.py运行。简单几行代码，运行截图如下：

在这里插入图片描述
注意：当网络设置不当或开启代理时，可能会出现以下错误提示：

ValueError: Unknown scheme for proxy URL URL('socks://127.0.0.1:7890/')

此时关闭代理或调整网络设置即可。可以使用命令env | grep -i proxy查看代理设置，无输出时代表无代理，相反输出如下：

~$ env | grep -i proxy
no_proxy=localhost,127.0.0.1,::1
https_proxy=http://127.0.0.1:7890/
NO_PROXY=localhost,127.0.0.1,::1
HTTPS_PROXY=http://127.0.0.1:7890/
HTTP_PROXY=http://127.0.0.1:7890/
http_proxy=http://127.0.0.1:7890/
ALL_PROXY=socks://127.0.0.1:7890/
all_proxy=socks://127.0.0.1:7890/

此时需关闭代理，如果关闭代理后还提示，这时需要重启终端或jupyter即可。

2.2.2. 命令行式热重载

当构建Gradio demo时，尤其是在Blocks中，你会发现不断重新运行代码来测试更改很麻烦。为了更快、更方便地编写代码，可以在Python IDE中开发（如VS code、Sublime Text、PyCharm等）并在终端运行Python代码时，通过热重载技术可以立即“重新加载”Gradio应用程序。而在Jupyter Notebooks（或任何类似的环境，如Colab），也可以使用类似的“魔术命令”更快地重新运行单元格。下面将讲述这两种开启热重载的方式：命令行和Notebooks魔术命令。

只需在文件名前键入gradio替换python即可。在上述例子中，在终端输入：gradio app.py，如下所示：

:~/src/jupyter-notebook/hugging-face$ gradio app.py 
Watching: '/home/shoe/src/jupyter-notebook/hugging-face' 
'/home/shoe/src/jupyter-notebook/hugging-face'

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

To create a public link, set `share=True` in `launch()`.
...
httpx.ConnectTimeout: _ssl.c:983: The handshake operation timed out

对于异常提示不用理会，重要部分是Watching…，它表示Gradio正在监视app.py所在的目录文件，此时更改app.py的内容，会重新运行并实时反馈在浏览器上。

✍️ 提示：

不支持launch()参数更改：gradio命令不会检测传递给launch()方法的参数，因为在重载模式下永远不会调用launch()方法，因此在launch()中设置auth或show_error等参数将不会反映在应用程序中。
支持demo重命名：在使用热重载模式时，还需要记住一件重要的事情：Gradio专门在代码中寻找一个名为demo的Blocks/Interface演示，如果演示命名为其他名称，则需要将演示的名称作为代码中的第二个参数传入。比如app.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），需做如下操作：（1）配置python脚本的编码声明，例如：#--coding：cp1252--；（2）确认您的代码编辑器已识别出该编码格式；（3）运行命令如下：gradio app.py --encoding cp1252

2.2.3 Notebook式热重载

如果用Jupyter Notebooks（或Colab Notebooks等）开发代码，Gradio也提供了“魔法命令”来创建并运行Blocks Demo来开启热重载，只需在notebook顶部加载如下命令：

%load_ext gradio

然后，只需在Gradio Demo的开发单元中，在顶部加入“魔法命令”——%%blocks，然后像往常一样编写layout和components即可，如下所示：

%%blocks

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)

✍️ 提示：

代码中不需要lanucn()——Gradio会自动启动；
每次重新运行单元时，Gradio都会在相同的端口上使用相同的底层web服务器重新呈现应用程序。这意味着热重载将比正常重新运行单元格更快地看到更改效果。

运行效果如下图：
在这里插入图片描述

2.2.4 控制热重载

默认情况下，热重载模式将为每一次更改重新运行整个脚本。但在某些情况下，这是不可取的。比如加载机器学习模型可能只发生一次。还有一些使用C或Rust扩展的Python库如numpy和tiktoken，在重新加载时会抛出错误。
在这些情况下，可以将不希望重新运行的代码放在if gr.NO_RELOAD代码块中。下面是一个示例，说明如何在开发过程中使用它只加载一次transformers模型：

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()