Table Transformer
概述
Table Transformer 模型由 Brandon Smock、Rohith Pesala、Robin Abraham 在PubTables-1M: Towards comprehensive table extraction from unstructured documents 中提出。作者引入了一个新的数据集 PubTables-1M，用于评估从非结构化文档中提取表格、以及表格结构识别和功能分析的进展。作者训练了 2 个 DETR 模型，一个用于表格检测，另一个用于表格结构识别，统称为 Table Transformers。
该论文的摘要如下
最近，在将机器学习应用于从非结构化文档中进行表格结构推断和提取的问题上取得了重大进展。然而，最大的挑战之一仍然是以规模创建具有完整、明确的真实数据的数据集。为了解决这个问题，我们开发了一个新的、更全面的表格提取数据集，名为 PubTables-1M。PubTables-1M 包含来自科学文章的近一百万个表格，支持多种输入模式，并包含表格结构的详细标题和位置信息，使其可用于各种建模方法。它还使用一种新颖的规范化程序，解决了在先前数据集中观察到的称为过度分割的真实数据不一致性的重要来源。我们证明，这些改进显着提高了训练性能，并为表格结构识别提供了更可靠的模型性能评估估计。此外，我们表明，在 PubTables-1M 上训练的基于 Transformer 的对象检测模型在检测、结构识别和功能分析的所有三项任务中都产生了出色的结果，而无需对这些任务进行任何特殊定制。
表格检测和表格结构识别的说明。摘自原始论文。作者发布了 2 个模型，一个用于文档中的表格检测，一个用于表格结构识别（识别表格中各个行、列等的任务）。
资源
TableTransformerConfig
class transformers.TableTransformerConfig
< source >( 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, 可选, 默认为 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或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) — 用于初始化所有权重矩阵的 truncated_normal_initializer 的标准差。 - init_xavier_std (
float, optional, defaults to 1) — 用于 HM Attention map 模块中 Xavier 初始化增益的缩放因子。 - encoder_layerdrop (
float, optional, defaults to 0.0) — 编码器的 LayerDrop 概率。 有关更多详细信息，请参阅 [LayerDrop 论文](see https://arxiv.org/abs/1909.11556)。 - decoder_layerdrop (
float, optional, defaults to 0.0) — 解码器的 LayerDrop 概率。 有关更多详细信息，请参阅 [LayerDrop 论文](see https://arxiv.org/abs/1909.11556)。 - auxiliary_loss (
bool, optional, defaults toFalse) — 是否使用辅助解码损失（每个解码器层的损失）。 - position_embedding_type (
str, optional, defaults to"sine") — 要在图像特征之上使用的位置嵌入类型。 可以是"sine"或"learned"之一。 - backbone (
str, optional) — 当backbone_config为None时，要使用的 backbone 的名称。 如果use_pretrained_backbone为True，这将从 timm 或 transformers 库加载相应的预训练权重。 如果use_pretrained_backbone为False，这将加载 backbone 的配置并使用它来初始化具有随机权重的 backbone。 - use_pretrained_backbone (
bool, optional,True) — 是否使用 backbone 的预训练权重。 - backbone_kwargs (
dict, optional) — 从检查点加载时要传递给 AutoBackbone 的关键字参数，例如{'out_indices': (0, 1, 2, 3)}。 如果设置了backbone_config，则无法指定。 - dilation (
bool, optional, defaults toFalse) — 是否在最后一个卷积块 (DC5) 中用 dilation 替换 stride。 仅当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) — 匈牙利匹配成本中边界框的 generalized IoU 损失的相对权重。 - mask_loss_coefficient (
float, optional, defaults to 1) — 全景分割损失中 Focal 损失的相对权重。 - dice_loss_coefficient (
float, optional, defaults to 1) — 全景分割损失中 DICE/F-1 损失的相对权重。 - bbox_loss_coefficient (
float, optional, defaults to 5) — 对象检测损失中 L1 边界框损失的相对权重。 - giou_loss_coefficient (
float, optional, defaults to 2) — 对象检测损失中 generalized IoU 损失的相对权重。 - eos_coefficient (
float, optional, defaults to 0.1) — 对象检测损失中 ‘no-object’ 类的相对分类权重。
这是用于存储 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.configTableTransformerModel
class transformers.TableTransformerModel
< source >( config: TableTransformerConfig )
参数
- config (TableTransformerConfig) — 具有模型所有参数的模型配置类。 使用配置文件初始化不会加载与模型关联的权重，而只会加载配置。 查看 from_pretrained() 方法以加载模型权重。
裸 Table Transformer 模型（由 backbone 和编码器-解码器 Transformer 组成）输出原始隐藏状态，顶部没有任何特定的 head。
此模型继承自 PreTrainedModel。 查看超类文档，了解库为其所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、剪枝 head 等）。
此模型也是 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 output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None ) → transformers.models.table_transformer.modeling_table_transformer.TableTransformerModelOutput or 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) 组成，形状为(batch_size, sequence_length, hidden_size)的last_hidden_state，可选) 是编码器最后一层输出的隐藏状态序列。 在解码器的交叉注意力中使用。 - 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 的 forward 方法，覆盖了 __call__ 特殊方法。
尽管 forward 传递的配方需要在该函数中定义，但是应该在之后调用 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。 查看超类文档，了解库为其所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、剪枝 head 等）。
此模型也是 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), 可选) — 元组由 (last_hidden_state, 可选:hidden_states, 可选:attentions) 组成，形状为(batch_size, sequence_length, hidden_size)的last_hidden_state，可选) 是编码器最后一层输出的隐藏状态序列。 在解码器的交叉注意力中使用。 - 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,)，可选) — 用于计算二分图匹配损失的标签。 字典列表，每个字典至少包含以下 2 个键：‘class_labels’ 和 ‘boxes’ (分别为批次中图像的类别标签和边界框)。 类别标签本身应为长度为(图像中边界框的数量,)的torch.LongTensor，而 boxes 应为形状为(图像中边界框的数量, 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 (形状为
(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] 范围内归一化，相对于批次中每个单独图像的大小 (忽略可能的填充)。 您可以使用~TableTransformerImageProcessor.post_process_object_detection来检索未归一化的边界框。 - auxiliary_outputs (
list[Dict], 可选) — 可选，仅当辅助损失被激活时 (即config.auxiliary_loss设置为True) 且提供 labels 时返回。 它是字典列表，包含每个解码器层的上述两个键 (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 (
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 之后，用于计算自注意力头中的加权平均值。
TableTransformerForObjectDetection forward 方法，覆盖了 __call__ 特殊方法。
尽管 forward 传递的配方需要在该函数中定义，但是应该在之后调用 Module 实例而不是此函数，因为前者负责运行预处理和后处理步骤，而后者会默默地忽略它们。
示例
>>> 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]