Transformers 文档

表格转换器

Transformers

加入 Hugging Face 社区

并获得增强的文档体验

协作模型、数据集和 Spaces

使用加速推理更快地运行示例

切换文档主题

开始使用

表格转换器

概述

表格转换器模型由 Brandon Smock、Rohith Pesala、Robin Abraham 在 PubTables-1M：迈向从非结构化文档中全面提取表格中提出。作者介绍了一个新的数据集 PubTables-1M，用于衡量从非结构化文档中提取表格、表格结构识别和功能分析方面的进展。作者训练了两个 DETR 模型，一个用于表格检测，一个用于表格结构识别，称为表格转换器。

论文摘要如下：

近年来，在将机器学习应用于从非结构化文档中推断和提取表格结构方面取得了重大进展。然而，最大的挑战之一仍然是创建具有完整、明确的规模化地面实况数据集。为了解决这个问题，我们开发了一个新的、更全面的表格提取数据集，称为 PubTables-1M。PubTables-1M 包含来自科学文章的近百万个表格，支持多种输入模式，并包含表格结构的详细标题和位置信息，使其可用于各种建模方法。它还使用一种新颖的规范化过程来解决先前数据集中观察到的地面实况不一致的主要来源，即过度分割。我们证明这些改进导致训练性能显着提高，并使表格结构识别的评估模型性能评估更加可靠。此外，我们表明，在 PubTables-1M 上训练的基于转换器的目标检测模型在检测、结构识别和功能分析三项任务中都取得了优异的成果，而无需针对这些任务进行任何特殊定制。

表格检测和表格结构识别说明。摘自原始论文。

作者发布了两个模型，一个用于文档中的表格检测，一个用于表格结构识别（识别表格中各个行、列等的任务）。

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

资源

目标检测

表格转换器的演示笔记本可以在这里找到。
事实证明，图像的填充对于检测非常重要。一个有趣的 Github 线程，其中包含作者的回复，可以在这里找到。

TableTransformerConfig

class transformers.TableTransformerConfig

< 源代码 >

