LiLT

概述

LiLT 模型由 Jiapeng Wang、Lianwen Jin 和 Kai Ding 在 LiLT: A Simple yet Effective Language-Independent Layout Transformer for Structured Document Understanding 中提出。LiLT 允许将任何预训练的 RoBERTa 文本编码器与轻量级的 Layout Transformer 结合使用，从而为多种语言实现类似 LayoutLM 的文档理解。

论文摘要如下

结构化文档理解近来引起了相当大的关注并取得了显著进展，因为它在智能文档处理中起着至关重要的作用。然而，大多数现有的相关模型只能处理预训练集中包含的特定语言（通常是英语）的文档数据，这非常有限。为了解决这个问题，我们提出了一种简单而有效的语言无关布局 Transformer (LiLT) 用于结构化文档理解。LiLT 可以在单个语言的结构化文档上进行预训练，然后直接在使用相应的现成单语/多语预训练文本模型的其他语言上进行微调。在八种语言上的实验结果表明，LiLT 可以在各种广泛使用的下游基准测试中实现有竞争力甚至更优越的性能，这使得从文档布局结构的预训练中获得语言无关的益处。

LiLT 架构。摘自原始论文。

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

使用技巧

要将语言无关布局 Transformer 与来自 hub 的新 RoBERTa 检查点结合使用，请参考本指南。该脚本将导致 config.json 和 pytorch_model.bin 文件本地存储。完成此操作后，可以执行以下操作（假设您已使用您的 HuggingFace 帐户登录）

from transformers import LiltModel

model = LiltModel.from_pretrained("path_to_your_files")
model.push_to_hub("name_of_repo_on_the_hub")

在为模型准备数据时，请确保使用与您与布局 Transformer 结合的 RoBERTa 检查点相对应的令牌词汇表。
由于 lilt-roberta-en-base 使用与 LayoutLMv3 相同的词汇表，因此可以使用 LayoutLMv3TokenizerFast 为模型准备数据。lilt-roberta-en-base 也是如此：可以使用 LayoutXLMTokenizerFast 用于该模型。

资源

官方 Hugging Face 和社区（🌎 表示）资源的列表，可帮助您开始使用 LiLT。

LiLT 的演示 notebook 可以在这里找到。

文档资源

如果您有兴趣提交资源以包含在此处，请随时打开 Pull Request，我们将对其进行审核！该资源最好展示一些新的东西，而不是复制现有资源。

LiltConfig

class transformers.LiltConfig

< 源代码 >

( vocab_size = 30522 hidden_size = 768 num_hidden_layers = 12 num_attention_heads = 12 intermediate_size = 3072 hidden_act = 'gelu' hidden_dropout_prob = 0.1 attention_probs_dropout_prob = 0.1 max_position_embeddings = 512 type_vocab_size = 2 initializer_range = 0.02 layer_norm_eps = 1e-12 pad_token_id = 0 position_embedding_type = 'absolute' classifier_dropout = None channel_shrink_ratio = 4 max_2d_position_embeddings = 1024 **kwargs )

参数

vocab_size (int, 可选, 默认为 30522) — LiLT 模型的词汇表大小。定义了在调用 LiltModel 时传递的 inputs_ids 可以表示的不同令牌的数量。
hidden_size (int, 可选, 默认为 768) — 编码器层和池化器层的维度。应为 24 的倍数。
num_hidden_layers (int, optional, defaults to 12) — Transformer 编码器中的隐藏层数。
num_attention_heads (int, optional, defaults to 12) — Transformer 编码器中每个注意力层的注意力头数。
intermediate_size (int, optional, defaults to 3072) — Transformer 编码器中“中间”层（通常称为前馈层）的维度。
hidden_act (str or Callable, optional, defaults to "gelu") — 编码器和池化器中的非线性激活函数（函数或字符串）。如果为字符串，则支持 "gelu"、"relu"、"silu" 和 "gelu_new"。
hidden_dropout_prob (float, optional, defaults to 0.1) — 嵌入层、编码器和池化器中所有全连接层的 dropout 概率。
attention_probs_dropout_prob (float, optional, defaults to 0.1) — 注意力概率的 dropout 比率。
max_position_embeddings (int, optional, defaults to 512) — 此模型可能使用的最大序列长度。通常将其设置为较大的值以防万一（例如，512 或 1024 或 2048）。
type_vocab_size (int, optional, defaults to 2) — 调用 LiltModel 时传递的 token_type_ids 的词汇表大小。
initializer_range (float, optional, defaults to 0.02) — 用于初始化所有权重矩阵的 truncated_normal_initializer 的标准差。
layer_norm_eps (float, optional, defaults to 1e-12) — 层归一化层使用的 epsilon 值。
position_embedding_type (str, optional, defaults to "absolute") — 位置嵌入的类型。选择 "absolute"、"relative_key"、"relative_key_query" 之一。对于位置嵌入，使用 "absolute"。有关 "relative_key" 的更多信息，请参阅 Self-Attention with Relative Position Representations (Shaw et al.)。有关 "relative_key_query" 的更多信息，请参阅 Improve Transformer Models with Better Relative Position Embeddings (Huang et al.) 中的方法 4。
classifier_dropout (float, optional) — 分类头的 dropout 比率。
channel_shrink_ratio (int, optional, defaults to 4) — 相对于 hidden_size 的收缩率，用于布局嵌入的通道维度。
max_2d_position_embeddings (int, optional, defaults to 1024) — 2D 位置嵌入可能使用的最大值。通常将其设置为较大的值以防万一（例如，1024）。

