Python - Gradio 文档使用心得与文档解读

Posted 2023-04-04 DreamingBetter

前言

官方文档
我也是第一天看，第一天用，读文档和使用过程遇到的情况浅浅记录一下，直接进入正题。

创建Interface实例

这是Interface的参数

gradio.Interface(self, fn, inputs=None, outputs=None, examples=None, examples_per_page=10, live=False, layout="unaligned", 
interpretation=None, num_shap=2.0, theme=None, title=None, description=None, article=None, thumbnail=None, css=None, 
allow_flagging=None, flagging_options=None, flagging_dir="flagged")

这么一大坨参数看着也头晕，我们挑几个（对于我自身使用而言）较为常用参数来看：
（最主要三个参数即可创建实例，fn、inputs、outputs）

gradio.Interface(self, fn, inputs=None, outputs=None, live=False, layout='unaligned', allow_flagging=None, flagging_dir="flagged")

注：Union表示集合、包含的意思，例如inputs，可以是字符串str；可以是输入组件InputComponent；可以是列表，列表可以包含字符串str，输入组件InputComponent。

• fn(Union[Callable, List[Callable]])：包装的函数，可以是一个或者多个，用列表存放多个函数。
• inputs(Union[str, InputComponent, List[Union[str, InputComponent]]])：输入类型/格式，一个参数可以是字符串str；可以是输入组件InputComponent；多个参数可以是列表，列表可以包含字符串str，输入组件InputComponent。输入组件的个数应该和fn函数的参数个数一致。
• outputs(Union[str, OutputComponent, List[Union[str, OutputComponent]]])：输出类型/格式，与inputs类似，区别就算这是输出组件。输出组件的个数应该和fn函数返回个数一致。
• live(bool)：默认为False，设置为True，为动态页面，只要输入发生变化，结果马上发生改变。
• layout(str)：输入输出面板的布局。"horizontal"安排他们为两列等高；"unaligned"安排他们为两列不等高；"vertical"安排他们为垂直排放。
• allow_flagging(str)：有三个选项"never"、“auto”、“manual”。设置为"never"或"auto"时，用户无法看到Flag按钮；设置为"manual"，用户可见Flag按钮。如果设置为"auto"，每次的输入输出都会被标记保存。如果设置为"manual"，当用户按下Flag按钮，标记当前输入输出的结果并保存。
• flagging_dir(str)：Flag保存的文件夹名称

发射Interface

gradio.Interface().launch(self)

也是那几个（对于我自身使用而言）较为常用参数来看：
（无需参数，可直接调用，为本地链接）

• share(bool)：是否创建可公开分享的链接。
• auth(Callable, Union[Tuple[str, str], List[Tuple[str, str]]])：最简单的就是给个用户名、密码的元组，这样就可以让有权限的人才能访问。

输入组件（只解释我认为的较为常用）

• Textbox

gradio.inputs.Textbox(self, lines=1, placeholder=None, default="", label=None, optional=False)

该组件为用户提供一个输入框，需提供一个字符串为参数的包装函数
输入类型：str

参数：
lines (int) - 输入区域行数
placeholder (str) - placeholder学过前端的应该都知道，就是在输入框中的一个提示文本。
default (str) - 默认文本
label (str) - 在接口中的该输入组件的组件名（下面所有组件同理）
optional (bool) - 这个参数忽略（官方文档这么写的）

字符串快捷键：（即不需要实例化Textbox对象）
“text” - 使用默认参数
“textbox” - 设置 lines=7

• Number

gradio.inputs.Number(self, default=None, label=None, optional=False)

该组件为用户提供一个数字输入框，需提供一个数字为参数的包装函数
输入类型：float

参数：
default (float) - 默认值
label (str) - 组件名
optional (bool) - 如果为True，可以没输入值就点击Submit提交

字符串快捷键：
“number” - 使用默认参数

• Slider

gradio.inputs.Slider(self, minimum=0, maximum=100, step=None, default=None, label=None, optional=False)

该组件为用户提供一个最小值到最大值的区间滑块，需提供一个数字为参数的包装函数
输入类型：float

参数：
minimum (float) - 最小值
maximum (float) - 最大值
step (float) - 步长
default (float) - 默认值
label (str) - 组件名
optional (bool) - 这个参数忽略

字符串快捷键：
“slider” - 使用默认参数

• Checkbox

gradio.inputs.Checkbox(self, default=False, label=None, optional=False)

该组件为用户提供单个复选框，可选可不选，需提供一个bool为参数的包装函数
输入类型：bool

参数：
label (str) - 组件名
default (bool) - 如果为True，默认选中
optional (bool) - 这个参数忽略

字符串快捷键：
“checkbox” - 使用默认参数

• CheckboxGroup

gradio.inputs.CheckboxGroup(self, choices, default=[], type="value", label=None, optional=False)

