Hugging Face 的徽标

Transformers 文档

ZoeDepth

Hugging Face's logo
加入 Hugging Face 社区

并获得增强文档体验的访问权限

开始使用

ZoeDepth

概述

ZoeDepth 模型由 Shariq Farooq Bhat、Reiner Birkl、Diana Wofk、Peter Wonka 和 Matthias Müller 在 ZoeDepth：通过结合相对深度和度量深度实现零样本迁移 中提出。ZoeDepth 扩展了 DPT 框架用于度量（也称为绝对）深度估计。ZoeDepth 使用相对深度在 12 个数据集上进行预训练，并使用度量深度在两个领域（NYU 和 KITTI）上进行微调。每个领域都使用称为度量箱模块的新颖箱调整设计，配备轻量级头部。在推理过程中，每个输入图像都会使用潜在分类器自动路由到相应的头部。

论文中的摘要如下

本文解决了从单张图像中进行深度估计的问题。现有工作要么侧重于不考虑度量尺度的泛化性能，即相对深度估计，要么侧重于特定数据集上的最先进结果，即度量深度估计。我们提出了第一个将这两个方面结合起来的方法，从而使模型具有优异的泛化性能，同时保持度量尺度。我们的旗舰模型 ZoeD-M12-NK 使用相对深度在 12 个数据集上进行预训练，并使用度量深度在两个数据集上进行微调。我们使用轻量级头部，每个领域都使用称为度量箱模块的新颖箱调整设计。在推理过程中，每个输入图像都会使用潜在分类器自动路由到相应的头部。我们的框架根据用于相对深度预训练和度量微调的数据集，允许使用多种配置。在没有预训练的情况下，我们已经可以在 NYU Depth v2 室内数据集上显著提高最先进水平（SOTA）。在 12 个数据集上进行预训练，并在 NYU Depth v2 室内数据集上进行微调，我们可以进一步提高 SOTA，在相对绝对误差 (REL) 方面总共提高 21%。最后，ZoeD-M12-NK 是第一个能够在多个数据集（NYU Depth v2 和 KITTI）上联合训练而不会显著降低性能，并实现对来自室内和室外领域八个未见数据集的空前零样本泛化性能的模型。

drawing ZoeDepth 架构。摘自 原始论文。

该模型由 nielsr 贡献。原始代码可以在 此处 找到。

使用技巧

  • ZoeDepth 是一个绝对（也称为度量）深度估计模型，与 DPT 不同，DPT 是一个相对深度估计模型。这意味着 ZoeDepth 能够以米等度量单位估算深度。

使用 ZoeDepth 进行推理最简单的方法是利用 管道 API

from transformers import pipeline
from PIL import Image
import requests

url = "http://images.cocodataset.org/val2017/000000039769.jpg"
image = Image.open(requests.get(url, stream=True).raw)

pipe = pipeline(task="depth-estimation", model="Intel/zoedepth-nyu-kitti")
result = pipe(image)
depth = result["depth"]

或者，还可以使用以下类进行推理

from transformers import AutoImageProcessor, ZoeDepthForDepthEstimation
import torch
import numpy as np
from PIL import Image
import requests

url = "http://images.cocodataset.org/val2017/000000039769.jpg"
image = Image.open(requests.get(url, stream=True).raw)

image_processor = AutoImageProcessor.from_pretrained("Intel/zoedepth-nyu-kitti")
model = ZoeDepthForDepthEstimation.from_pretrained("Intel/zoedepth-nyu-kitti")

# prepare image for the model
inputs = image_processor(images=image, return_tensors="pt")

with torch.no_grad():
    outputs = model(**inputs)
    predicted_depth = outputs.predicted_depth

# interpolate to original size
prediction = torch.nn.functional.interpolate(
    predicted_depth.unsqueeze(1),
    size=image.size[::-1],
    mode="bicubic",
    align_corners=False,
)

# visualize the prediction
output = prediction.squeeze().cpu().numpy()
formatted = (output * 255 / np.max(output)).astype("uint8")
depth = Image.fromarray(formatted)

资源

官方 Hugging Face 和社区（由 🌎 表示）资源列表，可帮助您开始使用 ZoeDepth。

  • 关于使用 ZoeDepth 模型进行推理的演示笔记本可以在 此处 找到。 🌎

ZoeDepthConfig

class transformers.ZoeDepthConfig

< >