( 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 库作为主干网络。如果设置为 False，则使用 AutoBackbone API。
backbone_config (PretrainedConfig 或 dict, 可选) — 主干模型的配置。仅在 use_timm_backbone 设置为 False 时使用，在这种情况下，它将默认为 ResNetConfig()。
num_channels (int, 可选, 默认为 3) — 输入通道数量。
num_queries (int, 可选, 默认为 100) — 对象查询的数量，即检测槽位。这是 TableTransformerModel 在单张图像中可以检测到的最大对象数量。对于 COCO，我们建议使用 100 个查询。
d_model (int, 可选, 默认为 256) — 层的维度。
encoder_layers (int, 可选, 默认为 6) — 编码器层的数量。
decoder_layers (int, 可选, 默认为 6) — 解码器层的数量。
encoder_attention_heads (int, optional, defaults to 8) — Transformer 编码器中每个注意力层的注意力头数量。
decoder_attention_heads (int, optional, defaults to 8) — Transformer 解码器中每个注意力层的注意力头数量。
decoder_ffn_dim (int, optional, defaults to 2048) — 解码器中“中间”(通常称为前馈)层的维度。
encoder_ffn_dim (int, optional, defaults to 2048) — 解码器中“中间”(通常称为前馈)层的维度。
activation_function (str or function, optional, defaults to "relu") — 编码器和池化器中的非线性激活函数（函数或字符串）。如果为字符串，则支持 "gelu"、"relu"、"silu" 和 "gelu_new"。
dropout (float, optional, defaults to 0.1) — 嵌入、编码器和池化器中所有全连接层的 dropout 概率。
attention_dropout (float, optional, defaults to 0.0) — 注意力概率的 dropout 率。
activation_dropout (float, optional, defaults to 0.0) — 全连接层内激活的 dropout 率。
init_std (float, optional, defaults to 0.02) — 初始化所有权重矩阵的截断正态分布初始化的标准差。
init_xavier_std (float, optional, defaults to 1) — 用于 HM 注意力映射模块中 Xavier 初始化增益的缩放因子。
decoder_layerdrop (float, optional, defaults to 0.0) — 解码器的 LayerDrop 概率。有关更多详细信息，请参阅 [LayerDrop 论文](参见 https://arxiv.org/abs/1909.11556)。
auxiliary_loss (bool, optional, defaults to False) — 是否使用辅助解码损失（每个解码器层的损失）。
position_embedding_type (str, optional, defaults to "sine") — 在图像特征之上使用的位置嵌入类型。"sine" 或 "learned" 之一。
backbone (str, optional) — 当 backbone_config 为 None 时要使用的骨干名称。如果 use_pretrained_backbone 为 True，这将从 timm 或 transformers 库中加载相应的预训练权重。如果 use_pretrained_backbone 为 False，则加载骨干的配置并使用它来初始化骨干，并使用随机权重。
use_pretrained_backbone (bool, optional, True) — 是否使用骨干的预训练权重。
backbone_kwargs (dict, optional) — 从检查点加载时传递给 AutoBackbone 的关键字参数，例如 {'out_indices': (0, 1, 2, 3)}。如果设置了 backbone_config，则无法指定。
dilation (bool, optional, defaults to False) — 是否在最后一个卷积块（DC5）中用膨胀代替步幅。仅在 use_timm_backbone = True 时支持。
class_cost (float, optional, defaults to 1) — 匈牙利匹配成本中分类错误的相对权重。
bbox_cost (float, optional, defaults to 5) — 匈牙利匹配成本中边界框坐标的 L1 错误的相对权重。
giou_cost (float, optional, defaults to 2) — 匈牙利匹配成本中边界框的广义 IoU 损失的相对权重。
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) — 目标检测损失中“无目标”类别的相对分类权重。

这是用于存储 TableTransformerModel 配置的配置类。它用于根据指定参数实例化 Table Transformer 模型，定义模型架构。使用默认值实例化配置将生成与 Table Transformer microsoft/table-transformer-detection 架构相似的配置。

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

示例

>>> from transformers import TableTransformerModel, TableTransformerConfig

>>> # Initializing a Table Transformer microsoft/table-transformer-detection style configuration
>>> configuration = TableTransformerConfig()

>>> # Initializing a model from the microsoft/table-transformer-detection style configuration
>>> model = TableTransformerModel(configuration)

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

TableTransformerModel

class transformers.TableTransformerModel

< 源代码 >

( config: TableTransformerConfig )

参数

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

基本的 Table Transformer 模型（包含主干网络和编码器-解码器 Transformer），输出原始隐藏状态，没有在其上添加任何特定头部。

此模型继承自 PreTrainedModel。查看超类文档，了解库为其所有模型实现的通用方法（如下载或保存、调整输入嵌入大小、修剪头部等）。

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

forward

< 源代码 >

( pixel_values: FloatTensor pixel_mask: Optional = None decoder_attention_mask: Optional = None encoder_outputs: Optional = None inputs_embeds: Optional = None decoder_inputs_embeds: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None ) → transformers.models.table_transformer.modeling_table_transformer.TableTransformerModelOutput 或 tuple(torch.FloatTensor)

参数

pixel_values (torch.FloatTensor 形状为 (batch_size, num_channels, height, width)) — 像素值。如果您提供填充，默认情况下将忽略填充。

可以使用 DetrImageProcessor 获取像素值。有关详细信息，请参见 DetrImageProcessor.call()。
pixel_mask (torch.FloatTensor 形状为 (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.table_transformer.modeling_table_transformer.TableTransformerModelOutput 或 tuple(torch.FloatTensor)

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

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 (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_heads, sequence_length, sequence_length)。编码器的注意力权重，在注意力 softmax 之后，用于计算自注意力头中的加权平均。
intermediate_hidden_states (torch.FloatTensor，形状为(config.decoder_layers, batch_size, sequence_length, hidden_size), 可选, 当config.auxiliary_loss=True时返回) — 中间解码器激活，即每一层解码器的输出，每个都经过了层归一化。

TableTransformerModel 的前向方法，重写了__call__ 特殊方法。

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

示例

>>> from transformers import AutoImageProcessor, TableTransformerModel
>>> from huggingface_hub import hf_hub_download
>>> from PIL import Image

>>> file_path = hf_hub_download(repo_id="nielsr/example-pdf", repo_type="dataset", filename="example_pdf.png")
>>> image = Image.open(file_path).convert("RGB")

>>> image_processor = AutoImageProcessor.from_pretrained("microsoft/table-transformer-detection")
>>> model = TableTransformerModel.from_pretrained("microsoft/table-transformer-detection")

>>> # 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, 15, 256]

TableTransformerForObjectDetection

class transformers.TableTransformerForObjectDetection

< source >

( config: TableTransformerConfig )

参数

config (TableTransformerConfig) — 模型配置类，包含模型的所有参数。使用配置文檔初始化不会加载与模型相关的权重，只加载配置。请查看from_pretrained() 方法来加载模型权重。

Table Transformer 模型（包含主干和编码器-解码器 Transformer），顶部具有目标检测头，用于 COCO 检测等任务。

此模型继承自 PreTrainedModel。查看超类文档，了解库为其所有模型实现的通用方法（如下载或保存、调整输入嵌入大小、修剪头部等）。

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

forward

< source >

( pixel_values: FloatTensor pixel_mask: Optional = None decoder_attention_mask: Optional = None encoder_outputs: Optional = None inputs_embeds: Optional = None decoder_inputs_embeds: Optional = None labels: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None ) → transformers.models.table_transformer.modeling_table_transformer.TableTransformerObjectDetectionOutput 或 tuple(torch.FloatTensor)

参数

pixel_values (torch.FloatTensor，形状为(batch_size, num_channels, height, width)) — 像素值。如果您提供填充，默认情况下将忽略填充。

可以使用DetrImageProcessor 获取像素值。有关详细信息，请参见DetrImageProcessor.call()。
pixel_mask (torch.FloatTensor，形状为(batch_size, height, width), 可选) — 用于避免对填充像素值执行注意力的掩码。在[0, 1] 中选择掩码值：
- 1 代表实际像素（即 **未掩码**），
- 0 代表填充像素（即 **掩码**）。
什么是注意力掩码？
decoder_attention_mask (torch.FloatTensor，形状为(batch_size, num_queries), 可选) — 默认情况下不使用。可用于屏蔽目标查询。
encoder_outputs (tuple(tuple(torch.FloatTensor), optional) — 元组由 (last_hidden_state, optional: hidden_states, optional: attentions) last_hidden_state 形状为 (batch_size, sequence_length, hidden_size), optional) 是编码器最后一层输出的隐藏状态序列。用于解码器的交叉注意力。
inputs_embeds (torch.FloatTensor 形状为 (batch_size, sequence_length, hidden_size), optional) — 可选地，而不是传递扁平化的特征图（骨干网络 + 投影层的输出），可以选择直接传递图像的扁平化表示。
decoder_inputs_embeds (torch.FloatTensor 形状为 (batch_size, num_queries, hidden_size), optional) — 可选地，而不是用零张量初始化查询，可以选择直接传递嵌入表示。
output_attentions (bool, optional) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参阅返回张量下的 attentions。
output_hidden_states (bool, optional) — 是否返回所有层的隐藏状态。有关更多详细信息，请参阅返回张量下的 hidden_states。
return_dict (bool, optional) — 是否返回一个 ModelOutput 而不是一个简单的元组。
labels (List[Dict] 长度为 (batch_size,), optional) — 用于计算二部匹配损失的标签。字典列表，每个字典至少包含以下 2 个键：“class_labels” 和“boxes”（分别为批次中图像的类别标签和边界框）。类别标签本身应该是长度为 (图像中的边界框数量,) 的 torch.LongTensor，而盒子则是形状为 (图像中的边界框数量, 4) 的 torch.FloatTensor。

transformers.models.table_transformer.modeling_table_transformer.TableTransformerObjectDetectionOutput 或 tuple(torch.FloatTensor)

一个 transformers.models.table_transformer.modeling_table_transformer.TableTransformerObjectDetectionOutput 或一个 torch.FloatTensor 元组（如果传递了 return_dict=False 或当 config.return_dict=False 时），包含根据配置 (TableTransformerConfig) 和输入而定的各种元素。

loss (torch.FloatTensor 形状为 (1,), optional, 当提供 labels 时返回) — 作为负对数似然（交叉熵）对类别预测和边界框损失的线性组合的总损失。后者定义为 L1 损失和广义尺度不变 IoU 损失的线性组合。
loss_dict (Dict, optional) — 包含各个损失的字典。对日志记录很有用。
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] 中归一化，相对于批次中每个单独图像的大小（不考虑可能的填充）。可以使用 ~TableTransformerImageProcessor.post_process_object_detection 检索未归一化的边界框。
auxiliary_outputs (list[Dict], optional) — 可选，仅在激活辅助损失时返回（即 config.auxiliary_loss 设置为 True）并且提供标签。它是一个字典列表，包含每个解码器层的两个以上键 (logits 和 pred_boxes)。
last_hidden_state (torch.FloatTensor 形状为 (batch_size, sequence_length, hidden_size), optional) — 模型解码器最后一层的隐藏状态序列。
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 (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_heads, sequence_length, sequence_length)。编码器的注意力权重，在注意力 softmax 之后，用于计算自注意力头中的加权平均。

The TableTransformerForObjectDetection forward method, overrides the __call__ special method.

示例

>>> from huggingface_hub import hf_hub_download
>>> from transformers import AutoImageProcessor, TableTransformerForObjectDetection
>>> import torch
>>> from PIL import Image

>>> file_path = hf_hub_download(repo_id="nielsr/example-pdf", repo_type="dataset", filename="example_pdf.png")
>>> image = Image.open(file_path).convert("RGB")

>>> image_processor = AutoImageProcessor.from_pretrained("microsoft/table-transformer-detection")
>>> model = TableTransformerForObjectDetection.from_pretrained("microsoft/table-transformer-detection")

>>> 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 table with confidence 1.0 at location [202.1, 210.59, 1119.22, 385.09]

< > Update on GitHub

←Swin2SR UperNet→