该组件为用户提供多个复选框，需提供一个作为选项内容的字符串列表为参数的包装函数
输入类型：Union[List[str], List[int]]

参数：
choices (List[str]) - 选项列表
default (List[str]) - 默认选中的选项列表
type (str) - 组件返回值的类型（就是用户选择后，返回给我们以什么类型处理）。 “value” 返回所选选项的字符串列表， “index” 返回所选选项的索引列表。
label (str) - 组件名
optional (bool) - 这个参数忽略

• Radio

gradio.inputs.Radio(self, choices, type="value", default=None, label=None, optional=False)

该组件为用户提供多个单选框按钮，需提供一个被选择的字符串为参数的包装函数
输入类型：Union[str, int]

参数：
choices (List[str]) - 选项列表
type (str) - 组件返回值的类型（就是用户选择后，返回给我们以什么类型处理）。 “value” 返回所选选项的字符串， “index” 返回所选选项的索引。
default (str) - 默认选择的按钮，如果为None, 则没有默认选择。
label (str) - 组件名
optional (bool) - 这个参数忽略

• Dropdown

gradio.inputs.Dropdown(self, choices, type="value", default=None, label=None, optional=False)

该组件为用户提供只能选择一个的下拉框，需提供一个被选择的字符串为参数的包装函数
输入类型：Union[str, int]

参数：（与Radio一样）
choices (List[str]) - 选项列表
type (str) - 组件返回值的类型（就是用户选择后，返回给我们以什么类型处理）。 “value” 返回所选选项的字符串， “index” 返回所选选项的索引。
default (str) - 默认选择的按钮，如果为None, 则没有默认选择。
label (str) - 组件名
optional (bool) - 这个参数忽略

• Image
• Video
• Audio
• File

gradio.inputs.File(self, file_count="single", type="file", label=None, optional=False)

该组件接受通用文件上传
输入类型：Union[file-object, bytes, List[Union[file-object, bytes]]]

参数：（与Radio一样）
file_count (str) - 如果为"single"，只允许上传单个文件。 如果为 “multiple”，可以上传多个文件。如果为 “directory”, 可以上传一个文件夹。如果为"multiple" 或 “directory"返回类型是每个文件的列表。
type (str) - 组件返回值的类型。 “file” 返回一个临时文件对象，路径可以通过file_obj.name获取。 “binary” returns an bytes object. （文档写的binary）实际使用报错信息发现还是得用"bytes”，返回一个字节对象。
label (str) - 组件名
optional (bool) - 如果为True，可以不上传文件，此时输入值为None

• Dataframe
• Timeseries
• State

输出组件（只解释目前我用到的）

• Textbox

gradio.outputs.Textbox(self, type="auto", label=None)

该组件创建一个文本框放输出的文本或数字
输出类型：Union[str, float, int]

参数：
type (str) - 传回组件的类型。“str” 期待一个字符串，“number” 期待一个float，“auto” 自动检测返回类型。.
label (str) - 组件名

字符串快捷键：
“text” - 设置 type=str
“textbox” - 设置 type=str
“number” - 设置 type=number

• Label
• Image
• Video
• KeyValues
• HighlightedText
• Audio
• JSON
• html
• File

gradio.outputs.File(self, label=None)

该组件用于文件输出
输出类型：Union[file-like, str]

参数：
label (str) - 组件名

字符串快捷键：
“file” - 使用默认参数

• Dataframe
• Carousel
• Timeseries
• Chatbot
• State

*此文仅为个人笔记

Gradio 机器学习和数据科学开源 Python 库

        Gradio是一个开源的 Python 库，MIT的开源项目，用于构建机器学习和数据科学演示和 Web 应用。

        Gradio的定位类似于Streamlit，但是更轻量，因为它推荐的应用场景都是对“单个函数”进行调用的应用，并且不需要对组件进行回调。比如下列场景（以下代码参考官方文档）

        Gradio提供机器学习模型或数据科学工作流程快速创建一个漂亮的用户界面，让人们通过拖放自己的图片、粘贴文本、录制自己的声音来 "试用"，并通过浏览器与你的演示进行互动。

Gradio 适用于：

 

• 演示你的机器学习模型
• 通过自动共享链接快速部署你的模型，并获得对模型性能的反馈
• 在开发过程中使用内置的操作和解释工具对你的模型进行交互式调试

Gradio 需要 Python 3.7 或更高版本

pip install gradio

 Python 脚本或在 Jupyter Notebook 中运行

import gradio as gr

def greet(name):
    return "Hello " + name + "!"

demo = gr.Interface(fn=greet, inputs="text", outputs="text")
demo.launch()

 

参考：

Gradio官网：https://www.gradio.app/

Gradio官方文档：https://gradio.app/docs

使用Gradio的项目「Anime2Sketch」：https://www.gradio.app/hub/AK391/Anime2Sketch