这是用于存储 LiltModel 配置的配置类。它用于根据指定的参数实例化 LiLT 模型，定义模型架构。使用默认值实例化配置将产生与 LiLT SCUT-DLVCLab/lilt-roberta-en-base 架构类似的配置。配置对象继承自 PretrainedConfig，可用于控制模型输出。阅读 PretrainedConfig 的文档以获取更多信息。

示例

>>> from transformers import LiltConfig, LiltModel

>>> # Initializing a LiLT SCUT-DLVCLab/lilt-roberta-en-base style configuration
>>> configuration = LiltConfig()
>>> # Randomly initializing a model from the SCUT-DLVCLab/lilt-roberta-en-base style configuration
>>> model = LiltModel(configuration)
>>> # Accessing the model configuration
>>> configuration = model.config

LiltModel

class transformers.LiltModel

< source >

( config add_pooling_layer = True )

参数

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

裸 LiLT 模型 Transformer 输出原始隐藏状态，顶部没有任何特定的 head。此模型继承自 PreTrainedModel。查看超类文档以了解库为其所有模型实现的通用方法（例如下载或保存，调整输入嵌入大小，剪枝 head 等）。

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

forward

< source >

( input_ids: typing.Optional[torch.Tensor] = None bbox: typing.Optional[torch.Tensor] = None attention_mask: typing.Optional[torch.Tensor] = None token_type_ids: typing.Optional[torch.Tensor] = None position_ids: typing.Optional[torch.Tensor] = None head_mask: typing.Optional[torch.Tensor] = None inputs_embeds: typing.Optional[torch.Tensor] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None ) → transformers.modeling_outputs.BaseModelOutputWithPooling 或 tuple(torch.FloatTensor)

参数

input_ids (torch.LongTensor of shape (batch_size, sequence_length)) — 词汇表中输入序列 tokens 的索引。

可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。

什么是输入 ID？
bbox (torch.LongTensor of shape (batch_size, sequence_length, 4), optional) — 每个输入序列 token 的边界框。在范围 [0, config.max_2d_position_embeddings-1] 中选择。每个边界框应为 (x0, y0, x1, y1) 格式的归一化版本，其中 (x0, y0) 对应于边界框中左上角的位置，而 (x1, y1) 表示右下角的位置。有关归一化，请参阅概述。
attention_mask (torch.FloatTensor of shape (batch_size, sequence_length), optional) — 用于避免在 padding token 索引上执行注意力的 Mask。Mask 值在 [0, 1] 中选择：
- 1 表示 token 未被 mask，
- 0 表示 token 已被 mask。
什么是注意力 Mask？
token_type_ids (torch.LongTensor of shape (batch_size, sequence_length), optional) — 分段 token 索引，用于指示输入的第一部分和第二部分。索引在 [0, 1] 中选择：
- 0 对应于 句子 A token，
- 1 对应于 句子 B token。
什么是 token 类型 ID？
position_ids (torch.LongTensor of shape (batch_size, sequence_length), optional) — 每个输入序列 token 在位置嵌入中的位置索引。在范围 [0, config.max_position_embeddings - 1] 中选择。

