Transformers 文档
MarkupLM
并获取增强的文档体验
开始使用
MarkupLM
概述
MarkupLM 模型在 MarkupLM: Pre-training of Text and Markup Language for Visually-rich Document Understanding 中提出,作者是 Junlong Li, Yiheng Xu, Lei Cui, Furu Wei。 MarkupLM 是 BERT,但应用于 HTML 页面而不是原始文本文档。 该模型结合了额外的嵌入层以提高性能,类似于 LayoutLM。
该模型可用于诸如网页问答或从网页提取信息之类的任务。 它在 2 个重要的基准测试中获得了最先进的结果
论文的摘要如下
多模态预训练结合文本、布局和图像,在视觉丰富文档理解 (VrDU) 方面取得了显著进展,尤其是在固定布局的文档中,例如扫描文档图像。然而,仍然存在大量的数字文档,它们的布局信息不是固定的,需要交互式和动态渲染以进行可视化,这使得现有的基于布局的预训练方法不易应用。在本文中,我们提出了 MarkupLM,用于以标记语言(如基于 HTML/XML 的文档)作为骨干的文档理解任务,其中文本和标记信息被联合预训练。实验结果表明,预训练的 MarkupLM 在多个文档理解任务上显著优于现有的强大基线模型。预训练模型和代码将公开提供。
使用技巧
- 除了
input_ids
,forward() 还期望 2 个额外的输入,即xpath_tags_seq
和xpath_subs_seq
。 这些分别是输入序列中每个 token 的 XPATH 标签和下标。 - 可以使用 MarkupLMProcessor 为模型准备所有数据。 有关更多信息,请参阅使用指南。

