Transformers 文档
DETA
并获得增强的文档体验
开始使用
DETA
此模型仅处于维护模式,我们不接受任何更改其代码的新 PR。如果您在使用此模型时遇到任何问题,请重新安装支持此模型的最后一个版本:v4.40.2。您可以通过运行以下命令进行操作:pip install -U transformers==4.40.2
。
概述
DETA 模型由 Jeffrey Ouyang-Zhang、Jang Hyun Cho、Xingyi Zhou、Philipp Krähenbühl 在 NMS Strikes Back 中提出。DETA(Detection Transformers with Assignment 的缩写)通过将一对一的匈牙利匹配损失替换为传统检测器中使用的带非极大值抑制(NMS)的一对多标签分配来改进 Deformable DETR。这带来了高达 2.5 mAP 的显著提升。
论文摘要如下:
检测 Transformer (DETR) 在训练过程中使用一对一的二分匹配直接将查询转换为唯一的对象,并实现端到端对象检测。最近,这些模型以无可辩驳的优雅在 COCO 上超越了传统检测器。然而,它们在模型架构和训练调度等多个设计上与传统检测器不同,因此一对一匹配的有效性尚未完全理解。在这项工作中,我们对 DETR 中一对一的匈牙利匹配与传统检测器中带有非极大值抑制(NMS)的一对多标签分配进行了严格比较。令人惊讶的是,我们观察到在一对多分配中,带有 NMS 的传统检测器在相同设置下始终优于标准的一对一匹配,显著提升了高达 2.5 mAP。我们的检测器使用传统的基于 IoU 的标签分配训练 Deformable-DETR,在 12 个 epoch(1x 调度)内使用 ResNet50 主干网络实现了 50.2 COCO mAP,超越了在此设置下所有现有的传统或基于 Transformer 的检测器。在多个数据集、调度和架构上,我们始终表明二分匹配对于高性能检测 Transformer 来说并非必需。此外,我们将检测 Transformer 的成功归因于其富有表现力的 Transformer 架构。

