XLM
概述
XLM 模型在 Cross-lingual Language Model Pretraining 这篇论文中由 Guillaume Lample, Alexis Conneau 提出。它是一个使用以下目标之一进行预训练的 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 以上。我们的代码和预训练模型将公开提供。
此模型由 thomwolf 贡献。原始代码可以在 这里 找到。
使用技巧
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) — 用于初始化嵌入矩阵的截断正态分布初始化器的标准差。 - init_std (
int, 可选, 默认为 50257) — 用于初始化除嵌入矩阵之外的所有权重矩阵的截断正态分布初始化器的标准差。 - 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) — 初始化后的模型是否应为 Transformer 编码器或解码器，如 Vaswani 等人所述。 - summary_type (
string, 可选, 默认为 “first”) — 进行序列摘要时使用的参数。用于序列分类和多项选择模型。必须是以下选项之一：
"last": 取最后一个 token 的隐藏状态（如 XLNet）。"first": 取第一个 token 的隐藏状态（如 BERT）。"mean": 取所有 token 隐藏状态的均值。"cls_index": 提供分类 token 位置的 Tensor（如 GPT/GPT-2）。"attn": 暂未实现，使用多头注意力。
- summary_use_proj (
bool, 可选, 默认为True) — 进行序列摘要时使用的参数。用于序列分类和多项选择模型。是否在向量提取后添加投影层。
- summary_activation (
str, 可选) — 进行序列摘要时使用的参数。用于序列分类和多项选择模型。传递
"tanh"以将 tanh 激活函数应用于输出，任何其他值将导致无激活函数。 - summary_proj_to_labels (
bool, optional, defaults toTrue) — 用于序列分类和多项选择模型。投影输出是否应具有
config.num_labels或config.hidden_size类。 - summary_first_dropout (
float, optional, defaults to 0.1) — 用于序列分类和多项选择模型。投影和激活后要使用的 dropout 比率。
- start_n_top (
int, optional, defaults to 5) — 用于 SQuAD 评估脚本。 - end_n_top (
int, optional, defaults to 5) — 用于 SQuAD 评估脚本。 - mask_token_id (
int, optional, defaults to 0) — 模型无关参数，用于在 MLM 上下文中生成文本时识别掩码标记。 - lang_id (
int, optional, defaults to 1) — 模型使用的语言 ID。此参数在生成给定语言的文本时使用。
这是用于存储 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>") — 未知标记。词汇表中不存在的标记无法转换为 ID，而是设置为此标记。 - bos_token (
str, optional, defaults to"<s>") — 序列开始标记，在预训练期间使用。可以用作序列分类器标记。当使用特殊标记构建序列时，这不是用于序列开始的标记。使用的标记是
cls_token。 - sep_token (
str, optional, defaults to"</s>") — 分隔符标记，用于从多个序列构建序列时，例如用于序列分类的两个序列或用于问答的文本和问题。它也用作使用特殊标记构建的序列的最后一个标记。 - pad_token (
str, optional, defaults to"<pad>") — 用于填充的标记，例如在对不同长度的序列进行批处理时。 - cls_token (
str, optional, defaults to"</s>") — 分类器标记，用于进行序列分类（对整个序列而不是每个标记的分类）。当使用特殊标记构建时，它是序列的第一个标记。 - mask_token (
str, optional, defaults to"<special1>") — 用于掩盖值的标记。这是使用掩码语言建模训练此模型时使用的标记。这是模型将尝试预测的标记。 - additional_special_tokens (
List[str], optional, defaults to['<special0>', '<special1>', '<special2>', '<special3>', '<special4>', '<special5>', '<special6>', '<special7>', '<special8>', '<special9>']) — 附加特殊标记列表。 - lang2id (
Dict[str, int], optional) — 将语言字符串标识符映射到其 ID 的字典。 - id2lang (
Dict[int, str], optional) — 将语言 ID 映射到其字符串标识符的字典。 - do_lowercase_and_remove_accent (
bool, optional, defaults toTrue) — 在分词时是否转换为小写并删除重音符号。
构建 XLM 分词器。基于 Byte-Pair Encoding。分词过程如下
- 大多数支持语言的 Moses 预处理和分词。
- 中文（Jieba）、日文（KyTea）和泰文（PyThaiNLP）的特定语言分词。
- 可选择将所有输入文本转换为小写并进行规范化。
- 参数
special_tokens和函数set_special_tokens可用于向词汇表添加其他符号（如“classify”）。 - 如果提供了
lang2id属性，则该属性会将模型支持的语言与其 ID 映射（为预训练词汇表自动设置）。 - 如果提供了
id2lang属性，则该属性会进行反向映射（为预训练词汇表自动设置）。
此分词器继承自 PreTrainedTokenizer，其中包含大多数主要方法。用户应参考此超类以获取有关这些方法的更多信息。
build_inputs_with_special_tokens
< source >( token_ids_0: List token_ids_1: Optional = None ) → List[int]
通过连接和添加特殊标记，从序列或序列对构建用于序列分类任务的模型输入。 XLM 序列具有以下格式
- 单序列：
<s> X </s> - 序列对：
<s> A </s> B </s>
get_special_tokens_mask
< source >( token_ids_0: List token_ids_1: Optional = None already_has_special_tokens: bool = False ) → List[int]
从没有添加特殊令牌的令牌列表中检索序列 ID。当使用 tokenizer 的 prepare_for_model 方法添加特殊令牌时，会调用此方法。
create_token_type_ids_from_sequences
< source >( token_ids_0: List token_ids_1: Optional = None ) → List[int]
从传递的两个序列创建掩码，用于序列对分类任务。XLM 序列
如果 token_ids_1 为 None，此方法仅返回掩码的第一部分（0）。
XLM 特定输出
class transformers.models.xlm.modeling_xlm.XLMForQuestionAnsweringOutput
< source >( loss: Optional = None start_top_log_probs: Optional = None start_top_index: Optional = None end_top_log_probs: Optional = None end_top_index: Optional = None cls_logits: Optional = None hidden_states: Optional = None attentions: Optional = None )
参数
- loss (
torch.FloatTensor，形状为(1,)，optional，如果同时提供了start_positions和end_positions则返回) — 分类损失，为起始令牌、结束令牌（以及如果提供，则为 is_impossible）分类损失之和。 - start_top_log_probs (
torch.FloatTensor，形状为(batch_size, config.start_n_top)，optional，如果未提供start_positions或end_positions则返回) — 顶部 config.start_n_top 个起始令牌可能性的对数概率（束搜索）。 - start_top_index (
torch.LongTensor，形状为(batch_size, config.start_n_top)，optional，如果未提供start_positions或end_positions则返回) — 顶部 config.start_n_top 个起始令牌可能性的索引（束搜索）。 - end_top_log_probs (
torch.FloatTensor，形状为(batch_size, config.start_n_top * config.end_n_top)，optional，如果未提供start_positions或end_positions则返回) — 顶部config.start_n_top * config.end_n_top个结束令牌可能性的对数概率（束搜索）。 - end_top_index (
torch.LongTensor，形状为(batch_size, config.start_n_top * config.end_n_top)，optional，如果未提供start_positions或end_positions则返回) — 顶部config.start_n_top * config.end_n_top个结束令牌可能性的索引（束搜索）。 - cls_logits (
torch.FloatTensor，形状为(batch_size,)，optional，如果未提供start_positions或end_positions则返回) — 答案的is_impossible标签的对数概率。 - hidden_states (
tuple(torch.FloatTensor)，optional，当传递output_hidden_states=True或config.output_hidden_states=True时返回) —torch.FloatTensor的元组（每个嵌入输出一个 + 每个层的输出一个），形状为(batch_size, sequence_length, hidden_size)。模型在每一层输出以及初始嵌入输出的隐藏状态。
- attentions (
tuple(torch.FloatTensor)，optional，当传递output_attentions=True或config.output_attentions=True时返回) —torch.FloatTensor的元组（每一层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 之后的注意力权重，用于计算自注意力头中的加权平均值。
使用 SquadHead 的问答模型输出的基类。
XLMModel
class transformers.XLMModel
< source >( config )
参数
- config (XLMConfig) — 带有模型所有参数的模型配置类。使用配置文件初始化不会加载与模型关联的权重，仅加载配置。查看 from_pretrained() 方法以加载模型权重。
裸 XLM 模型转换器，输出原始隐藏状态，顶部没有任何特定的头部。
此模型继承自 PreTrainedModel。查看超类文档，了解库为其所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、剪枝头等）。
此模型也是 PyTorch torch.nn.Module 子类。将其用作常规 PyTorch 模块，并参阅 PyTorch 文档，了解与常规用法和行为相关的所有事项。
forward
< source >( input_ids: Optional = None attention_mask: Optional = None langs: Optional = None token_type_ids: Optional = None position_ids: Optional = None lengths: Optional = None cache: Optional = None head_mask: Optional = None inputs_embeds: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None ) → transformers.modeling_outputs.BaseModelOutput 或 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 表示 token 未被掩码，
- 0 表示 token 已被掩码。
- langs (
torch.LongTensor，形状为(batch_size, sequence_length)，可选) — 一个并行的 token 序列，用于指示输入中每个 token 的语言。索引是语言 ID，可以通过使用模型配置中提供的两个转换映射从语言名称中获得（仅为多语言模型提供）。更准确地说，语言名称到语言 ID 的映射在model.config.lang2id中（这是一个字符串到整数的字典），而语言 ID 到语言名称 的映射在model.config.id2lang中（整数到字符串的字典）。有关详细的使用示例，请参阅多语言文档。
- 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 在 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 自注意力模块中选定 head 的掩码。掩码值在[0, 1]中选择：- 1 表示 head 未被掩码，
- 0 表示 head 已被掩码。
- inputs_embeds (
torch.FloatTensor，形状为(batch_size, sequence_length, hidden_size)，可选) — 可选地，您可以选择直接传递嵌入表示，而不是传递input_ids。如果您希望比模型的内部 embedding 查找矩阵更精细地控制如何将input_ids索引转换为关联的向量，这将非常有用。 - output_attentions (
bool，可选) — 是否返回所有 attention 层的 attentions tensors。有关更多详细信息，请参见返回的 tensors 下的attentions。 - output_hidden_states (
bool，可选) — 是否返回所有层的 hidden states。有关更多详细信息，请参见返回的 tensors 下的hidden_states。 - return_dict (
bool，可选) — 是否返回 ModelOutput 而不是一个普通 tuple。
返回
transformers.modeling_outputs.BaseModelOutput 或 tuple(torch.FloatTensor)
一个 transformers.modeling_outputs.BaseModelOutput 或一个 torch.FloatTensor 的 tuple （如果传递 return_dict=False 或当 config.return_dict=False 时），包含各种元素，具体取决于配置 (XLMConfig) 和输入。
-
last_hidden_state (
torch.FloatTensor，形状为(batch_size, sequence_length, hidden_size)) — 模型最后一层的输出端的 hidden-states 序列。 -
hidden_states (
tuple(torch.FloatTensor)，可选，当传递output_hidden_states=True或当config.output_hidden_states=True时返回) —torch.FloatTensor的 tuple（如果模型具有 embedding 层，则为 embedding 的输出，+ 每层输出一个），形状为(batch_size, sequence_length, hidden_size)。模型在每一层输出端的 Hidden-states，加上可选的初始 embedding 输出。
-
attentions (
tuple(torch.FloatTensor)，可选，当传递output_attentions=True或当config.output_attentions=True时返回) —torch.FloatTensor的 tuple（每层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。attention softmax 之后的 Attention 权重，用于计算自注意力 head 中的加权平均值。
XLMModel forward 方法，覆盖了 __call__ 特殊方法。
尽管 forward pass 的配方需要在该函数中定义，但应该在之后调用 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
< source >( config )
参数
- config (XLMConfig) — 模型配置类，包含模型的所有参数。使用配置文件初始化不会加载与模型关联的权重，仅加载配置。查看 from_pretrained() 方法以加载模型权重。
带有语言建模 head (权重与输入 embeddings 绑定的线性层) 的 XLM 模型转换器。
此模型继承自 PreTrainedModel。查看超类文档，了解库为其所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、剪枝头等）。
此模型也是 PyTorch torch.nn.Module 子类。将其用作常规 PyTorch 模块，并参阅 PyTorch 文档，了解与常规用法和行为相关的所有事项。
forward
< source >( input_ids: Optional = None attention_mask: Optional = None langs: Optional = None token_type_ids: Optional = None position_ids: Optional = None lengths: Optional = None cache: Optional = None head_mask: Optional = None inputs_embeds: Optional = None labels: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None ) → transformers.modeling_outputs.MaskedLMOutput 或 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 表示 token 未被掩码，
- 0 表示 token 已被掩码。
- langs (
torch.LongTensor，形状为(batch_size, sequence_length)，可选) — 一个并行的 token 序列，用于指示输入中每个 token 的语言。索引是语言 ID，可以通过使用模型配置中提供的两个转换映射从语言名称中获得（仅为多语言模型提供）。更准确地说，语言名称到语言 ID 的映射在model.config.lang2id中（这是一个字符串到整数的字典），而语言 ID 到语言名称 的映射在model.config.id2lang中（整数到字符串的字典）。有关详细的使用示例，请参阅多语言文档。
- 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,)，可选) — 每个句子的长度，可用于避免对填充 token 索引执行 attention。您也可以使用 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 自注意力模块中选定 head 的掩码。掩码值在[0, 1]中选择：- 1 表示 head 不被掩盖，
- 0 表示 head 被掩盖。
- inputs_embeds (
torch.FloatTensor，形状为(batch_size, sequence_length, hidden_size)，可选) — 可选地，您可以选择直接传递嵌入表示，而不是传递input_ids。如果您希望比模型的内部嵌入查找矩阵更精细地控制如何将input_ids索引转换为关联向量，这将非常有用。 - output_attentions (
bool，可选) — 是否返回所有注意力层的注意力张量。 有关更多详细信息，请参阅返回张量下的attentions。 - output_hidden_states (
bool，可选) — 是否返回所有层的隐藏状态。 有关更多详细信息，请参阅返回张量下的hidden_states。 - return_dict (
bool，可选) — 是否返回 ModelOutput 而不是普通元组。 - labels (
torch.LongTensor，形状为(batch_size, sequence_length)，可选) — 用于语言建模的标签。 请注意，标签在模型内部被移动，即您可以设置labels = input_ids。索引在[-100, 0, ..., config.vocab_size]中选择。 所有设置为-100的标签都将被忽略（掩盖），损失仅针对[0, ..., config.vocab_size]中的标签计算。
返回
transformers.modeling_outputs.MaskedLMOutput 或 tuple(torch.FloatTensor)
一个 transformers.modeling_outputs.MaskedLMOutput 或 torch.FloatTensor 的元组 (如果传递了 return_dict=False 或者当 config.return_dict=False 时)，包含各种元素，具体取决于配置 (XLMConfig) 和输入。
-
loss (
torch.FloatTensor，形状为(1,)，可选，当提供labels时返回) — 掩码语言建模 (MLM) 损失。 -
logits (
torch.FloatTensor，形状为(batch_size, sequence_length, config.vocab_size)) — 语言建模 head 的预测分数（SoftMax 之前每个词汇表 token 的分数）。 -
hidden_states (
tuple(torch.FloatTensor)，可选，当传递output_hidden_states=True或当config.output_hidden_states=True时返回) —torch.FloatTensor的 tuple（如果模型具有 embedding 层，则为 embedding 的输出，+ 每层输出一个），形状为(batch_size, sequence_length, hidden_size)。模型在每一层输出端的 Hidden-states，加上可选的初始 embedding 输出。
-
attentions (
tuple(torch.FloatTensor)，可选，当传递output_attentions=True或当config.output_attentions=True时返回) —torch.FloatTensor的 tuple（每层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。attention softmax 之后的 Attention 权重，用于计算自注意力 head 中的加权平均值。
XLMWithLMHeadModel 前向传播方法，覆盖了 __call__ 特殊方法。
尽管 forward pass 的配方需要在该函数中定义，但应该在之后调用 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 模型，顶部带有一个序列分类/回归 head（池化输出顶部的线性层），例如用于 GLUE 任务。
此模型继承自 PreTrainedModel。查看超类文档，了解库为其所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、剪枝头等）。
此模型也是 PyTorch torch.nn.Module 子类。将其用作常规 PyTorch 模块，并参阅 PyTorch 文档，了解与常规用法和行为相关的所有事项。
forward
< source >( input_ids: Optional = None attention_mask: Optional = None langs: Optional = None token_type_ids: Optional = None position_ids: Optional = None lengths: Optional = None cache: Optional = None head_mask: Optional = None inputs_embeds: Optional = None labels: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None ) → transformers.modeling_outputs.SequenceClassifierOutput 或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensor，形状为(batch_size, sequence_length)) — 词汇表中输入序列 token 的索引。可以使用 AutoTokenizer 获取索引。 有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
torch.FloatTensor，形状为(batch_size, sequence_length)，可选) — 用于避免在填充 token 索引上执行 attention 的掩码。 掩码值在[0, 1]中选择：- 1 表示 token 不被掩盖，
- 0 表示 token 被掩盖。
- langs (
torch.LongTensor，形状为(batch_size, sequence_length)，可选) — 要用于指示输入中每个 token 语言的并行 token 序列。 索引是语言 ID，可以通过使用模型配置中提供的两个转换映射从语言名称中获得（仅为多语言模型提供）。 更准确地说，语言名称到语言 ID 的映射在model.config.lang2id中（这是一个字符串到 int 的字典），而语言 ID 到语言名称 的映射在model.config.id2lang中（int 到字符串的字典）。请参阅 多语言文档 中详述的用法示例。
- 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 的位置索引。在范围[0, config.max_position_embeddings - 1]中选择。 - lengths (
torch.LongTensor，形状为(batch_size,)，可选) — 每个句子的长度，可用于避免对填充 token 索引执行 attention。您也可以使用 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)，可选) — 用于置空自注意力模块中选定 head 的掩码。掩码值应在[0, 1]中选择：- 1 表示 head 不被掩盖，
- 0 表示 head 被掩盖。
- inputs_embeds (
torch.FloatTensor，形状为(batch_size, sequence_length, hidden_size)，可选) — （可选）您可以选择直接传递嵌入表示，而不是传递input_ids。如果您希望比模型的内部嵌入查找矩阵更精细地控制如何将input_ids索引转换为关联向量，这将非常有用。 - output_attentions (
bool，可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参见返回张量下的attentions。 - output_hidden_states (
bool，可选) — 是否返回所有层的隐藏状态。有关更多详细信息，请参见返回张量下的hidden_states。 - return_dict (
bool，可选) — 是否返回 ModelOutput 而不是纯元组。 - labels (
torch.LongTensor，形状为(batch_size,)，可选) — 用于计算序列分类/回归损失的标签。索引应在[0, ..., config.num_labels - 1]中。如果config.num_labels == 1，则计算回归损失（均方误差损失）；如果config.num_labels > 1，则计算分类损失（交叉熵损失）。
返回
transformers.modeling_outputs.SequenceClassifierOutput 或 tuple(torch.FloatTensor)
一个 transformers.modeling_outputs.SequenceClassifierOutput 或一个 torch.FloatTensor 元组（如果传递了 return_dict=False 或当 config.return_dict=False 时），其中包含各种元素，具体取决于配置 (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时返回) —torch.FloatTensor的 tuple（如果模型具有 embedding 层，则为 embedding 的输出，+ 每层输出一个），形状为(batch_size, sequence_length, hidden_size)。模型在每一层输出端的 Hidden-states，加上可选的初始 embedding 输出。
-
attentions (
tuple(torch.FloatTensor)，可选，当传递output_attentions=True或当config.output_attentions=True时返回) —torch.FloatTensor的 tuple（每层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。attention softmax 之后的 Attention 权重，用于计算自注意力 head 中的加权平均值。
XLMForSequenceClassification 前向传播方法，覆盖了 __call__ 特殊方法。
尽管 forward pass 的配方需要在该函数中定义，但应该在之后调用 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（pooled 输出顶部的线性层和一个 softmax），例如用于 RocStories/SWAG 任务。
此模型继承自 PreTrainedModel。查看超类文档，了解库为其所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、剪枝头等）。
此模型也是 PyTorch torch.nn.Module 子类。将其用作常规 PyTorch 模块，并参阅 PyTorch 文档，了解与常规用法和行为相关的所有事项。
forward
< source >( input_ids: Optional = None attention_mask: Optional = None langs: Optional = None token_type_ids: Optional = None position_ids: Optional = None lengths: Optional = None cache: Optional = None head_mask: Optional = None inputs_embeds: Optional = None labels: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None ) → transformers.modeling_outputs.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中（这是一个字符串到整数的字典），语言 ID 到语言名称 的映射在model.config.id2lang中（整数到字符串的字典）。请参阅 多语言文档 中详述的使用示例。
- token_type_ids (
torch.LongTensor，形状为(batch_size, num_choices, sequence_length)，可选) — 用于指示输入的第一部分和第二部分的片段 token 索引。索引应在[0, 1]中选择：- 0 对应于 句子 A token，
- 1 对应于 句子 B token。
- position_ids (
torch.LongTensor，形状为(batch_size, num_choices, 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的字典，其中包含模型计算的预计算隐藏状态（注意力块中的键和值）（请参阅下面的cache输出）。可用于加速顺序解码。字典对象将在前向传播过程中就地修改，以添加新计算的隐藏状态。
- head_mask (
torch.FloatTensor，形状为(num_heads,)或(num_layers, num_heads)，可选) — 用于置空自注意力模块中选定 head 的掩码。掩码值应在[0, 1]中选择：- 1 表示 head 不被掩盖，
- 0 表示 head 被掩盖。
- 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时返回) —torch.FloatTensor的 tuple（如果模型具有 embedding 层，则为 embedding 的输出，+ 每层输出一个），形状为(batch_size, sequence_length, hidden_size)。模型在每一层输出端的 Hidden-states，加上可选的初始 embedding 输出。
-
attentions (
tuple(torch.FloatTensor)，可选，当传递output_attentions=True或当config.output_attentions=True时返回) —torch.FloatTensor的 tuple（每层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。attention softmax 之后的 Attention 权重，用于计算自注意力 head 中的加权平均值。
XLMForMultipleChoice 的 forward 方法，覆盖了 __call__ 特殊方法。
尽管 forward pass 的配方需要在该函数中定义，但应该在之后调用 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() 方法来加载模型权重。
带有 token 分类头的 XLM 模型（隐藏状态输出之上的线性层），例如用于命名实体识别 (NER) 任务。
此模型继承自 PreTrainedModel。查看超类文档，了解库为其所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、剪枝头等）。
此模型也是 PyTorch torch.nn.Module 子类。将其用作常规 PyTorch 模块，并参阅 PyTorch 文档，了解与常规用法和行为相关的所有事项。
forward
< source >( input_ids: Optional = None attention_mask: Optional = None langs: Optional = None token_type_ids: Optional = None position_ids: Optional = None lengths: Optional = None cache: Optional = None head_mask: Optional = None inputs_embeds: Optional = None labels: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None ) → transformers.modeling_outputs.TokenClassifierOutput 或 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 values selected in[0, 1]:- 1 表示 token 未被掩盖，
- 0 表示 token 已被掩盖。
- 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 的位置索引。在范围[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 模块的选定头的掩码。 Mask values selected in[0, 1]:- 1 表示头 未被掩盖，
- 0 表示头 已被掩盖。
- inputs_embeds (
torch.FloatTensor，形状为(batch_size, sequence_length, hidden_size)，可选) — （可选）您可以选择直接传递嵌入表示，而不是传递input_ids。 如果您希望比模型的内部嵌入查找矩阵更好地控制如何将input_ids索引转换为关联向量，这将非常有用。 - output_attentions (
bool，可选) — 是否返回所有 attention 层的 attention 张量。 有关更多详细信息，请参见返回张量下的attentions。 - output_hidden_states (
bool，可选) — 是否返回所有层的隐藏状态。 有关更多详细信息，请参见返回张量下的hidden_states。 - return_dict (
bool，可选) — 是否返回 ModelOutput 而不是普通元组。 - labels (
torch.LongTensor，形状为(batch_size, sequence_length)，可选) — 用于计算 token 分类损失的标签。 索引应在[0, ..., config.num_labels - 1]中。
返回
transformers.modeling_outputs.TokenClassifierOutput 或 tuple(torch.FloatTensor)
transformers.modeling_outputs.TokenClassifierOutput 或 torch.FloatTensor 的元组（如果传递了 return_dict=False 或当 config.return_dict=False 时），包含各种元素，具体取决于配置 (XLMConfig) 和输入。
-
loss (
torch.FloatTensor，形状为(1,)，可选，当提供labels时返回) — 分类损失。 -
logits (
torch.FloatTensor，形状为(batch_size, sequence_length, config.num_labels)) — 分类得分（在 SoftMax 之前）。 -
hidden_states (
tuple(torch.FloatTensor)，可选，当传递output_hidden_states=True或当config.output_hidden_states=True时返回) —torch.FloatTensor的 tuple（如果模型具有 embedding 层，则为 embedding 的输出，+ 每层输出一个），形状为(batch_size, sequence_length, hidden_size)。模型在每一层输出端的 Hidden-states，加上可选的初始 embedding 输出。
-
attentions (
tuple(torch.FloatTensor)，可选，当传递output_attentions=True或当config.output_attentions=True时返回) —torch.FloatTensor的 tuple（每层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。attention softmax 之后的 Attention 权重，用于计算自注意力 head 中的加权平均值。
XLMForTokenClassification 的 forward 方法，覆盖了 __call__ 特殊方法。
尽管 forward pass 的配方需要在该函数中定义，但应该在之后调用 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() 方法来加载模型权重。
带有 span 分类头的 XLM 模型，用于抽取式问答任务，例如 SQuAD（隐藏状态输出之上的线性层，用于计算 span start logits 和 span end logits）。
此模型继承自 PreTrainedModel。查看超类文档，了解库为其所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、剪枝头等）。
此模型也是 PyTorch torch.nn.Module 子类。将其用作常规 PyTorch 模块，并参阅 PyTorch 文档，了解与常规用法和行为相关的所有事项。
forward
< source >( input_ids: Optional = None attention_mask: Optional = None langs: Optional = None token_type_ids: Optional = None position_ids: Optional = None lengths: Optional = None cache: Optional = None head_mask: Optional = None inputs_embeds: Optional = None start_positions: Optional = None end_positions: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None ) → transformers.modeling_outputs.QuestionAnsweringModelOutput 或 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)，可选) — 用于指示输入中每个 token 语言的并行 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)，可选) — 位置嵌入中每个输入序列 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 模块的选定 head 的掩码。 掩码值在[0, 1]中选择：- 1 表示 head 未被掩码，
- 0 表示 head 被掩码。
- inputs_embeds (
torch.FloatTensor，形状为(batch_size, sequence_length, hidden_size)，可选) — 可选地，您可以选择直接传递嵌入表示，而不是传递input_ids。 如果您希望比模型的内部嵌入查找矩阵更精细地控制如何将input_ids索引转换为关联向量，这将非常有用。 - output_attentions (
bool，可选) — 是否返回所有 attention 层的 attention tensors。 有关更多详细信息，请参阅返回的 tensors 下的attentions。 - output_hidden_states (
bool，可选) — 是否返回所有层的 hidden states。 有关更多详细信息，请参阅返回的 tensors 下的hidden_states。 - return_dict (
bool，可选) — 是否返回 ModelOutput 而不是普通元组。 - start_positions (
torch.LongTensor，形状为(batch_size,)，可选) — 用于计算 token 分类损失的标记跨度开始位置（索引）的标签。 位置被限制在序列的长度 (sequence_length) 内。 序列之外的位置不计入损失计算。 - end_positions (
torch.LongTensor，形状为(batch_size,)，可选) — 用于计算 token 分类损失的标记跨度结束位置（索引）的标签。 位置被限制在序列的长度 (sequence_length) 内。 序列之外的位置不计入损失计算。
返回
transformers.modeling_outputs.QuestionAnsweringModelOutput 或 tuple(torch.FloatTensor)
一个 transformers.modeling_outputs.QuestionAnsweringModelOutput 或 torch.FloatTensor 的元组（如果传递 return_dict=False 或当 config.return_dict=False 时），包含各种元素，具体取决于配置 (XLMConfig) 和输入。
-
loss (
torch.FloatTensor，形状为(1,)，可选，当提供labels时返回) — 总跨度提取损失是开始和结束位置的交叉熵之和。 -
start_logits (
torch.FloatTensor，形状为(batch_size, sequence_length)) — 跨度开始得分（SoftMax 之前）。 -
end_logits (
torch.FloatTensor，形状为(batch_size, sequence_length)) — 跨度结束得分（SoftMax 之前）。 -
hidden_states (
tuple(torch.FloatTensor)，可选，当传递output_hidden_states=True或当config.output_hidden_states=True时返回) —torch.FloatTensor的 tuple（如果模型具有 embedding 层，则为 embedding 的输出，+ 每层输出一个），形状为(batch_size, sequence_length, hidden_size)。模型在每一层输出端的 Hidden-states，加上可选的初始 embedding 输出。
-
attentions (
tuple(torch.FloatTensor)，可选，当传递output_attentions=True或当config.output_attentions=True时返回) —torch.FloatTensor的 tuple（每层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。attention softmax 之后的 Attention 权重，用于计算自注意力 head 中的加权平均值。
XLMForQuestionAnsweringSimple 前向传播方法，覆盖了 __call__ 特殊方法。
尽管 forward pass 的配方需要在该函数中定义，但应该在之后调用 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 跨度分类 head，用于抽取式问答任务，如 SQuAD（在 hidden-states 输出之上添加线性层以计算 span start logits 和 span end logits）。
此模型继承自 PreTrainedModel。查看超类文档，了解库为其所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、剪枝头等）。
此模型也是 PyTorch torch.nn.Module 子类。将其用作常规 PyTorch 模块，并参阅 PyTorch 文档，了解与常规用法和行为相关的所有事项。
forward
< source >( input_ids: Optional = None attention_mask: Optional = None langs: Optional = None token_type_ids: Optional = None position_ids: Optional = None lengths: Optional = None cache: Optional = None head_mask: Optional = None inputs_embeds: Optional = None start_positions: Optional = None end_positions: Optional = None is_impossible: Optional = None cls_index: Optional = None p_mask: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None ) → transformers.models.xlm.modeling_xlm.XLMForQuestionAnsweringOutput 或 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)，可选) — 用于指示输入中每个 token 语言的并行 token 序列。索引是语言 ID，可以通过使用模型配置中提供的两个转换映射从语言名称获得（仅为多语言模型提供）。更准确地说，语言名称到语言 ID 的映射在model.config.lang2id中（这是一个字符串到整数的字典），而语言 ID 到语言名称 的映射在model.config.id2lang中（整数到字符串的字典）。请参阅 多语言文档 中详述的使用示例。
- 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)，可选) — 位置嵌入中每个输入序列 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 块中的 key 和 value）（请参阅下面的cache输出）。可用于加速顺序解码。字典对象将在前向传播过程中就地修改，以添加新计算的隐藏状态。
- head_mask (
torch.FloatTensor，形状为(num_heads,)或(num_layers, num_heads)，可选) — 用于 nullify 自注意力模块中选定 head 的 mask。Mask 值在[0, 1]中选择：- 1 表示 head 未被 masking，
- 0 表示 head 已被 masking。
- inputs_embeds (
torch.FloatTensor，形状为(batch_size, sequence_length, hidden_size)，可选) — 可选地，您可以选择直接传递嵌入表示，而不是传递input_ids。如果您希望比模型的内部嵌入查找矩阵更精细地控制如何将input_ids索引转换为关联的向量，这将非常有用。 - output_attentions (
bool，可选) — 是否返回所有 attention 层的 attention 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)，可选) — 可选的 token mask，指示哪些 token 不能在答案中（例如 [CLS], [PAD], ...）。1.0 表示 token 应该被 masking。0.0 表示 token 未被 masking。
返回
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 可能性的对数概率（beam-search）。 -
start_top_index (
torch.LongTensor，形状为(batch_size, config.start_n_top)，可选，如果未提供start_positions或end_positions则返回) — 前 config.start_n_top 个起始 token 可能性的索引（beam-search）。 -
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 可能性的对数概率（beam-search）。 -
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 可能性的索引（beam-search）。 -
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的 tuple (embeddings 的输出一个，每层输出一个)，形状为(batch_size, sequence_length, hidden_size)。模型在每一层输出的 hidden-states 加上初始 embedding 输出。
-
attentions (
tuple(torch.FloatTensor)，可选，当传递output_attentions=True或当config.output_attentions=True时返回) —torch.FloatTensor的 tuple（每层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。attention softmax 之后的 Attention 权重，用于计算自注意力 head 中的加权平均值。
XLMForQuestionAnswering forward 方法，覆盖了 __call__ 特殊方法。
尽管 forward pass 的配方需要在该函数中定义，但应该在之后调用 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 模型转换器，输出原始隐藏状态，顶部没有任何特定的头部。
此模型继承自 TFPreTrainedModel。查看超类文档，了解库为所有模型实现的通用方法（例如下载或保存、调整输入 embeddings 大小、剪枝 head 等）。
此模型也是 keras.Model 子类。像使用常规 TF 2.0 Keras 模型一样使用它，并参考 TF 2.0 文档了解所有与通用用法和行为相关的事项。
transformers 中的 TensorFlow 模型和层接受两种输入格式
- 将所有输入作为关键字参数（如 PyTorch 模型），或
- 将所有输入作为列表、tuple 或字典放在第一个位置参数中。
支持第二种格式的原因是，Keras 方法在将输入传递给模型和层时更喜欢这种格式。由于这种支持，当使用诸如 model.fit() 之类的方法时，对于您来说，事情应该“正常工作” - 只需以 model.fit() 支持的任何格式传递您的输入和标签即可！但是，如果您想在 Keras 方法（如 fit() 和 predict()）之外使用第二种格式，例如，当使用 Keras Functional API 创建您自己的层或模型时，您可以使用以下三种可能性来收集第一个位置参数中的所有输入 Tensors
- 仅使用
input_ids且不包含其他内容的单个 Tensor：model(input_ids) - 长度可变的列表，其中包含一个或多个输入 Tensors，顺序与文档字符串中给出的顺序相同：
model([input_ids, attention_mask])或model([input_ids, attention_mask, token_type_ids]) - 字典，其中包含一个或多个输入 Tensors，这些 Tensors 与文档字符串中给出的输入名称相关联：
model({"input_ids": input_ids, "token_type_ids": token_type_ids})
请注意，当使用 subclassing 创建模型和层时，您无需担心任何这些问题，因为您可以像将输入传递给任何其他 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 (形状为
(batch_size, sequence_length)的Numpy array或tf.Tensor) — 词汇表中输入序列 token 的索引。索引可以使用 AutoTokenizer 获得。有关详细信息，请参阅 PreTrainedTokenizer.call() 和 PreTrainedTokenizer.encode()。
- attention_mask (
Numpy array或tf.Tensor，形状为(batch_size, sequence_length)，可选) — 用于避免在 padding token 索引上执行 attention 的掩码。掩码值在[0, 1]中选择：- 1 表示 token 未被掩码，
- 0 表示 token 已被掩码。
- langs (
tf.Tensor或Numpy array，形状为(batch_size, sequence_length)，可选) — 一个并行的 token 序列，用于指示输入中每个 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)，可选) — 位置嵌入中每个输入序列 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)，可选) — 用于使 self-attention 模块的选定 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 tensors。有关更多详细信息，请参阅返回的 tensors 下的attentions。此参数只能在 eager 模式下使用，在 graph 模式下将使用 config 中的值。 - output_hidden_states (
bool，可选) — 是否返回所有层的隐藏状态。有关更多详细信息，请参阅返回的 tensors 下的hidden_states。此参数只能在 eager 模式下使用，在 graph 模式下将使用 config 中的值。 - 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)。模型在每一层输出的 hidden-states 加上初始 embedding 输出。
-
attentions (
tuple(tf.Tensor)，可选，当传递output_attentions=True或当config.output_attentions=True时返回) —tf.Tensor元组（每层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。attention softmax 之后的 Attention 权重，用于计算自注意力 head 中的加权平均值。
TFXLMModel 前向传播方法，覆盖了 __call__ 特殊方法。
尽管 forward pass 的配方需要在该函数中定义，但应该在之后调用 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() 方法以加载模型权重。
带有语言建模 head (权重与输入 embeddings 绑定的线性层) 的 XLM 模型转换器。
此模型继承自 TFPreTrainedModel。查看超类文档，了解库为所有模型实现的通用方法（例如下载或保存、调整输入 embeddings 大小、剪枝 head 等）。
此模型也是 keras.Model 子类。像使用常规 TF 2.0 Keras 模型一样使用它，并参考 TF 2.0 文档了解所有与通用用法和行为相关的事项。
transformers 中的 TensorFlow 模型和层接受两种输入格式
- 将所有输入作为关键字参数（如 PyTorch 模型），或
- 将所有输入作为列表、tuple 或字典放在第一个位置参数中。
支持第二种格式的原因是，Keras 方法在将输入传递给模型和层时更喜欢这种格式。由于这种支持，当使用诸如 model.fit() 之类的方法时，对于您来说，事情应该“正常工作” - 只需以 model.fit() 支持的任何格式传递您的输入和标签即可！但是，如果您想在 Keras 方法（如 fit() 和 predict()）之外使用第二种格式，例如，当使用 Keras Functional API 创建您自己的层或模型时，您可以使用以下三种可能性来收集第一个位置参数中的所有输入 Tensors
- 仅使用
input_ids且不包含其他内容的单个 Tensor：model(input_ids) - 长度可变的列表，其中包含一个或多个输入 Tensors，顺序与文档字符串中给出的顺序相同：
model([input_ids, attention_mask])或model([input_ids, attention_mask, token_type_ids]) - 字典，其中包含一个或多个输入 Tensors，这些 Tensors 与文档字符串中给出的输入名称相关联：
model({"input_ids": input_ids, "token_type_ids": token_type_ids})
请注意，当使用 subclassing 创建模型和层时，您无需担心任何这些问题，因为您可以像将输入传递给任何其他 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)) — 词汇表中输入序列 token 的索引。索引可以使用 AutoTokenizer 获得。 有关详细信息，请参阅 PreTrainedTokenizer.call() 和 PreTrainedTokenizer.encode()。
- attention_mask (
Numpy array或tf.Tensor，形状为(batch_size, sequence_length)，可选) — 用于避免在 padding token 索引上执行 attention 的掩码。掩码值在[0, 1]中选择：- 1 表示 token 未被掩码，
- 0 表示 token 已被掩码。
- langs (
tf.Tensor或Numpy array，形状为(batch_size, sequence_length)，可选) — 一个并行的 token 序列，用于指示输入中每个 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)，可选) — 位置嵌入中每个输入序列 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)，可选) — 用于使 self-attention 模块的选定 head 失效的掩码。掩码值在[0, 1]中选择：- 1 表示 head 未被掩码，
- 0 表示 head 已被掩码。
- inputs_embeds (形状为
(batch_size, sequence_length, hidden_size)的tf.Tensor, 可选) — （可选）您可以选择直接传递嵌入表示，而不是传递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.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 (形状为
(batch_size, sequence_length, config.vocab_size)的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)。模型在每一层输出的 hidden-states 加上初始 embedding 输出。
-
attentions (
tuple(tf.Tensor)，可选，当传递output_attentions=True或当config.output_attentions=True时返回) —tf.Tensor元组（每层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。attention softmax 之后的 Attention 权重，用于计算自注意力 head 中的加权平均值。
TFXLMWithLMHeadModel 前向方法，覆盖了 __call__ 特殊方法。
尽管 forward pass 的配方需要在该函数中定义，但应该在之后调用 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 模型，顶部带有一个序列分类/回归 head（池化输出顶部的线性层），例如用于 GLUE 任务。
此模型继承自 TFPreTrainedModel。查看超类文档，了解库为所有模型实现的通用方法（例如下载或保存、调整输入 embeddings 大小、剪枝 head 等）。
此模型也是 keras.Model 子类。像使用常规 TF 2.0 Keras 模型一样使用它，并参考 TF 2.0 文档了解所有与通用用法和行为相关的事项。
transformers 中的 TensorFlow 模型和层接受两种输入格式
- 将所有输入作为关键字参数（如 PyTorch 模型），或
- 将所有输入作为列表、tuple 或字典放在第一个位置参数中。
支持第二种格式的原因是，Keras 方法在将输入传递给模型和层时更喜欢这种格式。由于这种支持，当使用诸如 model.fit() 之类的方法时，对于您来说，事情应该“正常工作” - 只需以 model.fit() 支持的任何格式传递您的输入和标签即可！但是，如果您想在 Keras 方法（如 fit() 和 predict()）之外使用第二种格式，例如，当使用 Keras Functional API 创建您自己的层或模型时，您可以使用以下三种可能性来收集第一个位置参数中的所有输入 Tensors
- 仅使用
input_ids且不包含其他内容的单个 Tensor：model(input_ids) - 长度可变的列表，其中包含一个或多个输入 Tensors，顺序与文档字符串中给出的顺序相同：
model([input_ids, attention_mask])或model([input_ids, attention_mask, token_type_ids]) - 字典，其中包含一个或多个输入 Tensors，这些 Tensors 与文档字符串中给出的输入名称相关联：
model({"input_ids": input_ids, "token_type_ids": token_type_ids})
请注意，当使用 subclassing 创建模型和层时，您无需担心任何这些问题，因为您可以像将输入传递给任何其他 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 (形状为
(batch_size, sequence_length)的Numpy array或tf.Tensor) — 词汇表中输入序列标记的索引。可以使用 AutoTokenizer 获取索引。 有关详细信息，请参阅 PreTrainedTokenizer.call() 和 PreTrainedTokenizer.encode()。
- attention_mask (形状为
(batch_size, sequence_length)的Numpy array或tf.Tensor, 可选) — 用于避免在填充标记索引上执行注意力的掩码。 在[0, 1]中选择的掩码值：- 1 表示未被掩盖的标记，
- 0 表示被掩盖的标记。
- langs (形状为
(batch_size, sequence_length)的tf.Tensor或Numpy array, 可选) — 要用于指示输入中每个标记的语言的并行标记序列。 索引是语言 ID，可以使用模型配置中提供的两个转换映射从语言名称中获取（仅为多语言模型提供）。 更准确地说，语言名称到语言 ID 的映射在model.config.lang2id中（这是一个从字符串到 int 的字典），而语言 ID 到语言名称的映射在model.config.id2lang中（从 int 到字符串的字典）。有关详细用法示例，请参阅 多语言文档。
- token_type_ids (形状为
(batch_size, sequence_length)的Numpy array或tf.Tensor, 可选) — 段标记索引，用于指示输入的第一部分和第二部分。 索引在[0, 1]中选择：- 0 对应于句子 A 标记，
- 1 对应于句子 B 标记。
- position_ids (形状为
(batch_size, sequence_length)的Numpy array或tf.Tensor, 可选) — 位置嵌入中每个输入序列标记的位置索引。 在范围[0, config.max_position_embeddings - 1]中选择。 - lengths (形状为
(batch_size,)的tf.Tensor或Numpy array, 可选) — 每个句子的长度，可用于避免在填充标记索引上执行注意力。 您也可以使用 attention_mask 获得相同的结果（见上文），此处保留是为了兼容性。 在[0, ..., input_ids.size(-1)]中选择的索引。 - cache (
Dict[str, tf.Tensor], 可选) — 字符串到tf.Tensor的字典，其中包含模型计算的预计算隐藏状态（注意力块中的键和值）（请参阅下面的cache输出）。 可用于加速顺序解码。字典对象将在前向传递期间就地修改，以添加新计算的隐藏状态。
- head_mask (形状为
(num_heads,)或(num_layers, num_heads)的Numpy array或tf.Tensor, 可选) — 用于使自注意力模块的选定头无效的掩码。 在[0, 1]中选择的掩码值：- 1 表示头未被掩盖，
- 0 表示头被掩盖。
- inputs_embeds (形状为
(batch_size, sequence_length, hidden_size)的tf.Tensor, 可选) — （可选）您可以选择直接传递嵌入表示，而不是传递input_ids。如果您希望比模型的内部嵌入查找矩阵更灵活地控制如何将input_ids索引转换为关联向量，这将非常有用。 - output_attentions (
bool, 可选) — 是否返回所有注意力层的注意力张量。 有关更多详细信息，请参阅返回张量下的attentions。 此参数只能在立即模式下使用，在图模式下将使用配置中的值。 - output_hidden_states (
bool, 可选) — 是否返回所有层的隐藏状态。 有关更多详细信息，请参阅返回张量下的hidden_states。 此参数只能在立即模式下使用，在图模式下将使用配置中的值。 - return_dict (
bool, 可选) — 是否返回 ModelOutput 而不是普通元组。 此参数可以在立即模式下使用，在图模式下，该值将始终设置为 True。 - training (
bool, optional, 默认为False) — 是否在训练模式下使用模型（例如 dropout 模块等一些模块在训练和评估模式下的行为有所不同）。 - labels (形状为
(batch_size,)的tf.Tensor, 可选) — 用于计算序列分类/回归损失的标签。索引应在[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 (形状为
(batch_size, )的tf.Tensor, 可选, 当提供labels时返回) — 分类损失（如果 config.num_labels==1 则为回归损失）。 -
logits (形状为
(batch_size, config.num_labels)的tf.Tensor) — 分类得分（或如果 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)。模型在每一层输出的 hidden-states 加上初始 embedding 输出。
-
attentions (
tuple(tf.Tensor)，可选，当传递output_attentions=True或当config.output_attentions=True时返回) —tf.Tensor元组（每层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。attention softmax 之后的 Attention 权重，用于计算自注意力 head 中的加权平均值。
TFXLMForSequenceClassification 的前向传播方法，覆盖了 __call__ 特殊方法。
尽管 forward pass 的配方需要在该函数中定义，但应该在之后调用 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（pooled 输出顶部的线性层和一个 softmax），例如用于 RocStories/SWAG 任务。
此模型继承自 TFPreTrainedModel。查看超类文档，了解库为所有模型实现的通用方法（例如下载或保存、调整输入 embeddings 大小、剪枝 head 等）。
此模型也是 keras.Model 子类。像使用常规 TF 2.0 Keras 模型一样使用它，并参考 TF 2.0 文档了解所有与通用用法和行为相关的事项。
transformers 中的 TensorFlow 模型和层接受两种输入格式
- 将所有输入作为关键字参数（如 PyTorch 模型），或
- 将所有输入作为列表、tuple 或字典放在第一个位置参数中。
支持第二种格式的原因是，Keras 方法在将输入传递给模型和层时更喜欢这种格式。由于这种支持，当使用诸如 model.fit() 之类的方法时，对于您来说，事情应该“正常工作” - 只需以 model.fit() 支持的任何格式传递您的输入和标签即可！但是，如果您想在 Keras 方法（如 fit() 和 predict()）之外使用第二种格式，例如，当使用 Keras Functional API 创建您自己的层或模型时，您可以使用以下三种可能性来收集第一个位置参数中的所有输入 Tensors
- 仅使用
input_ids且不包含其他内容的单个 Tensor：model(input_ids) - 长度可变的列表，其中包含一个或多个输入 Tensors，顺序与文档字符串中给出的顺序相同：
model([input_ids, attention_mask])或model([input_ids, attention_mask, token_type_ids]) - 字典，其中包含一个或多个输入 Tensors，这些 Tensors 与文档字符串中给出的输入名称相关联：
model({"input_ids": input_ids, "token_type_ids": token_type_ids})
请注意，当使用 subclassing 创建模型和层时，您无需担心任何这些问题，因为您可以像将输入传递给任何其他 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 (形状为
(batch_size, num_choices, sequence_length)的Numpy array或tf.Tensor) — 词汇表中输入序列标记的索引。可以使用 AutoTokenizer 获取索引。 有关详细信息，请参见 PreTrainedTokenizer.call() 和 PreTrainedTokenizer.encode()。
- attention_mask (形状为
(batch_size, num_choices, sequence_length)的Numpy array或tf.Tensor, 可选) — 掩码，用于避免在填充标记索引上执行注意力机制。掩码值在[0, 1]中选择：- 1 表示标记未被掩盖，
- 0 表示标记已被掩盖。
- langs (形状为
(batch_size, num_choices, sequence_length)的tf.Tensor或Numpy array, 可选) — 一个并行的标记序列，用于指示输入中每个标记的语言。索引是语言 ID，可以通过使用模型配置中提供的两个转换映射从语言名称中获得（仅适用于多语言模型）。更准确地说，语言名称到语言 ID 的映射在model.config.lang2id中（这是一个字符串到整数的字典），而语言 ID 到语言名称 的映射在model.config.id2lang中（整数到字符串的字典）。有关详细用法示例，请参见多语言文档。
- token_type_ids (形状为
(batch_size, num_choices, sequence_length)的Numpy array或tf.Tensor, 可选) — 分段标记索引，用于指示输入的第一个和第二个部分。索引在[0, 1]中选择：- 0 对应于 sentence A 标记，
- 1 对应于 sentence B 标记。
- position_ids (形状为
(batch_size, num_choices, sequence_length)的Numpy array或tf.Tensor, 可选) — 位置嵌入中每个输入序列标记的位置索引。在范围[0, config.max_position_embeddings - 1]中选择。 - lengths (形状为
(batch_size,)的tf.Tensor或Numpy array, 可选) — 每个句子的长度，可用于避免在填充标记索引上执行注意力机制。您也可以使用 attention_mask 来获得相同的结果（见上文），此处保留是为了兼容性。索引在[0, ..., input_ids.size(-1)]中选择。 - cache (
Dict[str, tf.Tensor], 可选) — 字符串到tf.Tensor的字典，其中包含模型计算的预计算隐藏状态（注意力块中的键和值）（请参阅下面的cache输出）。可用于加速顺序解码。字典对象将在前向传播期间就地修改，以添加新计算的隐藏状态。
- head_mask (形状为
(num_heads,)或(num_layers, num_heads)的Numpy array或tf.Tensor, 可选) — 用于使自注意力模块的选定头无效的掩码。掩码值在[0, 1]中选择：- 1 表示头未被掩盖，
- 0 表示头已被掩盖。
- inputs_embeds (形状为
(batch_size, num_choices, sequence_length, hidden_size)的tf.Tensor, 可选) — （可选）您可以选择直接传递嵌入表示，而不是传递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, optional, 默认为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 (形状为 (batch_size, ) 的
tf.Tensor, 可选, 当提供labels时返回) — 分类损失。 -
logits (形状为
(batch_size, num_choices)的tf.Tensor) — num_choices 是输入张量的第二个维度。（请参阅上面的 input_ids ）。分类得分（在 SoftMax 之前）。
-
hidden_states (
tuple(tf.Tensor), 可选, 当传递output_hidden_states=True或当config.output_hidden_states=True时返回) —tf.Tensor的元组（嵌入输出一个，每层输出一个），形状为(batch_size, sequence_length, hidden_size)。模型在每一层输出的 hidden-states 加上初始 embedding 输出。
-
attentions (
tuple(tf.Tensor)，可选，当传递output_attentions=True或当config.output_attentions=True时返回) —tf.Tensor元组（每层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。attention softmax 之后的 Attention 权重，用于计算自注意力 head 中的加权平均值。
TFXLMForMultipleChoice 的前向传播方法，覆盖了 __call__ 特殊方法。
尽管 forward pass 的配方需要在该函数中定义，但应该在之后调用 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
class transformers.TFXLMForTokenClassification
< source >( config *inputs **kwargs )
参数
- config (XLMConfig) — 带有模型所有参数的模型配置类。使用配置文件初始化不会加载与模型关联的权重，仅加载配置。查看 from_pretrained() 方法来加载模型权重。
带有 token 分类头的 XLM 模型（隐藏状态输出之上的线性层），例如用于命名实体识别 (NER) 任务。
此模型继承自 TFPreTrainedModel。查看超类文档，了解库为所有模型实现的通用方法（例如下载或保存、调整输入 embeddings 大小、剪枝 head 等）。
此模型也是 keras.Model 子类。像使用常规 TF 2.0 Keras 模型一样使用它，并参考 TF 2.0 文档了解所有与通用用法和行为相关的事项。
transformers 中的 TensorFlow 模型和层接受两种输入格式
- 将所有输入作为关键字参数（如 PyTorch 模型），或
- 将所有输入作为列表、tuple 或字典放在第一个位置参数中。
支持第二种格式的原因是，Keras 方法在将输入传递给模型和层时更喜欢这种格式。由于这种支持，当使用诸如 model.fit() 之类的方法时，对于您来说，事情应该“正常工作” - 只需以 model.fit() 支持的任何格式传递您的输入和标签即可！但是，如果您想在 Keras 方法（如 fit() 和 predict()）之外使用第二种格式，例如，当使用 Keras Functional API 创建您自己的层或模型时，您可以使用以下三种可能性来收集第一个位置参数中的所有输入 Tensors
- 仅使用
input_ids且不包含其他内容的单个 Tensor：model(input_ids) - 长度可变的列表，其中包含一个或多个输入 Tensors，顺序与文档字符串中给出的顺序相同：
model([input_ids, attention_mask])或model([input_ids, attention_mask, token_type_ids]) - 字典，其中包含一个或多个输入 Tensors，这些 Tensors 与文档字符串中给出的输入名称相关联：
model({"input_ids": input_ids, "token_type_ids": token_type_ids})
请注意，当使用 subclassing 创建模型和层时，您无需担心任何这些问题，因为您可以像将输入传递给任何其他 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 或 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 令牌索引上执行注意力机制。掩码值在[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 (
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_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 失效的掩码。掩码值在[0, 1]中选择：- 1 表示 head 未被掩盖，
- 0 表示 head 已被掩盖。
- 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, 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的元组（嵌入输出一个，每层输出一个），形状为(batch_size, sequence_length, hidden_size)。模型在每一层输出的 hidden-states 加上初始 embedding 输出。
-
attentions (
tuple(tf.Tensor)，可选，当传递output_attentions=True或当config.output_attentions=True时返回) —tf.Tensor元组（每层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。attention softmax 之后的 Attention 权重，用于计算自注意力 head 中的加权平均值。
TFXLMForTokenClassification 前向方法，覆盖了 __call__ 特殊方法。
尽管 forward pass 的配方需要在该函数中定义，但应该在之后调用 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
class transformers.TFXLMForQuestionAnsweringSimple
< source >( config *inputs **kwargs )
参数
- config (XLMConfig) — 模型配置类，包含模型的所有参数。使用配置文件初始化不会加载与模型关联的权重，仅加载配置。查看 from_pretrained() 方法以加载模型权重。
XLM 模型，顶部带有一个 span 分类头，用于执行抽取式问答任务，例如 SQuAD（隐藏状态输出顶部的线性层，用于计算 span start logits 和 span end logits）。
此模型继承自 TFPreTrainedModel。查看超类文档，了解库为所有模型实现的通用方法（例如下载或保存、调整输入 embeddings 大小、剪枝 head 等）。
此模型也是 keras.Model 子类。像使用常规 TF 2.0 Keras 模型一样使用它，并参考 TF 2.0 文档了解所有与通用用法和行为相关的事项。
transformers 中的 TensorFlow 模型和层接受两种输入格式
- 将所有输入作为关键字参数（如 PyTorch 模型），或
- 将所有输入作为列表、tuple 或字典放在第一个位置参数中。
支持第二种格式的原因是，Keras 方法在将输入传递给模型和层时更喜欢这种格式。由于这种支持，当使用诸如 model.fit() 之类的方法时，对于您来说，事情应该“正常工作” - 只需以 model.fit() 支持的任何格式传递您的输入和标签即可！但是，如果您想在 Keras 方法（如 fit() 和 predict()）之外使用第二种格式，例如，当使用 Keras Functional API 创建您自己的层或模型时，您可以使用以下三种可能性来收集第一个位置参数中的所有输入 Tensors
- 仅使用
input_ids且不包含其他内容的单个 Tensor：model(input_ids) - 长度可变的列表，其中包含一个或多个输入 Tensors，顺序与文档字符串中给出的顺序相同：
model([input_ids, attention_mask])或model([input_ids, attention_mask, token_type_ids]) - 字典，其中包含一个或多个输入 Tensors，这些 Tensors 与文档字符串中给出的输入名称相关联：
model({"input_ids": input_ids, "token_type_ids": token_type_ids})
请注意，当使用 subclassing 创建模型和层时，您无需担心任何这些问题，因为您可以像将输入传递给任何其他 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 或 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 令牌索引上执行注意力机制。掩码值在[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 (
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 层的 attentions 张量。有关更多详细信息，请参阅返回张量下的attentions。此参数只能在即时模式下使用，在图模式下将使用配置中的值。 - output_hidden_states (
bool，可选) — 是否返回所有层的隐藏状态。有关更多详细信息，请参阅返回张量下的hidden_states。此参数只能在即时模式下使用，在图模式下将使用配置中的值。 - return_dict (
bool，可选) — 是否返回 ModelOutput 而不是普通元组。此参数可以在即时模式下使用，在图模式下该值将始终设置为 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 的元组（如果传递了 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的元组（嵌入输出一个，每层输出一个），形状为(batch_size, sequence_length, hidden_size)。模型在每一层输出的 hidden-states 加上初始 embedding 输出。
-
attentions (
tuple(tf.Tensor)，可选，当传递output_attentions=True或当config.output_attentions=True时返回) —tf.Tensor元组（每层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。attention softmax 之后的 Attention 权重，用于计算自注意力 head 中的加权平均值。
TFXLMForQuestionAnsweringSimple 前向方法，覆盖了 __call__ 特殊方法。
尽管 forward pass 的配方需要在该函数中定义，但应该在之后调用 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]