( backbone_config = None backbone = None use_pretrained_backbone = False backbone_kwargs = None hidden_act = 'gelu' initializer_range = 0.02 batch_norm_eps = 1e-05 readout_type = 'project' reassemble_factors = [4, 2, 1, 0.5] neck_hidden_sizes = [96, 192, 384, 768] fusion_hidden_size = 256 head_in_index = -1 use_batch_norm_in_fusion_residual = False use_bias_in_fusion_residual = None num_relative_features = 32 add_projection = False bottleneck_features = 256 num_attractors = [16, 8, 4, 1] bin_embedding_dim = 128 attractor_alpha = 1000 attractor_gamma = 2 attractor_kind = 'mean' min_temp = 0.0212 max_temp = 50.0 bin_centers_type = 'softplus' bin_configurations = [{'n_bins': 64, 'min_depth': 0.001, 'max_depth': 10.0}] num_patch_transformer_layers = None patch_transformer_hidden_size = None patch_transformer_intermediate_size = None patch_transformer_num_attention_heads = None **kwargs )

参数

  • backbone_config (Union[Dict[str, Any], PretrainedConfig], 可选, 默认值为 BeitConfig()) — 主干模型的配置。
  • backbone (str, 可选) — 当 backbone_config 为 None 时使用的主干模型名称。如果 use_pretrained_backbone 为 True，这将从 timm 或 transformers 库加载相应的预训练权重。如果 use_pretrained_backbone 为 False，这将加载主干模型的配置，并使用它来使用随机权重初始化主干模型。
  • use_pretrained_backbone (bool, 可选, 默认值为 False) — 是否使用主干模型的预训练权重。
  • backbone_kwargs (dict, 可选) — 传递给 AutoBackbone 的关键字参数，用于从检查点加载，例如 {'out_indices': (0, 1, 2, 3)}。如果设置了 backbone_config，则无法指定。
  • hidden_act (str 或 function, 可选, 默认值为 "gelu") — 编码器和池化器中的非线性激活函数 (函数或字符串)。如果为字符串，则支持 "gelu"、"relu"、"selu" 和 "gelu_new"。
  • initializer_range (float, 可选, 默认值为 0.02) — 用于初始化所有权重矩阵的截断正态初始化的标准差。
  • batch_norm_eps (float, 可选, 默认值为 1e-05) — 批量归一化层使用的 epsilon。
  • readout_type (str, 可选, 默认为 "project") — 处理 ViT 主干网络中间隐藏状态的读出令牌（CLS 令牌）时要使用的读出类型。可以是以下之一： ["ignore", "add", "project"].

    • “ignore” 忽略 CLS 令牌。
    • “add” 通过将表示相加，将 CLS 令牌的信息传递给所有其他令牌。
    • “project” 通过在将表示投影到原始特征维度 D 之前将读出与所有其他令牌连接起来，将信息传递给其他令牌，使用一个线性层，然后使用 GELU 非线性。
  • reassemble_factors (List[int], 可选, 默认为 [4, 2, 1, 0.5]) — 重组层的向上/向下采样因子。
  • neck_hidden_sizes (List[str], 可选, 默认为 [96, 192, 384, 768]) — 要为主干网络的特征图投影的隐藏大小。
  • fusion_hidden_size (int, 可选, 默认为 256) — 融合前的通道数。
  • head_in_index (int, 可选, 默认为 -1) — 要在头部中使用的特征的索引。
  • use_batch_norm_in_fusion_residual (bool, 可选, 默认为 False) — 是否在融合块的预激活残差单元中使用批次归一化。
  • use_bias_in_fusion_residual (bool, 可选, 默认为 True) — 是否在融合块的预激活残差单元中使用偏置。
  • num_relative_features (int, 可选, 默认为 32) — 要在相对深度估计头中使用的特征数量。
  • add_projection (bool, 可选, 默认为 False) — 是否在深度估计头之前添加一个投影层。
  • bottleneck_features (int, 可选, 默认为 256) — 瓶颈层中的特征数量。
  • bin_embedding_dim (int, optional, defaults to 128) — 箱体嵌入的维度。
  • attractor_alpha (int, optional, defaults to 1000) — 用于吸引器的 alpha 值。
  • attractor_gamma (int, optional, defaults to 2) — 用于吸引器的 gamma 值。
  • attractor_kind (str, optional, defaults to "mean") — 要使用的吸引器类型。可以是 ["mean", "sum"] 之一。
  • min_temp (float, optional, defaults to 0.0212) — 要考虑的最小温度值。
  • max_temp (float, optional, defaults to 50.0) — 要考虑的最大温度值。
  • bin_centers_type (str, optional, defaults to "softplus") — 用于箱体中心的激活类型。可以是 “normed” 或 “softplus”。对于 “normed” 箱体中心，会应用线性归一化技巧。这会导致有界箱体中心。对于 “softplus”，会使用 softplus 激活，因此是无界的。
  • bin_configurations (List[dict], optional, defaults to [{'n_bins' -- 64, 'min_depth': 0.001, 'max_depth': 10.0}]): 每个箱头配置。每个配置应包含以下键：

    • name (str): 箱头的名称 - 仅在有多个箱体配置的情况下需要。
    • n_bins (int): 要使用的箱体数量。
    • min_depth (float): 要考虑的最小深度值。
    • max_depth (float): 要考虑的最大深度值。如果只传递单个配置，模型将使用具有指定配置的单个头。如果传递多个配置，模型将使用具有指定配置的多个头。
  • num_patch_transformer_layers (int, optional) — 在补丁转换器中要使用的转换器层数。仅在有多个箱体配置的情况下使用。
  • patch_transformer_hidden_size (int, optional) — 在补丁转换器中要使用的隐藏大小。仅在有多个箱体配置的情况下使用。
  • patch_transformer_num_attention_heads (int, 可选) — 在 patch transformer 中使用的注意力头的数量。仅在多 bin 配置的情况下使用。