什么是位置 ID？
head_mask (torch.FloatTensor of shape (num_heads,) or (num_layers, num_heads), optional) — 用于 nullify 自注意力模块的选定 head 的 Mask。Mask 值在 [0, 1] 中选择：
- 1 表示 head 未被 mask，
- 0 表示 head 已被 mask。
inputs_embeds (torch.FloatTensor of shape (batch_size, sequence_length, hidden_size), optional) — （可选）您可以选择直接传递嵌入表示，而不是传递 input_ids。如果您希望比模型的内部嵌入查找矩阵更精细地控制如何将 input_ids 索引转换为关联的向量，这将非常有用。
output_attentions (bool, optional) — 是否返回所有注意力层的注意力张量。更多细节请参阅返回张量下的 attentions 。
output_hidden_states (bool, optional) — 是否返回所有层的隐藏状态。更多细节请参阅返回张量下的 hidden_states 。
return_dict (bool, optional) — 是否返回 ModelOutput 而不是普通元组。

transformers.modeling_outputs.BaseModelOutputWithPooling 或 tuple(torch.FloatTensor)

transformers.modeling_outputs.BaseModelOutputWithPooling 或 torch.FloatTensor 元组 (如果传递了 return_dict=False 或当 config.return_dict=False 时)，其中包含各种元素，具体取决于配置 (LiltConfig) 和输入。

last_hidden_state (torch.FloatTensor，形状为 (batch_size, sequence_length, hidden_size)) — 模型最后一层的输出处的隐藏状态序列。
pooler_output (torch.FloatTensor，形状为 (batch_size, hidden_size)) — 序列的第一个 token (分类 token) 的最后一层隐藏状态，经过用于辅助预训练任务的层进一步处理之后。例如，对于 BERT 系列模型，这返回通过线性层和 tanh 激活函数处理后的分类 token。线性层权重是通过预训练期间的下一句预测（分类）目标训练的。
hidden_states (tuple(torch.FloatTensor), optional, 当传递 output_hidden_states=True 或当 config.output_hidden_states=True 时返回) — torch.FloatTensor 元组（如果模型具有嵌入层，则embeddings 的输出为一个，+ 每层的输出为一个），形状为 (batch_size, sequence_length, hidden_size)。

模型在每一层输出处的隐藏状态，加上可选的初始嵌入输出。
attentions (tuple(torch.FloatTensor), optional, 当传递 output_attentions=True 或当 config.output_attentions=True 时返回) — torch.FloatTensor 元组（每层一个），形状为 (batch_size, num_heads, sequence_length, sequence_length)。

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

LiltModel 前向方法，覆盖了 __call__ 特殊方法。

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

示例

>>> from transformers import AutoTokenizer, AutoModel
>>> from datasets import load_dataset

>>> tokenizer = AutoTokenizer.from_pretrained("SCUT-DLVCLab/lilt-roberta-en-base")
>>> model = AutoModel.from_pretrained("SCUT-DLVCLab/lilt-roberta-en-base")

>>> dataset = load_dataset("nielsr/funsd-layoutlmv3", split="train", trust_remote_code=True)
>>> example = dataset[0]
>>> words = example["tokens"]
>>> boxes = example["bboxes"]

>>> encoding = tokenizer(words, boxes=boxes, return_tensors="pt")

>>> outputs = model(**encoding)
>>> last_hidden_states = outputs.last_hidden_state

LiltForSequenceClassification

class transformers.LiltForSequenceClassification

< source >

( config )

参数

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

LiLT 模型转换器，顶部带有序列分类/回归头（池化输出顶部的线性层），例如用于 GLUE 任务。

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

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

forward

< source >

( input_ids: typing.Optional[torch.LongTensor] = None bbox: typing.Optional[torch.Tensor] = None attention_mask: typing.Optional[torch.FloatTensor] = None token_type_ids: typing.Optional[torch.LongTensor] = None position_ids: typing.Optional[torch.LongTensor] = None head_mask: typing.Optional[torch.FloatTensor] = None inputs_embeds: typing.Optional[torch.FloatTensor] = None labels: typing.Optional[torch.LongTensor] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None ) → transformers.modeling_outputs.SequenceClassifierOutput 或 tuple(torch.FloatTensor)

参数

input_ids (torch.LongTensor，形状为 (batch_size, sequence_length)) — 词汇表中输入序列 token 的索引。

索引可以使用 AutoTokenizer 获得。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call() 。

