Gradio 月活用户突破 100 万!

阅读更多
Gradio logo
  1. 组件
  2. 状态

Gradio 新手?从这里开始: 入门指南

查看发布历史

状态

gradio.State(···)

描述

用于定义所有输入/输出组件应具有的方法的基类。

行为

作为输入组件: 传递任意类型的值。

您的函数应接受以下类型之一
def predict(
	value: Any
)
	...

作为输出组件: 期望任意类型的值,只要它可以被深度复制。

您的函数应返回以下类型之一
def predict(···) -> Any
	...	
	return value

初始化

参数
🔗
value: Any
default = None

状态的初始值(任意类型)。提供的参数会被深度复制。如果提供了可调用对象,则在应用加载时将调用该函数以设置状态的初始值。

🔗
render: bool
default = True

应始终为 True,为了与其他组件保持一致性而包含。

🔗
time_to_live: int | float | None
default = None

状态在创建或更新后应存储的秒数。如果为 None,则状态将无限期存储。Gradio 会在用户关闭浏览器选项卡或刷新页面后自动删除状态变量,因此这对于清除可能长时间运行的会话的状态很有用。

🔗
delete_callback: Callable[[Any], None] | None
default = None

状态被删除时调用的函数。该函数应将状态值作为参数。

事件监听器

描述

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

支持的事件监听器

State 组件支持以下事件监听器。每个事件监听器都采用相同的参数,这些参数在下面的事件参数表中列出。

监听器 描述

State.change(fn, ···)

当 State 的值因用户输入(例如,用户在文本框中键入内容)或函数更新(例如,图像从事件触发器的输出接收到一个值)而改变时触发。有关仅由用户输入触发的监听器,请参见 .input()

事件参数

参数
🔗
fn: Callable | None | Literal['decorator']
default = "decorator"

触发此事件时要调用的函数。通常是机器学习模型的预测函数。函数的每个参数对应一个输入组件,函数应返回单个值或值元组,元组中的每个元素对应一个输出组件。

🔗
inputs: Component | BlockContext | list[Component | BlockContext] | Set[Component | BlockContext] | None
default = None

用作输入的 gradio.components 列表。如果函数不接受任何输入,则应为空列表。

🔗
outputs: Component | BlockContext | list[Component | BlockContext] | Set[Component | BlockContext] | None
default = None

用作输出的 gradio.components 列表。如果函数不返回任何输出,则应为空列表。

🔗
api_name: str | None | Literal[False]
default = None

定义端点在 API 文档中的显示方式。可以是字符串、None 或 False。如果设置为字符串,则端点将以给定的名称在 API 文档中公开。如果为 None(默认),则函数的名称将用作 API 端点。如果为 False,则端点将不会在 API 文档中公开,下游应用(包括 `gr.load` 此应用的那些应用)将无法使用此事件。

🔗
scroll_to_output: bool
default = False

如果为 True,则完成后将滚动到输出组件

🔗
show_progress: Literal['full', 'minimal', 'hidden']
default = "full"

事件运行时如何显示进度动画:“full”显示一个覆盖输出组件区域的微调器以及右上角的运行时显示,“minimal”仅显示运行时显示,“hidden”不显示任何进度动画

🔗
show_progress_on: Component | list[Component] | None
default = None

要在其上显示进度动画的组件或组件列表。如果为 None,则将在所有输出组件上显示进度动画。

🔗
queue: bool
default = True

如果为 True,则会将请求放在队列中(如果已启用队列)。如果为 False,则不会将此事件放在队列中,即使已启用队列也是如此。如果为 None,将使用 Gradio 应用的队列设置。

🔗
batch: bool
default = False

如果为 True,则函数应处理一批输入,这意味着它应接受每个参数的输入值列表。列表的长度应相等(且长度不超过 `max_batch_size`)。然后 *必须* 返回一个列表元组(即使只有一个输出组件),元组中的每个列表对应一个输出组件。

🔗
max_batch_size: int
default = 4

如果从队列调用(仅在 batch=True 时相关),则要批处理在一起的最大输入数

🔗
preprocess: bool
default = True

如果为 False,则在运行“fn”之前不会运行组件数据的预处理(例如,如果使用 `Image` 组件调用此方法,则将其保留为 base64 字符串)。

🔗
postprocess: bool
default = True

如果为 False,则在将“fn”输出返回到浏览器之前,不会运行组件数据的后处理。

🔗
cancels: dict[str, Any] | list[dict[str, Any]] | None
default = None

触发此监听器时要取消的其他事件的列表。例如,设置 cancels=[click_event] 将取消 click_event,其中 click_event 是另一个组件的 .click 方法的返回值。尚未运行的函数(或正在迭代的生成器)将被取消,但当前正在运行的函数将允许完成。

🔗
trigger_mode: Literal['once', 'multiple', 'always_last'] | None
default = None

如果为“once”(除 `.change()` 之外的所有事件的默认值),则在事件挂起时不允许任何提交。如果设置为“multiple”,则在挂起时允许无限次提交,而“always_last”(`.change()` 和 `.key_up()` 事件的默认值)将允许在挂起事件完成后进行第二次提交。

🔗
js: str | Literal[True] | None
default = None

在运行“fn”之前要运行的可选前端 js 方法。js 方法的输入参数是“inputs”和“outputs”的值,返回值应为输出组件的值列表。

🔗
concurrency_limit: int | None | Literal['default']
default = "default"

如果设置,则这是可以同时运行的此事件的最大数量。可以设置为 None 表示没有 concurrency_limit(可以同时运行此事件的任意数量)。设置为“default”以使用默认并发限制(由 `Blocks.queue()` 中的 `default_concurrency_limit` 参数定义,该参数本身默认为 1)。

🔗
concurrency_id: str | None
default = None

如果设置,则这是并发组的 ID。具有相同 concurrency_id 的事件将受到最低设置的 concurrency_limit 的限制。

🔗
show_api: bool
default = True

是否在 Gradio 应用的“查看 API”页面或 Gradio 客户端的 “.view_api()” 方法中显示此事件。与将 api_name 设置为 False 不同,将 show_api 设置为 False 仍将允许下游应用以及客户端使用此事件。如果 fn 为 None,则 show_api 将自动设置为 False。

🔗
time_limit: int | None
default = None
🔗
stream_every: float
default = 0.5
🔗
like_user_message: bool
default = False