Hugging Face 的 LOGO

Transformers 文档

Table Transformer

Hugging Face's logo
加入 Hugging Face 社区

并获得增强的文档体验

开始使用

该模型于 2021-09-30 发布，并于 2022-10-18 添加到 Hugging Face Transformers。

表格转换器

PyTorch

概述

Table Transformer 模型由 Brandon Smock, Rohith Pesala, Robin Abraham 在 PubTables-1M: Towards comprehensive table extraction from unstructured documents 中提出。作者们引入了一个名为 PubTables-1M 的新数据集，用于评估从非结构化文档中提取表格的进展，以及表格结构识别和功能分析。作者们训练了 2 个 DETR 模型，一个用于表格检测，另一个用于表格结构识别，并将其命名为 Table Transformers。

论文摘要如下：

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

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

作者们发布了 2 个模型，一个用于文档中的表格检测，另一个用于表格结构识别（即识别表格中单个行、列等）。

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

资源

物体检测
  • Table Transformer 的演示笔记本可以在 这里找到。
  • 事实证明，图像的填充对于检测非常重要。作者们在 这里 提供了一个有趣的 Github 讨论串。

TableTransformerConfig

class transformers.TableTransformerConfig

< >

( 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' 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 )

参数

  • backbone_config (Union[dict, "PreTrainedConfig"], optional, defaults to ResNetConfig()) — 主干模型的配置。仅在 use_timm_backbone 设置为 False 时使用，在这种情况下，它将默认为 ResNetConfig()。
  • num_channels (int, optional, defaults to 3) — 输入通道数。
  • num_queries (int, optional, defaults to 100) — 对象查询数量，即检测槽。这是 TableTransformerModel 在单张图像中能够检测到的最大对象数量。对于 COCO，我们推荐 100 个查询。
  • d_model (int, optional, defaults to 256) — 层的维度。
  • encoder_layers (int, optional, defaults to 6) — Transformer 编码器中每个注意力层的层数。
  • decoder_layers (int, optional, defaults to 6) — Transformer 解码器中每个注意力层的层数。
  • 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 或 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 paper](see https://huggingface.co/papers/1909.11556)。
  • decoder_layerdrop (float, 可选, 默认值为 0.0) — 解码器的 LayerDrop 概率。更多详细信息请参阅 [LayerDrop paper](see https://huggingface.co/papers/1909.11556)。
  • auxiliary_loss (bool, 可选, 默认值为 False) — 是否使用辅助解码损失（每个解码器层的损失）。
  • position_embedding_type (str, 可选, 默认值为 "sine") — 在图像特征之上使用的位置嵌入的类型。可以是 "sine" 或 "learned"。
  • 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 loss 的相对权重。
  • dice_loss_coefficient (float, 可选, 默认值为 1) — 整体分割损失中 DICE/F-1 loss 的相对权重。
  • 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() 方法。

仅包含骨干网和编码器-解码器 Transformer 的裸 Table Transformer 模型，输出原始隐藏状态，不带任何特定头。

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

此模型也是一个 PyTorch torch.nn.Module 子类。像普通的 PyTorch Module 一样使用它，并参考 PyTorch 文档了解一般用法和行为的所有相关信息。

forward

< >

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

参数

  • pixel_values (torch.FloatTensor，形状为 (batch_size, num_channels, image_size, image_size)) — 对应于输入图像的张量。像素值可以通过 DetrImageProcessorFast 获取。有关详细信息，请参阅 DetrImageProcessorFast.call()（processor_class 使用 DetrImageProcessorFast 来处理图像）。
  • pixel_mask (torch.FloatTensor, 形状为 (batch_size, height, width), 可选) — 用于避免对填充像素值执行注意力的掩码。掩码值选择在 [0, 1] 中：

    • 1 表示真实像素（即未被掩码），
    • 0 表示填充像素（即被掩码）。

    什么是注意力掩码？

  • decoder_attention_mask (torch.FloatTensor, 形状为 (batch_size, num_queries), 可选) — 默认不使用。可用于掩盖对象查询。
  • encoder_outputs (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 (形状为 (batch_size, sequence_length, hidden_size) 的 torch.FloatTensor, 可选) — 模型最后一层输出的隐藏状态序列。

  • past_key_values (~cache_utils.EncoderDecoderCache, optional, returned when use_cache=True is passed or when config.use_cache=True) — It is a Cache instance. For more details, see our kv cache guide.

    Contains pre-computed hidden-states (key and values in the self-attention blocks and optionally if config.is_encoder_decoder=True in the cross-attention blocks) that can be used (see past_key_values input) to speed up sequential decoding.

  • decoder_hidden_states (tuple, optional, returned when output_hidden_states=True is passed or when config.output_hidden_states=True) — Tuple of torch.FloatTensor (one for the output of the embeddings, if the model has an embedding layer, + one for the output of each layer) of shape (batch_size, sequence_length, hidden_size).

    解码器在每一层输出时的隐藏状态以及初始嵌入输出。

  • decoder_attentions (tuple, optional, returned when output_attentions=True is passed or when config.output_attentions=True) — Tuple of torch.FloatTensor (one for each layer) of shape (batch_size, num_heads, sequence_length, sequence_length).

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

  • cross_attentions (tuple, optional, returned when output_attentions=True is passed or when config.output_attentions=True) — Tuple of torch.FloatTensor (one for each layer) of shape (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, optional, returned when output_hidden_states=True is passed or when config.output_hidden_states=True) — Tuple of torch.FloatTensor (one for the output of the embeddings, if the model has an embedding layer, + one for the output of each layer) of shape (batch_size, sequence_length, hidden_size).

    编码器在每一层输出时的隐藏状态以及初始嵌入输出。

  • encoder_attentions (tuple, optional, returned when output_attentions=True is passed or when config.output_attentions=True) — Tuple of torch.FloatTensor (one for each layer) of shape (batch_size, num_heads, sequence_length, sequence_length).

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

  • intermediate_hidden_states (torch.FloatTensor of shape (config.decoder_layers, batch_size, sequence_length, hidden_size), optional, returned when config.auxiliary_loss=True) — Intermediate decoder activations, i.e. the output of each decoder layer, each of them gone through a layernorm.

transformers.models.table_transformer.modeling_table_transformer.TableTransformerModel 的 forward 方法，重写了 __call__ 特殊方法。

虽然 forward pass 的实现需要在此函数中定义，但你应该在之后调用 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

< >

( config: TableTransformerConfig )

参数

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

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

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

此模型也是一个 PyTorch torch.nn.Module 子类。像普通的 PyTorch Module 一样使用它，并参考 PyTorch 文档了解一般用法和行为的所有相关信息。

forward

< >

( pixel_values: FloatTensor pixel_mask: torch.FloatTensor | None = None decoder_attention_mask: torch.FloatTensor | None = None encoder_outputs: torch.FloatTensor | None = None inputs_embeds: torch.FloatTensor | None = None decoder_inputs_embeds: torch.FloatTensor | None = None labels: list[dict] | None = None output_attentions: bool | None = None output_hidden_states: bool | None = None return_dict: bool | None = None **kwargs ) → transformers.models.table_transformer.modeling_table_transformer.TableTransformerObjectDetectionOutput 或 tuple(torch.FloatTensor)

参数

  • pixel_values (torch.FloatTensor, 形状为 (batch_size, num_channels, image_size, image_size)) — 对应于输入图像的张量。可以使用 DetrImageProcessorFast 获取像素值。有关详细信息，请参阅 DetrImageProcessorFast.call() （processor_class 使用 DetrImageProcessorFast 来处理图像）。
  • pixel_mask (torch.FloatTensor, 形状为 (batch_size, height, width), 可选) — 用于避免对填充像素值执行注意力的掩码。掩码值选择在 [0, 1] 中：

    • 1 表示真实像素（即未被掩码），
    • 0 表示填充像素（即被掩码）。

    什么是注意力掩码？

  • decoder_attention_mask (torch.FloatTensor, 形状为 (batch_size, num_queries), 可选) — 默认不使用。可用于掩盖对象查询。
  • encoder_outputs (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), 可选) — 可选地，您可以直接传递嵌入式表示来代替用零张量初始化查询。
  • labels (list[Dict], 长度为 (batch_size,), 可选) — 用于计算二分匹配损失的标签。字典列表，每个字典至少包含以下两个键：“class_labels”和“boxes”（分别为批次中图像的类别标签和边界框）。类别标签本身应为 torch.LongTensor，长度为 (图像中的边界框数量,)，边界框为 torch.FloatTensor，形状为 (图像中的边界框数量, 4)。
  • output_attentions (bool, 可选) — 是否返回所有注意力层的注意力张量。有关详细信息，请参阅返回张量下的 attentions。
  • output_hidden_states (bool, 可选) — 是否返回所有层的隐藏状态。有关详细信息，请参阅返回张量下的 hidden_states。
  • return_dict (bool, 可选) — 是否返回一个 ModelOutput 而不是一个普通元组。

返回

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 of shape (1,), optional, 当提供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] 范围内归一化，相对于批次中每个单独图像的大小（忽略可能的填充）。您可以使用 ~TableTransformerImageProcessor.post_process_object_detection 来获取未归一化的边界框。

  • auxiliary_outputs (list[Dict], optional) — 可选，仅在启用了辅助损失（即config.auxiliary_loss设置为True）且提供了标签时返回。它是一个字典列表，包含每个解码器层的上述两个键（logits和pred_boxes）。

  • last_hidden_state (形状为 (batch_size, sequence_length, hidden_size) 的 torch.FloatTensor，可选) — 模型解码器最后一层输出的隐藏状态序列。

  • decoder_hidden_states (tuple[torch.FloatTensor] | None.decoder_hidden_states, 当传递output_hidden_states=True或当config.output_hidden_states=True时返回) — 形状为(batch_size, sequence_length, hidden_size)的torch.FloatTensor元组（一个用于嵌入层的输出，如果模型有嵌入层，+ 一个用于每个层的输出）。

    解码器在每一层输出时的隐藏状态以及初始嵌入输出。

  • decoder_attentions (tuple[torch.FloatTensor] | None.decoder_attentions, 当传递output_attentions=True或当config.output_attentions=True时返回) — 形状为(batch_size, num_heads, sequence_length, sequence_length)的torch.FloatTensor元组（每个层一个）。

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

  • cross_attentions (tuple[torch.FloatTensor] | None.cross_attentions, 当传递output_attentions=True或当config.output_attentions=True时返回) — 形状为(batch_size, num_heads, sequence_length, sequence_length)的torch.FloatTensor元组（每个层一个）。

    解码器交叉注意力层的注意力权重，在注意力 softmax 之后，用于计算交叉注意力头中的加权平均。

  • encoder_last_hidden_state (torch.FloatTensor | None.encoder_last_hidden_state of shape (batch_size, sequence_length, hidden_size), defaults to None) — 模型编码器最后一层的输出的隐藏状态序列。

  • encoder_hidden_states (tuple[torch.FloatTensor] | None.encoder_hidden_states, 当传递output_hidden_states=True或当config.output_hidden_states=True时返回) — 形状为(batch_size, sequence_length, hidden_size)的torch.FloatTensor元组（一个用于嵌入层的输出，如果模型有嵌入层，+ 一个用于每个层的输出）。

    编码器在每一层输出时的隐藏状态以及初始嵌入输出。

  • encoder_attentions (tuple[torch.FloatTensor] | None.encoder_attentions, 当传递output_attentions=True或当config.output_attentions=True时返回) — 形状为(batch_size, num_heads, sequence_length, sequence_length)的torch.FloatTensor元组（每个层一个）。

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

transformers.TableTransformerForObjectDetection 的 forward 方法，重写了 __call__ 特殊方法。

虽然 forward pass 的实现需要在此函数中定义，但你应该在之后调用 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]
在 GitHub 上更新

←Swin2SR TextNet→
© . This site is unofficial and not affiliated with Hugging Face, Inc.