什么是输入 ID？
bbox (torch.LongTensor，形状为 (batch_size, sequence_length, 4), optional) — 每个输入序列 token 的边界框。在范围 [0, config.max_2d_position_embeddings-1] 中选择。每个边界框应为 (x0, y0, x1, y1) 格式的标准化版本，其中 (x0, y0) 对应于边界框中左上角的位置，而 (x1, y1) 表示右下角的位置。有关标准化，请参阅概述。
attention_mask (torch.FloatTensor，形状为 (batch_size, sequence_length), optional) — 用于避免对 padding token 索引执行注意力的掩码。在 [0, 1] 中选择的掩码值：
- 1 表示 未被掩盖 的 token，
- 0 表示 被掩盖 的 token。
什么是注意力掩码？
token_type_ids (torch.LongTensor，形状为 (batch_size, sequence_length), optional) — 分段 token 索引，用于指示输入的第一个和第二个部分。索引在 [0, 1] 中选择：
- 0 对应于 句子 A token，
- 1 对应于 句子 B token。
什么是 token 类型 ID？
position_ids (torch.LongTensor，形状为 (batch_size, sequence_length), optional) — 位置嵌入中每个输入序列 token 的位置索引。在范围 [0, config.max_position_embeddings - 1] 中选择。

什么是位置 ID？
head_mask (torch.FloatTensor，形状为 (num_heads,) 或 (num_layers, num_heads), optional) — 用于使自注意力模块的选定头无效的掩码。在 [0, 1] 中选择的掩码值：
- 1 表示头 未被掩盖 ，
- 0 表示头 被掩盖 。
inputs_embeds (torch.FloatTensor，形状为 (batch_size, sequence_length, hidden_size), optional) — 可选地，您可以选择直接传递嵌入表示，而不是传递 input_ids。如果您希望比模型的内部嵌入查找矩阵更好地控制如何将 input_ids 索引转换为关联的向量，这将非常有用。
output_attentions (bool, optional) — 是否返回所有注意力层的注意力张量。更多细节请参阅返回张量下的 attentions 。
output_hidden_states (bool, optional) — 是否返回所有层的隐藏状态。更多细节请参阅返回张量下的 hidden_states 。
return_dict (bool, optional) — 是否返回 ModelOutput 而不是普通元组。
labels (torch.LongTensor，形状为 (batch_size,), optional) — 用于计算序列分类/回归损失的标签。索引应在 [0, ..., config.num_labels - 1] 中。如果 config.num_labels == 1 ，则计算回归损失（均方误差损失）；如果 config.num_labels > 1 ，则计算分类损失（交叉熵损失）。

transformers.modeling_outputs.SequenceClassifierOutput 或 tuple(torch.FloatTensor)

transformers.modeling_outputs.SequenceClassifierOutput 或 torch.FloatTensor 元组 (如果传递了 return_dict=False 或当 config.return_dict=False 时)，其中包含各种元素，具体取决于配置 (LiltConfig) 和输入。

loss (torch.FloatTensor，形状为 (1,), optional, 当提供 labels 时返回) — 分类（或回归，如果 config.num_labels==1）损失。
logits (torch.FloatTensor，形状为 (batch_size, config.num_labels)) — 分类（或回归，如果 config.num_labels==1）得分（在 SoftMax 之前）。
hidden_states (tuple(torch.FloatTensor), optional, 当传递 output_hidden_states=True 或当 config.output_hidden_states=True 时返回) — torch.FloatTensor 元组（如果模型具有嵌入层，则embeddings 的输出为一个，+ 每层的输出为一个），形状为 (batch_size, sequence_length, hidden_size)。

模型在每一层输出处的隐藏状态，加上可选的初始嵌入输出。
attentions (tuple(torch.FloatTensor), optional, 当传递 output_attentions=True 或当 config.output_attentions=True 时返回) — torch.FloatTensor 元组（每层一个），形状为 (batch_size, num_heads, sequence_length, sequence_length)。

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

LiltForSequenceClassification 前向方法，覆盖了 __call__ 特殊方法。

示例

>>> from transformers import AutoTokenizer, AutoModelForSequenceClassification
>>> from datasets import load_dataset

>>> tokenizer = AutoTokenizer.from_pretrained("SCUT-DLVCLab/lilt-roberta-en-base")
>>> model = AutoModelForSequenceClassification.from_pretrained("SCUT-DLVCLab/lilt-roberta-en-base")

