Transformers 文档

TAPAS

Hugging Face's logo
加入 Hugging Face 社区

并访问增强的文档体验

开始使用

TAPAS

概述

TAPAS 模型在 TAPAS: Weakly Supervised Table Parsing via Pre-training 中被提出,作者是 Jonathan Herzig、Paweł Krzysztof Nowak、Thomas Müller、Francesco Piccinno 和 Julian Martin Eisenschlos。它是一个基于 BERT 的模型,专门为回答关于表格数据的问题而设计(和预训练)。与 BERT 相比,TAPAS 使用相对位置嵌入,并有 7 种标记类型来编码表格结构。TAPAS 在一个大型数据集上进行了掩码语言建模 (MLM) 目标的预训练,该数据集包含来自英文维基百科和相应文本的数百万个表格。

对于问答,TAPAS 在顶部有 2 个头部:一个单元格选择头部和一个聚合头部,用于(可选地)在选定的单元格之间执行聚合(例如计数或求和)。TAPAS 已经在多个数据集上进行了微调

  • SQA(微软的顺序问答)
  • WTQ(斯坦福大学的维基表格问题)
  • WikiSQL(Salesforce 提供)。

它在 SQA 和 WTQ 上都取得了最先进的成果,同时在 WikiSQL 上具有与 SOTA 相当的性能,但架构更简单。

论文的摘要如下

回答关于表格的自然语言问题通常被视为语义解析任务。为了减轻完整逻辑形式的收集成本,一种流行的方法侧重于由指称而不是逻辑形式组成的弱监督。然而,从弱监督中训练语义解析器存在困难,此外,生成的逻辑形式仅用作检索指称的中间步骤。在本文中,我们提出了 TAPAS,一种无需生成逻辑形式的表格问答方法。TAPAS 从弱监督中进行训练,并通过选择表格单元格并可选地对这种选择应用相应的聚合运算符来预测指称。TAPAS 扩展了 BERT 的架构以编码表格作为输入,从文本段和从维基百科抓取的表格的有效联合预训练中初始化,并进行端到端训练。我们用三个不同的语义解析数据集进行了实验,发现 TAPAS 通过将 SQA 的最先进准确率从 55.1 提高到 67.2,并在 WIKISQL 和 WIKITQ 上达到与最先进水平相当的性能,但模型架构更简单,从而优于或匹敌语义解析模型。我们还发现,从 WIKISQL 到 WIKITQ 的迁移学习(在我们的设置中是微不足道的)产生了 48.7 的准确率,比最先进水平高出 4.2 个百分点。

此外,作者还进一步预训练了 TAPAS 以识别表格蕴含,通过创建一个数百万个自动创建的训练示例的平衡数据集,这些示例在微调之前的中间步骤中学习。TAPAS 的作者将这种进一步的预训练称为中间预训练(因为 TAPAS 首先在 MLM 上进行预训练,然后在另一个数据集上进行预训练)。他们发现,中间预训练进一步提高了 SQA 的性能,取得了新的最先进水平,并在 TabFact 上也达到了最先进水平,TabFact 是一个包含 1.6 万个维基百科表格的大规模数据集,用于表格蕴含(二元分类任务)。有关更多详细信息,请参阅他们的后续论文:使用中间预训练理解表格,作者是 Julian Martin Eisenschlos、Syrine Krichene 和 Thomas Müller。

drawing TAPAS 架构。取自原始博客文章

此模型由 nielsr 贡献。此模型的 Tensorflow 版本由 kamalkraj 贡献。原始代码可以在此处找到。

使用技巧

  • TAPAS 默认使用相对位置嵌入(在表格的每个单元格处重新启动位置嵌入)。请注意,这是在原始 TAPAS 论文发表后添加的内容。根据作者的说法,这通常会带来稍好的性能,并允许您编码更长的序列而不会耗尽嵌入。这反映在 TapasConfigreset_position_index_per_cell 参数中,默认设置为 True。在 hub 上可用的模型的默认版本都使用相对位置嵌入。您仍然可以使用绝对位置嵌入的版本,方法是在调用 from_pretrained() 方法时传入额外的参数 revision="no_reset"。请注意,通常建议在右侧而不是左侧填充输入。
  • TAPAS 基于 BERT,因此例如 TAPAS-base 对应于 BERT-base 架构。当然,TAPAS-large 将产生最佳性能(论文中报告的结果来自 TAPAS-large)。各种大小模型的结果显示在原始 GitHub 仓库中。
  • TAPAS 具有在 SQA 上微调的检查点,能够回答与会话设置中表格相关的问题。这意味着您可以提出与上一个问题相关的后续问题,例如“他的年龄是多少?”。请注意,在会话设置中,TAPAS 的前向传递略有不同:在这种情况下,您必须将每个表格-问题对逐个馈送到模型,以便 prev_labels 标记类型可以被模型对上一个问题的预测 labels 覆盖。有关更多信息,请参阅“用法”部分。
  • TAPAS 类似于 BERT,因此依赖于掩码语言建模 (MLM) 目标。因此,它在预测掩码标记和一般的 NLU 方面非常有效,但对于文本生成来说不是最优的。使用因果语言建模 (CLM) 目标训练的模型在这方面更好。请注意,TAPAS 可以用作 EncoderDecoderModel 框架中的编码器,以将其与 GPT-2 等自回归文本解码器结合使用。

用法:微调

在这里,我们将解释如何在您自己的数据集上微调 TapasForQuestionAnswering

步骤 1:选择您可以使用 TAPAS 的 3 种方式之一 - 或进行实验

基本上,有 3 种不同的方式可以微调 TapasForQuestionAnswering,对应于 Tapas 在其上进行微调的不同数据集

  1. SQA:如果您对在会话设置中提出与表格相关的后续问题感兴趣。例如,如果您首先问“第一个演员的名字是什么?”,那么您可以问一个后续问题,例如“他多大了?”。在这里,问题不涉及任何聚合(所有问题都是单元格选择问题)。
  2. WTQ:如果您对在会话设置中提问不感兴趣,而只是提出与表格相关的问题,这些问题可能涉及聚合,例如计算行数、求和单元格值或平均单元格值。然后,您可以例如问“克里斯蒂亚诺·罗纳尔多在他的职业生涯中总共进了多少球?”。这种情况也称为弱监督,因为模型本身必须仅根据问题的答案作为监督来学习适当的聚合运算符(SUM/COUNT/AVERAGE/NONE)。
  3. WikiSQL-supervised:此数据集基于 WikiSQL,模型在训练期间被赋予了真实聚合运算符。这也称为强监督。在这里,学习适当的聚合运算符要容易得多。

总结一下

任务 示例数据集 描述
会话式 SQA 会话式,仅单元格选择问题
聚合的弱监督 WTQ 问题可能涉及聚合,模型必须仅根据答案作为监督来学习这一点
聚合的强监督 WikiSQL-supervised 问题可能涉及聚合,模型必须根据给定的黄金聚合运算符来学习这一点
Pytorch
隐藏 Pytorch 内容

可以使用如下所示的方法,从 hub 初始化具有预训练基础和随机初始化的分类头的模型。

>>> from transformers import TapasConfig, TapasForQuestionAnswering

>>> # for example, the base sized model with default SQA configuration
>>> model = TapasForQuestionAnswering.from_pretrained("google/tapas-base")

>>> # or, the base sized model with WTQ configuration
>>> config = TapasConfig.from_pretrained("google/tapas-base-finetuned-wtq")
>>> model = TapasForQuestionAnswering.from_pretrained("google/tapas-base", config=config)

>>> # or, the base sized model with WikiSQL configuration
>>> config = TapasConfig("google-base-finetuned-wikisql-supervised")
>>> model = TapasForQuestionAnswering.from_pretrained("google/tapas-base", config=config)

当然,您不一定非要遵循 TAPAS 进行微调的三种方式之一。您也可以通过在初始化 TapasConfig 时定义您想要的任何超参数来进行实验,然后基于该配置创建 TapasForQuestionAnswering。例如,如果您的数据集既有会话问题,也有可能涉及聚合的问题,那么您可以这样做。这是一个例子

>>> from transformers import TapasConfig, TapasForQuestionAnswering

>>> # you can initialize the classification heads any way you want (see docs of TapasConfig)
>>> config = TapasConfig(num_aggregation_labels=3, average_logits_per_cell=True)
>>> # initializing the pre-trained base sized model with our custom classification heads
>>> model = TapasForQuestionAnswering.from_pretrained("google/tapas-base", config=config)
TensorFlow
隐藏 TensorFlow 内容

可以使用如下所示的方法,从 hub 初始化具有预训练基础和随机初始化的分类头的模型。请确保已安装 tensorflow_probability 依赖项

>>> from transformers import TapasConfig, TFTapasForQuestionAnswering

>>> # for example, the base sized model with default SQA configuration
>>> model = TFTapasForQuestionAnswering.from_pretrained("google/tapas-base")

>>> # or, the base sized model with WTQ configuration
>>> config = TapasConfig.from_pretrained("google/tapas-base-finetuned-wtq")
>>> model = TFTapasForQuestionAnswering.from_pretrained("google/tapas-base", config=config)

>>> # or, the base sized model with WikiSQL configuration
>>> config = TapasConfig("google-base-finetuned-wikisql-supervised")
>>> model = TFTapasForQuestionAnswering.from_pretrained("google/tapas-base", config=config)

当然,您不一定非要遵循 TAPAS 进行微调的三种方式之一。您也可以通过在初始化 TapasConfig 时定义您想要的任何超参数来进行实验,然后基于该配置创建 TFTapasForQuestionAnswering。例如,如果您的数据集既有会话问题,也有可能涉及聚合的问题,那么您可以这样做。这是一个例子

>>> from transformers import TapasConfig, TFTapasForQuestionAnswering

>>> # you can initialize the classification heads any way you want (see docs of TapasConfig)
>>> config = TapasConfig(num_aggregation_labels=3, average_logits_per_cell=True)
>>> # initializing the pre-trained base sized model with our custom classification heads
>>> model = TFTapasForQuestionAnswering.from_pretrained("google/tapas-base", config=config)

您还可以从已经微调的检查点开始。这里需要注意的是,在 WTQ 上已经微调的检查点由于 L2 损失而存在一些问题,L2 损失在某种程度上是脆弱的。有关更多信息,请参阅此处

有关 HuggingFace 的 hub 上可用的所有预训练和微调 TAPAS 检查点的列表,请参阅此处

步骤 2:以 SQA 格式准备您的数据

其次,无论您选择上述哪种方式,您都应该以 SQA 格式准备您的数据集。此格式是一个 TSV/CSV 文件,包含以下列

  • id:可选,表格-问题对的 ID,用于记账目的。
  • annotator:可选,注释表格-问题对的人员的 ID,用于记账目的。
  • position:整数,指示问题是与表格相关的第一、第二、第三...个问题。仅在会话设置 (SQA) 中需要。如果您要进行 WTQ/WikiSQL-supervised,则不需要此列。
  • question:字符串
  • table_file:字符串,包含表格数据的 csv 文件的名称
  • answer_coordinates:一个或多个元组的列表(每个元组都是单元格坐标,即作为答案一部分的行、列对)
  • answer_text:一个或多个字符串的列表(每个字符串都是作为答案一部分的单元格值)
  • aggregation_label:聚合运算符的索引。仅在聚合的强监督情况下(WikiSQL-supervised 情况)需要
  • float_answer:问题的浮点答案(如果没有,则为 np.nan)。仅在聚合的弱监督情况下(例如 WTQ 和 WikiSQL)需要

表格本身应存在于文件夹中,每个表格都是一个单独的 csv 文件。请注意,TAPAS 算法的作者使用了转换脚本和一些自动化逻辑来将其他数据集(WTQ、WikiSQL)转换为 SQA 格式。作者在此处解释了这一点。可以在此处找到与 HuggingFace 的实现一起使用的此脚本的转换版本。有趣的是,这些转换脚本并不完美(answer_coordinatesfloat_answer 字段是根据 answer_text 填充的),这意味着 WTQ 和 WikiSQL 的结果实际上可以得到改进。

步骤 3:使用 TapasTokenizer 将您的数据转换为张量

Pytorch
隐藏 Pytorch 内容

第三,假设您已以此 TSV/CSV 格式(以及包含表格数据的相应 CSV 文件)准备好数据,那么您可以使用 TapasTokenizer 将表格-问题对转换为 input_idsattention_masktoken_type_ids 等。同样,根据您在上面选择的三种情况中的哪一种,TapasForQuestionAnswering 需要不同的输入来进行微调

任务 必需的输入
会话式 input_ids, attention_mask, token_type_ids, labels
聚合的弱监督 input_ids, attention_mask, token_type_ids, labels, numeric_values, numeric_values_scale, float_answer
聚合的强监督 input ids, attention mask, token type ids, labels, aggregation_labels

TapasTokenizer 基于 TSV 文件的 answer_coordinatesanswer_text 列创建 labelsnumeric_valuesnumeric_values_scalefloat_answeraggregation_labels 已经在步骤 2 的 TSV 文件中。这是一个例子

>>> from transformers import TapasTokenizer
>>> import pandas as pd

>>> model_name = "google/tapas-base"
>>> tokenizer = TapasTokenizer.from_pretrained(model_name)

