Transformers 文档
DETR
并获得增强的文档体验
开始使用
DETR
概述
DETR 模型在 End-to-End Object Detection with Transformers 中由 Nicolas Carion、Francisco Massa、Gabriel Synnaeve、Nicolas Usunier、Alexander Kirillov 和 Sergey Zagoruyko 提出。DETR 由卷积骨干网络和编码器-解码器 Transformer 组成,可以端到端地训练以进行物体检测。它极大地简化了像 Faster-R-CNN 和 Mask-R-CNN 这样模型的复杂性,这些模型使用了诸如区域提议、非极大值抑制程序和锚点生成之类的东西。此外,通过在解码器输出之上简单地添加一个掩码头,DETR 还可以自然地扩展以执行全景分割。
该论文的摘要如下:
我们提出了一种新方法,该方法将物体检测视为直接的集合预测问题。我们的方法简化了检测流程,有效地消除了对许多手工设计组件的需求,例如非极大值抑制程序或锚点生成,这些组件明确地编码了我们关于任务的先验知识。名为 DEtection TRansformer 或 DETR 的新框架的主要成分是基于集合的全局损失,该损失通过二分匹配强制执行唯一预测,以及 transformer 编码器-解码器架构。给定一组固定的小型学习对象查询,DETR 推理对象的关系和全局图像上下文,以并行直接输出最终的预测集。与许多其他现代检测器不同,新模型在概念上很简单,并且不需要专门的库。在具有挑战性的 COCO 物体检测数据集上,DETR 展示了与已建立且高度优化的 Faster RCNN 基线相当的准确性和运行时性能。此外,DETR 可以轻松地推广以统一的方式生成全景分割。我们表明,它显着优于竞争基线。
DETR 的工作原理
这是一个 TLDR,解释了 DetrForObjectDetection 的工作原理
首先,图像通过预训练的卷积骨干网络(在论文中,作者使用 ResNet-50/ResNet-101)。假设我们也添加了一个批次维度。这意味着骨干网络的输入是形状为 (batch_size, 3, height, width)
的张量,假设图像有 3 个颜色通道 (RGB)。CNN 骨干网络输出一个新的较低分辨率的特征图,通常形状为 (batch_size, 2048, height/32, width/32)
。然后将其投影以匹配 DETR 的 Transformer 的隐藏维度,默认情况下为 256
,使用 nn.Conv2D
层。所以现在,我们有一个形状为 (batch_size, 256, height/32, width/32)
的张量。接下来,特征图被展平并转置以获得形状为 (batch_size, seq_len, d_model)
= (batch_size, width/32*height/32, 256)
的张量。因此,与 NLP 模型的不同之处在于,序列长度实际上比平时更长,但 d_model
更小(在 NLP 中,通常为 768 或更高)。
接下来,这被发送到编码器,输出相同形状的 encoder_hidden_states
(您可以将这些视为图像特征)。接下来,所谓的对象查询被发送到解码器。这是一个形状为 (batch_size, num_queries, d_model)
的张量,其中 num_queries
通常设置为 100 并初始化为零。这些输入嵌入是学习到的位置编码,作者将其称为对象查询,并且与编码器类似,它们被添加到每个注意力层的输入中。每个对象查询都将在图像中查找特定对象。解码器通过多个自注意力层和编码器-解码器注意力层更新这些嵌入,以输出相同形状的 decoder_hidden_states
:(batch_size, num_queries, d_model)
。接下来,在顶部添加两个头用于对象检测:一个线性层,用于将每个对象查询分类为对象之一或“无对象”,以及一个 MLP,用于预测每个查询的边界框。
该模型使用二分匹配损失进行训练:因此我们实际上做的是将 N = 100 个对象查询中的每一个的预测类别 + 边界框与 ground truth 注释进行比较,填充到相同的长度 N(因此,如果图像仅包含 4 个对象,则 96 个注释将仅具有“无对象”作为类别,并将“无边界框”作为边界框)。匈牙利匹配算法用于找到每个 N 个查询到每个 N 个注释的最佳一对一映射。接下来,使用标准交叉熵(对于类别)和 L1 和 generalized IoU loss 的线性组合(对于边界框)来优化模型的参数。
DETR 可以自然地扩展以执行全景分割(它统一了语义分割和实例分割)。DetrForSegmentation 在 DetrForObjectDetection 之上添加了一个分割掩码头。掩码头可以联合训练,也可以分两个步骤进行,其中首先训练一个 DetrForObjectDetection 模型来检测“事物”(实例)和“东西”(背景事物,如树木、道路、天空)周围的边界框,然后冻结所有权重并仅训练掩码头 25 个 epoch。实验表明,这两种方法给出相似的结果。请注意,预测框是训练成为可能的必要条件,因为匈牙利匹配是使用框之间的距离计算的。
使用技巧
- DETR 使用所谓的对象查询来检测图像中的对象。查询的数量决定了单个图像中可以检测到的最大对象数量,默认情况下设置为 100(请参阅 DetrConfig 的参数
num_queries
)。请注意,最好有一些余量(在 COCO 中,作者使用了 100,而 COCO 图像中对象的最大数量约为 70)。 - DETR 的解码器并行更新查询嵌入。这与像 GPT-2 这样的语言模型不同,后者使用自回归解码而不是并行解码。因此,不使用因果注意力掩码。
- DETR 在投影到查询和键之前,在每个自注意力层和交叉注意力层将位置嵌入添加到隐藏状态。对于图像的位置嵌入,可以选择固定正弦或学习的绝对位置嵌入。默认情况下,DetrConfig 的参数
position_embedding_type
设置为"sine"
。 - 在训练期间,DETR 的作者发现使用解码器中的辅助损失很有帮助,尤其是帮助模型输出每个类别的正确对象数量。如果您将 DetrConfig 的参数
auxiliary_loss
设置为True
,则在每个解码器层之后添加预测前馈神经网络和匈牙利损失(FFN 共享参数)。 - 如果要在跨多个节点的分布式环境中训练模型,则应更新 modeling_detr.py 的 DetrLoss 类中的 num_boxes 变量。在多个节点上训练时,这应设置为所有节点的目标框的平均数量,正如在原始实现 此处 中看到的那样。
- DetrForObjectDetection 和 DetrForSegmentation 可以使用 timm 库中提供的任何卷积骨干网络进行初始化。例如,使用 MobileNet 骨干网络进行初始化可以通过将 DetrConfig 的
backbone
属性设置为"tf_mobilenetv3_small_075"
,然后使用该配置初始化模型来完成。 - DETR 调整输入图像的大小,使得最短边至少为一定像素量,而最长边最多为 1333 像素。在训练时,使用尺度增强,使得最短边随机设置为至少 480 像素,最多 800 像素。在推理时,最短边设置为 800。可以使用 DetrImageProcessor 来为模型准备图像(以及 COCO 格式的可选注释)。由于这种调整大小,批次中的图像可以具有不同的大小。DETR 通过将图像填充到批次中的最大尺寸,并创建一个像素掩码来指示哪些像素是真实的/哪些是填充像素来解决此问题。或者,您还可以定义一个自定义
collate_fn
以将图像批量处理在一起,使用~transformers.DetrImageProcessor.pad_and_create_pixel_mask
。 - 图像的大小将决定使用的内存量,并因此决定
batch_size
。建议每个 GPU 使用 2 的批次大小。有关更多信息,请参阅 此 Github 线程。
有三种实例化 DETR 模型的方法(取决于您的偏好)
选项 1:使用整个模型的预训练权重实例化 DETR
>>> from transformers import DetrForObjectDetection
>>> model = DetrForObjectDetection.from_pretrained("facebook/detr-resnet-50")
选项 2:使用 Transformer 的随机初始化的权重实例化 DETR,但使用骨干网络的预训练权重
>>> from transformers import DetrConfig, DetrForObjectDetection
>>> config = DetrConfig()
>>> model = DetrForObjectDetection(config)
选项 3:使用骨干网络 + Transformer 的随机初始化的权重实例化 DETR
>>> config = DetrConfig(use_pretrained_backbone=False)
>>> model = DetrForObjectDetection(config)
作为总结,请考虑下表
任务 | 物体检测 | 实例分割 | 全景分割 |
---|---|---|---|
描述 | 预测图像中物体周围的边界框和类别标签 | 预测图像中物体(即实例)周围的掩码 | 预测图像中物体(即实例)以及“东西”(即背景事物,如树木和道路)周围的掩码 |
模型 | DetrForObjectDetection | DetrForSegmentation | DetrForSegmentation |
示例数据集 | COCO 检测 | COCO 检测,COCO 全景 | COCO 全景 |
提供给 DetrImageProcessor 的注释格式 | {‘image_id’: int , ‘annotations’: List[Dict] } 每个 Dict 都是 COCO 对象注释 | {‘image_id’: int , ‘annotations’: List[Dict] }(在 COCO 检测的情况下)或 {‘file_name’: str , ‘image_id’: int , ‘segments_info’: List[Dict] }(在 COCO 全景的情况下) | {‘file_name’: str , ‘image_id’: int , ‘segments_info’: List[Dict] } 和 masks_path(包含掩码 PNG 文件的目录路径) |
后处理(即将模型输出转换为 Pascal VOC 格式) | post_process() | post_process_segmentation() | post_process_segmentation() , post_process_panoptic() |
评估器 | CocoEvaluator ,iou_types="bbox" | CocoEvaluator ,iou_types="bbox" 或 "segm" | CocoEvaluator ,iou_tupes="bbox" 或 "segm" ,PanopticEvaluator |
简而言之,应该以 COCO 检测或 COCO 全景格式准备数据,然后使用 DetrImageProcessor 创建 pixel_values
、pixel_mask
和可选的 labels
,然后可以使用它们来训练(或微调)模型。对于评估,应首先使用 DetrImageProcessor 的后处理方法之一转换模型输出。这些可以提供给 CocoEvaluator
或 PanopticEvaluator
,它们允许您计算诸如平均平均精度 (mAP) 和全景质量 (PQ) 之类的指标。后两个对象在 原始存储库 中实现。有关评估的更多信息,请参阅 示例笔记本。
资源
官方 Hugging Face 和社区(🌎 表示)资源列表,可帮助您开始使用 DETR。
- 所有示例笔记本,说明如何微调自定义数据集上的 DetrForObjectDetection 和 DetrForSegmentation,可以在 此处 找到。
- 使用 Trainer 或 Accelerate 微调 DetrForObjectDetection 的脚本可以在 此处 找到。
- 另请参阅:物体检测任务指南。
如果您有兴趣提交资源以包含在此处,请随时打开 Pull Request,我们将对其进行审核!该资源理想情况下应展示一些新的东西,而不是重复现有资源。
DetrConfig
类 transformers.DetrConfig
< 源代码 >( use_timm_backbone = True backbone_config = None num_channels = 3 num_queries = 100 encoder_layers = 6 encoder_ffn_dim = 2048 encoder_attention_heads = 8 decoder_layers = 6 decoder_ffn_dim = 2048 decoder_attention_heads = 8 encoder_layerdrop = 0.0 decoder_layerdrop = 0.0 is_encoder_decoder = True activation_function = 'relu' d_model = 256 dropout = 0.1 attention_dropout = 0.0 activation_dropout = 0.0 init_std = 0.02 init_xavier_std = 1.0 auxiliary_loss = False position_embedding_type = 'sine' backbone = 'resnet50' use_pretrained_backbone = True backbone_kwargs = None dilation = False class_cost = 1 bbox_cost = 5 giou_cost = 2 mask_loss_coefficient = 1 dice_loss_coefficient = 1 bbox_loss_coefficient = 5 giou_loss_coefficient = 2 eos_coefficient = 0.1 **kwargs )
参数
- use_timm_backbone (
bool
, 可选, 默认为True
) — 是否使用timm
库作为 backbone。如果设置为False
,将使用 AutoBackbone API。 - backbone_config (
PretrainedConfig
或dict
, 可选) — backbone 模型的配置。仅在use_timm_backbone
设置为False
时使用,在这种情况下,它将默认为ResNetConfig()
。 - num_channels (
int
, 可选, 默认为 3) — 输入通道的数量。 - num_queries (
int
, 可选, 默认为 100) — 对象查询的数量,即检测槽的数量。这是 DetrModel 在单张图像中可以检测到的最大对象数量。对于 COCO,我们建议使用 100 个查询。 - d_model (
int
, 可选, 默认为 256) — 此参数是一个通用维度参数,用于定义组件的维度,例如编码器层和解码器层中的投影参数等。 - encoder_layers (
int
, 可选, 默认为 6) — 编码器层数。 - decoder_layers (
int
, 可选, 默认为 6) — 解码器层数。 - encoder_attention_heads (
int
, 可选, 默认为 8) — Transformer 编码器中每个注意力层的注意力头数。 - decoder_attention_heads (
int
, 可选, 默认为 8) — Transformer 解码器中每个注意力层的注意力头数。 - decoder_ffn_dim (
int
, 可选, 默认为 2048) — 解码器中“中间”(通常称为前馈)层的维度。 - encoder_ffn_dim (
int
, 可选, 默认为 2048) — 解码器中“中间”(通常称为前馈)层的维度。 - activation_function (
str
或function
, 可选, 默认为"relu"
) — 编码器和池化器中的非线性激活函数(函数或字符串)。如果为字符串,则支持"gelu"
、"relu"
、"silu"
和"gelu_new"
。 - dropout (
float
, 可选, 默认为 0.1) — 嵌入层、编码器和池化器中所有全连接层的 dropout 概率。 - attention_dropout (
float
, 可选, 默认为 0.0) — 注意力概率的 dropout 比率。 - activation_dropout (
float
, 可选, 默认为 0.0) — 全连接层内部激活的 dropout 比率。 - init_std (
float
, 可选, 默认为 0.02) — 用于初始化所有权重矩阵的 truncated_normal_initializer 的标准差。 - init_xavier_std (
float
, 可选, 默认为 1) — 用于 HM Attention map 模块中 Xavier 初始化增益的缩放因子。 - encoder_layerdrop (
float
, 可选, 默认为 0.0) — 编码器的 LayerDrop 概率。有关更多详细信息,请参见 [LayerDrop 论文](see https://arxiv.org/abs/1909.11556)。 - decoder_layerdrop (
float
, 可选, 默认为 0.0) — 解码器的 LayerDrop 概率。有关更多详细信息,请参见 [LayerDrop 论文](see https://arxiv.org/abs/1909.11556)。 - auxiliary_loss (
bool
, 可选, 默认为False
) — 是否使用辅助解码损失(每个解码器层的损失)。 - position_embedding_type (
str
, 可选, 默认为"sine"
) — 要在图像特征之上使用的位置嵌入类型。"sine"
或"learned"
之一。 - backbone (
str
, 可选, 默认为"resnet50"
) — 当backbone_config
为None
时要使用的 backbone 名称。如果use_pretrained_backbone
为True
,这将从 timm 或 transformers 库加载相应的预训练权重。如果use_pretrained_backbone
为False
,这将加载 backbone 的配置并使用它来初始化具有随机权重的 backbone。 - use_pretrained_backbone (
bool
, 可选,True
) — 是否对 backbone 使用预训练权重。 - backbone_kwargs (
dict
, 可选) — 从检查点加载时要传递给 AutoBackbone 的关键字参数,例如{'out_indices': (0, 1, 2, 3)}
。如果设置了backbone_config
,则无法指定。 - dilation (
bool
, 可选, 默认为False
) — 是否在最后一个卷积块 (DC5) 中用空洞卷积替换步幅。仅当use_timm_backbone
=True
时才支持。 - class_cost (
float
, 可选, 默认为 1) — 匈牙利匹配代价中分类错误的相对权重。 - bbox_cost (
float
, 可选, 默认为 5) — 匈牙利匹配代价中边界框坐标 L1 误差的相对权重。 - giou_cost (
float
, 可选, 默认为 2) — 匈牙利匹配代价中边界框的广义 IoU 损失的相对权重。 - mask_loss_coefficient (
float
, 可选, 默认为 1) — 全景分割损失中 Focal 损失的相对权重。 - dice_loss_coefficient (
float
, 可选, 默认为 1) — 全景分割损失中 DICE/F-1 损失的相对权重。 - bbox_loss_coefficient (
float
, 可选, 默认为 5) — 对象检测损失中 L1 边界框损失的相对权重。 - giou_loss_coefficient (
float
, 可选, 默认为 2) — 对象检测损失中广义 IoU 损失的相对权重。 - eos_coefficient (
float
, 可选, 默认为 0.1) — 对象检测损失中 ‘无对象’ 类别分类的相对权重。
这是用于存储 DetrModel 配置的配置类。它用于根据指定的参数实例化 DETR 模型,定义模型架构。使用默认值实例化配置将产生与 DETR facebook/detr-resnet-50 架构类似的配置。
配置对象继承自 PretrainedConfig,可用于控制模型输出。有关更多信息,请阅读 PretrainedConfig 中的文档。
示例
>>> from transformers import DetrConfig, DetrModel
>>> # Initializing a DETR facebook/detr-resnet-50 style configuration
>>> configuration = DetrConfig()
>>> # Initializing a model (with random weights) from the facebook/detr-resnet-50 style configuration
>>> model = DetrModel(configuration)
>>> # Accessing the model configuration
>>> configuration = model.config
from_backbone_config
< source >( backbone_config: PretrainedConfig **kwargs ) → DetrConfig
从预训练的骨干模型配置实例化 DetrConfig (或派生类)。
DetrImageProcessor
class transformers.DetrImageProcessor
< source >( format: typing.Union[str, transformers.image_utils.AnnotationFormat] = <AnnotationFormat.COCO_DETECTION: 'coco_detection'> do_resize: bool = True size: typing.Dict[str, int] = None resample: Resampling = <Resampling.BILINEAR: 2> do_rescale: bool = True rescale_factor: typing.Union[int, float] = 0.00392156862745098 do_normalize: bool = True image_mean: typing.Union[float, typing.List[float]] = None image_std: typing.Union[float, typing.List[float]] = None do_convert_annotations: typing.Optional[bool] = None do_pad: bool = True pad_size: typing.Optional[typing.Dict[str, int]] = None **kwargs )
参数
- format (
str
, 可选, 默认为"coco_detection"
) — 注释的数据格式。为 “coco_detection” 或 “coco_panoptic” 之一。 - do_resize (
bool
, 可选, 默认为True
) — 控制是否将图像的(高度, 宽度)
尺寸调整为指定的size
。可以被preprocess
方法中的do_resize
参数覆盖。 - size (
Dict[str, int]
可选, 默认为{"shortest_edge" -- 800, "longest_edge": 1333}
): 调整大小后图像的(高度, 宽度)
尺寸大小。可以被preprocess
方法中的size
参数覆盖。可用选项包括:{"height": int, "width": int}
: 图像将被调整为精确尺寸(高度, 宽度)
。不保持宽高比。{"shortest_edge": int, "longest_edge": int}
: 图像将被调整为最大尺寸,同时保持宽高比,并保持最短边小于或等于shortest_edge
,最长边小于或等于longest_edge
。{"max_height": int, "max_width": int}
: 图像将被调整为最大尺寸,同时保持宽高比,并保持高度小于或等于max_height
,宽度小于或等于max_width
。
- resample (
PILImageResampling
, 可选, 默认为PILImageResampling.BILINEAR
) — 如果调整图像大小,则使用的重采样过滤器。 - 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_DEFAULT_MEAN
) — 标准化图像时使用的均值。可以是单个值或值列表,每个通道一个值。可以被preprocess
方法中的image_mean
参数覆盖。 - image_std (
float
或List[float]
, 可选, 默认为IMAGENET_DEFAULT_STD
) — 标准化图像时使用的标准差值。可以是单个值或值列表,每个通道一个值。可以被preprocess
方法中的image_std
参数覆盖。 - do_convert_annotations (
bool
, 可选, 默认为True
) — 控制是否将注释转换为 DETR 模型期望的格式。将边界框转换为(center_x, center_y, width, height)
格式,并在[0, 1]
范围内。可以被preprocess
方法中的do_convert_annotations
参数覆盖。 - do_pad (
bool
, 可选, 默认为True
) — 控制是否填充图像。可以被preprocess
方法中的do_pad
参数覆盖。如果为True
,则将在图像的底部和右侧填充零。如果提供了pad_size
,则图像将被填充到指定的尺寸。否则,图像将被填充到批次中的最大高度和宽度。 - pad_size (
Dict[str, int]
, 可选) — 要将图像填充到的尺寸{"height": int, "width" int}
。必须大于任何为预处理提供的图像尺寸。如果未提供pad_size
,则图像将填充到批次中最大的高度和宽度。
构造 Detr 图像处理器。
preprocess
< source >( images: typing.Union[ForwardRef('PIL.Image.Image'), numpy.ndarray, ForwardRef('torch.Tensor'), list['PIL.Image.Image'], list[numpy.ndarray], list['torch.Tensor']] annotations: typing.Union[dict[str, typing.Union[int, str, list[dict]]], typing.List[dict[str, typing.Union[int, str, list[dict]]]], NoneType] = None return_segmentation_masks: bool = None masks_path: typing.Union[str, pathlib.Path, NoneType] = None do_resize: typing.Optional[bool] = None size: typing.Optional[typing.Dict[str, int]] = None resample = None do_rescale: typing.Optional[bool] = None rescale_factor: typing.Union[int, float, NoneType] = None do_normalize: typing.Optional[bool] = None do_convert_annotations: typing.Optional[bool] = None image_mean: typing.Union[float, typing.List[float], NoneType] = None image_std: typing.Union[float, typing.List[float], NoneType] = None do_pad: typing.Optional[bool] = None format: typing.Union[str, transformers.image_utils.AnnotationFormat, NoneType] = None return_tensors: typing.Union[str, transformers.utils.generic.TensorType, NoneType] = None data_format: typing.Union[str, transformers.image_utils.ChannelDimension] = <ChannelDimension.FIRST: 'channels_first'> input_data_format: typing.Union[str, transformers.image_utils.ChannelDimension, NoneType] = None pad_size: typing.Optional[typing.Dict[str, int]] = None **kwargs )
参数
- images (
ImageInput
) — 要预处理的图像或批量图像。 期望像素值范围为 0 到 255 的单张或批量图像。 如果传入像素值介于 0 和 1 之间的图像,请设置do_rescale=False
。 - annotations (
AnnotationType
或List[AnnotationType]
, 可选) — 与图像或批量图像关联的注释列表。 如果注释用于对象检测,则注释应为包含以下键的字典:- “image_id” (
int
): 图像 ID。 - “annotations” (
List[Dict]
): 图像的注释列表。 每个注释都应是一个字典。 图像可以没有注释,在这种情况下,列表应为空。 如果注释用于分割,则注释应为包含以下键的字典: - “image_id” (
int
): 图像 ID。 - “segments_info” (
List[Dict]
): 图像的分割列表。 每个分割都应是一个字典。 图像可以没有分割,在这种情况下,列表应为空。 - “file_name” (
str
): 图像的文件名。
- “image_id” (
- return_segmentation_masks (
bool
, 可选, 默认为 self.return_segmentation_masks) — 是否返回分割掩码。 - masks_path (
str
或pathlib.Path
, 可选) — 包含分割掩码的目录的路径。 - do_resize (
bool
, 可选, 默认为 self.do_resize) — 是否调整图像大小。 - size (
Dict[str, int]
, 可选, 默认为 self.size) — 调整大小后图像的(height, width)
尺寸大小。 可用选项包括:{"height": int, "width": int}
: 图像将被调整为精确尺寸(height, width)
。 请勿保持纵横比。{"shortest_edge": int, "longest_edge": int}
: 图像将被调整为最大尺寸,同时保持纵横比,并保持最短边小于或等于shortest_edge
,最长边小于或等于longest_edge
。{"max_height": int, "max_width": int}
: 图像将被调整为最大尺寸,同时保持纵横比,并保持高度小于或等于max_height
,宽度小于或等于max_width
。
- resample (
PILImageResampling
, 可选, 默认为 self.resample) — 调整图像大小时使用的重采样过滤器。 - do_rescale (
bool
, 可选, 默认为 self.do_rescale) — 是否重新缩放图像。 - rescale_factor (
float
, 可选, 默认为 self.rescale_factor) — 重新缩放图像时使用的重新缩放因子。 - do_normalize (
bool
, 可选, 默认为 self.do_normalize) — 是否标准化图像。 - do_convert_annotations (
bool
, 可选, 默认为 self.do_convert_annotations) — 是否将注释转换为模型期望的格式。 将边界框从(top_left_x, top_left_y, width, height)
格式转换为(center_x, center_y, width, height)
格式,并使用相对坐标。 - image_mean (
float
或List[float]
, 可选, 默认为 self.image_mean) — 标准化图像时使用的均值。 - image_std (
float
或List[float]
, 可选, 默认为 self.image_std) — 标准化图像时使用的标准差。 - do_pad (
bool
, 可选, 默认为 self.do_pad) — 是否填充图像。 如果为True
,则填充将应用于图像的底部和右侧,并使用零填充。 如果提供了pad_size
,则图像将被填充到指定的尺寸。 否则,图像将被填充到批次中的最大高度和宽度。 - format (
str
或AnnotationFormat
, 可选, 默认为 self.format) — 注释的格式。 - return_tensors (
str
或TensorType
, 可选, 默认为 self.return_tensors) — 要返回的张量类型。 如果为None
,将返回图像列表。 - data_format (
ChannelDimension
或str
, 可选, 默认为ChannelDimension.FIRST
) — 输出图像的通道维度格式。 可以是以下之一:"channels_first"
或ChannelDimension.FIRST
: 格式为 (num_channels, height, width) 的图像。"channels_last"
或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) 的图像。
- pad_size (
Dict[str, int]
, 可选) — 将图像填充到的尺寸{"height": int, "width" int}
。 必须大于为预处理提供的任何图像尺寸。 如果未提供pad_size
,则图像将填充到批次中的最大高度和宽度。
预处理单张或批量图像,以便模型可以使用。
post_process_object_detection
< source >( outputs threshold: float = 0.5 target_sizes: typing.Union[transformers.utils.generic.TensorType, typing.List[typing.Tuple]] = None ) → List[Dict]
将 DetrForObjectDetection 的原始输出转换为 (top_left_x, top_left_y, bottom_right_x, bottom_right_y) 格式的最终边界框。仅支持 PyTorch。
post_process_semantic_segmentation
< source >( outputs target_sizes: typing.List[typing.Tuple[int, int]] = None ) → List[torch.Tensor]
参数
- outputs (DetrForSegmentation) — 模型的原始输出。
- target_sizes (
List[Tuple[int, int]]
, 可选) — 包含批次中每张图像的目标尺寸(高度,宽度)的元组列表 (Tuple[int, int]
)。如果未设置,则不会调整预测大小。
返回
List[torch.Tensor]
长度为 batch_size
的列表,其中每个项目是形状为 (height, width) 的语义分割图,对应于 target_sizes 条目(如果指定了 target_sizes
)。每个 torch.Tensor
的每个条目对应一个语义类别 ID。
将 DetrForSegmentation 的输出转换为语义分割图。仅支持 PyTorch。
post_process_instance_segmentation
< source >( outputs threshold: float = 0.5 mask_threshold: float = 0.5 overlap_mask_area_threshold: float = 0.8 target_sizes: typing.Optional[typing.List[typing.Tuple[int, int]]] = None return_coco_annotation: typing.Optional[bool] = False ) → List[Dict]
参数
- outputs (DetrForSegmentation) — 模型的原始输出。
- threshold (
float
, 可选, 默认为 0.5) — 保留预测实例掩码的概率分数阈值。 - mask_threshold (
float
, 可选, 默认为 0.5) — 将预测掩码转换为二值时使用的阈值。 - overlap_mask_area_threshold (
float
, 可选, 默认为 0.8) — 重叠掩码区域阈值,用于合并或丢弃每个二值实例掩码内的小的、不连接的部分。 - target_sizes (
List[Tuple]
, 可选) — 长度为 (batch_size) 的列表,其中每个列表项 (Tuple[int, int]]
) 对应于每个预测的请求最终尺寸(高度,宽度)。如果未设置,则不会调整预测大小。 - return_coco_annotation (
bool
, 可选) — 默认为False
。如果设置为True
,则分割图以 COCO 游程编码 (RLE) 格式返回。
返回
List[Dict]
每个图像的字典列表,每个字典包含两个键
- segmentation — 形状为
(height, width)
的张量,其中每个像素代表一个segment_id
,或者如果 return_coco_annotation 设置为True
,则为分割图的List[List]
游程编码 (RLE)。 如果未找到高于threshold
的掩码,则设置为None
。 - segments_info — 一个字典,包含每个分割的附加信息。
- id — 代表
segment_id
的整数。 - label_id — 代表与
segment_id
对应的标签/语义类别 ID 的整数。 - score —
segment_id
分割的预测分数。
- id — 代表
将 DetrForSegmentation 的输出转换为实例分割预测。仅支持 PyTorch。
post_process_panoptic_segmentation
< source >( outputs threshold: float = 0.5 mask_threshold: float = 0.5 overlap_mask_area_threshold: float = 0.8 label_ids_to_fuse: typing.Optional[typing.Set[int]] = None target_sizes: typing.Optional[typing.List[typing.Tuple[int, int]]] = None ) → List[Dict]
参数
- outputs (DetrForSegmentation) — 来自 DetrForSegmentation 的输出。
- threshold (
float
, 可选, 默认为 0.5) — 保留预测实例掩码的概率分数阈值。 - mask_threshold (
float
, 可选, 默认为 0.5) — 将预测掩码转换为二值时使用的阈值。 - overlap_mask_area_threshold (
float
, 可选, 默认为 0.8) — 重叠掩码区域阈值,用于合并或丢弃每个二值实例掩码内的小的、不连接的部分。 - label_ids_to_fuse (
Set[int]
, 可选) — 此状态下的标签将使其所有实例融合在一起。例如,我们可以说一张图像中只能有一个天空,但可以有多个人,因此天空的标签 ID 将在该集合中,但人员的标签 ID 不会。 - target_sizes (
List[Tuple]
, 可选) — 长度为 (batch_size) 的列表,其中每个列表项 (Tuple[int, int]]
) 对应于批次中每个预测的请求最终尺寸(高度,宽度)。如果未设置,则不会调整预测大小。
返回
List[Dict]
每个图像的字典列表,每个字典包含两个键
- segmentation — 形状为
(height, width)
的张量,其中每个像素代表一个segment_id
,或者如果未找到高于threshold
的掩码,则为None
。 如果指定了target_sizes
,则分割将被调整为相应的target_sizes
条目。 - segments_info — 一个字典,包含每个分割的附加信息。
- id — 代表
segment_id
的整数。 - label_id — 代表与
segment_id
对应的标签/语义类别 ID 的整数。 - was_fused — 一个布尔值,如果
label_id
在label_ids_to_fuse
中,则为True
,否则为False
。 同一类别/标签的多个实例被融合并分配了单个segment_id
。 - score —
segment_id
分割的预测分数。
- id — 代表
将 DetrForSegmentation 的输出转换为图像全景分割预测。仅支持 PyTorch。
DetrImageProcessorFast
class transformers.DetrImageProcessorFast
< source >( **kwargs: typing_extensions.Unpack[transformers.models.detr.image_processing_detr_fast.DetrFastImageProcessorKwargs] )
参数
- do_resize (
bool
, 可选, 默认为self.do_resize
) — 是否将图像的(高度,宽度)尺寸调整为指定的size
。可以被preprocess
方法中的do_resize
参数覆盖。 - size (
dict
, 可选, 默认为self.size
) — 调整大小后输出图像的大小。可以被preprocess
方法中的size
参数覆盖。 - default_to_square (
bool
, 可选, 默认为self.default_to_square
) — 如果 size 是整数,是否默认调整为方形图像。 - resample (
PILImageResampling
, 可选, 默认为self.resample
) — 如果调整图像大小,则使用的重采样过滤器。 仅当do_resize
设置为True
时才有效。 可以被preprocess
方法中的resample
参数覆盖。 - do_center_crop (
bool
, optional, defaults toself.do_center_crop
) — 是否将图像中心裁剪到指定的crop_size
。可以被preprocess
方法中的do_center_crop
参数覆盖。 - crop_size (
Dict[str, int]
optional, defaults toself.crop_size
) — 应用center_crop
后输出图像的尺寸。可以被preprocess
方法中的crop_size
参数覆盖。 - do_rescale (
bool
, optional, defaults toself.do_rescale
) — 是否按照指定的缩放比例rescale_factor
缩放图像。可以被preprocess
方法中的do_rescale
参数覆盖。 - rescale_factor (
int
orfloat
, optional, defaults toself.rescale_factor
) — 如果要缩放图像,则使用的缩放因子。仅当do_rescale
设置为True
时才有效。可以被preprocess
方法中的rescale_factor
参数覆盖。 - do_normalize (
bool
, optional, defaults toself.do_normalize
) — 是否对图像进行归一化。可以被preprocess
方法中的do_normalize
参数覆盖。可以被preprocess
方法中的do_normalize
参数覆盖。 - image_mean (
float
orList[float]
, optional, defaults toself.image_mean
) — 如果要归一化图像,则使用的均值。这是一个浮点数或浮点数列表,其长度等于图像中的通道数。可以被preprocess
方法中的image_mean
参数覆盖。可以被preprocess
方法中的image_mean
参数覆盖。 - image_std (
float
orList[float]
, optional, defaults toself.image_std
) — 如果要归一化图像,则使用的标准差。这是一个浮点数或浮点数列表,其长度等于图像中的通道数。可以被preprocess
方法中的image_std
参数覆盖。可以被preprocess
方法中的image_std
参数覆盖。 - do_convert_rgb (
bool
, optional, defaults toself.do_convert_rgb
) — 是否将图像转换为 RGB 格式。 - return_tensors (
str
orTensorType
, optional, defaults toself.return_tensors
) — 如果设置为 `pt`,则返回堆叠的张量,否则返回张量列表。 - data_format (
ChannelDimension
orstr
, optional, defaults toself.data_format
) — 仅支持ChannelDimension.FIRST
。为了与慢速处理器兼容而添加。 - input_data_format (
ChannelDimension
orstr
, optional, defaults toself.input_data_format
) — 输入图像的通道维度格式。如果未设置,则通道维度格式从输入图像推断。可以是以下之一:"channels_first"
或ChannelDimension.FIRST
:图像格式为 (num_channels, height, width)。"channels_last"
或ChannelDimension.LAST
:图像格式为 (height, width, num_channels)。"none"
或ChannelDimension.NONE
:图像格式为 (height, width)。
- device (
torch.device
, optional, defaults toself.device
) — 处理图像的设备。如果未设置,则设备从输入图像推断。 - format (
str
, optional, defaults toAnnotationFormat.COCO_DETECTION
) — 注释的数据格式。可以是 “coco_detection” 或 “coco_panoptic” 之一。 - do_convert_annotations (
bool
, optional, defaults toTrue
) — 控制是否将注释转换为 DETR 模型期望的格式。将边界框转换为(center_x, center_y, width, height)
格式,并在[0, 1]
范围内。可以被preprocess
方法中的do_convert_annotations
参数覆盖。 - do_pad (
bool
, optional, defaults toTrue
) — 控制是否填充图像。可以被preprocess
方法中的do_pad
参数覆盖。如果为True
,则将在图像的底部和右侧填充零。如果提供了pad_size
,则图像将被填充到指定的尺寸。否则,图像将被填充到批次中的最大高度和宽度。 - pad_size (
Dict[str, int]
, optional) — 要将图像填充到的尺寸{"height": int, "width" int}
。必须大于为预处理提供的任何图像尺寸。如果未提供pad_size
,则图像将被填充到批次中最大的高度和宽度。 - return_segmentation_masks (
bool
, optional, defaults toFalse
) — 是否返回分割掩码。
构建一个快速的 Detr 图像处理器。
preprocess
< source >( images: typing.Union[ForwardRef('PIL.Image.Image'), numpy.ndarray, ForwardRef('torch.Tensor'), list['PIL.Image.Image'], list[numpy.ndarray], list['torch.Tensor']] annotations: typing.Union[dict[str, typing.Union[int, str, list[dict]]], typing.List[dict[str, typing.Union[int, str, list[dict]]]], NoneType] = None masks_path: typing.Union[str, pathlib.Path, NoneType] = None **kwargs: typing_extensions.Unpack[transformers.models.detr.image_processing_detr_fast.DetrFastImageProcessorKwargs] )
参数
- images (
ImageInput
) — 要预处理的图像。 期望是像素值范围为 0 到 255 的单个或批量图像。如果传入像素值在 0 到 1 之间的图像,请设置do_rescale=False
。 - do_resize (
bool
, optional, defaults toself.do_resize
) — 是否调整图像大小。 - size (
Dict[str, int]
, optional, defaults toself.size
) — 描述模型接受的最大输入尺寸。 - resample (
PILImageResampling
orInterpolationMode
, optional, defaults toself.resample
) — 如果调整图像大小,则使用的重采样过滤器。可以是枚举PILImageResampling
之一。仅当do_resize
设置为True
时才有效。 - do_center_crop (
bool
, optional, defaults toself.do_center_crop
) — 是否对图像进行中心裁剪。 - crop_size (
Dict[str, int]
, optional, defaults toself.crop_size
) — 应用center_crop
后输出图像的尺寸。 - do_rescale (
bool
, optional, defaults toself.do_rescale
) — 是否缩放图像。 - rescale_factor (
float
, optional, defaults toself.rescale_factor
) — 如果do_rescale
设置为True
,则用于缩放图像的缩放因子。 - do_normalize (
bool
, optional, defaults toself.do_normalize
) — 是否对图像进行归一化。 - image_mean (
float
orList[float]
, optional, defaults toself.image_mean
) — 用于归一化的图像均值。仅当do_normalize
设置为True
时才有效。 - image_std (
float
orList[float]
, optional, defaults toself.image_std
) — 用于归一化的图像标准差。仅当do_normalize
设置为True
时才有效。 - do_convert_rgb (
bool
, optional, defaults toself.do_convert_rgb
) — 是否将图像转换为 RGB 格式。 - return_tensors (
str
orTensorType
, optional, defaults toself.return_tensors
) — 如果设置为 `pt`,则返回堆叠的张量,否则返回张量列表。 - data_format (
ChannelDimension
orstr
, optional, defaults toself.data_format
) — 仅支持ChannelDimension.FIRST
。 为了与慢速处理器兼容而添加。 - input_data_format (
ChannelDimension
orstr
, optional, defaults toself.input_data_format
) — 输入图像的通道维度格式。 如果未设置,则通道维度格式将从输入图像中推断。 可以是以下之一:"channels_first"
或ChannelDimension.FIRST
:(num_channels, height, width) 格式的图像。"channels_last"
或ChannelDimension.LAST
:(height, width, num_channels) 格式的图像。"none"
或ChannelDimension.NONE
:(height, width) 格式的图像。
- device (
torch.device
, optional, defaults toself.device
) — 处理图像的设备。 如果未设置,则设备将从输入图像中推断。 - annotations (
AnnotationType
orList[AnnotationType]
, optional) — 与图像或图像批次关联的注释列表。 如果注释用于对象检测,则注释应为具有以下键的字典:- “image_id” (
int
):图像 ID。 - “annotations” (
List[Dict]
):图像的注释列表。 每个注释应为一个字典。 图像可以没有注释,在这种情况下,列表应为空。 如果注释用于分割,则注释应为具有以下键的字典: - “image_id” (
int
):图像 ID。 - “segments_info” (
List[Dict]
):图像的分割列表。 每个分割应为一个字典。 图像可以没有分割,在这种情况下,列表应为空。 - “file_name” (
str
):图像的文件名。
- “image_id” (
- format (
str
, optional, defaults toAnnotationFormat.COCO_DETECTION
) — 注释的数据格式。 “coco_detection” 或 “coco_panoptic” 之一。 - do_convert_annotations (
bool
, optional, defaults toTrue
) — 控制是否将注释转换为 DETR 模型期望的格式。 将边界框转换为(center_x, center_y, width, height)
格式,并在[0, 1]
范围内。 可以通过preprocess
方法中的do_convert_annotations
参数覆盖。 - do_pad (
bool
, optional, defaults toTrue
) — 控制是否填充图像。 可以通过preprocess
方法中的do_pad
参数覆盖。 如果为True
,则将在图像的底部和右侧填充零。 如果提供了pad_size
,则图像将被填充到指定的尺寸。 否则,图像将被填充到批次的最大高度和宽度。 - pad_size (
Dict[str, int]
, optional) — 要将图像填充到的尺寸{"height": int, "width" int}
。 必须大于任何提供的用于预处理的图像尺寸。 如果未提供pad_size
,则图像将被填充到批次中最大的高度和宽度。 - return_segmentation_masks (
bool
, optional, defaults toFalse
) — 是否返回分割掩码。 - masks_path (
str
orpathlib.Path
, optional) — 包含分割掩码的目录路径。
预处理图像或图像批次。
post_process_object_detection
< source >( outputs threshold: float = 0.5 target_sizes: typing.Union[transformers.utils.generic.TensorType, typing.List[typing.Tuple]] = None ) → List[Dict]
参数
- outputs (
DetrObjectDetectionOutput
) — 模型的原始输出。 - threshold (
float
, optional) — 保留对象检测预测的分数阈值。 - target_sizes (
torch.Tensor
orList[Tuple[int, int]]
, optional) — 形状为(batch_size, 2)
的张量或元组列表 (Tuple[int, int]
),其中包含批次中每张图像的目标尺寸(height, width)
。 如果未设置,则不会调整预测大小。
返回
List[Dict]
模型预测的批次中每张图像的字典列表,每个字典包含图像的分数、标签和边界框。
将 DetrForObjectDetection 的原始输出转换为 (top_left_x, top_left_y, bottom_right_x, bottom_right_y) 格式的最终边界框。仅支持 PyTorch。
post_process_semantic_segmentation
< source >( outputs target_sizes: typing.List[typing.Tuple[int, int]] = None ) → List[torch.Tensor]
参数
- outputs (DetrForSegmentation) — 模型的原始输出。
- target_sizes (
List[Tuple[int, int]]
, optional) — 元组列表 (Tuple[int, int]
),其中包含批次中每张图像的目标尺寸(高度,宽度)。 如果未设置,则不会调整预测大小。
返回
List[torch.Tensor]
长度为 batch_size
的列表,其中每个项目是形状为 (height, width) 的语义分割图,对应于 target_sizes 条目(如果指定了 target_sizes
)。每个 torch.Tensor
的每个条目对应一个语义类别 ID。
将 DetrForSegmentation 的输出转换为语义分割图。仅支持 PyTorch。
post_process_instance_segmentation
< source >( outputs threshold: float = 0.5 mask_threshold: float = 0.5 overlap_mask_area_threshold: float = 0.8 target_sizes: typing.Optional[typing.List[typing.Tuple[int, int]]] = None return_coco_annotation: typing.Optional[bool] = False ) → List[Dict]
参数
- outputs (DetrForSegmentation) — 模型的原始输出。
- threshold (
float
, optional, defaults to 0.5) — 保留预测实例掩码的概率分数阈值。 - mask_threshold (
float
, optional, defaults to 0.5) — 将预测掩码转换为二进制值时使用的阈值。 - overlap_mask_area_threshold (
float
, optional, defaults to 0.8) — 重叠掩码区域阈值,用于合并或丢弃每个二进制实例掩码内的小型不连贯部分。 - target_sizes (
List[Tuple]
, optional) — 长度为 (batch_size) 的列表,其中每个列表项 (Tuple[int, int]]
) 对应于每个预测请求的最终尺寸(高度,宽度)。 如果未设置,则不会调整预测大小。 - return_coco_annotation (
bool
, optional) — 默认为False
。如果设置为True
,则分割图以 COCO 运行长度编码 (RLE) 格式返回。
返回
List[Dict]
每个图像的字典列表,每个字典包含两个键
- segmentation — 形状为
(height, width)
的张量,其中每个像素代表一个segment_id
,或者如果 return_coco_annotation 设置为True
,则为分割图的List[List]
游程编码 (RLE)。 如果未找到高于threshold
的掩码,则设置为None
。 - segments_info — 一个字典,包含每个分割的附加信息。
- id — 代表
segment_id
的整数。 - label_id — 代表与
segment_id
对应的标签/语义类别 ID 的整数。 - score —
segment_id
分割的预测分数。
- id — 代表
将 DetrForSegmentation 的输出转换为实例分割预测。仅支持 PyTorch。
post_process_panoptic_segmentation
< source >( outputs threshold: float = 0.5 mask_threshold: float = 0.5 overlap_mask_area_threshold: float = 0.8 label_ids_to_fuse: typing.Optional[typing.Set[int]] = None target_sizes: typing.Optional[typing.List[typing.Tuple[int, int]]] = None ) → List[Dict]
参数
- outputs (DetrForSegmentation) — 来自 DetrForSegmentation 的输出。
- threshold (
float
, optional, 默认为 0.5) — 用于保留预测实例掩码的概率分数阈值。 - mask_threshold (
float
, optional, 默认为 0.5) — 将预测掩码转换为二值时使用的阈值。 - overlap_mask_area_threshold (
float
, optional, 默认为 0.8) — 用于合并或丢弃每个二值实例掩码内的小的、不连接部分的重叠掩码区域阈值。 - label_ids_to_fuse (
Set[int]
, optional) — 在此状态下的标签将使其所有实例融合在一起。例如,我们可以说一张图像中只能有一个天空,但可以有多个人,因此天空的标签 ID 将在该集合中,但人的标签 ID 不会在其中。 - target_sizes (
List[Tuple]
, optional) — 长度为 (batch_size) 的列表,其中每个列表项 (Tuple[int, int]]
) 对应于批次中每个预测的请求最终大小(高度,宽度)。如果未设置,则不会调整预测大小。
返回
List[Dict]
每个图像的字典列表,每个字典包含两个键
- segmentation — 形状为
(height, width)
的张量,其中每个像素代表一个segment_id
,或者如果未找到高于threshold
的掩码,则为None
。 如果指定了target_sizes
,则分割将被调整为相应的target_sizes
条目。 - segments_info — 一个字典,包含每个分割的附加信息。
- id — 代表
segment_id
的整数。 - label_id — 代表与
segment_id
对应的标签/语义类别 ID 的整数。 - was_fused — 一个布尔值,如果
label_id
在label_ids_to_fuse
中,则为True
,否则为False
。 同一类别/标签的多个实例被融合并分配了单个segment_id
。 - score —
segment_id
分割的预测分数。
- id — 代表
将 DetrForSegmentation 的输出转换为图像全景分割预测。仅支持 PyTorch。
DetrFeatureExtractor
预处理图像或一批图像。
post_process_object_detection
< source >( outputs threshold: float = 0.5 target_sizes: typing.Union[transformers.utils.generic.TensorType, typing.List[typing.Tuple]] = None ) → List[Dict]
参数
- outputs (
DetrObjectDetectionOutput
) — 模型的原始输出。 - threshold (
float
, optional) — 用于保留对象检测预测的分数阈值。 - target_sizes (
torch.Tensor
或List[Tuple[int, int]]
, optional) — 形状为(batch_size, 2)
的张量或元组列表 (Tuple[int, int]
),其中包含批次中每张图像的目标大小(height, width)
。如果未设置,则不会调整预测大小。
返回
List[Dict]
模型预测的批次中每张图像的字典列表,每个字典包含图像的分数、标签和边界框。
将 DetrForObjectDetection 的原始输出转换为 (top_left_x, top_left_y, bottom_right_x, bottom_right_y) 格式的最终边界框。仅支持 PyTorch。
post_process_semantic_segmentation
< source >( outputs target_sizes: typing.List[typing.Tuple[int, int]] = None ) → List[torch.Tensor]
参数
- outputs (DetrForSegmentation) — 模型的原始输出。
- target_sizes (
List[Tuple[int, int]]
, optional) — 元组列表 (Tuple[int, int]
),其中包含批次中每张图像的目标大小(高度,宽度)。如果未设置,则不会调整预测大小。
返回
List[torch.Tensor]
长度为 batch_size
的列表,其中每个项目是形状为 (height, width) 的语义分割图,对应于 target_sizes 条目(如果指定了 target_sizes
)。每个 torch.Tensor
的每个条目对应一个语义类别 ID。
将 DetrForSegmentation 的输出转换为语义分割图。仅支持 PyTorch。
post_process_instance_segmentation
< source >( outputs threshold: float = 0.5 mask_threshold: float = 0.5 overlap_mask_area_threshold: float = 0.8 target_sizes: typing.Optional[typing.List[typing.Tuple[int, int]]] = None return_coco_annotation: typing.Optional[bool] = False ) → List[Dict]
参数
- outputs (DetrForSegmentation) — 模型的原始输出。
- threshold (
float
, optional, 默认为 0.5) — 用于保留预测实例掩码的概率分数阈值。 - mask_threshold (
float
, optional, 默认为 0.5) — 将预测掩码转换为二值时使用的阈值。 - overlap_mask_area_threshold (
float
, optional, 默认为 0.8) — 用于合并或丢弃每个二值实例掩码内的小的、不连接部分的重叠掩码区域阈值。 - target_sizes (
List[Tuple]
, optional) — 长度为 (batch_size) 的列表,其中每个列表项 (Tuple[int, int]]
) 对应于每个预测的请求最终大小(高度,宽度)。如果未设置,则不会调整预测大小。 - return_coco_annotation (
bool
, optional) — 默认为False
。如果设置为True
,则分割图以 COCO 运行长度编码 (RLE) 格式返回。
返回
List[Dict]
每个图像的字典列表,每个字典包含两个键
- segmentation — 形状为
(height, width)
的张量,其中每个像素代表一个segment_id
,或者如果 return_coco_annotation 设置为True
,则为分割图的List[List]
游程编码 (RLE)。 如果未找到高于threshold
的掩码,则设置为None
。 - segments_info — 一个字典,包含每个分割的附加信息。
- id — 代表
segment_id
的整数。 - label_id — 代表与
segment_id
对应的标签/语义类别 ID 的整数。 - score —
segment_id
分割的预测分数。
- id — 代表
将 DetrForSegmentation 的输出转换为实例分割预测。仅支持 PyTorch。
post_process_panoptic_segmentation
< source >( outputs threshold: float = 0.5 mask_threshold: float = 0.5 overlap_mask_area_threshold: float = 0.8 label_ids_to_fuse: typing.Optional[typing.Set[int]] = None target_sizes: typing.Optional[typing.List[typing.Tuple[int, int]]] = None ) → List[Dict]
参数
- outputs (DetrForSegmentation) — 来自 DetrForSegmentation 的输出。
- threshold (
float
, 可选, 默认为 0.5) — 保留预测实例掩码的概率分数阈值。 - mask_threshold (
float
, 可选, 默认为 0.5) — 将预测的掩码转换为二值时使用的阈值。 - overlap_mask_area_threshold (
float
, 可选, 默认为 0.8) — 用于合并或丢弃每个二值实例掩码内的小型不连贯部分的重叠掩码区域阈值。 - label_ids_to_fuse (
Set[int]
, 可选) — 此状态下的标签将使其所有实例融合在一起。例如,我们可以说一张图片中只能有一个天空,但可以有几个人,因此天空的标签 ID 将在该集合中,但人的标签 ID 不会在其中。 - target_sizes (
List[Tuple]
, 可选) — 长度为 (batch_size) 的列表,其中每个列表项 (Tuple[int, int]]
) 对应于批次中每个预测的请求的最终尺寸(高度,宽度)。如果未设置,则不会调整预测大小。
返回
List[Dict]
每个图像的字典列表,每个字典包含两个键
- segmentation — 形状为
(height, width)
的张量,其中每个像素代表一个segment_id
,或者如果未找到高于threshold
的掩码,则为None
。 如果指定了target_sizes
,则分割将被调整为相应的target_sizes
条目。 - segments_info — 一个字典,包含每个分割的附加信息。
- id — 代表
segment_id
的整数。 - label_id — 代表与
segment_id
对应的标签/语义类别 ID 的整数。 - was_fused — 一个布尔值,如果
label_id
在label_ids_to_fuse
中,则为True
,否则为False
。 同一类别/标签的多个实例被融合并分配了单个segment_id
。 - score —
segment_id
分割的预测分数。
- id — 代表
将 DetrForSegmentation 的输出转换为图像全景分割预测。仅支持 PyTorch。
DETR 特定输出
class transformers.models.detr.modeling_detr.DetrModelOutput
< source >( last_hidden_state: FloatTensor = None past_key_values: typing.Optional[typing.Tuple[typing.Tuple[torch.FloatTensor]]] = None decoder_hidden_states: typing.Optional[typing.Tuple[torch.FloatTensor, ...]] = None decoder_attentions: typing.Optional[typing.Tuple[torch.FloatTensor, ...]] = None cross_attentions: typing.Optional[typing.Tuple[torch.FloatTensor, ...]] = None encoder_last_hidden_state: typing.Optional[torch.FloatTensor] = None encoder_hidden_states: typing.Optional[typing.Tuple[torch.FloatTensor, ...]] = None encoder_attentions: typing.Optional[typing.Tuple[torch.FloatTensor, ...]] = None intermediate_hidden_states: typing.Optional[torch.FloatTensor] = None )
参数
- last_hidden_state (形状为
(batch_size, sequence_length, hidden_size)
的torch.FloatTensor
) — 模型解码器最后一层的输出处的隐藏状态序列。 - decoder_hidden_states (
tuple(torch.FloatTensor)
, 可选, 当传递output_hidden_states=True
或config.output_hidden_states=True
时返回) — 形状为(batch_size, sequence_length, hidden_size)
的torch.FloatTensor
元组(每个层的输出一个,加上嵌入层的输出一个)。解码器在每一层输出的隐藏状态,加上初始嵌入输出。 - decoder_attentions (
tuple(torch.FloatTensor)
, 可选, 当传递output_attentions=True
或config.output_attentions=True
时返回) — 形状为(batch_size, num_heads, sequence_length, sequence_length)
的torch.FloatTensor
元组(每层一个)。解码器的注意力权重,在注意力 softmax 之后,用于计算自注意力头中的加权平均值。 - cross_attentions (
tuple(torch.FloatTensor)
, 可选, 当传递output_attentions=True
或config.output_attentions=True
时返回) — 形状为(batch_size, num_heads, sequence_length, sequence_length)
的torch.FloatTensor
元组(每层一个)。解码器交叉注意力层的注意力权重,在注意力 softmax 之后,用于计算交叉注意力头中的加权平均值。 - encoder_last_hidden_state (形状为
(batch_size, sequence_length, hidden_size)
的torch.FloatTensor
, 可选) — 模型编码器最后一层的输出处的隐藏状态序列。 - encoder_hidden_states (
tuple(torch.FloatTensor)
, 可选, 当传递output_hidden_states=True
或config.output_hidden_states=True
时返回) — 形状为(batch_size, sequence_length, hidden_size)
的torch.FloatTensor
元组(每个层的输出一个,加上嵌入层的输出一个)。编码器在每一层输出的隐藏状态,加上初始嵌入输出。 - encoder_attentions (
tuple(torch.FloatTensor)
, 可选, 当传递output_attentions=True
或config.output_attentions=True
时返回) — 形状为(batch_size, num_heads, sequence_length, sequence_length)
的torch.FloatTensor
元组(每层一个)。编码器的注意力权重,在注意力 softmax 之后,用于计算自注意力头中的加权平均值。 - intermediate_hidden_states (形状为
(config.decoder_layers, batch_size, sequence_length, hidden_size)
的torch.FloatTensor
, 可选, 当config.auxiliary_loss=True
时返回) — 中间解码器激活,即每个解码器层的输出,每个都经过了 layernorm。
DETR 编码器-解码器模型输出的基类。此类向 Seq2SeqModelOutput 添加了一个属性,即中间解码器激活的可选堆栈,即每个解码器层的输出,每个都经过了 layernorm。当使用辅助解码损失训练模型时,这很有用。
class transformers.models.detr.modeling_detr.DetrObjectDetectionOutput
< source >( loss: typing.Optional[torch.FloatTensor] = None loss_dict: typing.Optional[typing.Dict] = None logits: FloatTensor = None pred_boxes: FloatTensor = None auxiliary_outputs: typing.Optional[typing.List[typing.Dict]] = None last_hidden_state: typing.Optional[torch.FloatTensor] = None decoder_hidden_states: typing.Optional[typing.Tuple[torch.FloatTensor]] = None decoder_attentions: typing.Optional[typing.Tuple[torch.FloatTensor]] = None cross_attentions: typing.Optional[typing.Tuple[torch.FloatTensor]] = None encoder_last_hidden_state: typing.Optional[torch.FloatTensor] = None encoder_hidden_states: typing.Optional[typing.Tuple[torch.FloatTensor]] = None encoder_attentions: typing.Optional[typing.Tuple[torch.FloatTensor]] = None )
参数
- loss (形状为
(1,)
的torch.FloatTensor
, 可选, 当提供labels
时返回) — 总损失,是用于类别预测的负对数似然(交叉熵)和边界框损失的线性组合。后者定义为 L1 损失和广义尺度不变 IoU 损失的线性组合。 - loss_dict (
Dict
, 可选) — 包含各个损失的字典。用于日志记录很有用。 - logits (形状为
(batch_size, num_queries, num_classes + 1)
的torch.FloatTensor
) — 所有查询的分类 logits(包括无对象)。 - pred_boxes (形状为
(batch_size, num_queries, 4)
的torch.FloatTensor
) — 所有查询的归一化框坐标,表示为 (center_x, center_y, width, height)。这些值在 [0, 1] 范围内归一化,相对于批次中每张单独图像的大小(忽略可能的填充)。您可以使用 post_process_object_detection() 来检索未归一化的边界框。 - auxiliary_outputs (
list[Dict]
, 可选) — 可选,仅当辅助损失激活时返回(即config.auxiliary_loss
设置为True
)并且提供了标签。它是字典列表,其中包含每个解码器层的上述两个键(logits
和pred_boxes
)。 - last_hidden_state (形状为
(batch_size, sequence_length, hidden_size)
的torch.FloatTensor
, 可选) — 模型解码器最后一层的输出处的隐藏状态序列。 - decoder_hidden_states (
tuple(torch.FloatTensor)
, 可选, 当传递output_hidden_states=True
或config.output_hidden_states=True
时返回) — 形状为(batch_size, sequence_length, hidden_size)
的torch.FloatTensor
元组(每个层的输出一个,加上嵌入层的输出一个)。解码器在每一层输出的隐藏状态,加上初始嵌入输出。 - decoder_attentions (
tuple(torch.FloatTensor)
, 可选, 当传入output_attentions=True
或config.output_attentions=True
时返回) —torch.FloatTensor
的元组(每个层一个),形状为(batch_size, num_heads, sequence_length, sequence_length)
。解码器的注意力权重,在注意力 softmax 之后,用于计算自注意力头中的加权平均。 - cross_attentions (
tuple(torch.FloatTensor)
, 可选, 当传入output_attentions=True
或config.output_attentions=True
时返回) —torch.FloatTensor
的元组(每个层一个),形状为(batch_size, num_heads, sequence_length, sequence_length)
。解码器交叉注意力层的注意力权重,在注意力 softmax 之后,用于计算交叉注意力头中的加权平均。 - encoder_last_hidden_state (形状为
(batch_size, sequence_length, hidden_size)
的torch.FloatTensor
, 可选) — 模型编码器最后一层的输出的隐藏状态序列。 - encoder_hidden_states (
tuple(torch.FloatTensor)
, 可选, 当传入output_hidden_states=True
或config.output_hidden_states=True
时返回) —torch.FloatTensor
的元组(对于嵌入输出 + 每个层的输出各一个),形状为(batch_size, sequence_length, hidden_size)
。编码器在每个层输出端的隐藏状态,加上初始嵌入输出。 - encoder_attentions (
tuple(torch.FloatTensor)
, 可选, 当传入output_attentions=True
或config.output_attentions=True
时返回) —torch.FloatTensor
的元组(每个层一个),形状为(batch_size, num_heads, sequence_length, sequence_length)
。编码器的注意力权重,在注意力 softmax 之后,用于计算自注意力头中的加权平均。
DetrForObjectDetection 的输出类型。
class transformers.models.detr.modeling_detr.DetrSegmentationOutput
< source >( loss: typing.Optional[torch.FloatTensor] = None loss_dict: typing.Optional[typing.Dict] = None logits: FloatTensor = None pred_boxes: FloatTensor = None pred_masks: FloatTensor = None auxiliary_outputs: typing.Optional[typing.List[typing.Dict]] = None last_hidden_state: typing.Optional[torch.FloatTensor] = None decoder_hidden_states: typing.Optional[typing.Tuple[torch.FloatTensor]] = None decoder_attentions: typing.Optional[typing.Tuple[torch.FloatTensor]] = None cross_attentions: typing.Optional[typing.Tuple[torch.FloatTensor]] = None encoder_last_hidden_state: typing.Optional[torch.FloatTensor] = None encoder_hidden_states: typing.Optional[typing.Tuple[torch.FloatTensor]] = None encoder_attentions: typing.Optional[typing.Tuple[torch.FloatTensor]] = None )
参数
- loss (形状为
(1,)
的torch.FloatTensor
, 可选, 当提供labels
时返回)) — 总损失,是用于类别预测的负对数似然(交叉熵)损失和边界框损失的线性组合。后者定义为 L1 损失和广义尺度不变 IoU 损失的线性组合。 - loss_dict (
Dict
, 可选) — 包含各个损失的字典。用于日志记录非常有用。 - logits (形状为
(batch_size, num_queries, num_classes + 1)
的torch.FloatTensor
) — 所有查询的分类 logits(包括无对象)。 - pred_boxes (形状为
(batch_size, num_queries, 4)
的torch.FloatTensor
) — 所有查询的归一化框坐标,表示为 (center_x, center_y, width, height)。这些值在 [0, 1] 范围内归一化,相对于批次中每个单独图像的大小(忽略可能的填充)。您可以使用 post_process_object_detection() 来检索未归一化的边界框。 - pred_masks (形状为
(batch_size, num_queries, height/4, width/4)
的torch.FloatTensor
) — 所有查询的分割掩码 logits。另请参阅 post_process_semantic_segmentation() 或 post_process_instance_segmentation() post_process_panoptic_segmentation() 以分别评估语义分割、实例分割和全景分割掩码。 - auxiliary_outputs (
list[Dict]
, 可选) — 可选,仅当辅助损失被激活时返回(即config.auxiliary_loss
设置为True
)且提供了标签。它是字典的列表,包含每个解码器层的上述两个键(logits
和pred_boxes
)。 - last_hidden_state (形状为
(batch_size, sequence_length, hidden_size)
的torch.FloatTensor
, 可选) — 模型解码器最后一层的输出的隐藏状态序列。 - decoder_hidden_states (
tuple(torch.FloatTensor)
, 可选, 当传入output_hidden_states=True
或config.output_hidden_states=True
时返回) —torch.FloatTensor
的元组(对于嵌入输出 + 每个层的输出各一个),形状为(batch_size, sequence_length, hidden_size)
。解码器在每个层输出端的隐藏状态,加上初始嵌入输出。 - decoder_attentions (
tuple(torch.FloatTensor)
, 可选, 当传入output_attentions=True
或config.output_attentions=True
时返回) —torch.FloatTensor
的元组(每个层一个),形状为(batch_size, num_heads, sequence_length, sequence_length)
。解码器的注意力权重,在注意力 softmax 之后,用于计算自注意力头中的加权平均。 - cross_attentions (
tuple(torch.FloatTensor)
, 可选, 当传入output_attentions=True
或config.output_attentions=True
时返回) —torch.FloatTensor
的元组(每个层一个),形状为(batch_size, num_heads, sequence_length, sequence_length)
。解码器交叉注意力层的注意力权重,在注意力 softmax 之后,用于计算交叉注意力头中的加权平均。 - encoder_last_hidden_state (形状为
(batch_size, sequence_length, hidden_size)
的torch.FloatTensor
, 可选) — 模型编码器最后一层的输出的隐藏状态序列。 - encoder_hidden_states (
tuple(torch.FloatTensor)
, 可选, 当传入output_hidden_states=True
或config.output_hidden_states=True
时返回) —torch.FloatTensor
的元组(对于嵌入输出 + 每个层的输出各一个),形状为(batch_size, sequence_length, hidden_size)
。编码器在每个层输出端的隐藏状态,加上初始嵌入输出。 - encoder_attentions (
tuple(torch.FloatTensor)
, 可选, 当传入output_attentions=True
或config.output_attentions=True
时返回) —torch.FloatTensor
的元组(每个层一个),形状为(batch_size, num_heads, sequence_length, sequence_length)
。编码器的注意力权重,在注意力 softmax 之后,用于计算自注意力头中的加权平均。
DetrForSegmentation 的输出类型。
DetrModel
class transformers.DetrModel
< source >( config: DetrConfig )
参数
- config (DetrConfig) — 带有模型所有参数的模型配置类。使用配置文件初始化不会加载与模型关联的权重,仅加载配置。查看 from_pretrained() 方法来加载模型权重。
裸 DETR 模型(由骨干网络和编码器-解码器 Transformer 组成)输出原始隐藏状态,顶部没有任何特定的头部。
此模型继承自 PreTrainedModel。查看超类文档,了解库为其所有模型实现的通用方法(例如下载或保存、调整输入嵌入大小、剪枝头等)。
此模型也是 PyTorch torch.nn.Module 子类。将其用作常规 PyTorch 模块,并参考 PyTorch 文档,了解与常规用法和行为相关的所有事项。
forward
< source >( pixel_values: FloatTensor pixel_mask: typing.Optional[torch.LongTensor] = None decoder_attention_mask: typing.Optional[torch.FloatTensor] = None encoder_outputs: typing.Optional[torch.FloatTensor] = None inputs_embeds: typing.Optional[torch.FloatTensor] = None decoder_inputs_embeds: typing.Optional[torch.FloatTensor] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None ) → transformers.models.detr.modeling_detr.DetrModelOutput 或 tuple(torch.FloatTensor)
参数
- pixel_values (形状为
(batch_size, num_channels, height, width)
的torch.FloatTensor
) — 像素值。如果您提供填充,默认情况下将被忽略。像素值可以使用 AutoImageProcessor 获得。 有关详细信息,请参阅 DetrImageProcessor.call()。
- pixel_mask (形状为
(batch_size, height, width)
的torch.LongTensor
, 可选) — 用于避免对填充像素值执行注意力的掩码。掩码值在[0, 1]
中选择:- 1 表示真实的像素(即未被掩码),
- 0 表示填充像素(即被掩码)。
- decoder_attention_mask (形状为
(batch_size, num_queries)
的torch.FloatTensor
, 可选) — 默认情况下不使用。 可用于掩盖对象查询。 - encoder_outputs (
tuple(tuple(torch.FloatTensor)
, 可选) — 元组由 (last_hidden_state
, 可选:hidden_states
, 可选:attentions
) 组成,形状为(batch_size, sequence_length, hidden_size)
的last_hidden_state
, 可选) 是编码器最后一层的输出处的隐藏状态序列。在解码器的交叉注意力中使用。 - inputs_embeds (形状为
(batch_size, sequence_length, hidden_size)
的torch.FloatTensor
, 可选) — 可选地,您可以选择直接传递图像的扁平化表示,而不是传递扁平化的特征图(骨干网络 + 投影层的输出)。 - decoder_inputs_embeds (形状为
(batch_size, num_queries, hidden_size)
的torch.FloatTensor
, 可选) — 可选地,您可以选择直接传递嵌入表示,而不是使用零张量初始化查询。 - output_attentions (
bool
, 可选) — 是否返回所有注意力层的注意力张量。 有关更多详细信息,请参阅返回张量下的attentions
。 - output_hidden_states (
bool
, 可选) — 是否返回所有层的隐藏状态。 有关更多详细信息,请参阅返回张量下的hidden_states
。 - return_dict (
bool
, 可选) — 是否返回 ModelOutput 而不是普通元组。
返回
transformers.models.detr.modeling_detr.DetrModelOutput 或 tuple(torch.FloatTensor)
一个 transformers.models.detr.modeling_detr.DetrModelOutput 或 torch.FloatTensor
的元组(如果传递 return_dict=False
或当 config.return_dict=False
时),包括取决于配置 (DetrConfig) 和输入的各种元素。
- last_hidden_state (形状为
(batch_size, sequence_length, hidden_size)
的torch.FloatTensor
) — 模型解码器最后一层输出处的隐藏状态序列。 - decoder_hidden_states (
tuple(torch.FloatTensor)
, 可选, 当传递output_hidden_states=True
或当config.output_hidden_states=True
时返回) —torch.FloatTensor
的元组(一个用于嵌入的输出 + 一个用于每层的输出),形状为(batch_size, sequence_length, hidden_size)
。 解码器在每层输出处的隐藏状态加上初始嵌入输出。 - decoder_attentions (
tuple(torch.FloatTensor)
, 可选, 当传递output_attentions=True
或当config.output_attentions=True
时返回) —torch.FloatTensor
的元组(每层一个),形状为(batch_size, num_heads, sequence_length, sequence_length)
。 解码器的注意力权重,在注意力 softmax 之后,用于计算自注意力头中的加权平均值。 - cross_attentions (
tuple(torch.FloatTensor)
, 可选, 当传递output_attentions=True
或当config.output_attentions=True
时返回) —torch.FloatTensor
的元组(每层一个),形状为(batch_size, num_heads, sequence_length, sequence_length)
。 解码器交叉注意力层的注意力权重,在注意力 softmax 之后,用于计算交叉注意力头中的加权平均值。 - encoder_last_hidden_state (形状为
(batch_size, sequence_length, hidden_size)
的torch.FloatTensor
, 可选) — 模型编码器最后一层输出处的隐藏状态序列。 - encoder_hidden_states (
tuple(torch.FloatTensor)
, 可选, 当传递output_hidden_states=True
或当config.output_hidden_states=True
时返回) —torch.FloatTensor
的元组(一个用于嵌入的输出 + 一个用于每层的输出),形状为(batch_size, sequence_length, hidden_size)
。 编码器在每层输出处的隐藏状态加上初始嵌入输出。 - encoder_attentions (
tuple(torch.FloatTensor)
, 可选, 当传递output_attentions=True
或当config.output_attentions=True
时返回) —torch.FloatTensor
的元组(每层一个),形状为(batch_size, num_heads, sequence_length, sequence_length)
。 编码器的注意力权重,在注意力 softmax 之后,用于计算自注意力头中的加权平均值。 - intermediate_hidden_states (形状为
(config.decoder_layers, batch_size, sequence_length, hidden_size)
的torch.FloatTensor
, 可选, 当config.auxiliary_loss=True
时返回) — 中间解码器激活,即每个解码器层的输出,每个解码器层都经过了层归一化。
DetrModel forward 方法,覆盖了 __call__
特殊方法。
尽管 forward 传递的配方需要在该函数中定义,但之后应该调用 Module
实例而不是此函数,因为前者负责运行预处理和后处理步骤,而后者会静默地忽略它们。
示例
>>> from transformers import AutoImageProcessor, DetrModel
>>> 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("facebook/detr-resnet-50")
>>> model = DetrModel.from_pretrained("facebook/detr-resnet-50")
>>> # prepare image for the model
>>> inputs = image_processor(images=image, return_tensors="pt")
>>> # forward pass
>>> outputs = model(**inputs)
>>> # the last hidden states are the final query embeddings of the Transformer decoder
>>> # these are of shape (batch_size, num_queries, hidden_size)
>>> last_hidden_states = outputs.last_hidden_state
>>> list(last_hidden_states.shape)
[1, 100, 256]
DetrForObjectDetection
class transformers.DetrForObjectDetection
< source >( config: DetrConfig )
参数
- config (DetrConfig) — 模型配置类,包含模型的所有参数。 使用配置文件初始化不会加载与模型关联的权重,仅加载配置。查看 from_pretrained() 方法加载模型权重。
DETR 模型(由骨干网络和编码器-解码器 Transformer 组成),顶部带有对象检测头,用于执行 COCO 检测等任务。
此模型继承自 PreTrainedModel。查看超类文档,了解库为其所有模型实现的通用方法(例如下载或保存、调整输入嵌入大小、剪枝头等)。
此模型也是 PyTorch torch.nn.Module 子类。将其用作常规 PyTorch 模块,并参考 PyTorch 文档,了解与常规用法和行为相关的所有事项。
forward
< source >( pixel_values: FloatTensor pixel_mask: typing.Optional[torch.LongTensor] = None decoder_attention_mask: typing.Optional[torch.FloatTensor] = None encoder_outputs: typing.Optional[torch.FloatTensor] = None inputs_embeds: typing.Optional[torch.FloatTensor] = None decoder_inputs_embeds: typing.Optional[torch.FloatTensor] = None labels: typing.Optional[typing.List[dict]] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None ) → transformers.models.detr.modeling_detr.DetrObjectDetectionOutput 或 tuple(torch.FloatTensor)
参数
- pixel_values (形状为
(batch_size, num_channels, height, width)
的torch.FloatTensor
) — 像素值。如果您提供填充,默认情况下将被忽略。像素值可以使用 AutoImageProcessor 获得。 有关详细信息,请参阅 DetrImageProcessor.call()。
- pixel_mask (形状为
(batch_size, height, width)
的torch.LongTensor
, 可选) — 用于避免对填充像素值执行注意力的掩码。掩码值在[0, 1]
中选择:- 1 表示真实的像素(即未被掩码),
- 0 表示填充像素(即被掩码)。
- decoder_attention_mask (形状为
(batch_size, num_queries)
的torch.FloatTensor
, 可选) — 默认情况下不使用。 可用于掩盖对象查询。 - encoder_outputs (
tuple(tuple(torch.FloatTensor)
, 可选) — 元组由 (last_hidden_state
, 可选:hidden_states
, 可选:attentions
) 组成,形状为(batch_size, sequence_length, hidden_size)
的last_hidden_state
, 可选) 是编码器最后一层的输出处的隐藏状态序列。在解码器的交叉注意力中使用。 - inputs_embeds (形状为
(batch_size, sequence_length, hidden_size)
的torch.FloatTensor
, 可选) — 可选地,您可以选择直接传递图像的扁平化表示,而不是传递扁平化的特征图(骨干网络 + 投影层的输出)。 - decoder_inputs_embeds (形状为
(batch_size, num_queries, hidden_size)
的torch.FloatTensor
, 可选) — 可选地,您可以选择直接传递嵌入表示,而不是使用零张量初始化查询。 - output_attentions (
bool
, 可选) — 是否返回所有注意力层的注意力张量。 有关更多详细信息,请参阅返回张量下的attentions
。 - output_hidden_states (
bool
, 可选) — 是否返回所有层的隐藏状态。 有关更多详细信息,请参阅返回张量下的hidden_states
。 - return_dict (
bool
, 可选) — 是否返回 ModelOutput 而不是普通元组。 - labels (长度为
(batch_size,)
的List[Dict]
, 可选) — 用于计算二分图匹配损失的标签。 字典列表,每个字典至少包含以下 2 个键:“class_labels”和“boxes”(批次中图像的类别标签和边界框)。 类别标签本身应为长度为(图像中边界框的数量,)
的torch.LongTensor
,而框应为形状为(图像中边界框的数量, 4)
的torch.FloatTensor
。
返回
transformers.models.detr.modeling_detr.DetrObjectDetectionOutput 或 tuple(torch.FloatTensor)
一个 transformers.models.detr.modeling_detr.DetrObjectDetectionOutput 或 torch.FloatTensor
的元组(如果传递 return_dict=False
或当 config.return_dict=False
时),包括取决于配置 (DetrConfig) 和输入的各种元素。
- loss (
torch.FloatTensor
,形状为(1,)
,可选,当提供labels
时返回) — 总损失,是类别预测的负对数似然(交叉熵)损失和边界框损失的线性组合。后者定义为 L1 损失和广义尺度不变 IoU 损失的线性组合。 - loss_dict (
Dict
,可选) — 包含各个损失的字典。用于日志记录非常有用。 - logits (
torch.FloatTensor
,形状为(batch_size, num_queries, num_classes + 1)
) — 所有查询的分类 logits(包括无对象类别)。 - pred_boxes (
torch.FloatTensor
,形状为(batch_size, num_queries, 4)
) — 所有查询的归一化框坐标,表示为(center_x,center_y,width,height)。这些值在 [0, 1] 范围内归一化,相对于批次中每个单独图像的大小(忽略可能的填充)。您可以使用 post_process_object_detection() 来检索非归一化的边界框。 - auxiliary_outputs (
list[Dict]
,可选) — 可选,仅当辅助损失被激活时返回(即config.auxiliary_loss
设置为True
)并且提供了标签。它是一个字典列表,包含每个解码器层的上述两个键(logits
和pred_boxes
)。 - last_hidden_state (
torch.FloatTensor
,形状为(batch_size, sequence_length, hidden_size)
,可选) — 模型解码器最后一层的输出处的隐藏状态序列。 - decoder_hidden_states (
tuple(torch.FloatTensor)
, 可选, 当传递output_hidden_states=True
或当config.output_hidden_states=True
时返回) —torch.FloatTensor
的元组(一个用于嵌入的输出 + 一个用于每层的输出),形状为(batch_size, sequence_length, hidden_size)
。 解码器在每层输出处的隐藏状态加上初始嵌入输出。 - decoder_attentions (
tuple(torch.FloatTensor)
, 可选, 当传递output_attentions=True
或当config.output_attentions=True
时返回) —torch.FloatTensor
的元组(每层一个),形状为(batch_size, num_heads, sequence_length, sequence_length)
。 解码器的注意力权重,在注意力 softmax 之后,用于计算自注意力头中的加权平均值。 - cross_attentions (
tuple(torch.FloatTensor)
, 可选, 当传递output_attentions=True
或当config.output_attentions=True
时返回) —torch.FloatTensor
的元组(每层一个),形状为(batch_size, num_heads, sequence_length, sequence_length)
。 解码器交叉注意力层的注意力权重,在注意力 softmax 之后,用于计算交叉注意力头中的加权平均值。 - encoder_last_hidden_state (形状为
(batch_size, sequence_length, hidden_size)
的torch.FloatTensor
, 可选) — 模型编码器最后一层输出处的隐藏状态序列。 - encoder_hidden_states (
tuple(torch.FloatTensor)
, 可选, 当传递output_hidden_states=True
或当config.output_hidden_states=True
时返回) —torch.FloatTensor
的元组(一个用于嵌入的输出 + 一个用于每层的输出),形状为(batch_size, sequence_length, hidden_size)
。 编码器在每层输出处的隐藏状态加上初始嵌入输出。 - encoder_attentions (
tuple(torch.FloatTensor)
, 可选, 当传递output_attentions=True
或当config.output_attentions=True
时返回) —torch.FloatTensor
的元组(每层一个),形状为(batch_size, num_heads, sequence_length, sequence_length)
。 编码器的注意力权重,在注意力 softmax 之后,用于计算自注意力头中的加权平均值。
DetrForObjectDetection 的 forward 方法,覆盖了 __call__
特殊方法。
尽管 forward 传递的配方需要在该函数中定义,但之后应该调用 Module
实例而不是此函数,因为前者负责运行预处理和后处理步骤,而后者会静默地忽略它们。
示例
>>> from transformers import AutoImageProcessor, DetrForObjectDetection
>>> import torch
>>> 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("facebook/detr-resnet-50")
>>> model = DetrForObjectDetection.from_pretrained("facebook/detr-resnet-50")
>>> inputs = image_processor(images=image, return_tensors="pt")
>>> outputs = model(**inputs)
>>> # convert outputs (bounding boxes and class logits) to Pascal VOC format (xmin, ymin, xmax, ymax)
>>> target_sizes = torch.tensor([image.size[::-1]])
>>> results = image_processor.post_process_object_detection(outputs, threshold=0.9, target_sizes=target_sizes)[
... 0
... ]
>>> for score, label, box in zip(results["scores"], results["labels"], results["boxes"]):
... box = [round(i, 2) for i in box.tolist()]
... print(
... f"Detected {model.config.id2label[label.item()]} with confidence "
... f"{round(score.item(), 3)} at location {box}"
... )
Detected remote with confidence 0.998 at location [40.16, 70.81, 175.55, 117.98]
Detected remote with confidence 0.996 at location [333.24, 72.55, 368.33, 187.66]
Detected couch with confidence 0.995 at location [-0.02, 1.15, 639.73, 473.76]
Detected cat with confidence 0.999 at location [13.24, 52.05, 314.02, 470.93]
Detected cat with confidence 0.999 at location [345.4, 23.85, 640.37, 368.72]
DetrForSegmentation
class transformers.DetrForSegmentation
< source >( config: DetrConfig )
参数
- config (DetrConfig) — 模型配置类,包含模型的所有参数。使用配置文件初始化不会加载与模型关联的权重,仅加载配置。查看 from_pretrained() 方法来加载模型权重。
DETR 模型(由骨干网络和编码器-解码器 Transformer 组成),顶部带有分割头,用于诸如 COCO 全景分割之类的任务。
此模型继承自 PreTrainedModel。查看超类文档,了解库为其所有模型实现的通用方法(例如下载或保存、调整输入嵌入大小、剪枝头等)。
此模型也是 PyTorch torch.nn.Module 子类。将其用作常规 PyTorch 模块,并参考 PyTorch 文档,了解与常规用法和行为相关的所有事项。
forward
< source >( pixel_values: FloatTensor pixel_mask: typing.Optional[torch.LongTensor] = None decoder_attention_mask: typing.Optional[torch.FloatTensor] = None encoder_outputs: typing.Optional[torch.FloatTensor] = None inputs_embeds: typing.Optional[torch.FloatTensor] = None decoder_inputs_embeds: typing.Optional[torch.FloatTensor] = None labels: typing.Optional[typing.List[dict]] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None ) → transformers.models.detr.modeling_detr.DetrSegmentationOutput 或 tuple(torch.FloatTensor)
参数
- pixel_values (
torch.FloatTensor
,形状为(batch_size, num_channels, height, width)
) — 像素值。如果您提供填充,默认情况下将被忽略。像素值可以使用 AutoImageProcessor 获得。有关详细信息,请参阅 DetrImageProcessor.call()。
- pixel_mask (
torch.LongTensor
,形状为(batch_size, height, width)
,可选) — 用于避免对填充像素值执行注意力的掩码。掩码值在[0, 1]
中选择:- 1 代表真实像素(即未被掩码),
- 0 代表填充像素(即被掩码)。
- decoder_attention_mask (
torch.FloatTensor
,形状为(batch_size, num_queries)
,可选) — 默认情况下不使用。可用于掩码对象查询。 - encoder_outputs (
tuple(tuple(torch.FloatTensor)
,可选) — 元组由 (last_hidden_state
,可选:hidden_states
,可选:attentions
) 组成。last_hidden_state
的形状为(batch_size, sequence_length, hidden_size)
,可选) 是编码器最后一层输出处的隐藏状态序列。在解码器的交叉注意力中使用。 - inputs_embeds (
torch.FloatTensor
,形状为(batch_size, sequence_length, hidden_size)
,可选) — 可选地,您可以选择直接传递图像的扁平化表示,而不是传递扁平化的特征图(骨干网络 + 投影层的输出)。 - decoder_inputs_embeds (
torch.FloatTensor
,形状为(batch_size, num_queries, hidden_size)
,可选) — 可选地,您可以选择直接传递嵌入表示,而不是使用零张量初始化查询。 - output_attentions (
bool
,可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息,请参阅返回张量下的attentions
。 - output_hidden_states (
bool
,可选) — 是否返回所有层的隐藏状态。有关更多详细信息,请参阅返回张量下的hidden_states
。 - return_dict (
bool
,可选) — 是否返回 ModelOutput 而不是普通元组。 - labels (
List[Dict]
,长度为(batch_size,)
,可选) — 用于计算二分图匹配损失、DICE/F-1 损失和 Focal 损失的标签。字典列表,每个字典至少包含以下 3 个键:“class_labels”、“boxes”和“masks”(分别为批次中图像的类别标签、边界框和分割掩码)。类别标签本身应为长度为(图像中边界框的数量,)
的torch.LongTensor
,框应为形状为(图像中边界框的数量, 4)
的torch.FloatTensor
,掩码应为形状为(图像中边界框的数量, height, width)
的torch.FloatTensor
。
返回
transformers.models.detr.modeling_detr.DetrSegmentationOutput 或 tuple(torch.FloatTensor)
一个 transformers.models.detr.modeling_detr.DetrSegmentationOutput 或 torch.FloatTensor
的元组(如果传递 return_dict=False
或当 config.return_dict=False
时),其中包含各种元素,具体取决于配置 (DetrConfig) 和输入。
- loss (
torch.FloatTensor
,形状为(1,)
,可选,当提供labels
时返回) — 总损失,是类别预测的负对数似然(交叉熵)损失和边界框损失的线性组合。后者定义为 L1 损失和广义尺度不变 IoU 损失的线性组合。 - loss_dict (
Dict
,可选) — 包含各个损失的字典。用于日志记录非常有用。 - logits (
torch.FloatTensor
,形状为(batch_size, num_queries, num_classes + 1)
) — 所有查询的分类 logits(包括无对象类别)。 - pred_boxes (
torch.FloatTensor
,形状为(batch_size, num_queries, 4)
) — 所有查询的归一化框坐标,表示为(center_x,center_y,width,height)。这些值在 [0, 1] 范围内归一化,相对于批次中每个单独图像的大小(忽略可能的填充)。您可以使用 post_process_object_detection() 来检索非归一化的边界框。 - pred_masks (
torch.FloatTensor
,形状为(batch_size, num_queries, height/4, width/4)
) — 所有查询的分割掩码 logits。另请参阅 post_process_semantic_segmentation() 或 post_process_instance_segmentation() post_process_panoptic_segmentation(),分别用于评估语义分割、实例分割和全景分割掩码。 - auxiliary_outputs (
list[Dict]
,可选) — 可选,仅当辅助损失被激活时返回(即config.auxiliary_loss
设置为True
)并且提供了标签。它是一个字典列表,包含每个解码器层的上述两个键(logits
和pred_boxes
)。 - last_hidden_state (
torch.FloatTensor
,形状为(batch_size, sequence_length, hidden_size)
,可选) — 模型解码器最后一层的输出处的隐藏状态序列。 - decoder_hidden_states (
tuple(torch.FloatTensor)
, 可选, 当传递output_hidden_states=True
或当config.output_hidden_states=True
时返回) —torch.FloatTensor
的元组(一个用于嵌入的输出 + 一个用于每层的输出),形状为(batch_size, sequence_length, hidden_size)
。 解码器在每层输出处的隐藏状态加上初始嵌入输出。 - decoder_attentions (
tuple(torch.FloatTensor)
, 可选, 当传递output_attentions=True
或当config.output_attentions=True
时返回) —torch.FloatTensor
的元组(每层一个),形状为(batch_size, num_heads, sequence_length, sequence_length)
。 解码器的注意力权重,在注意力 softmax 之后,用于计算自注意力头中的加权平均值。 - cross_attentions (
tuple(torch.FloatTensor)
, 可选, 当传递output_attentions=True
或当config.output_attentions=True
时返回) —torch.FloatTensor
的元组(每层一个),形状为(batch_size, num_heads, sequence_length, sequence_length)
。 解码器交叉注意力层的注意力权重,在注意力 softmax 之后,用于计算交叉注意力头中的加权平均值。 - encoder_last_hidden_state (形状为
(batch_size, sequence_length, hidden_size)
的torch.FloatTensor
, 可选) — 模型编码器最后一层输出处的隐藏状态序列。 - encoder_hidden_states (
tuple(torch.FloatTensor)
, 可选, 当传递output_hidden_states=True
或当config.output_hidden_states=True
时返回) —torch.FloatTensor
的元组(一个用于嵌入的输出 + 一个用于每层的输出),形状为(batch_size, sequence_length, hidden_size)
。 编码器在每层输出处的隐藏状态加上初始嵌入输出。 - encoder_attentions (
tuple(torch.FloatTensor)
, 可选, 当传递output_attentions=True
或当config.output_attentions=True
时返回) —torch.FloatTensor
的元组(每层一个),形状为(batch_size, num_heads, sequence_length, sequence_length)
。 编码器的注意力权重,在注意力 softmax 之后,用于计算自注意力头中的加权平均值。
DetrForSegmentation 的 forward 方法,覆盖了 __call__
特殊方法。
尽管 forward 传递的配方需要在该函数中定义,但之后应该调用 Module
实例而不是此函数,因为前者负责运行预处理和后处理步骤,而后者会静默地忽略它们。
示例
>>> import io
>>> import requests
>>> from PIL import Image
>>> import torch
>>> import numpy
>>> from transformers import AutoImageProcessor, DetrForSegmentation
>>> from transformers.image_transforms import rgb_to_id
>>> url = "http://images.cocodataset.org/val2017/000000039769.jpg"
>>> image = Image.open(requests.get(url, stream=True).raw)
>>> image_processor = AutoImageProcessor.from_pretrained("facebook/detr-resnet-50-panoptic")
>>> model = DetrForSegmentation.from_pretrained("facebook/detr-resnet-50-panoptic")
>>> # prepare image for the model
>>> inputs = image_processor(images=image, return_tensors="pt")
>>> # forward pass
>>> outputs = model(**inputs)
>>> # Use the `post_process_panoptic_segmentation` method of the `image_processor` to retrieve post-processed panoptic segmentation maps
>>> # Segmentation results are returned as a list of dictionaries
>>> result = image_processor.post_process_panoptic_segmentation(outputs, target_sizes=[(300, 500)])
>>> # A tensor of shape (height, width) where each value denotes a segment id, filled with -1 if no segment is found
>>> panoptic_seg = result[0]["segmentation"]
>>> # Get prediction score and segment_id to class_id mapping of each segment
>>> panoptic_segments_info = result[0]["segments_info"]