这是用于存储 ZoeDepthForDepthEstimation 配置的配置类。它用于根据指定的参数实例化 ZoeDepth 模型，定义模型架构。使用默认值实例化配置将产生与 ZoeDepth Intel/zoedepth-nyu 架构类似的配置。

配置对象继承自 PretrainedConfig，可用于控制模型输出。阅读 PretrainedConfig 中的文档以获取更多信息。

示例

>>> from transformers import ZoeDepthConfig, ZoeDepthForDepthEstimation

>>> # Initializing a ZoeDepth zoedepth-large style configuration
>>> configuration = ZoeDepthConfig()

>>> # Initializing a model from the zoedepth-large style configuration
>>> model = ZoeDepthForDepthEstimation(configuration)

>>> # Accessing the model configuration
>>> configuration = model.config

ZoeDepthImageProcessor

class transformers.ZoeDepthImageProcessor

< >

( do_pad: bool = True do_rescale: bool = True rescale_factor: Union = 0.00392156862745098 do_normalize: bool = True image_mean: Union = None image_std: Union = None do_resize: bool = True size: Dict = None resample: Resampling = <Resampling.BILINEAR: 2> keep_aspect_ratio: bool = True ensure_multiple_of: int = 32 **kwargs )

参数

  • do_pad (bool, 可选，默认为 True) — 是否应用填充输入。
  • do_rescale (bool, 可选，默认为 True) — 是否根据指定的缩放比例 rescale_factor 对图像进行缩放。可以在 preprocess 中被 do_rescale 覆盖。
  • rescale_factor (int 或 float, 可选，默认为 1/255) — 如果缩放图像，要使用的缩放比例。可以在 preprocess 中被 rescale_factor 覆盖。
  • do_normalize (bool, 可选，默认为 True) — 是否对图像进行标准化。可以在 preprocess 方法中的 do_normalize 参数中被覆盖。
  • image_mean (float 或 List[float], 可选，默认为 IMAGENET_STANDARD_MEAN) — 如果标准化图像，要使用的均值。这是一个浮点数或浮点数列表，其长度与图像中通道数量相同。可以在 preprocess 方法中的 image_mean 参数中被覆盖。
  • image_std (float 或 List[float], 可选, 默认值 IMAGENET_STANDARD_STD) — 归一化图像时要使用的标准差。这是一个浮点数或浮点数列表，其长度与图像中的通道数量相同。可以在 preprocess 方法中使用 image_std 参数覆盖。
  • do_resize (bool, 可选, 默认值 True) — 是否调整图像的（高度、宽度）尺寸。可以在 preprocess 中使用 do_resize 覆盖。
  • size (Dict[str, int] 可选, 默认值 {"height" -- 384, "width": 512}): 调整大小后图像的大小。调整大小后图像的大小。如果 keep_aspect_ratio 为 True，则图像会通过选择高度和宽度缩放因子中的较小者并将其用于两个维度来调整大小。如果还设置了 ensure_multiple_of，则图像将进一步调整为此值的倍数大小。可以在 preprocess 中使用 size 参数覆盖。
  • resample (PILImageResampling, 可选, 默认值 Resampling.BILINEAR) — 定义调整图像大小时要使用的重采样滤波器。可以在 preprocess 中使用 resample 参数覆盖。
  • keep_aspect_ratio (bool, 可选, 默认值 True) — 如果为 True，则图像会通过选择高度和宽度缩放因子中的较小者并将其用于两个维度来调整大小。这确保图像在仍适合所需输出大小的情况下尽可能少地缩小。如果还设置了 ensure_multiple_of，则图像将通过将高度和宽度向下舍入到此值的最近倍数来进一步调整为此值的倍数大小。可以在 preprocess 中使用 keep_aspect_ratio 参数覆盖。
  • ensure_multiple_of (int, 可选, 默认值 32) — 如果 do_resize 为 True，则图像将调整为此值的倍数大小。通过将高度和宽度向下舍入到此值的最近倍数来实现。