>>> dataset = load_dataset("nielsr/funsd-layoutlmv3", split="train", trust_remote_code=True)
>>> example = dataset[0]
>>> words = example["tokens"]
>>> boxes = example["bboxes"]

>>> encoding = tokenizer(words, boxes=boxes, return_tensors="pt")

>>> outputs = model(**encoding)
>>> predicted_class_idx = outputs.logits.argmax(-1).item()
>>> predicted_class = model.config.id2label[predicted_class_idx]

LiltForTokenClassification

class transformers.LiltForTokenClassification

< source >

( config )

参数

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

Lilt 模型，顶部带有 token 分类头（隐藏状态输出顶部的线性层），例如用于命名实体识别 (NER) 任务。

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

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

forward

< source >

( input_ids: typing.Optional[torch.LongTensor] = None bbox: typing.Optional[torch.LongTensor] = None attention_mask: typing.Optional[torch.FloatTensor] = None token_type_ids: typing.Optional[torch.LongTensor] = None position_ids: typing.Optional[torch.LongTensor] = None head_mask: typing.Optional[torch.FloatTensor] = None inputs_embeds: typing.Optional[torch.FloatTensor] = None labels: typing.Optional[torch.LongTensor] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None ) → transformers.modeling_outputs.TokenClassifierOutput 或 tuple(torch.FloatTensor)

参数

input_ids (torch.LongTensor，形状为 (batch_size, sequence_length)) — 词汇表中输入序列 tokens 的索引。

索引可以使用 AutoTokenizer 获得。请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call() 以了解详情。

什么是输入 IDs？
bbox (torch.LongTensor，形状为 (batch_size, sequence_length, 4)，可选) — 每个输入序列 tokens 的边界框。在范围 [0, config.max_2d_position_embeddings-1] 中选择。每个边界框都应该是 (x0, y0, x1, y1) 格式的标准化版本，其中 (x0, y0) 对应于边界框中左上角的位置，而 (x1, y1) 表示右下角的位置。有关标准化，请参阅概述。
attention_mask (torch.FloatTensor，形状为 (batch_size, sequence_length)，可选) — 掩码，用于避免在 padding token 索引上执行 attention。掩码值在 [0, 1] 中选择：
- 1 表示 未被掩码 的 tokens，
- 0 表示 被掩码 的 tokens。
什么是 attention masks？
token_type_ids (torch.LongTensor，形状为 (batch_size, sequence_length)，可选) — Segment token 索引，用于指示输入的第一部分和第二部分。索引在 [0, 1] 中选择：
- 0 对应于 sentence A token，
- 1 对应于 sentence B token。
什么是 token type IDs？
position_ids (torch.LongTensor，形状为 (batch_size, sequence_length)，可选) — 位置嵌入中每个输入序列 tokens 的位置索引。在范围 [0, config.max_position_embeddings - 1] 中选择。

什么是 position IDs？
head_mask (torch.FloatTensor，形状为 (num_heads,) 或 (num_layers, num_heads)，可选) — 掩码，用于使 self-attention 模块的选定 head 失效。掩码值在 [0, 1] 中选择：
- 1 表示 head 未被掩码，
- 0 表示 head 被掩码。
inputs_embeds (torch.FloatTensor，形状为 (batch_size, sequence_length, hidden_size)，可选) — （可选）您可以选择直接传递嵌入表示，而不是传递 input_ids。如果您希望比模型的内部嵌入查找矩阵更精细地控制如何将 input_ids 索引转换为关联的向量，这将非常有用。
output_attentions (bool，可选) — 是否返回所有 attention 层的 attentions 张量。有关更多详细信息，请参阅返回的张量下的 attentions。
output_hidden_states (bool，可选) — 是否返回所有层的 hidden states。有关更多详细信息，请参阅返回的张量下的 hidden_states。
return_dict (bool，可选) — 是否返回 ModelOutput 而不是纯元组。
labels (torch.LongTensor，形状为 (batch_size, sequence_length)，可选) — 用于计算 token 分类损失的标签。索引应在 [0, ..., config.num_labels - 1] 中。

transformers.modeling_outputs.TokenClassifierOutput 或 tuple(torch.FloatTensor)

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