资源
以下是官方 Hugging Face 和社区(用 🌎 表示)资源列表,可帮助您开始使用 DETA。
- DETA 的演示笔记本可以在 这里 找到。
- 使用 Trainer 或 Accelerate 对 DetaForObjectDetection 进行微调的脚本可以在 这里 找到。
- 另请参阅:目标检测任务指南。
如果您有兴趣在此处提交资源,请随时开启 Pull Request,我们将对其进行审查!该资源最好能展示一些新内容,而不是重复现有资源。
DetaConfig
class transformers.DetaConfig
< 来源 >( backbone_config = None backbone = None use_pretrained_backbone = False use_timm_backbone = False backbone_kwargs = None num_queries = 900 max_position_embeddings = 2048 encoder_layers = 6 encoder_ffn_dim = 2048 encoder_attention_heads = 8 decoder_layers = 6 decoder_ffn_dim = 1024 decoder_attention_heads = 8 encoder_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 return_intermediate = True auxiliary_loss = False position_embedding_type = 'sine' num_feature_levels = 5 encoder_n_points = 4 decoder_n_points = 4 two_stage = True two_stage_num_proposals = 300 with_box_refine = True assign_first_stage = True assign_second_stage = True 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 focal_alpha = 0.25 disable_custom_kernels = True **kwargs )
参数
- backbone_config (
PretrainedConfig
或dict
, 可选, 默认为ResNetConfig()
) — 主干模型的配置。 - backbone (
str
, 可选) — 当backbone_config
为None
时使用的主干名称。如果use_pretrained_backbone
为True
,这将从 timm 或 transformers 库加载相应的预训练权重。如果use_pretrained_backbone
为False
,这将加载主干的配置并使用它来初始化具有随机权重的后台。 - use_pretrained_backbone (
bool
, 可选,False
) — 是否使用预训练的主干权重。 - use_timm_backbone (
bool
, 可选,False
) — 是否从 timm 库加载backbone
。如果为False
,则从 transformers 库加载主干。 - backbone_kwargs (
dict
, 可选) — 加载检查点时传递给 AutoBackbone 的关键字参数,例如{'out_indices': (0, 1, 2, 3)}
。如果设置了backbone_config
,则不能指定此参数。 - num_queries (
int
, 可选, 默认为 900) — 对象查询的数量,即检测槽的数量。这是 DetaModel 在单张图像中可以检测到的最大对象数量。如果two_stage
设置为True
,则使用two_stage_num_proposals
。 - 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 模块中 Xavier 初始化增益的缩放因子。 - encoder_layerdrop (
float
, 可选, 默认为 0.0) — 编码器的 LayerDrop 概率。更多详细信息请参阅 [LayerDrop 论文](参见 https://huggingface.co/papers/1909.11556)。 - auxiliary_loss (
bool
, 可选, 默认为False
) — 是否使用辅助解码损失(每个解码器层的损失)。 - position_embedding_type (
str
, 可选, 默认为"sine"
) — 在图像特征之上使用的位置嵌入类型。可选择"sine"
或"learned"
。 - class_cost (
float
, 可选, 默认为 1) — 匈牙利匹配代价中分类误差的相对权重。 - bbox_cost (
float
, 可选, 默认为 5) — 匈牙利匹配代价中边界框坐标 L1 误差的相对权重。 - giou_cost (
float
, 可选, 默认为 2) — 匈牙利匹配代价中边界框广义 IoU 损失的相对权重。 - mask_loss_coefficient (
float
, 可选, 默认为 1) — 全景分割损失中 Focal loss 的相对权重。 - 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) — 对象检测损失中“无对象”类别的相对分类权重。 - num_feature_levels (
int
, 可选, 默认为 5) — 输入特征层数。 - encoder_n_points (
int
, 可选, 默认为 4) — 编码器中每个特征层、每个注意力头中采样的键点数。 - decoder_n_points (
int
, 可选, 默认为 4) — 解码器中每个特征层、每个注意力头中采样的键点数。 - two_stage (
bool
, 可选, 默认为True
) — 是否应用两阶段可变形DETR,其中区域提议也由DETA的变体生成,并进一步输入解码器以进行迭代边界框细化。 - two_stage_num_proposals (
int
, 可选, 默认为 300) — 在two_stage
设置为True
的情况下,要生成的区域提议的数量。 - with_box_refine (
bool
, 可选, 默认为True
) — 是否应用迭代边界框细化,其中每个解码器层根据前一层的预测来细化边界框。 - focal_alpha (
float
, 可选, 默认为 0.25) — 焦点损失中的 Alpha 参数。 - assign_first_stage (
bool
, 可选, 默认为True
) — 是否将每个预测 i 分配给重叠度高于阈值 0.7 的最高重叠真实对象。 - assign_second_stage (
bool
, 可选, 默认为True
) — 第二阶段的第二个分配过程是否与第一阶段的分配过程紧密相关。 - disable_custom_kernels (
bool
, 可选, 默认为True
) — 禁用自定义CUDA和CPU内核的使用。此选项对于ONNX导出是必需的,因为PyTorch ONNX导出不支持自定义内核。
这是一个配置类,用于存储 DetaModel 的配置。它用于根据指定的参数实例化 DETA 模型,定义模型架构。使用默认值实例化配置将生成与 DETA SenseTime/deformable-detr 架构类似的配置。
配置对象继承自 PretrainedConfig,可用于控制模型输出。有关更多信息,请参阅 PretrainedConfig 的文档。
示例
>>> from transformers import DetaConfig, DetaModel
>>> # Initializing a DETA SenseTime/deformable-detr style configuration
>>> configuration = DetaConfig()
>>> # Initializing a model (with random weights) from the SenseTime/deformable-detr style configuration
>>> model = DetaModel(configuration)
>>> # Accessing the model configuration
>>> configuration = model.config
DetaImageProcessor
class transformers.DetaImageProcessor
< source >( format: typing.Union[str, transformers.image_utils.AnnotationFormat] = <AnnotationFormat.COCO_DETECTION: 'coco_detection'> do_resize: bool = True size: typing.Optional[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, list[float], NoneType] = None image_std: typing.Union[float, list[float], NoneType] = None do_convert_annotations: bool = True do_pad: bool = True pad_size: typing.Optional[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}
):调整大小后图像的(height, width)
尺寸。可以通过preprocess
方法中的size
参数覆盖。可用选项包括:{"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
, 可选, 默认为PILImageResampling.BILINEAR
) — 如果调整图像大小,则使用的重采样滤波器。 - do_rescale (
bool
, 可选, 默认为True
) — 控制是否按指定的比例rescale_factor
重新缩放图像。可以通过preprocess
方法中的do_rescale
参数覆盖。 - rescale_factor (
int
或float
, 可选, 默认为1/255
) — 如果重新缩放图像,则使用的比例因子。可以通过preprocess
方法中的rescale_factor
参数覆盖。 - do_normalize — 控制是否标准化图像。可以通过
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
) — 控制是否填充图像。如果为True
,将用零填充图像的底部和右侧。如果提供了pad_size
,图像将填充到指定尺寸。否则,图像将填充到批次的最大高度和宽度。 - pad_size (
dict[str, int]
, 可选) — 要填充图像的尺寸{"height": int, "width" int}
。必须大于任何为预处理提供的图像尺寸。如果未提供pad_size
,图像将填充到批次中的最大高度和宽度。
构造可变形 DETR 图像处理器。
预处理
< 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[list[dict], list[list[dict]], NoneType] = None return_segmentation_masks: typing.Optional[bool] = None masks_path: typing.Union[str, pathlib.Path, NoneType] = None do_resize: typing.Optional[bool] = None size: typing.Optional[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 image_mean: typing.Union[float, list[float], NoneType] = None image_std: typing.Union[float, list[float], NoneType] = None do_convert_annotations: typing.Optional[bool] = 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[dict[str, int]] = None **kwargs )
参数
- images (
ImageInput
) — 要预处理的图像或图像批次。期望单个或批次的图像,像素值范围从0到255。如果传入的图像像素值在0到1之间,请设置do_rescale=False
。 - annotations (
list[Dict]
或list[list[Dict]]
, 可选) — 与图像或图像批次关联的注释列表。如果注释用于对象检测,则注释应为具有以下键的字典:- “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) — 是否标准化图像。 - image_mean (
float
或list[float]
, 可选, 默认为 self.image_mean) — 标准化图像时使用的均值。 - image_std (
float
或list[float]
, 可选, 默认为 self.image_std) — 标准化图像时使用的标准差。 - do_convert_annotations (
bool
, 可选, 默认为 self.do_convert_annotations) — 是否将注释转换为模型所需的格式。将边界框从(top_left_x, top_left_y, width, height)
格式转换为(center_x, center_y, width, height)
,并转换为相对坐标。 - 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
,图像将填充到批次中的最大高度和宽度。
预处理图像或图像批次,以便模型可以使用。
后处理对象检测
< source >( outputs threshold: float = 0.5 target_sizes: typing.Union[transformers.utils.generic.TensorType, list[tuple]] = None nms_threshold: float = 0.7 ) → list[Dict]
参数
- outputs (
DetrObjectDetectionOutput
) — 模型的原始输出。 - threshold (
float
, 可选, 默认为 0.5) — 保持对象检测预测的分数阈值。 - target_sizes (
torch.Tensor
或list[tuple[int, int]]
, 可选) — 形状为(batch_size, 2)
的张量或元组列表 (tuple[int, int]
),其中包含批次中每个图像的目标大小(高度,宽度)。如果留空,则预测不会调整大小。 - nms_threshold (
float
, 可选, 默认为 0.7) — NMS 阈值。
返回
list[Dict]
一个字典列表,每个字典包含模型预测的批处理中每张图像的分数、标签和框。
将 DetaForObjectDetection 的输出转换为 (top_left_x, top_left_y, bottom_right_x, bottom_right_y) 格式的最终边界框。仅支持 PyTorch。
DetaModel
class transformers.DetaModel
< source >( config: DetaConfig )
参数
- config (DetaConfig) — 包含模型所有参数的模型配置类。使用配置文件初始化不会加载与模型关联的权重,仅加载配置。请查看 from_pretrained() 方法以加载模型权重。
裸 DETA 模型(由骨干网络和编码器-解码器 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.deprecated.deta.modeling_deta.DetaModelOutput
或 tuple(torch.FloatTensor)
参数
- pixel_values (
torch.FloatTensor
, 形状为(batch_size, num_channels, height, width)
) — 像素值。如果提供,默认情况下将忽略填充。像素值可以使用 AutoImageProcessor 获取。有关详细信息,请参阅
AutoImageProcessor.__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 而不是普通元组。
返回
transformers.models.deprecated.deta.modeling_deta.DetaModelOutput
或 tuple(torch.FloatTensor)
一个 transformers.models.deprecated.deta.modeling_deta.DetaModelOutput
或一个 torch.FloatTensor
元组(如果传递了 return_dict=False
或 config.return_dict=False
时),包含根据配置(DetaConfig)和输入的不同元素。
- init_reference_points (
torch.FloatTensor
, 形状为(batch_size, num_queries, 4)
) — 通过 Transformer 解码器发送的初始参考点。 - last_hidden_state (
torch.FloatTensor
, 形状为(batch_size, num_queries, hidden_size)
) — 模型解码器最后一层输出的隐藏状态序列。 - intermediate_hidden_states (
torch.FloatTensor
, 形状为(batch_size, config.decoder_layers, num_queries, hidden_size)
) — 堆叠的中间隐藏状态(解码器每层的输出)。 - intermediate_reference_points (
torch.FloatTensor
, 形状为(batch_size, config.decoder_layers, num_queries, 4)
) — 堆叠的中间参考点(解码器每层的参考点)。 - decoder_hidden_states (
tuple(torch.FloatTensor)
, 可选, 当传递output_hidden_states=True
或config.output_hidden_states=True
时返回) —torch.FloatTensor
元组(一个用于嵌入输出 + 每个层的输出一个),形状为(batch_size, num_queries, hidden_size)
。解码器在每层输出处的隐藏状态加上初始嵌入输出。 - decoder_attentions (
tuple(torch.FloatTensor)
, 可选, 当传递output_attentions=True
或config.output_attentions=True
时返回) —torch.FloatTensor
元组(每层一个),形状为(batch_size, num_heads, num_queries, num_queries)
。解码器的注意力权重,在注意力 softmax 之后,用于计算自注意力头中的加权平均。 - cross_attentions (
tuple(torch.FloatTensor)
, 可选, 当传递output_attentions=True
或config.output_attentions=True
时返回) —torch.FloatTensor
元组(每层一个),形状为(batch_size, num_queries, num_heads, 4, 4)
。解码器交叉注意力层的注意力权重,在注意力 softmax 之后,用于计算交叉注意力头中的加权平均。 - encoder_last_hidden_state (
torch.FloatTensor
,形状为(batch_size, sequence_length, hidden_size)
,可选) — 模型编码器最后一层输出的隐藏状态序列。 - 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_queries, num_heads, 4, 4)
。编码器的注意力权重,在注意力 softmax 之后,用于计算自注意力头中的加权平均。 - enc_outputs_class (
torch.FloatTensor
, 形状为(batch_size, sequence_length, config.num_labels)
, 可选, 当config.with_box_refine=True
和config.two_stage=True
时返回) — 预测的边界框分数,其中得分最高的config.two_stage_num_proposals
个边界框在第一阶段被选为区域提案。边界框二元分类(即前景和背景)的输出。 - enc_outputs_coord_logits (
torch.FloatTensor
, 形状为(batch_size, sequence_length, 4)
, 可选, 当config.with_box_refine=True
和config.two_stage=True
时返回) — 第一阶段预测的边界框坐标的 logits。 - output_proposals (
torch.FloatTensor
, 形状为(batch_size, sequence_length, 4)
, 可选, 当config.two_stage=True
时返回) — `gen_encoder_output_proposals` 中提案边界框坐标的 logits。
DetaModel 的 forward 方法,重写了 __call__
特殊方法。
尽管前向传递的实现需要在该函数中定义,但在此之后应该调用 Module
实例,而不是直接调用此函数,因为前者会处理预处理和后处理步骤,而后者会默默忽略它们。
示例
>>> from transformers import AutoImageProcessor, DetaModel
>>> 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("jozhang97/deta-swin-large-o365")
>>> model = DetaModel.from_pretrained("jozhang97/deta-swin-large-o365", two_stage=False)
>>> inputs = image_processor(images=image, return_tensors="pt")
>>> outputs = model(**inputs)
>>> last_hidden_states = outputs.last_hidden_state
>>> list(last_hidden_states.shape)
[1, 900, 256]
DetaForObjectDetection
class transformers.DetaForObjectDetection
< source >( config: DetaConfig )
参数
- config (DetaConfig) — 模型配置类,包含模型的所有参数。使用配置文件初始化不会加载与模型关联的权重,只会加载配置。请查看 from_pretrained() 方法来加载模型权重。
DETA 模型(由骨干网络和编码器-解码器 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[list[dict]] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None ) → transformers.models.deprecated.deta.modeling_deta.DetaObjectDetectionOutput
或 tuple(torch.FloatTensor)
参数
- pixel_values (
torch.FloatTensor
, 形状为(batch_size, num_channels, height, width)
) — 像素值。如果提供,默认情况下将忽略填充。像素值可以使用 AutoImageProcessor 获取。有关详细信息,请参阅
AutoImageProcessor.__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,)
, 可选) — 用于计算二分匹配损失的标签。字典列表,每个字典至少包含以下两个键:“class_labels”和“boxes”(分别表示批处理中图像的类别标签和边界框)。类别标签本身应该是长度为(图像中边界框的数量,)
的torch.LongTensor
,而框应该是形状为(图像中边界框的数量, 4)
的torch.FloatTensor
。
返回
transformers.models.deprecated.deta.modeling_deta.DetaObjectDetectionOutput
或 tuple(torch.FloatTensor)
一个 transformers.models.deprecated.deta.modeling_deta.DetaObjectDetectionOutput
或一个 torch.FloatTensor
元组(如果传递了 return_dict=False
或 config.return_dict=False
时),包含根据配置(DetaConfig)和输入的不同元素。
- loss (
torch.FloatTensor
, 形状为(1,)
, 可选, 当提供了labels
时返回) — 总损失,是类别预测的负对数似然(交叉熵)和边界框损失的线性组合。后者定义为 L1 损失和广义尺度不变 IoU 损失的线性组合。 - loss_dict (
Dict
, 可选) — 包含各个损失的字典。用于日志记录。 - logits (形状为
(batch_size, num_queries, num_classes + 1)
的torch.FloatTensor
) — 所有查询的分类 logits(包括无对象)。 - pred_boxes (
torch.FloatTensor
, 形状为(batch_size, num_queries, 4)
) — 所有查询的归一化框坐标,表示为 (center_x, center_y, width, height)。这些值归一化到 [0, 1] 范围,相对于批处理中每个单独图像的大小(忽略可能的填充)。您可以使用~DetaProcessor.post_process_object_detection
来检索未归一化的边界框。 - auxiliary_outputs (
list[Dict]
, 可选) — 可选,仅当辅助损失激活(即config.auxiliary_loss
设置为True
)且提供标签时返回。它是字典列表,每个字典包含上述两个键(logits
和pred_boxes
),对应每个解码器层。 - last_hidden_state (
torch.FloatTensor
, 形状为(batch_size, num_queries, hidden_size)
, 可选) — 模型解码器最后一层输出的隐藏状态序列。 - decoder_hidden_states (
tuple(torch.FloatTensor)
, 可选, 当传递output_hidden_states=True
或config.output_hidden_states=True
时返回) —torch.FloatTensor
元组(一个用于嵌入输出 + 每个层的输出一个),形状为(batch_size, num_queries, hidden_size)
。解码器在每层输出处的隐藏状态加上初始嵌入输出。 - decoder_attentions (
tuple(torch.FloatTensor)
, 可选, 当传递output_attentions=True
或config.output_attentions=True
时返回) —torch.FloatTensor
元组(每层一个),形状为(batch_size, num_heads, num_queries, num_queries)
。解码器的注意力权重,在注意力 softmax 之后,用于计算自注意力头中的加权平均。 - cross_attentions (
tuple(torch.FloatTensor)
, 可选, 当传递output_attentions=True
或config.output_attentions=True
时返回) —torch.FloatTensor
元组(每层一个),形状为(batch_size, num_queries, num_heads, 4, 4)
。解码器交叉注意力层的注意力权重,在注意力 softmax 之后,用于计算交叉注意力头中的加权平均。 - encoder_last_hidden_state (
torch.FloatTensor
,形状为(batch_size, sequence_length, hidden_size)
,可选) — 模型编码器最后一层输出的隐藏状态序列。 - 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, sequence_length, num_heads, 4, 4)
。编码器的注意力权重,在注意力 softmax 之后,用于计算自注意力头中的加权平均。 - intermediate_hidden_states (
torch.FloatTensor
, 形状为(batch_size, config.decoder_layers, num_queries, hidden_size)
) — 堆叠的中间隐藏状态(解码器每层的输出)。 - intermediate_reference_points (
torch.FloatTensor
, 形状为(batch_size, config.decoder_layers, num_queries, 4)
) — 堆叠的中间参考点(解码器每层的参考点)。 - init_reference_points (
torch.FloatTensor
, 形状为(batch_size, num_queries, 4)
) — 通过 Transformer 解码器发送的初始参考点。 - enc_outputs_class (
torch.FloatTensor
, 形状为(batch_size, sequence_length, config.num_labels)
, 可选, 当config.with_box_refine=True
和config.two_stage=True
时返回) — 预测的边界框分数,其中得分最高的config.two_stage_num_proposals
个边界框在第一阶段被选为区域提案。边界框二元分类(即前景和背景)的输出。 - enc_outputs_coord_logits (
torch.FloatTensor
, 形状为(batch_size, sequence_length, 4)
, 可选, 当config.with_box_refine=True
和config.two_stage=True
时返回) — 第一阶段预测的边界框坐标的 logits。 - output_proposals (
torch.FloatTensor
, 形状为(batch_size, sequence_length, 4)
, 可选, 当config.two_stage=True
时返回) — `gen_encoder_output_proposals` 中提案边界框坐标的 logits。
DetaForObjectDetection 的 forward 方法,重写了 __call__
特殊方法。
尽管前向传递的实现需要在该函数中定义,但在此之后应该调用 Module
实例,而不是直接调用此函数,因为前者会处理预处理和后处理步骤,而后者会默默忽略它们。
示例
>>> from transformers import AutoImageProcessor, DetaForObjectDetection
>>> 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("jozhang97/deta-swin-large")
>>> model = DetaForObjectDetection.from_pretrained("jozhang97/deta-swin-large")
>>> 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.5, 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 cat with confidence 0.802 at location [9.87, 54.36, 316.93, 473.44]
Detected cat with confidence 0.795 at location [346.62, 24.35, 639.62, 373.2]
Detected remote with confidence 0.725 at location [40.41, 73.36, 175.77, 117.29]
Detected remote with confidence 0.638 at location [333.34, 76.81, 370.22, 187.94]
Detected couch with confidence 0.584 at location [0.03, 0.99, 640.02, 474.93]