>>> data = {"Actors": ["Brad Pitt", "Leonardo Di Caprio", "George Clooney"], "Number of movies": ["87", "53", "69"]}
>>> queries = [
...     "What is the name of the first actor?",
...     "How many movies has George Clooney played in?",
...     "What is the total number of movies?",
... ]
>>> answer_coordinates = [[(0, 0)], [(2, 1)], [(0, 1), (1, 1), (2, 1)]]
>>> answer_text = [["Brad Pitt"], ["69"], ["209"]]
>>> table = pd.DataFrame.from_dict(data)
>>> inputs = tokenizer(
...     table=table,
...     queries=queries,
...     answer_coordinates=answer_coordinates,
...     answer_text=answer_text,
...     padding="max_length",
...     return_tensors="pt",
... )
>>> inputs
{'input_ids': tensor([[ ... ]]), 'attention_mask': tensor([[...]]), 'token_type_ids': tensor([[[...]]]),
'numeric_values': tensor([[ ... ]]), 'numeric_values_scale: tensor([[ ... ]]), labels: tensor([[ ... ]])}

请注意,TapasTokenizer 期望表格的数据是纯文本。您可以在数据帧上使用 .astype(str) 将其转换为纯文本数据。当然,这仅显示如何编码单个训练示例。建议创建一个数据加载器来迭代批次

>>> import torch
>>> import pandas as pd

>>> tsv_path = "your_path_to_the_tsv_file"
>>> table_csv_path = "your_path_to_a_directory_containing_all_csv_files"


>>> class TableDataset(torch.utils.data.Dataset):
...     def __init__(self, data, tokenizer):
...         self.data = data
...         self.tokenizer = tokenizer

...     def __getitem__(self, idx):
...         item = data.iloc[idx]
...         table = pd.read_csv(table_csv_path + item.table_file).astype(
...             str
...         )  # be sure to make your table data text only
...         encoding = self.tokenizer(
...             table=table,
...             queries=item.question,
...             answer_coordinates=item.answer_coordinates,
...             answer_text=item.answer_text,
...             truncation=True,
...             padding="max_length",
...             return_tensors="pt",
...         )
...         # remove the batch dimension which the tokenizer adds by default
...         encoding = {key: val.squeeze(0) for key, val in encoding.items()}
...         # add the float_answer which is also required (weak supervision for aggregation case)
...         encoding["float_answer"] = torch.tensor(item.float_answer)
...         return encoding

...     def __len__(self):
...         return len(self.data)


>>> data = pd.read_csv(tsv_path, sep="\t")
>>> train_dataset = TableDataset(data, tokenizer)
>>> train_dataloader = torch.utils.data.DataLoader(train_dataset, batch_size=32)
TensorFlow
隐藏 TensorFlow 内容

第三,假设您已以此 TSV/CSV 格式(以及包含表格数据的相应 CSV 文件)准备好数据,那么您可以使用 TapasTokenizer 将表格-问题对转换为 input_idsattention_masktoken_type_ids 等。同样,根据您在上面选择的三种情况中的哪一种,TFTapasForQuestionAnswering 需要不同的输入来进行微调

任务 必需的输入
会话式 input_ids, attention_mask, token_type_ids, labels
聚合的弱监督 input_ids, attention_mask, token_type_ids, labels, numeric_values, numeric_values_scale, float_answer
聚合的强监督 input ids, attention mask, token type ids, labels, aggregation_labels

TapasTokenizer 基于 TSV 文件的 answer_coordinatesanswer_text 列创建 labelsnumeric_valuesnumeric_values_scalefloat_answeraggregation_labels 已经在步骤 2 的 TSV 文件中。这是一个例子

>>> from transformers import TapasTokenizer
>>> import pandas as pd

>>> model_name = "google/tapas-base"
>>> tokenizer = TapasTokenizer.from_pretrained(model_name)

>>> data = {"Actors": ["Brad Pitt", "Leonardo Di Caprio", "George Clooney"], "Number of movies": ["87", "53", "69"]}
>>> queries = [
...     "What is the name of the first actor?",
...     "How many movies has George Clooney played in?",
...     "What is the total number of movies?",
... ]
>>> answer_coordinates = [[(0, 0)], [(2, 1)], [(0, 1), (1, 1), (2, 1)]]
>>> answer_text = [["Brad Pitt"], ["69"], ["209"]]
>>> table = pd.DataFrame.from_dict(data)
>>> inputs = tokenizer(
...     table=table,
...     queries=queries,
...     answer_coordinates=answer_coordinates,
...     answer_text=answer_text,
...     padding="max_length",
...     return_tensors="tf",
... )
>>> inputs
{'input_ids': tensor([[ ... ]]), 'attention_mask': tensor([[...]]), 'token_type_ids': tensor([[[...]]]),
'numeric_values': tensor([[ ... ]]), 'numeric_values_scale: tensor([[ ... ]]), labels: tensor([[ ... ]])}

请注意,TapasTokenizer 期望表格的数据是纯文本。您可以在数据帧上使用 .astype(str) 将其转换为纯文本数据。当然,这仅显示如何编码单个训练示例。建议创建一个数据加载器来迭代批次

>>> import tensorflow as tf
>>> import pandas as pd

>>> tsv_path = "your_path_to_the_tsv_file"
>>> table_csv_path = "your_path_to_a_directory_containing_all_csv_files"


>>> class TableDataset:
...     def __init__(self, data, tokenizer):
...         self.data = data
...         self.tokenizer = tokenizer

...     def __iter__(self):
...         for idx in range(self.__len__()):
...             item = self.data.iloc[idx]
...             table = pd.read_csv(table_csv_path + item.table_file).astype(
...                 str
...             )  # be sure to make your table data text only
...             encoding = self.tokenizer(
...                 table=table,
...                 queries=item.question,
...                 answer_coordinates=item.answer_coordinates,
...                 answer_text=item.answer_text,
...                 truncation=True,
...                 padding="max_length",
...                 return_tensors="tf",
...             )
...             # remove the batch dimension which the tokenizer adds by default
...             encoding = {key: tf.squeeze(val, 0) for key, val in encoding.items()}
...             # add the float_answer which is also required (weak supervision for aggregation case)
...             encoding["float_answer"] = tf.convert_to_tensor(item.float_answer, dtype=tf.float32)
...             yield encoding["input_ids"], encoding["attention_mask"], encoding["numeric_values"], encoding[
...                 "numeric_values_scale"
...             ], encoding["token_type_ids"], encoding["labels"], encoding["float_answer"]

...     def __len__(self):
...         return len(self.data)


>>> data = pd.read_csv(tsv_path, sep="\t")
>>> train_dataset = TableDataset(data, tokenizer)
>>> output_signature = (
...     tf.TensorSpec(shape=(512,), dtype=tf.int32),
...     tf.TensorSpec(shape=(512,), dtype=tf.int32),
...     tf.TensorSpec(shape=(512,), dtype=tf.float32),
...     tf.TensorSpec(shape=(512,), dtype=tf.float32),
...     tf.TensorSpec(shape=(512, 7), dtype=tf.int32),
...     tf.TensorSpec(shape=(512,), dtype=tf.int32),
...     tf.TensorSpec(shape=(512,), dtype=tf.float32),
... )
>>> train_dataloader = tf.data.Dataset.from_generator(train_dataset, output_signature=output_signature).batch(32)

请注意,在这里,我们独立编码每个表格-问题对。只要您的数据集不是会话式的,这就可以了。如果您的数据集涉及会话问题(例如 SQA),那么您应该首先将每个表格的 queriesanswer_coordinatesanswer_text 分组在一起(按其 position 索引的顺序),并批量编码每个表格及其问题。这将确保 prev_labels 标记类型(请参阅 TapasTokenizer 的文档)设置正确。有关更多信息,请参阅此笔记本。有关使用 TensorFlow 模型的更多信息,请参阅此笔记本

**步骤 4:训练(微调)模型**

Pytorch
隐藏 Pytorch 内容

然后,您可以按如下方式微调 TapasForQuestionAnswering(此处显示的是聚合情况的弱监督)

>>> from transformers import TapasConfig, TapasForQuestionAnswering, AdamW

>>> # this is the default WTQ configuration
>>> config = TapasConfig(
...     num_aggregation_labels=4,
...     use_answer_as_supervision=True,
...     answer_loss_cutoff=0.664694,
...     cell_selection_preference=0.207951,
...     huber_loss_delta=0.121194,
...     init_cell_selection_weights_to_zero=True,
...     select_one_column=True,
...     allow_empty_column_selection=False,
...     temperature=0.0352513,
... )
>>> model = TapasForQuestionAnswering.from_pretrained("google/tapas-base", config=config)

>>> optimizer = AdamW(model.parameters(), lr=5e-5)

>>> model.train()
>>> for epoch in range(2):  # loop over the dataset multiple times
...     for batch in train_dataloader:
...         # get the inputs;
...         input_ids = batch["input_ids"]
...         attention_mask = batch["attention_mask"]
...         token_type_ids = batch["token_type_ids"]
...         labels = batch["labels"]
...         numeric_values = batch["numeric_values"]
...         numeric_values_scale = batch["numeric_values_scale"]
...         float_answer = batch["float_answer"]

...         # zero the parameter gradients
...         optimizer.zero_grad()

...         # forward + backward + optimize
...         outputs = model(
...             input_ids=input_ids,
...             attention_mask=attention_mask,
...             token_type_ids=token_type_ids,
...             labels=labels,
...             numeric_values=numeric_values,
...             numeric_values_scale=numeric_values_scale,
...             float_answer=float_answer,
...         )
...         loss = outputs.loss
...         loss.backward()
...         optimizer.step()
TensorFlow
隐藏 TensorFlow 内容

然后,您可以按如下方式微调 TFTapasForQuestionAnswering(此处显示的是聚合情况的弱监督)

>>> import tensorflow as tf
>>> from transformers import TapasConfig, TFTapasForQuestionAnswering

>>> # this is the default WTQ configuration
>>> config = TapasConfig(
...     num_aggregation_labels=4,
...     use_answer_as_supervision=True,
...     answer_loss_cutoff=0.664694,
...     cell_selection_preference=0.207951,
...     huber_loss_delta=0.121194,
...     init_cell_selection_weights_to_zero=True,
...     select_one_column=True,
...     allow_empty_column_selection=False,
...     temperature=0.0352513,
... )
>>> model = TFTapasForQuestionAnswering.from_pretrained("google/tapas-base", config=config)

>>> optimizer = tf.keras.optimizers.Adam(learning_rate=5e-5)

>>> for epoch in range(2):  # loop over the dataset multiple times
...     for batch in train_dataloader:
...         # get the inputs;
...         input_ids = batch[0]
...         attention_mask = batch[1]
...         token_type_ids = batch[4]
...         labels = batch[-1]
...         numeric_values = batch[2]
...         numeric_values_scale = batch[3]
...         float_answer = batch[6]

...         # forward + backward + optimize
...         with tf.GradientTape() as tape:
...             outputs = model(
...                 input_ids=input_ids,
...                 attention_mask=attention_mask,
...                 token_type_ids=token_type_ids,
...                 labels=labels,
...                 numeric_values=numeric_values,
...                 numeric_values_scale=numeric_values_scale,
...                 float_answer=float_answer,
...             )
...         grads = tape.gradient(outputs.loss, model.trainable_weights)
...         optimizer.apply_gradients(zip(grads, model.trainable_weights))

用法:推理

Pytorch
隐藏 Pytorch 内容

在这里,我们将解释如何使用 TapasForQuestionAnsweringTFTapasForQuestionAnswering 进行推理(即对新数据进行预测)。对于推理,只需要向模型提供 input_idsattention_masktoken_type_ids(您可以使用 TapasTokenizer 获得),即可获得 logits。接下来,您可以使用方便的 ~models.tapas.tokenization_tapas.convert_logits_to_predictions 方法将这些 logits 转换为预测的坐标和可选的聚合索引。

但是,请注意,推理不同,具体取决于设置是否是会话式的。在非会话设置中,可以对批次的所有表格-问题对并行完成推理。这是一个例子

>>> from transformers import TapasTokenizer, TapasForQuestionAnswering
>>> import pandas as pd

>>> model_name = "google/tapas-base-finetuned-wtq"
>>> model = TapasForQuestionAnswering.from_pretrained(model_name)
>>> tokenizer = TapasTokenizer.from_pretrained(model_name)

>>> data = {"Actors": ["Brad Pitt", "Leonardo Di Caprio", "George Clooney"], "Number of movies": ["87", "53", "69"]}
>>> queries = [
...     "What is the name of the first actor?",
...     "How many movies has George Clooney played in?",
...     "What is the total number of movies?",
... ]
>>> table = pd.DataFrame.from_dict(data)
>>> inputs = tokenizer(table=table, queries=queries, padding="max_length", return_tensors="pt")
>>> outputs = model(**inputs)
>>> predicted_answer_coordinates, predicted_aggregation_indices = tokenizer.convert_logits_to_predictions(
...     inputs, outputs.logits.detach(), outputs.logits_aggregation.detach()
... )

>>> # let's print out the results:
>>> id2aggregation = {0: "NONE", 1: "SUM", 2: "AVERAGE", 3: "COUNT"}
>>> aggregation_predictions_string = [id2aggregation[x] for x in predicted_aggregation_indices]

>>> answers = []
>>> for coordinates in predicted_answer_coordinates:
...     if len(coordinates) == 1:
...         # only a single cell:
...         answers.append(table.iat[coordinates[0]])
...     else:
...         # multiple cells
...         cell_values = []
...         for coordinate in coordinates:
...             cell_values.append(table.iat[coordinate])
...         answers.append(", ".join(cell_values))

>>> display(table)
>>> print("")
>>> for query, answer, predicted_agg in zip(queries, answers, aggregation_predictions_string):
...     print(query)
...     if predicted_agg == "NONE":
...         print("Predicted answer: " + answer)
...     else:
...         print("Predicted answer: " + predicted_agg + " > " + answer)
What is the name of the first actor?
Predicted answer: Brad Pitt
How many movies has George Clooney played in?
Predicted answer: COUNT > 69
What is the total number of movies?
Predicted answer: SUM > 87, 53, 69
TensorFlow
隐藏 TensorFlow 内容

在这里,我们将解释如何使用 TFTapasForQuestionAnswering 进行推理(即对新数据进行预测)。对于推理,只需要向模型提供 input_idsattention_masktoken_type_ids(您可以使用 TapasTokenizer 获得),即可获得 logits。接下来,您可以使用方便的 ~models.tapas.tokenization_tapas.convert_logits_to_predictions 方法将这些 logits 转换为预测的坐标和可选的聚合索引。

但是,请注意,推理不同,具体取决于设置是否是会话式的。在非会话设置中,可以对批次的所有表格-问题对并行完成推理。这是一个例子

>>> from transformers import TapasTokenizer, TFTapasForQuestionAnswering
>>> import pandas as pd

>>> model_name = "google/tapas-base-finetuned-wtq"
>>> model = TFTapasForQuestionAnswering.from_pretrained(model_name)
>>> tokenizer = TapasTokenizer.from_pretrained(model_name)

>>> data = {"Actors": ["Brad Pitt", "Leonardo Di Caprio", "George Clooney"], "Number of movies": ["87", "53", "69"]}
>>> queries = [
...     "What is the name of the first actor?",
...     "How many movies has George Clooney played in?",
...     "What is the total number of movies?",
... ]
>>> table = pd.DataFrame.from_dict(data)
>>> inputs = tokenizer(table=table, queries=queries, padding="max_length", return_tensors="tf")
>>> outputs = model(**inputs)
>>> predicted_answer_coordinates, predicted_aggregation_indices = tokenizer.convert_logits_to_predictions(
...     inputs, outputs.logits, outputs.logits_aggregation
... )

>>> # let's print out the results:
>>> id2aggregation = {0: "NONE", 1: "SUM", 2: "AVERAGE", 3: "COUNT"}
>>> aggregation_predictions_string = [id2aggregation[x] for x in predicted_aggregation_indices]

>>> answers = []
>>> for coordinates in predicted_answer_coordinates:
...     if len(coordinates) == 1:
...         # only a single cell:
...         answers.append(table.iat[coordinates[0]])
...     else:
...         # multiple cells
...         cell_values = []
...         for coordinate in coordinates:
...             cell_values.append(table.iat[coordinate])
...         answers.append(", ".join(cell_values))

>>> display(table)
>>> print("")
>>> for query, answer, predicted_agg in zip(queries, answers, aggregation_predictions_string):
...     print(query)
...     if predicted_agg == "NONE":
...         print("Predicted answer: " + answer)
...     else:
...         print("Predicted answer: " + predicted_agg + " > " + answer)
What is the name of the first actor?
Predicted answer: Brad Pitt
How many movies has George Clooney played in?
Predicted answer: COUNT > 69
What is the total number of movies?
Predicted answer: SUM > 87, 53, 69

在会话设置的情况下,每个表格-问题对都必须顺序地提供给模型,以便 prev_labels 标记类型可以被上一个表格-问题对的预测 labels 覆盖。同样,更多信息可以在此笔记本(对于 PyTorch)和此笔记本(对于 TensorFlow)中找到。

资源

TAPAS 特定输出

class transformers.models.tapas.modeling_tapas.TableQuestionAnsweringOutput

< >

( loss: Optional = None logits: FloatTensor = None logits_aggregation: FloatTensor = None hidden_states: Optional = None attentions: Optional = None )

参数

  • loss (torch.FloatTensor,形状为 (1,)可选,当提供 labels(以及可能的 answeraggregation_labelsnumeric_valuesnumeric_values_scale)时返回) — 总损失,是层级单元格选择对数似然损失以及(可选的)半监督回归损失和(可选的)聚合监督损失的总和。
  • logits (torch.FloatTensor,形状为 (batch_size, sequence_length)) — 单元格选择头的预测分数,针对每个 token。
  • logits_aggregation (torch.FloatTensor, 可选, 形状为 (batch_size, num_aggregation_labels)) — 聚合头的预测分数,针对每个聚合运算符。
  • hidden_states (tuple(torch.FloatTensor), 可选, 当传递 output_hidden_states=Trueconfig.output_hidden_states=True 时返回) — torch.FloatTensor 的元组(每个层的输出一个,加上嵌入层的输出)。形状为 (batch_size, sequence_length, hidden_size)。模型在每一层输出的隐藏状态,加上初始嵌入输出。
  • attentions (tuple(torch.FloatTensor), 可选, 当传递 output_attentions=Trueconfig.output_attentions=True 时返回) — torch.FloatTensor 的元组(每层一个)。形状为 (batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 后的注意力权重,用于计算自注意力头中的加权平均值。

TapasForQuestionAnswering 的输出类型。

TapasConfig

class transformers.TapasConfig

< >

( 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 = 1024 type_vocab_sizes = [3, 256, 256, 2, 256, 256, 10] initializer_range = 0.02 layer_norm_eps = 1e-12 pad_token_id = 0 positive_label_weight = 10.0 num_aggregation_labels = 0 aggregation_loss_weight = 1.0 use_answer_as_supervision = None answer_loss_importance = 1.0 use_normalized_answer_loss = False huber_loss_delta = None temperature = 1.0 aggregation_temperature = 1.0 use_gumbel_for_cells = False use_gumbel_for_aggregation = False average_approximation_function = 'ratio' cell_selection_preference = None answer_loss_cutoff = None max_num_rows = 64 max_num_columns = 32 average_logits_per_cell = False select_one_column = True allow_empty_column_selection = False init_cell_selection_weights_to_zero = False reset_position_index_per_cell = True disable_per_token_loss = False aggregation_labels = None no_aggregation_label_index = None **kwargs )

参数

  • vocab_size (int, 可选, 默认为 30522) — TAPAS 模型的词汇表大小。定义了在调用 TapasModel 时传递的 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 (strCallable, 可选, 默认为 "gelu") — 编码器和池化器中的非线性激活函数(函数或字符串)。如果为字符串,则支持 "gelu", "relu", "swish""gelu_new"
  • hidden_dropout_prob (float, 可选, 默认为 0.1) — 嵌入层、编码器和池化器中所有全连接层的 dropout 概率。
  • attention_probs_dropout_prob (float, 可选, 默认为 0.1) — 注意力概率的 dropout 比率。
  • max_position_embeddings (int, 可选, 默认为 1024) — 此模型可能使用的最大序列长度。通常设置为较大的值以防万一(例如,512 或 1024 或 2048)。
  • type_vocab_sizes (List[int], 可选, 默认为 [3, 256, 256, 2, 256, 256, 10]) — 调用 TapasModel 时传递的 token_type_ids 的词汇表大小。
  • initializer_range (float, 可选, 默认为 0.02) — 用于初始化所有权重矩阵的截断正态分布初始化器的标准差。
  • layer_norm_eps (float, 可选, 默认为 1e-12) — 层归一化层使用的 epsilon 值。
  • positive_label_weight (float, 可选, 默认为 10.0) — 正标签的权重。
  • num_aggregation_labels (int, 可选, 默认为 0) — 要预测的聚合操作符的数量。
  • aggregation_loss_weight (float, 可选, 默认为 1.0) — 聚合损失的重要性权重。
  • use_answer_as_supervision (bool, 可选) — 是否将答案用作聚合示例的唯一监督信号。
  • answer_loss_importance (float, 可选, 默认为 1.0) — 回归损失的重要性权重。
  • use_normalized_answer_loss (bool, 可选, 默认为 False) — 是否通过预测值和期望值的最大值来归一化答案损失。
  • huber_loss_delta (float, 可选) — 用于计算回归损失的 Delta 参数。
  • temperature (float, 可选, 默认为 1.0) — 用于控制(或更改)单元格 logits 概率偏度的值。
  • aggregation_temperature (float, 可选, 默认为 1.0) — 缩放聚合 logits 以控制概率的偏度。
  • use_gumbel_for_cells (bool, 可选, 默认为 False) — 是否对单元格选择应用 Gumbel-Softmax。
  • use_gumbel_for_aggregation (bool, 可选, 默认为 False) — 是否对聚合选择应用 Gumbel-Softmax。
  • average_approximation_function (string, 可选, 默认为 "ratio") — 在弱监督情况下计算单元格预期平均值的方法。 可以是 "ratio", "first_order""second_order" 之一。
  • cell_selection_preference (float, 可选) — 在不明确的情况下对单元格选择的偏好。 仅在聚合的弱监督情况下适用 (WTQ, WikiSQL)。 如果聚合概率的总质量(不包括“NONE”操作符)高于此超参数,则预测示例的聚合。
  • answer_loss_cutoff (float, 可选) — 忽略答案损失大于 cutoff 的示例。
  • max_num_rows (int, 可选, 默认为 64) — 最大行数。
  • max_num_columns (int, 可选, 默认为 32) — 最大列数。
  • average_logits_per_cell (bool, 可选, 默认为 False) — 是否平均每个单元格的 logits。
  • select_one_column (bool, 可选, 默认为 True) — 是否约束模型仅从单列中选择单元格。
  • allow_empty_column_selection (bool, 可选, 默认为 False) — 是否允许不选择任何列。
  • init_cell_selection_weights_to_zero (bool, 可选, 默认为 False) — 是否将单元格选择权重初始化为 0,以便初始概率为 50%。
  • reset_position_index_per_cell (bool, 可选, 默认为 True) — 是否在每个单元格处重新启动位置索引(即使用相对位置嵌入)。
  • disable_per_token_loss (bool, 可选, 默认为 False) — 是否禁用对单元格的任何(强或弱)监督。
  • aggregation_labels (Dict[int, label], 可选) — 用于聚合结果的聚合标签。 例如,WTQ 模型具有以下聚合标签: {0: "NONE", 1: "SUM", 2: "AVERAGE", 3: "COUNT"}
  • no_aggregation_label_index (int, 可选) — 如果定义了聚合标签,并且其中一个标签代表“无聚合”,则应将其设置为其索引。 例如,WTQ 模型在索引 0 处具有“NONE”聚合标签,因此对于这些模型,该值应设置为 0。

这是用于存储 TapasModel 配置的配置类。 它用于根据指定的参数实例化 TAPAS 模型,定义模型架构。 使用默认值实例化配置将产生与 TAPAS google/tapas-base-finetuned-sqa 架构类似的配置。

配置对象继承自 PreTrainedConfig,可用于控制模型输出。 有关更多信息,请阅读 PretrainedConfig 中的文档。

BERT 的附加超参数取自原始实现的 run_task_main.py 和 hparam_utils.py。 原始实现可在 https://github.com/google-research/tapas/tree/master 中找到。

示例

>>> from transformers import TapasModel, TapasConfig

>>> # Initializing a default (SQA) Tapas configuration
>>> configuration = TapasConfig()
>>> # Initializing a model from the configuration
>>> model = TapasModel(configuration)
>>> # Accessing the model configuration
>>> configuration = model.config

TapasTokenizer

class transformers.TapasTokenizer

< >

( vocab_file do_lower_case = True do_basic_tokenize = True never_split = None unk_token = '[UNK]' sep_token = '[SEP]' pad_token = '[PAD]' cls_token = '[CLS]' mask_token = '[MASK]' empty_token = '[EMPTY]' tokenize_chinese_chars = True strip_accents = None cell_trim_length: int = -1 max_column_id: int = None max_row_id: int = None strip_column_names: bool = False update_answer_coordinates: bool = False min_question_length = None max_question_length = None model_max_length: int = 512 additional_special_tokens: Optional = None clean_up_tokenization_spaces = True **kwargs )

参数

  • vocab_file (str) — 包含词汇表的文件。
  • do_lower_case (bool, 可选, 默认为 True) — 是否在分词时将输入文本转换为小写。
  • do_basic_tokenize (bool, 可选, 默认为 True) — 是否在 WordPiece 分词之前执行基础分词。
  • never_split (Iterable, 可选) — 在分词期间永远不会被拆分的 token 集合。 仅当 do_basic_tokenize=True 时有效。
  • unk_token (str, 可选, 默认为 "[UNK]") — 未知 token。 词汇表中不存在的 token 无法转换为 ID,而是设置为此 token。
  • sep_token (str, 可选, 默认为 "[SEP]") — 分隔符 token,用于从多个序列构建序列时,例如序列分类的两个序列,或问答的文本和问题。 它也用作使用特殊 token 构建的序列的最后一个 token。
  • pad_token (str, 可选, 默认为 "[PAD]") — 用于填充的 token,例如在批量处理不同长度的序列时。
  • cls_token (str, 可选, 默认为 "[CLS]") — 分类器 token,用于执行序列分类(对整个序列进行分类,而不是按 token 分类)。 当使用特殊 token 构建时,它是序列的第一个 token。
  • mask_token (str, 可选, 默认为 "[MASK]") — 用于掩码值的 token。 这是使用掩码语言建模训练此模型时使用的 token。 这是模型将尝试预测的 token。
  • empty_token (str, 可选, 默认为 "[EMPTY]") — 用于表格中空单元格值的 token。 空单元格值包括 "", “n/a”, “nan” 和 ”?“。
  • tokenize_chinese_chars (bool, 可选, 默认为 True) — 是否对中文字符进行分词。 对于日语,这可能应该被禁用(请参阅此 issue)。
  • strip_accents (bool, 可选) — 是否去除所有重音符号。 如果未指定此选项,则将由 lowercase 的值确定(与原始 BERT 中一样)。
  • cell_trim_length (int, 可选, 默认为 -1) — 如果 > 0:修剪单元格,使长度 <= 此值。 还会禁用进一步的单元格修剪,因此应与设置为 Truetruncation 一起使用。
  • max_column_id (int, 可选) — 要提取的最大列 ID。
  • max_row_id (int, 可选) — 要提取的最大行 ID。
  • strip_column_names (bool, 可选, 默认为 False) — 是否添加空字符串而不是列名。
  • update_answer_coordinates (bool, 可选, 默认为 False) — 是否从答案文本重新计算答案坐标。
  • min_question_length (int, 可选) — 每个问题的最小 token 长度(否则将被跳过)。
  • max_question_length (int, 可选) — 每个问题的最大 token 长度(否则将被跳过)。
  • clean_up_tokenization_spaces (bool, 可选, 默认为 True) — 是否清理解码后的空格,清理包括删除潜在的伪像,如多余的空格。

构建 TAPAS 分词器。 基于 WordPiece。 将表格和一个或多个相关句子展平,以供 TAPAS 模型使用。

此分词器继承自 PreTrainedTokenizer,其中包含大多数主要方法。 用户应参考此超类以获取有关这些方法的更多信息。 TapasTokenizer 创建了几个 token 类型 ID 来编码表格结构。 更准确地说,它添加了 7 个 token 类型 ID,顺序如下:segment_idscolumn_idsrow_idsprev_labelscolumn_ranksinv_column_ranksnumeric_relations

  • segment_ids:指示 token 属于问题 (0) 还是表格 (1)。 特殊 token 和填充为 0。
  • column_ids:指示 token 属于表格的哪一列(从 1 开始)。 所有问题 token、特殊 token 和填充均为 0。
  • row_ids:指示 token 属于表格的哪一行(从 1 开始)。 所有问题 token、特殊 token 和填充均为 0。 列标题的 token 也为 0。
  • prev_labels:指示 token 是否是先前问题答案的一部分 (1) 或不是 (0)。 在对话设置(例如 SQA)中很有用。
  • column_ranks:指示表格 token 相对于列的排名(如果适用)。 例如,如果您有一个“电影数量”列,其值为 87、53 和 69,则这些 token 的列排名分别为 3、1 和 2。 所有问题 token、特殊 token 和填充均为 0。
  • inv_column_ranks:指示表格 token 相对于列的逆序排名(如果适用)。 例如,如果您有一个“电影数量”列,其值为 87、53 和 69,则这些 token 的逆序列排名分别为 1、3 和 2。 所有问题 token、特殊 token 和填充均为 0。
  • numeric_relations:指示问题和表格 token 之间的数值关系。 所有问题 token、特殊 token 和填充均为 0。

TapasTokenizer 对表格和关联句子运行端到端分词:标点符号分割和 wordpiece。

__call__

< >

( table: pd.DataFrame queries: Union = None answer_coordinates: Union = None answer_text: Union = None add_special_tokens: bool = True padding: Union = False truncation: Union = False max_length: Optional = None pad_to_multiple_of: Optional = None padding_side: 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 )

参数

  • table (pd.DataFrame) — 包含表格数据的表格。 请注意,所有单元格值都必须是文本。 在 Pandas dataframe 上使用 .astype(str) 可以将其转换为字符串。
  • queries (strList[str]) — 要编码的与表格相关的问题或批量问题。 请注意,如果是批量问题,则所有问题都必须指向同一个表格。
  • answer_coordinates (List[Tuple]List[List[Tuple]], 可选) — 批次中每个表格-问题对的答案坐标。如果仅提供单个表格-问题对,则 answer_coordinates 必须是包含一个或多个元组的单个列表。每个元组必须是一个 (row_index, column_index) 对。第一个数据行(非列标题行)的索引为 0。第一列的索引为 0。如果提供一批表格-问题对,则 answer_coordinates 必须是元组列表的列表(每个列表对应于单个表格-问题对)。
  • answer_text (List[str]List[List[str]], 可选) — 批次中每个表格-问题对的答案文本。如果仅提供单个表格-问题对,则 answer_text 必须是包含一个或多个字符串的单个列表。每个字符串必须是对应答案坐标的答案文本。如果提供一批表格-问题对,则 answer_coordinates 必须是字符串列表的列表(每个列表对应于单个表格-问题对)。
  • add_special_tokens (bool, 可选, 默认为 True) — 是否使用模型相关的特殊 token 对序列进行编码。
  • padding (bool, strPaddingStrategy, 可选, 默认为 False) — 激活并控制填充。接受以下值:

    • True'longest': 填充到批次中最长的序列(如果仅提供单个序列,则不填充)。
    • 'max_length': 填充到参数 max_length 指定的最大长度,或者如果未提供该参数,则填充到模型可接受的最大输入长度。
    • False'do_not_pad' (默认): 不填充(即,可以输出具有不同长度序列的批次)。
  • truncation (bool, strTapasTruncationStrategy, 可选, 默认为 False) — 激活并控制截断。接受以下值:

    • True'drop_rows_to_fit': 截断到参数 max_length 指定的最大长度,或者如果未提供该参数,则截断到模型可接受的最大输入长度。这将逐行截断,从表格中删除行。
    • False'do_not_truncate' (默认): 不截断(即,可以输出序列长度大于模型最大允许输入大小的批次)。
  • max_length (int, 可选) — 控制截断/填充参数之一使用的最大长度。

    如果未设置或设置为 None,如果截断/填充参数之一需要最大长度,则将使用预定义的模型最大长度。如果模型没有特定的最大输入长度(如 XLNet),则将停用截断/填充到最大长度。

  • is_split_into_words (bool, 可选, 默认为 False) — 输入是否已预先分词(例如,拆分为单词)。如果设置为 True,则分词器假定输入已拆分为单词(例如,通过在空格上拆分),它将对其进行分词。这对于 NER 或 token 分类很有用。
  • pad_to_multiple_of (int, 可选) — 如果设置,则将序列填充到提供的值的倍数。这对于在计算能力 >= 7.5 (Volta) 的 NVIDIA 硬件上启用 Tensor Cores 的使用尤其有用。
  • return_tensors (strTensorType, 可选) — 如果设置,将返回 tensor 而不是 python 整数列表。可接受的值为:

    • 'tf': 返回 TensorFlow tf.constant 对象。
    • 'pt': 返回 PyTorch torch.Tensor 对象。
    • 'np': 返回 Numpy np.ndarray 对象。

用于对与表格相关的一个或多个序列进行分词并为模型准备的主要方法。

convert_logits_to_predictions

< >

( data logits logits_agg = None cell_classification_threshold = 0.5 ) tuple,包含取决于输入的各种元素

参数

  • data (dict) — 将特征映射到实际值的字典。应使用 TapasTokenizer 创建。
  • logits (形状为 (batch_size, sequence_length)torch.Tensortf.Tensor) — 包含 token 级别 logits 的 Tensor。
  • logits_agg (形状为 (batch_size, num_aggregation_labels)torch.Tensortf.Tensor, 可选) — 包含聚合 logits 的 Tensor。
  • cell_classification_threshold (float, 可选, 默认为 0.5) — 用于单元格选择的阈值。概率大于此阈值的所有表格单元格都将被选中。

返回值

tuple,包含取决于输入的各种元素

  • predicted_answer_coordinates (List[List[[tuple]],长度为 batch_size): 预测的答案坐标,形式为元组列表的列表。列表中的每个元素都包含批次中单个示例的预测答案坐标,形式为元组列表。每个元组是一个单元格,即(行索引,列索引)。
  • predicted_aggregation_indices (List[int],长度为 batch_size可选,当提供 logits_aggregation 时返回): 聚合头的预测聚合运算符索引。

TapasForQuestionAnswering 的 logits 转换为实际预测的答案坐标和可选的聚合索引。

此函数基于的原始实现可以在 此处 找到。

save_vocabulary

< >

( save_directory: str filename_prefix: Optional = None )

Pytorch
隐藏 Pytorch 内容

TapasModel

class transformers.TapasModel

< >

( config add_pooling_layer = True )

参数

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

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

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

BertModel 相比,此类只有很小的更改,其中考虑了附加的 token 类型 ID。

该模型可以充当编码器(仅具有自注意力),也可以充当解码器,在这种情况下,在自注意力层之间添加交叉注意力层,遵循 Attention is all you need 中描述的架构,作者为 Ashish Vaswani、Noam Shazeer、Niki Parmar、Jakob Uszkoreit、Llion Jones、Aidan N. Gomez、Lukasz Kaiser 和 Illia Polosukhin。

forward

< >

( input_ids: Optional = None attention_mask: Optional = None token_type_ids: Optional = None position_ids: Optional = None head_mask: Optional = None inputs_embeds: Optional = None encoder_hidden_states: Optional = None encoder_attention_mask: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None ) transformers.modeling_outputs.BaseModelOutputWithPoolingtuple(torch.FloatTensor)

参数

  • input_ids (torch.LongTensor,形状为 (batch_size, sequence_length)) — 词汇表中输入序列 tokens 的索引。索引可以使用 AutoTokenizer 获得。 参见 PreTrainedTokenizer.encode()PreTrainedTokenizer.call() 以了解详细信息。

    什么是输入 IDs?

  • attention_mask (torch.FloatTensor,形状为 (batch_size, sequence_length)可选) — 用于避免在 padding token 索引上执行 attention 的掩码。掩码值在 [0, 1] 中选择:

    • 1 表示 tokens 未被掩码
    • 0 表示 tokens 被掩码

    什么是 attention masks?

  • token_type_ids (torch.LongTensor,形状为 (batch_size, sequence_length, 7)可选) — 编码表格结构的 token 索引。索引可以使用 AutoTokenizer 获得。 有关更多信息,请参阅此类。

    什么是 token type IDs?

  • position_ids (torch.LongTensor,形状为 (batch_size, sequence_length)可选) — 每个输入序列 token 在 position embeddings 中的位置索引。如果 TapasConfigreset_position_index_per_cell 设置为 True,则将使用相对位置 embeddings。 在 [0, config.max_position_embeddings - 1] 范围内选择。

    什么是 position IDs?

  • head_mask (torch.FloatTensor,形状为 (num_heads,)(num_layers, num_heads)可选) — 用于 nullify self-attention 模块中选定 head 的掩码。掩码值在 [0, 1] 中选择: - 1 表示 head 未被掩码, - 0 表示 head 被掩码
  • inputs_embeds (torch.FloatTensor,形状为 (batch_size, sequence_length, hidden_size)可选) — (可选)您可以选择直接传递嵌入表示,而不是传递 input_ids。 如果您想比模型的内部 embedding lookup 矩阵更精细地控制如何将 input_ids 索引转换为关联的向量,这将非常有用。
  • output_attentions (bool可选) — 是否返回所有 attention 层的 attentions tensors。 有关更多详细信息,请参见返回的 tensors 下的 attentions
  • output_hidden_states (bool可选) — 是否返回所有层的 hidden states。 有关更多详细信息,请参见返回的 tensors 下的 hidden_states
  • return_dict (bool可选) — 是否返回 ModelOutput 而不是纯粹的 tuple。

返回值

transformers.modeling_outputs.BaseModelOutputWithPoolingtuple(torch.FloatTensor)

一个 transformers.modeling_outputs.BaseModelOutputWithPooling 或一个 torch.FloatTensor 的 tuple(如果传递了 return_dict=False 或者当 config.return_dict=False 时),其中包含各种元素,具体取决于配置 (TapasConfig) 和输入。

  • last_hidden_state (torch.FloatTensor,形状为 (batch_size, sequence_length, hidden_size)) — 模型最后一层的输出端的 hidden-states 序列。

  • pooler_output (torch.FloatTensor,形状为 (batch_size, hidden_size)) — 序列的第一个 token(classification token)的最后一层 hidden-state,经过用于辅助预训练任务的层进一步处理之后。 例如,对于 BERT 系列模型,这将返回通过线性层和 tanh 激活函数处理后的 classification token。 线性层权重通过预训练期间的下一句预测(分类)目标进行训练。

  • hidden_states (tuple(torch.FloatTensor)可选,当传递 output_hidden_states=True 或当 config.output_hidden_states=True 时返回) — torch.FloatTensor 的 tuple (对于 embeddings 的输出,如果模型具有 embedding 层,则为一个;对于每层的输出,则为一个),形状为 (batch_size, sequence_length, hidden_size)

    模型在每层输出端的 Hidden-states,加上可选的初始 embedding 输出。

  • attentions (tuple(torch.FloatTensor)可选,当传递 output_attentions=True 或当 config.output_attentions=True 时返回) — torch.FloatTensor 的 tuple(每层一个),形状为 (batch_size, num_heads, sequence_length, sequence_length)

    attention softmax 之后的 Attention 权重,用于计算 self-attention heads 中的加权平均值。

TapasModel forward 方法,覆盖了 __call__ 特殊方法。

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

示例

>>> from transformers import AutoTokenizer, TapasModel
>>> import pandas as pd

>>> tokenizer = AutoTokenizer.from_pretrained("google/tapas-base")
>>> model = TapasModel.from_pretrained("google/tapas-base")

>>> data = {
...     "Actors": ["Brad Pitt", "Leonardo Di Caprio", "George Clooney"],
...     "Age": ["56", "45", "59"],
...     "Number of movies": ["87", "53", "69"],
... }
>>> table = pd.DataFrame.from_dict(data)
>>> queries = ["How many movies has George Clooney played in?", "How old is Brad Pitt?"]

>>> inputs = tokenizer(table=table, queries=queries, padding="max_length", return_tensors="pt")
>>> outputs = model(**inputs)

>>> last_hidden_states = outputs.last_hidden_state

TapasForMaskedLM

class transformers.TapasForMaskedLM

< >

( config )

参数

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

具有位于顶部的 language modeling head 的 Tapas 模型。 此模型继承自 PreTrainedModel。 查看超类文档以了解库为所有模型实现的通用方法(例如,下载或保存、调整输入 embeddings 大小、pruning heads 等)。

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

forward

< >

( input_ids: Optional = None attention_mask: Optional = None token_type_ids: Optional = None position_ids: Optional = None head_mask: Optional = None inputs_embeds: Optional = None encoder_hidden_states: Optional = None encoder_attention_mask: Optional = None labels: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None **kwargs ) transformers.modeling_outputs.MaskedLMOutputtuple(torch.FloatTensor)

参数

  • input_ids (torch.LongTensor,形状为 (batch_size, sequence_length)) — 词汇表中输入序列 tokens 的索引。索引可以使用 AutoTokenizer 获得。 参见 PreTrainedTokenizer.encode()PreTrainedTokenizer.call() 以了解详细信息。

    什么是输入 IDs?

  • attention_mask (torch.FloatTensor,形状为 (batch_size, sequence_length)可选) — 用于避免在 padding token 索引上执行 attention 的掩码。掩码值在 [0, 1] 中选择:

    • 1 表示 tokens 未被掩码
    • 0 表示 tokens 被掩码

    什么是 attention masks?

  • token_type_ids (torch.LongTensor,形状为 (batch_size, sequence_length, 7)可选) — 编码表格结构的 token 索引。索引可以使用 AutoTokenizer 获得。 有关更多信息,请参阅此类。

    什么是 token type IDs?

  • position_ids (torch.LongTensor,形状为 (batch_size, sequence_length)可选) — 每个输入序列 token 在 position embeddings 中的位置索引。如果 TapasConfigreset_position_index_per_cell 设置为 True,则将使用相对位置 embeddings。 在 [0, config.max_position_embeddings - 1] 范围内选择。

    什么是 position IDs?

  • head_mask (torch.FloatTensor,形状为 (num_heads,)(num_layers, num_heads)可选) — 用于 nullify self-attention 模块中选定 head 的掩码。掩码值在 [0, 1] 中选择: - 1 表示 head 未被掩码, - 0 表示 head 被掩码
  • inputs_embeds (torch.FloatTensor,形状为 (batch_size, sequence_length, hidden_size)可选) — (可选)您可以选择直接传递嵌入表示,而不是传递 input_ids。 如果您想比模型的内部 embedding lookup 矩阵更精细地控制如何将 input_ids 索引转换为关联的向量,这将非常有用。
  • output_attentions (bool可选) — 是否返回所有 attention 层的 attentions tensors。 有关更多详细信息,请参见返回的 tensors 下的 attentions
  • output_hidden_states (bool可选) — 是否返回所有层的 hidden states。 有关更多详细信息,请参见返回的 tensors 下的 hidden_states
  • return_dict (bool可选) — 是否返回 ModelOutput 而不是纯粹的 tuple。
  • labels (torch.LongTensor of shape (batch_size, sequence_length), optional) — 用于计算掩码语言建模损失的标签。索引应在 [-100, 0, ..., config.vocab_size] 中(参见 input_ids 文档字符串)。索引设置为 -100 的标记将被忽略(掩码),损失仅针对标签在 [0, ..., config.vocab_size] 中的标记计算

返回值

transformers.modeling_outputs.MaskedLMOutputtuple(torch.FloatTensor)

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

  • loss (torch.FloatTensor of shape (1,), optional, 当提供 labels 时返回) — 掩码语言建模 (MLM) 损失。

  • logits (torch.FloatTensor of shape (batch_size, sequence_length, config.vocab_size)) — 语言建模头的预测分数(SoftMax 之前每个词汇表标记的分数)。

  • hidden_states (tuple(torch.FloatTensor)可选,当传递 output_hidden_states=True 或当 config.output_hidden_states=True 时返回) — torch.FloatTensor 的 tuple (对于 embeddings 的输出,如果模型具有 embedding 层,则为一个;对于每层的输出,则为一个),形状为 (batch_size, sequence_length, hidden_size)

    模型在每层输出端的 Hidden-states,加上可选的初始 embedding 输出。

  • attentions (tuple(torch.FloatTensor)可选,当传递 output_attentions=True 或当 config.output_attentions=True 时返回) — torch.FloatTensor 的 tuple(每层一个),形状为 (batch_size, num_heads, sequence_length, sequence_length)

    attention softmax 之后的 Attention 权重,用于计算 self-attention heads 中的加权平均值。

TapasForMaskedLM forward 方法,覆盖了 __call__ 特殊方法。

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

示例

>>> from transformers import AutoTokenizer, TapasForMaskedLM
>>> import pandas as pd

>>> tokenizer = AutoTokenizer.from_pretrained("google/tapas-base")
>>> model = TapasForMaskedLM.from_pretrained("google/tapas-base")

>>> data = {
...     "Actors": ["Brad Pitt", "Leonardo Di Caprio", "George Clooney"],
...     "Age": ["56", "45", "59"],
...     "Number of movies": ["87", "53", "69"],
... }
>>> table = pd.DataFrame.from_dict(data)

>>> inputs = tokenizer(
...     table=table, queries="How many [MASK] has George [MASK] played in?", return_tensors="pt"
... )
>>> labels = tokenizer(
...     table=table, queries="How many movies has George Clooney played in?", return_tensors="pt"
... )["input_ids"]

>>> outputs = model(**inputs, labels=labels)
>>> logits = outputs.logits

TapasForSequenceClassification

class transformers.TapasForSequenceClassification

< >

( config )

参数

  • config (TapasConfig) — 带有模型所有参数的模型配置类。使用配置文件初始化不会加载与模型关联的权重,仅加载配置。查看 from_pretrained() 方法来加载模型权重。

Tapas 模型,顶部带有一个序列分类头(池化输出顶部的线性层),例如用于表格蕴含任务,如 TabFact (Chen et al., 2020)。

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

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

forward

< >

( input_ids: 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.SequenceClassifierOutputtuple(torch.FloatTensor)

参数

  • input_ids (torch.LongTensor of shape (batch_size, sequence_length)) — 词汇表中输入序列标记的索引。索引可以使用 AutoTokenizer 获得。有关详细信息,请参阅 PreTrainedTokenizer.encode()PreTrainedTokenizer.call()

    什么是输入 IDs?

  • attention_mask (torch.FloatTensor of shape (batch_size, sequence_length), optional) — 避免在填充标记索引上执行注意力的掩码。在 [0, 1] 中选择的掩码值:

    • 1 表示未被掩码的标记,
    • 0 表示被掩码的标记。

    什么是注意力掩码?

  • token_type_ids (torch.LongTensor of shape (batch_size, sequence_length, 7), optional) — 编码表格结构的标记索引。索引可以使用 AutoTokenizer 获得。有关更多信息,请参阅此类。

    什么是标记类型 IDs?

  • position_ids (torch.LongTensor of shape (batch_size, sequence_length), optional) — 每个输入序列标记在位置嵌入中的位置索引。如果 TapasConfigreset_position_index_per_cell 设置为 True,则将使用相对位置嵌入。在范围 [0, config.max_position_embeddings - 1] 中选择。

    什么是位置 IDs?

  • head_mask (torch.FloatTensor of shape (num_heads,)(num_layers, num_heads), optional) — 用于使自注意力模块的选定头无效的掩码。在 [0, 1] 中选择的掩码值: - 1 表示头未被掩码, - 0 表示头被掩码
  • inputs_embeds (torch.FloatTensor of shape (batch_size, sequence_length, hidden_size), optional) — 可选地,您可以选择直接传递嵌入表示,而不是传递 input_ids。如果您想要比模型的内部嵌入查找矩阵更精细地控制如何将 input_ids 索引转换为关联向量,这将非常有用。
  • output_attentions (bool, optional) — 是否返回所有注意力层的注意力张量。 有关更多详细信息,请参见返回张量下的 attentions
  • output_hidden_states (bool, optional) — 是否返回所有层的隐藏状态。 有关更多详细信息,请参见返回张量下的 hidden_states
  • return_dict (bool, optional) — 是否返回 ModelOutput 而不是普通元组。
  • labels (torch.LongTensor of shape (batch_size,), optional) — 用于计算序列分类/回归损失的标签。索引应在 [0, ..., config.num_labels - 1] 中。如果 config.num_labels == 1,则计算回归损失(均方误差损失),如果 config.num_labels > 1,则计算分类损失(交叉熵损失)。注意:这在原始实现中称为 “classification_class_index”。

返回值

transformers.modeling_outputs.SequenceClassifierOutputtuple(torch.FloatTensor)

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

  • loss (torch.FloatTensor of shape (1,), optional, 当提供 labels 时返回) — 分类(或回归,如果 config.num_labels==1)损失。

  • logits (torch.FloatTensor of shape (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 的 tuple (对于 embeddings 的输出,如果模型具有 embedding 层,则为一个;对于每层的输出,则为一个),形状为 (batch_size, sequence_length, hidden_size)

    模型在每层输出端的 Hidden-states,加上可选的初始 embedding 输出。

  • attentions (tuple(torch.FloatTensor)可选,当传递 output_attentions=True 或当 config.output_attentions=True 时返回) — torch.FloatTensor 的 tuple(每层一个),形状为 (batch_size, num_heads, sequence_length, sequence_length)

    attention softmax 之后的 Attention 权重,用于计算 self-attention heads 中的加权平均值。

TapasForSequenceClassification forward 方法,覆盖了 __call__ 特殊方法。

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

示例

>>> from transformers import AutoTokenizer, TapasForSequenceClassification
>>> import torch
>>> import pandas as pd

>>> tokenizer = AutoTokenizer.from_pretrained("google/tapas-base-finetuned-tabfact")
>>> model = TapasForSequenceClassification.from_pretrained("google/tapas-base-finetuned-tabfact")

>>> data = {
...     "Actors": ["Brad Pitt", "Leonardo Di Caprio", "George Clooney"],
...     "Age": ["56", "45", "59"],
...     "Number of movies": ["87", "53", "69"],
... }
>>> table = pd.DataFrame.from_dict(data)
>>> queries = [
...     "There is only one actor who is 45 years old",
...     "There are 3 actors which played in more than 60 movies",
... ]

>>> inputs = tokenizer(table=table, queries=queries, padding="max_length", return_tensors="pt")
>>> labels = torch.tensor([1, 0])  # 1 means entailed, 0 means refuted

>>> outputs = model(**inputs, labels=labels)
>>> loss = outputs.loss
>>> logits = outputs.logits

TapasForQuestionAnswering

class transformers.TapasForQuestionAnswering

< >

( config: TapasConfig )

参数

  • config (TapasConfig) — 带有模型所有参数的模型配置类。使用配置文件初始化不会加载与模型关联的权重,仅加载配置。查看 from_pretrained() 方法来加载模型权重。

Tapas 模型,顶部带有一个单元格选择头和可选的聚合头,用于表格上的问答任务(隐藏状态输出顶部的线性层,用于计算 logits 和可选的 logits_aggregation),例如用于 SQA、WTQ 或 WikiSQL-supervised 任务。

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

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

forward

< >

( input_ids: Optional = None attention_mask: Optional = None token_type_ids: Optional = None position_ids: Optional = None head_mask: Optional = None inputs_embeds: Optional = None table_mask: Optional = None labels: Optional = None aggregation_labels: Optional = None float_answer: Optional = None numeric_values: Optional = None numeric_values_scale: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None ) transformers.models.tapas.modeling_tapas.TableQuestionAnsweringOutputtuple(torch.FloatTensor)

参数

  • input_ids (torch.LongTensor,形状为 (batch_size, sequence_length)) — 词汇表中输入序列 tokens 的索引。索引可以使用 AutoTokenizer 获得。 详见 PreTrainedTokenizer.encode()PreTrainedTokenizer.call() 以了解详情。

    什么是输入 IDs?

  • attention_mask (torch.FloatTensor,形状为 (batch_size, sequence_length), *可选*) — 避免对 padding token 索引执行 attention 的 Mask。 Mask 值在 [0, 1] 中选择:

    • 1 表示 tokens **未被 masked**,
    • 0 表示 tokens **被 masked**。

    什么是 attention masks?

  • token_type_ids (torch.LongTensor,形状为 (batch_size, sequence_length, 7), *可选*) — 编码表格结构的 Token 索引。 索引可以使用 AutoTokenizer 获得。 有关更多信息,请参阅此类。

    什么是 token type IDs?

  • position_ids (torch.LongTensor,形状为 (batch_size, sequence_length), *可选*) — 每个输入序列 tokens 在 position embeddings 中的位置索引。 如果 TapasConfigreset_position_index_per_cell 设置为 True,将使用相对 position embeddings。 在范围 [0, config.max_position_embeddings - 1] 中选择。

    什么是 position IDs?

  • head_mask (torch.FloatTensor,形状为 (num_heads,)(num_layers, num_heads), *可选*) — 用于 nullify self-attention 模块中选定 heads 的 Mask。 Mask 值在 [0, 1] 中选择: - 1 表示 head **未被 masked**, - 0 表示 head **被 masked**。
  • inputs_embeds (torch.FloatTensor,形状为 (batch_size, sequence_length, hidden_size), *可选*) — 可选地,您可以选择直接传递嵌入表示,而不是传递 input_ids。 如果您希望比模型的内部嵌入查找矩阵更精细地控制如何将 input_ids 索引转换为关联向量,这将非常有用。
  • output_attentions (bool, *可选*) — 是否返回所有 attention 层的 attentions tensors。 有关更多详细信息,请参阅返回 tensors 下的 attentions
  • output_hidden_states (bool, *可选*) — 是否返回所有层的 hidden states。 有关更多详细信息,请参阅返回 tensors 下的 hidden_states
  • return_dict (bool, *可选*) — 是否返回 ModelOutput 而不是 plain tuple。
  • table_mask (torch.LongTensor,形状为 (batch_size, seq_length), *可选*) — 表格的 Mask。 指示哪些 tokens 属于表格 (1)。 问题 tokens、表格标题和 padding 为 0。
  • labels (torch.LongTensor,形状为 (batch_size, seq_length), *可选*) — 用于计算分层单元格选择损失的每个 token 的标签。 这编码了答案在表格中出现的位置。 可以使用 AutoTokenizer 获得。

    • 1 表示 tokens **是答案的一部分**,
    • 0 表示 tokens **不是答案的一部分**。
  • aggregation_labels (torch.LongTensor,形状为 (batch_size, ), *可选*) — 用于计算 aggregation 损失的批次中每个示例的聚合函数索引。 索引应在 [0, ..., config.num_aggregation_labels - 1] 中。 仅在对聚合进行强监督(WikiSQL-supervised)的情况下才需要。
  • float_answer (torch.FloatTensor,形状为 (batch_size, ), *可选*) — 批次中每个示例的浮点数答案。 对于单元格选择问题,设置为 *float('nan')*。 仅在弱监督 (WTQ) 的情况下才需要计算聚合 mask 和回归损失。
  • numeric_values (torch.FloatTensor,形状为 (batch_size, seq_length), *可选*) — 每个 token 的数值,对于非数值的 tokens 为 NaN。 可以使用 AutoTokenizer 获得。 仅在弱监督聚合 (WTQ) 的情况下才需要计算回归损失。
  • numeric_values_scale (torch.FloatTensor,形状为 (batch_size, seq_length), *可选*) — 每个 token 的数值的比例。 可以使用 AutoTokenizer 获得。 仅在弱监督聚合 (WTQ) 的情况下才需要计算回归损失。

返回值

transformers.models.tapas.modeling_tapas.TableQuestionAnsweringOutputtuple(torch.FloatTensor)

一个 transformers.models.tapas.modeling_tapas.TableQuestionAnsweringOutput 或一个 torch.FloatTensor 的 tuple (如果传递了 return_dict=False 或当 config.return_dict=False 时),包含各种元素,具体取决于配置 (TapasConfig) 和输入。

  • loss (torch.FloatTensor,形状为 (1,),*可选*,当提供 labels(以及可能的 answeraggregation_labelsnumeric_valuesnumeric_values_scale)时返回) — 总损失,作为分层单元格选择对数似然损失以及(可选的)半监督回归损失和(可选的)聚合监督损失的总和。
  • logits (torch.FloatTensor,形状为 (batch_size, sequence_length)) — 单元格选择 head 的预测分数,针对每个 token。
  • logits_aggregation (torch.FloatTensor,*可选*,形状为 (batch_size, num_aggregation_labels)) — 聚合 head 的预测分数,针对每个聚合运算符。
  • hidden_states (tuple(torch.FloatTensor),*可选*,当传递 output_hidden_states=True 或当 config.output_hidden_states=True 时返回) — torch.FloatTensor 的元组(embeddings 的输出一个,加上每层的输出一个),形状为 (batch_size, sequence_length, hidden_size)。 模型在每一层输出端的 hidden-states 加上初始 embedding 输出。
  • 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 heads 中的加权平均值。

TapasForQuestionAnswering 的 forward 方法,覆盖了 __call__ 特殊方法。

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

示例

>>> from transformers import AutoTokenizer, TapasForQuestionAnswering
>>> import pandas as pd

>>> tokenizer = AutoTokenizer.from_pretrained("google/tapas-base-finetuned-wtq")
>>> model = TapasForQuestionAnswering.from_pretrained("google/tapas-base-finetuned-wtq")

>>> data = {
...     "Actors": ["Brad Pitt", "Leonardo Di Caprio", "George Clooney"],
...     "Age": ["56", "45", "59"],
...     "Number of movies": ["87", "53", "69"],
... }
>>> table = pd.DataFrame.from_dict(data)
>>> queries = ["How many movies has George Clooney played in?", "How old is Brad Pitt?"]

>>> inputs = tokenizer(table=table, queries=queries, padding="max_length", return_tensors="pt")
>>> outputs = model(**inputs)

>>> logits = outputs.logits
>>> logits_aggregation = outputs.logits_aggregation
TensorFlow
隐藏 TensorFlow 内容

TFTapasModel

class transformers.TFTapasModel

< >

( config: TapasConfig *inputs **kwargs )

参数

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

裸 Tapas Model transformer,输出原始 hidden-states,顶部没有任何特定的 head。

此模型继承自 TFPreTrainedModel。 查看超类文档以获取库为所有模型实现的通用方法(例如下载或保存、调整输入 embeddings 大小、剪枝 heads 等)。

此模型也是 keras.Model 子类。 将其用作常规 TF 2.0 Keras 模型,并参阅 TF 2.0 文档以了解与常规用法和行为相关的所有事项。

transformers 中的 TensorFlow 模型和层接受两种输入格式

  • 将所有输入作为关键字参数(如 PyTorch 模型),或者
  • 将所有输入作为列表、元组或字典放在第一个位置参数中。

支持第二种格式的原因是 Keras 方法在将输入传递给模型和层时首选此格式。 由于这种支持,当使用诸如 model.fit() 之类的方法时,事情应该对您“正常工作” - 只需以 model.fit() 支持的任何格式传递您的输入和标签即可! 但是,如果您想在 Keras 方法(如 fit()predict())之外使用第二种格式,例如在使用 Keras Functional API 创建您自己的层或模型时,可以使用三种可能性来收集第一个位置参数中的所有输入 Tensors

  • 仅使用 input_ids 且不使用其他任何内容的单个 Tensor:model(input_ids)
  • 具有可变长度的列表,其中包含一个或多个输入 Tensors,顺序与文档字符串中给出的顺序相同:model([input_ids, attention_mask])model([input_ids, attention_mask, token_type_ids])
  • 字典,其中一个或多个输入 Tensors 与文档字符串中给出的输入名称相关联:model({"input_ids": input_ids, "token_type_ids": token_type_ids})

请注意,当使用 子类化 创建模型和层时,您无需担心任何这些,因为您可以像对待任何其他 Python 函数一样传递输入!

call

< >

( input_ids: TFModelInputType | None = None attention_mask: np.ndarray | tf.Tensor | None = None token_type_ids: np.ndarray | tf.Tensor | None = None position_ids: np.ndarray | tf.Tensor | None = None head_mask: np.ndarray | tf.Tensor | None = None inputs_embeds: np.ndarray | tf.Tensor | None = None output_attentions: Optional[bool] = None output_hidden_states: Optional[bool] = None return_dict: Optional[bool] = None training: Optional[bool] = False ) transformers.modeling_tf_outputs.TFBaseModelOutputWithPoolingtuple(tf.Tensor)

参数

  • input_ids (np.ndarray, tf.Tensor, List[tf.Tensor] `Dict[str, tf.Tensor]Dict[str, np.ndarray],且每个示例必须具有形状 (batch_size, sequence_length)) — 词汇表中输入序列 tokens 的索引。

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

    什么是输入 IDs?

  • attention_mask (np.ndarraytf.Tensor,形状为 (batch_size, sequence_length),*可选*) — 用于避免在 padding token 索引上执行 attention 的 Mask。 Mask 值在 `[0, 1]` 中选择:

    • 1 表示 tokens 未被 mask
    • 0 表示 tokens 已被 mask

    什么是 attention masks?

  • token_type_ids (np.ndarraytf.Tensor,形状为 (batch_size, sequence_length, 7),*可选*) — 编码表格结构的 Token 索引。 索引可以使用 AutoTokenizer 获得。 有关更多信息,请参阅此类。

    什么是 token type IDs?

  • position_ids (np.ndarraytf.Tensor,形状为 (batch_size, sequence_length),*可选*) — 每个输入序列 token 在位置 embeddings 中的位置索引。 如果 TapasConfigreset_position_index_per_cell 设置为 True,则将使用相对位置 embeddings。 在范围 `[0, config.max_position_embeddings - 1]` 中选择。

    什么是 position IDs?

  • head_mask (np.ndarraytf.Tensor,形状为 (num_heads,)(num_layers, num_heads),*可选*) — 用于 nullify self-attention 模块中选定 heads 的 Mask。 Mask 值在 `[0, 1]` 中选择:

    • 1 表示 head 未被 mask
    • 0 表示 head 已被 mask
  • inputs_embeds (np.ndarraytf.Tensor,形状为 (batch_size, sequence_length, hidden_size),*可选*) — 可选地,您可以选择直接传递嵌入表示,而不是传递 input_ids。 如果您希望比模型的内部嵌入查找矩阵更精细地控制如何将 input_ids 索引转换为关联的向量,这将非常有用。
  • output_attentions (bool, *可选*) — 是否返回所有 attention 层的 attentions tensors。 有关更多详细信息,请参阅返回 tensors 下的 attentions。 此参数只能在 eager 模式下使用,在 graph 模式下,将使用 config 中的值。
  • output_hidden_states (bool, *可选*) — 是否返回所有层的 hidden states。 有关更多详细信息,请参阅返回 tensors 下的 hidden_states。 此参数只能在 eager 模式下使用,在 graph 模式下,将使用 config 中的值。
  • return_dict (bool, *可选*) — 是否返回 ModelOutput 而不是 plain tuple。 此参数可以在 eager 模式下使用,在 graph 模式下,该值将始终设置为 True。
  • training (bool, *可选*, 默认为 `False`) — 是否在 training 模式下使用模型(某些模块(如 dropout 模块)在 training 和 evaluation 之间具有不同的行为)。

返回值

transformers.modeling_tf_outputs.TFBaseModelOutputWithPoolingtuple(tf.Tensor)

一个 transformers.modeling_tf_outputs.TFBaseModelOutputWithPooling 或一个 tf.Tensor 的 tuple(如果传递了 return_dict=False 或当 config.return_dict=False 时),其中包含各种元素,具体取决于配置 (TapasConfig) 和输入。

  • last_hidden_state (tf.Tensor,形状为 (batch_size, sequence_length, hidden_size)) — 模型最后一层的输出端的 hidden-states 序列。

  • pooler_output (tf.Tensor,形状为 (batch_size, hidden_size)) — 序列的第一个 token(分类 token)的最后一层 hidden-state,通过 Linear 层和 Tanh 激活函数进一步处理。 Linear 层的权重在预训练期间从下一句预测(分类)目标中训练而来。

    此输出通常*不是*输入的语义内容的良好摘要,对于整个输入序列,您通常最好使用 averaging 或 pooling hidden-states 序列。

  • hidden_states (tuple(tf.Tensor), *可选*, 当传递 output_hidden_states=True 或当 config.output_hidden_states=True 时返回) — tf.Tensor 的 Tuple(一个用于 embeddings 的输出 + 一个用于每一层的输出),形状为 (batch_size, sequence_length, hidden_size)

    模型在每一层输出端的 Hidden-states 加上初始 embedding 输出。

  • attentions (tuple(tf.Tensor), *可选*, 当传递 output_attentions=True 或当 config.output_attentions=True 时返回) — tf.Tensor 的 Tuple(每一层一个),形状为 (batch_size, num_heads, sequence_length, sequence_length)

    attention softmax 之后的 Attention 权重,用于计算 self-attention heads 中的加权平均值。

The TFTapasModel forward 方法,覆盖了 __call__ 特殊方法。

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

示例

>>> from transformers import AutoTokenizer, TapasModel
>>> import pandas as pd

>>> tokenizer = AutoTokenizer.from_pretrained("google/tapas-base")
>>> model = TapasModel.from_pretrained("google/tapas-base")

>>> data = {
...     "Actors": ["Brad Pitt", "Leonardo Di Caprio", "George Clooney"],
...     "Age": ["56", "45", "59"],
...     "Number of movies": ["87", "53", "69"],
... }
>>> table = pd.DataFrame.from_dict(data)
>>> queries = ["How many movies has George Clooney played in?", "How old is Brad Pitt?"]

>>> inputs = tokenizer(table=table, queries=queries, padding="max_length", return_tensors="tf")
>>> outputs = model(**inputs)

>>> last_hidden_states = outputs.last_hidden_state

TFTapasForMaskedLM

class transformers.TFTapasForMaskedLM

< >

( config: TapasConfig *inputs **kwargs )

参数

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

在顶部带有 language modeling head 的 Tapas 模型。

此模型继承自 TFPreTrainedModel。 查看超类文档以获取库为所有模型实现的通用方法(例如下载或保存、调整输入 embeddings 大小、剪枝 heads 等)。

此模型也是 keras.Model 子类。 将其用作常规 TF 2.0 Keras 模型,并参阅 TF 2.0 文档以了解与常规用法和行为相关的所有事项。

transformers 中的 TensorFlow 模型和层接受两种输入格式

  • 将所有输入作为关键字参数(如 PyTorch 模型),或者
  • 将所有输入作为列表、元组或字典放在第一个位置参数中。

支持第二种格式的原因是 Keras 方法在将输入传递给模型和层时首选此格式。 由于这种支持,当使用诸如 model.fit() 之类的方法时,事情应该对您“正常工作” - 只需以 model.fit() 支持的任何格式传递您的输入和标签即可! 但是,如果您想在 Keras 方法(如 fit()predict())之外使用第二种格式,例如在使用 Keras Functional API 创建您自己的层或模型时,可以使用三种可能性来收集第一个位置参数中的所有输入 Tensors

  • 仅使用 input_ids 且不使用其他任何内容的单个 Tensor:model(input_ids)
  • 具有可变长度的列表,其中包含一个或多个输入 Tensors,顺序与文档字符串中给出的顺序相同:model([input_ids, attention_mask])model([input_ids, attention_mask, token_type_ids])
  • 字典,其中一个或多个输入 Tensors 与文档字符串中给出的输入名称相关联:model({"input_ids": input_ids, "token_type_ids": token_type_ids})

请注意,当使用 子类化 创建模型和层时,您无需担心任何这些,因为您可以像对待任何其他 Python 函数一样传递输入!

call

< >

( input_ids: TFModelInputType | None = None attention_mask: np.ndarray | tf.Tensor | None = None token_type_ids: np.ndarray | tf.Tensor | None = None position_ids: np.ndarray | tf.Tensor | None = None head_mask: np.ndarray | tf.Tensor | None = None inputs_embeds: np.ndarray | tf.Tensor | None = None output_attentions: Optional[bool] = None output_hidden_states: Optional[bool] = None return_dict: Optional[bool] = None labels: np.ndarray | tf.Tensor | None = None training: Optional[bool] = False ) transformers.modeling_tf_outputs.TFMaskedLMOutputtuple(tf.Tensor)

参数

  • input_ids (np.ndarray, tf.Tensor, List[tf.Tensor] `Dict[str, tf.Tensor]Dict[str, np.ndarray],且每个示例必须具有形状 (batch_size, sequence_length)) — 词汇表中输入序列 tokens 的索引。

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

    什么是输入 IDs?

  • attention_mask (np.ndarraytf.Tensor,形状为 (batch_size, sequence_length),*可选*) — 用于避免在 padding token 索引上执行 attention 的 Mask。 Mask 值在 `[0, 1]` 中选择:

    • 1 表示 tokens 未被 mask
    • 0 表示 tokens 已被 mask

    什么是 attention masks?

  • token_type_ids (np.ndarraytf.Tensor,形状为 (batch_size, sequence_length, 7),*可选*) — 编码表格结构的 Token 索引。 索引可以使用 AutoTokenizer 获得。 有关更多信息,请参阅此类。

    什么是 token type IDs?

  • position_ids (np.ndarraytf.Tensor,形状为 (batch_size, sequence_length),*可选*) — 每个输入序列 token 在位置 embeddings 中的位置索引。 如果 TapasConfigreset_position_index_per_cell 设置为 True,则将使用相对位置 embeddings。 在范围 `[0, config.max_position_embeddings - 1]` 中选择。

    什么是 position IDs?

  • head_mask (np.ndarraytf.Tensor,形状为 (num_heads,)(num_layers, num_heads),*可选*) — 用于 nullify self-attention 模块中选定 heads 的 Mask。 Mask 值在 `[0, 1]` 中选择:

    • 1 表示 head 未被 mask
    • 0 表示 head 已被 mask
  • inputs_embeds (np.ndarraytf.Tensor,形状为 (batch_size, sequence_length, hidden_size)可选) — (可选)您可以选择直接传递嵌入表示,而不是传递 input_ids。如果您希望比模型的内部嵌入查找矩阵更精确地控制如何将 input_ids 索引转换为关联向量,这将非常有用。
  • output_attentions (bool可选) — 是否返回所有注意力层的注意力张量。 有关更多详细信息,请参阅返回张量下的 attentions。 此参数只能在即时模式下使用,在图模式下将使用配置中的值。
  • output_hidden_states (bool可选) — 是否返回所有层的隐藏状态。 有关更多详细信息,请参阅返回张量下的 hidden_states。 此参数只能在即时模式下使用,在图模式下将使用配置中的值。
  • return_dict (bool可选) — 是否返回 ModelOutput 而不是普通元组。 此参数可以在即时模式下使用,在图模式下,该值将始终设置为 True。
  • training (bool可选,默认为 `False`) — 是否在训练模式下使用该模型(一些模块,如 dropout 模块,在训练和评估之间具有不同的行为)。
  • labels (tf.Tensornp.ndarray,形状为 (batch_size, sequence_length)可选) — 用于计算掩码语言建模损失的标签。索引应在 [-100, 0, ..., config.vocab_size] 中(请参阅 input_ids 文档字符串)。索引设置为 -100 的标记将被忽略(掩码),损失仅针对标签在 [0, ..., config.vocab_size] 中的标记计算。

返回值

transformers.modeling_tf_outputs.TFMaskedLMOutputtuple(tf.Tensor)

一个 transformers.modeling_tf_outputs.TFMaskedLMOutputtf.Tensor 元组(如果传递 return_dict=False 或当 config.return_dict=False 时),其中包含各种元素,具体取决于配置 (TapasConfig) 和输入。

  • loss (tf.Tensor,形状为 (n,)可选,当提供 labels 时返回) — 掩码语言建模 (MLM) 损失,其中 n 是非掩码标签的数量。

  • logits (tf.Tensor,形状为 (batch_size, sequence_length, config.vocab_size)) — 语言建模头的预测分数(SoftMax 之前每个词汇表标记的分数)。

  • hidden_states (tuple(tf.Tensor), *可选*, 当传递 output_hidden_states=True 或当 config.output_hidden_states=True 时返回) — tf.Tensor 的 Tuple(一个用于 embeddings 的输出 + 一个用于每一层的输出),形状为 (batch_size, sequence_length, hidden_size)

    模型在每一层输出端的 Hidden-states 加上初始 embedding 输出。

  • attentions (tuple(tf.Tensor), *可选*, 当传递 output_attentions=True 或当 config.output_attentions=True 时返回) — tf.Tensor 的 Tuple(每一层一个),形状为 (batch_size, num_heads, sequence_length, sequence_length)

    attention softmax 之后的 Attention 权重,用于计算 self-attention heads 中的加权平均值。

TFTapasForMaskedLM 前向方法,覆盖了 __call__ 特殊方法。

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

示例

>>> from transformers import AutoTokenizer, TapasForMaskedLM
>>> import pandas as pd

>>> tokenizer = AutoTokenizer.from_pretrained("google/tapas-base")
>>> model = TapasForMaskedLM.from_pretrained("google/tapas-base")

>>> data = {
...     "Actors": ["Brad Pitt", "Leonardo Di Caprio", "George Clooney"],
...     "Age": ["56", "45", "59"],
...     "Number of movies": ["87", "53", "69"],
... }
>>> table = pd.DataFrame.from_dict(data)

>>> inputs = tokenizer(
...     table=table, queries="How many [MASK] has George [MASK] played in?", return_tensors="tf"
... )
>>> labels = tokenizer(
...     table=table, queries="How many movies has George Clooney played in?", return_tensors="tf"
... )["input_ids"]

>>> outputs = model(**inputs, labels=labels)
>>> logits = outputs.logits

TFTapasForSequenceClassification

class transformers.TFTapasForSequenceClassification

< >

( config: TapasConfig *inputs **kwargs )

参数

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

Tapas 模型,顶部带有一个序列分类头(池化输出顶部的线性层),例如用于表格蕴含任务,如 TabFact (Chen et al., 2020)。

此模型继承自 TFPreTrainedModel。 查看超类文档以获取库为所有模型实现的通用方法(例如下载或保存、调整输入 embeddings 大小、剪枝 heads 等)。

此模型也是 keras.Model 子类。 将其用作常规 TF 2.0 Keras 模型,并参阅 TF 2.0 文档以了解与常规用法和行为相关的所有事项。

transformers 中的 TensorFlow 模型和层接受两种输入格式

  • 将所有输入作为关键字参数(如 PyTorch 模型),或者
  • 将所有输入作为列表、元组或字典放在第一个位置参数中。

支持第二种格式的原因是 Keras 方法在将输入传递给模型和层时首选此格式。 由于这种支持,当使用诸如 model.fit() 之类的方法时,事情应该对您“正常工作” - 只需以 model.fit() 支持的任何格式传递您的输入和标签即可! 但是,如果您想在 Keras 方法(如 fit()predict())之外使用第二种格式,例如在使用 Keras Functional API 创建您自己的层或模型时,可以使用三种可能性来收集第一个位置参数中的所有输入 Tensors

  • 仅使用 input_ids 且不使用其他任何内容的单个 Tensor:model(input_ids)
  • 具有可变长度的列表,其中包含一个或多个输入 Tensors,顺序与文档字符串中给出的顺序相同:model([input_ids, attention_mask])model([input_ids, attention_mask, token_type_ids])
  • 字典,其中一个或多个输入 Tensors 与文档字符串中给出的输入名称相关联:model({"input_ids": input_ids, "token_type_ids": token_type_ids})

请注意,当使用 子类化 创建模型和层时,您无需担心任何这些,因为您可以像对待任何其他 Python 函数一样传递输入!

call

< >

( input_ids: TFModelInputType | None = None attention_mask: np.ndarray | tf.Tensor | None = None token_type_ids: np.ndarray | tf.Tensor | None = None position_ids: np.ndarray | tf.Tensor | None = None head_mask: np.ndarray | tf.Tensor | None = None inputs_embeds: np.ndarray | tf.Tensor | None = None output_attentions: Optional[bool] = None output_hidden_states: Optional[bool] = None return_dict: Optional[bool] = None labels: np.ndarray | tf.Tensor | None = None training: Optional[bool] = False ) transformers.modeling_tf_outputs.TFSequenceClassifierOutputtuple(tf.Tensor)

参数

  • input_ids (np.ndarray, tf.Tensor, List[tf.Tensor]Dict[str, tf.Tensor]Dict[str, np.ndarray],并且每个示例都必须具有形状 (batch_size, num_choices, sequence_length)) — 词汇表中输入序列标记的索引。

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

    什么是输入 ID?

  • attention_mask (np.ndarraytf.Tensor,形状为 (batch_size, num_choices, sequence_length)可选) — 掩码,以避免在填充标记索引上执行注意力。掩码值在 [0, 1] 中选择:

    • 1 表示标记未被掩码
    • 0 表示标记已被掩码

    什么是注意力掩码?

  • token_type_ids (np.ndarraytf.Tensor,形状为 (batch_size, num_choices, sequence_length, 7)可选) — 编码表格结构的标记索引。可以使用 AutoTokenizer 获得索引。 有关更多信息,请参阅此类。

    什么是标记类型 ID?

  • position_ids (np.ndarraytf.Tensor,形状为 (batch_size, num_choices, sequence_length)可选) — 每个输入序列标记在位置嵌入中的位置索引。如果 TapasConfigreset_position_index_per_cell 设置为 True,则将使用相对位置嵌入。在范围 [0, config.max_position_embeddings - 1] 中选择。

    什么是位置 ID?

  • head_mask (np.ndarraytf.Tensor,形状为 (num_heads,)(num_layers, num_heads)可选) — 用于使自注意力模块的选定头无效的掩码。掩码值在 [0, 1] 中选择:

    • 1 表示头未被掩码
    • 0 表示头已被掩码
  • inputs_embeds (np.ndarraytf.Tensor,形状为 (batch_size, num_choices, sequence_length, hidden_size)可选) — (可选)您可以选择直接传递嵌入表示,而不是传递 input_ids。如果您希望比模型的内部嵌入查找矩阵更精确地控制如何将 input_ids 索引转换为关联向量,这将非常有用。
  • output_attentions (bool可选) — 是否返回所有注意力层的注意力张量。 有关更多详细信息,请参阅返回张量下的 attentions。 此参数只能在即时模式下使用,在图模式下将使用配置中的值。
  • output_hidden_states (bool可选) — 是否返回所有层的隐藏状态。 有关更多详细信息,请参阅返回张量下的 hidden_states。 此参数只能在即时模式下使用,在图模式下将使用配置中的值。
  • return_dict (bool可选) — 是否返回 ModelOutput 而不是普通元组。 此参数可以在即时模式下使用,在图模式下,该值将始终设置为 True。
  • training (bool可选,默认为 `False`) — 是否在训练模式下使用该模型(一些模块,如 dropout 模块,在训练和评估之间具有不同的行为)。
  • labels (torch.LongTensor,形状为 (batch_size,)可选) — 用于计算序列分类/回归损失的标签。索引应在 [0, ..., config.num_labels - 1] 中。如果 config.num_labels == 1,则计算回归损失(均方误差损失);如果 config.num_labels > 1,则计算分类损失(交叉熵)。注意:这在原始实现中称为“classification_class_index”。

返回值

transformers.modeling_tf_outputs.TFSequenceClassifierOutputtuple(tf.Tensor)

一个 transformers.modeling_tf_outputs.TFSequenceClassifierOutputtf.Tensor 元组(如果传递 return_dict=False 或当 config.return_dict=False 时),其中包含各种元素,具体取决于配置 (TapasConfig) 和输入。

  • loss (tf.Tensor,形状为 (batch_size, )可选,当提供 labels 时返回) — 分类(或回归,如果 config.num_labels==1)损失。

  • logits (tf.Tensor,形状为 (batch_size, config.num_labels)) — 分类(或回归,如果 config.num_labels==1)分数(SoftMax 之前)。

  • hidden_states (tuple(tf.Tensor), *可选*, 当传递 output_hidden_states=True 或当 config.output_hidden_states=True 时返回) — tf.Tensor 的 Tuple(一个用于 embeddings 的输出 + 一个用于每一层的输出),形状为 (batch_size, sequence_length, hidden_size)

    模型在每一层输出端的 Hidden-states 加上初始 embedding 输出。

  • attentions (tuple(tf.Tensor), *可选*, 当传递 output_attentions=True 或当 config.output_attentions=True 时返回) — tf.Tensor 的 Tuple(每一层一个),形状为 (batch_size, num_heads, sequence_length, sequence_length)

    attention softmax 之后的 Attention 权重,用于计算 self-attention heads 中的加权平均值。

TFTapasForSequenceClassification 前向方法,覆盖了 __call__ 特殊方法。

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

示例

>>> from transformers import AutoTokenizer, TapasForSequenceClassification
>>> import tensorflow as tf
>>> import pandas as pd

>>> tokenizer = AutoTokenizer.from_pretrained("google/tapas-base-finetuned-tabfact")
>>> model = TapasForSequenceClassification.from_pretrained("google/tapas-base-finetuned-tabfact")

>>> data = {
...     "Actors": ["Brad Pitt", "Leonardo Di Caprio", "George Clooney"],
...     "Age": ["56", "45", "59"],
...     "Number of movies": ["87", "53", "69"],
... }
>>> table = pd.DataFrame.from_dict(data)
>>> queries = [
...     "There is only one actor who is 45 years old",
...     "There are 3 actors which played in more than 60 movies",
... ]

>>> inputs = tokenizer(table=table, queries=queries, padding="max_length", return_tensors="tf")
>>> labels = tf.convert_to_tensor([1, 0])  # 1 means entailed, 0 means refuted

>>> outputs = model(**inputs, labels=labels)
>>> loss = outputs.loss
>>> logits = outputs.logits

TFTapasForQuestionAnswering

class transformers.TFTapasForQuestionAnswering

< >

( config: TapasConfig *inputs **kwargs )

参数

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

Tapas 模型,顶部带有一个单元格选择头和可选的聚合头,用于表格上的问答任务(隐藏状态输出顶部的线性层,用于计算 logits 和可选的 logits_aggregation),例如用于 SQA、WTQ 或 WikiSQL-supervised 任务。

此模型继承自 TFPreTrainedModel。 查看超类文档以获取库为所有模型实现的通用方法(例如下载或保存、调整输入 embeddings 大小、剪枝 heads 等)。

此模型也是 keras.Model 子类。 将其用作常规 TF 2.0 Keras 模型,并参阅 TF 2.0 文档以了解与常规用法和行为相关的所有事项。

transformers 中的 TensorFlow 模型和层接受两种输入格式

  • 将所有输入作为关键字参数(如 PyTorch 模型),或者
  • 将所有输入作为列表、元组或字典放在第一个位置参数中。

支持第二种格式的原因是 Keras 方法在将输入传递给模型和层时首选此格式。 由于这种支持,当使用诸如 model.fit() 之类的方法时,事情应该对您“正常工作” - 只需以 model.fit() 支持的任何格式传递您的输入和标签即可! 但是,如果您想在 Keras 方法(如 fit()predict())之外使用第二种格式,例如在使用 Keras Functional API 创建您自己的层或模型时,可以使用三种可能性来收集第一个位置参数中的所有输入 Tensors

  • 仅使用 input_ids 且不使用其他任何内容的单个 Tensor:model(input_ids)
  • 具有可变长度的列表,其中包含一个或多个输入 Tensors,顺序与文档字符串中给出的顺序相同:model([input_ids, attention_mask])model([input_ids, attention_mask, token_type_ids])
  • 字典,其中一个或多个输入 Tensors 与文档字符串中给出的输入名称相关联:model({"input_ids": input_ids, "token_type_ids": token_type_ids})

请注意,当使用 子类化 创建模型和层时,您无需担心任何这些,因为您可以像对待任何其他 Python 函数一样传递输入!

call

< >

( input_ids: TFModelInputType | None = None attention_mask: np.ndarray | tf.Tensor | None = None token_type_ids: np.ndarray | tf.Tensor | None = None position_ids: np.ndarray | tf.Tensor | None = None head_mask: np.ndarray | tf.Tensor | None = None inputs_embeds: np.ndarray | tf.Tensor | None = None table_mask: np.ndarray | tf.Tensor | None = None aggregation_labels: np.ndarray | tf.Tensor | None = None float_answer: np.ndarray | tf.Tensor | None = None numeric_values: np.ndarray | tf.Tensor | None = None numeric_values_scale: np.ndarray | tf.Tensor | None = None output_attentions: Optional[bool] = None output_hidden_states: Optional[bool] = None return_dict: Optional[bool] = None labels: np.ndarray | tf.Tensor | None = None training: Optional[bool] = False ) transformers.models.tapas.modeling_tf_tapas.TFTableQuestionAnsweringOutputtuple(tf.Tensor)

参数

  • input_ids (np.ndarray, tf.Tensor, List[tf.Tensor] `Dict[str, tf.Tensor]Dict[str, np.ndarray] 并且每个示例必须具有形状 (batch_size, sequence_length)) — 词汇表中输入序列 tokens 的索引。

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

    什么是输入 ID?

  • attention_mask (np.ndarraytf.Tensor,形状为 (batch_size, sequence_length)可选) — 用于避免在填充 token 索引上执行注意力的掩码。 掩码值在 [0, 1] 中选择:

    • 1 表示 token 未被掩盖
    • 0 表示 token 被掩盖

    什么是注意力掩码?

  • token_type_ids (np.ndarraytf.Tensor,形状为 (batch_size, sequence_length, 7)可选) — 编码表格结构的 Token 索引。 可以使用 AutoTokenizer 获取索引。 有关更多信息,请参阅此类。

    什么是令牌类型 ID?

  • position_ids (np.ndarraytf.Tensor,形状为 (batch_size, sequence_length)可选) — 位置嵌入中每个输入序列 token 的位置索引。 如果 TapasConfigreset_position_index_per_cell 设置为 True,则将使用相对位置嵌入。 在范围 [0, config.max_position_embeddings - 1] 中选择。

    什么是位置 ID?

  • head_mask (np.ndarraytf.Tensor,形状为 (num_heads,)(num_layers, num_heads)可选) — 用于使自注意力模块的选定头无效的掩码。 掩码值在 [0, 1] 中选择:

    • 1 表示头 未被掩盖
    • 0 表示头 被掩盖
  • inputs_embeds (np.ndarraytf.Tensor,形状为 (batch_size, sequence_length, hidden_size)可选) — (可选)您可以选择直接传递嵌入表示,而不是传递 input_ids。 如果您希望比模型的内部嵌入查找矩阵更好地控制如何将 input_ids 索引转换为关联的向量,这将非常有用。
  • output_attentions (bool可选) — 是否返回所有注意力层的注意力张量。 有关更多详细信息,请参阅返回张量下的 attentions。 此参数只能在 eager 模式下使用,在 graph 模式下将使用配置中的值。
  • output_hidden_states (bool可选) — 是否返回所有层的隐藏状态。 有关更多详细信息,请参阅返回张量下的 hidden_states。 此参数只能在 eager 模式下使用,在 graph 模式下将使用配置中的值。
  • return_dict (bool可选) — 是否返回 ModelOutput 而不是普通元组。 此参数可以在 eager 模式下使用,在 graph 模式下,该值将始终设置为 True。
  • training (bool可选,默认为 `False“) — 是否在训练模式下使用模型(某些模块(如 dropout 模块)在训练和评估之间具有不同的行为)。
  • table_mask (tf.Tensor,形状为 (batch_size, seq_length)可选) — 表格的掩码。 指示哪些 token 属于表格 (1)。 问题 token、表格标题和填充为 0。
  • labels (tf.Tensor,形状为 (batch_size, seq_length)可选) — 每个 token 的标签,用于计算分层单元格选择损失。 这编码了表格中出现的答案的位置。 可以使用 AutoTokenizer 获取。

    • 1 表示 token 是 答案的一部分
    • 0 表示 token 不是答案的一部分
  • aggregation_labels (tf.Tensor,形状为 (batch_size, )可选) — 批次中每个示例的聚合函数索引,用于计算聚合损失。 索引应在 [0, ..., config.num_aggregation_labels - 1] 中。 仅在对聚合进行强监督的情况下(WikiSQL 监督)才需要。
  • float_answer (tf.Tensor,形状为 (batch_size, )可选) — 批次中每个示例的浮点答案。 对于单元格选择问题,设置为 float(‘nan’)。 仅在弱监督(WTQ)的情况下才需要计算聚合掩码和回归损失。
  • numeric_values (tf.Tensor,形状为 (batch_size, seq_length)可选) — 每个 token 的数值,对于非数值的 token 为 NaN。 可以使用 AutoTokenizer 获取。 仅在弱监督聚合(WTQ)的情况下才需要计算回归损失。
  • numeric_values_scale (tf.Tensor,形状为 (batch_size, seq_length)可选) — 每个 token 数值的比例。 可以使用 AutoTokenizer 获取。 仅在弱监督聚合(WTQ)的情况下才需要计算回归损失。

返回值

transformers.models.tapas.modeling_tf_tapas.TFTableQuestionAnsweringOutputtuple(tf.Tensor)

一个 transformers.models.tapas.modeling_tf_tapas.TFTableQuestionAnsweringOutput 或一个 tf.Tensor 元组(如果传递了 return_dict=False 或当 config.return_dict=False 时),其中包含取决于配置 (TapasConfig) 和输入的各种元素。

  • loss (tf.Tensor,形状为 (1,)可选,当提供 labels(并且可能提供 answeraggregation_labelsnumeric_valuesnumeric_values_scale 时返回)) — 总损失,作为分层单元格选择对数似然损失和(可选)半监督回归损失以及(可选)聚合的监督损失的总和。
  • logits (tf.Tensor,形状为 (batch_size, sequence_length)) — 单元格选择头的预测分数,针对每个 token。
  • logits_aggregation (tf.Tensor可选,形状为 (batch_size, num_aggregation_labels)) — 聚合头的预测分数,针对每个聚合运算符。
  • hidden_states (tuple(tf.Tensor)可选,当传递 output_hidden_states=True 或当 config.output_hidden_states=True 时返回) — tf.Tensor 的元组(每个层的输出一个,再加上初始嵌入输出一个),形状为 (batch_size, sequence_length, hidden_size)。 模型在每一层输出端的隐藏状态,加上初始嵌入输出。
  • attentions (tuple(tf.Tensor)可选,当传递 output_attentions=True 或当 config.output_attentions=True 时返回) — tf.Tensor 的元组(每一层一个),形状为 (batch_size, num_heads, sequence_length, sequence_length)。 注意力 softmax 之后的注意力权重,用于计算自注意力头中的加权平均值。

TFTapasForQuestionAnswering 前向方法,覆盖了 __call__ 特殊方法。

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

示例

>>> from transformers import AutoTokenizer, TapasForQuestionAnswering
>>> import pandas as pd

>>> tokenizer = AutoTokenizer.from_pretrained("google/tapas-base-finetuned-wtq")
>>> model = TapasForQuestionAnswering.from_pretrained("google/tapas-base-finetuned-wtq")

>>> data = {
...     "Actors": ["Brad Pitt", "Leonardo Di Caprio", "George Clooney"],
...     "Age": ["56", "45", "59"],
...     "Number of movies": ["87", "53", "69"],
... }
>>> table = pd.DataFrame.from_dict(data)
>>> queries = ["How many movies has George Clooney played in?", "How old is Brad Pitt?"]

>>> inputs = tokenizer(table=table, queries=queries, padding="max_length", return_tensors="tf")
>>> outputs = model(**inputs)

>>> logits = outputs.logits
>>> logits_aggregation = outputs.logits_aggregation
< > GitHub 上更新