LiLT

概述

LiLT 模型由 Jiapeng Wang、Lianwen Jin 和 Kai Ding 在 LiLT: A Simple yet Effective Language-Independent Layout Transformer for Structured Document Understanding 中提出。LiLT 允许将任何预训练的 RoBERTa 文本编码器与轻量级布局 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 的演示笔记本可以在这里找到。

文档资源

如果您有兴趣在此处提交资源，请随时开启 Pull Request，我们将对其进行审查！该资源最好能展示一些新内容，而不是重复现有资源。

LiltConfig

class transformers.LiltConfig

< source >

( 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 可以表示的不同 token 的数量。
hidden_size (int, 可选, 默认为 768) — 编码器层和池化层的维度。应为 24 的倍数。
num_hidden_layers (int, 可选, 默认为 12) — Transformer 编码器中的隐藏层数量。
num_attention_heads (int, 可选, 默认为 12) — Transformer 编码器中每个注意力层的注意力头数量。
intermediate_size (int, 可选, 默认为 3072) — Transformer 编码器中“中间”（通常称为前馈）层的维度。
hidden_act (str 或 Callable, 可选, 默认为 "gelu") — 编码器和池化器中的非线性激活函数（函数或字符串）。如果是字符串，支持 "gelu", "relu", "silu" 和 "gelu_new"。
hidden_dropout_prob (float, 可选, 默认为 0.1) — 嵌入、编码器和池化器中所有全连接层的 dropout 概率。
attention_probs_dropout_prob (float, 可选, 默认为 0.1) — 注意力概率的 dropout 比率。
max_position_embeddings (int, 可选, 默认为 512) — 该模型可能使用的最大序列长度。通常情况下，为了以防万一，将其设置为一个较大的值（例如 512 或 1024 或 2048）。
type_vocab_size (int, 可选, 默认为 2) — 调用 LiltModel 时传入的 token_type_ids 的词汇表大小。
initializer_range (float, 可选, 默认为 0.02) — 用于初始化所有权重矩阵的 truncated_normal_initializer 的标准差。
layer_norm_eps (float, 可选, 默认为 1e-12) — 层归一化层使用的 epsilon。
position_embedding_type (str, 可选, 默认为 "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, 可选) — 分类头的 dropout 比率。
channel_shrink_ratio (int, 可选, 默认为 4) — 布局嵌入的通道维度相对于 hidden_size 的收缩比。
max_2d_position_embeddings (int, 可选, 默认为 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 (LiltModel) — 包含模型所有参数的模型配置类。使用配置文件初始化并不会加载与模型相关的权重，只加载配置。要加载模型权重，请查看 from_pretrained() 方法。
add_pooling_layer (bool, 可选, 默认为 True) — 是否添加池化层。

Lilt 模型输出原始隐藏状态，顶部没有特定头部。

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

该模型也是 PyTorch torch.nn.Module 的子类。将其作为常规 PyTorch 模块使用，并参考 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.Tensor, 形状为 (batch_size, sequence_length), 可选) — 词汇表中输入序列 token 的索引。默认情况下会忽略填充。

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

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

什么是位置 ID？
head_mask (形状为 (num_heads,) 或 (num_layers, num_heads) 的 torch.Tensor，可选) — 用于使自注意力模块的选定头无效的掩码。掩码值在 [0, 1] 之间选择：
- 1 表示头 未被掩盖，
- 0 表示头 被掩盖。
inputs_embeds (形状为 (batch_size, sequence_length, hidden_size) 的 torch.FloatTensor，可选) — 可选地，你可以选择直接传入嵌入表示而不是 input_ids。如果你想比模型的内部嵌入查找矩阵更精细地控制如何将 input_ids 索引转换为关联向量，这会很有用。
output_attentions (bool，可选) — 是否返回所有注意力层的注意力张量。更多详细信息请参阅返回张量下的 attentions。
output_hidden_states (bool，可选) — 是否返回所有层的隐藏状态。更多详细信息请参阅返回张量下的 hidden_states。
return_dict (bool，可选) — 是否返回 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 (形状为 (batch_size, hidden_size) 的 torch.FloatTensor) — 序列的第一个 token（分类 token）经过用于辅助预训练任务的层进一步处理后的最后一层隐藏状态。例如，对于 BERT 家族模型，这返回分类 token 经过线性层和 tanh 激活函数处理后的结果。线性层权重在预训练期间通过下一个句子预测（分类）目标进行训练。
hidden_states (tuple(torch.FloatTensor)，可选，当传入 output_hidden_states=True 或 config.output_hidden_states=True 时返回) — torch.FloatTensor 的元组 (如果模型有嵌入层，则一个用于嵌入层的输出，加上每个层的输出) ，形状为 (batch_size, sequence_length, hidden_size)。

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

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

LiltModel` 的 forward 方法，重写了 `__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")
>>> 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 (LiltForSequenceClassification) — 包含模型所有参数的模型配置类。使用配置文件初始化并不会加载与模型相关的权重，仅加载配置。请查看 from_pretrained() 方法以加载模型权重。

LiLT 模型变压器，顶部带有序列分类/回归头（在池化输出之上有一个线性层），例如用于 GLUE 任务。

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

该模型也是 PyTorch torch.nn.Module 的子类。将其作为常规 PyTorch 模块使用，并参考 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 (形状为 (batch_size, sequence_length) 的 torch.LongTensor，可选) — 词表中输入序列 token 的索引。默认情况下会忽略填充。

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

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

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

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

一个 transformers.modeling_outputs.SequenceClassifierOutput 或一个 torch.FloatTensor 的元组 (如果传入了 return_dict=False 或 config.return_dict=False)，其中包含根据配置 (LiltConfig) 和输入而定的各种元素。

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

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

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

LiltForSequenceClassification` 的 forward 方法，重写了 `__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")
>>> 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 (LiltForTokenClassification) — 包含模型所有参数的模型配置类。使用配置文件初始化并不会加载与模型相关的权重，仅加载配置。请查看 from_pretrained() 方法以加载模型权重。

Lilt 变压器，顶部带有 token 分类头（在隐藏状态输出之上有一个线性层），例如用于命名实体识别 (NER) 任务。

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

该模型也是 PyTorch torch.nn.Module 的子类。将其作为常规 PyTorch 模块使用，并参考 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 (形状为 (batch_size, sequence_length) 的 torch.LongTensor，可选) — 词表中输入序列 token 的索引。默认情况下会忽略填充。

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

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

什么是位置 ID？
head_mask (形状为 (num_heads,) 或 (num_layers, num_heads) 的 torch.FloatTensor，可选) — 用于使自注意力模块的选定头无效的掩码。掩码值在 [0, 1] 之间选择：
- 1 表示头 未被掩盖，
- 0 表示头 被掩盖。
inputs_embeds (形状为 (batch_size, sequence_length, hidden_size) 的 torch.FloatTensor，可选) — 可选地，你可以选择直接传入嵌入表示而不是 input_ids。如果你想比模型的内部嵌入查找矩阵更精细地控制如何将 input_ids 索引转换为关联向量，这会很有用。
labels (形状为 (batch_size, sequence_length) 的 torch.LongTensor，可选) — 用于计算 token 分类损失的标签。索引应在 [0, ..., config.num_labels - 1] 之间。
output_attentions (bool，可选) — 是否返回所有注意力层的注意力张量。更多详细信息请参阅返回张量下的 attentions。
output_hidden_states (bool，可选) — 是否返回所有层的隐藏状态。更多详细信息请参阅返回张量下的 hidden_states。
return_dict (bool，可选) — 是否返回 ModelOutput 而不是普通的元组。

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

一个 transformers.modeling_outputs.TokenClassifierOutput 或一个 torch.FloatTensor 的元组 (如果传入了 return_dict=False 或 config.return_dict=False)，其中包含根据配置 (LiltConfig) 和输入而定的各种元素。

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

模型在每个层输出的隐藏状态以及可选的初始嵌入输出。
attentions (tuple(torch.FloatTensor)，可选，当传入 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")
>>> 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 (LiltForQuestionAnswering) — 包含模型所有参数的模型配置类。使用配置文件初始化并不会加载与模型相关的权重，仅加载配置。请查看 from_pretrained() 方法以加载模型权重。

Lilt 变压器，顶部带有用于 SQuAD 等抽取式问答任务的跨度分类头（在隐藏状态输出之上有一个线性层，用于计算 span start logits 和 span end logits）。

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

该模型也是 PyTorch torch.nn.Module 的子类。将其作为常规 PyTorch 模块使用，并参考 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 (形状为 (batch_size, sequence_length) 的 torch.LongTensor，可选) — 词表中输入序列 token 的索引。默认情况下会忽略填充。

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

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

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

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

一个 transformers.modeling_outputs.QuestionAnsweringModelOutput 或一个 torch.FloatTensor 元组（如果传递 return_dict=False 或 config.return_dict=False），包含取决于配置 (LiltConfig) 和输入的不同元素。

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

模型在每个层输出的隐藏状态以及可选的初始嵌入输出。
attentions (tuple(torch.FloatTensor)，可选，当传入 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")
>>> 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