loss (torch.FloatTensor，形状为 (1,)，可选，当提供 labels 时返回) — 分类损失。
logits (torch.FloatTensor，形状为 (batch_size, sequence_length, config.num_labels)) — 分类得分（在 SoftMax 之前）。
hidden_states (tuple(torch.FloatTensor), optional, 当传递 output_hidden_states=True 或当 config.output_hidden_states=True 时返回) — torch.FloatTensor 元组（如果模型具有嵌入层，则embeddings 的输出为一个，+ 每层的输出为一个），形状为 (batch_size, sequence_length, hidden_size)。

模型在每一层输出处的隐藏状态，加上可选的初始嵌入输出。
attentions (tuple(torch.FloatTensor), optional, 当传递 output_attentions=True 或当 config.output_attentions=True 时返回) — torch.FloatTensor 元组（每层一个），形状为 (batch_size, num_heads, sequence_length, sequence_length)。

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

LiltForTokenClassification forward 方法，覆盖了 __call__ 特殊方法。

示例

>>> from transformers import AutoTokenizer, AutoModelForTokenClassification
>>> from datasets import load_dataset

>>> tokenizer = AutoTokenizer.from_pretrained("SCUT-DLVCLab/lilt-roberta-en-base")
>>> model = AutoModelForTokenClassification.from_pretrained("SCUT-DLVCLab/lilt-roberta-en-base")

>>> dataset = load_dataset("nielsr/funsd-layoutlmv3", split="train", trust_remote_code=True)
>>> example = dataset[0]
>>> words = example["tokens"]
>>> boxes = example["bboxes"]

>>> encoding = tokenizer(words, boxes=boxes, return_tensors="pt")

>>> outputs = model(**encoding)
>>> predicted_class_indices = outputs.logits.argmax(-1)

LiltForQuestionAnswering

class transformers.LiltForQuestionAnswering

< source >

( config )

参数

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

Lilt 模型，顶部带有跨度分类 head，用于抽取式问答任务，如 SQuAD（hidden-states 输出顶部的线性层，用于计算 span start logits 和 span end logits）。

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

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

forward

< source >

( input_ids: typing.Optional[torch.LongTensor] = None bbox: typing.Optional[torch.LongTensor] = None attention_mask: typing.Optional[torch.FloatTensor] = None token_type_ids: typing.Optional[torch.LongTensor] = None position_ids: typing.Optional[torch.LongTensor] = None head_mask: typing.Optional[torch.FloatTensor] = None inputs_embeds: typing.Optional[torch.FloatTensor] = None start_positions: typing.Optional[torch.LongTensor] = None end_positions: typing.Optional[torch.LongTensor] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None ) → transformers.modeling_outputs.QuestionAnsweringModelOutput 或 tuple(torch.FloatTensor)

参数

input_ids (torch.LongTensor，形状为 (batch_size, sequence_length)) — 词汇表中输入序列 tokens 的索引。

索引可以使用 AutoTokenizer 获得。请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call() 以了解详情。

什么是输入 IDs？
bbox (torch.LongTensor，形状为 (batch_size, sequence_length, 4)，可选) — 每个输入序列 tokens 的边界框。在范围 [0, config.max_2d_position_embeddings-1] 中选择。每个边界框都应该是 (x0, y0, x1, y1) 格式的标准化版本，其中 (x0, y0) 对应于边界框中左上角的位置，而 (x1, y1) 表示右下角的位置。有关标准化，请参阅概述。
attention_mask (torch.FloatTensor，形状为 (batch_size, sequence_length)，可选) — 掩码，用于避免在 padding token 索引上执行 attention。掩码值在 [0, 1] 中选择：
- 1 表示 未被掩码 的 tokens，
- 0 表示 被掩码 的 tokens。
什么是 attention masks？
token_type_ids (torch.LongTensor，形状为 (batch_size, sequence_length)，可选) — Segment token 索引，用于指示输入的第一部分和第二部分。索引在 [0, 1] 中选择：
- 0 对应于 sentence A token，
- 1 对应于 sentence B token。
什么是 token type IDs？
position_ids (torch.LongTensor，形状为 (batch_size, sequence_length)，可选) — 位置嵌入中每个输入序列 tokens 的位置索引。在范围 [0, config.max_position_embeddings - 1] 中选择。

