FlauBERT模型在论文《FlauBERT: Unsupervised Language Model Pre-training for French》中提出，作者为Hang Le等人。它是一个使用掩码语言建模（MLM）目标（类似BERT）预训练的Transformer模型。
论文的摘要如下
语言模型已成为实现自然语言处理（NLP）任务中世界一流结果的关键步骤。利用如今可用的巨大数量的未标记文本，它们提供了一种有效的方式，预先训练连续词语表示，这些表示可以针对下游任务进行微调，并在句子级别上进行上下文化。这已经在英语中通过上下文表示得到了广泛证明（Dai 和 Le，2015；Peters 等，2018；Howard 和 Ruder，2018；Radford 等，2018；Devlin 等，2019；Yang 等，2019b）。在本文中，我们介绍并分享了FlauBERT，这是一个在非常大型和非同质化的法语语料库上学习的模型。通过使用新的CNRS（法国国家科学研究中心）Jean Zay超级计算机，训练了不同大小的模型。我们将我们的法语语言模型应用于各种NLP任务（文本分类、释义、自然语言推理、解析、词语歧义消除）并表明，大多数情况下，它们优于其他预训练方法。FlauBERT的不同版本以及针对下游任务（称为FLUE，法语语言理解评估）的统一评估协议，都被分享给研究界，以进行法国NLP的进一步可重复实验。
此模型是由formiel贡献的。原始代码可在此找到：[这里]。
提示
- 与RoBERTa类似，没有句子排序预测（因此仅基于MLM目标进行训练）。
资源
FlaubertConfig
类 transformers.FlaubertConfig
< 来源 >( pre_norm = False layerdrop = 0.0 vocab_size = 30145 emb_dim = 2048 n_layers = 12 n_heads = 16 dropout = 0.1 attention_dropout = 0.1 gelu_activation = True sinusoidal_embeddings = False causal = False asm = False n_langs = 1 use_lang_emb = True max_position_embeddings = 512 embed_init_std = 0.02209708691207961 layer_norm_eps = 1e-12 init_std = 0.02 bos_index = 0 eos_index = 1 pad_index = 2 unk_index = 3 mask_index = 5 is_encoder = True summary_type = 'first' summary_use_proj = True summary_activation = None summary_proj_to_labels = True summary_first_dropout = 0.1 start_n_top = 5 end_n_top = 5 mask_token_id = 0 lang_id = 0 pad_token_id = 2 bos_token_id = 0 **kwargs )
参数
- pre_norm (
bool, 可选, 默认为False) — 是否在每一层注意力之后的应用层归一化前后（Vaswani 等人，Tensor2Tensor for Neural Machine Translation. 2018） - layerdrop (
float, 可选, 默认为 0.0) — 训练中丢弃层的概率（Fan 等人，《按需减少 Transformer 深度的结构化丢弃》。ICLR 2020） - vocab_size (
int, 可选, 默认为30145) — FlauBERT模型的词汇表大小。定义了调用FlaubertModel或TFFlaubertModel时可以通过inputs_ids表示的不同令牌的数量。 - emb_dim (
int, 可选, 默认为2048) — 编码层和池化层的大小维度。 - n_layer (
int, 可选, 默认为12) — Transformer编码器中的隐藏层数。 - n_head (
int, 可选, 默认为16) — Transformer编码器每个注意层的注意力头数。 - dropout (
float, 可选，默认为0.1) — 在嵌入层、编码器层和池化层中所有全连接层的dropout概率。 - attention_dropout (
float, 可选，默认为0.1) — 注意机制的dropout概率。 - gelu_activation (
bool, 可选，默认为True) — 是否使用gelu激活函数而不是relu。 - sinusoidal_embeddings (
bool, 可选，默认为False) — 是否使用正弦定位嵌入而不是绝对定位嵌入。 - causal (
bool, 可选，默认为False) — 模型是否以因果方式进行。因果模型使用三角形注意力掩码进行单向注意力而不是双向上下文。 - asm (
bool, 可选，默认为False) — 是否使用自适应对数 softmax 投影层替代线性层进行输出的预测层。 - n_langs （
int，可选，默认为1） — 模型处理的语言数量。对于单语模型设置为1。 - use_lang_emb （
bool，可选，默认为True） — 是否使用语言嵌入。某些模型使用额外的语言嵌入，请参阅 多语言模型页面 了解如何使用它们。 - max_position_embeddings （
int，可选，默认为 512） — 此模型可能用到的最大序列长度。通常设置为较大的值以防万一（例如，512或1024或2048）。 - embed_init_std (
float, 可选，默认为2048的-0.5次方) — 初始化嵌入矩阵所使用的截断正态初始化器的标准差。 - init_std (
int, 可选，默认为50257) — 除嵌入矩阵外，初始化所有权重矩阵所使用的截断正态初始化器的标准差。 - layer_norm_eps (
float, 可选，默认为1e-12) — 层归一化层中使用的epsilon值。 - bos_index (
int, 可选，默认为0) — 词汇表中句子开始 token 的索引。 - eos_index （
int，可选，默认值为1） — 词汇表中结束标记的索引。 - pad_index （
int，可选，默认值为2） — 词汇表中填充标记的索引。 - unk_index （
int，可选，默认值为3） — 词汇表中的未知标记索引。 - mask_index （
int，可选，默认值为5） — 词汇表中掩盖标记的索引。 - is_encoder(
bool, 可选，默认为True) — 指定的模型是否应该是一个变压器编码器或解码器，这通常是 Vaswani 等人所说的。 - summary_type (
字符串, 可选，默认为 "first") — 在做序列摘要时使用的参数。用于序列分类和多项选择模型。 - summary_use_proj (
bool, 可选，默认为True) — 在做序列摘要时使用的参数。用于序列分类和多项选择模型。 - summary_activation (
str, 可选) — 在执行序列摘要时使用的参数。用于序列分类和多项选择模型。将
"tanh"传递给输出以使用 tanh 激活，任何其他值都会导致没有激活。 - summary_proj_to_labels (
bool, 可选, 默认值True) — 用于序列分类和多项选择模型。投影输出应该具有
config.num_labels或config.hidden_size个类。 - summary_first_dropout (
float, 可选, 默认值 0.1) — 用于序列分类和多项选择模型。在投影和激活之后使用的 dropout 比率。
- start_n_top (
int, 可选, 默认为5) — 在SQuAD评估脚本中使用。 - end_n_top (
int, 可选, 默认为5) — 在SQuAD评估脚本中使用。 - mask_token_id (
int, 可选, 默认为0) — 识别MLM上下文中生成的文本时的掩码令牌标识符。这是一个与模型无关的参数。 - lang_id (
int, 可选, 默认为1) — 模型使用的语言ID。当生成指定语言的文本时，使用此参数。
这是一个用于存储FlaubertModel或TFFlaubertModel配置的配置类。它用于根据指定的参数实例化FlauBERT模型，定义模型架构。使用默认值实例化配置将产生类似于FlauBERT flaubert/flaubert_base_uncased 架构的配置。
配置对象继承自PretrainedConfig，可以用于控制模型输出。有关更多信息，请阅读PretrainedConfig文档。
FlaubertTokenizer
class transformers.FlaubertTokenizer
< 源代码 >(
参数
- do_lowercase (
bool, 可选，默认为False) — 控制小写化。 - unk_token (
str, 可选，默认为"<unk>") — 未知令牌。不在词汇表中的令牌不能转换为ID，并设置为该令牌。 - bos_token (
str, 可选，默认为"<s>") — 预训练过程中使用的序列开始令牌。可以用作序列分类令牌。在构建使用特殊令牌的序列时，此令牌不是用于序列开始的令牌。使用的令牌是
cls_token。 - sep_token (
str, 可选,默认为"</s>") — 分隔符标记，用于从多个序列构建一个序列时，例如用于序列分类或问答文本和问题时的两个序列。它还用作具有特殊标记构建的序列的最后一个标记。 - pad_token (
str, 可选,默认为"<pad>") — 用于填充的标记，例如当序列长度不同进行批处理时。 - cls_token (
str, 可选,默认为"</s>") — 分类标记，在序列分类中使用（而不是每个标记的分类）。当使用特殊标记构建序列时，它是序列的第一个标记。 - mask_token （str，可选，默认为 "
"）— 用于掩盖值的标记。这是在用掩盖语言建模训练此模型时使用的标记。这是模型尝试预测的标记。 - additional_special_tokens （List[str]，可选）— 额外特殊标记的列表。
- lang2id （Dict[str, int]，可选）— 将语言字符串标识符映射到它们 ID 的字典。
- id2lang （Dict[int, str]，可选）— 将语言 ID 映射到它们的字符串标识符的字典。
构建Flaubert分词器。基于字节对编码。分词过程如下
- 摩西预处理和标记化。
- 标准化所有输入文本。
- 参数
special_tokens和函数set_special_tokens，可以用来向词汇表中添加额外的符号（如“分类”）。 - 参数
do_lowercase控制小写（预训练词汇表自动设置）。
此标记器继承自PreTrainedTokenizer，其中包含大多数主要方法。用户应参考此超类以获取有关这些方法的更多信息。
build_inputs_with_special_tokens
< source >( token_ids_0: List token_ids_1: Optional = None ) → List[int]
通过连接和添加特殊标记从序列或序列对构建模型输入，以进行序列分类任务。XLM序列的格式如下
- 单序列：
<s> X </s> - 序列对：
<s> A </s> B </s>
将标记序列（字符串）转换为单个字符串。
create_token_type_ids_from_sequences
< source >( token_ids_0: List token_ids_1: Optional = None ) → List[int]
根据传递给序列对分类任务的两个序列创建一个掩码。一个XLM序列
如果token_ids_1为None，则此方法仅返回掩码的第一部分（0s）。
get_special_tokens_mask
< source >( token_ids_0: List token_ids_1: 可选 = None already_has_special_tokens: bool = False ) → 列表[int]
检索未添加特殊标记的标记列表中的序列 ID。此方法在通过 tokenizer 的 prepare_for_model 方法添加特殊标记时调用。
FlaubertModel
前进
< 源代码 >（ input_ids: 可选 = None attention_mask: 可选 = None langs: 可选 = None token_type_ids: 可选 = None position_ids: 可选 = None lengths: 可选 = None cache: 可选 = None head_mask: 可选 = None inputs_embeds: 可选 = None output_attentions: 可选 = None output_hidden_states: 可选 = None return_dict: 可选 = None ） → transformers.modeling_outputs.BaseModelOutput 或 tuple(torch.FloatTensor)
参数
- input_ids（《torch.LongTensor》形状为《batch_size, sequence_length》）） — 词汇中的输入序列标记索引。
可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- 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]内。 - lengths (
torch.LongTensor的形状为(batch_size,)，可选) — 每个句子的长度，可用于避免在填充标记索引上执行注意力操作。您还可以使用attention_mask（参见上方）以获得相同的结果，这里保留以保持兼容性。在[0, ..., input_ids.size(-1)]中选定的索引： - cache (
Dict[str, torch.FloatTensor]，可选) — 字符串到torch.FloatTensor的字典，包含模型（参见下方的cache输出）计算出的预计算隐藏状态（注意力块中的键和值）。可用于加速顺序解码。在正向传播过程中字典对象将就地修改，以添加新的隐藏状态。 - head_mask (
torch.FloatTensor的形状为(num_heads,)或(num_layers, num_heads)，可选) — 用于使自注意力模块中选定的头部无效的掩码。在[0, 1]中选定的掩码值：- 1表示头部未掩码，
- 0表示头部被掩码。
- inputs_embeds (
torch.FloatTensor的形状为(batch_size, sequence_length, hidden_size)，可选) — 可以选择直接传递嵌入表示，而不是传递input_ids。如果您想比模型内部的嵌入查找矩阵有更多控制权，将input_ids索引转换为相关向量，则很有用。 - output_attentions (
bool，可选) — 是否返回所有注意力层的注意力张量。有关详细信息，请参阅返回张量下的attentions。 - output_hidden_states (
bool，可选) — 是否返回所有层的隐藏状态。有关详细信息，请参阅返回张量下的hidden_states。 - return_dict (
布尔值, 可选) — 是否 return 一个 ModelOutput 而不是纯元组。
返回值
transformers.modeling_outputs.BaseModelOutput 或 tuple(torch.FloatTensor)
根据配置 (FlaubertConfig) 和输入，一个 transformers.modeling_outputs.BaseModelOutput 或一个由 torch.FloatTensor 组成的元组（如果传递了 return_dict=False 或当 config.return_dict=False）。
-
last_hidden_state （形状为
(batch_size, sequence_length, hidden_size)的torch.FloatTensor） — 模型最后一层的隐藏状态序列。 -
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时返回） — 一个形状为(batch_size, num_heads, sequence_length, sequence_length)的torch.FloatTensor元组（每个层一个）。注意力softmax后的注意力权重，用于在自注意力头中计算加权平均。
FlaubertModel 前向方法覆盖了 __call__ 特殊方法。
尽管需要在这个函数中定义前向传递的配方，但应该在函数之后调用 Module 实例，因为这个官方实例负责运行前处理和后处理步骤，而后者默默地忽略了它们。
示例
>>> from transformers import AutoTokenizer, FlaubertModel
>>> import torch
>>> tokenizer = AutoTokenizer.from_pretrained("flaubert/flaubert_base_cased")
>>> model = FlaubertModel.from_pretrained("flaubert/flaubert_base_cased")
>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="pt")
>>> outputs = model(**inputs)
>>> last_hidden_states = outputs.last_hidden_stateFlaubertWithLMHeadModel
class transformers.FlaubertWithLMHeadModel
< source >( config )
参数
- config (FlaubertConfig) — 包含模型所有参数的配置类。使用配置文件初始化时不加载模型相关的权重，只加载配置。查看from_pretrained() 方法以加载模型权重。
Flaubert模型变换器，在顶部带有语言建模头（权重与输入嵌入绑定的一层线性层）。
此模型继承自PreTrainedModel。请参阅superclass文档以了解库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、剪枝头部等）。
此模型也是PyTorch torch.nn.Module的子类。将其用作常规PyTorch模块，并查阅PyTorch文档以了解所有与一般用法和行为相关的信息。
前进
< source >( input_ids: Optional = None attention_mask: Optional = None langs: Optional = None token_type_ids: Optional = None position_ids: Optional = None lengths: Optional = None cache: Optional = None head_mask: Optional = None inputs_embeds: Optional = None labels: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None ) → transformers.modeling_outputs.MaskedLMOutput or tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensor形状(batch_size, sequence_length)}) — 输入序列词汇中的标记索引。可以使用 AutoTokenizer 获取索引。详细信息请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- 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]内选择。 - lengths (
torch.LongTensor形状(batch_size,)，可选) — 每个句子长度，可用于避免在填充标记索引上进行注意力操作。您也可以使用attention_mask获得相同的结果（见上文），这里保留以保持兼容性。索引选择在[0, ..., input_ids.size(-1)]中： - cache (
Dict[str, torch.FloatTensor]，可选) — 字典字符串到torch.FloatTensor，包含由模型预先计算的隐藏状态（注意力块中的键和值），如模型计算的（参见下面的cache输出）。可用于加速序列解码。在正向传递过程中将就地修改字典对象，以添加新计算的隐藏状态。 - head_mask (
torch.FloatTensor形状为(num_heads,)或(num_layers, num_heads)，可选) — 用于使自我注意力模块中的选定头部无效的遮罩。遮罩值选择的值在[0, 1]内：- 1 表示头部被 未遮罩，
- 0 表示头部被 遮罩。
- inputs_embeds (
torch.FloatTensor形状为(batch_size, sequence_length, hidden_size)，可选) — 可选，你可以选择直接传递嵌入表示，而不是传递input_ids。这在你想比模型内部的嵌入查找矩阵有更多控制权时很有用，以将input_ids索引转换为相关向量。 - output_attentions (
bool，可选) — 是否返回所有注意力层的注意力张量。有关返回张量下的更多详细信息，请参阅attentions。 - output_hidden_states (
bool, 可选) — 是否返回所有层的隐藏状态。有关详细信息，请参阅返回张量下的hidden_states。 - return_dict (
bool, 可选) — 是否返回ModelOutput而不是原始元组。 - labels (
torch.LongTensor的形状为(batch_size, sequence_length), 可选) — 语言模型的标签。注意，标签在模型中是位移的，即您可以将labels = input_ids。索引在[-100, 0, ..., config.vocab_size]中选取。所有设置为-100的标签都会被忽略（掩码），只对[0, ..., config.vocab_size]中的标签计算损失。
返回值
transformers.modeling_outputs.MaskedLMOutput或tuple(torch.FloatTensor)
transformers.modeling_outputs.MaskedLMOutput或一个包含多个元素的元组，具体取决于配置（FlaubertConfigtorch.FloatTensor（如果通过return_dict=False传递或当config.return_dict=False）。
-
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时返回） — 一个形状为(batch_size, num_heads, sequence_length, sequence_length)的torch.FloatTensor元组（每个层一个）。注意力softmax后的注意力权重，用于在自注意力头中计算加权平均。
FlaubertWithLMHeadModel的前向方法，覆盖了__call__特殊方法。
尽管需要在这个函数中定义前向传递的配方，但应该在函数之后调用 Module 实例，因为这个官方实例负责运行前处理和后处理步骤，而后者默默地忽略了它们。
示例
>>> from transformers import AutoTokenizer, FlaubertWithLMHeadModel
>>> import torch
>>> tokenizer = AutoTokenizer.from_pretrained("flaubert/flaubert_base_cased")
>>> model = FlaubertWithLMHeadModel.from_pretrained("flaubert/flaubert_base_cased")
>>> inputs = tokenizer("The capital of France is <special1>.", return_tensors="pt")
>>> with torch.no_grad():
... logits = model(**inputs).logits
>>> # retrieve index of <special1>
>>> mask_token_index = (inputs.input_ids == tokenizer.mask_token_id)[0].nonzero(as_tuple=True)[0]
>>> predicted_token_id = logits[0, mask_token_index].argmax(axis=-1)
>>> labels = tokenizer("The capital of France is Paris.", return_tensors="pt")["input_ids"]
>>> # mask labels of non-<special1> tokens
>>> labels = torch.where(inputs.input_ids == tokenizer.mask_token_id, labels, -100)
>>> outputs = model(**inputs, labels=labels)FlaubertForSequenceClassification
类 transformers.FlaubertForSequenceClassification
< 源 >( config )
参数
- 配置 (FlaubertConfig) — 包含所有模型参数的配置类。使用配置文件初始化不会加载与模型关联的权重，只会加载数据。请查看from_pretrained() 方法来加载模型权重。
在序列分类/回归头部上方的Flaubert模型（在池化输出之上添加一个线性层），例如用于GLUE任务。
此模型继承自PreTrainedModel。请参阅superclass文档以了解库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、剪枝头部等）。
此模型也是PyTorch torch.nn.Module的子类。将其用作常规PyTorch模块，并查阅PyTorch文档以了解所有与一般用法和行为相关的信息。
前进
< 来源 >( input_ids: Optional = None attention_mask: Optional = None langs: Optional = None token_type_ids: Optional = None position_ids: Optional = None lengths: Optional = None cache: Optional = None head_mask: Optional = None inputs_embeds: Optional = None labels: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None ) → transformers.modeling_outputs.SequenceClassifierOutput 或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensor形状为(batch_size, sequence_length)) —词汇表中的输入序列标记索引。索引可以通过使用 AutoTokenizer 获取。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- 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)，可选) — 每个输入序列token在位置嵌入中的位置索引。在范围[0, config.max_position_embeddings - 1]中选择。 - lengths (
torch.LongTensor的形状为(batch_size,)，可选) — 每个句子的长度，可用于避免在填充token索引上执行注意力操作。您也可以使用attention_mask达到相同的结果（见上面），这里保留以保持兼容性。选择的索引范围为[0, ..., input_ids.size(-1)]： - cache (
Dict[str, torch.FloatTensor]，可选) — 包含由模型预先计算的隐藏状态（注意力块中的键和值）的字符串到torch.FloatTensor的字典，如模型计算的（见下方的cache输出）。可用于加快顺序解码。在正向传递过程中将修改字典对象以添加新计算的隐藏状态。 - head_mask (
torch.FloatTensorof shape(num_heads,)or(num_layers, num_heads), optional) — 用于取消激活self-attention模块选定heads的掩码。掩码值选择在[0, 1]：- 1 表示头部未被掩码
- 0 表示头部被掩码
- inputs_embeds (
torch.FloatTensorof shape(batch_size, sequence_length, hidden_size), optional) — 可以选择直接传递嵌入表示，而不是传递input_ids，这可以让你有更多控制权，能够比模型的内部嵌入查找矩阵更灵活地将input_ids索引转换为相应的向量。 - output_attentions (
bool, optional) — 是否返回所有注意力层的注意力张量。有关更多详情，请参阅返回张量下的attentions。 - output_hidden_states (
bool, 可选) — 是否返回所有层的隐藏状态。有关详细信息，请参阅返回张量中的hidden_states。 - return_dict (
bool, 可选) — 是否返回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)
A transformers.modeling_outputs.SequenceClassifierOutput 或一个包含各种元素的torch.FloatTensor元组，这取决于配置（FlaubertConfig）和输入（如果return_dict=False被传递或当config.return_dict=False）。
-
loss （shape 为
(1,)的torch.FloatTensor，可选，当提供labels时返回）—— 分类（或当 config.num_labels==1 时的回归）损失。 -
logits （shape 为
(batch_size, config.num_labels)的torch.FloatTensor）—— 分类（或当 config.num_labels==1 时的回归）得分（SoftMax 之前）。 -
hidden_states （可选，
tuple(torch.FloatTensor)，在传递了output_hidden_states=True或当config.output_hidden_states=True时返回） — 版本为torch.FloatTensor的元组（模型若有嵌入层，则包含嵌入层的输出，+ 每层的输出），形状为(batch_size, sequence_length, hidden_size)。各层的隐藏状态及可选的初始嵌入输出。
-
attentions （可选，
tuple(torch.FloatTensor)，在传递了output_attentions=True或当config.output_attentions=True时返回） — 一个形状为(batch_size, num_heads, sequence_length, sequence_length)的torch.FloatTensor元组（每个层一个）。注意力softmax后的注意力权重，用于在自注意力头中计算加权平均。
FlaubertForSequenceClassification 的 forward 方法覆盖了 __call__ 特殊方法。
尽管需要在这个函数中定义前向传递的配方，但应该在函数之后调用 Module 实例，因为这个官方实例负责运行前处理和后处理步骤，而后者默默地忽略了它们。
单标签分类示例
>>> import torch
>>> from transformers import AutoTokenizer, FlaubertForSequenceClassification
>>> tokenizer = AutoTokenizer.from_pretrained("flaubert/flaubert_base_cased")
>>> model = FlaubertForSequenceClassification.from_pretrained("flaubert/flaubert_base_cased")
>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="pt")
>>> with torch.no_grad():
... logits = model(**inputs).logits
>>> predicted_class_id = logits.argmax().item()
>>> # To train a model on `num_labels` classes, you can pass `num_labels=num_labels` to `.from_pretrained(...)`
>>> num_labels = len(model.config.id2label)
>>> model = FlaubertForSequenceClassification.from_pretrained("flaubert/flaubert_base_cased", num_labels=num_labels)
>>> labels = torch.tensor([1])
>>> loss = model(**inputs, labels=labels).loss多标签分类示例
>>> import torch
>>> from transformers import AutoTokenizer, FlaubertForSequenceClassification
>>> tokenizer = AutoTokenizer.from_pretrained("flaubert/flaubert_base_cased")
>>> model = FlaubertForSequenceClassification.from_pretrained("flaubert/flaubert_base_cased", problem_type="multi_label_classification")
>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="pt")
>>> with torch.no_grad():
... logits = model(**inputs).logits
>>> predicted_class_ids = torch.arange(0, logits.shape[-1])[torch.sigmoid(logits).squeeze(dim=0) > 0.5]
>>> # To train a model on `num_labels` classes, you can pass `num_labels=num_labels` to `.from_pretrained(...)`
>>> num_labels = len(model.config.id2label)
>>> model = FlaubertForSequenceClassification.from_pretrained(
... "flaubert/flaubert_base_cased", num_labels=num_labels, problem_type="multi_label_classification"
... )
>>> labels = torch.sum(
... torch.nn.functional.one_hot(predicted_class_ids[None, :].clone(), num_classes=num_labels), dim=1
... ).to(torch.float)
>>> loss = model(**inputs, labels=labels).lossFlaubertForMultipleChoice
class transformers.FlaubertForMultipleChoice
< source >( config *inputs **kwargs )
参数
- config (FlaubertConfig) — 模型配置类，包含所有模型参数。使用配置文件初始化不会加载与模型相关的权重，只加载配置。请查看from_pretrained()方法来加载模型权重。
在顶部添加多选题分类头（在池化输出之上添加一个线性层和一个softmax层）的Flaubert模型，例如用于RocStories/SWAG任务。
此模型继承自PreTrainedModel。请参阅superclass文档以了解库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、剪枝头部等）。
此模型也是PyTorch torch.nn.Module的子类。将其用作常规PyTorch模块，并查阅PyTorch文档以了解所有与一般用法和行为相关的信息。
前进
< source >( input_ids: 可选 = None attention_mask: 可选 = None langs: 可选 = None token_type_ids: 可选 = None position_ids: 可选 = None lengths: 可选 = None cache: 可选 = None head_mask: 可选 = None inputs_embeds: 可选 = None labels: 可选 = None output_attentions: 可选 = None output_hidden_states: 可选 = None return_dict: 可选 = None ) → transformers.modeling_outputs.MultipleChoiceModelOutput 或者 tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensor形状(batch_size, sequence_length)) — 在词汇表中输入序列令牌的索引。可以通过 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask （形状为
(batch_size, sequence_length)的torch.FloatTensor，可选） — 用于避免在填充标记索引上执行注意力的掩码。掩码值选择在[0, 1]内：- 1 对应 未掩码 的标记；
- 0 对应 掩码 的标记。
- token_type_ids （形状为
(batch_size, sequence_length)的torch.LongTensor，可选） — 段标记索引，用于指示输入的第一段和第二段。索引选择在[0, 1]内：- 0 对应于 句子 A 标记；
- 1 对应于 句子 B 标记。
- position_ids （形状为
(batch_size, sequence_length)的torch.LongTensor，可选） — 每个输入序列标记在位置嵌入中的索引。索引选择在[0, config.max_position_embeddings - 1]范围内。，有关更多信息请参阅位置 ID 是什么？
- lengths (
torch.LongTensor形状(batch_size,)，可选) — 每个句子可以用于避免在填充令牌索引上执行关注度的长度。您也可以使用attention_mask来达到相同的效果（见上方），此处保留以保持兼容性。在[0, ..., input_ids.size(-1)]中选择的索引： - cache (
Dict[str, torch.FloatTensor]，可选) — 字符串到torch.FloatTensor的字典，包含模型通过计算得到的预计算隐藏状态（注意力块中的密钥和值），如下面的cache输出所示。可以用于加速顺序解码。字典对象在正向传递过程中进行就地修改，以添加新计算的隐藏状态。 - head_mask (
torch.FloatTensor形状(num_heads,)或(num_layers, num_heads)，可选) — 用于屏蔽自我注意力模块选中头的掩码。在[0, 1]中选择的掩码值：- 1 表示头部 未被屏蔽，
- 0 表示头部 被屏蔽。
- inputs_embeds (
torch.FloatTensor，形状为(batch_size, sequence_length, hidden_size)，可选) — 可以选择不传递input_ids，而是直接传递嵌入表示。这在需要比模型内部嵌入查找矩阵更多的控制，以将input_ids索引转换为相关向量时很有用。 - output_attentions (
bool，可选) — 是否返回所有注意力的张量。有关详细信息，请参阅返回张量下的attentions。 - output_hidden_states (
bool，可选) — 是否返回所有层的隐藏状态。有关详细信息，请参阅返回张量下的hidden_states。 - return_dict (
bool, 可选) — 是否返回ModelOutput而不是普通的元组。 - labels (
torch.LongTensor，形状为(batch_size,))，可选) — 用于计算多选分类损失的标签。索引应在[0, ..., num_choices-1]之间，其中num_choices是输入张量的第二维大小。（见上面的input_ids）
返回值
transformers.modeling_outputs.MultipleChoiceModelOutput或tuple(torch.FloatTensor)
A transformers.modeling_outputs.MultipleChoiceModelOutput或一个torch.FloatTensor的元组（如果传递了return_dict=False或当config.return_dict=False时），包含根据配置（FlaubertConfig）和输入的各种元素。
-
loss (
torch.FloatTensor，形状为(1,)，可选，当提供labels时返回） — 分类损失。 -
logits (
torch.FloatTensor，形状为(batch_size, num_choices)） — num_choices是输入张量的第二维。 （见上面的input_ids）分类评分（在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时返回） — 一个形状为(batch_size, num_heads, sequence_length, sequence_length)的torch.FloatTensor元组（每个层一个）。注意力softmax后的注意力权重，用于在自注意力头中计算加权平均。
FlaubertForMultipleChoice的前向方法，覆盖了__call__特例方法。
尽管需要在这个函数中定义前向传递的配方，但应该在函数之后调用 Module 实例，因为这个官方实例负责运行前处理和后处理步骤，而后者默默地忽略了它们。
示例
>>> from transformers import AutoTokenizer, FlaubertForMultipleChoice
>>> import torch
>>> tokenizer = AutoTokenizer.from_pretrained("flaubert/flaubert_base_cased")
>>> model = FlaubertForMultipleChoice.from_pretrained("flaubert/flaubert_base_cased")
>>> prompt = "In Italy, pizza served in formal settings, such as at a restaurant, is presented unsliced."
>>> choice0 = "It is eaten with a fork and a knife."
>>> choice1 = "It is eaten while held in the hand."
>>> labels = torch.tensor(0).unsqueeze(0) # choice0 is correct (according to Wikipedia ;)), batch size 1
>>> encoding = tokenizer([prompt, prompt], [choice0, choice1], return_tensors="pt", padding=True)
>>> outputs = model(**{k: v.unsqueeze(0) for k, v in encoding.items()}, labels=labels) # batch size is 1
>>> # the linear classifier still needs to be trained
>>> loss = outputs.loss
>>> logits = outputs.logitsFlaubertForTokenClassification
类 transformers.FlaubertForTokenClassification
< 源代码 >( config )
参数
- 配置 (FlaubertConfig) — 包含模型所有参数的模型配置类。使用配置文件初始化不会加载与模型关联的权重，只有配置。查看 from_pretrained() 方法以加载模型权重。
在顶部带有标记分类头（隐藏状态输出之上的线性层）的Flaubert模型，例如用于命名实体识别（NER）任务。
此模型继承自PreTrainedModel。请参阅superclass文档以了解库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、剪枝头部等）。
此模型也是PyTorch torch.nn.Module的子类。将其用作常规PyTorch模块，并查阅PyTorch文档以了解所有与一般用法和行为相关的信息。
前进
< 源代码 >( input_ids: 可选 = None attention_mask: 可选 = None langs: 可选 = None token_type_ids: 可选 = None position_ids: 可选 = None lengths: 可选 = None cache: 可选 = None head_mask: 可选 = None inputs_embeds: 可选 = None labels: 可选 = None output_attentions: 可选 = None output_hidden_states: 可选 = None return_dict: 可选 = None ) → transformers.modeling_outputs.TokenClassifierOutput 或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensorof shape(batch_size, sequence_length)) — 输入序列标记的索引，位于词汇表中。索引可以通过 AutoTokenizer 获取。更多信息请参见 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
torch.FloatTensorof shape(batch_size, sequence_length), 可选) — 用于避免对填充标记索引执行注意力的掩码。掩码值在[0, 1]之间选择：- 1 对应 未掩码 的标记，
- 0 对应 掩码 的标记。
- token_type_ids (
torch.LongTensorof shape(batch_size, sequence_length), 可选) — 标记段索引，用于指示输入的第一个和第二部分。索引在[0, 1]之间选择：- 0对应于 句子 A 标记，
- 1对应于 句子 B 标记。
- position_ids (
torch.LongTensorof shape(batch_size, sequence_length), 可选) — 每个输入序列标记在位置嵌入中的索引。选择范围为[0, config.max_position_embeddings - 1]。 - lengths（
torch.LongTensor形状为(batch_size,)，可选）——句子长度，可用于避免在填充标记索引上执行注意力操作。您也可以使用attention_mask来得到相同的结果（见上述），此处保留以兼容。选择索引为[0, ..., input_ids.size(-1)]： - cache（
Dict[str, torch.FloatTensor]，可选）——包含预计算的隐藏状态（注意力块中的键和值）的字符串到torch.FloatTensor的映射，由模型计算得出（参见下面的cache输出）。可用于加速序列解码。该字典对象将在前向传递过程中原地修改，以添加新的隐藏状态。 - head_mask（形状为
torch.FloatTensor的(num_heads,)或(num_layers, num_heads)，可选）——用于取消选中注意力模块中选定头部的掩码。选定的掩码值在[0, 1]中：- 1 表示头部 未遮蔽，
- 0 表示头部 遮蔽。
- inputs_embeds （
torch.FloatTensor形状为(batch_size, sequence_length, hidden_size)，可选） — 可选地，您可以直接传递嵌入表示，而不是传递input_ids。这可以在您想要比模型内部嵌入查找矩阵有更多控制权来将input_ids索引转换为相关向量时很有用。 - output_attentions （
bool，可选） — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参阅返回张量下的attentions。 - output_hidden_states （
bool，可选） — 是否返回所有层的隐藏状态。有关更多详细信息，请参阅返回张量下的hidden_states。 - return_dict (
bool, optional) — 是否返回一个 ModelOutput 而不是普通的元组。 - labels (
torch.LongTensorof shape(batch_size, sequence_length), optional) — 用于计算token分类损失的标签。索引应该在[0, ..., config.num_labels - 1]范围内。
返回值
transformers.modeling_outputs.TokenClassifierOutput 或 tuple(torch.FloatTensor)
A transformers.modeling_outputs.TokenClassifierOutput 或一个包含torch.FloatTensor的元组（如果传递了 return_dict=False 或当 config.return_dict=False），根据配置（FlaubertConfig）和输入包含不同元素。
-
loss (
torch.FloatTensorof shape(1,), optional, returned whenlabelsis provided) — 分类损失。 -
logits (
torch.FloatTensorof shape(batch_size, sequence_length, config.num_labels)) — 分类得分（在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时返回） — 一个形状为(batch_size, num_heads, sequence_length, sequence_length)的torch.FloatTensor元组（每个层一个）。注意力softmax后的注意力权重，用于在自注意力头中计算加权平均。
FlaubertForTokenClassification 的前进方法，覆盖了 __call__ 特殊方法。
尽管需要在这个函数中定义前向传递的配方，但应该在函数之后调用 Module 实例，因为这个官方实例负责运行前处理和后处理步骤，而后者默默地忽略了它们。
示例
>>> from transformers import AutoTokenizer, FlaubertForTokenClassification
>>> import torch
>>> tokenizer = AutoTokenizer.from_pretrained("flaubert/flaubert_base_cased")
>>> model = FlaubertForTokenClassification.from_pretrained("flaubert/flaubert_base_cased")
>>> inputs = tokenizer(
... "HuggingFace is a company based in Paris and New York", add_special_tokens=False, return_tensors="pt"
... )
>>> with torch.no_grad():
... logits = model(**inputs).logits
>>> predicted_token_class_ids = logits.argmax(-1)
>>> # Note that tokens are classified rather then input words which means that
>>> # there might be more predicted token classes than words.
>>> # Multiple token classes might account for the same word
>>> predicted_tokens_classes = [model.config.id2label[t.item()] for t in predicted_token_class_ids[0]]
>>> labels = predicted_token_class_ids
>>> loss = model(**inputs, labels=labels).lossFlaubertForQuestionAnsweringSimple
class transformers.FlaubertForQuestionAnsweringSimple
< 源代码 >( config )
参数
- config（《FlaubertConfig》）—— 包含所有模型参数的模型配置类。使用配置文件初始化不会加载与模型相关的权重，只加载配置。请查看from_pretrained()方法以加载模型权重。
具有顶部分词分类头层的Flaubert模型，用于SQuAD等抽取式问答任务（线性层覆盖隐藏状态输出以计算跨度开始logits和跨度结束logits）。
此模型继承自PreTrainedModel。请参阅superclass文档以了解库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、剪枝头部等）。
此模型也是PyTorch torch.nn.Module的子类。将其用作常规PyTorch模块，并查阅PyTorch文档以了解所有与一般用法和行为相关的信息。
前进
< 源代码 >( input_ids: 可选 = None attention_mask: 可选 = None langs: 可选 = None token_type_ids: 可选 = None position_ids: 可选 = None lengths: 可选 = None cache: 可选 = None head_mask: 可选 = None inputs_embeds: 可选 = None start_positions: 可选 = None end_positions: 可选 = None output_attentions: 可选 = None output_hidden_states: 可选 = None return_dict: 可选 = None ) → transformers.modeling_outputs.QuestionAnsweringModelOutput 或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensorof shape(batch_size, sequence_length)) —词汇中的输入序列标记的索引。索引可以通过使用 AutoTokenizer 获取。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- 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]中选值。 - lengths （形状为
(batch_size,)的torch.LongTensor，可选）— 用于避免对填充标记索引执行注意力的每个句子的长度。也可以使用attention_mask达到相同的结果（见上文），这里保留以保持兼容性。在[0, ..., input_ids.size(-1)]中选中的索引： - cache （可选）
Dict[str, torch.FloatTensor]字典，包含由模型预先计算的隐藏状态（注意力块中的键和值）作为cache输出。可用于加快序列解码。在正向传播过程中，该字典对象将被就地修改，以添加新计算的隐藏状态。 - head_mask （形状为
(num_heads,)或(num_layers, num_heads)的torch.FloatTensor，可选）— 用于置零自注意力模块选中头的掩码。掩码值在[0, 1]中选择： - inputs_embeds (
torch.FloatTensorof 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 而不是纯元组。 - start_positions (
torch.LongTensorof shape(batch_size,), optional) — 标记的跨度开始的标签位置（索引），用于计算token分类损失。位置被限制为序列长度（sequence_length）。序列之外的位置在计算损失时不考虑。 - end_positions (
torch.LongTensorof shape(batch_size,), optional) — 标记的跨度结束的标签位置（索引），用于计算token分类损失。位置被限制为序列长度（sequence_length）。序列之外的位置在计算损失时不考虑。
返回值
transformers.modeling_outputs.QuestionAnsweringModelOutput 或 tuple(torch.FloatTensor)
一个transformers.modeling_outputs.QuestionAnsweringModelOutput，或者一个由torch.FloatTensor组成的元组（如果传递了return_dict=False或者当config.return_dict=False时），包含多个元素，具体取决于配置（FlaubertConfig）和输入。
-
损失（形状为
(1,)的torch.FloatTensor，可选，当提供labels时返回）—总跨度提取损失是起始和结束位置交叉熵的和。 -
start_logits（形状为
(batch_size, sequence_length)的torch.FloatTensor）—跨度起始的分数（在SoftMax之前）。 -
end_logits（形状为
(batch_size, sequence_length)的torch.FloatTensor）—跨度结束的分数（在SoftMax之前）。 -
hidden_states （可选，
tuple(torch.FloatTensor)，在传递了output_hidden_states=True或当config.output_hidden_states=True时返回） — 版本为torch.FloatTensor的元组（模型若有嵌入层，则包含嵌入层的输出，+ 每层的输出），形状为(batch_size, sequence_length, hidden_size)。各层的隐藏状态及可选的初始嵌入输出。
-
attentions （可选，
tuple(torch.FloatTensor)，在传递了output_attentions=True或当config.output_attentions=True时返回） — 一个形状为(batch_size, num_heads, sequence_length, sequence_length)的torch.FloatTensor元组（每个层一个）。注意力softmax后的注意力权重，用于在自注意力头中计算加权平均。
FlaubertForQuestionAnsweringSimple的前向方法，重写了__call__特殊方法。
尽管需要在这个函数中定义前向传递的配方，但应该在函数之后调用 Module 实例，因为这个官方实例负责运行前处理和后处理步骤，而后者默默地忽略了它们。
示例
>>> from transformers import AutoTokenizer, FlaubertForQuestionAnsweringSimple
>>> import torch
>>> tokenizer = AutoTokenizer.from_pretrained("flaubert/flaubert_base_cased")
>>> model = FlaubertForQuestionAnsweringSimple.from_pretrained("flaubert/flaubert_base_cased")
>>> question, text = "Who was Jim Henson?", "Jim Henson was a nice puppet"
>>> inputs = tokenizer(question, text, return_tensors="pt")
>>> with torch.no_grad():
... outputs = model(**inputs)
>>> answer_start_index = outputs.start_logits.argmax()
>>> answer_end_index = outputs.end_logits.argmax()
>>> predict_answer_tokens = inputs.input_ids[0, answer_start_index : answer_end_index + 1]
>>> # target is "nice puppet"
>>> target_start_index = torch.tensor([14])
>>> target_end_index = torch.tensor([15])
>>> outputs = model(**inputs, start_positions=target_start_index, end_positions=target_end_index)
>>> loss = outputs.lossFlaubertForQuestionAnswering
前进
< 源 >( input_ids: 可选 = None attention_mask: 可选 = None langs: 可选 = None token_type_ids: 可选 = None position_ids: 可选 = None lengths: 可选 = None cache: 可选 = None head_mask: 可选 = None inputs_embeds: 可选 = None start_positions: 可选 = None end_positions: 可选 = None is_impossible: 可选 = None cls_index: 可选 = None p_mask: 可选 = None output_attentions: 可选 = None output_hidden_states: 可选 = None return_dict: 可选 = None ) → transformers.models.flaubert.modeling_flaubert.FlaubertForQuestionAnsweringOutput 或 tuple(torch.FloatTensor)
参数
返回值
transformers.models.flaubert.modeling_flaubert.FlaubertForQuestionAnsweringOutput 或 tuple(torch.FloatTensor)
A transformers.models.flaubert.modeling_flaubert.FlaubertForQuestionAnsweringOutput 或一个 torch.FloatTensor 的元组（如果传递了 return_dict=False 或当 config.return_dict=False），根据配置（FlaubertConfig）和输入包含各种元素。
- config (FlaubertConfig): 含有模型所有参数的模型配置类。用配置文件初始化不会加载与模型关联的权重，只加载配置。请查看 from_pretrained() 方法以加载模型权重。
FlaubertForQuestionAnswering 的 forward 方法重写了 __call__ 特殊方法。
尽管需要在这个函数中定义前向传递的配方，但应该在函数之后调用 Module 实例，因为这个官方实例负责运行前处理和后处理步骤，而后者默默地忽略了它们。
使用 SquadHead 的问答模型输出的基类。
示例
>>> from transformers import XLMTokenizer, XLMForQuestionAnswering
>>> import torch
>>> tokenizer = XLMTokenizer.from_pretrained("FacebookAI/xlm-mlm-en-2048")
>>> model = XLMForQuestionAnswering.from_pretrained("FacebookAI/xlm-mlm-en-2048")
>>> input_ids = torch.tensor(tokenizer.encode("Hello, my dog is cute", add_special_tokens=True)).unsqueeze(
... 0
... ) # Batch size 1
>>> start_positions = torch.tensor([1])
>>> end_positions = torch.tensor([3])
>>> outputs = model(input_ids, start_positions=start_positions, end_positions=end_positions)
>>> loss = outputs.lossTFFlaubertModel
类 transformers.TFFlaubertModel
< 来源 >( config *inputs **kwargs )
参数
- config (FlaubertConfig) — 含有模型所有参数的模型配置类。用配置文件初始化不会加载与模型关联的权重，只加载配置。请查看 from_pretrained() 方法以加载模型权重。
仅输出原始隐藏状态的裸 Flaubert 模型，无任何特定头。
此模型继承自 TFPreTrainedModel。检查超类文档以了解库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入的大小、剪枝头等。）
该模型也是keras.Model的子类。您可以将其视为标准的TF 2.0 Keras模型，并参考TF 2.0文档了解有关通用用法和行为的所有相关信息。
在transformers中，TensorFlow模型和层接受两种输入格式：
- 将所有输入作为关键字参数（类似于PyTorch模型），或者
- 将所有输入作为列表、元组或字典的第一个位置参数。
支持第二种格式的理由是，Keras方法在向模型和层传递输入时更倾向于这种格式。因此，使用类似model.fit()的方法时，对于您输入和标签的任何格式，事情都应该“仅仅工作”——只需传递您的输入和标签即可！但如果您想在除fit()和predict()等Keras方法之外的场合使用第二种格式，例如当使用Keras的Functional API创建自己的层或模型时，有三种可能性可供您组装第一个位置参数中的所有输入张量：
- 只有一个
input_ids张量，没有其他内容：model(input_ids) - 一个变长的列表，包含一个或多个按照文档字符串中给出的顺序排列的输入张量：
model([input_ids, attention_mask])或model([input_ids, attention_mask, token_type_ids]) - 一个字典，包含一个或多个与文档字符串中给出的输入名称相关联的输入张量：
model({"input_ids": input_ids, "token_type_ids": token_type_ids})
请注意，如果您通过子类化创建模型和层，那么您不需要担心这些，因为您可以像对任何其他Python函数一样传递输入！
调用
< source >( input_ids: np.ndarray | tf.Tensor | None = None attention_mask: np.ndarray | tf.Tensor | None = None langs: np.ndarray | tf.Tensor | None = None token_type_ids: np.ndarray | tf.Tensor | None = None position_ids: np.ndarray | tf.Tensor | None = None lengths: np.ndarray | tf.Tensor | None = None cache: Optional[Dict[str, tf.Tensor]] = None head_mask: np.ndarray | tf.Tensor | None = None inputs_embeds: 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.TFBaseModelOutput or tuple(tf.Tensor)
参数
- input_ids (
Numpy array或tf.Tensor形状为(batch_size, sequence_length)) — 输入序列标记 vocabulary 中的索引。索引可以使用 AutoTokenizer 获取。有关详细信息，请参阅 PreTrainedTokenizer.call() 和 PreTrainedTokenizer.encode()。
- attention_mask (
Numpy array或tf.Tensor形状为(batch_size, sequence_length)，可选) — 避免在填充令牌索引上执行注意力的掩码。在[0, 1]中选择的掩码值：1对应未掩码的令牌，0对应掩码令牌。
- langs (
tf.Tensor或Numpy array形状为(batch_size, sequence_length)，可选) — 用于指示输入中每个令牌语言的并行令牌序列。索引是语言ID，可以通过模型配置中提供的两个转换映射从语言名称获得（仅适用于多语言模型）。更确切地说，语言名称到语言ID 映射在model.config.lang2id中（这是一个字符串到整数的字典）和 语言ID到语言名称 映射在model.config.id2lang中（整数到字符串的字典）。请参阅多语言文档中详细的使用示例。
- token_type_ids (
tf.Tensor或Numpy array形状为(batch_size, sequence_length)，可选) — 段落令牌索引以表示输入的第一和第二部分。索引选择在[0, 1]：0对应于 句子 A 令牌，1对应于 句子 B 令牌。
- position_ids (
tf.Tensor或者Numpy数组，形状为(batch_size, sequence_length)，可选) — 在位置嵌入中每个输入序列标记的位置索引。选择范围在[0, config.max_position_embeddings - 1]之间。 - lengths (
tf.Tensor或者Numpy数组，形状为(batch_size,)，可选) — 每个句子的长度，可用于避免在填充标记索引上执行注意力操作。您也可以使用attention_mask来获得相同的结果（见上文），此处保留以保持兼容性。所选索引在一个范围[0, ..., input_ids.size(-1)]内： - cache (
Dict[str, tf.Tensor]，可选) — 包含模型计算出的预计算隐藏状态（注意力块的键和值）的字符串到tf.FloatTensor的字典。可以用于加速序列解码。在正向传递过程中，字典对象将被就地修改以添加新计算的隐藏状态。
- head_mask （可选，输入数组
Numpy array或tf.Tensor，形状为(num_heads,)或(num_layers, num_heads)） — 用于使能自注意力模块中选定的头部失效的掩码。掩码值为[0, 1]： - inputs_embeds （可选，
tf.Tensor形状为(batch_size, sequence_length, hidden_size)） — 可选地，直接传递嵌入表示，而不是传递input_ids。如果想要比模型内部的嵌入查找矩阵有更多控制如何将input_ids索引转换为相关向量的话，这是有用的。 - output_attentions （可选，布尔值） — 是否返回所有注意力层的注意力张量。更多细节请参见返回的张量中的
attentions。此参数只能在 eager 模式下使用，在 graph 模式下将使用配置中的值。 - output_hidden_states (
bool, 可选) —— 是否返回所有层的隐藏状态。有关更多详细信息，请参阅返回张量下的hidden_states。此参数只在 eager 模式下可以使用，在 graph 模式下，将使用配置中的值。 - return_dict (
bool, 可选) —— 是否返回ModelOutput 而不是普通元组。此参数可以在 eager 模式下使用，在 graph 模式下，值将始终设置为 True。 - training (
bool, 可选, 默认为False) —— 是否以训练模式使用模型（例如，dropout 模块在训练和评估之间有不同的行为）。
返回值
transformers.modeling_tf_outputs.TFBaseModelOutput 或 tuple(tf.Tensor)
一个transformers.modeling_tf_outputs.TFBaseModelOutput 或 tf.Tensor 的元组（如果传递了 return_dict=False 或 config.return_dict=False），根据配置（FlaubertConfig）和输入包含各种元素。
-
last_hidden_state (
tf.Tensor形状为(batch_size, sequence_length, hidden_size)) — 模型最后一层输出的隐藏状态序列。 -
hidden_states (
tuple(tf.FloatTensor)，可选，当传递output_hidden_states=True或配置config.output_hidden_states=True时返回) — 形状为(batch_size, sequence_length, hidden_size)的tf.Tensor元组（一个用于嵌入输出，一个用于每一层的输出）。模型在每个层输出的隐藏状态以及初始嵌入输出。
-
attentions (
tuple(tf.Tensor)，可选，当传递output_attentions=True或配置config.output_attentions=True时返回) — 形状为(batch_size, num_heads, sequence_length, sequence_length)的tf.Tensor元组（每个层次一个）。注意力softmax后的注意力权重，用于在自注意力头中计算加权平均。
TFFlaubertModel 的 forward 方法重写了 __call__ 特殊方法。
尽管需要在这个函数中定义前向传递的配方，但应该在函数之后调用 Module 实例，因为这个官方实例负责运行前处理和后处理步骤，而后者默默地忽略了它们。
示例
>>> from transformers import AutoTokenizer, TFFlaubertModel
>>> import tensorflow as tf
>>> tokenizer = AutoTokenizer.from_pretrained("flaubert/flaubert_base_cased")
>>> model = TFFlaubertModel.from_pretrained("flaubert/flaubert_base_cased")
>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="tf")
>>> outputs = model(inputs)
>>> last_hidden_states = outputs.last_hidden_stateTFFlaubertWithLMHeadModel
class transformers.TFFlaubertWithLMHeadModel
< source >( config *inputs **kwargs )
参数
- config (FlaubertConfig) — 含有所有模型参数的模型配置类。使用配置文件初始化时，不会加载模型关联的权重，只加载配置。检查from_pretrained() 方法以加载模型权重。
Flaubert模型变换器，在顶部带有语言建模头（权重与输入嵌入绑定的一层线性层）。
此模型继承自 TFPreTrainedModel。检查超类文档以了解库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入的大小、剪枝头等。）
该模型也是keras.Model的子类。您可以将其视为标准的TF 2.0 Keras模型，并参考TF 2.0文档了解有关通用用法和行为的所有相关信息。
在transformers中，TensorFlow模型和层接受两种输入格式：
- 将所有输入作为关键字参数（类似于PyTorch模型），或者
- 将所有输入作为列表、元组或字典的第一个位置参数。
支持第二种格式的理由是，Keras方法在向模型和层传递输入时更倾向于这种格式。因此，使用类似model.fit()的方法时，对于您输入和标签的任何格式，事情都应该“仅仅工作”——只需传递您的输入和标签即可！但如果您想在除fit()和predict()等Keras方法之外的场合使用第二种格式，例如当使用Keras的Functional API创建自己的层或模型时，有三种可能性可供您组装第一个位置参数中的所有输入张量：
- 只有一个
input_ids张量，没有其他内容：model(input_ids) - 一个变长的列表，包含一个或多个按照文档字符串中给出的顺序排列的输入张量：
model([input_ids, attention_mask])或model([input_ids, attention_mask, token_type_ids]) - 一个字典，包含一个或多个与文档字符串中给出的输入名称相关联的输入张量：
model({"input_ids": input_ids, "token_type_ids": token_type_ids})
请注意，如果您通过子类化创建模型和层，那么您不需要担心这些，因为您可以像对任何其他Python函数一样传递输入！
调用
< source >( input_ids: np.ndarray | tf.Tensor | None = None attention_mask: np.ndarray | tf.Tensor | None = None langs: np.ndarray | tf.Tensor | None = None token_type_ids: np.ndarray | tf.Tensor | None = None position_ids: np.ndarray | tf.Tensor | None = None lengths: np.ndarray | tf.Tensor | None = None cache: Optional[Dict[str, tf.Tensor]] = None head_mask: np.ndarray | tf.Tensor | None = None inputs_embeds: 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.models.flaubert.modeling_tf_flaubert.TFFlaubertWithLMHeadModelOutput or tuple(tf.Tensor)
参数
- input_ids (
Numpy array或tf.Tensor大小为(batch_size, sequence_length)) — 输入序列中词汇的索引。使用 AutoTokenizer 可以获取索引。有关详细信息，请参见 PreTrainedTokenizer.call() 和 PreTrainedTokenizer.encode()。
- attention_mask （
Numpy 数组或tf.Tensor，形状为(batch_size, sequence_length)，可选） — 用于避免在填充标记索引上执行注意力的遮罩。遮罩值在[0, 1]中选择：1对非掩码标记有效；0对掩码标记有效。
- langs （
tf.Tensor或Numpy 数组，形状为(batch_size, sequence_length)，可选） — 用于指示输入中每个标记语言的平行序列。索引是语言ID，可以通过模型配置中提供的两种转换映射获得（仅适用于多语言模型）。更确切地说，语言名称到语言ID 映射在model.config.lang2id中（该字典是字符串到整数的映射）和 语言ID到语言名称 映射在model.config.id2lang中（该字典是整数到字符串的映射）。请参阅多语言文档中的详细使用示例。
- token_type_ids (
tf.Tensor或Numpy array的形状为(batch_size, sequence_length)，可选) — 标记段索引以指示输入的第一部分和第二部分。索引选择在[0, 1]范围内：0对应于 句子 A 标记，1对应于 句子 B 标记。
- position_ids (
tf.Tensor或Numpy array的形状为(batch_size, sequence_length)，可选) — 每个输入序列标记在位置嵌入中的索引。选择在[0, config.max_position_embeddings - 1]范围内。 - lengths (
tf.Tensor或Numpy array的形状为(batch_size,)，可选) — 每个句子的长度，可用于避免在填充标记索引上执行注意力操作。您也可以使用 attention_mask（见上面），此处保留以提高兼容性。索引选择在[0, ..., input_ids.size(-1)]范围内： - cache (
字符串到tf.FloatTensor的字典，可选) — 包含模型预先计算的隐藏状态（注意块的键和值）的字典（参见下文的cache输出）。可用于加快序列解码。 - head_mask (
或(num_heads,)形式或(num_layers, num_heads)的tf.Tensor，可选) — 用于取消自动注意力模块中选定头部的掩码。掩码值在范围内选择：[0, 1]： - inputs_embeds (
tf.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。 - 训练 (
bool, 可选，默认为False) — 是否在训练模式下使用模型（某些模块（如dropout模块）在训练和评估之间有不同的行为）。
返回值
transformers.models.flaubert.modeling_tf_flaubert.TFFlaubertWithLMHeadModelOutput 或 tuple(tf.Tensor)
A transformers.models.flaubert.modeling_tf_flaubert.TFFlaubertWithLMHeadModelOutput 或一个tf.Tensor（如果传递了return_dict=False或当 config.return_dict=False）的元组，包含根据配置（FlaubertConfig）和输入的不同元素。
-
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的元组（一个用于嵌入层的输出，另一个用于每个层的输出），形状为(batch_size, sequence_length, hidden_size)。模型在每个层输出的隐藏状态以及初始嵌入输出。
-
attentions (
tuple(tf.Tensor)，可选，当传递output_attentions=True或配置config.output_attentions=True时返回) — 形状为(batch_size, num_heads, sequence_length, sequence_length)的tf.Tensor元组（每个层次一个）。注意力softmax后的注意力权重，用于在自注意力头中计算加权平均。
TFFlaubertWithLMHeadModel 前向方法，重写了__call__特殊方法。
尽管需要在这个函数中定义前向传递的配方，但应该在函数之后调用 Module 实例，因为这个官方实例负责运行前处理和后处理步骤，而后者默默地忽略了它们。
示例
>>> from transformers import AutoTokenizer, TFFlaubertWithLMHeadModel
>>> import tensorflow as tf
>>> tokenizer = AutoTokenizer.from_pretrained("flaubert/flaubert_base_cased")
>>> model = TFFlaubertWithLMHeadModel.from_pretrained("flaubert/flaubert_base_cased")
>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="tf")
>>> outputs = model(inputs)
>>> logits = outputs.logitsTFFlaubertForSequenceClassification
类 transformers.TFFlaubertForSequenceClassification
< 源代码 >( config *inputs **kwargs )
参数
- config (Flaubert配置) — 包含模型所有参数的配置类。使用配置文件启动不会加载模型相关联的权重，只会加载配置。请参阅 from_pretrained() 方法以加载模型权重。
在序列分类/回归头部上方的Flaubert模型（在池化输出之上添加一个线性层），例如用于GLUE任务。
此模型继承自 TFPreTrainedModel。检查超类文档以了解库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入的大小、剪枝头等。）
该模型也是keras.Model的子类。您可以将其视为标准的TF 2.0 Keras模型，并参考TF 2.0文档了解有关通用用法和行为的所有相关信息。
在transformers中，TensorFlow模型和层接受两种输入格式：
- 将所有输入作为关键字参数（类似于PyTorch模型），或者
- 将所有输入作为列表、元组或字典的第一个位置参数。
支持第二种格式的理由是，Keras方法在向模型和层传递输入时更倾向于这种格式。因此，使用类似model.fit()的方法时，对于您输入和标签的任何格式，事情都应该“仅仅工作”——只需传递您的输入和标签即可！但如果您想在除fit()和predict()等Keras方法之外的场合使用第二种格式，例如当使用Keras的Functional API创建自己的层或模型时，有三种可能性可供您组装第一个位置参数中的所有输入张量：
- 只有一个
input_ids张量，没有其他内容：model(input_ids) - 一个变长的列表，包含一个或多个按照文档字符串中给出的顺序排列的输入张量：
model([input_ids, attention_mask])或model([input_ids, attention_mask, token_type_ids]) - 一个字典，包含一个或多个与文档字符串中给出的输入名称相关联的输入张量：
model({"input_ids": input_ids, "token_type_ids": token_type_ids})
请注意，如果您通过子类化创建模型和层，那么您不需要担心这些，因为您可以像对任何其他Python函数一样传递输入！
调用
< 源代码 >( input_ids: TFModelInputType | None = None attention_mask: np.ndarray | tf.Tensor | None = None langs: np.ndarray | tf.Tensor | None = None token_type_ids: np.ndarray | tf.Tensor | None = None position_ids: np.ndarray | tf.Tensor | None = None lengths: np.ndarray | tf.Tensor | None = None cache: Optional[Dict[str, tf.Tensor]] = 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: bool = False ) → transformers.modeling_tf_outputs.TFSequenceClassifierOutput or tuple(tf.Tensor)
参数
- input_ids (
NumPy 数组或tf.Tensor，形状为(batch_size, sequence_length)） — 输入序列令牌的词汇表索引。索引可以通过 AutoTokenizer 获取。有关详情，请参阅 PreTrainedTokenizer.call() 和 PreTrainedTokenizer.encode()。
- attention_mask （可选）为形状为
(batch_size, sequence_length)的Numpy 数组或tf.Tensor，表示应避免在填充标记索引上进行注意力的掩码。在[0, 1]中选择的掩码值：1表示未被掩码的标记，0表示被掩码的标记。
- langs （可选）为形状为
(batch_size, sequence_length)的tf.Tensor或Numpy 数组，表示用于指示输入中每个标记的语言的并行序列。索引是语言 ID，可以通过使用模型配置中提供的两种转换映射从语言名称中获得（仅用于多语言模型）。更确切地说，语言名称到语言 ID 的映射在model.config.lang2id中（它是一个字符串到整数的字典）和 语言 ID 到语言名称 的映射在model.config.id2lang中（整数到字符串的字典）。请参阅多语言文档中的详细用法示例。
- token_type_ids （可选）为形状为
(batch_size, sequence_length)的tf.Tensor或Numpy 数组，表示指示输入输入的第一个和第二部分的段标记索引。索引在[0, 1]中选择：0对应于 句子 A 标记，1对应于 句子 B 标记。
- position_ids (
tf.Tensor或Numpy array形状为(batch_size, sequence_length)，可选) — 每个输入序列标记在位置嵌入中的位置索引。选择在范围[0, config.max_position_embeddings - 1]内。 - lengths (
tf.Tensor或Numpy array形状为(batch_size,)，可选) — 每个句子的长度，可用于避免在填充标记索引上执行注意力操作。您也可以使用 attention_mask 来获得相同的结果（见上方），这里保留以保持兼容性。索引选择在[0, ..., input_ids.size(-1)]： - cache (
Dict[str, tf.Tensor]，可选) — 字典字符串到tf.FloatTensor的映射，包含由模型计算出（参见下面的cache输出）的预计算隐藏状态（注意力块中的密钥和值）。可用于加速顺序解码。在正向传递过程中，字典对象将被原地修改，以添加新计算的隐藏状态。
- head_mask (
Numpy数组或tf.Tensor形状为(num_heads,)或(num_layers, num_heads)，可选) — 用于屏蔽自注意力模块中选中头部的掩码。掩码值选择在[0, 1]： - inputs_embeds (
tf.Tensor形状为(batch_size, sequence_length, hidden_size)，可选) — 可以选择直接传递嵌入表示来代替input_ids，这在您想更精确地控制如何将input_ids索引转换为相关向量时非常有用，而非模型内部的嵌入查找矩阵。 - output_attentions (
bool，可选) — 是否返回所有注意力层的注意力张量。有关返回张量中attentions的详细信息，请参阅。只有在eager模式中可以使用此参数，在graph模式中将使用配置中的值。 - output_hidden_states (
bool, 可选) — 是否返回所有层的隐藏状态。关于返回的tensor中的hidden_states的详细信息，请参阅。此参数只能用于eager模式，在图模式下将使用配置中的值。 - return_dict (
bool, 可选) — 是否返回ModelOutput而不是一个简单的元组。此参数可以用于eager模式，在图模式下总是设置为True。 - training (
bool, 可选，默认为False) — 是否以训练模式使用模型（某些模块如dropout模块在训练和评估之间有不同的行为）。 - labels (
tf.Tensor形状为(batch_size,)，可选。) — 用于计算序列分类/回归损失的标签。索引应在[0, ..., config.num_labels - 1]范围内。如果config.num_labels == 1，则计算回归损失（均方损失），如果config.num_labels > 1，则计算分类损失（交叉熵损失）。
返回值
transformers.modeling_tf_outputs.TFSequenceClassifierOutput 或 tuple(tf.Tensor)
A transformers.modeling_tf_outputs.TFSequenceClassifierOutput 或一个 tf.Tensor 的元组（如果传递了 return_dict=False 或当 config.return_dict=False）根据配置（FlaubertConfig）和输入组成各种元素。
-
loss (
tf.Tensor形状为(batch_size, )，可选，当提供labels时返回) — 分类（或配置num_labels==1时的回归）损失。 -
logits (
tf.Tensor形状为(batch_size, config.num_labels).) — 分类（或配置num_labels==1时的回归）分数（在 SoftMax 之前）。 -
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时返回) — 形状为(batch_size, num_heads, sequence_length, sequence_length)的tf.Tensor元组（每个层次一个）。注意力softmax后的注意力权重，用于在自注意力头中计算加权平均。
TFFlaubertForSequenceClassification 前进方法，覆盖了 __call__ 特殊方法。
尽管需要在这个函数中定义前向传递的配方，但应该在函数之后调用 Module 实例，因为这个官方实例负责运行前处理和后处理步骤，而后者默默地忽略了它们。
示例
>>> from transformers import AutoTokenizer, TFFlaubertForSequenceClassification
>>> import tensorflow as tf
>>> tokenizer = AutoTokenizer.from_pretrained("flaubert/flaubert_base_cased")
>>> model = TFFlaubertForSequenceClassification.from_pretrained("flaubert/flaubert_base_cased")
>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="tf")
>>> logits = model(**inputs).logits
>>> predicted_class_id = int(tf.math.argmax(logits, axis=-1)[0])>>> # To train a model on `num_labels` classes, you can pass `num_labels=num_labels` to `.from_pretrained(...)`
>>> num_labels = len(model.config.id2label)
>>> model = TFFlaubertForSequenceClassification.from_pretrained("flaubert/flaubert_base_cased", num_labels=num_labels)
>>> labels = tf.constant(1)
>>> loss = model(**inputs, labels=labels).lossTFFlaubertForMultipleChoice
类 transformers.TFFlaubertForMultipleChoice
< 来源 >( config *inputs **kwargs )
参数
- 配置 (FlaubertConfig) — 包含所有模型参数的模型配置类。使用配置文件初始化时不加载与模型关联的权重，仅加载配置。请查看 from_pretrained() 方法以加载模型权重。
在顶部添加多选题分类头（在池化输出之上添加一个线性层和一个softmax层）的Flaubert模型，例如用于RocStories/SWAG任务。
此模型继承自 TFPreTrainedModel。检查超类文档以了解库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入的大小、剪枝头等。）
该模型也是keras.Model的子类。您可以将其视为标准的TF 2.0 Keras模型，并参考TF 2.0文档了解有关通用用法和行为的所有相关信息。
在transformers中，TensorFlow模型和层接受两种输入格式：
- 将所有输入作为关键字参数（类似于PyTorch模型），或者
- 将所有输入作为列表、元组或字典的第一个位置参数。
支持第二种格式的理由是，Keras方法在向模型和层传递输入时更倾向于这种格式。因此，使用类似model.fit()的方法时，对于您输入和标签的任何格式，事情都应该“仅仅工作”——只需传递您的输入和标签即可！但如果您想在除fit()和predict()等Keras方法之外的场合使用第二种格式，例如当使用Keras的Functional API创建自己的层或模型时，有三种可能性可供您组装第一个位置参数中的所有输入张量：
- 只有一个
input_ids张量，没有其他内容：model(input_ids) - 一个变长的列表，包含一个或多个按照文档字符串中给出的顺序排列的输入张量：
model([input_ids, attention_mask])或model([input_ids, attention_mask, token_type_ids]) - 一个字典，包含一个或多个与文档字符串中给出的输入名称相关联的输入张量：
model({"input_ids": input_ids, "token_type_ids": token_type_ids})
请注意，如果您通过子类化创建模型和层，那么您不需要担心这些，因为您可以像对任何其他Python函数一样传递输入！
调用
< 来源 >( input_ids: TFModelInputType | None = None attention_mask: np.ndarray | tf.Tensor | None = None langs: np.ndarray | tf.Tensor | None = None token_type_ids: np.ndarray | tf.Tensor | None = None position_ids: np.ndarray | tf.Tensor | None = None lengths: np.ndarray | tf.Tensor | None = None cache: Optional[Dict[str, tf.Tensor]] = 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: bool = False ) → transformers.modeling_tf_outputs.TFMultipleChoiceModelOutput or tuple(tf.Tensor)
参数
- input_ids (
Numpy arrayortf.Tensorof shape(batch_size, sequence_length)) —— 输入序列token在词汇表中的索引。索引可以通过使用AutoTokenizer获得。有关详细信息，请参阅PreTrainedTokenizer.call() 和 PreTrainedTokenizer.encode()。
- attention_mask（
NumPy数组或tf.Tensor，形状为(批次大小, 序列长度)，可选）— 用来避免将注意力放在填充标记索引上的掩码。掩码值选择在[0, 1]范围内：1表示 未掩码 的标记，0表示 掩码 的标记。
- langs（
tf.Tensor或NumPy数组，形状为(批次大小, 序列长度)，可选）— 用于指示输入中每个标记的语言的并行序列。索引是语言ID，可以通过使用模型配置中提供的两种转换映射从语言名称中获取（仅适用于多语言模型）。更具体地说，语言名称到语言ID的映射在model.config.lang2id（这是一个字符串到整数的字典）中，语言ID到语言名称的映射在model.config.id2lang（整数到字符串的字典）中。有关使用示例的详细信息，请参阅多语言文档。
- token_type_ids (
tf.Tensor或Numpy array形状(batch_size, sequence_length)，可选) — 段落标记索引，表示输入的第一部分和第二部分。索引在[0, 1]范围内：0对应 句子 A 标记，1对应 句子 B 标记。
- position_ids (
tf.Tensor或Numpy array形状(batch_size, sequence_length)，可选) — 每个输入序列标记在位置嵌入中的位置索引。选择范围在[0, config.max_position_embeddings - 1]内。 - lengths (
tf.Tensor或Numpy array形状(batch_size,)，可选) — 可以用来避免在填充标记索引上执行注意力的每个句子的长度。您也可以使用 attention_mask 来得到相同的结果（见上文），这里保留以保持兼容性。索引选择在[0, ..., input_ids.size(-1)]范围内： - cache (
Dict[str, tf.Tensor]，可选) — 包含由模型预先计算并存储的隐藏状态（注意力块中的键和值）的字符串到tf.FloatTensor的字典（见下文中的cache输出）。可用于加速序列解码。 - head_mask (
Numpy array或tf.Tensor的形状为(num_heads,)或(num_layers, num_heads)，可选) — 用于屏蔽自我注意力模块中选定头的掩码。掩码值选择在[0, 1]中： - inputs_embeds (
tf.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。 - 训练 (
bool, 可选, 默认为False) — 是否使用模型在训练模式（一些模块如dropout模块，在训练和评估之间有不同的行为）。
返回值
transformers.modeling_tf_outputs.TFMultipleChoiceModelOutput 或 tuple(tf.Tensor)
A transformers.modeling_tf_outputs.TFMultipleChoiceModelOutput 或一个由tf.Tensor组成的元组（如果传递了return_dict=False或当config.return_dict=False时），包含根据配置（FlaubertConfig）和输入的各个元素。
-
loss （提供
labels时的tf.Tensor，形状为(batch_size, )，可选） — 分类损失。 -
logits （形状为
(batch_size, num_choices)的tf.Tensor） — num_choices是输入张量的第二维（参见上面的input_ids）。分类评分（在SoftMax之前）。
-
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时返回) — 形状为(batch_size, num_heads, sequence_length, sequence_length)的tf.Tensor元组（每个层次一个）。注意力softmax后的注意力权重，用于在自注意力头中计算加权平均。
The TFFlaubertForMultipleChoice前进方法，重写了__call__特殊方法。
尽管需要在这个函数中定义前向传递的配方，但应该在函数之后调用 Module 实例，因为这个官方实例负责运行前处理和后处理步骤，而后者默默地忽略了它们。
示例
>>> from transformers import AutoTokenizer, TFFlaubertForMultipleChoice
>>> import tensorflow as tf
>>> tokenizer = AutoTokenizer.from_pretrained("flaubert/flaubert_base_cased")
>>> model = TFFlaubertForMultipleChoice.from_pretrained("flaubert/flaubert_base_cased")
>>> prompt = "In Italy, pizza served in formal settings, such as at a restaurant, is presented unsliced."
>>> choice0 = "It is eaten with a fork and a knife."
>>> choice1 = "It is eaten while held in the hand."
>>> encoding = tokenizer([prompt, prompt], [choice0, choice1], return_tensors="tf", padding=True)
>>> inputs = {k: tf.expand_dims(v, 0) for k, v in encoding.items()}
>>> outputs = model(inputs) # batch size is 1
>>> # the linear classifier still needs to be trained
>>> logits = outputs.logitsTFFlaubertForTokenClassification
类 transformers.TFFlaubertForTokenClassification
< 源代码 >( config *inputs **kwargs )
参数
- config (Flaubert配置) — 包含所有模型参数的模型配置类。用配置文件初始化不会加载与模型关联的权重，仅加载配置。有关加载模型权重的信息，请查看from_pretrained() 方法。
在顶部带有标记分类头（隐藏状态输出之上的线性层）的Flaubert模型，例如用于命名实体识别（NER）任务。
此模型继承自 TFPreTrainedModel。检查超类文档以了解库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入的大小、剪枝头等。）
该模型也是keras.Model的子类。您可以将其视为标准的TF 2.0 Keras模型，并参考TF 2.0文档了解有关通用用法和行为的所有相关信息。
在transformers中，TensorFlow模型和层接受两种输入格式：
- 将所有输入作为关键字参数（类似于PyTorch模型），或者
- 将所有输入作为列表、元组或字典的第一个位置参数。
支持第二种格式的理由是，Keras方法在向模型和层传递输入时更倾向于这种格式。因此，使用类似model.fit()的方法时，对于您输入和标签的任何格式，事情都应该“仅仅工作”——只需传递您的输入和标签即可！但如果您想在除fit()和predict()等Keras方法之外的场合使用第二种格式，例如当使用Keras的Functional API创建自己的层或模型时，有三种可能性可供您组装第一个位置参数中的所有输入张量：
- 只有一个
input_ids张量，没有其他内容：model(input_ids) - 一个变长的列表，包含一个或多个按照文档字符串中给出的顺序排列的输入张量：
model([input_ids, attention_mask])或model([input_ids, attention_mask, token_type_ids]) - 一个字典，包含一个或多个与文档字符串中给出的输入名称相关联的输入张量：
model({"input_ids": input_ids, "token_type_ids": token_type_ids})
请注意，如果您通过子类化创建模型和层，那么您不需要担心这些，因为您可以像对任何其他Python函数一样传递输入！
调用
< 源代码 >( input_ids: TFModelInputType | None = None attention_mask: np.ndarray | tf.Tensor | None = None langs: np.ndarray | tf.Tensor | None = None token_type_ids: np.ndarray | tf.Tensor | None = None position_ids: np.ndarray | tf.Tensor | None = None lengths: np.ndarray | tf.Tensor | None = None cache: Optional[Dict[str, tf.Tensor]] = 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: bool = False ) → transformers.modeling_tf_outputs.TFTokenClassifierOutput 或 tuple(tf.Tensor)
参数
- input_ids (
Numpy数组或tf.Tensor，形状为(batch_size, sequence_length)） — 输入序列词元的词库索引。 - attention_mask （形状为
(batch_size, sequence_length)的Numpy 数组或tf.Tensor，可选）— 使用掩码以避免在填充标记索引上执行注意力机制。掩码值选择的范围在[0, 1]内：1表示未掩码的标记,0表示已掩码的标记。
- langs （形状为
(batch_size, sequence_length)的tf.Tensor或Numpy 数组，可选）— 用于指示输入中每个标记的语言的并行标记序列。索引是语言ID，可以通过使用模型配置中提供的两个转换映射来获得（仅为多语言模型提供）。更确切地说，语言名到语言ID 的映射在model.config.lang2id中（它是一个字符串到整数的字典）和 语言ID到语言名 的映射在model.config.id2lang中（整数到字符串的字典）。请参阅 多语言文档 中的详细使用示例。
- token_type_ids (
tf.Tensor或Numpy array形状为(batch_size, sequence_length)，可选) — 段落标记索引，用于指示输入的第一和第二部分。索引选择在[0, 1]：0对应于 句子 A 标记，1对应于 句子 B 标记。
- position_ids (
tf.Tensor或Numpy array形状为(batch_size, sequence_length)，可选) — 在位置编码中的每个输入序列标记的位置索引。选择在范围[0, config.max_position_embeddings - 1]。 - lengths (
tf.Tensor或Numpy array形状为(batch_size,)，可选) — 每个句子的长度，可用来避免在填充标记索引上执行注意力操作。您还可以使用 attention_mask 实现（参见上文），这里保留以保持兼容性。索引选择在[0, ..., input_ids.size(-1)]： - cache (
Dict[str, tf.Tensor], 可选) — 包含由模型计算出的预定义隐藏状态的字典（键和值来自于注意力块），为cache输出的内容。可用于加速序列解码。 - head_mask (
Numpy数组或tf.Tensor的形状为(num_heads,)或(num_layers, num_heads)，可选) — 用于取消自注意力模块中选定头的掩码。掩码值选择在[0, 1]： - inputs_embeds (
tf.Tensor的形状为(batch_size, sequence_length, hidden_size)，可选) — 可以选择直接传递嵌入表示，而不是传递input_ids。这在您想更多地控制在如何将input_ids索引转换为相关向量方面比模型内部的嵌入查找矩阵更有用。 - output_attentions (
bool, 可选) — 是否返回所有注意力层的注意力张量。有关详细信息，请参阅返回张量部分的attentions。此参数只能在 eager 模式下使用，在图模式下将使用配置中的值。 - output_hidden_states (
bool, 可选) — 是否返回所有层的隐藏状态。有关详细信息，请参阅返回张量部分的hidden_states。此参数只能在 eager 模式下使用，在图模式下将使用配置中的值。 - return_dict (
bool, 可选) — 是否返回ModelOutput，而非普通元组。此参数可以在 eager 模式下使用，在图模式下此值始终设置为 True。 - 训练 (
布尔值, 可选, 默认为False) — 是否使用模型在训练模式（一些模块如dropout模块在训练和评估之间有不同行为）。 - labels (
tf.Tensor形状为(批量大小, 序列长度), 可选) — 用于计算token分类损失的标签。索引应在[0, ..., config.num_labels - 1]范围内。
返回值
transformers.modeling_tf_outputs.TFTokenClassifierOutput 或 tuple(tf.Tensor)
transformers.modeling_tf_outputs.TFTokenClassifierOutput 或一个包含 tf.Tensor 的元组（如果传递了 return_dict=False 或当 config.return_dict=False），根据配置（FlaubertConfig）和输入包含不同的元素。
-
loss (
tf.Tensor形状为(n,), 可选，其中 n 是未屏蔽标签的数量，在提供labels时返回) — 分类损失。 -
logits (
tf.Tensor形状为(批量大小, 序列长度, config.num_labels)) — 分类分数（SoftMax之前）。 -
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时返回) — 形状为(batch_size, num_heads, sequence_length, sequence_length)的tf.Tensor元组（每个层次一个）。注意力softmax后的注意力权重，用于在自注意力头中计算加权平均。
TFFlaubertForTokenClassification 的 forward 方法，覆盖了 __call__ 特殊方法。
尽管需要在这个函数中定义前向传递的配方，但应该在函数之后调用 Module 实例，因为这个官方实例负责运行前处理和后处理步骤，而后者默默地忽略了它们。
示例
>>> from transformers import AutoTokenizer, TFFlaubertForTokenClassification
>>> import tensorflow as tf
>>> tokenizer = AutoTokenizer.from_pretrained("flaubert/flaubert_base_cased")
>>> model = TFFlaubertForTokenClassification.from_pretrained("flaubert/flaubert_base_cased")
>>> inputs = tokenizer(
... "HuggingFace is a company based in Paris and New York", add_special_tokens=False, return_tensors="tf"
... )
>>> logits = model(**inputs).logits
>>> predicted_token_class_ids = tf.math.argmax(logits, axis=-1)
>>> # Note that tokens are classified rather then input words which means that
>>> # there might be more predicted token classes than words.
>>> # Multiple token classes might account for the same word
>>> predicted_tokens_classes = [model.config.id2label[t] for t in predicted_token_class_ids[0].numpy().tolist()]TFFlaubertForQuestionAnsweringSimple
类 transformers.TFFlaubertForQuestionAnsweringSimple
< 源代码 >( config *inputs **kwargs )
参数
- 配置 （FlaubertConfig） — 包含模型所有参数的配置类。使用配置文件初始化时不加载与模型关联的权重，只加载配置。查看用于加载模型权重的 from_pretrained() 方法。
Flaubert 模型，顶部带有 span 分类头，适用于 SQuAD 等提取式问答任务（在隐藏状态输出上方的一个线性层，用于计算 span 开始对数特征 和 span 结束对数特征）。
此模型继承自 TFPreTrainedModel。检查超类文档以了解库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入的大小、剪枝头等。）
该模型也是keras.Model的子类。您可以将其视为标准的TF 2.0 Keras模型，并参考TF 2.0文档了解有关通用用法和行为的所有相关信息。
在transformers中，TensorFlow模型和层接受两种输入格式：
- 将所有输入作为关键字参数（类似于PyTorch模型），或者
- 将所有输入作为列表、元组或字典的第一个位置参数。
支持第二种格式的理由是，Keras方法在向模型和层传递输入时更倾向于这种格式。因此，使用类似model.fit()的方法时，对于您输入和标签的任何格式，事情都应该“仅仅工作”——只需传递您的输入和标签即可！但如果您想在除fit()和predict()等Keras方法之外的场合使用第二种格式，例如当使用Keras的Functional API创建自己的层或模型时，有三种可能性可供您组装第一个位置参数中的所有输入张量：
- 只有一个
input_ids张量，没有其他内容：model(input_ids) - 一个变长的列表，包含一个或多个按照文档字符串中给出的顺序排列的输入张量：
model([input_ids, attention_mask])或model([input_ids, attention_mask, token_type_ids]) - 一个字典，包含一个或多个与文档字符串中给出的输入名称相关联的输入张量：
model({"input_ids": input_ids, "token_type_ids": token_type_ids})
请注意，如果您通过子类化创建模型和层，那么您不需要担心这些，因为您可以像对任何其他Python函数一样传递输入！
调用
< 源代码 >( input_ids: TFModelInputType | None = None attention_mask: np.ndarray | tf.Tensor | None = None langs: np.ndarray | tf.Tensor | None = None token_type_ids: np.ndarray | tf.Tensor | None = None position_ids: np.ndarray | tf.Tensor | None = None lengths: np.ndarray | tf.Tensor | None = None cache: Optional[Dict[str, tf.Tensor]] = 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 start_positions: np.ndarray | tf.Tensor | None = None end_positions: np.ndarray | tf.Tensor | None = None training: bool = False ) → transformers.modeling_tf_outputs.TFQuestionAnsweringModelOutput 或 tuple(tf.Tensor)
参数
- input_ids (
Numpy数组或tf.Tensor形状为(batch_size, sequence_length)) — 输入序列单词的词库索引。索引可以通过 AutoTokenizer 获取。有关详细信息，请参阅 PreTrainedTokenizer.call() 和 PreTrainedTokenizer.encode()。
- attention_mask (
Numpy数组或tf.Tensor形状为(batch_size, sequence_length)，可选) — 用于避免对填充单词索引执行注意力的掩码。掩码值选择在[0, 1]范围内：1对应于 未掩码 的单词，0对应于 掩码 的单词。
- langs (
tf.Tensor或Numpy array，形状为(batch_size, sequence_length)，可选) — 一个并行序列，表示输入中每个标记的语言。索引是语言ID，可以通过模型配置中提供的两种转换映射从语言名称获得。更确切地说，语言名称到语言ID 的映射在model.config.lang2id中（这是一个字符串到整数的字典），而 语言ID到语言名称 的映射在model.config.id2lang中（一个整数到字符串的字典）。请参阅 多语言文档 中详细的使用示例。
- token_type_ids (
tf.Tensor或Numpy array，形状为(batch_size, sequence_length)，可选) — 表示输入中第一部分和第二部分的段标记指数。索引为[0, 1]：0对应于 句子A 标记，1对应于 句子B 标记。
- position_ids (
tf.Tensor或Numpy array，形状为(batch_size, sequence_length)，可选) — 每个输入序列标记的位置嵌入中的索引。选择范围在[0, config.max_position_embeddings - 1]之间。 - lengths （
tf.Tensor或者形状为(batch_size,)的Numpy array，可选） — 可以用来避免对填充标记索引执行注意力操作的每个句子的长度。您也可以使用 attention_mask 来获得相同的结果（参见上面），在这里保留以保持兼容性。在[0, ..., input_ids.size(-1)]中选择的索引： - cache （
Dict[str, tf.Tensor]，可选） — 包含模型（参见下面的cache输出）预计算隐藏状态（键和值在注意力块中）的字符串到tf.FloatTensor字典，可用于加速顺序解码。 - head_mask （形状为
(num_heads,)或(num_layers, num_heads)的Numpy array或tf.Tensor，可选） — 用于屏蔽自注意力模块中选定的头的掩码。掩码值在[0, 1]中选择：1表示 未屏蔽 的头；0表示 屏蔽 的头。
- inputs_embeds （形状为
(batch_size, sequence_length, hidden_size)，类型为tf.Tensor的数组，可选） — 可以选择不传递input_ids，直接传递嵌入表示。如果想要比模型的内部嵌入查找矩阵更多地控制如何将input_ids索引转换为相关向量，则这种方法很有用。 - output_attentions （布尔值，可选） — 是否返回所有注意力层的注意力张量。有关返回张量中
attentions的更多详细信息，请参阅。此参数只能在 eager 模式下使用，在 graph 模式下将使用配置中的值。 - output_hidden_states （布尔值，可选） — 是否返回所有层的隐藏状态。有关返回张量中
hidden_states的更多详细信息，请参阅。此参数只能在 eager 模式下使用，在 graph 模式下将使用配置中的值。 - return_dict (
bool, optional) — 是否返回ModelOutput而不是普通元组。此参数可以在急切模式下使用，在图模式下，该值始终设置为True。 - training (
bool, optional, defaults toFalse) — 是否在训练模式中使用模型（某些模块如dropout模块在训练和评估间的行为有所不同）。 - start_positions (
tf.Tensorof shape(batch_size,), optional) — 标记span开始的位置（索引）的标签，用于计算token分类损失。位置会被限制在序列长度的范围内（sequence_length）。序列之外的位置不参与计算损失。 - end_positions (
tf.Tensorof shape(batch_size,), optional) — 标注跨度末尾位置的标签（用于计算token分类损失的位置）。位置限制为序列长度（sequence_length）。序列之外的末尾位置不计入损失计算。
返回值
transformers.modeling_tf_outputs.TFQuestionAnsweringModelOutput或tuple(tf.Tensor)
transformers.modeling_tf_outputs.TFQuestionAnsweringModelOutput 或一个包含 tf.Tensor 的元组（如果传递了 return_dict=False 或当 config.return_dict=False）的 tuple，元素根据配置（FlaubertConfig）和输入而有所不同。
-
loss（
tf.Tensor，形状(batch_size, )，可选，当提供start_positions和end_positions时返回）— 总跨度提取损失是起始和结束位置上交叉熵的和。 -
start_logits（
tf.Tensor，形状(batch_size, sequence_length)）— Span起始分数（在SoftMax之前）。 -
end_logits（
tf.Tensor，形状(batch_size, sequence_length)）— Span结束分数（在SoftMax之前）。 -
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时返回) — 形状为(batch_size, num_heads, sequence_length, sequence_length)的tf.Tensor元组（每个层次一个）。注意力softmax后的注意力权重，用于在自注意力头中计算加权平均。
TFFlaubertForQuestionAnsweringSimple 的前向方法，覆盖了 __call__ 特殊方法。
尽管需要在这个函数中定义前向传递的配方，但应该在函数之后调用 Module 实例，因为这个官方实例负责运行前处理和后处理步骤，而后者默默地忽略了它们。
示例
>>> from transformers import AutoTokenizer, TFFlaubertForQuestionAnsweringSimple
>>> import tensorflow as tf
>>> tokenizer = AutoTokenizer.from_pretrained("flaubert/flaubert_base_cased")
>>> model = TFFlaubertForQuestionAnsweringSimple.from_pretrained("flaubert/flaubert_base_cased")
>>> question, text = "Who was Jim Henson?", "Jim Henson was a nice puppet"
>>> inputs = tokenizer(question, text, return_tensors="tf")
>>> outputs = model(**inputs)
>>> answer_start_index = int(tf.math.argmax(outputs.start_logits, axis=-1)[0])
>>> answer_end_index = int(tf.math.argmax(outputs.end_logits, axis=-1)[0])
>>> predict_answer_tokens = inputs.input_ids[0, answer_start_index : answer_end_index + 1]