MarkupLM
概述
MarkupLM 模型由 Junlong Li、Yiheng Xu、Lei Cui、Furu Wei 在 MarkupLM: Pre-training of Text and Markup Language for Visually-rich Document Understanding 中提出。MarkupLM 是 BERT，但应用于 HTML 页面而不是纯文本文档。该模型包含了额外的嵌入层以提高性能，类似于 LayoutLM。
该模型可用于网页问答或网页信息提取等任务。它在两个重要基准测试中获得了最先进的结果。
论文的摘要如下：
使用文本、布局和图像进行多模态预训练在视觉丰富文档理解 (VrDU) 方面取得了重大进展，尤其是扫描文档图像等固定布局文档。然而，仍然存在大量数字文档，其中布局信息不是固定的，需要交互式和动态渲染以供可视化，这使得现有的基于布局的预训练方法难以应用。在本文中，我们提出了 MarkupLM，用于使用标记语言作为骨干的文档理解任务，例如基于 HTML/XML 的文档，其中文本和标记信息被联合预训练。实验结果表明，预训练的 MarkupLM 在多个文档理解任务上明显优于现有的强大基线模型。预训练的模型和代码将公开提供。
该模型由 nielsr 贡献。原始代码可以在这里找到 here。
使用技巧
- 除了
input_ids之外，forward() 还需要两个额外的输入，分别是xpath_tags_seq和xpath_subs_seq。这些分别是输入序列中每个标记的 XPATH 标签和下标。 - 可以使用 MarkupLMProcessor 为模型准备所有数据。有关更多信息，请参阅 使用指南。
MarkupLM 架构。摘自 原始论文。使用：MarkupLMProcessor
为模型准备数据的最简单方法是使用 MarkupLMProcessor，它在内部结合了特征提取器 (MarkupLMFeatureExtractor) 和分词器 (MarkupLMTokenizer 或 MarkupLMTokenizerFast)。特征提取器用于从 HTML 字符串中提取所有节点和 xpath，然后将其提供给分词器，分词器将其转换为模型的标记级别输入 (input_ids 等)。请注意，如果您只想处理这两项任务中的其中一项，您仍然可以分别使用特征提取器和分词器。
from transformers import MarkupLMFeatureExtractor, MarkupLMTokenizerFast, MarkupLMProcessor
feature_extractor = MarkupLMFeatureExtractor()
tokenizer = MarkupLMTokenizerFast.from_pretrained("microsoft/markuplm-base")
processor = MarkupLMProcessor(feature_extractor, tokenizer)简而言之，可以将 HTML 字符串（以及可能的其他数据）提供给 MarkupLMProcessor，它将创建模型所需的输入。在内部，处理器首先使用 MarkupLMFeatureExtractor 获取节点和对应 xpath 的列表。然后将节点和 xpath 提供给 MarkupLMTokenizer 或 MarkupLMTokenizerFast，它们将其转换为标记级别的 input_ids、attention_mask、token_type_ids、xpath_subs_seq、xpath_tags_seq。可以选择将节点标签提供给处理器，这些标签将转换为标记级别的 labels。
MarkupLMFeatureExtractor 在幕后使用 Beautiful Soup，这是一个用于从 HTML 和 XML 文件中提取数据的 Python 库。请注意，您仍然可以使用自己的首选解析解决方案，并将节点和 xpath 自行提供给 MarkupLMTokenizer 或 MarkupLMTokenizerFast。
总共有 5 种处理器支持的用例。下面，我们列出所有用例。请注意，这些用例中的每一个都适用于批量和非批量输入（我们针对非批量输入进行说明）。
用例 1：网页分类 (训练、推理) + 标记分类 (推理)，parse_html = True
这是最简单的用例，其中处理器将使用特征提取器从 HTML 中获取所有节点和 xpath。
>>> from transformers import MarkupLMProcessor
>>> processor = MarkupLMProcessor.from_pretrained("microsoft/markuplm-base")
>>> html_string = """
... <!DOCTYPE html>
... <html>
... <head>
... <title>Hello world</title>
... </head>
... <body>
... <h1>Welcome</h1>
... <p>Here is my website.</p>
... </body>
... </html>"""
>>> # note that you can also add provide all tokenizer parameters here such as padding, truncation
>>> encoding = processor(html_string, return_tensors="pt")
>>> print(encoding.keys())
dict_keys(['input_ids', 'token_type_ids', 'attention_mask', 'xpath_tags_seq', 'xpath_subs_seq'])用例 2：网页分类 (训练、推理) + 标记分类 (推理)，parse_html=False
如果已经获得了所有节点和 xpath，则不需要特征提取器。在这种情况下，应将节点和相应的 xpath 本身提供给处理器，并确保将 parse_html 设置为 False。
>>> from transformers import MarkupLMProcessor
>>> processor = MarkupLMProcessor.from_pretrained("microsoft/markuplm-base")
>>> processor.parse_html = False
>>> nodes = ["hello", "world", "how", "are"]
>>> xpaths = ["/html/body/div/li[1]/div/span", "/html/body/div/li[1]/div/span", "html/body", "html/body/div"]
>>> encoding = processor(nodes=nodes, xpaths=xpaths, return_tensors="pt")
>>> print(encoding.keys())
dict_keys(['input_ids', 'token_type_ids', 'attention_mask', 'xpath_tags_seq', 'xpath_subs_seq'])用例 3：标记分类 (训练)，parse_html=False
对于标记分类任务（例如 SWDE），还可以提供相应的节点标签以训练模型。然后，处理器将将其转换为标记级别的 labels。默认情况下，它只会标记一个单词的第一个词片，并将剩余的词片标记为 -100，这是 PyTorch 的 CrossEntropyLoss 的 ignore_index。如果您希望标记一个单词的所有词片，可以将 only_label_first_subword 设置为 False 初始化分词器。
>>> from transformers import MarkupLMProcessor
>>> processor = MarkupLMProcessor.from_pretrained("microsoft/markuplm-base")
>>> processor.parse_html = False
>>> nodes = ["hello", "world", "how", "are"]
>>> xpaths = ["/html/body/div/li[1]/div/span", "/html/body/div/li[1]/div/span", "html/body", "html/body/div"]
>>> node_labels = [1, 2, 2, 1]
>>> encoding = processor(nodes=nodes, xpaths=xpaths, node_labels=node_labels, return_tensors="pt")
>>> print(encoding.keys())
dict_keys(['input_ids', 'token_type_ids', 'attention_mask', 'xpath_tags_seq', 'xpath_subs_seq', 'labels'])用例 4：网页问答 (推理)，parse_html=True
对于网页上的问答任务，可以将问题提供给处理器。默认情况下，处理器将使用特征提取器获取所有节点和 xpath，并创建 [CLS] 问题标记 [SEP] 词标记 [SEP]。
>>> from transformers import MarkupLMProcessor
>>> processor = MarkupLMProcessor.from_pretrained("microsoft/markuplm-base")
>>> html_string = """
... <!DOCTYPE html>
... <html>
... <head>
... <title>Hello world</title>
... </head>
... <body>
... <h1>Welcome</h1>
... <p>My name is Niels.</p>
... </body>
... </html>"""
>>> question = "What's his name?"
>>> encoding = processor(html_string, questions=question, return_tensors="pt")
>>> print(encoding.keys())
dict_keys(['input_ids', 'token_type_ids', 'attention_mask', 'xpath_tags_seq', 'xpath_subs_seq'])用例 5：网页问答（推理），parse_html=False
对于问答任务（如 WebSRC），你可以向处理器提供一个问题。如果你已经自己提取了所有节点和 xpath，你可以直接将它们提供给处理器。确保将 parse_html 设置为 False。
>>> from transformers import MarkupLMProcessor
>>> processor = MarkupLMProcessor.from_pretrained("microsoft/markuplm-base")
>>> processor.parse_html = False
>>> nodes = ["hello", "world", "how", "are"]
>>> xpaths = ["/html/body/div/li[1]/div/span", "/html/body/div/li[1]/div/span", "html/body", "html/body/div"]
>>> question = "What's his name?"
>>> encoding = processor(nodes=nodes, xpaths=xpaths, questions=question, return_tensors="pt")
>>> print(encoding.keys())
dict_keys(['input_ids', 'token_type_ids', 'attention_mask', 'xpath_tags_seq', 'xpath_subs_seq'])资源
MarkupLMConfig
class transformers.MarkupLMConfig
< 源代码 >( 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 bos_token_id = 0 eos_token_id = 2 max_xpath_tag_unit_embeddings = 256 max_xpath_subs_unit_embeddings = 1024 tag_pad_id = 216 subs_pad_id = 1001 xpath_unit_hidden_size = 32 max_depth = 50 position_embedding_type = 'absolute' use_cache = True classifier_dropout = None **kwargs )
参数
- vocab_size (
int, 可选，默认值为 30522) — MarkupLM 模型的词汇量。定义了可以由传递给 MarkupLMModel 的 forward 方法的 inputs_ids 表示的不同令牌。 - hidden_size (
int, 可选，默认值为 768) — 编码器层和池化层的维度。 - num_hidden_layers (
int, 可选，默认值为 12) — Transformer 编码器中的隐藏层数量。 - num_attention_heads (
int, 可选，默认值为 12) — Transformer 编码器中每个注意力层的注意力头数。 - intermediate_size (
int, 可选，默认值为 3072) — Transformer 编码器中“中间”（即前馈）层的维度。 - hidden_act (
str或function, 可选，默认为"gelu") — 编码器和池化器中的非线性激活函数（函数或字符串）。如果为字符串，则支持"gelu"、"relu"、"silu"和"gelu_new"。 - hidden_dropout_prob (
float, 可选，默认为 0.1) — 嵌入、编码器和池化器中所有全连接层的丢弃概率。 - attention_probs_dropout_prob (
float, 可选，默认为 0.1) — 注意概率的丢弃率。 - max_position_embeddings (
int, 可选，默认为 512) — 此模型可能使用的最大序列长度。通常将其设置为一个较大的值，以防万一（例如，512 或 1024 或 2048）。 - type_vocab_size (
int, 可选，默认为 2) — 传递到 MarkupLMModel 的token_type_ids的词汇量。 - initializer_range (
float, 可选，默认为 0.02) — 初始化所有权重矩阵的截断正态初始化的标准差。 - layer_norm_eps (
float, 可选，默认为 1e-12) — 层归一化层使用的 epsilon。 - max_tree_id_unit_embeddings (
int, 可选，默认为 1024) — 树 ID 单位嵌入可能使用的最大值。通常将其设置为一个较大的值，以防万一（例如，1024）。 - max_xpath_tag_unit_embeddings (
int, 可选，默认为 256) — xpath 标签单位嵌入可能使用的最大值。通常将其设置为一个较大的值，以防万一（例如，256）。 - max_xpath_subs_unit_embeddings (
int, 可选，默认为 1024) — xpath 下标单位嵌入可能使用的最大值。通常将其设置为一个较大的值，以防万一（例如，1024）。 - xpath_tag_unit_hidden_size (
int, 可选, 默认值 32) — 每个树 ID 单元的隐藏大小。一个完整的树索引将具有 (50*xpath_tag_unit_hidden_size)-dim。 - max_depth (
int, 可选, 默认值 50) — xpath 中的最大深度。
这是用于存储 MarkupLMModel 配置的配置类。它用于根据指定的参数实例化一个 MarkupLM 模型，定义模型架构。使用默认值实例化配置将产生与 MarkupLM microsoft/markuplm-base 架构类似的配置。
配置对象继承自 BertConfig，可用于控制模型输出。阅读 BertConfig 的文档以了解更多信息。
示例
>>> from transformers import MarkupLMModel, MarkupLMConfig
>>> # Initializing a MarkupLM microsoft/markuplm-base style configuration
>>> configuration = MarkupLMConfig()
>>> # Initializing a model from the microsoft/markuplm-base style configuration
>>> model = MarkupLMModel(configuration)
>>> # Accessing the model configuration
>>> configuration = model.configMarkupLMFeatureExtractor
构造一个 MarkupLM 特征提取器。这可以用于从 HTML 字符串中获取节点列表和对应的 xpath。
此特征提取器继承自 PreTrainedFeatureExtractor()，其中包含大多数主要方法。用户应参考此超类以获取有关这些方法的更多信息。
__call__
< 源代码 >( html_strings ) → BatchFeature
准备模型一个或多个 HTML 字符串的主要方法。
示例
>>> from transformers import MarkupLMFeatureExtractor
>>> page_name_1 = "page1.html"
>>> page_name_2 = "page2.html"
>>> page_name_3 = "page3.html"
>>> with open(page_name_1) as f:
... single_html_string = f.read()
>>> feature_extractor = MarkupLMFeatureExtractor()
>>> # single example
>>> encoding = feature_extractor(single_html_string)
>>> print(encoding.keys())
>>> # dict_keys(['nodes', 'xpaths'])
>>> # batched example
>>> multi_html_strings = []
>>> with open(page_name_2) as f:
... multi_html_strings.append(f.read())
>>> with open(page_name_3) as f:
... multi_html_strings.append(f.read())
>>> encoding = feature_extractor(multi_html_strings)
>>> print(encoding.keys())
>>> # dict_keys(['nodes', 'xpaths'])MarkupLMTokenizer
class transformers.MarkupLMTokenizer
< 源代码 >( vocab_file merges_file tags_dict errors = 'replace' bos_token = '<s>' eos_token = '</s>' sep_token = '</s>' cls_token = '<s>' unk_token = '<unk>' pad_token = '<pad>' mask_token = '<mask>' add_prefix_space = False max_depth = 50 max_width = 1000 pad_width = 1001 pad_token_label = -100 only_label_first_subword = True **kwargs )
参数
- vocab_file (
str) — 词汇表文件路径。 - merges_file (
str) — 合并文件路径。 - errors (
str, 可选, 默认值为"replace") — 解码字节到 UTF-8 时采用的策略。详情请参考 bytes.decode。 - bos_token (
str, 可选, 默认值为"<s>") — 在预训练过程中使用的序列起始标记。可用于序列分类标记。 - eos_token (
str, 可选, 默认值为"</s>") — 序列结束标记。 - sep_token (
str, 可选, 默认值为"</s>") — 分隔标记，用于从多个序列构建单个序列，例如用于序列分类的两个序列，或用于问答的文本和问题。它也是使用特殊标记构建的序列的最后一个标记。 - cls_token (
str, 可选, 默认值为"<s>") — 分类标记，用于执行序列分类（对整个序列进行分类，而不是对每个标记进行分类）。它是在使用特殊标记构建序列时的第一个标记。 - unk_token (
str, 可选, 默认值为"<unk>") — 未知标记。词汇表中不存在的标记无法转换为 ID，因此设置为此标记。 - pad_token (
str, optional, defaults to"<pad>") — 用于填充的标记，例如在对不同长度的序列进行批处理时。 - mask_token (
str, optional, defaults to"<mask>") — 用于屏蔽值的标记。这是在使用掩码语言建模训练此模型时使用的标记。这是模型将尝试预测的标记。 - add_prefix_space (
bool, optional, defaults toFalse) — 是否在输入中添加前缀空格。这允许像对待其他单词一样对待第一个单词。(RoBERTa 标记器通过前面的空格检测单词的开头)。
构造一个 MarkupLM 标记器。基于字节级字节对编码 (BPE)。MarkupLMTokenizer 可用于将 HTML 字符串转换为令牌级 input_ids、attention_mask、token_type_ids、xpath_tags_seq 和 xpath_tags_seq。此标记器继承自 PreTrainedTokenizer，其中包含大多数主要方法。用户应参考此超类以获取有关这些方法的更多信息。
build_inputs_with_special_tokens
< source >( token_ids_0: List token_ids_1: Optional = None ) → List[int]
通过连接和添加特殊标记，从序列或一对序列为序列分类任务构建模型输入。RoBERTa 序列具有以下格式
- 单个序列:
<s> X </s> - 一对序列:
<s> A </s></s> B </s>
get_special_tokens_mask
< source >( token_ids_0: List token_ids_1: Optional = None already_has_special_tokens: bool = False ) → List[int]
参数
- Retrieve 从没有添加特殊标记的标记列表中检索序列 ID。当添加 —
- special 使用标记器
prepare_for_model方法的标记。 — token_ids_0 (List[int]): ID 列表。 token_ids_1 (List[int], optional): 序列对的可选第二个 ID 列表。 already_has_special_tokens (bool, optional, defaults toFalse): 标记列表是否已使用模型的特殊标记进行格式化。
返回值
List[int]
范围在 [0, 1] 内的整数列表：特殊标记为 1，序列标记为 0。
create_token_
< source >( token_ids_0: List token_ids_1: Optional = None ) → List[int]
从传递的两个序列中创建一个掩码，用于序列对分类任务。RoBERTa 不使用令牌类型 ID，因此返回一个零列表。
MarkupLMTokenizerFast
class transformers.MarkupLMTokenizerFast
< source >( vocab_file merges_file tags_dict tokenizer_file = None errors = 'replace' bos_token = '<s>' eos_token = '</s>' sep_token = '</s>' cls_token = '<s>' unk_token = '<unk>' pad_token = '<pad>' mask_token = '<mask>' add_prefix_space = False max_depth = 50 max_width = 1000 pad_width = 1001 pad_token_label = -100 only_label_first_subword = True trim_offsets = False **kwargs )
参数
- vocab_file (
str) — 词汇表文件路径。 - merges_file (
str) — 合并文件路径。 - eos_token (
str, optional, defaults to"</s>") — 序列结束标记。在使用特殊标记构建序列时，这不是用于序列结束的标记。使用的标记是
sep_token。 - sep_token (
str, optional, defaults to"</s>") — 分隔符标记，用于从多个序列构建序列，例如用于序列分类的两个序列，或者用于问答的文本和问题。它也用作使用特殊标记构建的序列的最后一个标记。 - cls_token (
str, optional, defaults to"<s>") — 当执行序列分类（对整个序列进行分类而不是对每个标记进行分类）时使用的分类标记。它是使用特殊标记构建的序列的第一个标记。 - unk_token (
str, optional, defaults to"<unk>") — 未知标记。不在词汇表中的标记无法转换为 ID，而是设置为此标记。 - pad_token (
str, optional, defaults to"<pad>") — 用于填充的标记，例如在对不同长度的序列进行批处理时。 - mask_token (
str, optional, defaults to"<mask>") — 用于掩蔽值的标记。这是在使用掩蔽语言建模训练此模型时使用的标记。这是模型将尝试预测的标记。 - add_prefix_space (
bool, optional, defaults toFalse) — 是否在输入开头添加空格。这允许将前导词与其他任何词一样对待。（RoBERTa 标记器通过前面的空格检测单词的开头）。
构建 MarkupLM 标记器。基于字节级字节对编码（BPE）。
MarkupLMTokenizerFast 可用于将 HTML 字符串转换为标记级 input_ids、attention_mask、token_type_ids、xpath_tags_seq 和 xpath_tags_seq。此标记器继承自 PreTrainedTokenizer，其中包含大多数主要方法。
用户应参考此超类以获取有关这些方法的更多信息。
batch_encode_plus
< 源代码 >( batch_text_or_text_pairs: Union is_pair: bool = None xpaths: Optional = None node_labels: Union = None add_special_tokens: bool = True padding: Union = False truncation: Union = None max_length: Optional = None stride: int = 0 pad_to_multiple_of: Optional = None return_tensors: Union = None return_token_type_ids: Optional = None return_attention_mask: Optional = None return_overflowing_tokens: bool = False return_special_tokens_mask: bool = False return_offsets_mapping: bool = False return_length: bool = False verbose: bool = True **kwargs )
add_special_tokens (bool, 可选, 默认值为 True): 是否在编码序列时添加特殊标记。这将使用底层的 PretrainedTokenizerBase.build_inputs_with_special_tokens 函数，该函数定义了哪些标记会自动添加到输入 ID 中。如果您想自动添加 bos 或 eos 标记，这将很有用。padding (bool, str 或 PaddingStrategy, 可选, 默认值为 False): 激活并控制填充。接受以下值
True或'longest': 填充到批次中最长的序列（如果只提供一个序列，则不填充）。'max_length': 填充到使用max_length参数指定的最大长度，或者如果未提供该参数，则填充到模型可接受的最大输入长度。False或'do_not_pad'(默认): 不填充（即，可以输出具有不同长度序列的批次）。truncation (bool,str或 TruncationStrategy, 可选, 默认值为False): 激活并控制截断。接受以下值True或'longest_first': 截断到使用max_length参数指定的最大长度，或者如果未提供该参数，则截断到模型可接受的最大输入长度。如果提供了序列对（或批次对），这将逐个标记进行截断，从对中最长的序列中删除一个标记。'only_first': 截断到使用max_length参数指定的最大长度，或者如果未提供该参数，则截断到模型可接受的最大输入长度。如果提供了序列对（或批次对），这将只截断对中的第一个序列。'only_second': 截断到使用max_length参数指定的最大长度，或者如果未提供该参数，则截断到模型可接受的最大输入长度。如果提供了序列对（或批次对），这将只截断对中的第二个序列。False或'do_not_truncate'(默认): 不截断（即，可以输出序列长度大于模型最大可接受输入大小的批次）。max_length (int, 可选): 控制截断/填充参数使用的最大长度。
如果未设置或设置为 None，这将使用预定义的模型最大长度（如果截断/填充参数需要最大长度）。如果模型没有特定的最大输入长度（如 XLNet），则将停用截断/填充到最大长度。stride (int, 可选, 默认值为 0): 如果与 max_length 一起设置为一个数字，则当 return_overflowing_tokens=True 时返回的溢出标记将包含来自截断序列末尾的一些标记，以便在截断序列和溢出序列之间提供一些重叠。此参数的值定义了重叠标记的数量。is_split_into_words (bool, 可选, 默认值为 False): 输入是否已预先标记（例如，拆分为单词）。如果设置为 True，则标记器假设输入已拆分为单词（例如，通过在空格处拆分），它将对这些单词进行标记。这对于 NER 或标记分类很有用。pad_to_multiple_of (int, 可选): 如果设置，则将序列填充到提供的值的倍数。需要激活 padding。这对于在具有计算能力 >= 7.5 (Volta) 的 NVIDIA 硬件上使用 Tensor Core 特别有用。return_tensors (str 或 TensorType, 可选): 如果设置，将返回张量而不是 python 整数列表。可接受的值为
'tf': 返回 TensorFlowtf.constant对象。'pt': 返回 PyTorchtorch.Tensor对象。'np': 返回 Numpynp.ndarray对象。
add_special_tokens (bool, 可选, 默认值为 True): 是否使用与其模型相关的特殊标记对序列进行编码。padding (bool, str 或 PaddingStrategy, 可选, 默认值为 False): 激活并控制填充。接受以下值
True或'longest': 填充到批次中最长的序列（如果只提供一个序列，则不填充）。'max_length': 填充到使用max_length参数指定的最大长度，或者如果未提供该参数，则填充到模型可接受的最大输入长度。False或'do_not_pad'(默认): 不填充（即，可以输出具有不同长度序列的批次）。truncation (bool,str或 TruncationStrategy, 可选, 默认值为False): 激活并控制截断。接受以下值True或'longest_first': 截断到使用max_length参数指定的最大长度，或者如果未提供该参数，则截断到模型可接受的最大输入长度。如果提供了序列对（或批次对），这将逐个标记进行截断，从对中最长的序列中删除一个标记。'only_first': 截断到使用max_length参数指定的最大长度，或者如果未提供该参数，则截断到模型可接受的最大输入长度。如果提供了序列对（或批次对），这将只截断对中的第一个序列。'only_second': 截断到使用max_length参数指定的最大长度，或者如果未提供该参数，则截断到模型可接受的最大输入长度。如果提供了序列对（或批次对），这将只截断对中的第二个序列。False或'do_not_truncate'(默认): 不截断（即，可以输出序列长度大于模型最大可接受输入大小的批次）。max_length (int, 可选): 控制截断/填充参数使用的最大长度。如果未设置或设置为None，这将使用预定义的模型最大长度（如果截断/填充参数需要最大长度）。如果模型没有特定的最大输入长度（如 XLNet），则将停用截断/填充到最大长度。stride (int, 可选, 默认值为 0): 如果与max_length一起设置为一个数字，则当return_overflowing_tokens=True时返回的溢出标记将包含来自截断序列末尾的一些标记，以便在截断序列和溢出序列之间提供一些重叠。此参数的值定义了重叠标记的数量。pad_to_multiple_of (int, 可选): 如果设置，则将序列填充到提供的值的倍数。这对于在具有计算能力>= 7.5(Volta) 的 NVIDIA 硬件上使用 Tensor Core 特别有用。return_tensors (str或 TensorType, 可选): 如果设置，将返回张量而不是 python 整数列表。可接受的值为'tf': 返回 TensorFlowtf.constant对象。'pt': 返回 PyTorchtorch.Tensor对象。'np': 返回 Numpynp.ndarray对象。
build_inputs_with_special_tokens
< 源代码 >( token_ids_0: List token_ids_1: Optional = None ) → List[int]
通过连接和添加特殊标记，从序列或一对序列为序列分类任务构建模型输入。RoBERTa 序列具有以下格式
- 单个序列:
<s> X </s> - 一对序列:
<s> A </s></s> B </s>
create_token_
< 源代码 >( token_ids_0: List token_ids_1: Optional = None ) → List[int]
从传递的两个序列中创建一个掩码，用于序列对分类任务。RoBERTa 不使用令牌类型 ID，因此返回一个零列表。
encode_plus
< 源代码 >( text: Union text_pair: Optional = None xpaths: Optional = None node_labels: Optional = None add_special_tokens: bool = True padding: Union = False truncation: Union = None max_length: Optional = None stride: int = 0 pad_to_multiple_of: Optional = None return_tensors: Union = None return_token_type_ids: Optional = None return_attention_mask: Optional = None return_overflowing_tokens: bool = False return_special_tokens_mask: bool = False return_offsets_mapping: bool = False return_length: bool = False verbose: bool = True **kwargs )
参数
- text (
str,List[str],List[List[str]]) — 要编码的第一个序列。这可以是字符串、字符串列表或字符串列表列表。 - text_pair (
List[str]或List[int], 可选) — 要编码的可选的第二个序列。这可以是字符串列表（单个示例的单词）或字符串列表列表（一批示例的单词）。 - add_special_tokens (
bool, 可选, 默认值为True) — 编码序列时是否添加特殊标记。这将使用底层的PretrainedTokenizerBase.build_inputs_with_special_tokens函数，该函数定义了自动添加到输入 ID 的标记。如果您想自动添加bos或eos标记，这很有用。 - padding (
bool,str或 PaddingStrategy, 可选, 默认值为False) — 激活并控制填充。接受以下值：True或'longest': 填充到批次中最长的序列（如果只提供单个序列，则不填充）。'max_length': 填充到使用参数max_length指定的最大长度，或者如果未提供该参数，则填充到模型可接受的最大输入长度。False或'do_not_pad'(默认): 不填充（即，可以输出具有不同长度序列的批次）。
- 截断 (
bool,str或 TruncationStrategy, 可选, 默认值False) — 激活并控制截断。接受以下值：True或'longest_first': 截断到max_length参数指定的最大长度，或如果未提供该参数，则截断到模型可接受的最大输入长度。如果提供了序列对（或批处理序列对），则将逐个标记进行截断，从最长序列中删除一个标记。'only_first': 截断到max_length参数指定的最大长度，或如果未提供该参数，则截断到模型可接受的最大输入长度。如果提供了序列对（或批处理序列对），则将只截断第一条序列。'only_second': 截断到max_length参数指定的最大长度，或如果未提供该参数，则截断到模型可接受的最大输入长度。如果提供了序列对（或批处理序列对），则将只截断第二条序列。False或'do_not_truncate'(默认): 不进行截断（即可以输出长度超过模型最大可接受输入大小的批次）。
- 最大长度 (
int, 可选) — 通过截断/填充参数之一控制要使用的最大长度。如果未设置或设置为
None，则如果截断/填充参数之一需要最大长度，则将使用预定义的模型最大长度。如果模型没有特定的最大输入长度（如 XLNet），则将停用截断/填充到最大长度。 - 步长 (
int, 可选, 默认值 0) — 如果与max_length一起设置为一个数字，当return_overflowing_tokens=True时返回的溢出标记将包含一些来自截断序列末尾的标记，以便在截断序列和溢出序列之间提供一些重叠。该参数的值定义了重叠标记的数量。 - 是否已拆分为单词 (
bool, 可选, 默认值False) — 输入是否已经预先标记化（例如，拆分为单词）。如果设置为True，则分词器假设输入已经拆分为单词（例如，通过在空格处拆分），它将对这些单词进行分词。这对 NER 或标记分类很有用。 - 填充到倍数 (
int, 可选) — 如果设置，则将序列填充到提供的值的倍数。要求padding被激活。这对于在具有计算能力>= 7.5(Volta) 的 NVIDIA 硬件上启用张量核的使用特别有用。 - 返回张量 (
str或 TensorType, 可选) — 如果设置，将返回张量而不是 Python 整数列表。'tf': 返回 TensorFlowtf.constant对象。'pt': 返回 PyTorchtorch.Tensor对象。'np': 返回 Numpynp.ndarray对象。
- 添加特殊标记 (
bool, 可选, 默认值True) — 是否使用相对于其模型的特殊标记对序列进行编码。 - padding (
bool,str或 PaddingStrategy, 可选, 默认值为False) — 激活并控制填充。接受以下值：True或'longest': 填充到批次中最长的序列（如果只提供单个序列，则不填充）。'max_length': 填充到使用参数max_length指定的最大长度，或者如果未提供该参数，则填充到模型可接受的最大输入长度。False或'do_not_pad'(默认): 不填充（即，可以输出具有不同长度序列的批次）。
- 截断 (
bool,str或 TruncationStrategy, 可选, 默认值False) — 激活并控制截断。接受以下值：True或'longest_first': 截断到max_length参数指定的最大长度，或如果未提供该参数，则截断到模型可接受的最大输入长度。如果提供了序列对（或批处理序列对），则将逐个标记进行截断，从最长序列中删除一个标记。'only_first': 截断到max_length参数指定的最大长度，或如果未提供该参数，则截断到模型可接受的最大输入长度。如果提供了序列对（或批处理序列对），则将只截断第一条序列。'only_second': 截断到max_length参数指定的最大长度，或如果未提供该参数，则截断到模型可接受的最大输入长度。如果提供了序列对（或批处理序列对），则将只截断第二条序列。False或'do_not_truncate'(默认): 不进行截断（即可以输出长度超过模型最大可接受输入大小的批次）。
- 最大长度 (
int, 可选) — 通过截断/填充参数之一控制要使用的最大长度。如果未设置或设置为None，则如果截断/填充参数之一需要最大长度，则将使用预定义的模型最大长度。如果模型没有特定的最大输入长度（如 XLNet），则将停用截断/填充到最大长度。 - 步长 (
int, 可选, 默认值 0) — 如果与max_length一起设置为一个数字，当return_overflowing_tokens=True时返回的溢出标记将包含一些来自截断序列末尾的标记，以便在截断序列和溢出序列之间提供一些重叠。该参数的值定义了重叠标记的数量。 - 填充到倍数 (
int, 可选) — 如果设置，则将序列填充到提供的值的倍数。这对于在具有计算能力>= 7.5(Volta) 的 NVIDIA 硬件上启用张量核的使用特别有用。 - 返回张量 (
str或 TensorType, 可选) — 如果设置，将返回张量而不是 Python 整数列表。'tf': 返回 TensorFlowtf.constant对象。'pt': 返回 PyTorchtorch.Tensor对象。'np': 返回 Numpynp.ndarray对象。
分词并为模型准备一个序列或一对序列。.. warning:: 此方法已弃用，应使用 __call__ 代替。
给定一个特定节点的 xpath 表达式（例如“/html/body/div/li[1]/div/span[2]”），返回一个包含标签 ID 和对应下标的列表，考虑到最大深度。
MarkupLMProcessor
class transformers.MarkupLMProcessor
< source >( *args **kwargs )
参数
- feature_extractor (
MarkupLMFeatureExtractor) — MarkupLMFeatureExtractor 的实例。特征提取器是必需的输入。 - tokenizer (
MarkupLMTokenizerorMarkupLMTokenizerFast) — MarkupLMTokenizer 或 MarkupLMTokenizerFast 的实例。标记器是必需的输入。 - parse_html (
bool, optional, defaults toTrue) — 是否使用MarkupLMFeatureExtractor将 HTML 字符串解析为节点和相应的 xpath。
构造一个 MarkupLM 处理器，将 MarkupLM 特征提取器和 MarkupLM 标记器组合成一个处理器。
MarkupLMProcessor 提供了为模型准备数据所需的所有功能。
它首先使用 MarkupLMFeatureExtractor 从一个或多个 HTML 字符串中提取节点和相应的 xpath。接下来，将这些节点和 xpath 以及其他参数传递给 MarkupLMTokenizer 或 MarkupLMTokenizerFast，将它们转换为 token 级别的 input_ids、attention_mask、token_type_ids、xpath_tags_seq 和 xpath_subs_seq。
__call__
< source >( html_strings = None nodes = None xpaths = None node_labels = None questions = None add_special_tokens: bool = True padding: Union = False truncation: Union = None max_length: Optional = None stride: int = 0 pad_to_multiple_of: Optional = None return_token_type_ids: Optional = None return_attention_mask: Optional = None return_overflowing_tokens: bool = False return_special_tokens_mask: bool = False return_offsets_mapping: bool = False return_length: bool = False verbose: bool = True return_tensors: Union = None **kwargs )
此方法首先将 html_strings 参数转发到 call()。接下来，它将 nodes 和 xpaths 以及其他参数传递给 __call__() 并返回输出。
可以选择提供 text 参数，它作为第一个序列传递。
有关更多信息，请参阅上述两种方法的文档字符串。
MarkupLMModel
class transformers.MarkupLMModel
< source >( config add_pooling_layer = True )
参数
- config (MarkupLMConfig) — 模型配置类，包含模型的所有参数。使用配置文件初始化不会加载与模型关联的权重，仅加载配置。查看 from_pretrained() 方法加载模型权重。
MarkupLM 模型的裸 Transformer，输出原始隐藏状态，没有任何特定的头部。该模型是 PyTorch torch.nn.Module 子类。将其用作常规 PyTorch 模块，并参考 PyTorch 文档了解所有与一般使用和行为相关的事宜。
forward
< source >( input_ids: Optional = None xpath_tags_seq: Optional = None xpath_subs_seq: Optional = None attention_mask: Optional = None token_type_ids: Optional = None position_ids: Optional = None head_mask: Optional = None inputs_embeds: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None ) → transformers.modeling_outputs.BaseModelOutputWithPoolingAndCrossAttentions 或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensor形状为(batch_size, sequence_length)) — 输入序列标记在词汇表中的索引。索引可以使用 AutoTokenizer 获取。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- xpath_tags_seq (
torch.LongTensor形状为(batch_size, sequence_length, config.max_depth), 可选) — 输入序列中每个标记的标记 ID，填充至 config.max_depth。 - xpath_subs_seq (
torch.LongTensor形状为(batch_size, sequence_length, config.max_depth), 可选) — 输入序列中每个标记的下标 ID，填充至 config.max_depth。 - attention_mask (
torch.FloatTensor形状为(batch_size, sequence_length), 可选) — 掩码，避免对填充标记索引执行注意力。在[0, 1]中选择掩码值：1表示未掩码的标记，0表示掩码标记。 - token_type_ids (
torch.LongTensor形状为(batch_size, sequence_length)，可选) — 段落标记索引，用于指示输入的第一部分和第二部分。索引在[0, 1]中选择：0对应于句子 A 标记，1对应于句子 B 标记 - position_ids (
torch.LongTensor形状为(batch_size, sequence_length)，可选) — 每个输入序列标记在位置嵌入中的位置索引。在[0, config.max_position_embeddings - 1]范围内选择。 - head_mask (
torch.FloatTensor形状为(num_heads,)或(num_layers, num_heads)，可选) — 用于将自注意力模块的选定头部设为无效的掩码。掩码值在[0, 1]中选择：1表示头部未被掩码，0表示头部被掩码。 - inputs_embeds (
torch.FloatTensor形状为(batch_size, sequence_length, hidden_size)，可选) — 可选地，您可以选择直接传递嵌入表示，而不是传递input_ids。如果您想比模型的内部嵌入查找矩阵更精确地控制如何将input_ids 索引转换为相关向量，这将非常有用。 - output_attentions (
bool，可选) — 如果设置为True，则返回所有注意力层的注意力张量。有关更多详细信息，请参阅返回张量中的attentions。 - output_hidden_states (
bool，可选) — 如果设置为True，则返回所有层的隐藏状态。有关更多详细信息，请参阅返回张量中的hidden_states。 - return_dict (
bool，可选) — 如果设置为True，模型将返回一个 ModelOutput，而不是一个简单的元组。
返回值
transformers.modeling_outputs.BaseModelOutputWithPoolingAndCrossAttentions 或 tuple(torch.FloatTensor)
一个 transformers.modeling_outputs.BaseModelOutputWithPoolingAndCrossAttentions 或一个 torch.FloatTensor 元组（如果传递 return_dict=False 或 config.return_dict=False），包含根据配置 (MarkupLMConfig) 和输入的不同元素。
-
last_hidden_state (
torch.FloatTensor形状为(batch_size, sequence_length, hidden_size)) — 模型最后一层输出处的隐藏状态序列。 -
pooler_output (
torch.FloatTensor形状为(batch_size, hidden_size)) — 序列第一个标记（分类标记）的最后一层隐藏状态，经过用于辅助预训练任务的层的进一步处理。例如，对于 BERT 系列模型，这将返回经过线性层和 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 之后的注意力权重，用于计算自注意力头中的加权平均值。
-
cross_attentions (
tuple(torch.FloatTensor)，可选，在传递output_attentions=True和config.add_cross_attention=True或config.output_attentions=True时返回) —torch.FloatTensor元组（每个层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。解码器交叉注意力层的注意力权重，在注意力 softmax 之后，用于计算交叉注意力头中的加权平均值。
-
past_key_values (
tuple(tuple(torch.FloatTensor))，可选，在传递use_cache=True或config.use_cache=True时返回) —tuple(torch.FloatTensor)元组，长度为config.n_layers，每个元组包含 2 个形状为(batch_size, num_heads, sequence_length, embed_size_per_head)的张量，并且可选地，如果config.is_encoder_decoder=True，则包含 2 个形状为(batch_size, num_heads, encoder_sequence_length, embed_size_per_head)的附加张量。包含预先计算的隐藏状态（自注意力块中的键和值，以及可选地，如果
config.is_encoder_decoder=True，则包含交叉注意力块中的键和值），可以用于（参见past_key_values输入）加速顺序解码。
MarkupLMModel 前向方法覆盖了 __call__ 特殊方法。
虽然前向传递的配方需要在此函数内定义，但应该在之后调用 Module 实例，而不是调用此函数，因为前者负责运行前处理和后处理步骤，而后者则会默默地忽略它们。
示例
>>> from transformers import AutoProcessor, MarkupLMModel
>>> processor = AutoProcessor.from_pretrained("microsoft/markuplm-base")
>>> model = MarkupLMModel.from_pretrained("microsoft/markuplm-base")
>>> html_string = "<html> <head> <title>Page Title</title> </head> </html>"
>>> encoding = processor(html_string, return_tensors="pt")
>>> outputs = model(**encoding)
>>> last_hidden_states = outputs.last_hidden_state
>>> list(last_hidden_states.shape)
[1, 4, 768]MarkupLMForSequenceClassification
class transformers.MarkupLMForSequenceClassification
< source >( config )
参数
- config (MarkupLMConfig) — 模型配置类，包含模型的所有参数。使用配置文件进行初始化不会加载与模型相关的权重，只加载配置。查看 from_pretrained() 方法加载模型权重。
MarkupLM 模型变压器，在其顶部有一个序列分类/回归头（在池化输出之上有一个线性层），例如用于 GLUE 任务。
此模型是 PyTorch torch.nn.Module 子类。将其用作常规 PyTorch 模块，并参考 PyTorch 文档了解有关一般使用和行为的所有事项。
forward
< source >( input_ids: Optional = None xpath_tags_seq: Optional = None xpath_subs_seq: Optional = None attention_mask: Optional = None token_type_ids: Optional = None position_ids: Optional = None head_mask: Optional = None inputs_embeds: Optional = None labels: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None ) → transformers.modeling_outputs.SequenceClassifierOutput 或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensor形状为(batch_size, sequence_length)) — 词汇表中输入序列标记的索引。可以使用 AutoTokenizer 获取索引。有关详细信息，请查看 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call() 。
- xpath_tags_seq (
torch.LongTensor形状为(batch_size, sequence_length, config.max_depth), 可选) — 输入序列中每个标记的标记 ID，填充到 config.max_depth。 - xpath_subs_seq (
torch.LongTensor形状为(batch_size, sequence_length, config.max_depth), 可选) — 输入序列中每个标记的下标 ID，填充到 config.max_depth。 - attention_mask (
torch.FloatTensor形状为(batch_size, sequence_length), 可选) — 掩码以避免对填充标记索引执行注意力。在[0, 1]中选择掩码值：1表示未掩码的标记，0表示掩码的标记。 - token_type_ids (
torch.LongTensor形状为(batch_size, sequence_length), 可选) — 段标记索引，用于指示输入的第一个和第二个部分。索引选择范围为[0, 1]：0对应于 句子 A 标记，1对应于 句子 B 标记 - position_ids (
torch.LongTensor形状为(batch_size, sequence_length), 可选) — 每个输入序列标记在位置嵌入中的位置索引。选择范围为[0, config.max_position_embeddings - 1]. - head_mask (
torch.FloatTensor形状为(num_heads,)或(num_layers, num_heads), 可选) — 掩码，用于将自注意力模块的选定头部置为零。掩码值选择范围为[0, 1]：1表示头部 未被掩码，0表示头部 被掩码。 - inputs_embeds (
torch.FloatTensor形状为(batch_size, sequence_length, hidden_size), 可选) — 可选地，您可以选择直接传递嵌入式表示，而不是传递input_ids。如果您希望比模型的内部嵌入查找矩阵更好地控制如何将 input_ids 索引转换为关联的向量，这将非常有用。 - output_attentions (
bool, 可选) — 如果设置为True，将返回所有注意力层的注意力张量。有关详细信息，请参阅返回张量中的attentions。 - output_hidden_states (
bool, 可选) — 如果设置为True，将返回所有层的隐藏状态。有关详细信息，请参阅返回张量中的hidden_states。 - return_dict (
bool, 可选) — 如果设置为True，模型将返回一个 ModelOutput，而不是一个简单的元组。 - labels (
torch.LongTensor形状为(batch_size,), 可选) — 用于计算序列分类/回归损失的标签。索引应在[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 时），其中包含根据配置 (MarkupLMConfig) 和输入的不同元素。
-
loss (
torch.FloatTensor形状为(1,), 可选, 当提供labels时返回) — 分类（或如果 config.num_labels==1 则为回归）损失。 -
logits (
torch.FloatTensor形状为(batch_size, config.num_labels)) — 分类（或如果 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 之后的注意力权重，用于计算自注意力头中的加权平均值。
MarkupLMForSequenceClassification 正向方法，覆盖了 __call__ 特殊方法。
虽然前向传递的配方需要在此函数内定义，但应该在之后调用 Module 实例，而不是调用此函数，因为前者负责运行前处理和后处理步骤，而后者则会默默地忽略它们。
示例
>>> from transformers import AutoProcessor, AutoModelForSequenceClassification
>>> import torch
>>> processor = AutoProcessor.from_pretrained("microsoft/markuplm-base")
>>> model = AutoModelForSequenceClassification.from_pretrained("microsoft/markuplm-base", num_labels=7)
>>> html_string = "<html> <head> <title>Page Title</title> </head> </html>"
>>> encoding = processor(html_string, return_tensors="pt")
>>> with torch.no_grad():
... outputs = model(**encoding)
>>> loss = outputs.loss
>>> logits = outputs.logitsMarkupLMForTokenClassification
class transformers.MarkupLMForTokenClassification
< 源代码 >( config )
参数
- config (MarkupLMConfig) — 模型配置类，包含模型的所有参数。使用配置文件进行初始化不会加载与模型关联的权重，仅加载配置。查看 from_pretrained() 方法来加载模型权重。
带有 token_classification 头部的 MarkupLM 模型。此模型是一个 PyTorch torch.nn.Module 子类。将其用作常规 PyTorch 模块，并参考 PyTorch 文档以获取与一般使用和行为有关的所有事项。
forward
< 源代码 >( input_ids: Optional = None xpath_tags_seq: Optional = None xpath_subs_seq: Optional = None attention_mask: Optional = None token_type_ids: Optional = None position_ids: Optional = None head_mask: Optional = None inputs_embeds: Optional = None labels: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None ) → transformers.modeling_outputs.MaskedLMOutput 或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensor形状为(batch_size, sequence_length)) — 输入序列词元在词汇表中的索引。可以使用 AutoTokenizer 获取索引。查看 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call() 获取详细信息。
- xpath_tags_seq (
torch.LongTensor形状为(batch_size, sequence_length, config.max_depth), 可选) — 输入序列中每个词元的标签 ID，填充至 config.max_depth。 - xpath_subs_seq (
torch.LongTensor形状为(batch_size, sequence_length, config.max_depth), 可选) — 输入序列中每个词元的下标 ID，填充至 config.max_depth。 - attention_mask (
torch.FloatTensor形状为(batch_size, sequence_length), 可选) — 用于避免对填充词元索引执行注意力的掩码。掩码值选择[0, 1]中的值：1表示未被掩码的词元，0表示被掩码的词元。 - token_type_ids (
torch.LongTensor形状为(batch_size, sequence_length), 可选) — 段词元索引，用于指示输入的第一部分和第二部分。索引选择[0, 1]中的值：0表示句子 A 词元，1表示句子 B 词元 - position_ids (
torch.LongTensor形状为(batch_size, sequence_length)，可选) — 每个输入序列令牌在位置嵌入中的位置索引。在[0, config.max_position_embeddings - 1]范围内选择。 - head_mask (
torch.FloatTensor形状为(num_heads,)或(num_layers, num_heads)，可选) — 用于使自注意力模块中选定头部无效的掩码。在[0, 1]中选择掩码值：1表示头部未掩码，0表示头部掩码。 - inputs_embeds (
torch.FloatTensor形状为(batch_size, sequence_length, hidden_size)，可选) — 可选地，您可以选择直接传递嵌入式表示，而不是传递input_ids。如果您想要比模型的内部嵌入查找矩阵更详细地控制如何将input_ids 索引转换为关联的向量，这将很有用。 - output_attentions (
bool，可选) — 如果设置为True，则返回所有注意力层的注意力张量。有关详细信息，请参阅返回张量中的attentions。 - output_hidden_states (
bool，可选) — 如果设置为True，则返回所有层的隐藏状态。有关详细信息，请参阅返回张量中的hidden_states。 - return_dict (
bool，可选) — 如果设置为True，模型将返回一个 ModelOutput，而不是一个简单的元组。 - labels (
torch.LongTensor形状为(batch_size, sequence_length)，可选) — 用于计算令牌分类损失的标签。索引应在[0, ..., config.num_labels - 1]中。
返回值
transformers.modeling_outputs.MaskedLMOutput 或 tuple(torch.FloatTensor)
一个 transformers.modeling_outputs.MaskedLMOutput 或一个 torch.FloatTensor 元组（如果传递 return_dict=False 或当 config.return_dict=False 时），包含根据配置 (MarkupLMConfig) 和输入而变化的各种元素。
-
loss (
torch.FloatTensor形状为(1,)，可选，当提供labels时返回) — 掩码语言建模 (MLM) 损失。 -
logits (
torch.FloatTensor形状为(batch_size, sequence_length, config.vocab_size)) — 语言建模头的预测分数（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 之后的注意力权重，用于计算自注意力头中的加权平均值。
The MarkupLMForTokenClassification 正向方法覆盖了 __call__ 特殊方法。
虽然前向传递的配方需要在此函数内定义，但应该在之后调用 Module 实例，而不是调用此函数，因为前者负责运行前处理和后处理步骤，而后者则会默默地忽略它们。
示例
>>> from transformers import AutoProcessor, AutoModelForTokenClassification
>>> import torch
>>> processor = AutoProcessor.from_pretrained("microsoft/markuplm-base")
>>> processor.parse_html = False
>>> model = AutoModelForTokenClassification.from_pretrained("microsoft/markuplm-base", num_labels=7)
>>> nodes = ["hello", "world"]
>>> xpaths = ["/html/body/div/li[1]/div/span", "/html/body/div/li[1]/div/span"]
>>> node_labels = [1, 2]
>>> encoding = processor(nodes=nodes, xpaths=xpaths, node_labels=node_labels, return_tensors="pt")
>>> with torch.no_grad():
... outputs = model(**encoding)
>>> loss = outputs.loss
>>> logits = outputs.logitsMarkupLMForQuestionAnswering
class transformers.MarkupLMForQuestionAnswering
< 源代码 >( config )
参数
- config (MarkupLMConfig) — 模型配置类，包含模型的所有参数。用配置文件初始化不会加载与模型相关的权重，只会加载配置。查看from_pretrained()方法来加载模型权重。
带有跨度分类头的 MarkupLM 模型，用于 SQuAD 等提取式问答任务（在隐藏状态输出之上添加一个线性层以计算跨度开始对数和跨度结束对数）。
此模型是 PyTorch torch.nn.Module 子类。将其用作常规 PyTorch 模块，并参考 PyTorch 文档了解有关一般使用和行为的所有事项。
forward
< 源代码 >( input_ids: Optional = None xpath_tags_seq: Optional = None xpath_subs_seq: Optional = None attention_mask: Optional = None token_type_ids: Optional = None position_ids: Optional = None head_mask: Optional = None inputs_embeds: Optional = None start_positions: Optional = None end_positions: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None ) → transformers.modeling_outputs.QuestionAnsweringModelOutput 或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensor形状为(batch_size, sequence_length)) — 输入序列词元在词表的索引。索引可使用 AutoTokenizer 获取。查看 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call() 获取详细信息。
- xpath_tags_seq (
torch.LongTensor形状为(batch_size, sequence_length, config.max_depth), 可选) — 输入序列中每个词元的标签 ID，填充到 config.max_depth。 - xpath_subs_seq (
torch.LongTensor形状为(batch_size, sequence_length, config.max_depth), 可选) — 输入序列中每个词元的下标 ID，填充到 config.max_depth。 - attention_mask (
torch.FloatTensor形状为(batch_size, sequence_length), 可选) — 掩码，用于避免对填充词元索引执行注意力。掩码值在[0, 1]中选择：1表示未掩码的词元，0表示掩码的词元。 - token_type_ids (
torch.LongTensor形状为(batch_size, sequence_length), 可选) — 段词元索引，用于指示输入的第一部分和第二部分。索引在[0, 1]中选择：0对应于句子 A 词元，1对应于句子 B 词元 - position_ids (
torch.LongTensor形状为(batch_size, sequence_length), 可选) — 输入序列词元在位置嵌入中的位置索引。在[0, config.max_position_embeddings - 1]范围内选择。 - head_mask (
torch.FloatTensor形状为(num_heads,)或(num_layers, num_heads)，可选) — 用于使自注意力模块中选定头的无效化的掩码。掩码值在[0, 1]中选择：1表示头**未被掩码**，0表示头**被掩码**。 - inputs_embeds (
torch.FloatTensor形状为(batch_size, sequence_length, hidden_size)，可选) — 可选地，您可以选择直接传递嵌入表示，而不是传递input_ids。如果您想要更多地控制如何将 input_ids 索引转换为关联的向量（而不是模型的内部嵌入查找矩阵），这将非常有用。 - output_attentions (
bool，可选) — 如果设置为True，则返回所有注意力层的注意力张量。有关详细信息，请参阅返回张量下的attentions。 - output_hidden_states (
bool，可选) — 如果设置为True，则返回所有层的隐藏状态。有关详细信息，请参阅返回张量下的hidden_states。 - return_dict (
bool，可选) — 如果设置为True，模型将返回一个 ModelOutput，而不是一个简单的元组。 - start_positions (
torch.LongTensor形状为(batch_size,)，可选) — 用于计算标记分类损失的标记跨度开始位置（索引）的标签。位置被限制为序列的长度（sequence_length）。序列之外的位置不会被考虑用于计算损失。 - end_positions (
torch.LongTensor形状为(batch_size,)，可选) — 用于计算标记分类损失的标记跨度结束位置（索引）的标签。位置被限制为序列的长度（sequence_length）。序列之外的位置不会被考虑用于计算损失。
返回值
transformers.modeling_outputs.QuestionAnsweringModelOutput 或 tuple(torch.FloatTensor)
一个 transformers.modeling_outputs.QuestionAnsweringModelOutput 或 torch.FloatTensor 的元组（如果传递了 return_dict=False 或当 config.return_dict=False 时），包含根据配置 (MarkupLMConfig) 和输入的不同元素。
-
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)，可选，在传递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 之后的注意力权重，用于计算自注意力头中的加权平均值。
The MarkupLMForQuestionAnswering forward method, overrides the __call__ special method.
虽然前向传递的配方需要在此函数内定义，但应该在之后调用 Module 实例，而不是调用此函数，因为前者负责运行前处理和后处理步骤，而后者则会默默地忽略它们。
示例
>>> from transformers import AutoProcessor, MarkupLMForQuestionAnswering
>>> import torch
>>> processor = AutoProcessor.from_pretrained("microsoft/markuplm-base-finetuned-websrc")
>>> model = MarkupLMForQuestionAnswering.from_pretrained("microsoft/markuplm-base-finetuned-websrc")
>>> html_string = "<html> <head> <title>My name is Niels</title> </head> </html>"
>>> question = "What's his name?"
>>> encoding = processor(html_string, questions=question, return_tensors="pt")
>>> with torch.no_grad():
... 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]
>>> processor.decode(predict_answer_tokens).strip()
'Niels'