构造 ZoeDepth 图像处理器。

preprocess

< >

( images: Union do_pad: bool = None do_rescale: bool = None rescale_factor: float = None do_normalize: bool = None image_mean: Union = None image_std: Union = None do_resize: bool = None size: int = None keep_aspect_ratio: bool = None ensure_multiple_of: int = None resample: Resampling = None return_tensors: Union = None data_format: ChannelDimension = <ChannelDimension.FIRST: 'channels_first'> input_data_format: Union = None )

参数

  • images (ImageInput) — 要预处理的图像。需要一个或一批像素值范围为 0 到 255 的图像。如果传入像素值介于 0 到 1 之间的图像，请设置 do_rescale=False。
  • do_pad (bool, 可选, 默认为 self.do_pad) — 是否对输入图像进行填充。
  • do_rescale (bool, 可选, 默认为 self.do_rescale) — 是否将图像值重新缩放至 [0 - 1] 之间。
  • rescale_factor (float, 可选, 默认为 self.rescale_factor) — 如果 do_rescale 设置为 True，则重新缩放图像的缩放因子。
  • do_normalize (bool, 可选, 默认为 self.do_normalize) — 是否对图像进行标准化。
  • image_mean (float 或 List[float], 可选, 默认为 self.image_mean) — 图像均值。
  • image_std (float 或 List[float], 可选, 默认为 self.image_std) — 图像标准差。
  • do_resize (bool, 可选, 默认为 self.do_resize) — 是否调整图像大小。
  • size (Dict[str, int], 可选, 默认为 self.size) — 调整大小后图像的大小。如果 keep_aspect_ratio 为 True，则通过选择高度和宽度缩放因子中较小的一个并将其用于两个维度来调整图像大小。如果还设置了 ensure_multiple_of，则图像将进一步调整为该值的倍数大小。
  • keep_aspect_ratio (bool, 可选, 默认为 self.keep_aspect_ratio) — 如果 True 且 do_resize=True，则通过选择高度和宽度缩放因子中较小的一个并将其用于两个维度来调整图像大小。这确保了图像在尽可能小的缩放下仍然适合所需的输出大小。如果还设置了 ensure_multiple_of，则通过将高度和宽度向下取整到该值的最近倍数来进一步调整图像大小。
  • ensure_multiple_of (int, 可选, 默认为 self.ensure_multiple_of) — 如果 do_resize 为 True，则将图像调整为该值的倍数大小。通过将高度和宽度向下取整到该值的最近倍数来实现。

    无论 keep_aspect_ratio 是否设置为 True 都可以使用。可以被 preprocess 中的 ensure_multiple_of 覆盖。

  • return_tensors (str 或 TensorType, 可选) — 返回的张量类型。可以是以下之一：

    • 未设置：返回 np.ndarray 的列表。
    • TensorType.TENSORFLOW 或 'tf'：返回类型为 tf.Tensor 的批次。
    • TensorType.PYTORCH 或 'pt'：返回类型为 torch.Tensor 的批次。
    • TensorType.NUMPY 或 'np'：返回类型为 np.ndarray 的批次。
    • TensorType.JAX 或 'jax'：返回类型为 jax.numpy.ndarray 的批次。
  • data_format (ChannelDimension 或 str, 可选，默认值为 ChannelDimension.FIRST) — 输出图像的通道维度格式。可以是以下之一：

    • ChannelDimension.FIRST：图像格式为 (num_channels, height, width)。
    • ChannelDimension.LAST：图像格式为 (height, width, num_channels)。
  • input_data_format (ChannelDimension 或 str, 可选) — 输入图像的通道维度格式。如果未设置，则从输入图像推断通道维度格式。可以是以下之一：

    • "channels_first" 或 ChannelDimension.FIRST：图像格式为 (num_channels, height, width)。
    • "channels_last" 或 ChannelDimension.LAST：图像格式为 (height, width, num_channels)。
    • "none" 或 ChannelDimension.NONE：图像格式为 (height, width)。

