Transformers 4.37 中文文档（六十一）（5）

Transformers 4.37 中文文档（六十一）（4）https://developer.aliyun.com/article/1564140

XLMForMultipleChoice

class transformers.XLMForMultipleChoice

<来源>

( config *inputs **kwargs )

参数

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

XLM 模型，顶部带有多选分类头（池化输出上的线性层和 Softmax），例如用于 RocStories/SWAG 任务。

此模型继承自 PreTrainedModel。查看超类文档以获取库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入、修剪头等）。

此模型还是 PyTorch torch.nn.Module子类。将其用作常规 PyTorch 模块，并参考 PyTorch 文档以获取有关一般用法和行为的所有相关信息。

forward

<来源>

( 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 ) → export const metadata = 'undefined';transformers.modeling_outputs.MultipleChoiceModelOutput or tuple(torch.FloatTensor)

参数

• input_ids（形状为(batch_size, num_choices, sequence_length)的torch.LongTensor）— 词汇表中输入序列标记的索引。
  可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.encode()和 PreTrainedTokenizer.call()。
  什么是输入 IDs？
  
• attention_mask（形状为(batch_size, num_choices, sequence_length)的torch.FloatTensor，可选）— 用于避免在填充标记索引上执行注意力的掩码。掩码值在[0, 1]中选择：

• 1 表示未被遮罩的标记，
  
• 0 表示被遮罩的标记。
  

• 什么是注意力掩码？
  
• langs（形状为(batch_size, num_choices, sequence_length)的torch.LongTensor，可选）— 用于指示输入中每个标记的语言的并行标记序列。索引是语言 id，可以通过模型配置中提供的两个转换映射从语言名称中获取（仅适用于多语言模型）。更准确地说，语言名称到语言 id映射在model.config.lang2id中（这是一个字符串到整数的字典），语言 id 到语言名称映射在model.config.id2lang中（整数到字符串的字典）。
  有关详细的用法示例，请参阅多语言文档。
  
• token_type_ids（形状为(batch_size, num_choices, sequence_length)的torch.LongTensor，可选）— 分段标记索引，指示输入的第一部分和第二部分。索引在[0, 1]中选择：

• 0 对应于句子 A标记，
  
• 1 对应于句子 B标记。
  

• 什么是 token type IDs？
  
• position_ids（形状为(batch_size, num_choices, sequence_length)的torch.LongTensor，可选）— 每个输入序列标记的位置索引在位置嵌入中的索引。在范围[0, config.max_position_embeddings - 1]中选择。
  什么是 position IDs？
  
• lengths（形状为(batch_size,)的torch.LongTensor，可选）— 每个句子的长度，可用于避免在填充标记索引上执行注意力。您也可以使用attention_mask获得相同的结果（见上文），这里保留是为了兼容性。索引在[0, ..., input_ids.size(-1)]中选择。
  
• cache（Dict[str, torch.FloatTensor]，可选）— 包含由模型计算的预计算隐藏状态（注意力块中的键和值）的字符串到torch.FloatTensor的字典。可用于加速顺序解码。
  在前向传递期间，字典对象将被就地修改以添加新计算的隐藏状态。
  
