Gradio 代理 & MCP 黑客马拉松

获奖者
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)的组件。

行为

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

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

作为输出组件: 期望函数返回类型为(.obj、.glb、.stl 或 .gltf)的 strpathlib.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 | I18nData | 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 在一行中,A 的 `scale=2`,B 的 `scale=1`,则 A 的宽度将是 B 的两倍。应为整数。`scale` 适用于行中,以及 `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 | tuple[int | str, ...] | None
默认 = None

在 `gr.render` 中,跨重新渲染具有相同键的组件被视为同一组件,而不是新组件。在 `preserved_by_key` 中设置的属性在重新渲染时不会重置。

🔗
preserved_by_key: list[str] | str | None
默认 = "value"

此组件构造函数中的参数列表。在 `gr.render()` 函数内部,如果组件以相同的键重新渲染,则这些(且仅这些)参数将被保留在 UI 中(如果它们已被用户或事件监听器更改),而不是根据构造函数中提供的值重新渲染。

快捷方式

接口字符串快捷方式 初始化

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

🔗
concurrency_id: str | None
默认 = None

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

🔗
show_api: bool
默认 = True

是否在 Gradio 应用程序的“查看 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
🔗
key: int | str | tuple[int | str, ...] | None
默认 = None

此事件监听器的唯一键,用于 `@gr.render()`。如果设置,此值在键相同时,标识跨重新渲染的事件是相同的。

指南