Transformers 文档
MarkupLM
并获得增强的文档体验
开始使用
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 在多个文档理解任务中显著优于现有的强大基线模型。预训练模型和代码将公开发布。
使用技巧
- 除了
input_ids，forward() 还需要 2 个额外的输入，即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)简而言之，您可以向 MarkupLMProcessor 提供 HTML 字符串（以及可能的附加数据），它将创建模型期望的输入。在内部，处理器首先使用 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
类 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) — 嵌入、编码器和池化器中所有全连接层的 dropout 概率。 - attention_probs_dropout_prob (
float, 可选, 默认为 0.1) — 注意力概率的 dropout 比率。 - max_position_embeddings (
int, 可选, 默认为 512) — 此模型可能使用的最大序列长度。通常为了以防万一，将其设置为一个较大的值（例如 512、1024 或 2048）。 - type_vocab_size (
int, 可选, 默认为 2) — 传递到 MarkupLMModel 的token_type_ids的词汇表大小。 - initializer_range (
float, 可选, 默认为 0.02) — 用于初始化所有权重矩阵的 truncated_normal_initializer 的标准差。 - 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, optional, defaults to 1024) — xpath 下标单元嵌入可能使用的最大值。通常将其设置为一个较大的值以防万一（例如 1024）。 - tag_pad_id (
int, optional, defaults to 216) — xpath 标签中的填充标记 ID。 - subs_pad_id (
int, optional, defaults to 1001) — xpath 下标中的填充标记 ID。 - xpath_tag_unit_hidden_size (
int, optional, defaults to 32) — 每个树 ID 单元的隐藏大小。一个完整的树索引将具有 (50*xpath_tag_unit_hidden_size)-dim。 - max_depth (
int, optional, defaults to 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__
< source >( 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
< source >( 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, optional, defaults to"replace") — 解码字节到 UTF-8 时遵循的范式。有关更多信息，请参阅 bytes.decode。 - bos_token (
str, optional, defaults to"<s>") — 预训练期间使用的序列开始标记。可用作序列分类器标记。当使用特殊标记构建序列时，这不是用于序列开始的标记。使用的标记是
cls_token。 - 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 tokenizer 通过前导空格检测单词的开头）。
构造 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: typing.Optional[list[int]] = 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: typing.Optional[list[int]] = None already_has_special_tokens: bool = False ) → list[int]
参数
- Retrieve 从未添加特殊标记的标记列表中检索序列 ID。当使用分词器
prepare_for_model方法添加 — - special 标记时调用此方法。 — 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_type_ids_from_sequences
< source >( token_ids_0: list token_ids_1: typing.Optional[list[int]] = 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) — 合并文件的路径。 - errors (
str, optional, defaults to"replace") — 解码字节到 UTF-8 时遵循的范式。有关更多信息，请参阅 bytes.decode。 - bos_token (
str, optional, defaults to"<s>") — 预训练期间使用的序列开始标记。可用作序列分类器标记。当使用特殊标记构建序列时，这不是用于序列开始的标记。使用的标记是
cls_token。 - 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 tokenizer 通过前导空格检测单词的开头）。
构造 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: typing.Union[list[str], list[tuple[str, str]], list[list[str]]] is_pair: typing.Optional[bool] = None xpaths: typing.Optional[list[list[list[int]]]] = None node_labels: typing.Union[list[int], list[list[int]], NoneType] = None add_special_tokens: bool = True padding: typing.Union[bool, str, transformers.utils.generic.PaddingStrategy] = False truncation: typing.Union[bool, str, transformers.tokenization_utils_base.TruncationStrategy] = None max_length: typing.Optional[int] = None stride: int = 0 pad_to_multiple_of: typing.Optional[int] = None padding_side: typing.Optional[str] = None return_tensors: typing.Union[str, transformers.utils.generic.TensorType, NoneType] = None return_token_type_ids: typing.Optional[bool] = None return_attention_mask: typing.Optional[bool] = 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'(默认): 不填充（即，可以输出具有不同长度序列的批次）。截断 (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 的使用特别有用。padding_side (str, 可选): 模型应应用填充的侧面。应在 ['right', 'left'] 之间选择。默认值从同名类属性中选取。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'(默认): 不填充（即，可以输出具有不同长度序列的批次）。截断 (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: typing.Optional[list[int]] = None ) → list[int]
通过连接和添加特殊标记，从序列或序列对构建序列分类任务的模型输入。RoBERTa 序列的格式如下：
- 单个序列：
<s> X </s> - 序列对：
<s> A </s></s> B </s>
create_token_type_ids_from_sequences
< 来源 >( token_ids_0: list token_ids_1: typing.Optional[list[int]] = None ) → list[int]
从传递给序列对分类任务的两个序列创建掩码。RoBERTa 不使用标记类型 ID，因此返回一个零列表。
encode_plus
< 来源 >( text: typing.Union[str, list[str]] text_pair: typing.Optional[list[str]] = None xpaths: typing.Optional[list[list[int]]] = None node_labels: typing.Optional[list[int]] = None add_special_tokens: bool = True padding: typing.Union[bool, str, transformers.utils.generic.PaddingStrategy] = False truncation: typing.Union[bool, str, transformers.tokenization_utils_base.TruncationStrategy] = None max_length: typing.Optional[int] = None stride: int = 0 pad_to_multiple_of: typing.Optional[int] = None padding_side: typing.Optional[str] = None return_tensors: typing.Union[str, transformers.utils.generic.TensorType, NoneType] = None return_token_type_ids: typing.Optional[bool] = None return_attention_mask: typing.Optional[bool] = 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'(默认): 不填充（即，可以输出具有不同长度序列的批次）。
- 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 的使用特别有用。 - padding_side (
str, 可选) — 模型应应用填充的侧面。应在 ['right', 'left'] 之间选择。默认值从同名类属性中选取。 - 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对象。
对序列或序列对进行分词并为模型准备。.. 警告:: 此方法已弃用，应改用 __call__。
给定一个特定节点（如“/html/body/div/li[1]/div/span[2]”）的 xpath 表达式，返回一个标记 ID 及其相应下标的列表，同时考虑到最大深度。
MarkupLMProcessor
class transformers.MarkupLMProcessor
< 来源 >( *args **kwargs )
参数
- feature_extractor (
MarkupLMFeatureExtractor) — MarkupLMFeatureExtractor 的一个实例。特征提取器是必需的输入。 - tokenizer (
MarkupLMTokenizer或MarkupLMTokenizerFast) — MarkupLMTokenizer 或 MarkupLMTokenizerFast 的一个实例。分词器是必需的输入。 - parse_html (
bool, 可选, 默认为True) — 是否使用MarkupLMFeatureExtractor将 HTML 字符串解析为节点和相应的 xpath。
构建一个 MarkupLM 处理器，它将 MarkupLM 特征提取器和 MarkupLM 分词器组合成一个单一的处理器。
MarkupLMProcessor 提供了准备模型数据所需的所有功能。
它首先使用 MarkupLMFeatureExtractor 从一个或多个 HTML 字符串中提取节点和相应的 xpath。接下来，这些内容连同附加参数一起提供给 MarkupLMTokenizer 或 MarkupLMTokenizerFast，后者将它们转换为标记级别的 input_ids、attention_mask、token_type_ids、xpath_tags_seq 和 xpath_subs_seq。
__call__
< 来源 >( html_strings = None nodes = None xpaths = None node_labels = None questions = None add_special_tokens: bool = True padding: typing.Union[bool, str, transformers.utils.generic.PaddingStrategy] = False truncation: typing.Union[bool, str, transformers.tokenization_utils_base.TruncationStrategy] = None max_length: typing.Optional[int] = None stride: int = 0 pad_to_multiple_of: typing.Optional[int] = None return_token_type_ids: typing.Optional[bool] = None return_attention_mask: typing.Optional[bool] = 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: typing.Union[str, transformers.utils.generic.TensorType, NoneType] = None **kwargs )
此方法首先将 html_strings 参数转发到 call()。接下来，它将 nodes 和 xpaths 以及附加参数传递给 __call__() 并返回输出。
（可选）还可以提供 text 参数，该参数作为第一个序列传递。
有关更多信息，请参阅上述两种方法的文档字符串。
MarkupLMModel
class transformers.MarkupLMModel
< 来源 >( config add_pooling_layer = True )
参数
- config (MarkupLMModel) — 包含模型所有参数的模型配置类。使用配置文件初始化不会加载与模型相关的权重，只加载配置。请查阅 from_pretrained() 方法加载模型权重。
- add_pooling_layer (
bool, 可选, 默认为True) — 是否添加池化层
裸 MarkupLM 模型，输出原始隐藏状态，顶部没有任何特定头部。
此模型继承自 PreTrainedModel。查阅超类文档，了解库为其所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、剪枝头部等）。
此模型也是 PyTorch torch.nn.Module 子类。将其作为常规 PyTorch 模块使用，并查阅 PyTorch 文档以了解与一般用法和行为相关的所有事项。
forward
< 来源 >( input_ids: typing.Optional[torch.LongTensor] = None xpath_tags_seq: typing.Optional[torch.LongTensor] = None xpath_subs_seq: 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 output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = 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.n_positions - 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，可选) — 是否返回所有注意力层的注意力张量。更多详细信息请参阅返回张量中的attentions。 - output_hidden_states (
bool，可选) — 是否返回所有层的隐藏状态。更多详细信息请参阅返回张量中的hidden_states。 - return_dict (
bool，可选) — 是否返回 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 (
Cache，可选，当传递use_cache=True或config.use_cache=True时返回) — 这是一个 Cache 实例。有关更多详细信息，请参阅我们的 kv 缓存指南。包含预先计算的隐藏状态（自注意力块中的键和值，如果
config.is_encoder_decoder=True，则可选地包含交叉注意力块中的键和值），可用于（请参阅past_key_values输入）加快顺序解码。
MarkupLMModel 的 forward 方法，覆盖了 __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
< 来源 >( config )
参数
- config (MarkupLMForSequenceClassification) — 包含模型所有参数的模型配置类。使用配置文件初始化不会加载与模型相关的权重，只加载配置。请查看 from_pretrained() 方法来加载模型权重。
MarkupLM 模型 Transformer，顶部带有序列分类/回归头部（池化输出顶部的一个线性层），例如用于 GLUE 任务。
此模型继承自 PreTrainedModel。查阅超类文档，了解库为其所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、剪枝头部等）。
此模型也是 PyTorch torch.nn.Module 子类。将其作为常规 PyTorch 模块使用，并查阅 PyTorch 文档以了解与一般用法和行为相关的所有事项。
forward
< 来源 >( input_ids: typing.Optional[torch.Tensor] = None xpath_tags_seq: typing.Optional[torch.Tensor] = None xpath_subs_seq: 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 labels: 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.SequenceClassifierOutput 或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.Tensor，形状为(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.Tensor，形状为(batch_size, sequence_length)，可选) — 用于避免对填充标记索引执行注意力操作的掩码。掩码值选择范围为[0, 1]：- 1 表示标记未被掩码，
- 0 表示标记已被掩码。
- token_type_ids (
torch.Tensor，形状为(batch_size, sequence_length)，可选) — 用于指示输入的第一部分和第二部分的片段标记索引。索引选择范围为[0, 1]：- 0 对应于句子 A 标记，
- 1 对应于句子 B 标记。
- position_ids (
torch.Tensor，形状为(batch_size, sequence_length)，可选) — 每个输入序列标记在位置嵌入中的位置索引。选择范围为[0, config.n_positions - 1]。 - head_mask (
torch.Tensor，形状为(num_heads,)或(num_layers, num_heads)，可选) — 用于使自注意力模块的选定头部无效的掩码。掩码值选择范围为[0, 1]：- 1 表示头部未被掩码，
- 0 表示头部已被掩码。
- inputs_embeds (
torch.Tensor，形状为(batch_size, sequence_length, hidden_size)，可选) — 另外，除了传递input_ids，你也可以选择直接传递一个嵌入表示。如果你希望对如何将input_ids索引转换为相关向量拥有比模型内部嵌入查找矩阵更多的控制权，这将很有用。 - labels (
torch.LongTensor，形状为(batch_size,)，可选) — 用于计算序列分类/回归损失的标签。索引应在[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），包含根据配置（MarkupLMConfig）和输入而定的各种元素。
-
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 后的注意力权重，用于计算自注意力头中的加权平均值。
MarkupLMForSequenceClassification 的 forward 方法，覆盖了 __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 (MarkupLMForTokenClassification) — 包含模型所有参数的模型配置类。使用配置文件初始化不会加载与模型相关的权重，只加载配置。请查看 from_pretrained() 方法来加载模型权重。
MarkupLM 模型，顶部带有 token_classification 头部。
此模型继承自 PreTrainedModel。查阅超类文档，了解库为其所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、剪枝头部等）。
此模型也是 PyTorch torch.nn.Module 子类。将其作为常规 PyTorch 模块使用，并查阅 PyTorch 文档以了解与一般用法和行为相关的所有事项。
forward
< 来源 >( input_ids: typing.Optional[torch.Tensor] = None xpath_tags_seq: typing.Optional[torch.Tensor] = None xpath_subs_seq: 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 labels: 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.MaskedLMOutput 或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.Tensor，形状为(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.Tensor，形状为(batch_size, sequence_length)，可选) — 用于避免对填充标记索引执行注意力操作的掩码。掩码值选择范围为[0, 1]：- 1 表示标记未被掩码，
- 0 表示标记已被掩码。
- token_type_ids (
torch.Tensor，形状为(batch_size, sequence_length)，可选) — 用于指示输入的第一部分和第二部分的片段标记索引。索引选择范围为[0, 1]：- 0 对应于句子 A 标记，
- 1 对应于句子 B 标记。
- position_ids (
torch.Tensor，形状为(batch_size, sequence_length)，可选) — 每个输入序列标记在位置嵌入中的位置索引。选择范围为[0, config.n_positions - 1]。 - head_mask (
torch.Tensor，形状为(num_heads,)或(num_layers, num_heads)，可选) — 用于使自注意力模块的选定头部无效的掩码。掩码值选择范围为[0, 1]：- 1 表示头部未被掩码，
- 0 表示头部已被掩码。
- inputs_embeds (
torch.Tensor，形状为(batch_size, sequence_length, hidden_size)，可选) — 另外，除了传递input_ids，你也可以选择直接传递一个嵌入表示。如果你希望对如何将input_ids索引转换为相关向量拥有比模型内部嵌入查找矩阵更多的控制权，这将很有用。 - labels (
torch.LongTensor，形状为(batch_size, sequence_length)，可选) — 用于计算标记分类损失的标签。索引应在[0, ..., config.num_labels - 1]范围内。 - output_attentions (
bool，可选) — 是否返回所有注意力层的注意力张量。更多详细信息请参阅返回张量中的attentions。 - output_hidden_states (
bool, 可选) — 是否返回所有层的隐藏状态。更多详细信息请参阅返回张量中的hidden_states。 - return_dict (
bool, 可选) — 是否返回ModelOutput而不是普通元组。
返回
transformers.modeling_outputs.MaskedLMOutput 或 tuple(torch.FloatTensor)
一个transformers.modeling_outputs.MaskedLMOutput或一个torch.FloatTensor元组（如果传入return_dict=False或config.return_dict=False），包含根据配置（MarkupLMConfig）和输入的不同元素。
-
loss (形状为
(1,)的torch.FloatTensor，可选，当提供labels时返回) — 掩码语言建模 (MLM) 损失。 -
logits (形状为
(batch_size, sequence_length, config.vocab_size)的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 后的注意力权重，用于计算自注意力头中的加权平均值。
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
< source >( config )
参数
- config (MarkupLMForQuestionAnswering) — 包含模型所有参数的模型配置类。使用配置文件初始化不会加载与模型关联的权重，只加载配置。请查看from_pretrained()方法来加载模型权重。
Markuplm Transformer模型，其上带有一个用于SQuAD等抽取式问答任务的跨度分类头部（在隐藏状态输出上添加一个线性层来计算跨度起始 logits和跨度结束 logits）。
此模型继承自 PreTrainedModel。查阅超类文档，了解库为其所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、剪枝头部等）。
此模型也是 PyTorch torch.nn.Module 子类。将其作为常规 PyTorch 模块使用，并查阅 PyTorch 文档以了解与一般用法和行为相关的所有事项。
forward
< source >( input_ids: typing.Optional[torch.Tensor] = None xpath_tags_seq: typing.Optional[torch.Tensor] = None xpath_subs_seq: 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 start_positions: typing.Optional[torch.Tensor] = None end_positions: 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.QuestionAnsweringModelOutput 或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.Tensor形状为(batch_size, sequence_length), 可选) — 词汇表中输入序列 token 的索引。默认情况下会忽略填充。可以使用AutoTokenizer获取索引。有关详细信息，请参阅PreTrainedTokenizer.encode()和PreTrainedTokenizer.call()。
- xpath_tags_seq (
torch.LongTensor形状为(batch_size, sequence_length, config.max_depth), 可选) — 输入序列中每个 token 的标签 ID，填充至 config.max_depth。 - xpath_subs_seq (
torch.LongTensor形状为(batch_size, sequence_length, config.max_depth), 可选) — 输入序列中每个 token 的下标 ID，填充至 config.max_depth。 - attention_mask (
torch.Tensor形状为(batch_size, sequence_length), 可选) — 用于避免对填充 token 索引执行注意力操作的掩码。掩码值在[0, 1]中选择：- 1 表示 token 未被掩盖，
- 0 表示 token 已被掩盖。
- token_type_ids (
torch.Tensor形状为(batch_size, sequence_length), 可选) — 用于指示输入的第一部分和第二部分的片段 token 索引。索引在[0, 1]中选择：- 0 对应于句子 A token，
- 1 对应于句子 B token。
- position_ids (
torch.Tensor形状为(batch_size, sequence_length), 可选) — 位置嵌入中每个输入序列 token 的位置索引。在[0, config.n_positions - 1]范围内选择。 - head_mask (
torch.Tensor形状为(num_heads,)或(num_layers, num_heads), 可选) — 用于使自注意力模块的选定头部无效的掩码。掩码值在[0, 1]中选择：- 1 表示头部未被掩盖，
- 0 表示头部已被掩盖。
- inputs_embeds (
torch.Tensor形状为(batch_size, sequence_length, hidden_size), 可选) — 可选地，您可以选择直接传入嵌入表示，而不是传入input_ids。如果您希望对如何将input_ids索引转换为关联向量有比模型内部嵌入查找矩阵更多的控制，这将很有用。 - start_positions (
torch.Tensor形状为(batch_size,), 可选) — 用于计算 token 分类损失的已标记跨度起始位置（索引）的标签。位置被限制为序列的长度（sequence_length）。序列外的位置不计入损失计算。 - end_positions (
torch.Tensor形状为(batch_size,), 可选) — 用于计算 token 分类损失的已标记跨度结束位置（索引）的标签。位置被限制为序列的长度（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），包含根据配置（MarkupLMConfig）和输入的不同元素。
-
loss (
torch.FloatTensorof shape(1,), 可选, 当提供labels时返回) — 总范围提取损失是起始位置和结束位置的交叉熵之和。 -
start_logits (
torch.FloatTensorof shape(batch_size, sequence_length)) — 范围起始分数（SoftMax 之前）。 -
end_logits (
torch.FloatTensorof 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 后的注意力权重，用于计算自注意力头中的加权平均值。
MarkupLMForQuestionAnswering的前向方法，覆盖了__call__特殊方法。
尽管前向传播的实现需要在该函数中定义，但之后应调用 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'