• head_mask（形状为(num_heads,)或(num_layers, num_heads)的torch.FloatTensor，可选）— 用于使自注意力模块中选择的头部失效的掩码。掩码值在[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__ 特殊方法。

虽然前向传递的步骤需要在此函数内定义，但应该在此之后调用 Module 实例而不是这个，因为前者负责运行预处理和后处理步骤，而后者会默默地忽略它们。

示例：

>>> from transformers import AutoTokenizer, XLMForMultipleChoice
>>> import torch
>>> tokenizer = AutoTokenizer.from_pretrained("xlm-mlm-en-2048")
>>> model = XLMForMultipleChoice.from_pretrained("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.logits

XLMForTokenClassification

class transformers.XLMForTokenClassification

< source >

( config )

参数

• config（XLMConfig）— 具有模型所有参数的模型配置类。使用配置文件初始化不会加载与模型相关的权重，只加载配置。查看 from_pretrained()方法以加载模型权重。

XLM 模型在顶部带有一个标记分类头（隐藏状态输出的线性层），例如用于命名实体识别（NER）任务。

该模型继承自 PreTrainedModel。查看超类文档以获取库为所有模型实现的通用方法（如下载或保存、调整输入嵌入、修剪头等）。

该模型也是 PyTorch torch.nn.Module的子类。将其用作常规的 PyTorch 模块，并参考 PyTorch 文档以获取与一般用法和行为相关的所有内容。

forward

<来源>

( 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 ) → export const metadata = 'undefined';transformers.modeling_outputs.TokenClassifierOutput or tuple(torch.FloatTensor)

参数

• input_ids（torch.LongTensor，形状为(batch_size, sequence_length)）— 词汇表中输入序列标记的索引。
  可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.encode()和 PreTrainedTokenizer.call()。
  什么是输入 ID？
  
• attention_mask（torch.FloatTensor，形状为(batch_size, sequence_length)，可选）— 用于避免在填充标记索引上执行注意力的掩码。掩码值选择在[0, 1]之间：

• 1 表示未被掩盖的标记，
  
• 0 表示被掩盖的标记。
  

• 什么是注意力掩码？
  
• langs（torch.LongTensor，形状为(batch_size, sequence_length)，可选）— 用于指示输入中每个标记的语言的并行标记序列。索引是语言 ID，可以通过模型配置中提供的两个转换映射从语言名称中获取（仅适用于多语言模型）。更准确地说，语言名称到语言 ID映射在model.config.lang2id中（这是一个字符串到整数的字典），语言 ID 到语言名称映射在model.config.id2lang中（整数到字符串的字典）。
  请参阅多语言文档中详细的用法示例。
  
• token_type_ids（torch.LongTensor，形状为(batch_size, sequence_length)，可选）— 指示输入的第一部分和第二部分的段标记索引。索引选择在[0, 1]之间：

• 0 对应于句子 A标记，
  
• 1 对应于句子 B标记。
  

• 什么是标记类型 ID？
  
• position_ids（torch.LongTensor，形状为(batch_size, sequence_length)，可选）— 每个输入序列标记在位置嵌入中的位置索引。选择范围为[0, config.max_position_embeddings - 1]。
  什么是位置 ID？
  
• lengths（torch.LongTensor，形状为(batch_size,)，可选）— 每个句子的长度，可用于避免在填充标记索引上执行注意力。您也可以使用attention_mask获得相同的结果（见上文），这里保留是为了兼容性。索引选择在[0, ..., input_ids.size(-1)]之间。
  
• cache (Dict[str, torch.FloatTensor], optional) — 包含预先计算的隐藏状态（注意力块中的键和值）的字符串到 torch.FloatTensor 的字典，由模型计算（参见下面的 cache 输出）。可用于加速顺序解码。
  在前向传递期间，字典对象将被就地修改以添加新计算的隐藏状态。
  
• head_mask (torch.FloatTensor of shape (num_heads,) or (num_layers, num_heads), optional) — 用于将自注意力模块中选择的头部置零的掩码。掩码值在 [0, 1] 中选择：

• 1 表示头部未被掩码，
  
• 0 表示头部被掩码。
  

• inputs_embeds (torch.FloatTensor of shape (batch_size, sequence_length, hidden_size), optional) — 可选地，您可以选择直接传递嵌入表示而不是传递 input_ids。如果您想要更多控制权来将 input_ids 索引转换为相关向量，而不是使用模型的内部嵌入查找矩阵，则这很有用。
  
• output_attentions (bool, optional) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参阅返回张量下的 attentions。
  
• output_hidden_states (bool, optional) — 是否返回所有层的隐藏状态。有关更多详细信息，请参阅返回张量下的 hidden_states。
  
• return_dict (bool, optional) — 是否返回 ModelOutput 而不是普通元组。
  
• labels (torch.LongTensor of shape (batch_size, sequence_length), optional) — 用于计算标记分类损失的标签。索引应在 [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 或 config.return_dict=False）包含根据配置（XLMConfig）和输入的不同元素。

• loss (torch.FloatTensor of shape (1,), optional, 当提供 labels 时返回) — 分类损失。
  
• logits (torch.FloatTensor of shape (batch_size, sequence_length, config.num_labels)) — 分类分数（SoftMax 之前）。
  
• hidden_states (tuple(torch.FloatTensor), optional, 当传递 output_hidden_states=True 或 config.output_hidden_states=True 时返回) — 形状为 (batch_size, sequence_length, hidden_size) 的 torch.FloatTensor 元组。
  模型在每个层的输出处的隐藏状态以及可选的初始嵌入输出。
  
• attentions (tuple(torch.FloatTensor), optional, 当传递 output_attentions=True 或 config.output_attentions=True 时返回) — 形状为 (batch_size, num_heads, sequence_length, sequence_length) 的 torch.FloatTensor 元组。
  自注意力头部中的注意力权重，用于计算自注意力头部中的加权平均值。
  

XLMForTokenClassification 前向方法，覆盖 __call__ 特殊方法。

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

示例：

>>> from transformers import AutoTokenizer, XLMForTokenClassification
>>> import torch
>>> tokenizer = AutoTokenizer.from_pretrained("xlm-mlm-en-2048")
>>> model = XLMForTokenClassification.from_pretrained("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).loss

XLMForQuestionAnsweringSimple

class transformers.XLMForQuestionAnsweringSimple

<来源>

( config )

参数

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

XLM 模型在顶部具有用于提取式问答任务（如 SQuAD）的跨度分类头（在隐藏状态输出的顶部有线性层，用于计算跨度起始对数和跨度结束对数）。

这个模型继承自 PreTrainedModel。查看超类文档，了解库为所有模型实现的通用方法（如下载或保存、调整输入嵌入、修剪头等）。

这个模型也是一个 PyTorch torch.nn.Module子类。将其用作常规的 PyTorch 模块，并参考 PyTorch 文档以获取有关一般用法和行为的所有信息。

forward

<来源>

( 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 ) → export const metadata = 'undefined';transformers.modeling_outputs.QuestionAnsweringModelOutput or tuple(torch.FloatTensor)

参数

• input_ids（形状为(batch_size, sequence_length)的torch.LongTensor）— 词汇表中输入序列标记的索引。
  可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.encode()和 PreTrainedTokenizer.call()。
  什么是输入 ID？
  
• attention_mask（形状为(batch_size, sequence_length)的torch.FloatTensor，可选）— 避免在填充标记索引上执行注意力的掩码。掩码值选在[0, 1]之间：

• 1 表示“未被掩盖”的标记，
  
• 0 表示“被掩盖”的标记。
  

• 什么是注意力掩码？
  
• langs（形状为(batch_size, sequence_length)的torch.LongTensor，可选）— 用于指示输入中每个标记的语言的并行标记序列。语言 ID 可以通过模型配置中提供的两个转换映射从语言名称中获取（仅适用于多语言模型）。更准确地说，语言名称到语言 ID映射在model.config.lang2id中（这是一个字符串到整数的字典），语言 ID 到语言名称映射在model.config.id2lang中（整数到字符串的字典）。
  查看多语言文档中详细的使用示例。
  
• token_type_ids（形状为(batch_size, sequence_length)的torch.LongTensor，可选）— 段标记索引，用于指示输入的第一部分和第二部分。索引选在[0, 1]之间：

• 0 对应于句子 A的标记，
  
• 1 对应于句子 B的标记。
  

• 什么是标记类型 ID？
  
• position_ids（形状为(batch_size, sequence_length)的torch.LongTensor，可选）— 每个输入序列标记在位置嵌入中的位置索引。选在范围[0, config.max_position_embeddings - 1]内。
  什么是位置 ID？
  
• lengths（形状为(batch_size,)的torch.LongTensor，可选）— 每个句子的长度，可用于避免在填充标记索引上执行注意力。您也可以使用attention_mask获得相同的结果（见上文），这里保留是为了兼容性。索引选在[0, ..., input_ids.size(-1)]内。
  
• cache（Dict[str, torch.FloatTensor]，可选）— 包含预先计算的隐藏状态（注意力块中的键和值）的字符串到torch.FloatTensor的字典，由模型计算得出（参见下面的cache输出）。可用于加速顺序解码。
  在前向传递期间，字典对象将被就地修改以添加新计算的隐藏状态。
  
• head_mask（torch.FloatTensor，形状为(num_heads,)或(num_layers, num_heads)，可选）— 用于使自注意力模块的选定头部失效的掩码。在[0, 1]中选择的掩码值：

• 1 表示头部未被屏蔽，
  
• 0 表示头部被屏蔽。
  

• inputs_embeds（torch.FloatTensor，形状为(batch_size, sequence_length, hidden_size)，可选）— 可选地，您可以选择直接传递嵌入表示，而不是传递input_ids。如果您想要更多控制如何将input_ids索引转换为相关向量，而不是模型的内部嵌入查找矩阵，则这很有用。
  
• output_attentions（bool，可选）— 是否返回所有注意力层的注意力张量。有关更多详细信息，请参见返回张量下的attentions。
  
• output_hidden_states（bool，可选）— 是否返回所有层的隐藏状态。有关更多详细信息，请参见返回张量下的hidden_states。
  
• return_dict（bool，可选）— 是否返回一个 ModelOutput 而不是一个普通的元组。
  
• start_positions（torch.LongTensor，形状为(batch_size,)，可选）— 用于计算标记范围的起始位置（索引）的标签，以计算标记分类损失。位置被夹紧到序列的长度（sequence_length）。序列外的位置不会被考虑在内以计算损失。
  
• end_positions（torch.LongTensor，形状为(batch_size,)，可选）— 用于计算标记范围的结束位置（索引）的标签。位置被夹紧到序列的长度（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的元组（如果模型有嵌入层，则为嵌入的输出+每层的输出）的形状为(batch_size, sequence_length, hidden_size)。
  模型在每一层输出的隐藏状态以及可选的初始嵌入输出。
  
• attentions（tuple(torch.FloatTensor)，可选，当传递output_attentions=True或当config.output_attentions=True时返回）— torch.FloatTensor的元组（每层一个）的形状为(batch_size, num_heads, sequence_length, sequence_length)。
  在注意力 softmax 后的注意力权重，用于计算自注意力头中的加权平均值。
  

XLMForQuestionAnsweringSimple 的前向方法，覆盖了 __call__ 特殊方法。

虽然前向传播的配方需要在这个函数内定义，但应该在此之后调用 Module 实例，而不是这个函数，因为前者负责运行预处理和后处理步骤，而后者则默默地忽略它们。

示例：

>>> from transformers import AutoTokenizer, XLMForQuestionAnsweringSimple
>>> import torch
>>> tokenizer = AutoTokenizer.from_pretrained("xlm-mlm-en-2048")
>>> model = XLMForQuestionAnsweringSimple.from_pretrained("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.loss

XLMForQuestionAnswering

class transformers.XLMForQuestionAnswering

< source >

( config )

参数

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

XLM 模型，顶部带有用于提取式问答任务（如 SQuAD）的波束搜索跨度分类头（在隐藏状态输出的线性层上计算 跨度起始对数 和 跨度结束对数）。

此模型继承自 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 ) → export const metadata = 'undefined';transformers.models.xlm.modeling_xlm.XLMForQuestionAnsweringOutput or tuple(torch.FloatTensor)

参数

• input_ids（形状为 (batch_size, sequence_length) 的 torch.LongTensor）— 词汇表中输入序列标记的索引。
  可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
  什么是输入 ID？
  
• attention_mask（形状为 (batch_size, sequence_length) 的 torch.FloatTensor，可选）— 用于避免在填充标记索引上执行注意力的掩码。掩码值选在 [0, 1]：

• 1 用于“未屏蔽”的标记，
  
• 0 用于“屏蔽”的标记。
  

• 什么是注意力掩码？
  
• langs（形状为 (batch_size, sequence_length) 的 torch.LongTensor，可选）— 用于指示输入中每个标记的语言的并行标记序列。索引是语言 id，可以通过模型配置中提供的两个转换映射从语言名称中获取（仅适用于多语言模型）。更准确地说，语言名称到语言 id 映射在 model.config.lang2id 中（这是一个字符串到整数的字典），语言 id 到语言名称 映射在 model.config.id2lang 中（整数到字符串的字典）。
  查看 多语言文档 中详细的使用示例。
  
• token_type_ids（形状为 (batch_size, sequence_length) 的 torch.LongTensor，可选）— 段标记索引，用于指示输入的第一部分和第二部分。索引在 [0, 1] 中选择：

• 0 对应于一个 句子 A 的标记，
  
• 1 对应于一个 句子 B 的标记。
  

• 什么是令牌类型 ID？
  
• position_ids（形状为(batch_size, sequence_length)的torch.LongTensor，可选）— 每个输入序列令牌的位置嵌入中的位置索引。在范围[0, config.max_position_embeddings - 1]中选择。
  什么是位置 ID？
  
• lengths（形状为(batch_size,)的torch.LongTensor，可选）— 每个句子的长度，可用于避免在填充令牌索引上执行注意力。您也可以使用attention_mask获得相同的结果（请参见上文），这里保留以确保兼容性。选择的索引范围为[0, ..., input_ids.size(-1)]。
  
• cache（Dict[str, torch.FloatTensor]，可选）— 包含模型计算的预计算隐藏状态（键和值在注意力块中）的torch.FloatTensor的字符串字典。可用于加速顺序解码。
  字典对象将在前向传递期间就地修改，以添加新计算的隐藏状态。
  
• head_mask（形状为(num_heads,)或(num_layers, num_heads)的torch.FloatTensor，可选）— 用于使自注意力模块的选定头部无效的掩码。选择的掩码值在[0, 1]中选择。

• 1 表示头部未被掩盖，
  
• 0 表示头部已被掩盖。
  

• inputs_embeds（形状为(batch_size, sequence_length, hidden_size)的torch.FloatTensor，可选）— 可选地，您可以选择直接传递嵌入表示而不是传递input_ids。如果您想要更多控制如何将input_ids索引转换为相关向量，而不是使用模型的内部嵌入查找矩阵，则这很有用。
  
• output_attentions（bool，可选）— 是否返回所有注意力层的注意力张量。有关更多详细信息，请参见返回的张量下的attentions。
  
• output_hidden_states（bool，可选）— 是否返回所有层的隐藏状态。有关更多详细信息，请参见返回的张量下的hidden_states。
  
• return_dict（bool，可选）— 是否返回 ModelOutput 而不是普通元组。
  
• start_positions（形状为(batch_size,)的torch.LongTensor，可选）— 用于计算令牌分类损失的标记跨度开始位置的标签。位置被夹紧到序列的长度（sequence_length）。序列外的位置不会被考虑在内以计算损失。
  
• end_positions（形状为(batch_size,)的torch.LongTensor，可选）— 用于计算令牌分类损失的标记（索引）的标记跨度结束位置。位置被夹紧到序列的长度（sequence_length）。序列外的位置不会被考虑在内以计算损失。
  
• is_impossible（形状为(batch_size,)的torch.LongTensor，可选）— 标签，指示问题是否有答案或无答案（SQuAD 2.0）
  
• cls_index（形状为(batch_size,)的torch.LongTensor，可选）— 用作输入以计算答案合理性的分类令牌的位置（索引）的标签。
  
• p_mask（形状为(batch_size, sequence_length)的torch.FloatTensor，可选）— 无法包含在答案中的令牌的可选掩码（例如[CLS]，[PAD]，…）。1.0 表示应屏蔽令牌。0.0 表示令牌未被屏蔽。
  

返回

transformers.models.xlm.modeling_xlm.XLMForQuestionAnsweringOutput 或tuple(torch.FloatTensor)

一个 transformers.models.xlm.modeling_xlm.XLMForQuestionAnsweringOutput 或一个torch.FloatTensor元组（如果传递return_dict=False或当config.return_dict=False时）包含根据配置（XLMConfig）和输入的各种元素。

• loss（形状为(1,)的torch.FloatTensor，可选，如果提供了start_positions和end_positions）- 分类损失，作为开始令牌、结束令牌（如果提供）分类损失的总和。
  
• start_top_log_probs（形状为(batch_size, config.start_n_top)的torch.FloatTensor，可选，如果未提供start_positions或end_positions则返回）- 顶部config.start_n_top开始令牌可能性的对数概率（波束搜索）。
  
• start_top_index（形状为(batch_size, config.start_n_top)的torch.LongTensor，可选，如果未提供start_positions或end_positions则返回）- 前端令牌可能性的前config.start_n_top个索引（波束搜索）。
  
• 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结束令牌可能性的对数概率（波束搜索）。
  
• 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结束令牌可能性的索引（波束搜索）。
  
• 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 之后的注意力权重，用于计算自注意力头中的加权平均值。
  

XLMForQuestionAnswering 的前向方法，覆盖了__call__特殊方法。

虽然前向传递的方法需要在此函数内定义，但应该在此之后调用Module实例，而不是在此之后调用，因为前者负责运行前处理和后处理步骤，而后者会默默地忽略它们。

示例：

>>> from transformers import AutoTokenizer, XLMForQuestionAnswering
>>> import torch
>>> tokenizer = AutoTokenizer.from_pretrained("xlm-mlm-en-2048")
>>> model = XLMForQuestionAnswering.from_pretrained("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.loss

TensorFlow 隐藏 TensorFlow 内容

TFXLMModel

class transformers.TFXLMModel

<来源>

( config *inputs **kwargs )

参数

• config（XLMConfig）- 模型的所有参数的模型配置类。使用配置文件初始化不会加载与模型相关的权重，只会加载配置。查看 from_pretrained()方法以加载模型权重。

裸 XLM 模型变压器输出原始隐藏状态，没有特定的头部。

这个模型继承自 TFPreTrainedModel。查看超类文档以了解库实现的通用方法，适用于所有模型（例如下载或保存、调整输入嵌入、修剪头等）。

这个模型也是一个tf.keras.Model子类。将其用作常规的 TF 2.0 Keras 模型，并参考 TF 2.0 文档，了解与一般用法和行为相关的所有事项。

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

• 将所有输入作为关键字参数（类似于 PyTorch 模型），或
  
• 将所有输入作为列表、元组或字典放在第一个位置参数中。
  

支持第二种格式的原因是 Keras 方法在将输入传递给模型和层时更喜欢这种格式。由于这种支持，当使用model.fit()等方法时，应该可以正常工作 - 只需以model.fit()支持的任何格式传递输入和标签即可！然而，如果您想在 Keras 方法之外使用第二种格式，比如在使用 Keras Functional API 创建自己的层或模型时，有三种可能的方法可以用来收集所有输入张量在第一个位置参数中：

• 一个仅包含input_ids的单个张量，没有其他内容：model(input_ids)
  
• 一个长度不定的列表，其中包含一个或多个输入张量，按照文档字符串中给定的顺序：model([input_ids, attention_mask]) 或 model([input_ids, attention_mask, token_type_ids])
  
• 一个字典，其中包含一个或多个与文档字符串中给定输入名称相关联的输入张量：model({"input_ids": input_ids, "token_type_ids": token_type_ids})
  

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

call

<来源>

( 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 ) → export const metadata = 'undefined';transformers.modeling_tf_outputs.TFBaseModelOutput or tuple(tf.Tensor)

参数

• input_ids（形状为(batch_size, sequence_length)的Numpy数组或tf.Tensor）- 词汇表中输入序列标记的索引。
  可以使用 AutoTokenizer 获取索引。查看 PreTrainedTokenizer.call()和 PreTrainedTokenizer.encode()获取详细信息。
  什么是输入 ID？
  
• attention_mask（形状为(batch_size, sequence_length)的Numpy数组或tf.Tensor，可选）- 避免对填充标记索引执行注意力的掩码。掩码值选在[0, 1]之间：

• 对于未被masked的标记，值为 1。
  
• 对于被masked的标记，值为 0。
  

• 什么是注意力掩码？
  
• langs（形状为(batch_size, sequence_length)的tf.Tensor或Numpy数组，可选）- 用于指示输入中每个标记的语言的并行标记序列。语言 ID 是通过模型配置中提供的两个转换映射从语言名称获得的（仅适用于多语言模型）。更准确地说，语言名称到语言 ID映射在model.config.lang2id中（这是一个字符串到整数的字典），语言 ID 到语言名称映射在model.config.id2lang中（整数到字符串的字典）。
  详细的用法示例请参阅多语言文档。
  
• token_type_ids（Numpy 数组或形状为(batch_size, sequence_length)的tf.Tensor，可选）— 段标记索引，指示输入的第一部分和第二部分。索引在[0, 1]中选择：

• 0 对应于句子 A标记，
  
• 1 对应于句子 B标记。
  

• 什么是标记类型 ID？
  
• position_ids（形状为(batch_size, sequence_length)的Numpy 数组或tf.Tensor，可选）— 每个输入序列标记在位置嵌入中的位置索引。在范围[0, config.max_position_embeddings - 1]中选择。
  什么是位置 ID？
  
• lengths（形状为(batch_size,)的tf.Tensor或Numpy 数组，可选）— 每个句子的长度，可用于避免在填充标记索引上执行注意力。您还可以使用attention_mask获得相同的结果（请参见上文），这里保留以保持兼容性。在[0, ..., input_ids.size(-1)]中选择的索引。
  
• cache（Dict[str, tf.Tensor]，可选）— 包含预先计算的隐藏状态（键和值在注意力块中计算的）的字符串到tf.Tensor的字典，由模型计算（请参见下面的cache输出）。可用于加速顺序解码。
  字典对象将在前向传递期间就地修改，以添加新计算的隐藏状态。
  
• head_mask（形状为(num_heads,)或(num_layers, num_heads)的Numpy 数组或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，可选，默认为False）— 是否在训练模式下使用模型（某些模块，如丢弃模块，在训练和评估之间具有不同的行为）。
  

返回

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（形状为(batch_size, sequence_length, hidden_size)的tf.Tensor）— 模型最后一层的隐藏状态序列的输出。
  
• hidden_states（tuple(tf.FloatTensor)，可选，当传递output_hidden_states=True或config.output_hidden_states=True时返回）- 形状为(batch_size, sequence_length, hidden_size)的tf.Tensor元组（一个用于嵌入的输出 + 一个用于每个层的输出）。
  模型在每个层的输出处的隐藏状态加上初始嵌入输出。
  
• attentions（tuple(tf.Tensor)，可选，当传递output_attentions=True或config.output_attentions=True时返回）- 形状为(batch_size, num_heads, sequence_length, sequence_length)的tf.Tensor元组（每个层一个）。
  在注意力 softmax 之后的注意力权重，用于计算自注意力头中的加权平均值。
  

TFXLMModel 的前向方法覆盖了__call__特殊方法。

尽管前向传递的方法需要在此函数内定义，但应该在此之后调用Module实例，而不是在此处调用，因为前者会处理运行前后处理步骤，而后者会默默忽略它们。

示例：

>>> from transformers import AutoTokenizer, TFXLMModel
>>> import tensorflow as tf
>>> tokenizer = AutoTokenizer.from_pretrained("xlm-mlm-en-2048")
>>> model = TFXLMModel.from_pretrained("xlm-mlm-en-2048")
>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="tf")
>>> outputs = model(inputs)
>>> last_hidden_states = outputs.last_hidden_state

Transformers 4.37 中文文档（六十一）（6）https://developer.aliyun.com/article/1564142