Transformers 文档
FlauBERT
并获得增强的文档体验
开始使用
FlauBERT
概述
FlauBERT 模型由 Hang Le 等人在论文 《FlauBERT: Unsupervised Language Model Pre-training for French》 中提出。它是一个使用掩码语言建模（MLM）目标（如 BERT）进行预训练的 Transformer 模型。
论文摘要如下：
语言模型已成为在许多不同自然语言处理 (NLP) 任务中取得最新成果的关键步骤。利用当今可用的大量未标记文本，它们提供了一种有效的方法来预训练连续词表示，这些表示可以为下游任务进行微调，并在句子层面进行情境化。这一点已在英语中通过情境化表示得到了广泛证明 (Dai and Le, 2015; Peters et al., 2018; Howard and Ruder, 2018; Radford et al., 2018; Devlin et al., 2019; Yang et al., 2019b)。在本文中，我们介绍并分享了 FlauBERT，这是一个在非常庞大且异构的法语语料库上学习的模型。不同大小的模型使用新的 CNRS（法国国家科学研究中心）Jean Zay 超级计算机进行训练。我们将我们的法语语言模型应用于各种 NLP 任务（文本分类、释义、自然语言推理、解析、词义消歧），并表明它们在大多数情况下优于其他预训练方法。不同版本的 FlauBERT 以及一个名为 FLUE (French Language Understanding Evaluation) 的统一下游任务评估协议已与研究社区共享，以便在法语 NLP 中进行进一步的可复现实验。
技巧
- 与 RoBERTa 类似，但没有句子顺序预测（因此仅在 MLM 目标上进行训练）。
资源
FlaubertConfig
class 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 et al., Tensor2Tensor for Neural Machine Translation. 2018）前馈层之前或之后应用层归一化。 - layerdrop (
float, 可选, 默认为 0.0) — 在训练期间丢弃层的概率（Fan et al., Reducing Transformer Depth on Demand with Structured Dropout. 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) — 嵌入层、编码器和池化层中所有全连接层的丢弃概率。 - attention_dropout (
float, 可选, 默认为 0.1) — 注意力机制的丢弃概率。 - 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) — 用于初始化嵌入矩阵的 truncated_normal_initializer 的标准差。 - init_std (
int, 可选, 默认为 50257) — 用于初始化除嵌入矩阵外的所有权重矩阵的 truncated_normal_initializer 的标准差。 - layer_norm_eps (
float, 可选, 默认为 1e-12) — 层归一化层使用的 epsilon 值。 - bos_index (
int, 可选, 默认为 0) — 词汇表中句子开头词元的索引。 - eos_index (
int, 可选, 默认为 1) — 词汇表中句子结尾词元的索引。 - pad_index (
int, 可选, 默认为 2) — 词汇表中填充标记的索引。 - unk_index (
int, 可选, 默认为 3) — 词汇表中未知标记的索引。 - mask_index (
int, 可选, 默认为 5) — 词汇表中掩码标记的索引。 - is_encoder(
bool, 可选, 默认为True) — 初始化的模型是否应为 Vaswani 等人论文中描述的 Transformer 编码器或解码器。 - summary_type (
string, 可选, 默认为 “first”) — 用于序列摘要的参数。在序列分类和多项选择模型中使用。必须是以下选项之一：
"last": 取最后一个标记的隐藏状态（类似 XLNet）。"first": 取第一个标记的隐藏状态（类似 BERT）。"mean": 取所有标记隐藏状态的平均值。"cls_index": 提供一个分类标记位置的张量（类似 GPT/GPT-2）。"attn": 目前未实现，使用多头注意力。
- 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) — 在序列分类和多项选择模型中使用。在投影和激活后使用的丢弃率。
- 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
< 源 >( vocab_file merges_file do_lowercase = False unk_token = '<unk>' bos_token = '<s>' sep_token = '</s>' pad_token = '<pad>' cls_token = '</s>' mask_token = '<special1>' additional_special_tokens = ['<special0>', '<special1>', '<special2>', '<special3>', '<special4>', '<special5>', '<special6>', '<special7>', '<special8>', '<special9>'] lang2id = None id2lang = None **kwargs )
参数
- vocab_file (
str) — 词汇表文件。 - merges_file (
str) — 合并文件。 - 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, 可选, 默认为"<special1>") — 用于掩码值的标记。这是使用掩码语言建模训练此模型时使用的标记。这是模型将尝试预测的标记。 - additional_special_tokens (
List[str], 可选, 默认为['<special0>', '<special1>', '<special2>', '<special3>', '<special4>', '<special5>', '<special6>', '<special7>', '<special8>', '<special9>']) — 附加特殊标记列表。 - lang2id (
Dict[str, int], 可选) — 将语言字符串标识符映射到其 ID 的字典。 - id2lang (
Dict[int, str], 可选) — 将语言 ID 映射到其字符串标识符的字典。
构建一个 Flaubert 分词器。基于字节对编码（Byte-Pair Encoding）。分词过程如下：
- Moses 预处理和分词。
- 对所有输入文本进行规范化。
- 参数 `special_tokens` 和函数 `set_special_tokens` 可用于向词汇表添加额外的符号（如 “classify”）。
- 参数 `do_lowercase` 控制是否转为小写（对于预训练词汇表会自动设置）。
此分词器继承自 PreTrainedTokenizer，其中包含大部分主要方法。用户应参考此超类以获取有关这些方法的更多信息。
build_inputs_with_special_tokens
< 源 >( token_ids_0: list token_ids_1: typing.Optional[list[int]] = None ) → List[int]
通过连接和添加特殊词元，为序列分类任务从一个序列或一对序列构建模型输入。XLM 序列具有以下格式
- 单个序列：
<s> X </s> - 序列对：
<s> A </s> B </s>
将标记序列（字符串）转换为单个字符串。
get_special_tokens_mask
< 源 >( token_ids_0: list token_ids_1: typing.Optional[list[int]] = None already_has_special_tokens: bool = False ) → List[int]
从没有添加特殊标记的标记列表中检索序列ID。此方法在使用分词器prepare_for_model方法添加特殊标记时调用。
FlaubertModel
class transformers.FlaubertModel
< 源 >( config )
参数
- config (FlaubertModel) — 包含模型所有参数的模型配置类。使用配置文件初始化不会加载与模型相关的权重，只会加载配置。请查阅 from_pretrained() 方法来加载模型权重。
原始的 Flaubert 模型，输出原始的隐藏状态，没有任何特定的头部。
该模型继承自 PreTrainedModel。请查阅超类文档以了解该库为其所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、修剪头部等）。
该模型也是一个 PyTorch torch.nn.Module 子类。可以像常规的 PyTorch Module 一样使用它，并参考 PyTorch 文档了解所有与通用用法和行为相关的事项。
forward
< 源 >( input_ids: typing.Optional[torch.LongTensor] = None attention_mask: typing.Optional[torch.FloatTensor] = None langs: typing.Optional[torch.Tensor] = None token_type_ids: typing.Optional[torch.LongTensor] = None position_ids: typing.Optional[torch.LongTensor] = None lengths: typing.Optional[torch.LongTensor] = None cache: typing.Optional[dict[str, torch.FloatTensor]] = None head_mask: typing.Optional[torch.FloatTensor] = None inputs_embeds: typing.Optional[torch.FloatTensor] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None ) → transformers.modeling_outputs.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 表示标记被掩码。
- langs (
torch.LongTensor，形状为(batch_size, sequence_length), 可选) — 一个并行的标记序列，用于指示输入中每个标记的语言。索引是语言 ID，可以通过使用模型配置中提供的两个转换映射（仅为多语言模型提供）从语言名称中获取。更准确地说，语言名称到语言 ID 的映射在model.config.lang2id（一个字符串到整数的字典）中，而 语言 ID 到语言名称 的映射在model.config.id2lang（一个整数到字符串的字典）中。请参阅 多语言文档 中详细的用法示例。
- token_type_ids (
torch.LongTensor，形状为(batch_size, sequence_length), 可选) — 段标记索引，用于指示输入的第一部分和第二部分。索引在 `[0, 1]` 中选择：- 0 对应于 句子 A 的标记,
- 1 对应于 句子 B 的标记。
- position_ids (
torch.LongTensor，形状为(batch_size, sequence_length), 可选) — 位置嵌入中每个输入序列标记的位置索引。在 `[0, config.n_positions - 1]` 范围内选择。 - 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 而不是普通的元组。
返回
transformers.modeling_outputs.BaseModelOutput 或 tuple(torch.FloatTensor)
一个 transformers.modeling_outputs.BaseModelOutput 或一个 torch.FloatTensor 的元组（如果传递了 `return_dict=False` 或 `config.return_dict=False`），根据配置（FlaubertConfig）和输入包含各种元素。
-
last_hidden_state (
torch.FloatTensor, 形状为(batch_size, sequence_length, hidden_size)) — 模型最后一层输出的隐藏状态序列。 -
hidden_states (
tuple(torch.FloatTensor), 可选, 在传递output_hidden_states=True或config.output_hidden_states=True时返回) — `torch.FloatTensor` 的元组（一个用于嵌入层的输出，如果模型有嵌入层，+ 一个用于每层输出），形状为(batch_size, sequence_length, hidden_size)。模型在每个层输出的隐藏状态以及可选的初始嵌入输出。
-
attentions (
tuple(torch.FloatTensor), 可选, 在传递output_attentions=True或config.output_attentions=True时返回) — `torch.FloatTensor` 的元组（每层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 后的注意力权重，用于计算自注意力头中的加权平均值。
FlaubertModel 的前向方法，覆盖了 `__call__` 特殊方法。
虽然前向传递的配方需要在此函数内定义，但之后应该调用 `Module` 实例而不是此函数，因为前者会处理运行前处理和后处理步骤，而后者会静默地忽略它们。
FlaubertWithLMHeadModel
class transformers.FlaubertWithLMHeadModel
< source >( config )
参数
- config (FlaubertWithLMHeadModel) — 包含模型所有参数的模型配置类。使用配置文件初始化不会加载与模型相关的权重，只会加载配置。请查看 from_pretrained() 方法来加载模型权重。
Flaubert Transformer 模型，其顶部带有一个语言建模头（一个权重与输入嵌入绑定的线性层）。
该模型继承自 PreTrainedModel。请查阅超类文档以了解该库为其所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、修剪头部等）。
该模型也是一个 PyTorch torch.nn.Module 子类。可以像常规的 PyTorch Module 一样使用它，并参考 PyTorch 文档了解所有与通用用法和行为相关的事项。
forward
< source >( input_ids: typing.Optional[torch.Tensor] = None attention_mask: typing.Optional[torch.Tensor] = None langs: typing.Optional[torch.Tensor] = None token_type_ids: typing.Optional[torch.Tensor] = None position_ids: typing.Optional[torch.Tensor] = None lengths: typing.Optional[torch.Tensor] = None cache: typing.Optional[dict[str, torch.Tensor]] = None head_mask: typing.Optional[torch.Tensor] = None inputs_embeds: typing.Optional[torch.Tensor] = None labels: typing.Optional[torch.Tensor] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None ) → transformers.modeling_outputs.MaskedLMOutput 或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.Tensor，形状为(batch_size, sequence_length)，可选) — 词汇表中输入序列标记的索引。默认情况下，填充将被忽略。可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
torch.Tensor，形状为(batch_size, sequence_length)，可选) — 用于避免对填充标记索引执行注意力机制的掩码。掩码值在[0, 1]中选择：- 1 表示标记未被掩码，
- 0 表示标记被掩码。
- langs (
torch.LongTensor，形状为(batch_size, sequence_length)，可选) — 一个并行的标记序列，用于指示输入中每个标记的语言。索引是语言 ID，可以通过使用模型配置中提供的两个转换映射从语言名称中获取（仅为多语言模型提供）。更准确地说，语言名称到语言 ID 的映射在model.config.lang2id中（这是一个字符串到整数的字典），而语言 ID 到语言名称的映射在model.config.id2lang中（这是一个整数到字符串的字典）。请参阅多语言文档中详细的使用示例。
- token_type_ids (
torch.Tensor，形状为(batch_size, sequence_length)，可选) — 段标记索引，用于指示输入的第一部分和第二部分。索引在[0, 1]中选择：- 0 对应于句子 A 的标记，
- 1 对应于句子 B 的标记。
- position_ids (
torch.Tensor，形状为(batch_size, sequence_length)，可选) — 每个输入序列标记在位置嵌入中的位置索引。在范围[0, config.n_positions - 1]内选择。 - lengths (
torch.LongTensor，形状为(batch_size,)，可选) — 每个句子的长度，可用于避免对填充标记索引执行注意力机制。你也可以使用attention_mask达到相同的结果（见上文），此处保留是为了兼容性。索引在[0, ..., input_ids.size(-1)]中选择： - cache (
dict[str, torch.FloatTensor]，可选) — 字符串到torch.FloatTensor的字典，其中包含模型计算的预计算隐藏状态（注意力块中的键和值）（请参阅下面的cache输出）。可用于加速顺序解码。字典对象将在前向传递期间被就地修改，以添加新计算的隐藏状态。 - head_mask (
torch.Tensor，形状为(num_heads,)或(num_layers, num_heads)，可选) — 用于使自注意力模块的选定头无效的掩码。掩码值在[0, 1]中选择：- 1 表示头未被掩码，
- 0 表示头被掩码。
- inputs_embeds (
torch.Tensor，形状为(batch_size, sequence_length, hidden_size)，可选) — 可选地，你可以选择直接传递嵌入表示，而不是传递input_ids。如果你想比模型内部的嵌入查找矩阵更好地控制如何将input_ids索引转换为关联向量，这将非常有用。 - labels (
torch.LongTensor，形状为(batch_size, sequence_length)，可选) — 语言建模的标签。请注意，标签在模型内部会被移位，即你可以设置labels = input_ids。索引在[-100, 0, ..., config.vocab_size]中选择。所有设置为-100的标签都会被忽略（掩码），损失仅针对[0, ..., config.vocab_size]中的标签计算。 - output_attentions (
bool，可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参阅返回张量下的attentions。 - output_hidden_states (
bool，可选) — 是否返回所有层的隐藏状态。有关更多详细信息，请参阅返回张量下的hidden_states。 - return_dict (
bool，可选) — 是否返回一个 ModelOutput 而不是一个普通的元组。
返回
transformers.modeling_outputs.MaskedLMOutput 或 tuple(torch.FloatTensor)
一个 transformers.modeling_outputs.MaskedLMOutput 或一个 torch.FloatTensor 的元组（如果传递了 return_dict=False 或当 config.return_dict=False 时），根据配置（FlaubertConfig）和输入，包含各种元素。
-
loss (形状为
(1,)的torch.FloatTensor，可选，当提供labels时返回) — 掩码语言建模 (MLM) 损失。 -
logits (形状为
(batch_size, sequence_length, config.vocab_size)的torch.FloatTensor) — 语言建模头部的预测分数（SoftMax 之前的每个词汇标记的分数）。 -
hidden_states (
tuple(torch.FloatTensor), 可选, 在传递output_hidden_states=True或config.output_hidden_states=True时返回) — `torch.FloatTensor` 的元组（一个用于嵌入层的输出，如果模型有嵌入层，+ 一个用于每层输出），形状为(batch_size, sequence_length, hidden_size)。模型在每个层输出的隐藏状态以及可选的初始嵌入输出。
-
attentions (
tuple(torch.FloatTensor), 可选, 在传递output_attentions=True或config.output_attentions=True时返回) — `torch.FloatTensor` 的元组（每层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 后的注意力权重，用于计算自注意力头中的加权平均值。
FlaubertWithLMHeadModel 的 forward 方法重写了 __call__ 特殊方法。
虽然前向传递的配方需要在此函数内定义，但之后应该调用 `Module` 实例而不是此函数，因为前者会处理运行前处理和后处理步骤，而后者会静默地忽略它们。
示例
>>> import torch
>>> from transformers import AutoTokenizer, FlaubertWithLMHeadModel
>>> tokenizer = AutoTokenizer.from_pretrained("flaubert/flaubert_base_uncased")
>>> model = FlaubertWithLMHeadModel.from_pretrained("flaubert/flaubert_base_uncased")
>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="pt")
>>> outputs = model(**inputs, labels=inputs["input_ids"])
>>> loss = outputs.loss
>>> logits = outputs.logitsFlaubertForSequenceClassification
class transformers.FlaubertForSequenceClassification
< source >( config )
参数
- config (FlaubertForSequenceClassification) — 包含模型所有参数的模型配置类。使用配置文件初始化不会加载与模型相关的权重，只会加载配置。请查看 from_pretrained() 方法来加载模型权重。
Flaubert 模型，其顶部带有一个序列分类/回归头（一个在池化输出之上的线性层），例如用于 GLUE 任务。
该模型继承自 PreTrainedModel。请查阅超类文档以了解该库为其所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、修剪头部等）。
该模型也是一个 PyTorch torch.nn.Module 子类。可以像常规的 PyTorch Module 一样使用它，并参考 PyTorch 文档了解所有与通用用法和行为相关的事项。
forward
< source >( input_ids: typing.Optional[torch.Tensor] = None attention_mask: typing.Optional[torch.Tensor] = None langs: typing.Optional[torch.Tensor] = None token_type_ids: typing.Optional[torch.Tensor] = None position_ids: typing.Optional[torch.Tensor] = None lengths: typing.Optional[torch.Tensor] = None cache: typing.Optional[dict[str, torch.Tensor]] = None head_mask: typing.Optional[torch.Tensor] = None inputs_embeds: typing.Optional[torch.Tensor] = None labels: typing.Optional[torch.Tensor] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None ) → transformers.modeling_outputs.SequenceClassifierOutput 或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.Tensor，形状为(batch_size, sequence_length)，可选) — 词汇表中输入序列标记的索引。默认情况下，填充将被忽略。可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
torch.Tensor，形状为(batch_size, sequence_length)，可选) — 用于避免对填充标记索引执行注意力机制的掩码。掩码值在[0, 1]中选择：- 1 表示标记未被掩码，
- 0 表示标记被掩码。
- langs (
torch.LongTensor，形状为(batch_size, sequence_length)，可选) — 一个并行的标记序列，用于指示输入中每个标记的语言。索引是语言 ID，可以通过使用模型配置中提供的两个转换映射从语言名称中获取（仅为多语言模型提供）。更准确地说，语言名称到语言 ID 的映射在model.config.lang2id中（这是一个字符串到整数的字典），而语言 ID 到语言名称的映射在model.config.id2lang中（这是一个整数到字符串的字典）。请参阅多语言文档中详细的使用示例。
- token_type_ids (
torch.Tensor，形状为(batch_size, sequence_length)，可选) — 段标记索引，用于指示输入的第一部分和第二部分。索引在[0, 1]中选择：- 0 对应于句子 A 的标记，
- 1 对应于句子 B 的标记。
- position_ids (
torch.Tensor，形状为(batch_size, sequence_length)，可选) — 每个输入序列标记在位置嵌入中的位置索引。在范围[0, config.n_positions - 1]内选择。 - lengths (
torch.LongTensor，形状为(batch_size,)，可选) — 每个句子的长度，可用于避免对填充标记索引执行注意力机制。你也可以使用 attention_mask 达到相同的结果（见上文），此处保留是为了兼容性。索引在[0, ..., input_ids.size(-1)]中选择。 - cache (
dict[str, torch.FloatTensor]，可选) — 字符串到torch.FloatTensor的字典，其中包含模型计算的预计算隐藏状态（注意力块中的键和值）（请参阅下面的cache输出）。可用于加速顺序解码。字典对象将在前向传递期间被就地修改，以添加新计算的隐藏状态。
- head_mask (
torch.Tensor，形状为(num_heads,)或(num_layers, num_heads)，可选) — 用于使自注意力模块的选定头无效的掩码。掩码值在[0, 1]中选择：- 1 表示头未被掩码，
- 0 表示头被掩码。
- inputs_embeds (
torch.Tensor，形状为(batch_size, sequence_length, hidden_size)，可选) — 可选地，你可以选择直接传递嵌入表示，而不是传递input_ids。如果你想比模型内部的嵌入查找矩阵更好地控制如何将input_ids索引转换为关联向量，这将非常有用。 - labels (
torch.LongTensor，形状为(batch_size,)，可选) — 用于计算序列分类/回归损失的标签。索引应在[0, ..., config.num_labels - 1]范围内。如果config.num_labels == 1，则计算回归损失（均方损失），如果config.num_labels > 1，则计算分类损失（交叉熵）。 - output_attentions (
bool，可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参阅返回张量下的attentions。 - output_hidden_states (
bool，可选) — 是否返回所有层的隐藏状态。有关更多详细信息，请参阅返回张量下的hidden_states。 - return_dict (
bool，可选) — 是否返回一个 ModelOutput 而不是一个普通的元组。
返回
transformers.modeling_outputs.SequenceClassifierOutput 或 tuple(torch.FloatTensor)
一个 transformers.modeling_outputs.SequenceClassifierOutput 或一个 torch.FloatTensor 的元组（如果传递了 return_dict=False 或当 config.return_dict=False 时），根据配置（FlaubertConfig）和输入，包含各种元素。
-
loss (形状为
(1,)的torch.FloatTensor，可选，当提供labels时返回) — 分类损失（如果 config.num_labels==1，则为回归损失）。 -
logits (形状为
(batch_size, config.num_labels)的torch.FloatTensor) — 分类（如果 config.num_labels==1，则为回归）分数（SoftMax 之前）。 -
hidden_states (
tuple(torch.FloatTensor), 可选, 在传递output_hidden_states=True或config.output_hidden_states=True时返回) — `torch.FloatTensor` 的元组（一个用于嵌入层的输出，如果模型有嵌入层，+ 一个用于每层输出），形状为(batch_size, sequence_length, hidden_size)。模型在每个层输出的隐藏状态以及可选的初始嵌入输出。
-
attentions (
tuple(torch.FloatTensor), 可选, 在传递output_attentions=True或config.output_attentions=True时返回) — `torch.FloatTensor` 的元组（每层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 后的注意力权重，用于计算自注意力头中的加权平均值。
FlaubertForSequenceClassification 的 forward 方法重写了 __call__ 特殊方法。
虽然前向传递的配方需要在此函数内定义，但之后应该调用 `Module` 实例而不是此函数，因为前者会处理运行前处理和后处理步骤，而后者会静默地忽略它们。
单标签分类示例
>>> import torch
>>> from transformers import AutoTokenizer, FlaubertForSequenceClassification
>>> tokenizer = AutoTokenizer.from_pretrained("flaubert/flaubert_base_uncased")
>>> model = FlaubertForSequenceClassification.from_pretrained("flaubert/flaubert_base_uncased")
>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="pt")
>>> with torch.no_grad():
... logits = model(**inputs).logits
>>> predicted_class_id = logits.argmax().item()
>>> model.config.id2label[predicted_class_id]
...
>>> # 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_uncased", num_labels=num_labels)
>>> labels = torch.tensor([1])
>>> loss = model(**inputs, labels=labels).loss
>>> round(loss.item(), 2)
...多标签分类示例
>>> import torch
>>> from transformers import AutoTokenizer, FlaubertForSequenceClassification
>>> tokenizer = AutoTokenizer.from_pretrained("flaubert/flaubert_base_uncased")
>>> model = FlaubertForSequenceClassification.from_pretrained("flaubert/flaubert_base_uncased", 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_uncased", 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 (FlaubertForMultipleChoice) — 包含模型所有参数的模型配置类。使用配置文件初始化不会加载与模型相关的权重，只会加载配置。请查看 from_pretrained() 方法来加载模型权重。
Flaubert 模型，其顶部带有一个多项选择分类头（一个在池化输出之上的线性层和一个 softmax），例如用于 RocStories/SWAG 任务。
该模型继承自 PreTrainedModel。请查阅超类文档以了解该库为其所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、修剪头部等）。
该模型也是一个 PyTorch torch.nn.Module 子类。可以像常规的 PyTorch Module 一样使用它，并参考 PyTorch 文档了解所有与通用用法和行为相关的事项。
forward
< source >( input_ids: typing.Optional[torch.Tensor] = None attention_mask: typing.Optional[torch.Tensor] = None langs: typing.Optional[torch.Tensor] = None token_type_ids: typing.Optional[torch.Tensor] = None position_ids: typing.Optional[torch.Tensor] = None lengths: typing.Optional[torch.Tensor] = None cache: typing.Optional[dict[str, torch.Tensor]] = None head_mask: typing.Optional[torch.Tensor] = None inputs_embeds: typing.Optional[torch.Tensor] = None labels: typing.Optional[torch.Tensor] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None ) → transformers.modeling_outputs.MultipleChoiceModelOutput 或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensor，形状为(batch_size, num_choices, sequence_length)) — 词汇表中输入序列标记的索引。可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
torch.Tensor，形状为(batch_size, sequence_length)，可选) — 用于避免对填充标记索引执行注意力机制的掩码。掩码值在[0, 1]中选择：- 1 表示标记未被掩码，
- 0 表示标记被掩码。
- langs (
torch.LongTensor，形状为(batch_size, num_choices, sequence_length)，可选) — 一个并行的标记序列，用于指示输入中每个标记的语言。索引是语言 ID，可以通过使用模型配置中提供的两个转换映射从语言名称中获取（仅为多语言模型提供）。更准确地说，语言名称到语言 ID 的映射在model.config.lang2id中（这是一个字符串到整数的字典），而语言 ID 到语言名称的映射在model.config.id2lang中（这是一个整数到字符串的字典）。请参阅多语言文档中详细的使用示例。
- token_type_ids (
torch.LongTensor，形状为(batch_size, num_choices, sequence_length)，可选) — 片段标记索引，用于指示输入的第一部分和第二部分。索引在[0, 1]中选择：- 0 对应于 句子 A 的标记，
- 1 对应于 句子 B 的标记。
- position_ids (
torch.LongTensor，形状为(batch_size, num_choices, 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.Tensor，形状为(num_heads,)或(num_layers, num_heads)，可选) — 用于置零自注意力模块中选定头的掩码。掩码值在[0, 1]中选择：- 1 表示该头未被屏蔽，
- 0 表示该头被屏蔽。
- inputs_embeds (
torch.FloatTensor，形状为(batch_size, num_choices, sequence_length, hidden_size)，可选) — 可选地，您可以选择直接传递嵌入表示，而不是传递input_ids。如果您想比模型内部的嵌入查找矩阵更好地控制如何将input_ids索引转换为相关向量，这将非常有用。 - labels (
torch.LongTensor，形状为(batch_size,)，可选) — 用于计算多项选择分类损失的标签。索引应在[0, ..., num_choices-1]范围内，其中num_choices是输入张量第二维度的大小。（参见上文的input_ids） - output_attentions (
bool，可选) — 是否返回所有注意力层的注意力张量。更多详情请参阅返回张量下的attentions。 - output_hidden_states (
bool，可选) — 是否返回所有层的隐藏状态。更多详情请参阅返回张量下的hidden_states。 - return_dict (
bool，可选) — 是否返回一个 ModelOutput 而不是一个普通的元组。
返回
transformers.modeling_outputs.MultipleChoiceModelOutput 或 tuple(torch.FloatTensor)
一个 transformers.modeling_outputs.MultipleChoiceModelOutput 或一个 torch.FloatTensor 元组（如果传递了 return_dict=False 或 config.return_dict=False），包含根据配置（FlaubertConfig）和输入的不同元素。
-
loss (形状为 (1,) 的
torch.FloatTensor，可选，当提供labels时返回) — 分类损失。 -
logits (形状为
(batch_size, num_choices)的torch.FloatTensor) — 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时返回) — `torch.FloatTensor` 的元组（每层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 后的注意力权重，用于计算自注意力头中的加权平均值。
FlaubertForMultipleChoice 的 forward 方法重写了 __call__ 特殊方法。
虽然前向传递的配方需要在此函数内定义，但之后应该调用 `Module` 实例而不是此函数，因为前者会处理运行前处理和后处理步骤，而后者会静默地忽略它们。
示例
>>> from transformers import AutoTokenizer, FlaubertForMultipleChoice
>>> import torch
>>> tokenizer = AutoTokenizer.from_pretrained("flaubert/flaubert_base_uncased")
>>> model = FlaubertForMultipleChoice.from_pretrained("flaubert/flaubert_base_uncased")
>>> 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
class transformers.FlaubertForTokenClassification
< 源代码 >( config )
参数
- config (FlaubertForTokenClassification) — 包含模型所有参数的模型配置类。使用配置文件进行初始化不会加载与模型相关的权重，只会加载配置。请查看 from_pretrained() 方法来加载模型权重。
Flaubert Transformer 模型，其顶部带有一个标记分类头（一个在隐藏状态输出之上的线性层），例如用于命名实体识别（NER）任务。
该模型继承自 PreTrainedModel。请查阅超类文档以了解该库为其所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、修剪头部等）。
该模型也是一个 PyTorch torch.nn.Module 子类。可以像常规的 PyTorch Module 一样使用它，并参考 PyTorch 文档了解所有与通用用法和行为相关的事项。
forward
< 源代码 >( input_ids: typing.Optional[torch.Tensor] = None attention_mask: typing.Optional[torch.Tensor] = None langs: typing.Optional[torch.Tensor] = None token_type_ids: typing.Optional[torch.Tensor] = None position_ids: typing.Optional[torch.Tensor] = None lengths: typing.Optional[torch.Tensor] = None cache: typing.Optional[dict[str, torch.Tensor]] = None head_mask: typing.Optional[torch.Tensor] = None inputs_embeds: typing.Optional[torch.Tensor] = None labels: typing.Optional[torch.Tensor] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None ) → transformers.modeling_outputs.TokenClassifierOutput 或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.Tensor，形状为(batch_size, sequence_length)，可选) — 词汇表中输入序列标记的索引。默认情况下，填充将被忽略。可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
torch.Tensor，形状为(batch_size, sequence_length)，可选) — 用于避免对填充标记索引执行注意力计算的掩码。掩码值在[0, 1]中选择：- 1 表示标记未被屏蔽，
- 0 表示标记被屏蔽。
- langs (
torch.LongTensor，形状为(batch_size, sequence_length)，可选) — 与输入并行的标记序列，用于指示输入中每个标记的语言。索引是语言 ID，可以通过使用模型配置中提供的两种转换映射（仅为多语言模型提供）从语言名称中获取。更准确地说，语言名称到语言 ID 的映射在model.config.lang2id（这是一个字符串到整数的字典）中，而 语言 ID 到语言名称 的映射在model.config.id2lang（整数到字符串的字典）中。请参阅多语言文档中详细的用法示例。
- token_type_ids (
torch.Tensor，形状为(batch_size, sequence_length)，可选) — 片段标记索引，用于指示输入的第一部分和第二部分。索引在[0, 1]中选择：- 0 对应于 句子 A 的标记，
- 1 对应于 句子 B 的标记。
- position_ids (
torch.Tensor，形状为(batch_size, sequence_length)，可选) — 位置嵌入中每个输入序列标记的位置索引。在[0, config.n_positions - 1]范围内选择。 - lengths (
torch.LongTensor，形状为(batch_size,)，可选) — 每个句子的长度，可用于避免对填充标记索引执行注意力计算。您也可以使用 attention_mask 达到同样的效果（见上文），此处保留是为了兼容性。索引在[0, ..., input_ids.size(-1)]中选择。 - cache (
dict[str, torch.FloatTensor]，可选) — 从字符串到torch.FloatTensor的字典，包含由模型计算的预计算隐藏状态（注意力块中的键和值）（请参阅下文的cache输出）。可用于加速顺序解码。该字典对象将在前向传播过程中被就地修改，以添加新计算的隐藏状态。
- head_mask (
torch.Tensor，形状为(num_heads,)或(num_layers, num_heads)，可选) — 用于置零自注意力模块中选定头的掩码。掩码值在[0, 1]中选择：- 1 表示该头未被屏蔽，
- 0 表示该头被屏蔽。
- inputs_embeds (
torch.Tensor，形状为(batch_size, sequence_length, hidden_size)，可选) — 可选地，您可以选择直接传递嵌入表示，而不是传递input_ids。如果您想比模型内部的嵌入查找矩阵更好地控制如何将input_ids索引转换为相关向量，这将非常有用。 - labels (
torch.LongTensor，形状为(batch_size, sequence_length)，可选) — 用于计算标记分类损失的标签。索引应在[0, ..., config.num_labels - 1]范围内。 - output_attentions (
bool，可选) — 是否返回所有注意力层的注意力张量。更多详情请参阅返回张量下的attentions。 - output_hidden_states (
bool，可选) — 是否返回所有层的隐藏状态。更多详情请参阅返回张量下的hidden_states。 - return_dict (
bool，可选) — 是否返回一个 ModelOutput 而不是一个普通的元组。
返回
transformers.modeling_outputs.TokenClassifierOutput 或 tuple(torch.FloatTensor)
一个 transformers.modeling_outputs.TokenClassifierOutput 或一个 torch.FloatTensor 元组（如果传递了 return_dict=False 或 config.return_dict=False），包含根据配置（FlaubertConfig）和输入的不同元素。
-
loss (形状为
(1,)的torch.FloatTensor，可选，当提供labels时返回) — 分类损失。 -
logits (形状为
(batch_size, sequence_length, config.num_labels)的torch.FloatTensor) — 分类分数（SoftMax 之前）。 -
hidden_states (
tuple(torch.FloatTensor), 可选, 在传递output_hidden_states=True或config.output_hidden_states=True时返回) — `torch.FloatTensor` 的元组（一个用于嵌入层的输出，如果模型有嵌入层，+ 一个用于每层输出），形状为(batch_size, sequence_length, hidden_size)。模型在每个层输出的隐藏状态以及可选的初始嵌入输出。
-
attentions (
tuple(torch.FloatTensor), 可选, 在传递output_attentions=True或config.output_attentions=True时返回) — `torch.FloatTensor` 的元组（每层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 后的注意力权重，用于计算自注意力头中的加权平均值。
FlaubertForTokenClassification 的 forward 方法重写了 __call__ 特殊方法。
虽然前向传递的配方需要在此函数内定义，但之后应该调用 `Module` 实例而不是此函数，因为前者会处理运行前处理和后处理步骤，而后者会静默地忽略它们。
示例
>>> from transformers import AutoTokenizer, FlaubertForTokenClassification
>>> import torch
>>> tokenizer = AutoTokenizer.from_pretrained("flaubert/flaubert_base_uncased")
>>> model = FlaubertForTokenClassification.from_pretrained("flaubert/flaubert_base_uncased")
>>> 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]]
>>> predicted_tokens_classes
...
>>> labels = predicted_token_class_ids
>>> loss = model(**inputs, labels=labels).loss
>>> round(loss.item(), 2)
...FlaubertForQuestionAnsweringSimple
class transformers.FlaubertForQuestionAnsweringSimple
< 源代码 >( config )
参数
- config (FlaubertForQuestionAnsweringSimple) — 包含模型所有参数的模型配置类。使用配置文件进行初始化不会加载与模型相关的权重，只会加载配置。请查看 from_pretrained() 方法来加载模型权重。
Flaubert 模型，顶部带有一个片段分类头，用于像 SQuAD 这样的抽取式问答任务（一个在隐藏状态输出之上的线性层，用于计算 span start logits 和 span end logits）。
该模型继承自 PreTrainedModel。请查阅超类文档以了解该库为其所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、修剪头部等）。
该模型也是一个 PyTorch torch.nn.Module 子类。可以像常规的 PyTorch Module 一样使用它，并参考 PyTorch 文档了解所有与通用用法和行为相关的事项。
forward
< 源代码 >( input_ids: typing.Optional[torch.Tensor] = None attention_mask: typing.Optional[torch.Tensor] = None langs: typing.Optional[torch.Tensor] = None token_type_ids: typing.Optional[torch.Tensor] = None position_ids: typing.Optional[torch.Tensor] = None lengths: typing.Optional[torch.Tensor] = None cache: typing.Optional[dict[str, torch.Tensor]] = None head_mask: typing.Optional[torch.Tensor] = None inputs_embeds: typing.Optional[torch.Tensor] = None start_positions: typing.Optional[torch.Tensor] = None end_positions: typing.Optional[torch.Tensor] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None ) → transformers.modeling_outputs.QuestionAnsweringModelOutput 或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.Tensor，形状为(batch_size, sequence_length)，可选) — 词汇表中输入序列标记的索引。默认情况下，填充将被忽略。可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
torch.Tensor，形状为(batch_size, sequence_length)，可选) — 用于避免对填充标记索引执行注意力计算的掩码。掩码值在[0, 1]中选择：- 1 表示标记未被屏蔽，
- 0 表示标记被屏蔽。
- langs (
torch.LongTensor，形状为(batch_size, sequence_length)，可选) — 与输入并行的标记序列，用于指示输入中每个标记的语言。索引是语言 ID，可以通过使用模型配置中提供的两种转换映射（仅为多语言模型提供）从语言名称中获取。更准确地说，语言名称到语言 ID 的映射在model.config.lang2id（这是一个字符串到整数的字典）中，而 语言 ID 到语言名称 的映射在model.config.id2lang（整数到字符串的字典）中。请参阅多语言文档中详细的用法示例。
- token_type_ids (
torch.Tensor，形状为(batch_size, sequence_length)，可选) — 片段标记索引，用于指示输入的第一部分和第二部分。索引在[0, 1]中选择：- 0 对应于 句子 A 的标记，
- 1 对应于 句子 B 的标记。
- position_ids (
torch.Tensor，形状为(batch_size, sequence_length)，可选) — 位置嵌入中每个输入序列标记的位置索引。在[0, config.n_positions - 1]范围内选择。 - lengths (
torch.LongTensor，形状为(batch_size,)，可选) — 每个句子的长度，可用于避免对填充标记索引执行注意力计算。您也可以使用 attention_mask 达到同样的效果（见上文），此处保留是为了兼容性。索引在[0, ..., input_ids.size(-1)]中选择。 - cache (
dict[str, torch.FloatTensor]，可选) — 从字符串到torch.FloatTensor的字典，包含由模型计算的预计算隐藏状态（注意力块中的键和值）（请参阅下文的cache输出）。可用于加速顺序解码。该字典对象将在前向传播过程中被就地修改，以添加新计算的隐藏状态。
- head_mask (
torch.Tensor，形状为(num_heads,)或(num_layers, num_heads)，可选) — 用于置零自注意力模块中选定头的掩码。掩码值在[0, 1]中选择：- 1 表示该头未被屏蔽，
- 0 表示该头被屏蔽。
- inputs_embeds (
torch.Tensor，形状为(batch_size, sequence_length, hidden_size)，可选) — 可选地，您可以选择直接传递嵌入表示，而不是传递input_ids。如果您想比模型内部的嵌入查找矩阵更好地控制如何将input_ids索引转换为相关向量，这将非常有用。 - start_positions (
torch.Tensor，形状为(batch_size,)，可选) — 标记的片段开始位置（索引）的标签，用于计算标记分类损失。位置被限制在序列长度（sequence_length）内。序列之外的位置在计算损失时不予考虑。 - end_positions (
torch.Tensor，形状为(batch_size,)，可选) — 标记的片段结束位置（索引）的标签，用于计算标记分类损失。位置被限制在序列长度（sequence_length）内。序列之外的位置在计算损失时不予考虑。 - output_attentions (
bool，可选) — 是否返回所有注意力层的注意力张量。更多详情请参阅返回张量下的attentions。 - output_hidden_states (
bool，可选) — 是否返回所有层的隐藏状态。更多详情请参阅返回张量下的hidden_states。 - return_dict (
bool，可选) — 是否返回一个 ModelOutput 而不是一个普通的元组。
返回
transformers.modeling_outputs.QuestionAnsweringModelOutput 或 tuple(torch.FloatTensor)
一个 transformers.modeling_outputs.QuestionAnsweringModelOutput 或一个 torch.FloatTensor 元组（如果传递了 return_dict=False 或 config.return_dict=False），包含根据配置（FlaubertConfig）和输入的不同元素。
-
loss (
torch.FloatTensorof shape(1,), 可选, 当提供labels时返回) — 总范围提取损失是起始位置和结束位置的交叉熵之和。 -
start_logits (
torch.FloatTensorof shape(batch_size, sequence_length)) — 范围起始分数（SoftMax 之前）。 -
end_logits (
torch.FloatTensorof shape(batch_size, sequence_length)) — 范围结束分数（SoftMax 之前）。 -
hidden_states (
tuple(torch.FloatTensor), 可选, 在传递output_hidden_states=True或config.output_hidden_states=True时返回) — `torch.FloatTensor` 的元组（一个用于嵌入层的输出，如果模型有嵌入层，+ 一个用于每层输出），形状为(batch_size, sequence_length, hidden_size)。模型在每个层输出的隐藏状态以及可选的初始嵌入输出。
-
attentions (
tuple(torch.FloatTensor), 可选, 在传递output_attentions=True或config.output_attentions=True时返回) — `torch.FloatTensor` 的元组（每层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 后的注意力权重，用于计算自注意力头中的加权平均值。
The FlaubertForQuestionAnsweringSimple forward method, overrides the __call__ special method.
虽然前向传递的配方需要在此函数内定义，但之后应该调用 `Module` 实例而不是此函数，因为前者会处理运行前处理和后处理步骤，而后者会静默地忽略它们。
示例
>>> from transformers import AutoTokenizer, FlaubertForQuestionAnsweringSimple
>>> import torch
>>> tokenizer = AutoTokenizer.from_pretrained("flaubert/flaubert_base_uncased")
>>> model = FlaubertForQuestionAnsweringSimple.from_pretrained("flaubert/flaubert_base_uncased")
>>> 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]
>>> tokenizer.decode(predict_answer_tokens, skip_special_tokens=True)
...
>>> # 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.loss
>>> round(loss.item(), 2)
...FlaubertForQuestionAnswering
class transformers.FlaubertForQuestionAnswering
< 源代码 >( config )
参数
- config (FlaubertForQuestionAnswering) — 包含模型所有参数的模型配置类。使用配置文件初始化不会加载与模型相关的权重，只会加载配置。请查看 from_pretrained() 方法来加载模型权重。
带有一个用于抽取式问答任务（如 SQuAD）的片段分类头部的 Flaubert transformer（在隐藏状态输出之上添加一个线性层，用于计算 `片段开始 logits` 和 `片段结束 logits`）。
该模型继承自 PreTrainedModel。请查阅超类文档以了解该库为其所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、修剪头部等）。
该模型也是一个 PyTorch torch.nn.Module 子类。可以像常规的 PyTorch Module 一样使用它，并参考 PyTorch 文档了解所有与通用用法和行为相关的事项。
forward
< 源代码 >( input_ids: typing.Optional[torch.Tensor] = None attention_mask: typing.Optional[torch.Tensor] = None langs: typing.Optional[torch.Tensor] = None token_type_ids: typing.Optional[torch.Tensor] = None position_ids: typing.Optional[torch.Tensor] = None lengths: typing.Optional[torch.Tensor] = None cache: typing.Optional[dict[str, torch.Tensor]] = None head_mask: typing.Optional[torch.Tensor] = None inputs_embeds: typing.Optional[torch.Tensor] = None start_positions: typing.Optional[torch.Tensor] = None end_positions: typing.Optional[torch.Tensor] = None is_impossible: typing.Optional[torch.Tensor] = None cls_index: typing.Optional[torch.Tensor] = None p_mask: typing.Optional[torch.Tensor] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None ) → transformers.models.flaubert.modeling_flaubert.FlaubertForQuestionAnsweringOutput 或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.Tensor，形状为(batch_size, sequence_length), 可选) — 词汇表中输入序列标记的索引。默认情况下，填充将被忽略。可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
torch.Tensor，形状为(batch_size, sequence_length), 可选) — 用于避免对填充标记索引执行注意力的掩码。掩码值在[0, 1]中选择：- 1 表示标记未被遮盖，
- 0 表示标记被遮盖。
- langs (
torch.LongTensor，形状为(batch_size, sequence_length), 可选) — 与输入并行的标记序列，用于指示输入中每个标记的语言。索引是语言 ID，可以通过使用模型配置中提供的两个转换映射从语言名称中获得（仅适用于多语言模型）。更准确地说，语言名称到语言 ID 的映射在model.config.lang2id（一个字符串到整数的字典）中，而语言 ID 到语言名称 的映射在model.config.id2lang（一个整数到字符串的字典）中。有关用法示例，请参阅多语言文档。
- token_type_ids (
torch.Tensor，形状为(batch_size, sequence_length), 可选) — 片段标记索引，用于指示输入的第一部分和第二部分。索引在[0, 1]中选择：- 0 对应于 *A 句* 标记，
- 1 对应于 *B 句* 标记。
- position_ids (
torch.Tensor，形状为(batch_size, sequence_length), 可选) — 每个输入序列标记在位置嵌入中的位置索引。在[0, config.n_positions - 1]范围内选择。 - lengths (
torch.LongTensor，形状为(batch_size,), 可选) — 每个句子的长度，可用于避免对填充标记索引执行注意力。你也可以使用 *attention_mask* 达到同样的效果（见上文），这里保留是为了兼容性。索引在[0, ..., input_ids.size(-1)]中选择。 - cache (
dict[str, torch.FloatTensor], 可选) — 字符串到 `torch.FloatTensor` 的字典，包含模型计算的预计算隐藏状态（注意力块中的键和值）（见下文 `cache` 输出）。可用于加速顺序解码。该字典对象将在前向传播期间就地修改，以添加新计算的隐藏状态。
- head_mask (
torch.Tensor，形状为(num_heads,)或(num_layers, num_heads), 可选) — 用于使自注意力模块中选定的头无效的掩码。掩码值在[0, 1]中选择：- 1 表示头未被遮盖，
- 0 表示头被遮盖。
- inputs_embeds (
torch.Tensor，形状为(batch_size, sequence_length, hidden_size), 可选) — 可选地，你可以不传递 `input_ids`，而是直接传递一个嵌入表示。如果你想比模型内部的嵌入查找矩阵更好地控制如何将 `input_ids` 索引转换为关联向量，这会很有用。 - start_positions (
torch.Tensor，形状为(batch_size,), 可选) — 标记片段开始位置（索引）的标签，用于计算标记分类损失。位置被限制在序列长度（`sequence_length`）内。序列外的位置在计算损失时不予考虑。 - end_positions (
torch.Tensor，形状为(batch_size,), 可选) — 标记片段结束位置（索引）的标签，用于计算标记分类损失。位置被限制在序列长度（`sequence_length`）内。序列外的位置在计算损失时不予考虑。 - is_impossible (
torch.LongTensor，形状为(batch_size,), 可选) — 标记问题是否有答案（SQuAD 2.0） - cls_index (
torch.LongTensor，形状为(batch_size,), 可选) — 分类标记的位置（索引）标签，用作计算答案合理性的输入。 - p_mask (
torch.FloatTensor，形状为(batch_size, sequence_length), 可选) — 不可能出现在答案中的标记的可选掩码（例如 [CLS], [PAD], …）。1.0 表示标记应被遮盖。0.0 表示标记未被遮盖。 - output_attentions (
bool, 可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参见返回张量下的 `attentions`。 - output_hidden_states (
bool, 可选) — 是否返回所有层的隐藏状态。有关更多详细信息，请参见返回张量下的 `hidden_states`。 - return_dict (
bool, 可选) — 是否返回一个 ModelOutput 而不是一个普通的元组。
返回
transformers.models.flaubert.modeling_flaubert.FlaubertForQuestionAnsweringOutput 或 tuple(torch.FloatTensor)
一个 transformers.models.flaubert.modeling_flaubert.FlaubertForQuestionAnsweringOutput 或一个 `torch.FloatTensor` 的元组（如果传递了 `return_dict=False` 或 `config.return_dict=False`），根据配置（FlaubertConfig）和输入，包含各种元素。
-
loss (
torch.FloatTensor，形状为(1,), 可选, 如果同时提供了 `start_positions` 和 `end_positions`，则返回) — 分类损失，为开始标记、结束标记（以及如果提供，则为 is_impossible）分类损失的总和。 -
start_top_log_probs (
torch.FloatTensor，形状为(batch_size, config.start_n_top), 可选, 如果未提供 `start_positions` 或 `end_positions`，则返回) — top config.start_n_top 个开始标记可能性的对数概率（束搜索）。 -
start_top_index (
torch.LongTensor，形状为(batch_size, config.start_n_top), 可选, 如果未提供 `start_positions` 或 `end_positions`，则返回) — top config.start_n_top 个开始标记可能性的索引（束搜索）。 -
end_top_log_probs (
torch.FloatTensor，形状为(batch_size, config.start_n_top * config.end_n_top), 可选, 如果未提供 `start_positions` 或 `end_positions`，则返回) — top `config.start_n_top * config.end_n_top` 个结束标记可能性的对数概率（束搜索）。 -
end_top_index (
torch.LongTensor，形状为(batch_size, config.start_n_top * config.end_n_top), 可选, 如果未提供 `start_positions` 或 `end_positions`，则返回) — top `config.start_n_top * config.end_n_top` 个结束标记可能性的索引（束搜索）。 -
cls_logits (
torch.FloatTensor，形状为(batch_size,), 可选, 如果未提供 `start_positions` 或 `end_positions`，则返回) — 答案的 `is_impossible` 标签的对数概率。 -
hidden_states (
tuple[torch.FloatTensor], 可选, 当传递 `output_hidden_states=True` 或 `config.output_hidden_states=True` 时返回) — `torch.FloatTensor` 的元组（一个用于嵌入层的输出，如果模型有嵌入层，+ 每个层一个输出），形状为 `(batch_size, sequence_length, hidden_size)`。模型在每个层输出的隐藏状态以及可选的初始嵌入输出。
-
attentions (
tuple[torch.FloatTensor], 可选, 当传递 `output_attentions=True` 或 `config.output_attentions=True` 时返回) — `torch.FloatTensor` 的元组（每层一个），形状为 `(batch_size, num_heads, sequence_length, sequence_length)`。注意力 softmax 后的注意力权重，用于计算自注意力头中的加权平均值。
FlaubertForQuestionAnswering 的前向方法，重写了 `__call__` 特殊方法。
虽然前向传递的配方需要在此函数内定义，但之后应该调用 `Module` 实例而不是此函数，因为前者会处理运行前处理和后处理步骤，而后者会静默地忽略它们。
示例
>>> from transformers import AutoTokenizer, FlaubertForQuestionAnswering
>>> import torch
>>> tokenizer = AutoTokenizer.from_pretrained("FacebookAI/xlm-mlm-en-2048")
>>> model = FlaubertForQuestionAnswering.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
class transformers.TFFlaubertModel
< 源代码 >( config *inputs **kwargs )
参数
- config (FlaubertConfig) — 包含模型所有参数的模型配置类。使用配置文件初始化不会加载与模型相关的权重，只会加载配置。请查看 from_pretrained() 方法来加载模型权重。
裸 Flaubert 模型 transformer，输出原始隐藏状态，顶部没有任何特定的头。
该模型继承自 TFPreTrainedModel。请查看超类文档，了解库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、修剪头等）。
该模型也是一个 keras.Model 子类。可以像常规 TF 2.0 Keras 模型一样使用它，并参考 TF 2.0 文档了解所有与一般用法和行为相关的事项。
transformers 中的 TensorFlow 模型和层接受两种输入格式
- 所有输入作为关键字参数（如 PyTorch 模型），或
- 所有输入作为第一个位置参数中的列表、元组或字典。
支持第二种格式的原因是，Keras 方法在将输入传递给模型和层时更喜欢这种格式。由于这种支持，当使用像 `model.fit()` 这样的方法时，事情应该“自然而然”地工作——只需以 `model.fit()` 支持的任何格式传递您的输入和标签即可！但是，如果您想在 Keras 方法（如 `fit()` 和 `predict()`）之外使用第二种格式，例如在使用 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: 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 或 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 数组，形状为(batch_size, sequence_length), 可选) — 与输入并行的标记序列，用于指示输入中每个标记的语言。索引是语言 ID，可以通过使用模型配置中提供的两个转换映射从语言名称中获得（仅适用于多语言模型）。更准确地说，语言名称到语言 ID 的映射在 `model.config.lang2id`（一个字符串到整数的字典）中，而语言 ID 到语言名称 的映射在 `model.config.id2lang`（一个整数到字符串的字典）中。有关用法示例，请参阅多语言文档。
- token_type_ids (
tf.Tensor或Numpy 数组，形状为(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` 的字典，包含模型计算的预计算隐藏状态（注意力块中的键和值）（见下文 `cache` 输出）。可用于加速顺序解码。该字典对象将在前向传播期间就地修改，以添加新计算的隐藏状态。
- head_mask (
Numpy 数组或tf.Tensor，形状为(num_heads,)或(num_layers, num_heads), 可选) — 用于使自注意力模块中选定的头无效的掩码。掩码值在[0, 1]中选择：1表示头未被遮盖，0表示头被遮盖。
- inputs_embeds (
tf.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 模块在训练和评估之间有不同的行为）。
返回
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.Tensorof shape(batch_size, sequence_length, hidden_size)) — 模型最后一层输出的隐藏状态序列。 -
hidden_states (
tuple(tf.FloatTensor), 可选, 当传递 `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 后的注意力权重，用于计算自注意力头中的加权平均值。
TFFlaubertModel 的前向方法，重写了 `__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
< 源代码 >( config *inputs **kwargs )
参数
- config (FlaubertConfig) — 包含模型所有参数的模型配置类。使用配置文件初始化不会加载与模型相关的权重，只会加载配置。请查看 from_pretrained() 方法来加载模型权重。
Flaubert Transformer 模型，其顶部带有一个语言建模头（一个权重与输入嵌入绑定的线性层）。
该模型继承自 TFPreTrainedModel。请查看超类文档，了解库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、修剪头等）。
该模型也是一个 keras.Model 子类。可以像常规 TF 2.0 Keras 模型一样使用它，并参考 TF 2.0 文档了解所有与一般用法和行为相关的事项。
transformers 中的 TensorFlow 模型和层接受两种输入格式
- 所有输入作为关键字参数（如 PyTorch 模型），或
- 所有输入作为第一个位置参数中的列表、元组或字典。
支持第二种格式的原因是，Keras 方法在将输入传递给模型和层时更喜欢这种格式。由于这种支持，当使用像 `model.fit()` 这样的方法时，事情应该“自然而然”地工作——只需以 `model.fit()` 支持的任何格式传递您的输入和标签即可！但是，如果您想在 Keras 方法（如 `fit()` 和 `predict()`）之外使用第二种格式，例如在使用 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: 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 或 tuple(tf.Tensor)
参数
- input_ids (
Numpy array或tf.Tensor，形状为(batch_size, sequence_length)) — 词汇表中输入序列词元的索引。可以使用 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 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]：1表示头未被遮盖，0表示头被遮盖。
- 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。 - training (
bool，可选，默认为False) — 是否在训练模式下使用模型（某些模块，如 dropout 模块，在训练和评估之间的行为不同）。
返回
transformers.models.flaubert.modeling_tf_flaubert.TFFlaubertWithLMHeadModelOutput 或 tuple(tf.Tensor)
一个 transformers.models.flaubert.modeling_tf_flaubert.TFFlaubertWithLMHeadModelOutput 或一个 tf.Tensor 的元组（如果传递了 return_dict=False 或当 config.return_dict=False 时），包含各种元素，具体取决于配置 (FlaubertConfig) 和输入。
-
logits (
tf.Tensorof shape(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` 时返回) — `tf.Tensor` 的元组（每层一个），形状为 `(batch_size, num_heads, sequence_length, sequence_length)`。注意力 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
class transformers.TFFlaubertForSequenceClassification
< 来源 >( config *inputs **kwargs )
参数
- config (FlaubertConfig) — 包含模型所有参数的模型配置类。使用配置文件进行初始化不会加载与模型相关的权重，只会加载配置。请查看 from_pretrained() 方法来加载模型权重。
Flaubert 模型，其顶部带有一个序列分类/回归头（一个在池化输出之上的线性层），例如用于 GLUE 任务。
该模型继承自 TFPreTrainedModel。请查看超类文档，了解库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、修剪头等）。
该模型也是一个 keras.Model 子类。可以像常规 TF 2.0 Keras 模型一样使用它，并参考 TF 2.0 文档了解所有与一般用法和行为相关的事项。
transformers 中的 TensorFlow 模型和层接受两种输入格式
- 所有输入作为关键字参数（如 PyTorch 模型），或
- 所有输入作为第一个位置参数中的列表、元组或字典。
支持第二种格式的原因是，Keras 方法在将输入传递给模型和层时更喜欢这种格式。由于这种支持，当使用像 `model.fit()` 这样的方法时，事情应该“自然而然”地工作——只需以 `model.fit()` 支持的任何格式传递您的输入和标签即可！但是，如果您想在 Keras 方法（如 `fit()` 和 `predict()`）之外使用第二种格式，例如在使用 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 或 tuple(tf.Tensor)
参数
- input_ids (
Numpy array或tf.Tensor，形状为(batch_size, sequence_length)) — 词汇表中输入序列词元的索引。可以使用 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 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]：1表示头未被遮盖，0表示头被遮盖。
- 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。 - 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)
一个 transformers.modeling_tf_outputs.TFSequenceClassifierOutput 或一个 tf.Tensor 的元组（如果传递了 return_dict=False 或当 config.return_dict=False 时），包含各种元素，具体取决于配置 (FlaubertConfig) 和输入。
-
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的元组（一个用于嵌入的输出 + 一个用于每层的输出），形状为(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 后的注意力权重，用于计算自注意力头中的加权平均值。
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
class transformers.TFFlaubertForMultipleChoice
< 来源 >( config *inputs **kwargs )
参数
- config (FlaubertConfig) — 包含模型所有参数的模型配置类。使用配置文件进行初始化不会加载与模型相关的权重，只会加载配置。请查看 from_pretrained() 方法来加载模型权重。
带有多项选择分类头的 Flaubert 模型（在池化输出之上有一个线性层和一个 softmax），例如用于 RocStories/SWAG 任务。
该模型继承自 TFPreTrainedModel。请查看超类文档，了解库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、修剪头等）。
该模型也是一个 keras.Model 子类。可以像常规 TF 2.0 Keras 模型一样使用它，并参考 TF 2.0 文档了解所有与一般用法和行为相关的事项。
transformers 中的 TensorFlow 模型和层接受两种输入格式
- 所有输入作为关键字参数（如 PyTorch 模型），或
- 所有输入作为第一个位置参数中的列表、元组或字典。
支持第二种格式的原因是，Keras 方法在将输入传递给模型和层时更喜欢这种格式。由于这种支持，当使用像 `model.fit()` 这样的方法时，事情应该“自然而然”地工作——只需以 `model.fit()` 支持的任何格式传递您的输入和标签即可！但是，如果您想在 Keras 方法（如 `fit()` 和 `predict()`）之外使用第二种格式，例如在使用 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 或 tuple(tf.Tensor)
参数
- input_ids (
Numpy array或tf.Tensor，形状为(batch_size, sequence_length)) — 词汇表中输入序列词元的索引。可以使用 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 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]：1表示头未被遮盖，0表示头被遮盖。
- inputs_embeds (
tf.Tensor，形状为(batch_size, sequence_length, hidden_size)，可选) — 可选地，你可以选择直接传递嵌入表示，而不是传递input_ids。如果你想比模型内部的嵌入查找矩阵更好地控制如何将input_ids索引转换为相关联的向量，这会很有用。 - output_attentions (
bool, 可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参阅返回张量下的attentions。此参数只能在即时模式（eager mode）下使用，在图模式（graph mode）下将使用配置中的值。 - output_hidden_states (
bool, 可选) — 是否返回所有层的隐藏状态。有关更多详细信息，请参阅返回张量下的hidden_states。此参数只能在即时模式（eager mode）下使用，在图模式（graph mode）下将使用配置中的值。 - return_dict (
bool, 可选) — 是否返回一个 ModelOutput 而不是一个普通的元组。此参数可以在即时模式（eager mode）下使用，在图模式（graph mode）下该值将始终设置为 True。 - training (
bool, 可选, 默认为False) — 是否在训练模式下使用模型（某些模块如 dropout 模块在训练和评估之间有不同的行为）。
返回
transformers.modeling_tf_outputs.TFMultipleChoiceModelOutput 或 tuple(tf.Tensor)
一个 transformers.modeling_tf_outputs.TFMultipleChoiceModelOutput 或一个 tf.Tensor 的元组（如果传递了 return_dict=False 或 config.return_dict=False），包含根据配置（FlaubertConfig）和输入而不同的各种元素。
-
loss (
tf.Tensor，形状为 (batch_size, )，可选，当提供labels时返回) — 分类损失。 -
logits (
tf.Tensor，形状为(batch_size, num_choices)) — 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` 时返回) — `tf.Tensor` 的元组（每层一个），形状为 `(batch_size, num_heads, sequence_length, sequence_length)`。注意力 softmax 后的注意力权重，用于计算自注意力头中的加权平均值。
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
class transformers.TFFlaubertForTokenClassification
< 源代码 >( config *inputs **kwargs )
参数
- config (FlaubertConfig) — 包含模型所有参数的模型配置类。用配置文件初始化并不会加载与模型关联的权重，只会加载配置。请查看 from_pretrained() 方法来加载模型权重。
Flaubert 模型，其顶部带有一个词元分类头（在隐藏状态输出之上加一个线性层），例如用于命名实体识别（NER）任务。
该模型继承自 TFPreTrainedModel。请查看超类文档，了解库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、修剪头等）。
该模型也是一个 keras.Model 子类。可以像常规 TF 2.0 Keras 模型一样使用它，并参考 TF 2.0 文档了解所有与一般用法和行为相关的事项。
transformers 中的 TensorFlow 模型和层接受两种输入格式
- 所有输入作为关键字参数（如 PyTorch 模型），或
- 所有输入作为第一个位置参数中的列表、元组或字典。
支持第二种格式的原因是，Keras 方法在将输入传递给模型和层时更喜欢这种格式。由于这种支持，当使用像 `model.fit()` 这样的方法时，事情应该“自然而然”地工作——只需以 `model.fit()` 支持的任何格式传递您的输入和标签即可！但是，如果您想在 Keras 方法（如 `fit()` 和 `predict()`）之外使用第二种格式，例如在使用 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)) — 词汇表中输入序列词元的索引。可以使用 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 数组，形状为(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的字典，其中包含由模型计算的预计算的隐藏状态（注意力块中的键和值）（见下文cache输出）。可用于加速顺序解码。在前向传播过程中，字典对象将被就地修改以添加新计算的隐藏状态。
- head_mask (
Numpy 数组或tf.Tensor，形状为(num_heads,)或(num_layers, num_heads)，可选) — 用于置零自注意力模块中选定头的掩码。掩码值在[0, 1]中选择：1表示头未被屏蔽，0表示头已被屏蔽。
- inputs_embeds (
tf.Tensor，形状为(batch_size, sequence_length, hidden_size)，可选) — 可选地，你可以选择直接传递嵌入表示，而不是传递input_ids。如果你想比模型内部的嵌入查找矩阵更好地控制如何将input_ids索引转换为相关联的向量，这会很有用。 - output_attentions (
bool, 可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参阅返回张量下的attentions。此参数只能在即时模式（eager mode）下使用，在图模式（graph mode）下将使用配置中的值。 - output_hidden_states (
bool, 可选) — 是否返回所有层的隐藏状态。有关更多详细信息，请参阅返回张量下的hidden_states。此参数只能在即时模式（eager mode）下使用，在图模式（graph mode）下将使用配置中的值。 - return_dict (
bool, 可选) — 是否返回一个 ModelOutput 而不是一个普通的元组。此参数可以在即时模式（eager mode）下使用，在图模式（graph mode）下该值将始终设置为 True。 - training (
bool, 可选, 默认为False) — 是否在训练模式下使用模型（某些模块如 dropout 模块在训练和评估之间有不同的行为）。 - labels (
tf.Tensor，形状为(batch_size, sequence_length)，可选) — 用于计算词元分类损失的标签。索引应在[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，形状为(batch_size, sequence_length, 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` 时返回) — `tf.Tensor` 的元组（每层一个），形状为 `(batch_size, num_heads, sequence_length, sequence_length)`。注意力 softmax 后的注意力权重，用于计算自注意力头中的加权平均值。
TFFlaubertForTokenClassification 的前向方法会覆盖 __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
class transformers.TFFlaubertForQuestionAnsweringSimple
< 源代码 >( config *inputs **kwargs )
参数
- config (FlaubertConfig) — 包含模型所有参数的模型配置类。用配置文件初始化并不会加载与模型关联的权重，只会加载配置。请查看 from_pretrained() 方法来加载模型权重。
Flaubert 模型，顶部带有一个区间分类头，用于像 SQuAD 这样的抽取式问答任务（在隐藏状态输出之上加一个线性层，用于计算 `span start logits` 和 `span end logits`）。
该模型继承自 TFPreTrainedModel。请查看超类文档，了解库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、修剪头等）。
该模型也是一个 keras.Model 子类。可以像常规 TF 2.0 Keras 模型一样使用它，并参考 TF 2.0 文档了解所有与一般用法和行为相关的事项。
transformers 中的 TensorFlow 模型和层接受两种输入格式
- 所有输入作为关键字参数（如 PyTorch 模型），或
- 所有输入作为第一个位置参数中的列表、元组或字典。
支持第二种格式的原因是，Keras 方法在将输入传递给模型和层时更喜欢这种格式。由于这种支持，当使用像 `model.fit()` 这样的方法时，事情应该“自然而然”地工作——只需以 `model.fit()` 支持的任何格式传递您的输入和标签即可！但是，如果您想在 Keras 方法（如 `fit()` 和 `predict()`）之外使用第二种格式，例如在使用 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 数组，形状为(batch_size, sequence_length)，可选) — 一个并行的词元序列，用于指示输入中每个词元的语言。索引是语言 ID，可以通过使用模型配置中提供的两个转换映射从语言名称中获得（仅为多语言模型提供）。更准确地说，语言名称到语言 ID 的映射在model.config.lang2id（这是一个字符串到整数的字典）中，而 语言 ID 到语言名称 的映射在model.config.id2lang（一个整数到字符串的字典）中。请参阅 多语言文档 中详细的使用示例。
- token_type_ids (
tf.Tensor或Numpy 数组，形状为(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的字典，其中包含由模型计算的预计算的隐藏状态（注意力块中的键和值）（见下文cache输出）。可用于加速顺序解码。在前向传播过程中，字典对象将被就地修改以添加新计算的隐藏状态。
- head_mask (
Numpy 数组或tf.Tensor，形状为(num_heads,)或(num_layers, num_heads)，可选) — 用于置零自注意力模块中选定头的掩码。掩码值在[0, 1]中选择：1表示头未被屏蔽，0表示头已被屏蔽。
- inputs_embeds (
tf.Tensor，形状为(batch_size, sequence_length, hidden_size)，可选) — 可选地，你可以选择直接传递嵌入表示，而不是传递input_ids。如果你想比模型内部的嵌入查找矩阵更好地控制如何将input_ids索引转换为相关联的向量，这会很有用。 - output_attentions (
bool, 可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参阅返回张量下的attentions。此参数只能在即时模式（eager mode）下使用，在图模式（graph mode）下将使用配置中的值。 - output_hidden_states (
bool, 可选) — 是否返回所有层的隐藏状态。有关更多详细信息，请参阅返回张量下的hidden_states。此参数只能在即时模式（eager mode）下使用，在图模式（graph mode）下将使用配置中的值。 - return_dict (
bool, 可选) — 是否返回一个 ModelOutput 而不是一个普通的元组。此参数可以在即时模式（eager mode）下使用，在图模式（graph mode）下该值将始终设置为 True。 - training (
bool, 可选, 默认为False) — 是否在训练模式下使用模型（某些模块如 dropout 模块在训练和评估之间有不同的行为）。 - start_positions (
tf.Tensor，形状为(batch_size,)，可选) — 标记区间开始位置（索引）的标签，用于计算词元分类损失。位置被限制在序列长度（sequence_length）之内。序列之外的位置不计入损失计算。 - end_positions (
tf.Tensor，形状为(batch_size,)，可选) — 标记区间结束位置（索引）的标签，用于计算词元分类损失。位置被限制在序列长度（sequence_length）之内。序列之外的位置不计入损失计算。
返回
transformers.modeling_tf_outputs.TFQuestionAnsweringModelOutput 或 tuple(tf.Tensor)
一个 transformers.modeling_tf_outputs.TFQuestionAnsweringModelOutput 或一个 tf.Tensor 的元组（如果传递了 return_dict=False 或 config.return_dict=False），包含根据配置（FlaubertConfig）和输入而不同的各种元素。
-
loss (
tf.Tensor，形状为(batch_size, )，可选，当提供了start_positions和end_positions时返回) — 总的区间提取损失是开始和结束位置的交叉熵之和。 -
start_logits (形状为
(batch_size, sequence_length)的tf.Tensor) — 跨度起始分数（SoftMax 之前）。 -
end_logits (形状为
(batch_size, sequence_length)的tf.Tensor) — 跨度结束分数（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` 时返回) — `tf.Tensor` 的元组（每层一个），形状为 `(batch_size, num_heads, sequence_length, sequence_length)`。注意力 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]