什么是 position IDs？
head_mask (torch.FloatTensor，形状为 (num_heads,) 或 (num_layers, num_heads)，可选) — 掩码，用于使 self-attention 模块的选定 head 失效。掩码值在 [0, 1] 中选择：
- 1 表示 head 未被掩码，
- 0 表示 head 被掩码。
inputs_embeds (torch.FloatTensor，形状为 (batch_size, sequence_length, hidden_size)，可选) — （可选）您可以选择直接传递嵌入表示，而不是传递 input_ids。如果您希望比模型的内部嵌入查找矩阵更精细地控制如何将 input_ids 索引转换为关联的向量，这将非常有用。
output_attentions (bool，可选) — 是否返回所有 attention 层的 attentions 张量。有关更多详细信息，请参阅返回的张量下的 attentions。
output_hidden_states (bool, 可选) — 是否返回所有层的隐藏状态。更多细节请参阅返回张量下的 hidden_states。
return_dict (bool, 可选) — 是否返回一个 ModelOutput 而不是一个普通的元组。
start_positions (torch.LongTensor, 形状为 (batch_size,), 可选) — 用于计算 token 分类损失的标签，指示标注跨度的起始位置（索引）。位置被限制在序列的长度 (sequence_length) 内。序列之外的位置不被考虑用于计算损失。
end_positions (torch.LongTensor, 形状为 (batch_size,), 可选) — 用于计算 token 分类损失的标签，指示标注跨度的结束位置（索引）。位置被限制在序列的长度 (sequence_length) 内。序列之外的位置不被考虑用于计算损失。

transformers.modeling_outputs.QuestionAnsweringModelOutput 或 tuple(torch.FloatTensor)

一个 transformers.modeling_outputs.QuestionAnsweringModelOutput 或一个 torch.FloatTensor 的元组 (如果传递了 return_dict=False 或当 config.return_dict=False 时)，包含各种元素，具体取决于配置 (LiltConfig) 和输入。

loss (torch.FloatTensor, 形状为 (1,), 可选, 当提供 labels 时返回) — 总跨度提取损失是起始和结束位置的交叉熵损失之和。
start_logits (torch.FloatTensor, 形状为 (batch_size, sequence_length)) — 跨度起始得分 (SoftMax 之前)。
end_logits (torch.FloatTensor, 形状为 (batch_size, sequence_length)) — 跨度结束得分 (SoftMax 之前)。
hidden_states (tuple(torch.FloatTensor), optional, 当传递 output_hidden_states=True 或当 config.output_hidden_states=True 时返回) — torch.FloatTensor 元组（如果模型具有嵌入层，则embeddings 的输出为一个，+ 每层的输出为一个），形状为 (batch_size, sequence_length, hidden_size)。

模型在每一层输出处的隐藏状态，加上可选的初始嵌入输出。
attentions (tuple(torch.FloatTensor), optional, 当传递 output_attentions=True 或当 config.output_attentions=True 时返回) — torch.FloatTensor 元组（每层一个），形状为 (batch_size, num_heads, sequence_length, sequence_length)。

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

LiltForQuestionAnswering 的 forward 方法重写了 __call__ 特殊方法。

示例

>>> from transformers import AutoTokenizer, AutoModelForQuestionAnswering
>>> from datasets import load_dataset

>>> tokenizer = AutoTokenizer.from_pretrained("SCUT-DLVCLab/lilt-roberta-en-base")
>>> model = AutoModelForQuestionAnswering.from_pretrained("SCUT-DLVCLab/lilt-roberta-en-base")

>>> dataset = load_dataset("nielsr/funsd-layoutlmv3", split="train", trust_remote_code=True)
>>> example = dataset[0]
>>> words = example["tokens"]
>>> boxes = example["bboxes"]

>>> encoding = tokenizer(words, boxes=boxes, return_tensors="pt")

>>> outputs = model(**encoding)

>>> answer_start_index = outputs.start_logits.argmax()
>>> answer_end_index = outputs.end_logits.argmax()

>>> predict_answer_tokens = encoding.input_ids[0, answer_start_index : answer_end_index + 1]
>>> predicted_answer = tokenizer.decode(predict_answer_tokens)

< > 在 GitHub 上更新

Transformers

LiLT

概述

使用技巧

资源

LiltConfig

class transformers.LiltConfig

LiltModel

class transformers.LiltModel

forward

LiltForSequenceClassification

class transformers.LiltForSequenceClassification

forward

LiltForTokenClassification

class transformers.LiltForTokenClassification

forward

LiltForQuestionAnswering

class transformers.LiltForQuestionAnswering

forward