Gradio 月活用户达到 100 万!

阅读更多
Gradio logo
  1. 组件
  2. Model3D

Gradio 新手?从这里开始: 开始上手

查看发布历史

Model3D

gradio.Model3D(···)
import gradio as gr with gr.Blocks() as demo: gr.Model3D() demo.launch()

描述

创建一个组件,允许用户上传或查看 3D 模型文件 (.obj、.glb、.stl、.gltf、.splat 或 .ply)。

行为

作为输入组件: 将上传的文件作为文件路径字符串传递给函数。

你的函数应该接受以下类型之一
def predict(
	value: str | None
)
	...

作为输出组件: 期望函数返回 (.obj、.glb、.stl 或 .gltf) 类型的文件路径字符串或 pathlib.Path 对象

你的函数应该返回以下类型之一
def predict(···) -> str | Path | None
	...	
	return value

初始化

参数
🔗
value: str | Callable | None
默认 = None

要在 model3D 查看器中显示的 (.obj、.glb、.stl、.gltf、.splat 或 .ply) 文件的路径。如果提供了函数,则每次应用加载时都会调用该函数以设置此组件的初始值。

🔗
display_mode: Literal['solid', 'point_cloud', 'wireframe'] | None
默认 = None

场景中 3D 模型的显示模式。可以是 “solid”(将模型渲染为实体对象)、“point_cloud” 或 “wireframe”。对于 .splat 或 .ply 文件,此参数将被忽略,因为这些文件只能渲染为实体对象。

🔗
clear_color: tuple[float, float, float, float] | None
默认 = None

场景的背景颜色,应为 4 个介于 0 和 1 之间的浮点数的元组,表示 RGBA 值。

🔗
camera_position: tuple[int | float | None, int | float | None, int | float | None]
默认 = (None, None, None)

场景的初始相机位置,以 `(alpha, beta, radius)` 元组形式提供。每个值都是可选的。如果提供,`alpha` 和 `beta` 应为度数,分别反映沿经度和纬度轴的角度位置。半径对应于从对象中心到相机的距离。

🔗
zoom_speed: float
默认 = 1

当光标滚轮旋转或在移动设备上捏合屏幕时,场景的缩放速度。应为正浮点数,增加此值可加快缩放速度,减小此值可减慢缩放速度。影响相机的 wheelPrecision 属性。

🔗
pan_speed: float
默认 = 1

当光标被拖动或在移动设备上拖动屏幕时,场景的平移速度。应为正浮点数,增加此值可加快平移速度,减小此值可减慢平移速度。影响相机的 panSensibility 属性。

🔗
height: int | str | None
默认 = None

model3D 组件的高度,如果传递数字,则以像素为单位指定;如果传递字符串,则以 CSS 单位指定。

🔗
label: str | None
默认 = None

此组件的标签。显示在组件上方,如果此组件有示例表,则也用作标题。如果为 None 且在 `gr.Interface` 中使用,则标签将是分配给此组件的参数名称。

🔗
show_label: bool | None
默认 = None

如果为 True,将显示标签。

🔗
every: Timer | float | None
默认 = None

如果 `value` 是一个函数,则持续调用 `value` 以重新计算(否则无效)。可以提供一个 Timer,其刻度重置 `value`,或者提供一个浮点数,表示重置 Timer 的固定间隔。

🔗
inputs: Component | list[Component] | set[Component] | None
默认 = None

如果 `value` 是一个函数,则用作计算 `value` 的输入的组件(否则无效)。每当输入更改时,`value` 都会重新计算。

🔗
container: bool
默认 = True

如果为 True,则将组件放置在容器中 - 在边框周围提供一些额外的内边距。

🔗
scale: int | None
默认 = None

与相邻组件相比的相对大小。例如,如果组件 A 和 B 在同一 Row 中,并且 A 的 scale=2,B 的 scale=1,则 A 的宽度将是 B 的两倍。应为整数。scale 应用于 Rows,以及 Blocks 中 fill_height=True 的顶级组件。

🔗
min_width: int
默认 = 160

最小像素宽度,如果屏幕空间不足以满足此值,则会换行。如果某个 scale 值导致此组件比 min_width 更窄,则将首先遵守 min_width 参数。

🔗
interactive: bool | None
默认 = None

如果为 True,将允许用户上传文件;如果为 False,则只能用于显示文件。如果未提供,则根据组件是用作输入还是输出进行推断。

🔗
visible: bool
默认 = True

如果为 False,组件将被隐藏。

🔗
elem_id: str | None
默认 = None

一个可选的字符串,分配为该组件在 HTML DOM 中的 id。可用于定位 CSS 样式。

🔗
elem_classes: list[str] | str | None
默认 = None

一个可选的字符串列表,分配为该组件在 HTML DOM 中的类。可用于定位 CSS 样式。

🔗
render: bool
默认 = True

如果为 False,组件将不会在 Blocks 上下文中渲染。如果目的是现在分配事件侦听器,但稍后渲染组件,则应使用此选项。

🔗
key: int | str | None
默认 = None

如果已分配,将用于在重新渲染中假定身份。在重新渲染中具有相同 key 的组件将保留其值。

快捷方式

Interface 字符串快捷方式 初始化

gradio.Model3D

"model3d"

使用默认值

事件侦听器

描述

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

支持的事件侦听器

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

侦听器 描述

Model3D.change(fn, ···)

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

Model3D.upload(fn, ···)

当用户将文件上传到 Model3D 中时触发此侦听器。

Model3D.edit(fn, ···)

当用户使用内置编辑器编辑 Model3D(例如图像)时触发此侦听器。

Model3D.clear(fn, ···)

当用户使用组件的清除按钮清除 Model3D 时触发此侦听器。

事件参数

参数
🔗
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 此应用的应用程序)将无法使用此事件。

🔗
scroll_to_output: bool
默认 = False

如果为 True,将在完成时滚动到输出组件

🔗
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`)。然后*需要*函数返回列表元组(即使只有一个输出组件),元组中的每个列表对应一个输出组件。

🔗
max_batch_size: int
默认 = 4

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

🔗
preprocess: bool
默认 = True

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

🔗
postprocess: bool
默认 = True

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

🔗
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 以表示没有 concurrency_limit(可以同时运行此事件的任意数量)。设置为“default”以使用默认并发限制(由 `Blocks.queue()` 中的 `default_concurrency_limit` 参数定义,该参数本身默认为 1)。

🔗
concurrency_id: str | None
默认 = None

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

🔗
show_api: bool
默认 = True

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

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

指南