预处理图像或图像批次。

ZoeDepthForDepthEstimation

class transformers.ZoeDepthForDepthEstimation

< >

( config )

参数

  • config (ViTConfig) — 模型配置类，包含模型的所有参数。使用配置文件初始化不会加载与模型关联的权重，仅加载配置。查看 from_pretrained() 方法以加载模型权重。

在顶部有一个或多个度量深度估计头的 ZoeDepth 模型。

此模型是 PyTorch torch.nn.Module 子类。将其用作常规 PyTorch 模块，并参考 PyTorch 文档以了解有关一般用法和行为的所有事项。

forward

< >

( pixel_values: FloatTensor labels: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None ) → transformers.modeling_outputs.DepthEstimatorOutput 或 tuple(torch.FloatTensor)

参数

  • pixel_values (torch.FloatTensor 形状为 (batch_size, num_channels, height, width)) — 像素值。可以使用 AutoImageProcessor 获取像素值。有关详细信息，请参阅 DPTImageProcessor.call()。
  • output_attentions (bool, 可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参阅返回张量中的 attentions。
  • output_hidden_states (bool, 可选) — 是否返回所有层的隐藏状态。有关更多详细信息，请参阅返回张量中的 hidden_states。
  • return_dict (bool, 可选) — 是否返回 ModelOutput 而不是普通元组。
  • labels (torch.LongTensor 形状为 (batch_size, height, width), 可选) — 用于计算损失的真实深度估计图。

返回值

transformers.modeling_outputs.DepthEstimatorOutput 或 tuple(torch.FloatTensor)

一个 transformers.modeling_outputs.DepthEstimatorOutput 或 torch.FloatTensor 的元组（如果传递了 return_dict=False 或当 config.return_dict=False 时），包含取决于配置 (ZoeDepthConfig) 和输入的各种元素。

  • loss (torch.FloatTensor 形状为 (1,), 可选, 在提供 labels 时返回) — 分类（如果 config.num_labels==1 则为回归）损失。

  • predicted_depth (torch.FloatTensor 形状为 (batch_size, height, width)) — 每个像素的预测深度。

  • hidden_states (tuple(torch.FloatTensor), 可选, 当传递了 output_hidden_states=True 或当 config.output_hidden_states=True 时返回) — torch.FloatTensor 的元组（一个用于嵌入的输出，如果模型具有嵌入层，+ 一个用于每一层的输出）形状为 (batch_size, num_channels, height, width)。

    模型在每一层输出处的隐藏状态，加上可选的初始嵌入输出。

  • attentions (tuple(torch.FloatTensor), 可选, 当传递了 output_attentions=True 或当 config.output_attentions=True 时返回) — torch.FloatTensor 的元组（每一层一个）形状为 (batch_size, num_heads, patch_size, sequence_length)。

    注意力 softmax 之后的注意力权重，用于计算自注意力头中的加权平均值。

该 ZoeDepthForDepthEstimation 正向方法覆盖了 __call__ 特殊方法。

虽然正向传递的配方需要在此函数中定义，但应该随后调用 Module 实例，而不是此函数，因为前者负责运行前处理和后处理步骤，而后者则会静默地忽略它们。

示例

>>> from transformers import AutoImageProcessor, ZoeDepthForDepthEstimation
>>> import torch
>>> import numpy as np
>>> from PIL import Image
>>> import requests

>>> url = "http://images.cocodataset.org/val2017/000000039769.jpg"
>>> image = Image.open(requests.get(url, stream=True).raw)

>>> image_processor = AutoImageProcessor.from_pretrained("Intel/zoedepth-nyu-kitti")
>>> model = ZoeDepthForDepthEstimation.from_pretrained("Intel/zoedepth-nyu-kitti")

>>> # prepare image for the model
>>> inputs = image_processor(images=image, return_tensors="pt")

>>> with torch.no_grad():
...     outputs = model(**inputs)
...     predicted_depth = outputs.predicted_depth

>>> # interpolate to original size
>>> prediction = torch.nn.functional.interpolate(
...     predicted_depth.unsqueeze(1),
...     size=image.size[::-1],
...     mode="bicubic",
...     align_corners=False,
... )

>>> # visualize the prediction
>>> output = prediction.squeeze().cpu().numpy()
>>> formatted = (output * 255 / np.max(output)).astype("uint8")
>>> depth = Image.fromarray(formatted)
< > 在 GitHub 上更新

←YOLOS 音频频谱图转换器→