Transformers 文档
XLM
并获得增强的文档体验
开始使用
XLM
概述
XLM 模型由 Guillaume Lample 和 Alexis Conneau 在Cross-lingual Language Model Pretraining中提出。它是一个使用以下目标之一进行预训练的 Transformer 模型：
- 因果语言建模 (CLM) 目标（下一个 token 预测），
- 掩码语言建模 (MLM) 目标（类似 BERT），或
- 翻译语言建模 (TLM) 对象（BERT 的 MLM 扩展到多语言输入）
该论文的摘要如下：
最近的研究表明，生成式预训练对于英语自然语言理解的效率很高。在这项工作中，我们将这种方法扩展到多种语言，并展示了跨语言预训练的有效性。我们提出了两种学习跨语言语言模型 (XLM) 的方法：一种是无监督的，仅依赖于单语数据；另一种是有监督的，利用并行数据和一个新的跨语言语言模型目标。我们在跨语言分类、无监督和有监督机器翻译方面取得了最先进的结果。在 XNLI 上，我们的方法将最先进水平绝对提高了 4.9% 的准确率。在无监督机器翻译方面，我们在 WMT'16 德语-英语上获得了 34.3 BLEU，比之前的最先进水平提高了 9 个 BLEU 以上。在有监督机器翻译方面，我们在 WMT'16 罗马尼亚语-英语上获得了 38.5 BLEU 的新最先进水平，比之前的最佳方法高出 4 个 BLEU 以上。我们的代码和预训练模型将公开提供。
使用技巧
XLM 有许多不同的检查点，这些检查点是使用不同的目标训练的：CLM、MLM 或 TLM。请确保为您的任务选择正确的目标（例如，MLM 检查点不适合生成）。
XLM 具有利用特定
lang参数的多语言检查点。请查看多语言页面以获取更多信息。一个在多种语言上训练的 Transformer 模型。此模型有三种不同的训练类型，库为所有类型都提供了检查点。
- 因果语言建模 (CLM)，这是传统的自回归训练（因此此模型也可以放在上一节中）。每训练样本选择一种语言，模型输入是一个 256 个 token 的句子，该句子可能跨越这些语言之一的多个文档。
- 掩码语言建模 (MLM)，类似于 RoBERTa。每训练样本选择一种语言，模型输入是一个 256 个 token 的句子，该句子可能跨越这些语言之一的多个文档，并动态掩码 token。
- MLM 和翻译语言建模 (TLM) 的组合。这包括连接两种不同语言的句子，并进行随机掩码。为了预测其中一个被掩码的 token，模型可以使用语言 1 中的周围上下文和语言 2 提供的上下文。
资源
XLMConfig
class transformers.XLMConfig
< source >( 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 )
参数
- vocab_size (
int, 可选, 默认为 30145) — BERT 模型的词汇表大小。定义了在调用 XLMModel 或 TFXLMModel 时，可以通过inputs_ids传递的不同 token 的数量。 - 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) — 是否对预测层使用自适应 Log 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, optional, defaults to 0) — 词汇表中句子起始标记的索引（默认为 0，可选）。 - eos_index (
int, optional, defaults to 1) — 词汇表中句子结束标记的索引（默认为 1，可选）。 - pad_index (
int, optional, defaults to 2) — 词汇表中填充标记的索引（默认为 2，可选）。 - unk_index (
int, optional, defaults to 3) — 词汇表中未知标记的索引（默认为 3，可选）。 - mask_index (
int, optional, defaults to 5) — 词汇表中掩码标记的索引（默认为 5，可选）。 - is_encoder(
bool, optional, defaults toTrue) — 指示初始化的模型是否应为 Vaswani 等人提出的 Transformer 编码器或解码器（默认为True，可选）。 - summary_type (
string, optional, defaults to “first”) — 用于序列摘要的参数。用于序列分类和多项选择模型中。（默认为 “first”，可选）。必须是以下选项之一：
"last": 采用最后一个标记的隐藏状态（如 XLNet）。"first": 采用第一个标记的隐藏状态（如 BERT）。"mean": 采用所有标记隐藏状态的均值。"cls_index": 提供分类标记位置的张量（如 GPT/GPT-2）。"attn": 暂未实现，请使用多头注意力机制。
- summary_use_proj (
bool, optional, defaults toTrue) — 用于序列摘要的参数。用于序列分类和多项选择模型中。（默认为True，可选）。是否在向量提取后添加一个投影层。
- summary_activation (
str, optional) — 用于序列摘要的参数。用于序列分类和多项选择模型中。（可选）。传入
"tanh"将对输出应用 tanh 激活函数，任何其他值将导致不进行激活。 - summary_proj_to_labels (
bool, optional, defaults toTrue) — 用于序列分类和多项选择模型中。（默认为True，可选）。投影输出应具有
config.num_labels或config.hidden_size类。 - summary_first_dropout (
float, optional, defaults to 0.1) — 用于序列分类和多项选择模型中。（默认为 0.1，可选）。投影和激活后要使用的 dropout 比率。
- start_n_top (
int, optional, defaults to 5) — 用于 SQuAD 评估脚本中。（默认为 5，可选）。 - end_n_top (
int, optional, defaults to 5) — 用于 SQuAD 评估脚本中。（默认为 5，可选）。 - mask_token_id (
int, optional, defaults to 0) — 模型不可知的参数，用于在 MLM 上下文中生成文本时识别掩码标记（默认为 0，可选）。 - lang_id (
int, optional, defaults to 1) — 模型使用的语言 ID（默认为 1，可选）。此参数用于生成给定语言的文本。
这是用于存储 XLMModel 或 TFXLMModel 配置的配置类。它用于根据指定的参数实例化 XLM 模型，定义模型架构。使用默认值实例化配置将产生与 FacebookAI/xlm-mlm-en-2048 架构类似的配置。
配置对象继承自 PretrainedConfig，可用于控制模型输出。有关更多信息，请阅读 PretrainedConfig 中的文档。
示例
>>> from transformers import XLMConfig, XLMModel
>>> # Initializing a XLM configuration
>>> configuration = XLMConfig()
>>> # Initializing a model (with random weights) from the configuration
>>> model = XLMModel(configuration)
>>> # Accessing the model configuration
>>> configuration = model.configXLMTokenizer
class transformers.XLMTokenizer
< source >( vocab_file merges_file 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 do_lowercase_and_remove_accent = True **kwargs )
参数
- vocab_file (
str) — 词汇表文件。 - merges_file (
str) — 合并文件。 - unk_token (
str, optional, defaults to"<unk>") — 未知标记（默认为"<unk>"，可选）。词汇表中没有的标记无法转换为 ID，而是设置为此标记。 - bos_token (
str, optional, defaults to"<s>") — 序列起始标记（默认为"<s>"，可选），在预训练期间使用。可以用作序列分类器标记。当使用特殊标记构建序列时，这不是用于序列起始的标记。使用的标记是
cls_token。 - sep_token (
str, optional, defaults to"</s>") — 分隔符标记（默认为"</s>"，可选），用于从多个序列构建序列时，例如用于序列分类的两个序列或用于问答的文本和问题。它也用作使用特殊标记构建的序列的最后一个标记。 - pad_token (
str, optional, defaults to"<pad>") — 填充标记（默认为"<pad>"，可选），例如在对不同长度的序列进行批处理时使用。 - cls_token (
str, optional, defaults to"</s>") — 分类器标记（默认为"</s>"，可选），用于进行序列分类（对整个序列而不是每个标记进行分类）。当使用特殊标记构建序列时，它是序列的第一个标记。 - mask_token (
str, optional, defaults to"<special1>") — 掩码值标记（默认为"<special1>"，可选）。这是使用掩码语言建模训练此模型时使用的标记。这是模型将尝试预测的标记。 - additional_special_tokens (
List[str], optional, defaults to['<special0>', '<special1>', '<special2>', '<special3>', '<special4>', '<special5>', '<special6>', '<special7>', '<special8>', '<special9>']) — 附加特殊标记列表（默认为['<special0>', '<special1>', '<special2>', '<special3>', '<special4>', '<special5>', '<special6>', '<special7>', '<special8>', '<special9>']，可选）。 - lang2id (
Dict[str, int], 可选) — 语言字符串标识符到其 ID 的字典。 - id2lang (
Dict[int, str], 可选) — 语言 ID 到其字符串标识符的字典。 - do_lowercase_and_remove_accent (
bool, 可选, 默认为True) — 是否在分词时转换为小写并移除重音符号。
构建 XLM 分词器。基于字节对编码。分词过程如下：
- 对大多数支持的语言使用 Moses 预处理和分词。
- 对中文（Jieba）、日文（KyTea）和泰文（PyThaiNLP）使用特定于语言的分词。
- 可选地将所有输入文本转换为小写并进行规范化。
- 参数
special_tokens和函数set_special_tokens可用于向词汇表添加其他符号（如“classify”）。 lang2id属性将模型支持的语言及其 ID 映射在一起（如果提供，则会自动为预训练词汇表设置）。- 如果提供
id2lang属性，则执行反向映射（会自动为预训练词汇表设置）。
此分词器继承自 PreTrainedTokenizer，其中包含大多数主要方法。用户应参考此超类以获取有关这些方法的更多信息。
build_inputs_with_special_tokens
< source >( token_ids_0: typing.List[int] token_ids_1: typing.Optional[typing.List[int]] = None ) → List[int]
通过连接并添加特殊 token，从序列或序列对构建模型输入，用于序列分类任务。 XLM 序列具有以下格式：
- 单序列：
<s> X </s> - 序列对：
<s> A </s> B </s>
get_special_tokens_mask
< source >( token_ids_0: typing.List[int] token_ids_1: typing.Optional[typing.List[int]] = None already_has_special_tokens: bool = False ) → List[int]
从没有添加特殊 token 的 token 列表中检索序列 ID。当使用分词器的 prepare_for_model 方法添加特殊 token 时，将调用此方法。
create_token_type_ids_from_sequences
< source >( token_ids_0: typing.List[int] token_ids_1: typing.Optional[typing.List[int]] = None ) → List[int]
从传递的两个序列创建一个 mask，用于序列对分类任务。 XLM 序列
如果 token_ids_1 为 None，则此方法仅返回 mask 的第一部分 (0s)。
XLM 特定输出
class transformers.models.xlm.modeling_xlm.XLMForQuestionAnsweringOutput
< source >( loss: typing.Optional[torch.FloatTensor] = None start_top_log_probs: typing.Optional[torch.FloatTensor] = None start_top_index: typing.Optional[torch.LongTensor] = None end_top_log_probs: typing.Optional[torch.FloatTensor] = None end_top_index: typing.Optional[torch.LongTensor] = None cls_logits: typing.Optional[torch.FloatTensor] = None hidden_states: typing.Optional[typing.Tuple[torch.FloatTensor, ...]] = None attentions: typing.Optional[typing.Tuple[torch.FloatTensor, ...]] = None )
参数
- loss (形状为
(1,)的torch.FloatTensor，可选，如果提供了start_positions和end_positions则返回) — 分类损失，为起始 token、结束 token（以及如果提供，则为 is_impossible）分类损失的总和。 - start_top_log_probs (形状为
(batch_size, config.start_n_top)的torch.FloatTensor，可选，如果未提供start_positions或end_positions则返回) — 前 config.start_n_top 个起始 token 可能性的对数概率（束搜索）。 - start_top_index (形状为
(batch_size, config.start_n_top)的torch.LongTensor，可选，如果未提供start_positions或end_positions则返回) — 前 config.start_n_top 个起始 token 可能性的索引（束搜索）。 - end_top_log_probs (形状为
(batch_size, config.start_n_top * config.end_n_top)的torch.FloatTensor，可选，如果未提供start_positions或end_positions则返回) — 前config.start_n_top * config.end_n_top个结束 token 可能性的对数概率（束搜索）。 - end_top_index (形状为
(batch_size, config.start_n_top * config.end_n_top)的torch.LongTensor，可选，如果未提供start_positions或end_positions则返回) — 前config.start_n_top * config.end_n_top个结束 token 可能性的索引（束搜索）。 - cls_logits (形状为
(batch_size,)的torch.FloatTensor，可选，如果未提供start_positions或end_positions则返回) — 答案的is_impossible标签的对数概率。 - hidden_states (
tuple(torch.FloatTensor), 可选的, 当传递output_hidden_states=True或当config.output_hidden_states=True时返回) — 形状为(batch_size, sequence_length, hidden_size)的torch.FloatTensor元组（每个层的输出一个，加上嵌入层的输出一个）。模型在每一层输出端的隐藏状态，加上初始嵌入输出。
- attentions (
tuple(torch.FloatTensor), 可选的, 当传递output_attentions=True或当config.output_attentions=True时返回) — 形状为(batch_size, num_heads, sequence_length, sequence_length)的torch.FloatTensor元组（每层一个）。注意力 softmax 后的注意力权重，用于计算自注意力头中的加权平均值。
使用 SquadHead 的问答模型输出的基类。
XLMModel
class transformers.XLMModel
< 源代码 >( config )
参数
- config (XLMConfig) — 包含模型所有参数的模型配置类。使用配置文件初始化不会加载与模型关联的权重，只会加载配置。查看 from_pretrained() 方法来加载模型权重。
裸 XLM 模型 Transformer，输出原始隐藏状态，顶部没有任何特定的 head。
此模型继承自 PreTrainedModel。查看超类文档，了解库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、剪枝 head 等）。
此模型也是 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[typing.Dict[str, torch.Tensor]] = None head_mask: typing.Optional[torch.Tensor] = None inputs_embeds: typing.Optional[torch.Tensor] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None **kwargs ) → transformers.modeling_outputs.BaseModelOutput 或 tuple(torch.FloatTensor)
参数
- input_ids (形状为
(batch_size, sequence_length)的torch.LongTensor) — 词汇表中输入序列 tokens 的索引。索引可以使用 AutoTokenizer 获取。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (形状为
(batch_size, sequence_length)的torch.FloatTensor, 可选的) — 用于避免对 padding token 索引执行 attention 的 Mask。Mask 值在[0, 1]中选择：- 1 表示 未被 mask 的 tokens，
- 0 表示 被 mask 的 tokens。
- langs (形状为
(batch_size, sequence_length)的torch.LongTensor, 可选的) — 用于指示输入中每个 token 的语言的并行 token 序列。索引是语言 ID，可以使用模型配置中提供的两个转换映射从语言名称中获得（仅适用于多语言模型）。更准确地说，语言名称到语言 ID 的映射在model.config.lang2id中（这是一个从字符串到整数的字典），而 语言 ID 到语言名称 的映射在model.config.id2lang中（字典从整数到字符串）。有关详细用法示例，请参阅 多语言文档。
- token_type_ids (形状为
(batch_size, sequence_length)的torch.LongTensor, 可选的) — 用于指示输入的第一部分和第二部分的片段 token 索引。索引在[0, 1]中选择：- 0 对应于 句子 A token，
- 1 对应于 句子 B token。
- position_ids (形状为
(batch_size, sequence_length)的torch.LongTensor, 可选的) — 位置嵌入中每个输入序列 tokens 的位置索引。在范围[0, config.max_position_embeddings - 1]中选择。 - lengths (形状为
(batch_size,)的torch.LongTensor, 可选的) — 每个句子的长度，可用于避免对 padding token 索引执行 attention。您也可以使用 attention_mask 获得相同的结果（见上文），此处保留是为了兼容性。索引在[0, ..., input_ids.size(-1)]中选择。 - cache (
Dict[str, torch.FloatTensor], 可选的) — 字符串到torch.FloatTensor的字典，其中包含模型计算的预计算隐藏状态（attention 模块中的键和值）（请参阅下面的cache输出）。可用于加速顺序解码。字典对象将在前向传递期间就地修改，以添加新计算的隐藏状态。
- head_mask (形状为
(num_heads,)或(num_layers, num_heads)的torch.FloatTensor, 可选的) — 用于 nullify self-attention 模块的选定 head 的 Mask。Mask 值在[0, 1]中选择：- 1 表示 head 未被 mask，
- 0 表示 head 被 mask。
- inputs_embeds (形状为
(batch_size, sequence_length, hidden_size)的torch.FloatTensor, 可选的) — 可选地，您可以选择直接传递嵌入表示，而不是传递input_ids。如果您希望比模型的内部嵌入查找矩阵更好地控制如何将input_ids索引转换为关联的向量，这将非常有用。 - output_attentions (
bool, 可选的) — 是否返回所有 attention 层的 attentions 张量。 有关更多详细信息，请参见返回的 tensors 下的attentions。 - output_hidden_states (
bool, 可选的) — 是否返回所有层的隐藏状态。 有关更多详细信息，请参见返回的 tensors 下的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 时），包含各种元素，具体取决于配置 (XLMConfig) 和输入。
-
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时返回) — 形状为(batch_size, sequence_length, hidden_size)的torch.FloatTensor元组（对于嵌入的输出，如果模型具有嵌入层，则为一个；对于每一层的输出，则为一个）。模型在每一层输出端的隐藏状态，加上可选的初始嵌入输出。
-
attentions (
tuple(torch.FloatTensor), 可选的, 当传递output_attentions=True或当config.output_attentions=True时返回) — 形状为(batch_size, num_heads, sequence_length, sequence_length)的torch.FloatTensor元组（每层一个）。注意力 softmax 后的注意力权重，用于计算自注意力头中的加权平均值。
XLMModel forward 方法，覆盖了 __call__ 特殊方法。
尽管 forward 传递的配方需要在该函数中定义，但之后应调用 Module 实例而不是此函数，因为前者负责运行预处理和后处理步骤，而后者会静默地忽略它们。
示例
>>> from transformers import AutoTokenizer, XLMModel
>>> import torch
>>> tokenizer = AutoTokenizer.from_pretrained("FacebookAI/xlm-mlm-en-2048")
>>> model = XLMModel.from_pretrained("FacebookAI/xlm-mlm-en-2048")
>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="pt")
>>> outputs = model(**inputs)
>>> last_hidden_states = outputs.last_hidden_stateXLMWithLMHeadModel
class transformers.XLMWithLMHeadModel
< 源代码 >( config )
参数
- config (XLMConfig) — 包含模型所有参数的模型配置类。使用配置文件初始化不会加载与模型相关的权重，仅加载配置。请查看 from_pretrained() 方法来加载模型权重。
XLM 模型 Transformer，顶部带有一个语言建模头（线性层，其权重与输入嵌入层绑定）。
此模型继承自 PreTrainedModel。查看超类文档，了解库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、剪枝 head 等）。
此模型也是 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[typing.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 **kwargs ) → transformers.modeling_outputs.MaskedLMOutput 或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensor，形状为(batch_size, sequence_length)) — 词汇表中输入序列 tokens 的索引。可以使用 AutoTokenizer 获取索引。 有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
torch.FloatTensor，形状为(batch_size, sequence_length)，可选) — 用于避免在 padding token 索引上执行 attention 的 Mask。Mask 值在[0, 1]中选择：- 1 表示 未被 Mask 的 tokens，
- 0 表示 已被 Mask 的 tokens。
- langs (
torch.LongTensor，形状为(batch_size, sequence_length)，可选) — 一个并行的 tokens 序列，用于指示输入中每个 token 的语言。索引是语言 ID，可以通过使用模型配置中提供的两个转换映射从语言名称中获得（仅为多语言模型提供）。更准确地说，语言名称到语言 ID 的映射在model.config.lang2id中（这是一个字符串到 int 的字典），而语言 ID 到语言名称 的映射在model.config.id2lang中（int 到字符串的字典）。请参阅 多语言文档 中详细的使用示例。
- token_type_ids (
torch.LongTensor，形状为(batch_size, sequence_length)，可选) — Segment token 索引，用于指示输入的第一部分和第二部分。索引在[0, 1]中选择：- 0 对应于 sentence A token，
- 1 对应于 sentence B token。
- position_ids (
torch.LongTensor，形状为(batch_size, sequence_length)，可选) — 位置嵌入中每个输入序列 token 的位置索引。在范围[0, config.max_position_embeddings - 1]中选择。 - lengths (
torch.LongTensor，形状为(batch_size,)，可选) — 可以用于避免在 padding token 索引上执行 attention 的每个句子的长度。您也可以使用 attention_mask 来获得相同的结果（见上文），此处保留是为了兼容性。索引在[0, ..., input_ids.size(-1)]中选择。 - cache (
Dict[str, torch.FloatTensor]，可选) — 字符串到torch.FloatTensor的字典，其中包含模型计算的预计算隐藏状态（attention 模块中的键和值）（请参阅下面的cache输出）。可用于加速顺序解码。字典对象将在前向传递期间就地修改，以添加新计算的隐藏状态。
- head_mask (
torch.FloatTensor，形状为(num_heads,)或(num_layers, num_heads)，可选) — 用于 nullify self-attention 模块的选定 heads 的 Mask。Mask 值在[0, 1]中选择：- 1 表示 head 未被 Mask，
- 0 表示 head 已被 Mask。
- inputs_embeds (
torch.FloatTensor，形状为(batch_size, sequence_length, hidden_size)，可选) — （可选）您可以选择直接传递嵌入表示，而不是传递input_ids。如果您希望比模型的内部嵌入查找矩阵更精细地控制如何将input_ids索引转换为关联的向量，这将非常有用。 - output_attentions (
bool，可选) — 是否返回所有 attention 层的 attentions tensors。 有关更多详细信息，请参阅返回 tensors 下的attentions。 - output_hidden_states (
bool，可选) — 是否返回所有层的隐藏状态。 有关更多详细信息，请参阅返回 tensors 下的hidden_states。 - return_dict (
bool，可选) — 是否返回 ModelOutput 而不是普通元组。 - labels (
torch.LongTensor，形状为(batch_size, sequence_length)，可选) — 语言建模的标签。 请注意，标签在模型内部已移位，即您可以设置labels = input_ids索引在[-100, 0, ..., config.vocab_size]中选择。 所有设置为-100的标签都将被忽略（masked），损失仅针对[0, ..., config.vocab_size]中的标签计算。
返回值
transformers.modeling_outputs.MaskedLMOutput 或 tuple(torch.FloatTensor)
一个 transformers.modeling_outputs.MaskedLMOutput 或一个 torch.FloatTensor 元组 (如果传递了 return_dict=False 或当 config.return_dict=False 时)，包含各种元素，具体取决于配置 (XLMConfig) 和输入。
-
loss (
torch.FloatTensor，形状为(1,)，可选，当提供labels时返回) — Masked 语言建模 (MLM) 损失。 -
logits (
torch.FloatTensor，形状为(batch_size, sequence_length, config.vocab_size)) — 语言建模头的预测分数（SoftMax 之前每个词汇表 token 的分数）。 -
hidden_states (
tuple(torch.FloatTensor), 可选的, 当传递output_hidden_states=True或当config.output_hidden_states=True时返回) — 形状为(batch_size, sequence_length, hidden_size)的torch.FloatTensor元组（对于嵌入的输出，如果模型具有嵌入层，则为一个；对于每一层的输出，则为一个）。模型在每一层输出端的隐藏状态，加上可选的初始嵌入输出。
-
attentions (
tuple(torch.FloatTensor), 可选的, 当传递output_attentions=True或当config.output_attentions=True时返回) — 形状为(batch_size, num_heads, sequence_length, sequence_length)的torch.FloatTensor元组（每层一个）。注意力 softmax 后的注意力权重，用于计算自注意力头中的加权平均值。
XLMWithLMHeadModel 前向方法，覆盖了 __call__ 特殊方法。
尽管 forward 传递的配方需要在该函数中定义，但之后应调用 Module 实例而不是此函数，因为前者负责运行预处理和后处理步骤，而后者会静默地忽略它们。
示例
>>> from transformers import AutoTokenizer, XLMWithLMHeadModel
>>> import torch
>>> tokenizer = AutoTokenizer.from_pretrained("FacebookAI/xlm-mlm-en-2048")
>>> model = XLMWithLMHeadModel.from_pretrained("FacebookAI/xlm-mlm-en-2048")
>>> 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)XLMForSequenceClassification
class transformers.XLMForSequenceClassification
< source >( config )
参数
- config (XLMConfig) — 包含模型所有参数的模型配置类。使用配置文件初始化不会加载与模型相关的权重，仅加载配置。请查看 from_pretrained() 方法来加载模型权重。
XLM 模型，顶部带有一个序列分类/回归头（池化输出顶部的线性层），例如用于 GLUE 任务。
此模型继承自 PreTrainedModel。查看超类文档，了解库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、剪枝 head 等）。
此模型也是 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[typing.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.LongTensor，形状为(batch_size, sequence_length)) — 词汇表中输入序列 tokens 的索引。索引可以通过 AutoTokenizer 获得。 参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call() 以了解详细信息。
- attention_mask (
torch.FloatTensor，形状为(batch_size, sequence_length)，可选) — 掩码，用于避免在 padding token 索引上执行 attention。 掩码值在[0, 1]中选择：- 1 表示 tokens 未被掩码，
- 0 表示 tokens 被掩码。
- langs (
torch.LongTensor，形状为(batch_size, sequence_length)，可选) — 一个并行的 tokens 序列，用于指示输入中每个 token 的语言。 索引是语言 ID，可以通过模型配置中提供的两个转换映射，从语言名称获得（仅为多语言模型提供）。 更准确地说，语言名称到语言 ID 的映射在model.config.lang2id中（这是一个字符串到 int 的字典），语言 ID 到语言名称 的映射在model.config.id2lang中（int 到字符串的字典）。参阅 多语言文档 中详述的使用示例。
- token_type_ids (
torch.LongTensor，形状为(batch_size, sequence_length)，可选) — Segment token 索引，用于指示输入的第一部分和第二部分。 索引在[0, 1]中选择：- 0 对应于 句子 A token，
- 1 对应于 句子 B token。
- position_ids (
torch.LongTensor，形状为(batch_size, sequence_length)，可选) — 每个输入序列 tokens 在 position embeddings 中的位置索引。 在范围[0, config.max_position_embeddings - 1]中选择。 - lengths (
torch.LongTensor，形状为(batch_size,)，可选) — 每个句子的长度，可用于避免在 padding token 索引上执行 attention。 您也可以使用 attention_mask 达到相同的结果（见上文），此处保留是为了兼容性。 索引在[0, ..., input_ids.size(-1)]中选择。 - cache (
Dict[str, torch.FloatTensor]，可选) — 字符串到torch.FloatTensor的字典，其中包含模型计算的预计算隐藏状态（attention 块中的键和值）（参阅下面的cache输出）。 可用于加速顺序解码。字典对象将在前向传播过程中被就地修改，以添加新计算的隐藏状态。
- head_mask (
torch.FloatTensor，形状为(num_heads,)或(num_layers, num_heads)，可选) — 掩码，用于 nullify self-attention 模块的选定 heads。 掩码值在[0, 1]中选择：- 1 表示 head 未被掩码，
- 0 表示 head 被掩码。
- inputs_embeds (
torch.FloatTensor，形状为(batch_size, sequence_length, hidden_size)，可选) — （可选）您可以选择直接传递嵌入表示，而不是传递input_ids。 如果您希望比模型的内部嵌入查找矩阵更精细地控制如何将input_ids索引转换为关联的向量，这将非常有用。 - output_attentions (
bool，可选) — 是否返回所有 attention 层的 attentions tensors。 有关更多详细信息，请参阅返回的 tensors 下的attentions。 - output_hidden_states (
bool，可选) — 是否返回所有层的 hidden states。 有关更多详细信息，请参阅返回的 tensors 下的hidden_states。 - return_dict (
bool，可选) — 是否返回 ModelOutput 而不是普通 tuple。 - labels (
torch.LongTensor，形状为(batch_size,)，可选) — 用于计算序列分类/回归损失的标签。 索引应在[0, ..., config.num_labels - 1]中。 如果config.num_labels == 1，则计算回归损失（均方误差损失）；如果config.num_labels > 1，则计算分类损失（交叉熵损失）。
返回值
transformers.modeling_outputs.SequenceClassifierOutput 或 tuple(torch.FloatTensor)
一个 transformers.modeling_outputs.SequenceClassifierOutput 或一个 torch.FloatTensor 的 tuple（如果传递了 return_dict=False 或当 config.return_dict=False 时），包括各种元素，具体取决于配置 (XLMConfig) 和输入。
-
loss (
torch.FloatTensor，形状为(1,)，可选，当提供labels时返回) — 分类（或回归，如果 config.num_labels==1）损失。 -
logits (
torch.FloatTensor，形状为(batch_size, config.num_labels)) — 分类（或回归，如果 config.num_labels==1）得分（在 SoftMax 之前）。 -
hidden_states (
tuple(torch.FloatTensor), 可选的, 当传递output_hidden_states=True或当config.output_hidden_states=True时返回) — 形状为(batch_size, sequence_length, hidden_size)的torch.FloatTensor元组（对于嵌入的输出，如果模型具有嵌入层，则为一个；对于每一层的输出，则为一个）。模型在每一层输出端的隐藏状态，加上可选的初始嵌入输出。
-
attentions (
tuple(torch.FloatTensor), 可选的, 当传递output_attentions=True或当config.output_attentions=True时返回) — 形状为(batch_size, num_heads, sequence_length, sequence_length)的torch.FloatTensor元组（每层一个）。注意力 softmax 后的注意力权重，用于计算自注意力头中的加权平均值。
XLMForSequenceClassification 前向传播方法，覆盖了 __call__ 特殊方法。
尽管 forward 传递的配方需要在该函数中定义，但之后应调用 Module 实例而不是此函数，因为前者负责运行预处理和后处理步骤，而后者会静默地忽略它们。
单标签分类示例
>>> import torch
>>> from transformers import AutoTokenizer, XLMForSequenceClassification
>>> tokenizer = AutoTokenizer.from_pretrained("FacebookAI/xlm-mlm-en-2048")
>>> model = XLMForSequenceClassification.from_pretrained("FacebookAI/xlm-mlm-en-2048")
>>> 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 = XLMForSequenceClassification.from_pretrained("FacebookAI/xlm-mlm-en-2048", num_labels=num_labels)
>>> labels = torch.tensor([1])
>>> loss = model(**inputs, labels=labels).loss多标签分类示例
>>> import torch
>>> from transformers import AutoTokenizer, XLMForSequenceClassification
>>> tokenizer = AutoTokenizer.from_pretrained("FacebookAI/xlm-mlm-en-2048")
>>> model = XLMForSequenceClassification.from_pretrained("FacebookAI/xlm-mlm-en-2048", 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 = XLMForSequenceClassification.from_pretrained(
... "FacebookAI/xlm-mlm-en-2048", 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).lossXLMForMultipleChoice
class transformers.XLMForMultipleChoice
< source >( config *inputs **kwargs )
参数
- config (XLMConfig) — 模型配置类，包含模型的所有参数。 使用配置文件初始化不会加载与模型关联的权重，仅加载配置。 查看 from_pretrained() 方法以加载模型权重。
XLM 模型，顶部带有一个多项选择分类 head（池化输出顶部的线性层和一个 softmax），例如用于 RocStories/SWAG 任务。
此模型继承自 PreTrainedModel。查看超类文档，了解库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、剪枝 head 等）。
此模型也是 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[typing.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)) — 词汇表中输入序列 tokens 的索引。索引可以通过 AutoTokenizer 获得。 参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call() 以了解详细信息。
- attention_mask (
torch.FloatTensor，形状为(batch_size, num_choices, sequence_length)，可选) — 掩码，用于避免在 padding token 索引上执行 attention。 掩码值在[0, 1]中选择：- 1 表示 tokens 未被掩码，
- 0 表示 tokens 被掩码。
- langs (
torch.LongTensor，形状为(batch_size, num_choices, sequence_length)，可选) — 一个并行的 tokens 序列，用于指示输入中每个 token 的语言。 索引是语言 ID，可以通过模型配置中提供的两个转换映射，从语言名称获得（仅为多语言模型提供）。 更准确地说，语言名称到语言 ID 的映射在model.config.lang2id中（这是一个字符串到 int 的字典），语言 ID 到语言名称 的映射在model.config.id2lang中（int 到字符串的字典）。参阅 多语言文档 中详述的使用示例。
- token_type_ids (
torch.LongTensor，形状为(batch_size, num_choices, sequence_length)，可选) — Segment token 索引，用于指示输入的第一部分和第二部分。 索引在[0, 1]中选择：- 0 对应于 句子 A token，
- 1 对应于 句子 B token。
- 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.FloatTensor，形状为(num_heads,)或(num_layers, num_heads)，可选) — 用于 nullify 自注意力模块中选定头的掩码。掩码值在[0, 1]中选择：- 1 表示头是未被掩蔽的，
- 0 表示头是被掩蔽的。
- inputs_embeds (
torch.FloatTensor，形状为(batch_size, num_choices, sequence_length, hidden_size)，可选) — （可选）您可以选择直接传递嵌入表示，而不是传递input_ids。如果您希望比模型的内部嵌入查找矩阵更精细地控制如何将input_ids索引转换为关联向量，这将非常有用。 - output_attentions (
bool，可选) — 是否返回所有注意力层的注意力张量。 有关更多详细信息，请参见返回张量下的attentions。 - output_hidden_states (
bool，可选) — 是否返回所有层的隐藏状态。 有关更多详细信息，请参见返回张量下的hidden_states。 - return_dict (
bool，可选) — 是否返回 ModelOutput 而不是普通元组。 - labels (
torch.LongTensor，形状为(batch_size,)，可选) — 用于计算多项选择分类损失的标签。索引应在[0, ..., num_choices-1]中，其中num_choices是输入张量的第二个维度的大小。（请参阅上面的input_ids）
返回值
transformers.modeling_outputs.MultipleChoiceModelOutput 或 tuple(torch.FloatTensor)
一个 transformers.modeling_outputs.MultipleChoiceModelOutput 或一个 torch.FloatTensor 元组（如果传递了 return_dict=False 或当 config.return_dict=False 时），包含各种元素，具体取决于配置 (XLMConfig) 和输入。
-
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时返回) — 形状为(batch_size, sequence_length, hidden_size)的torch.FloatTensor元组（对于嵌入的输出，如果模型具有嵌入层，则为一个；对于每一层的输出，则为一个）。模型在每一层输出端的隐藏状态，加上可选的初始嵌入输出。
-
attentions (
tuple(torch.FloatTensor), 可选的, 当传递output_attentions=True或当config.output_attentions=True时返回) — 形状为(batch_size, num_heads, sequence_length, sequence_length)的torch.FloatTensor元组（每层一个）。注意力 softmax 后的注意力权重，用于计算自注意力头中的加权平均值。
XLMForMultipleChoice 前向方法，覆盖了 __call__ 特殊方法。
尽管 forward 传递的配方需要在该函数中定义，但之后应调用 Module 实例而不是此函数，因为前者负责运行预处理和后处理步骤，而后者会静默地忽略它们。
示例
>>> from transformers import AutoTokenizer, XLMForMultipleChoice
>>> import torch
>>> tokenizer = AutoTokenizer.from_pretrained("FacebookAI/xlm-mlm-en-2048")
>>> model = XLMForMultipleChoice.from_pretrained("FacebookAI/xlm-mlm-en-2048")
>>> 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.logitsXLMForTokenClassification
class transformers.XLMForTokenClassification
< source >( config )
参数
- config (XLMConfig) — 模型配置类，包含模型的所有参数。使用配置文件初始化不会加载与模型关联的权重，仅加载配置。查看 from_pretrained() 方法以加载模型权重。
XLM 模型，顶部带有标记分类头（隐藏状态输出顶部的线性层），例如，用于命名实体识别 (NER) 任务。
此模型继承自 PreTrainedModel。查看超类文档，了解库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、剪枝 head 等）。
此模型也是 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[typing.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.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中（这是一个字符串到 int 的字典），而语言 ID 到语言名称 映射在model.config.id2lang中（int 到字符串的字典）。请参阅 多语言文档 中详述的用法示例。
- 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)，可选) — 用于 nullify 自注意力模块中选定头的掩码。掩码值在[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, optional) — 是否返回所有层的隐藏状态。 更多细节请查看返回张量下的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 or tuple(torch.FloatTensor)
A transformers.modeling_outputs.TokenClassifierOutput 或 torch.FloatTensor 的元组 (如果传递了 return_dict=False 或者当 config.return_dict=False 时)，包含各种元素，具体取决于配置 (XLMConfig) 和输入。
-
loss (
torch.FloatTensorof shape(1,), optional, 当提供labels时返回) — 分类损失。 -
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时返回) — 形状为(batch_size, sequence_length, hidden_size)的torch.FloatTensor元组（对于嵌入的输出，如果模型具有嵌入层，则为一个；对于每一层的输出，则为一个）。模型在每一层输出端的隐藏状态，加上可选的初始嵌入输出。
-
attentions (
tuple(torch.FloatTensor), 可选的, 当传递output_attentions=True或当config.output_attentions=True时返回) — 形状为(batch_size, num_heads, sequence_length, sequence_length)的torch.FloatTensor元组（每层一个）。注意力 softmax 后的注意力权重，用于计算自注意力头中的加权平均值。
The XLMForTokenClassification forward 方法，覆盖了 __call__ 特殊方法。
尽管 forward 传递的配方需要在该函数中定义，但之后应调用 Module 实例而不是此函数，因为前者负责运行预处理和后处理步骤，而后者会静默地忽略它们。
示例
>>> from transformers import AutoTokenizer, XLMForTokenClassification
>>> import torch
>>> tokenizer = AutoTokenizer.from_pretrained("FacebookAI/xlm-mlm-en-2048")
>>> model = XLMForTokenClassification.from_pretrained("FacebookAI/xlm-mlm-en-2048")
>>> 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).lossXLMForQuestionAnsweringSimple
class transformers.XLMForQuestionAnsweringSimple
< source >( config )
参数
- config (XLMConfig) — 带有模型所有参数的模型配置类。 使用配置文件初始化不会加载与模型关联的权重，仅加载配置。查看 from_pretrained() 方法来加载模型权重。
XLM 模型，顶部带有一个跨度分类头，用于抽取式问答任务，例如 SQuAD (隐藏状态输出之上有一个线性层，用于计算 span start logits 和 span end logits)。
此模型继承自 PreTrainedModel。查看超类文档，了解库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、剪枝 head 等）。
此模型也是 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[typing.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 or tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensorof shape(batch_size, sequence_length)) — 词汇表中输入序列 tokens 的索引。可以使用 AutoTokenizer 获取索引。 请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call() 获取详细信息。
- attention_mask (
torch.FloatTensorof shape(batch_size, sequence_length), optional) — 用于避免在 padding token 索引上执行 attention 的掩码。 掩码值在[0, 1]中选择：- 1 表示 tokens 未被掩盖，
- 0 表示 tokens 被掩盖。
- langs (
torch.LongTensorof shape(batch_size, sequence_length), optional) — 要使用的并行 token 序列，以指示输入中每个 token 的语言。 索引是语言 ID，可以通过使用模型配置中提供的两个转换映射从语言名称中获得（仅为多语言模型提供）。 更准确地说，语言名称到语言 ID 的映射在model.config.lang2id中（这是一个字符串到 int 的字典），而语言 ID 到语言名称 的映射在model.config.id2lang中（字典 int 到字符串）。请参阅 多语言文档 中详细的使用示例。
- token_type_ids (
torch.LongTensorof shape(batch_size, sequence_length), optional) — Segment token 索引以指示输入的第一部分和第二部分。 索引在[0, 1]中选择：- 0 对应于 句子 A token，
- 1 对应于 句子 B token。
- position_ids (
torch.LongTensorof shape(batch_size, sequence_length), optional) — 位置嵌入中每个输入序列 tokens 的位置索引。 在范围[0, config.max_position_embeddings - 1]中选择。 - lengths (
torch.LongTensorof shape(batch_size,), optional) — 每个句子的长度，可用于避免在 padding token 索引上执行 attention。 您也可以使用 attention_mask 来获得相同的结果（见上文），此处保留是为了兼容性。 索引在[0, ..., input_ids.size(-1)]中选择。 - cache (
Dict[str, torch.FloatTensor], optional) — 字符串到torch.FloatTensor的字典，其中包含模型计算的预计算隐藏状态（attention 块中的键和值）（请参阅下面的cache输出）。 可用于加速顺序解码。字典对象将在前向传递期间就地修改，以添加新计算的隐藏状态。
- head_mask (
torch.FloatTensorof shape(num_heads,)or(num_layers, num_heads), optional) — 用于 nullify 自注意力模块的选定头的掩码。 掩码值在[0, 1]中选择：- 1 表示头 未被掩盖，
- 0 表示头 被掩盖。
- inputs_embeds (
torch.FloatTensorof shape(batch_size, sequence_length, hidden_size), optional) — （可选）您可以选择直接传递嵌入表示，而不是传递input_ids。 如果您希望比模型的内部嵌入查找矩阵更精细地控制如何将input_ids索引转换为关联的向量，这将非常有用。 - output_attentions (
bool, optional) — 是否返回所有 attention 层的 attentions 张量。 更多细节请查看返回张量下的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 or tuple(torch.FloatTensor)
A transformers.modeling_outputs.QuestionAnsweringModelOutput 或 torch.FloatTensor 的元组 (如果传递了 return_dict=False 或者当 config.return_dict=False 时)，包含各种元素，具体取决于配置 (XLMConfig) 和输入。
-
loss (
torch.FloatTensorof shape(1,), optional, 当提供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时返回) — 形状为(batch_size, sequence_length, hidden_size)的torch.FloatTensor元组（对于嵌入的输出，如果模型具有嵌入层，则为一个；对于每一层的输出，则为一个）。模型在每一层输出端的隐藏状态，加上可选的初始嵌入输出。
-
attentions (
tuple(torch.FloatTensor), 可选的, 当传递output_attentions=True或当config.output_attentions=True时返回) — 形状为(batch_size, num_heads, sequence_length, sequence_length)的torch.FloatTensor元组（每层一个）。注意力 softmax 后的注意力权重，用于计算自注意力头中的加权平均值。
The XLMForQuestionAnsweringSimple forward 方法，覆盖了 __call__ 特殊方法。
尽管 forward 传递的配方需要在该函数中定义，但之后应调用 Module 实例而不是此函数，因为前者负责运行预处理和后处理步骤，而后者会静默地忽略它们。
示例
>>> from transformers import AutoTokenizer, XLMForQuestionAnsweringSimple
>>> import torch
>>> tokenizer = AutoTokenizer.from_pretrained("FacebookAI/xlm-mlm-en-2048")
>>> model = XLMForQuestionAnsweringSimple.from_pretrained("FacebookAI/xlm-mlm-en-2048")
>>> 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.lossXLMForQuestionAnswering
class transformers.XLMForQuestionAnswering
< source >( config )
参数
- config (XLMConfig) — 带有模型所有参数的模型配置类。 使用配置文件初始化不会加载与模型关联的权重，仅加载配置。查看 from_pretrained() 方法来加载模型权重。
XLM 模型，顶部带有一个 beam-search 跨度分类头，用于抽取式问答任务，例如 SQuAD (隐藏状态输出之上有一个线性层，用于计算 span start logits 和 span end logits)。
此模型继承自 PreTrainedModel。查看超类文档，了解库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、剪枝 head 等）。
此模型也是 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[typing.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.xlm.modeling_xlm.XLMForQuestionAnsweringOutput or tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensor, 形状为(batch_size, sequence_length)) — 词汇表中输入序列 tokens 的索引。索引可以使用 AutoTokenizer 获得。 参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call() 以了解详情。
- attention_mask (
torch.FloatTensor, 形状为(batch_size, sequence_length), 可选) — 用于避免在 padding token 索引上执行 attention 的 Mask。Mask 值在[0, 1]中选择：- 1 代表 未被 Mask 的 tokens，
- 0 代表 被 Mask 的 tokens。
- langs (
torch.LongTensor, 形状为(batch_size, sequence_length), 可选) — 一个并行 tokens 序列，用于指示输入中每个 token 的语言。索引是语言 ID，可以通过使用模型配置中提供的两个转换映射，从语言名称获得（仅适用于多语言模型）。更准确地说，语言名称到语言 ID 的映射在model.config.lang2id中（这是一个字符串到整数的字典），而语言 ID 到语言名称 的映射在model.config.id2lang中（整数到字符串的字典）。请参阅 多语言文档 中详细的使用示例。
- token_type_ids (
torch.LongTensor, 形状为(batch_size, sequence_length), 可选) — 分段 token 索引，用于指示输入的第一部分和第二部分。索引在[0, 1]中选择：- 0 对应于 句子 A token，
- 1 对应于 句子 B token。
- position_ids (
torch.LongTensor, 形状为(batch_size, sequence_length), 可选) — 每个输入序列 token 在 position embeddings 中的位置索引。在范围[0, config.max_position_embeddings - 1]中选择。 - lengths (
torch.LongTensor, 形状为(batch_size,), 可选) — 每个句子的长度，可以用于避免在 padding token 索引上执行 attention。您也可以使用 attention_mask 达到相同的结果（见上文），此处保留是为了兼容性。索引在[0, ..., input_ids.size(-1)]中选择。 - cache (
Dict[str, torch.FloatTensor], 可选) — 字符串到torch.FloatTensor的字典，其中包含模型计算的预计算隐藏状态（attention 模块中的键和值）（请参阅下面的cache输出）。可用于加速顺序解码。字典对象将在前向传播期间就地修改，以添加新计算的隐藏状态。
- head_mask (
torch.FloatTensor, 形状为(num_heads,)或(num_layers, num_heads), 可选) — 用于 nullify self-attention 模块中选定 head 的 Mask。Mask 值在[0, 1]中选择：- 1 表示 head 未被 Mask，
- 0 表示 head 被 Mask。
- inputs_embeds (
torch.FloatTensor, 形状为(batch_size, sequence_length, hidden_size), 可选) — （可选）您可以选择直接传递嵌入表示，而不是传递input_ids。如果您希望比模型的内部嵌入查找矩阵更精细地控制如何将input_ids索引转换为关联的向量，这将非常有用。 - output_attentions (
bool, 可选) — 是否返回所有 attention 层的 attentions tensors。 有关更多详细信息，请参见返回 tensors 下的attentions。 - output_hidden_states (
bool, 可选) — 是否返回所有层的 hidden states。 有关更多详细信息，请参见返回 tensors 下的hidden_states。 - return_dict (
bool, 可选) — 是否返回 ModelOutput 而不是普通 tuple。 - start_positions (
torch.LongTensor, 形状为(batch_size,), 可选) — 用于计算 token 分类损失的带标签 span 开始位置（索引）的标签。位置被限制在序列的长度 (sequence_length) 内。序列外部的位置不计入损失计算。 - end_positions (
torch.LongTensor, 形状为(batch_size,), 可选) — 用于计算 token 分类损失的带标签 span 结束位置（索引）的标签。位置被限制在序列的长度 (sequence_length) 内。序列外部的位置不计入损失计算。 - is_impossible (
torch.LongTensor, 形状为(batch_size,), 可选) — 标签，指示问题是否有答案或没有答案 (SQuAD 2.0) - cls_index (
torch.LongTensor, 形状为(batch_size,), 可选) — 分类 token 的位置（索引）的标签，用作计算答案合理性的输入。 - p_mask (
torch.FloatTensor, 形状为(batch_size, sequence_length), 可选) — 不能在答案中的 tokens 的可选 Mask (例如，[CLS], [PAD], ...)。 1.0 表示 token 应该被 Mask。 0.0 表示 token 未被 Mask。
返回值
transformers.models.xlm.modeling_xlm.XLMForQuestionAnsweringOutput 或 tuple(torch.FloatTensor)
一个 transformers.models.xlm.modeling_xlm.XLMForQuestionAnsweringOutput 或一个 torch.FloatTensor 的 tuple（如果传递了 return_dict=False 或当 config.return_dict=False 时），包含各种元素，具体取决于配置 (XLMConfig) 和输入。
-
loss (
torch.FloatTensor, 形状为(1,), 可选, 如果同时提供了start_positions和end_positions则返回) — 分类损失，为起始 token、结束 token（以及如果提供，则为 is_impossible）分类损失的总和。 -
start_top_log_probs (
torch.FloatTensor, 形状为(batch_size, config.start_n_top), 可选, 如果未提供start_positions或end_positions则返回) — 前 config.start_n_top 个起始 token 可能性的 Log 概率（集束搜索）。 -
start_top_index (
torch.LongTensor, 形状为(batch_size, config.start_n_top), 可选, 如果未提供start_positions或end_positions则返回) — 前 config.start_n_top 个起始 token 可能性的索引（集束搜索）。 -
end_top_log_probs (
torch.FloatTensor, 形状为(batch_size, config.start_n_top * config.end_n_top), 可选, 如果未提供start_positions或end_positions则返回) — 前config.start_n_top * config.end_n_top个结束 token 可能性的 Log 概率（集束搜索）。 -
end_top_index (
torch.LongTensor, 形状为(batch_size, config.start_n_top * config.end_n_top), 可选, 如果未提供start_positions或end_positions则返回) — 前config.start_n_top * config.end_n_top个结束 token 可能性的索引（集束搜索）。 -
cls_logits (
torch.FloatTensor, 形状为(batch_size,), 可选, 如果未提供start_positions或end_positions则返回) — 答案的is_impossible标签的 Log 概率。 -
hidden_states (
tuple(torch.FloatTensor), 可选, 当传递output_hidden_states=True或当config.output_hidden_states=True时返回) —torch.FloatTensor的 Tuple（embeddings 的输出一个，加上每层的输出一个），形状为(batch_size, sequence_length, hidden_size)。模型在每层输出以及初始 embedding 输出处的 Hidden-states。
-
attentions (
tuple(torch.FloatTensor), 可选的, 当传递output_attentions=True或当config.output_attentions=True时返回) — 形状为(batch_size, num_heads, sequence_length, sequence_length)的torch.FloatTensor元组（每层一个）。注意力 softmax 后的注意力权重，用于计算自注意力头中的加权平均值。
XLMForQuestionAnswering 前向传播方法，覆盖了 __call__ 特殊方法。
尽管 forward 传递的配方需要在该函数中定义，但之后应调用 Module 实例而不是此函数，因为前者负责运行预处理和后处理步骤，而后者会静默地忽略它们。
示例
>>> from transformers import AutoTokenizer, XLMForQuestionAnswering
>>> import torch
>>> tokenizer = AutoTokenizer.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.lossTFXLMModel
class transformers.TFXLMModel
< source >( config *inputs **kwargs )
参数
- config (XLMConfig) — 模型配置类，包含模型的所有参数。使用配置文件初始化不会加载与模型关联的权重，仅加载配置。查看 from_pretrained() 方法以加载模型权重。
裸 XLM 模型 Transformer，输出原始隐藏状态，顶部没有任何特定的 head。
此模型继承自 TFPreTrainedModel。查看超类文档，了解库为其所有模型实现的通用方法（例如下载或保存、调整输入 embeddings 大小、剪枝 heads 等）。
此模型也是 keras.Model 的子类。你可以像使用常规的 TF 2.0 Keras 模型一样使用它，并参考 TF 2.0 文档以了解关于通用用法和行为的所有事项。
transformers 中的 TensorFlow 模型和层接受两种输入格式
- 所有输入都作为关键字参数（类似于 PyTorch 模型），或者
- 所有输入都作为列表、元组或字典放在第一个位置参数中。
支持第二种格式的原因是 Keras 方法在将输入传递给模型和层时更喜欢这种格式。由于这种支持，当使用 model.fit() 等方法时，对于你来说，事情应该“正常工作”——只需以 model.fit() 支持的任何格式传递你的输入和标签即可！但是，如果你想在 Keras 方法（如 fit() 和 predict()）之外使用第二种格式，例如在使用 Keras Functional API 创建你自己的层或模型时，你可以使用以下三种可能性来收集第一个位置参数中的所有输入张量
- 一个只包含
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 函数一样传递输入！
call
< source >( input_ids: TFModelInputType | None = None attention_mask: tf.Tensor | None = None langs: tf.Tensor | None = None token_type_ids: tf.Tensor | None = None position_ids: tf.Tensor | None = None lengths: tf.Tensor | None = None cache: Dict[str, tf.Tensor] | None = None head_mask: tf.Tensor | None = None inputs_embeds: tf.Tensor | None = None output_attentions: bool | None = None output_hidden_states: bool | None = None return_dict: bool | None = None training: bool = False ) → transformers.modeling_tf_outputs.TFBaseModelOutput 或 tuple(tf.Tensor)
参数
- input_ids (
Numpy array或tf.Tensor，形状为(batch_size, sequence_length)) — 词汇表中输入序列 tokens 的索引。索引可以使用 AutoTokenizer 获得。 有关详细信息，请参阅 PreTrainedTokenizer.call() 和 PreTrainedTokenizer.encode()。
- attention_mask (
Numpy array或tf.Tensor，形状为(batch_size, sequence_length), 可选) — 用于避免在 padding token 索引上执行 attention 的掩码。Mask 值在[0, 1]中选择：- 1 表示 tokens 未被掩盖，
- 0 表示 tokens 已被掩盖。
- langs (
tf.Tensor或Numpy array，形状为(batch_size, sequence_length), 可选) — 一个并行的 tokens 序列，用于指示输入中每个 token 的语言。索引是语言 ID，可以通过使用模型配置中提供的两个转换映射从语言名称中获得（仅为多语言模型提供）。更准确地说，语言名称到语言 ID 的映射在model.config.lang2id中（这是一个字符串到 int 的字典），语言 ID 到语言名称 的映射在model.config.id2lang中（int 到字符串的字典）。请参阅 多语言文档 中详细的使用示例。
- token_type_ids (
Numpy array或tf.Tensor，形状为(batch_size, sequence_length), 可选) — Segment token 索引，用于指示输入的第一部分和第二部分。索引在[0, 1]中选择：- 0 对应于 句子 A token，
- 1 对应于 句子 B token。
- position_ids (
Numpy array或tf.Tensor，形状为(batch_size, sequence_length), 可选) — 位置嵌入中每个输入序列 tokens 的位置索引。在范围[0, config.max_position_embeddings - 1]中选择。 - lengths (
tf.Tensor或Numpy array，形状为(batch_size,), 可选) — 每个句子的长度，可用于避免在 padding token 索引上执行 attention。你也可以使用 attention_mask 获得相同的结果（见上文），此处保留是为了兼容性。索引在[0, ..., input_ids.size(-1)]中选择。 - cache (
Dict[str, tf.Tensor], 可选) — 字符串到tf.Tensor的字典，其中包含模型计算的预计算隐藏状态（attention 块中的键和值）（请参阅下面的cache输出）。可用于加速顺序解码。字典对象将在前向传递期间就地修改，以添加新计算的隐藏状态。
- head_mask (
Numpy array或tf.Tensor，形状为(num_heads,)或(num_layers, num_heads), 可选) — 用于 nullify self-attention 模块的选定 head 的掩码。Mask 值在[0, 1]中选择：- 1 表示 head 未被掩盖，
- 0 表示 head 已被掩盖。
- inputs_embeds (
tf.Tensor，形状为(batch_size, sequence_length, hidden_size), 可选) — 可选地，你可以选择直接传递嵌入表示，而不是传递input_ids。 如果你希望比模型的内部嵌入查找矩阵更精细地控制如何将input_ids索引转换为关联的向量，这将非常有用。 - output_attentions (
bool, 可选) — 是否返回所有 attention 层的 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 时），包含各种元素，具体取决于配置 (XLMConfig) 和输入。
-
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时返回) —tf.Tensor的元组（embeddings 的输出一个，每层输出一个），形状为(batch_size, sequence_length, hidden_size)。模型在每层输出以及初始 embedding 输出处的 Hidden-states。
-
attentions (
tuple(tf.Tensor), 可选, 当传递output_attentions=True或当config.output_attentions=True时返回) —tf.Tensor的元组（每层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 后的注意力权重，用于计算自注意力头中的加权平均值。
TFXLMModel 前向方法，覆盖了 __call__ 特殊方法。
尽管 forward 传递的配方需要在该函数中定义，但之后应调用 Module 实例而不是此函数，因为前者负责运行预处理和后处理步骤，而后者会静默地忽略它们。
示例
>>> from transformers import AutoTokenizer, TFXLMModel
>>> import tensorflow as tf
>>> tokenizer = AutoTokenizer.from_pretrained("FacebookAI/xlm-mlm-en-2048")
>>> model = TFXLMModel.from_pretrained("FacebookAI/xlm-mlm-en-2048")
>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="tf")
>>> outputs = model(inputs)
>>> last_hidden_states = outputs.last_hidden_stateTFXLMWithLMHeadModel
class transformers.TFXLMWithLMHeadModel
< source >( config *inputs **kwargs )
参数
- config (XLMConfig) — 带有模型所有参数的模型配置类。使用配置文件初始化不会加载与模型关联的权重，仅加载配置。查看 from_pretrained() 方法以加载模型权重。
XLM 模型 Transformer，顶部带有一个语言建模头（线性层，其权重与输入嵌入层绑定）。
此模型继承自 TFPreTrainedModel。查看超类文档，了解库为其所有模型实现的通用方法（例如下载或保存、调整输入 embeddings 大小、剪枝 heads 等）。
此模型也是 keras.Model 的子类。你可以像使用常规的 TF 2.0 Keras 模型一样使用它，并参考 TF 2.0 文档以了解关于通用用法和行为的所有事项。
transformers 中的 TensorFlow 模型和层接受两种输入格式
- 所有输入都作为关键字参数（类似于 PyTorch 模型），或者
- 所有输入都作为列表、元组或字典放在第一个位置参数中。
支持第二种格式的原因是 Keras 方法在将输入传递给模型和层时更喜欢这种格式。由于这种支持，当使用 model.fit() 等方法时，对于你来说，事情应该“正常工作”——只需以 model.fit() 支持的任何格式传递你的输入和标签即可！但是，如果你想在 Keras 方法（如 fit() 和 predict()）之外使用第二种格式，例如在使用 Keras Functional API 创建你自己的层或模型时，你可以使用以下三种可能性来收集第一个位置参数中的所有输入张量
- 一个只包含
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 函数一样传递输入！
call
< source >( 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 training: bool = False ) → transformers.models.xlm.modeling_tf_xlm.TFXLMWithLMHeadModelOutput 或 tuple(tf.Tensor)
参数
- input_ids (
Numpy array或tf.Tensor，形状为(batch_size, sequence_length)) — 词汇表中输入序列 tokens 的索引。索引可以使用 AutoTokenizer 获得。 有关详细信息，请参阅 PreTrainedTokenizer.call() 和 PreTrainedTokenizer.encode()。
- attention_mask (
Numpy array或tf.Tensor，形状为(batch_size, sequence_length), 可选) — 用于避免在 padding token 索引上执行 attention 的掩码。Mask 值在[0, 1]中选择：- 1 表示 tokens 未被掩盖，
- 0 表示 tokens 已被掩盖。
- langs (
tf.Tensor或Numpy array，形状为(batch_size, sequence_length)，可选) — 用于指示输入中每个 token 语言的并行 token 序列。索引是语言 ID，可以通过使用模型配置中提供的两个转换映射从语言名称获得（仅为多语言模型提供）。更准确地说，语言名称到语言 ID 的映射在model.config.lang2id中（这是一个字符串到整数的字典），而语言 ID 到语言名称 的映射在model.config.id2lang中（整数到字符串的字典）。有关用法示例，请参阅多语言文档。
- token_type_ids (
Numpy array或tf.Tensor，形状为(batch_size, sequence_length)，可选) — 分段 token 索引，用于指示输入的第一个和第二个部分。索引在[0, 1]中选择：- 0 对应于 句子 A token，
- 1 对应于 句子 B token。
- position_ids (
Numpy array或tf.Tensor，形状为(batch_size, sequence_length)，可选) — 每个输入序列 token 在位置嵌入中的位置索引。在范围[0, config.max_position_embeddings - 1]中选择。 - lengths (
tf.Tensor或Numpy array，形状为(batch_size,)，可选) — 每个句子的长度，可用于避免对 padding token 索引执行 attention。您也可以使用 attention_mask 来获得相同的结果（见上文），此处保留是为了兼容性。索引在[0, ..., input_ids.size(-1)]中选择。 - cache (
Dict[str, tf.Tensor]，可选) — 字符串到tf.Tensor的字典，其中包含模型计算的预计算隐藏状态（attention 块中的键和值）（请参阅下面的cache输出）。可用于加速顺序解码。字典对象将在前向传播过程中就地修改，以添加新计算的隐藏状态。
- head_mask (
Numpy array或tf.Tensor，形状为(num_heads,)或(num_layers, num_heads)，可选) — 用于 nullify self-attention 模块中选定 head 的 mask。Mask 值在[0, 1]中选择：- 1 表示 head 未被 mask，
- 0 表示 head 已被 mask。
- inputs_embeds (
tf.Tensor，形状为(batch_size, sequence_length, hidden_size)，可选) — 可选地，您可以选择直接传递嵌入表示而不是传递input_ids。如果您希望比模型的内部嵌入查找矩阵更灵活地控制如何将input_ids索引转换为关联向量，这将非常有用。 - output_attentions (
bool，可选) — 是否返回所有 attention 层的 attention tensors。有关更多详细信息，请参阅返回的 tensors 下的attentions。此参数只能在 eager 模式下使用，在 graph 模式下将使用 config 中的值。 - output_hidden_states (
bool，可选) — 是否返回所有层的 hidden states。有关更多详细信息，请参阅返回的 tensors 下的hidden_states。此参数只能在 eager 模式下使用，在 graph 模式下将使用 config 中的值。 - return_dict (
bool，可选) — 是否返回 ModelOutput 而不是普通元组。此参数可以在 eager 模式下使用，在 graph 模式下该值将始终设置为 True。 - training (
bool，可选，默认为False) — 是否在训练模式下使用模型（某些模块（如 dropout 模块）在训练和评估之间具有不同的行为）。
返回值
transformers.models.xlm.modeling_tf_xlm.TFXLMWithLMHeadModelOutput 或 tuple(tf.Tensor)
一个 transformers.models.xlm.modeling_tf_xlm.TFXLMWithLMHeadModelOutput 或 tf.Tensor 元组（如果传递了 return_dict=False 或当 config.return_dict=False 时），包含各种元素，具体取决于配置 (XLMConfig) 和输入。
-
logits (
tf.Tensor，形状为(batch_size, sequence_length, config.vocab_size)) — 语言模型头的预测分数（SoftMax 之前每个词汇 token 的分数）。 -
hidden_states (
tuple(tf.Tensor)，可选，当传递output_hidden_states=True或当config.output_hidden_states=True时返回) —tf.Tensor元组（embeddings 的输出一个，每层的输出一个），形状为(batch_size, sequence_length, hidden_size)。模型在每层输出以及初始 embedding 输出处的 Hidden-states。
-
attentions (
tuple(tf.Tensor), 可选, 当传递output_attentions=True或当config.output_attentions=True时返回) —tf.Tensor的元组（每层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 后的注意力权重，用于计算自注意力头中的加权平均值。
TFXLMWithLMHeadModel 前向传播方法，覆盖了 __call__ 特殊方法。
尽管 forward 传递的配方需要在该函数中定义，但之后应调用 Module 实例而不是此函数，因为前者负责运行预处理和后处理步骤，而后者会静默地忽略它们。
示例
>>> from transformers import AutoTokenizer, TFXLMWithLMHeadModel
>>> import tensorflow as tf
>>> tokenizer = AutoTokenizer.from_pretrained("FacebookAI/xlm-mlm-en-2048")
>>> model = TFXLMWithLMHeadModel.from_pretrained("FacebookAI/xlm-mlm-en-2048")
>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="tf")
>>> outputs = model(inputs)
>>> logits = outputs.logitsTFXLMForSequenceClassification
class transformers.TFXLMForSequenceClassification
< source >( config *inputs **kwargs )
参数
- config (XLMConfig) — 带有模型所有参数的模型配置类。使用配置文件初始化不会加载与模型关联的权重，仅加载配置。查看 from_pretrained() 方法以加载模型权重。
XLM 模型，顶部带有一个序列分类/回归头（池化输出顶部的线性层），例如用于 GLUE 任务。
此模型继承自 TFPreTrainedModel。查看超类文档，了解库为其所有模型实现的通用方法（例如下载或保存、调整输入 embeddings 大小、剪枝 heads 等）。
此模型也是 keras.Model 的子类。你可以像使用常规的 TF 2.0 Keras 模型一样使用它，并参考 TF 2.0 文档以了解关于通用用法和行为的所有事项。
transformers 中的 TensorFlow 模型和层接受两种输入格式
- 所有输入都作为关键字参数（类似于 PyTorch 模型），或者
- 所有输入都作为列表、元组或字典放在第一个位置参数中。
支持第二种格式的原因是 Keras 方法在将输入传递给模型和层时更喜欢这种格式。由于这种支持，当使用 model.fit() 等方法时，对于你来说，事情应该“正常工作”——只需以 model.fit() 支持的任何格式传递你的输入和标签即可！但是，如果你想在 Keras 方法（如 fit() 和 predict()）之外使用第二种格式，例如在使用 Keras Functional API 创建你自己的层或模型时，你可以使用以下三种可能性来收集第一个位置参数中的所有输入张量
- 一个只包含
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 函数一样传递输入！
call
< source >( 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)) — 词汇表中输入序列 token 的索引。索引可以使用 AutoTokenizer 获得。有关详细信息，请参阅 PreTrainedTokenizer.call() 和 PreTrainedTokenizer.encode()。
- attention_mask (
Numpy array或tf.Tensor，形状为(batch_size, sequence_length)，可选) — Mask，以避免对 padding token 索引执行 attention。Mask 值在[0, 1]中选择：- 1 表示 token 未被 mask，
- 0 表示 token 已被 mask。
- langs (
tf.Tensor或Numpy array，形状为(batch_size, sequence_length)，可选) — 用于指示输入中每个 token 语言的并行 token 序列。索引是语言 ID，可以通过使用模型配置中提供的两个转换映射从语言名称获得（仅为多语言模型提供）。更准确地说，语言名称到语言 ID 的映射在model.config.lang2id中（这是一个字符串到整数的字典），而语言 ID 到语言名称 的映射在model.config.id2lang中（整数到字符串的字典）。有关用法示例，请参阅多语言文档。
- token_type_ids (
Numpy array或tf.Tensor，形状为(batch_size, sequence_length)，可选) — 分段 token 索引，用于指示输入的第一个和第二个部分。索引在[0, 1]中选择：- 0 对应于 句子 A token，
- 1 对应于 句子 B token。
- position_ids (
Numpy array或tf.Tensor，形状为(batch_size, sequence_length)，可选) — 每个输入序列 token 在位置嵌入中的位置索引。在范围[0, config.max_position_embeddings - 1]中选择。 - lengths (
tf.Tensor或Numpy array，形状为(batch_size,)，可选) — 每个句子的长度，可用于避免对 padding token 索引执行 attention。您也可以使用 attention_mask 来获得相同的结果（见上文），此处保留是为了兼容性。索引在[0, ..., input_ids.size(-1)]中选择。 - cache (
Dict[str, tf.Tensor], 可选) — 字符串到tf.Tensor的字典，包含由模型计算的预计算隐藏状态（注意力模块中的键和值）（请参阅下面的cache输出）。可用于加速顺序解码。字典对象将在前向传播过程中就地修改，以添加新计算的隐藏状态。
- head_mask (
Numpy array或tf.Tensor，形状为(num_heads,)或(num_layers, num_heads), 可选) — 用于置空自注意力模块中选定 head 的 Mask。Mask 值选自[0, 1]:- 1 表示 head 不被 Mask，
- 0 表示 head 被 Mask。
- 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 模块等某些模块在训练和评估之间具有不同的行为）。 - 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 时)，包含取决于配置 (XLMConfig) 和输入的各种元素。
-
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元组（embeddings 的输出一个，每层的输出一个），形状为(batch_size, sequence_length, hidden_size)。模型在每层输出以及初始 embedding 输出处的 Hidden-states。
-
attentions (
tuple(tf.Tensor), 可选, 当传递output_attentions=True或当config.output_attentions=True时返回) —tf.Tensor的元组（每层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 后的注意力权重，用于计算自注意力头中的加权平均值。
TFXLMForSequenceClassification 前向传播方法，覆盖了 __call__ 特殊方法。
尽管 forward 传递的配方需要在该函数中定义，但之后应调用 Module 实例而不是此函数，因为前者负责运行预处理和后处理步骤，而后者会静默地忽略它们。
示例
>>> from transformers import AutoTokenizer, TFXLMForSequenceClassification
>>> import tensorflow as tf
>>> tokenizer = AutoTokenizer.from_pretrained("FacebookAI/xlm-mlm-en-2048")
>>> model = TFXLMForSequenceClassification.from_pretrained("FacebookAI/xlm-mlm-en-2048")
>>> 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 = TFXLMForSequenceClassification.from_pretrained("FacebookAI/xlm-mlm-en-2048", num_labels=num_labels)
>>> labels = tf.constant(1)
>>> loss = model(**inputs, labels=labels).lossTFXLMForMultipleChoice
class transformers.TFXLMForMultipleChoice
< source >( config *inputs **kwargs )
参数
- config (XLMConfig) — 具有模型所有参数的模型配置类。使用配置文件初始化不会加载与模型关联的权重，仅加载配置。查看 from_pretrained() 方法以加载模型权重。
XLM 模型，顶部带有一个多项选择分类 head（池化输出顶部的线性层和一个 softmax），例如用于 RocStories/SWAG 任务。
此模型继承自 TFPreTrainedModel。查看超类文档，了解库为其所有模型实现的通用方法（例如下载或保存、调整输入 embeddings 大小、剪枝 heads 等）。
此模型也是 keras.Model 的子类。你可以像使用常规的 TF 2.0 Keras 模型一样使用它，并参考 TF 2.0 文档以了解关于通用用法和行为的所有事项。
transformers 中的 TensorFlow 模型和层接受两种输入格式
- 所有输入都作为关键字参数（类似于 PyTorch 模型），或者
- 所有输入都作为列表、元组或字典放在第一个位置参数中。
支持第二种格式的原因是 Keras 方法在将输入传递给模型和层时更喜欢这种格式。由于这种支持，当使用 model.fit() 等方法时，对于你来说，事情应该“正常工作”——只需以 model.fit() 支持的任何格式传递你的输入和标签即可！但是，如果你想在 Keras 方法（如 fit() 和 predict()）之外使用第二种格式，例如在使用 Keras Functional API 创建你自己的层或模型时，你可以使用以下三种可能性来收集第一个位置参数中的所有输入张量
- 一个只包含
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 函数一样传递输入！
call
< source >( 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, num_choices, sequence_length)) — 词汇表中输入序列 tokens 的索引。可以使用 AutoTokenizer 获取索引。 有关详细信息，请参见 PreTrainedTokenizer.call() 和 PreTrainedTokenizer.encode()。
- attention_mask (
Numpy array或tf.Tensor，形状为(batch_size, num_choices, sequence_length), 可选) — Mask，以避免对 padding token 索引执行 attention。Mask 值选自[0, 1]:- 1 表示 tokens 不被 Mask，
- 0 表示 tokens 被 Mask。
- langs (
tf.Tensor或Numpy array，形状为(batch_size, num_choices, sequence_length), 可选) — 要使用的并行 tokens 序列，以指示输入中每个 token 的语言。索引是语言 ID，可以通过使用模型的配置中提供的两个转换映射从语言名称中获得（仅为多语言模型提供）。更准确地说，语言名称到语言 ID 的映射在model.config.lang2id中（这是一个字符串到 int 的字典），而语言 ID 到语言名称 的映射在model.config.id2lang中（int 到字符串的字典）。请参阅 多语言文档 中详细的使用示例。
- token_type_ids (
Numpy array或tf.Tensor，形状为(batch_size, num_choices, sequence_length), 可选) — 分段 token 索引，用于指示输入的第一个和第二个部分。索引选自[0, 1]:- 0 对应于 句子 A token，
- 1 对应于 句子 B token。
- position_ids (
Numpy array或tf.Tensor，形状为(batch_size, num_choices, sequence_length), 可选) — 位置嵌入中每个输入序列 token 的位置索引。在范围[0, config.max_position_embeddings - 1]中选择。 - lengths (
tf.Tensor或Numpy array，形状为(batch_size,), 可选) — 每个句子的长度，可用于避免对 padding token 索引执行 attention。您也可以使用 attention_mask 获得相同的结果（见上文），此处保留是为了兼容性。索引在[0, ..., input_ids.size(-1)]中选择。 - cache (
Dict[str, tf.Tensor], 可选) — 字符串到tf.Tensor的字典，包含由模型计算的预计算隐藏状态（注意力模块中的键和值）（请参阅下面的cache输出）。可用于加速顺序解码。字典对象将在前向传播过程中就地修改，以添加新计算的隐藏状态。
- head_mask (
Numpy array或tf.Tensor，形状为(num_heads,)或(num_layers, num_heads), 可选) — 用于置空自注意力模块中选定 head 的 Mask。Mask 值选自[0, 1]:- 1 表示 head 不被 Mask，
- 0 表示 head 被 Mask。
- inputs_embeds (
tf.Tensor，形状为(batch_size, num_choices, 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.TFMultipleChoiceModelOutput 或 tuple(tf.Tensor)
一个 transformers.modeling_tf_outputs.TFMultipleChoiceModelOutput 或 tf.Tensor 的元组 (如果传递了 return_dict=False 或当 config.return_dict=False 时)，包含取决于配置 (XLMConfig) 和输入的各种元素。
-
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元组（embeddings 的输出一个，每层的输出一个），形状为(batch_size, sequence_length, hidden_size)。模型在每层输出以及初始 embedding 输出处的 Hidden-states。
-
attentions (
tuple(tf.Tensor), 可选, 当传递output_attentions=True或当config.output_attentions=True时返回) —tf.Tensor的元组（每层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 后的注意力权重，用于计算自注意力头中的加权平均值。
TFXLMForMultipleChoice 前向传播方法，覆盖了 __call__ 特殊方法。
尽管 forward 传递的配方需要在该函数中定义，但之后应调用 Module 实例而不是此函数，因为前者负责运行预处理和后处理步骤，而后者会静默地忽略它们。
示例
>>> from transformers import AutoTokenizer, TFXLMForMultipleChoice
>>> import tensorflow as tf
>>> tokenizer = AutoTokenizer.from_pretrained("FacebookAI/xlm-mlm-en-2048")
>>> model = TFXLMForMultipleChoice.from_pretrained("FacebookAI/xlm-mlm-en-2048")
>>> 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.logitsTFXLMForTokenClassification
类 transformers.TFXLMForTokenClassification
< source >( config *inputs **kwargs )
参数
- 配置 (XLMConfig) — 模型配置类，包含模型的所有参数。使用配置文件初始化不会加载与模型相关的权重，仅加载配置。查看 from_pretrained() 方法来加载模型权重。
XLM 模型，顶部带有标记分类头（隐藏状态输出顶部的线性层），例如，用于命名实体识别 (NER) 任务。
此模型继承自 TFPreTrainedModel。查看超类文档，了解库为其所有模型实现的通用方法（例如下载或保存、调整输入 embeddings 大小、剪枝 heads 等）。
此模型也是 keras.Model 的子类。你可以像使用常规的 TF 2.0 Keras 模型一样使用它，并参考 TF 2.0 文档以了解关于通用用法和行为的所有事项。
transformers 中的 TensorFlow 模型和层接受两种输入格式
- 所有输入都作为关键字参数（类似于 PyTorch 模型），或者
- 所有输入都作为列表、元组或字典放在第一个位置参数中。
支持第二种格式的原因是 Keras 方法在将输入传递给模型和层时更喜欢这种格式。由于这种支持，当使用 model.fit() 等方法时，对于你来说，事情应该“正常工作”——只需以 model.fit() 支持的任何格式传递你的输入和标签即可！但是，如果你想在 Keras 方法（如 fit() 和 predict()）之外使用第二种格式，例如在使用 Keras Functional API 创建你自己的层或模型时，你可以使用以下三种可能性来收集第一个位置参数中的所有输入张量
- 一个只包含
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 函数一样传递输入！
call
< source >( 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 or 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), 可选) — 掩码，用于避免在 padding 标记索引上执行 attention。掩码值在[0, 1]中选择：- 1 表示标记未被掩码，
- 0 表示标记被掩码。
- langs (
tf.Tensor或Numpy array，形状为(batch_size, sequence_length), 可选) — 一个并行的标记序列，用于指示输入中每个标记的语言。索引是语言 ID，可以通过使用模型配置中提供的两个转换映射从语言名称中获得（仅适用于多语言模型）。更准确地说，语言名称到语言 ID 的映射在model.config.lang2id中（这是一个字符串到 int 的字典），而语言 ID 到语言名称 的映射在model.config.id2lang中（int 到字符串的字典）。请参阅 多语言文档 中详述的使用示例。
- token_type_ids (
Numpy array或tf.Tensor，形状为(batch_size, sequence_length), 可选) — 分段标记索引，用于指示输入的第一部分和第二部分。索引在[0, 1]中选择：- 0 对应于 句子 A 标记，
- 1 对应于 句子 B 标记。
- position_ids (
Numpy array或tf.Tensor，形状为(batch_size, sequence_length), 可选) — 位置嵌入中每个输入序列标记的位置索引。在范围[0, config.max_position_embeddings - 1]中选择。 - lengths (
tf.Tensor或Numpy array，形状为(batch_size,), 可选) — 每个句子的长度，可用于避免在 padding 标记索引上执行 attention。您也可以使用 attention_mask 获得相同的结果（见上文），此处保留是为了兼容性。索引在[0, ..., input_ids.size(-1)]中选择。 - cache (
Dict[str, tf.Tensor], 可选) — 字符串到tf.Tensor的字典，其中包含模型计算的预计算隐藏状态（attention 块中的键和值）（请参阅下面的cache输出）。可用于加速顺序解码。字典对象将在前向传播期间就地修改，以添加新计算的隐藏状态。
- head_mask (
Numpy array或tf.Tensor，形状为(num_heads,)或(num_layers, num_heads), 可选) — 用于 nullify 自注意力模块中选定 head 的掩码。掩码值在[0, 1]中选择：- 1 表示 head 未被掩码，
- 0 表示 head 被掩码。
- inputs_embeds (
tf.Tensor，形状为(batch_size, sequence_length, hidden_size), 可选) — 可选地，您可以选择直接传递嵌入表示，而不是传递input_ids。如果您希望比模型的内部嵌入查找矩阵更好地控制如何将input_ids索引转换为关联向量，这将非常有用。 - output_attentions (
bool, 可选) — 是否返回所有 attention 层的 attention 张量。有关更多详细信息，请参阅返回张量下的attentions。此参数只能在 eager 模式下使用，在 graph 模式下将使用配置中的值。 - output_hidden_states (
bool, 可选) — 是否返回所有层的隐藏状态。有关更多详细信息，请参阅返回张量下的hidden_states。此参数只能在 eager 模式下使用，在 graph 模式下将使用配置中的值。 - return_dict (
bool, 可选) — 是否返回 ModelOutput 而不是普通元组。此参数可以在 eager 模式下使用，在 graph 模式下该值将始终设置为 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 时），包含各种元素，具体取决于配置 (XLMConfig) 和输入。
-
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元组（embeddings 的输出一个，每层的输出一个），形状为(batch_size, sequence_length, hidden_size)。模型在每层输出以及初始 embedding 输出处的 Hidden-states。
-
attentions (
tuple(tf.Tensor), 可选, 当传递output_attentions=True或当config.output_attentions=True时返回) —tf.Tensor的元组（每层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 后的注意力权重，用于计算自注意力头中的加权平均值。
TFXLMForTokenClassification 的前向传播方法，重写了 __call__ 特殊方法。
尽管 forward 传递的配方需要在该函数中定义，但之后应调用 Module 实例而不是此函数，因为前者负责运行预处理和后处理步骤，而后者会静默地忽略它们。
示例
>>> from transformers import AutoTokenizer, TFXLMForTokenClassification
>>> import tensorflow as tf
>>> tokenizer = AutoTokenizer.from_pretrained("FacebookAI/xlm-mlm-en-2048")
>>> model = TFXLMForTokenClassification.from_pretrained("FacebookAI/xlm-mlm-en-2048")
>>> 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()]TFXLMForQuestionAnsweringSimple
类 transformers.TFXLMForQuestionAnsweringSimple
< source >( config *inputs **kwargs )
参数
- 配置 (XLMConfig) — 模型配置类，包含模型的所有参数。使用配置文件初始化不会加载与模型相关的权重，仅加载配置。查看 from_pretrained() 方法来加载模型权重。
XLM 模型，顶部带有一个跨度分类头，用于执行抽取式问答任务，如 SQuAD（隐藏状态输出顶部的线性层，用于计算 span start logits 和 span end logits）。
此模型继承自 TFPreTrainedModel。查看超类文档，了解库为其所有模型实现的通用方法（例如下载或保存、调整输入 embeddings 大小、剪枝 heads 等）。
此模型也是 keras.Model 的子类。你可以像使用常规的 TF 2.0 Keras 模型一样使用它，并参考 TF 2.0 文档以了解关于通用用法和行为的所有事项。
transformers 中的 TensorFlow 模型和层接受两种输入格式
- 所有输入都作为关键字参数（类似于 PyTorch 模型），或者
- 所有输入都作为列表、元组或字典放在第一个位置参数中。
支持第二种格式的原因是 Keras 方法在将输入传递给模型和层时更喜欢这种格式。由于这种支持，当使用 model.fit() 等方法时，对于你来说，事情应该“正常工作”——只需以 model.fit() 支持的任何格式传递你的输入和标签即可！但是，如果你想在 Keras 方法（如 fit() 和 predict()）之外使用第二种格式，例如在使用 Keras Functional API 创建你自己的层或模型时，你可以使用以下三种可能性来收集第一个位置参数中的所有输入张量
- 一个只包含
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 函数一样传递输入！
call
< source >( 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 or tuple(tf.Tensor)
参数
- input_ids (
Numpy array或tf.Tensor，形状为(batch_size, sequence_length)) — 词汇表中输入序列 tokens 的索引。可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.call() 和 PreTrainedTokenizer.encode()。
- attention_mask (
Numpy array或tf.Tensor，形状为(batch_size, sequence_length)，可选) — 用于避免在 padding token 索引上执行 attention 的 Mask。 Mask 值在[0, 1]中选择：- 1 表示 tokens 未被 Mask，
- 0 表示 tokens 被 Mask。
- langs (
tf.Tensor或Numpy array，形状为(batch_size, sequence_length)，可选) — 一个平行的 tokens 序列，用于指示输入中每个 token 的语言。索引是语言 ID，可以通过使用模型配置中提供的两个转换映射从语言名称中获得（仅为多语言模型提供）。更准确地说，语言名称到语言 ID 的映射在model.config.lang2id中（这是一个字符串到整数的字典），而语言 ID 到语言名称 的映射在model.config.id2lang中（整数到字符串的字典）。请参阅 多语言文档 中详细的使用示例。
- token_type_ids (
Numpy array或tf.Tensor，形状为(batch_size, sequence_length)，可选) — Segment token 索引，用于指示输入的第一部分和第二部分。索引在[0, 1]中选择：- 0 对应于 句子 A token，
- 1 对应于 句子 B token。
- position_ids (
Numpy array或tf.Tensor，形状为(batch_size, sequence_length)，可选) — 每个输入序列 token 在位置嵌入中的位置索引。在[0, config.max_position_embeddings - 1]范围内选择。 - lengths (
tf.Tensor或Numpy array，形状为(batch_size,)，可选) — 每个句子的长度，可用于避免在 padding token 索引上执行 attention。您也可以使用 attention_mask 获得相同的结果（见上文），此处保留是为了兼容性。索引在[0, ..., input_ids.size(-1)]中选择。 - cache (
Dict[str, tf.Tensor]，可选) — 字符串到tf.Tensor的字典，其中包含模型计算的预计算隐藏状态（attention 块中的键和值）（请参阅下面的cache输出）。可用于加速顺序解码。字典对象将在前向传播过程中就地修改，以添加新计算的隐藏状态。
- head_mask (
Numpy array或tf.Tensor，形状为(num_heads,)或(num_layers, num_heads)，可选) — 用于 nullify self-attention 模块的选定 head 的 Mask。 Mask 值在[0, 1]中选择：- 1 表示 head 未被 Mask，
- 0 表示 head 被 Mask。
- inputs_embeds (
tf.Tensor，形状为(batch_size, sequence_length, hidden_size)，可选) — 可选地，您可以选择直接传递嵌入表示，而不是传递input_ids。如果您希望比模型的内部嵌入查找矩阵更精细地控制如何将input_ids索引转换为关联的向量，这将非常有用。 - output_attentions (
bool，可选) — 是否返回所有 attention 层的 attentions tensors。有关更多详细信息，请参阅返回的 tensors 下的attentions。此参数只能在 eager 模式下使用，在 graph 模式下将使用 config 中的值。 - output_hidden_states (
bool，可选) — 是否返回所有层的 hidden states。有关更多详细信息，请参阅返回的 tensors 下的hidden_states。此参数只能在 eager 模式下使用，在 graph 模式下将使用 config 中的值。 - return_dict (
bool，可选) — 是否返回 ModelOutput 而不是普通 tuple。此参数可以在 eager 模式下使用，在 graph 模式下该值将始终设置为 True。 - training (
bool，可选，默认为False) — 是否在训练模式下使用模型（dropout 模块等某些模块在训练和评估之间具有不同的行为）。 - start_positions (
tf.Tensor，形状为(batch_size,)，可选) — 用于计算 token 分类损失的标记跨度开始位置（索引）的标签。位置被限制在序列的长度 (sequence_length) 内。序列之外的位置不计入损失计算。 - end_positions (
tf.Tensor，形状为(batch_size,)，可选) — 用于计算 token 分类损失的标记跨度结束位置（索引）的标签。位置被限制在序列的长度 (sequence_length) 内。序列之外的位置不计入损失计算。
返回值
transformers.modeling_tf_outputs.TFQuestionAnsweringModelOutput 或 tuple(tf.Tensor)
一个 transformers.modeling_tf_outputs.TFQuestionAnsweringModelOutput 或 tf.Tensor 的 tuple (如果传递了 return_dict=False 或当 config.return_dict=False 时)，包含各种元素，具体取决于配置 (XLMConfig) 和输入。
-
loss (
tf.Tensor，形状为(batch_size, )，可选，当提供start_positions和end_positions时返回) — 总跨度抽取损失是开始和结束位置的交叉熵之和。 -
start_logits (
tf.Tensor，形状为(batch_size, sequence_length)) — 跨度开始得分（SoftMax 之前）。 -
end_logits (
tf.Tensor，形状为(batch_size, sequence_length)) — 跨度结束得分（SoftMax 之前）。 -
hidden_states (
tuple(tf.Tensor)，可选，当传递output_hidden_states=True或当config.output_hidden_states=True时返回) —tf.Tensor元组（embeddings 的输出一个，每层的输出一个），形状为(batch_size, sequence_length, hidden_size)。模型在每层输出以及初始 embedding 输出处的 Hidden-states。
-
attentions (
tuple(tf.Tensor), 可选, 当传递output_attentions=True或当config.output_attentions=True时返回) —tf.Tensor的元组（每层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 后的注意力权重，用于计算自注意力头中的加权平均值。
TFXLMForQuestionAnsweringSimple 前向传播方法，覆盖了 __call__ 特殊方法。
尽管 forward 传递的配方需要在该函数中定义，但之后应调用 Module 实例而不是此函数，因为前者负责运行预处理和后处理步骤，而后者会静默地忽略它们。
示例
>>> from transformers import AutoTokenizer, TFXLMForQuestionAnsweringSimple
>>> import tensorflow as tf
>>> tokenizer = AutoTokenizer.from_pretrained("FacebookAI/xlm-mlm-en-2048")
>>> model = TFXLMForQuestionAnsweringSimple.from_pretrained("FacebookAI/xlm-mlm-en-2048")
>>> 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]