用法:MarkupLMProcessor
为模型准备数据的最简单方法是使用 MarkupLMProcessor,它在内部结合了特征提取器 (MarkupLMFeatureExtractor) 和 tokenizer (MarkupLMTokenizer 或 MarkupLMTokenizerFast)。 特征提取器用于从 HTML 字符串中提取所有节点和 xpath,然后将其提供给 tokenizer,tokenizer 将其转换为模型的 token 级别输入 (input_ids
等)。 请注意,如果您只想处理两个任务中的一个,您仍然可以分别使用特征提取器和 tokenizer。
from transformers import MarkupLMFeatureExtractor, MarkupLMTokenizerFast, MarkupLMProcessor
feature_extractor = MarkupLMFeatureExtractor()
tokenizer = MarkupLMTokenizerFast.from_pretrained("microsoft/markuplm-base")
processor = MarkupLMProcessor(feature_extractor, tokenizer)
简而言之,可以将 HTML 字符串(以及可能的其他数据)提供给 MarkupLMProcessor,它将创建模型期望的输入。 在内部,processor 首先使用 MarkupLMFeatureExtractor 来获取节点列表和相应的 xpath。 然后将节点和 xpath 提供给 MarkupLMTokenizer 或 MarkupLMTokenizerFast,它们将其转换为 token 级别的 input_ids
、attention_mask
、token_type_ids
、xpath_subs_seq
、xpath_tags_seq
。 可选地,可以向 processor 提供节点标签,这些标签将被转换为 token 级别的 labels
。
MarkupLMFeatureExtractor 在底层使用了 Beautiful Soup,这是一个用于从 HTML 和 XML 文件中提取数据的 Python 库。 请注意,您仍然可以使用您自己选择的解析解决方案,并将节点和 xpath 自己提供给 MarkupLMTokenizer 或 MarkupLMTokenizerFast。
总共有 5 种 processor 支持的用例。 下面,我们列出所有这些用例。 请注意,这些用例中的每一个都适用于批量和非批量输入(我们针对非批量输入进行说明)。
用例 1:网页分类(训练,推理)+ token 分类(推理),parse_html = True
这是最简单的情况,其中 processor 将使用特征提取器从 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:网页分类(训练,推理)+ token 分类(推理),parse_html=False
如果已经获得了所有节点和 xpath,则不需要特征提取器。 在这种情况下,应将节点和相应的 xpath 本身提供给 processor,并确保将 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:token 分类(训练),parse_html=False
对于 token 分类任务(例如 SWDE),还可以提供相应的节点标签以训练模型。 然后,processor 会将这些标签转换为 token 级别的 labels
。 默认情况下,它只会标记单词的第一个 wordpiece,并用 -100 标记其余的 wordpiece,这是 PyTorch 的 CrossEntropyLoss 的 ignore_index
。 如果您希望标记单词的所有 wordpiece,则可以使用设置为 False
的 only_label_first_subword
初始化 tokenizer。
>>> 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
对于网页上的问答任务,您可以向 processor 提供问题。 默认情况下,processor 将使用特征提取器获取所有节点和 xpath,并创建 [CLS] 问题 tokens [SEP] 单词 tokens [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),您可以向 processor 提供问题。 如果您自己提取了所有节点和 xpath,则可以直接将其提供给 processor。 确保将 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
< 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 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 表示的不同 token。 - 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) — embeddings、编码器和池化器中所有全连接层的 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) — layer normalization 层使用的 epsilon 值。 - max_tree_id_unit_embeddings (
int
, 可选, 默认为 1024) — tree id unit embedding 可能使用的最大值。 通常将其设置为较大的值以防万一(例如,1024)。 - max_xpath_tag_unit_embeddings (
int
, 可选, 默认为 256) — xpath tag unit embedding 可能使用的最大值。 通常将其设置为较大的值以防万一(例如,256)。 - max_xpath_subs_unit_embeddings (
int
, 可选, 默认为 1024) — xpath subscript unit embedding 可能使用的最大值。 通常将其设置为较大的值以防万一(例如,1024)。 - tag_pad_id (
int
, optional, defaults to 216) — xpath 标签中填充 token 的 id。 - subs_pad_id (
int
, optional, defaults to 1001) — xpath 下标中填充 token 的 id。 - xpath_tag_unit_hidden_size (
int
, optional, defaults to 32) — 每个树 id 单元的隐藏层大小。一个完整的树索引将具有 (50*xpath_tag_unit_hidden_size) 维。 - 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.config
MarkupLMFeatureExtractor
构建 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
) — merges 文件的路径。 - errors (
str
, optional, defaults to"replace"
) — 将字节解码为 UTF-8 时要遵循的范例。有关更多信息,请参阅 bytes.decode。 - bos_token (
str
, optional, defaults to"<s>"
) — 预训练期间使用的序列开始 token。可以用作序列分类器 token。当使用特殊 token 构建序列时,这不是用于序列开始的 token。使用的 token 是
cls_token
。 - eos_token (
str
, optional, defaults to"</s>"
) — 序列结束 token。当使用特殊 token 构建序列时,这不是用于序列结束的 token。使用的 token 是
sep_token
。 - sep_token (
str
, optional, defaults to"</s>"
) — 分隔符 token,用于从多个序列构建序列时,例如,用于序列分类的两个序列,或用于问答的文本和问题。它也用作使用特殊 token 构建的序列的最后一个 token。 - cls_token (
str
, optional, defaults to"<s>"
) — 分类器 token,用于进行序列分类(对整个序列进行分类,而不是按 token 分类)。当使用特殊 token 构建时,它是序列的第一个 token。 - unk_token (
str
, optional, defaults to"<unk>"
) — 未知 token。词汇表中不存在的 token 无法转换为 ID,而是设置为此 token。 - pad_token (
str
, optional, defaults to"<pad>"
) — 用于填充的 token,例如在对不同长度的序列进行批处理时。 - mask_token (
str
, optional, defaults to"<mask>"
) — 用于掩码值的 token。这是使用掩码语言建模训练此模型时使用的 token。这是模型将尝试预测的 token。 - add_prefix_space (
bool
, optional, defaults toFalse
) — 是否在输入中添加前导空格。这允许像对待任何其他单词一样对待前导单词。(RoBERTa 分词器通过前面的空格检测单词的开头)。
构建 MarkupLM 分词器。基于字节级字节对编码 (BPE)。MarkupLMTokenizer 可以用于将 HTML 字符串转换为 token 级别的 input_ids
、attention_mask
、token_type_ids
、xpath_tags_seq
和 xpath_tags_seq
。此分词器继承自 PreTrainedTokenizer,其中包含大多数主要方法。用户应参考此超类以获取有关这些方法的更多信息。
build_inputs_with_special_tokens
< source >( token_ids_0: typing.List[int] token_ids_1: typing.Optional[typing.List[int]] = None ) → List[int]
参数
- token_ids_0 (
List[int]
) — 将特殊 token 添加到的 ID 列表。 - token_ids_1 (
List[int]
, optional) — 序列对的可选的第二个 ID 列表。
返回值
List[int]
带有适当特殊 token 的 input IDs 列表。
通过连接并添加特殊 token,从序列或序列对构建模型输入,用于序列分类任务。RoBERTa 序列具有以下格式
- 单个序列:
<s> X </s>
- 序列对:
<s> A </s></s> B </s>
get_special_tokens_mask
< source >( token_ids_0: typing.List[int] token_ids_1: typing.Optional[typing.List[int]] = None already_has_special_tokens: bool = False ) → List[int]
参数
- Retrieve 从未添加特殊 token 的 token 列表中检索序列 ID。当使用 tokenizer
prepare_for_model
方法添加 — - special token 时调用此方法。— token_ids_0 (
List[int]
): ID 列表。 token_ids_1 (List[int]
, optional): 序列对的可选的第二个 ID 列表。 already_has_special_tokens (bool
, optional, defaults toFalse
): token 列表是否已使用模型的特殊 token 格式化。
返回值
List[int]
一个整数列表,范围为 [0, 1]: 1 代表特殊 token,0 代表序列 token。
create_token_type_ids_from_sequences
< source >( token_ids_0: typing.List[int] token_ids_1: typing.Optional[typing.List[int]] = None ) → List[int]
从传递的两个序列创建一个 mask,用于序列对分类任务。RoBERTa 不使用 token 类型 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
) — merges 文件的路径。 - errors (
str
, optional, defaults to"replace"
) — 将字节解码为 UTF-8 时遵循的范例。 有关更多信息,请参阅 bytes.decode。 - bos_token (
str
, optional, defaults to"<s>"
) — 序列开始 token,在预训练期间使用。可以用作序列分类器 token。当使用特殊 token 构建序列时,这不是用于序列开始的 token。使用的 token 是
cls_token
。 - eos_token (
str
, optional, defaults to"</s>"
) — 序列结束 token。当使用特殊 token 构建序列时,这不是用于序列结束的 token。使用的 token 是
sep_token
。 - sep_token (
str
, optional, defaults to"</s>"
) — 分隔符 token,用于从多个序列构建序列时,例如用于序列分类的两个序列,或者用于问答的文本和问题。它也用作使用特殊 token 构建的序列的最后一个 token。 - cls_token (
str
, optional, defaults to"<s>"
) — 分类器 token,用于进行序列分类(对整个序列而不是每个 token 进行分类)。当使用特殊 token 构建时,它是序列的第一个 token。 - unk_token (
str
, optional, defaults to"<unk>"
) — 未知 token。词汇表中不存在的 token 无法转换为 ID,而是设置为此 token。 - pad_token (
str
, optional, defaults to"<pad>"
) — 用于填充的 token,例如当批量处理不同长度的序列时。 - mask_token (
str
, optional, defaults to"<mask>"
) — 用于遮蔽值的 token。这是在使用 masked language modeling 训练此模型时使用的 token。这是模型将尝试预测的 token。 - add_prefix_space (
bool
, optional, defaults toFalse
) — 是否在输入中添加前缀空格。这允许像对待任何其他单词一样对待前导单词。(RoBERTa tokenizer 通过前导空格检测单词的开头)。
构建 MarkupLM tokenizer。基于字节级 Byte-Pair-Encoding (BPE)。
MarkupLMTokenizerFast 可以用于将 HTML 字符串转换为 token 级别的 input_ids
、attention_mask
、token_type_ids
、xpath_tags_seq
和 xpath_tags_seq
。此 tokenizer 继承自 PreTrainedTokenizer,后者包含大多数主要方法。
用户应参考此超类以获取有关这些方法的更多信息。
batch_encode_plus
< source >( batch_text_or_text_pairs: typing.Union[typing.List[str], typing.List[typing.Tuple[str, str]], typing.List[typing.List[str]]] is_pair: bool = None xpaths: typing.Optional[typing.List[typing.List[typing.List[int]]]] = None node_labels: typing.Union[typing.List[int], typing.List[typing.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
): 一个布尔值,指示在编码序列时是否添加特殊 token。 这将使用底层的 PretrainedTokenizerBase.build_inputs_with_special_tokens
函数,该函数定义了哪些 token 会自动添加到 input ids 中。 如果你想自动添加 bos
或 eos
token,这将非常有用。 padding (bool
, str
或 PaddingStrategy, 可选, 默认为 False
): 激活和控制 padding。 接受以下值:
True
或'longest'
: 填充到 batch 中最长的序列(如果仅提供单个序列,则不进行填充)。'max_length'
: 填充到由参数max_length
指定的最大长度,或者如果未提供该参数,则填充到模型可接受的最大输入长度。False
或'do_not_pad'
(默认): 不进行填充(即,可以输出具有不同长度序列的 batch)。 truncation (bool
,str
或 TruncationStrategy, 可选, 默认为False
): 激活和控制 truncation。 接受以下值:True
或'longest_first'
: 截断到由参数max_length
指定的最大长度,或者如果未提供该参数,则截断到模型可接受的最大输入长度。 如果提供了一对序列(或一个 batch 的序列对),这将逐个 token 进行截断,从序列对中最长的序列中移除 token。'only_first'
: 截断到由参数max_length
指定的最大长度,或者如果未提供该参数,则截断到模型可接受的最大输入长度。 如果提供了一对序列(或一个 batch 的序列对),这将仅截断序列对中的第一个序列。'only_second'
: 截断到由参数max_length
指定的最大长度,或者如果未提供该参数,则截断到模型可接受的最大输入长度。 如果提供了一对序列(或一个 batch 的序列对),这将仅截断序列对中的第二个序列。False
或'do_not_truncate'
(默认): 不进行截断(即,可以输出序列长度大于模型最大允许输入大小的 batch)。 max_length (int
, 可选): 控制 truncation/padding 参数之一使用的最大长度。
如果未设置或设置为 None
,如果 truncation/padding 参数之一需要最大长度,则将使用预定义的模型最大长度。 如果模型没有特定的最大输入长度(如 XLNet),则将停用截断/填充到最大长度。 stride (int
, 可选, 默认为 0): 如果与 max_length
一起设置为一个数字,当 return_overflowing_tokens=True
时返回的溢出 token 将包含来自截断序列末尾的一些 token,以便在截断序列和溢出序列之间提供一些重叠。 此参数的值定义了重叠 token 的数量。 is_split_into_words (bool
, 可选, 默认为 False
): 指示输入是否已预先 token 化(例如,拆分为单词)。 如果设置为 True
,tokenizer 假定输入已经拆分为单词(例如,通过在空格上拆分),它将对其进行 token 化。 这对于 NER 或 token 分类非常有用。 pad_to_multiple_of (int
, 可选): 如果设置,则将序列填充为提供值的倍数。 需要激活 padding
。 这对于在计算能力 >= 7.5
(Volta) 的 NVIDIA 硬件上启用 Tensor Core 的使用尤其有用。 padding_side (str
, 可选): 模型应该在其上应用 padding 的一侧。 应在 ['right', 'left'] 中选择。 默认值从同名的类属性中选取。 return_tensors (str
或 TensorType, 可选): 如果设置,将返回 tensor 而不是 python 整数列表。 可接受的值为:
'tf'
: 返回 TensorFlowtf.constant
对象。'pt'
: 返回 PyTorchtorch.Tensor
对象。'np'
: 返回 Numpynp.ndarray
对象。
add_special_tokens (bool
, 可选, 默认为 True
): 一个布尔值,指示是否使用与其模型相关的特殊 token 对序列进行编码。 padding (bool
, str
或 PaddingStrategy, 可选, 默认为 False
): 激活和控制 padding。 接受以下值:
True
或'longest'
: 填充到 batch 中最长的序列(如果仅提供单个序列,则不进行填充)。'max_length'
: 填充到由参数max_length
指定的最大长度,或者如果未提供该参数,则填充到模型可接受的最大输入长度。False
或'do_not_pad'
(默认): 不进行填充(即,可以输出具有不同长度序列的 batch)。 truncation (bool
,str
或 TruncationStrategy, 可选, 默认为False
): 激活和控制 truncation。 接受以下值:True
或'longest_first'
: 截断到由参数max_length
指定的最大长度,或者如果未提供该参数,则截断到模型可接受的最大输入长度。 如果提供了一对序列(或一个 batch 的序列对),这将逐个 token 进行截断,从序列对中最长的序列中移除 token。'only_first'
: 截断到由参数max_length
指定的最大长度,或者如果未提供该参数,则截断到模型可接受的最大输入长度。 如果提供了一对序列(或一个 batch 的序列对),这将仅截断序列对中的第一个序列。'only_second'
: 截断到由参数max_length
指定的最大长度,或者如果未提供该参数,则截断到模型可接受的最大输入长度。 如果提供了一对序列(或一个 batch 的序列对),这将仅截断序列对中的第二个序列。False
或'do_not_truncate'
(默认): 不进行截断(即,可以输出序列长度大于模型最大允许输入大小的 batch)。 max_length (int
, 可选): 控制 truncation/padding 参数之一使用的最大长度。 如果未设置或设置为None
,如果 truncation/padding 参数之一需要最大长度,则将使用预定义的模型最大长度。 如果模型没有特定的最大输入长度(如 XLNet),则将停用截断/填充到最大长度。 stride (int
, 可选, 默认为 0): 如果与max_length
一起设置为一个数字,当return_overflowing_tokens=True
时返回的溢出 token 将包含来自截断序列末尾的一些 token,以便在截断序列和溢出序列之间提供一些重叠。 此参数的值定义了重叠 token 的数量。 pad_to_multiple_of (int
, 可选): 如果设置,则将序列填充为提供值的倍数。 这对于在计算能力>= 7.5
(Volta) 的 NVIDIA 硬件上启用 Tensor Core 的使用尤其有用。 return_tensors (str
或 TensorType, 可选): 如果设置,将返回 tensor 而不是 python 整数列表。 可接受的值为:'tf'
: 返回 TensorFlowtf.constant
对象。'pt'
: 返回 PyTorchtorch.Tensor
对象。'np'
: 返回 Numpynp.ndarray
对象。
build_inputs_with_special_tokens
< source >( token_ids_0: typing.List[int] token_ids_1: typing.Optional[typing.List[int]] = None ) → List[int]
通过连接并添加特殊 token,从序列或序列对构建模型输入,用于序列分类任务。RoBERTa 序列具有以下格式
- 单个序列:
<s> X </s>
- 序列对:
<s> A </s></s> B </s>
create_token_type_ids_from_sequences
< source >( token_ids_0: typing.List[int] token_ids_1: typing.Optional[typing.List[int]] = None ) → List[int]
从传递的两个序列创建一个 mask,用于序列对分类任务。RoBERTa 不使用 token 类型 ID,因此返回一个零列表。
encode_plus
< source >( text: typing.Union[str, typing.List[str]] text_pair: typing.Optional[typing.List[str]] = None xpaths: typing.Optional[typing.List[typing.List[int]]] = None node_labels: typing.Optional[typing.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
) — 一个布尔值,指示在编码序列时是否添加特殊 token。 这将使用底层的PretrainedTokenizerBase.build_inputs_with_special_tokens
函数,该函数定义了哪些 token 会自动添加到 input ids 中。 如果你想自动添加bos
或eos
token,这将非常有用。 - padding (
bool
,str
或 PaddingStrategy, 可选, 默认为False
) — 激活和控制 padding。 接受以下值:True
或'longest'
: 填充到 batch 中最长的序列(如果仅提供单个序列,则不进行填充)。'max_length'
: 填充到由参数max_length
指定的最大长度,或者如果未提供该参数,则填充到模型可接受的最大输入长度。False
或'do_not_pad'
(默认): 不进行填充(即,可以输出具有不同长度序列的 batch)。
- truncation (
bool
,str
或 TruncationStrategy, 可选, 默认为False
) — 激活和控制 truncation。 接受以下值:True
或'longest_first'
: 截断到由参数max_length
指定的最大长度,或者如果未提供该参数,则截断到模型可接受的最大输入长度。 如果提供了一对序列(或一个 batch 的序列对),这将逐个 token 进行截断,从序列对中最长的序列中移除 token。'only_first'
: 截断到由参数max_length
指定的最大长度,或者如果未提供该参数,则截断到模型可接受的最大输入长度。 如果提供了一对序列(或一个 batch 的序列对),这将仅截断序列对中的第一个序列。'only_second'
: 截断到由参数max_length
指定的最大长度,或者如果未提供该参数,则截断到模型可接受的最大输入长度。 如果提供了一对序列(或一个 batch 的序列对),这将仅截断序列对中的第二个序列。False
或'do_not_truncate'
(默认): 不进行截断(即,可以输出序列长度大于模型最大允许输入大小的 batch)。
- max_length (
int
, 可选) — 控制 truncation/padding 参数之一使用的最大长度。如果未设置或设置为
None
,如果 truncation/padding 参数之一需要最大长度,则将使用预定义的模型最大长度。 如果模型没有特定的最大输入长度(如 XLNet),则将停用截断/填充到最大长度。 - stride (
int
, 可选, 默认为 0) — 如果与max_length
一起设置为一个数字,当return_overflowing_tokens=True
时返回的溢出 tokens 将包含来自截断序列末尾的一些 tokens,以便在截断序列和溢出序列之间提供一些重叠。此参数的值定义了重叠 tokens 的数量。 - is_split_into_words (
bool
, 可选, 默认为False
) — 指示输入是否已被预先分词(例如,拆分为单词)。如果设置为True
,tokenizer 假设输入已被拆分为单词(例如,通过在空格上拆分),tokenizer 将对其进行分词。这对于 NER 或 token 分类很有用。 - pad_to_multiple_of (
int
, 可选) — 如果设置,将序列填充到提供值的倍数。需要激活padding
。这对于在计算能力>= 7.5
(Volta) 的 NVIDIA 硬件上启用 Tensor Cores 的使用尤其有用。 - padding_side (
str
, 可选) — 模型应该在其上应用填充的一侧。应从 [‘right’, ‘left’] 中选择。默认值从同名的类属性中选取。 - return_tensors (
str
或 TensorType, 可选) — 如果设置,将返回 tensors 而不是 python 整数列表。可接受的值为:'tf'
: 返回 TensorFlowtf.constant
对象。'pt'
: 返回 PyTorchtorch.Tensor
对象。'np'
: 返回 Numpynp.ndarray
对象。
- add_special_tokens (
bool
, 可选, 默认为True
) — 是否使用与其模型相关的特殊 tokens 对序列进行编码。 - padding (
bool
,str
或 PaddingStrategy, 可选, 默认为False
) — 激活和控制 padding。 接受以下值:True
或'longest'
: 填充到 batch 中最长的序列(如果仅提供单个序列,则不进行填充)。'max_length'
: 填充到由参数max_length
指定的最大长度,或者如果未提供该参数,则填充到模型可接受的最大输入长度。False
或'do_not_pad'
(默认): 不进行填充(即,可以输出具有不同长度序列的 batch)。
- truncation (
bool
,str
或 TruncationStrategy, 可选, 默认为False
) — 激活和控制 truncation。 接受以下值:True
或'longest_first'
: 截断到由参数max_length
指定的最大长度,或者如果未提供该参数,则截断到模型可接受的最大输入长度。 如果提供了一对序列(或一个 batch 的序列对),这将逐个 token 进行截断,从序列对中最长的序列中移除 token。'only_first'
: 截断到由参数max_length
指定的最大长度,或者如果未提供该参数,则截断到模型可接受的最大输入长度。 如果提供了一对序列(或一个 batch 的序列对),这将仅截断序列对中的第一个序列。'only_second'
: 截断到由参数max_length
指定的最大长度,或者如果未提供该参数,则截断到模型可接受的最大输入长度。 如果提供了一对序列(或一个 batch 的序列对),这将仅截断序列对中的第二个序列。False
或'do_not_truncate'
(默认): 不进行截断(即,可以输出序列长度大于模型最大允许输入大小的 batch)。
- max_length (
int
, 可选) — 通过截断/填充参数之一控制要使用的最大长度。如果未设置或设置为None
,如果截断/填充参数之一需要最大长度,则将使用预定义的模型最大长度。如果模型没有特定的最大输入长度(例如 XLNet),则将停用截断/填充到最大长度。 - stride (
int
, 可选, 默认为 0) — 如果与max_length
一起设置为一个数字,当return_overflowing_tokens=True
时返回的溢出 tokens 将包含来自截断序列末尾的一些 tokens,以便在截断序列和溢出序列之间提供一些重叠。此参数的值定义了重叠 tokens 的数量。 - pad_to_multiple_of (
int
, 可选) — 如果设置,将序列填充到提供值的倍数。这对于在计算能力>= 7.5
(Volta) 的 NVIDIA 硬件上启用 Tensor Cores 的使用尤其有用。 - return_tensors (
str
或 TensorType, 可选) — 如果设置,将返回 tensors 而不是 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
< source >( *args **kwargs )
参数
- feature_extractor (
MarkupLMFeatureExtractor
) — MarkupLMFeatureExtractor 的实例。feature extractor 是必需的输入。 - tokenizer (
MarkupLMTokenizer
或MarkupLMTokenizerFast
) — MarkupLMTokenizer 或 MarkupLMTokenizerFast 的实例。tokenizer 是必需的输入。 - parse_html (
bool
, 可选, 默认为True
) — 是否使用MarkupLMFeatureExtractor
将 HTML 字符串解析为节点和相应的 xpaths。
构建一个 MarkupLM processor,它将 MarkupLM feature extractor 和 MarkupLM tokenizer 组合成一个单独的 processor。
MarkupLMProcessor 提供了准备模型数据所需的所有功能。
它首先使用 MarkupLMFeatureExtractor 从一个或多个 HTML 字符串中提取节点和相应的 xpaths。接下来,这些被提供给 MarkupLMTokenizer 或 MarkupLMTokenizerFast,它们将节点和 xpaths 转换为 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: 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
< source >( config add_pooling_layer = True )
参数
- config (MarkupLMConfig) — 带有模型所有参数的模型配置类。使用配置文件初始化不会加载与模型关联的权重,仅加载配置。查看 from_pretrained() 方法以加载模型权重。
裸机 MarkupLM 模型 transformer 输出原始隐藏状态,顶部没有任何特定的 head。此模型是 PyTorch torch.nn.Module 子类。将其用作常规 PyTorch Module,并参考 PyTorch 文档以了解与常规用法和行为相关的所有事项。
forward
< source >( 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)
) — 词汇表中输入序列 tokens 的索引。可以使用 AutoTokenizer 获取索引。 有关详细信息,请参见 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- xpath_tags_seq (
torch.LongTensor
,形状为(batch_size, sequence_length, config.max_depth)
, 可选) — 输入序列中每个 token 的标签 IDs,填充到 config.max_depth。 - xpath_subs_seq (
torch.LongTensor
,形状为(batch_size, sequence_length, config.max_depth)
, 可选) — 输入序列中每个 token 的下标 IDs,填充到 config.max_depth。 - attention_mask (
torch.FloatTensor
,形状为(batch_size, sequence_length)
,可选) — 用于避免在 padding 标记索引上执行 attention 的掩码。掩码值在[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)
,可选) — 用于置空 self-attention 模块中选定 head 的掩码。掩码值在[0, 1]
中选择:1
表示 head **未被掩码**,0
表示 head **被掩码**。 - inputs_embeds (
torch.FloatTensor
,形状为(batch_size, sequence_length, hidden_size)
,可选) — (可选)您可以选择直接传递嵌入表示,而不是传递input_ids
。如果您希望比模型的内部嵌入查找矩阵更灵活地控制如何将 *input_ids* 索引转换为关联的向量,这将非常有用。 - output_attentions (
bool
,可选) — 如果设置为True
,则返回所有 attention 层的 attention 张量。有关更多详细信息,请参阅返回的张量下的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)
。attention softmax 之后的 attention 权重,用于计算 self-attention head 中的加权平均值。
-
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)
。decoder 的 cross-attention 层的 attention 权重,在 attention softmax 之后,用于计算 cross-attention head 中的加权平均值。
-
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)
的附加张量。包含预先计算的隐藏状态(self-attention 块中的 key 和 values,以及如果
config.is_encoder_decoder=True
,则在 cross-attention 块中),可以用于(参见past_key_values
输入)加速顺序解码。
MarkupLMModel forward 方法,覆盖了 __call__
特殊方法。
尽管 forward 传递的配方需要在该函数中定义,但应该在之后调用 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 模型转换器,顶部带有序列分类/回归 head(pooled 输出顶部的线性层),例如用于 GLUE 任务。
此模型是 PyTorch torch.nn.Module 子类。将其用作常规 PyTorch Module,并参阅 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 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.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)
,可选) — 用于避免在 padding 标记索引上执行 attention 的掩码。掩码值在[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)
,可选) — 用于置空 self-attention 模块中选定 head 的掩码。掩码值在[0, 1]
中选择:1
表示 head **未被掩码**,0
表示 head **被掩码**。 - inputs_embeds (
torch.FloatTensor
,形状为(batch_size, sequence_length, hidden_size)
,可选) — (可选)您可以选择直接传递嵌入表示,而不是传递input_ids
。如果您希望比模型的内部嵌入查找矩阵更灵活地控制如何将 *input_ids* 索引转换为关联的向量,这将非常有用。 - output_attentions (
bool
,可选) — 如果设置为True
,则返回所有 attention 层的 attention 张量。有关更多详细信息,请参阅返回的张量下的attentions
。 - output_hidden_states (
bool
, optional) — 如果设置为True
,则返回所有层的隐藏状态。 有关更多详细信息,请参阅返回张量下的hidden_states
。 - return_dict (
bool
, optional) — 如果设置为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)
。attention softmax 之后的 attention 权重,用于计算 self-attention head 中的加权平均值。
MarkupLMForSequenceClassification 前向方法,覆盖了 __call__
特殊方法。
尽管 forward 传递的配方需要在该函数中定义,但应该在之后调用 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.logits
MarkupLMForTokenClassification
class transformers.MarkupLMForTokenClassification
< source >( config )
参数
- config (MarkupLMConfig) — 带有模型所有参数的模型配置类。 使用配置文件初始化不会加载与模型关联的权重,仅加载配置。 查看 from_pretrained() 方法以加载模型权重。
带有 token_classification
头部的 MarkupLM 模型。 此模型是 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 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.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
, optional) — 如果设置为True
,则返回所有注意力层的注意力张量。 有关更多详细信息,请参阅返回张量下的attentions
。 - output_hidden_states (
bool
, optional) — 如果设置为True
,则返回所有层的隐藏状态。 有关更多详细信息,请参阅返回张量下的hidden_states
。 - return_dict (
bool
, optional) — 如果设置为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)
。attention softmax 之后的 attention 权重,用于计算 self-attention head 中的加权平均值。
MarkupLMForTokenClassification 前向方法,覆盖了 __call__
特殊方法。
尽管 forward 传递的配方需要在该函数中定义,但应该在之后调用 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.logits
MarkupLMForQuestionAnswering
class transformers.MarkupLMForQuestionAnswering
< source >( config )
参数
- config (MarkupLMConfig) — 带有模型所有参数的模型配置类。 使用配置文件初始化不会加载与模型关联的权重,仅加载配置。 查看 from_pretrained() 方法以加载模型权重。
带有跨度分类头部的 MarkupLM 模型,用于抽取式问答任务,如 SQuAD(隐藏状态输出顶部的线性层,用于计算 span start logits
和 span end logits
)。
此模型是 PyTorch torch.nn.Module 子类。将其用作常规 PyTorch Module,并参阅 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.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)
。attention softmax 之后的 attention 权重,用于计算 self-attention head 中的加权平均值。
MarkupLMForQuestionAnswering forward 方法,覆盖了 __call__
特殊方法。
尽管 forward 传递的配方需要在该函数中定义,但应该在之后调用 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'