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

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

XGLM

原文链接：huggingface.co/docs/transformers/v4.37.2/en/model_doc/xglm

概述

XGLM 模型是由 Xi Victoria Lin、Todor Mihaylov、Mikel Artetxe、Tianlu  Wang、Shuohui Chen、Daniel Simig、Myle Ott、Naman Goyal、Shruti  Bhosale、Jingfei Du、Ramakanth Pasunuru、Sam Shleifer、Punit Singh  Koura、Vishrav Chaudhary、Brian O’Horo、Jeff Wang、Luke Zettlemoyer、Zornitsa  Kozareva、Mona Diab、Veselin Stoyanov、Xian Li 在《Few-shot Learning with Multilingual Language Models》中提出的。

该论文的摘要如下：

大规模自回归语言模型（如  GPT-3）是少样本学习者，可以在不经过微调的情况下执行各种语言任务。虽然这些模型已知能够共同表示许多不同的语言，但它们的训练数据主要由英语主导，可能限制了它们的跨语言泛化能力。在这项工作中，我们在涵盖多种语言的平衡语料库上训练多语言自回归语言模型，并研究它们在各种任务中的少样本和零样本学习能力。我们的最大模型拥有  75 亿个参数，在 20 多种代表性语言中的少样本学习方面取得了新的最佳成绩，在多语言常识推理（在 0-shot  设置中准确率提高了+7.4%，在 4-shot 设置中提高了+9.4%）和自然语言推理（在 0-shot 和 4-shot 设置中各提高了  5.4%）方面超越了相同规模的 GPT-3。在 FLORES-101 机器翻译基准测试中，我们的模型在 32 个训练示例中在 182  个翻译方向中有 171 个方向超越了 GPT-3，同时在 45  个方向上超过了官方监督基线。我们对模型成功和失败的详细分析表明，它特别能够在某些任务上实现跨语言上下文学习，但在表面形式的稳健性和适应不具有自然填空形式的任务方面仍有改进空间。最后，我们在五种语言中评估我们的模型在社会价值任务（如仇恨言论检测）中发现它与相同规模的  GPT-3 模型存在类似的局限性。

该模型由Suraj贡献。原始代码可以在这里找到。

资源

• 因果语言建模任务指南

XGLMConfig

class transformers.XGLMConfig

<来源>

( vocab_size = 256008 max_position_embeddings = 2048 d_model = 1024 ffn_dim = 4096 num_layers = 24 attention_heads = 16 activation_function = 'gelu' dropout = 0.1 attention_dropout = 0.1 activation_dropout = 0.0 layerdrop = 0.0 init_std = 0.02 scale_embedding = True use_cache = True decoder_start_token_id = 2 pad_token_id = 1 bos_token_id = 0 eos_token_id = 2 **kwargs )

参数

• vocab_size（int，可选，默认为 256008）— XGLM 模型的词汇量。定义了在调用 XGLMModel 或 FlaxXGLMModel 时可以由inputs_ids表示的不同标记的数量。
• max_position_embeddings（int，可选，默认为 2048）— 该模型可能被使用的最大序列长度。通常将其设置为较大的值以防万一（例如 512、1024 或 2048）。
• d_model（int，可选，默认为 1024）— 层和池化器层的维度。
• ffn_dim（int，可选，默认为 4096）— 解码器中“中间”（通常称为前馈）层的维度。
• num_layers（int，可选，默认为 24）— Transformer 解码器中隐藏层的数量。
• attention_heads（int，可选，默认为 16）— Transformer 解码器中每个注意力层的注意力头数。
• activation_function（str或function，可选，默认为"gelu"）— 编码器和池化器中的非线性激活函数（函数或字符串）。如果是字符串，支持"gelu"、"relu"、"silu"和"gelu_new"。
• dropout (float, 可选, 默认为 0.1) — 嵌入层、解码器和池化器中所有完全连接层的丢弃概率。
• attention_dropout (float, 可选, 默认为 0.1) — 注意力概率的丢弃比率。
• activation_dropout (float, 可选, 默认为 0.0) — 完全连接层内激活的丢弃比率。
• layerdrop (float, 可选, 默认为 0.0) — 编码器的 LayerDrop 概率。有关更多详细信息，请参阅 LayerDrop 论文)。
• init_std (float, 可选, 默认为 0.02) — 用于初始化所有权重矩阵的截断正态初始化器的标准差。
• scale_embedding (bool, 可选, 默认为 True) — 通过除以 sqrt(d_model) 缩放嵌入。
• use_cache (bool, 可选, 默认为 True) — 模型是否应返回最后的键/值注意力（并非所有模型都使用）。

这是用于存储 XGLMModel 配置的配置类。它用于根据指定的参数实例化 XGLM 模型，定义模型架构。使用默认值实例化配置将产生类似于 XGLM facebook/xglm-564M 架构的配置。

配置对象继承自 PretrainedConfig，可用于控制模型输出。阅读 PretrainedConfig 的文档以获取更多信息。

示例：

>>> from transformers import XGLMModel, XGLMConfig
>>> # Initializing a XGLM facebook/xglm-564M style configuration
>>> configuration = XGLMConfig()
>>> # Initializing a model from the facebook/xglm-564M style configuration
>>> model = XGLMModel(configuration)
>>> # Accessing the model configuration
>>> configuration = model.config

XGLMTokenizer

class transformers.XGLMTokenizer

<来源>

( vocab_file bos_token = '<s>' eos_token = '</s>' sep_token = '</s>' cls_token = '<s>' unk_token = '<unk>' pad_token = '<pad>' sp_model_kwargs: Optional = None **kwargs )

参数

• vocab_file (str) — 词汇表文件的路径。
• bos_token (str, 可选, 默认为 "") — 在预训练期间使用的序列开始标记。可用作序列分类器标记。
  在使用特殊标记构建序列时，这不是用于序列开始的标记。使用的标记是 cls_token。
• eos_token (str, 可选, 默认为 "") — 序列结束标记。
  在使用特殊标记构建序列时，这不是用于序列结束的标记。使用的标记是 sep_token。
• sep_token (str, 可选, 默认为 "") — 分隔符标记，在从多个序列构建序列时使用，例如用于序列分类的两个序列或用于文本和问题的问题回答。也用作使用特殊标记构建的序列的最后一个标记。
• cls_token (str, 可选, 默认为 "") — 在进行序列分类（对整个序列而不是每个标记进行分类）时使用的分类器标记。在构建带有特殊标记的序列时，它是序列的第一个标记。
• unk_token (str, 可选, 默认为 "") — 未知标记。词汇表中不存在的标记无法转换为 ID，而是设置为此标记。
• pad_token (str, 可选, 默认为 "") — 用于填充的标记，例如在批处理不同长度的序列时使用。
• sp_model_kwargs (dict, 可选) — 将传递给 SentencePieceProcessor.__init__() 方法。SentencePiece 的 Python 包装器 可以用于设置：

• enable_sampling: 启用子词正则化。
• nbest_size: unigram 的抽样参数。对于 BPE-Dropout 无效。

• nbest_size = {0,1}: 不执行抽样。
• nbest_size > 1: 从 nbest_size 结果中抽样。
• nbest_size < 0：假设 nbest_size 是无限的，并使用前向过滤和后向采样算法从所有假设（格）中进行采样。

• alpha：用于 unigram 采样的平滑参数，以及 BPE-dropout 的合并操作的 dropout 概率。

• sp_model（SentencePieceProcessor）—用于每次转换（字符串、标记和 ID）的SentencePiece处理器。

改编自 RobertaTokenizer 和 XLNetTokenizer。基于SentencePiece。

此标记器继承自 PreTrainedTokenizer，其中包含大多数主要方法。用户应参考此超类以获取有关这些方法的更多信息。

build_inputs_with_special_tokens

<来源>

( token_ids_0: List token_ids_1: Optional = None ) → export const metadata = 'undefined';List[int]

参数

• token_ids_0（List[int]）—将添加特殊标记的 ID 列表。
• token_ids_1（List[int]，可选）—序列对的可选第二个 ID 列表。

返回

List[int]

带有适当特殊标记的 input IDs 列表。

通过连接和添加特殊标记从序列或序列对构建用于序列分类任务的模型输入。XLM-RoBERTa 序列的格式如下：

• 单个序列： X
• 序列对： A B

get_special_tokens_mask

<来源>

( token_ids_0: List token_ids_1: Optional = None already_has_special_tokens: bool = False ) → export const metadata = 'undefined';List[int]

参数

• token_ids_0（List[int]）—ID 列表。
• token_ids_1（List[int]，可选）—序列对的可选第二个 ID 列表。
• already_has_special_tokens（bool，可选，默认为False）—标记列表是否已经格式化为模型的特殊标记。

返回

List[int]

一个整数列表，范围为[0, 1]：特殊标记为 1，序列标记为 0。

从没有添加特殊标记的标记列表中检索序列 ID。在使用标记器prepare_for_model方法添加特殊标记时调用此方法。

create_token_type_ids_from_sequences

<来源>

( token_ids_0: List token_ids_1: Optional = None ) → export const metadata = 'undefined';List[int]

参数

• token_ids_0（List[int]）—ID 列表。
• token_ids_1（List[int]，可选）—序列对的可选第二个 ID 列表。

返回

List[int]

零列表。

从传递的两个序列创建一个用于序列对分类任务的掩码。XLM-RoBERTa 不使用标记类型 ID，因此返回一个零列表。

save_vocabulary

<来源>

( save_directory: str filename_prefix: Optional = None )

XGLMTokenizerFast

class transformers.XGLMTokenizerFast

<来源>

( vocab_file = None tokenizer_file = None bos_token = '<s>' eos_token = '</s>' sep_token = '</s>' cls_token = '<s>' unk_token = '<unk>' pad_token = '<pad>' **kwargs )

参数

• vocab_file（str）—词汇文件的路径。
• bos_token（str，可选，默认为""）—在预训练期间使用的序列开头标记。可用作序列分类器标记。
  在构建使用特殊标记的序列时，这不是用于序列开头的标记。使用的标记是cls_token。
• eos_token（str，可选，默认为""）—序列结束标记。
  在构建使用特殊标记的序列时，这不是用于序列结尾的标记。使用的标记是sep_token。
• sep_token (str, 可选, 默认为 "") — 分隔符标记，在从多个序列构建序列时使用，例如用于序列分类的两个序列或用于文本和问题的问题回答。它还用作使用特殊标记构建的序列的最后一个标记。
• cls_token (str, 可选, 默认为 "") — 在进行序列分类（对整个序列进行分类而不是每个标记的分类）时使用的分类器标记。当使用特殊标记构建时，它是序列的第一个标记。
• unk_token (str, 可选, 默认为 "") — 未知标记。词汇表中没有的标记无法转换为 ID，而是设置为此标记。
• pad_token (str, 可选, 默认为 "") — 用于填充的标记，例如在批处理不同长度的序列时使用。
• additional_special_tokens (List[str], 可选, 默认为 ["NOTUSED", "NOTUSED"]) — 分词器使用的额外特殊标记。

构建一个“快速”XGLM 分词器（由 HuggingFace 的tokenizers库支持）。改编自 RobertaTokenizer 和 XLNetTokenizer。基于BPE。

此分词器继承自 PreTrainedTokenizerFast，其中包含大多数主要方法。用户应参考此超类以获取有关这些方法的更多信息。

build_inputs_with_special_tokens

<来源>

( token_ids_0: List token_ids_1: Optional = None ) → export const metadata = 'undefined';List[int]

参数

• token_ids_0 (List[int]) — 将添加特殊标记的 ID 列表。
• token_ids_1 (List[int], 可选) — 序列对的第二个 ID 列表（可选）。

返回

List[int]

带有适当特殊标记的输入 ID 列表。

通过连接和添加特殊标记，从序列或序列对构建用于序列分类任务的模型输入。XLM-RoBERTa 序列的格式如下：

• 单个序列： X
• 序列对： A B

create_token_type_ids_from_sequences

<来源>

( token_ids_0: List token_ids_1: Optional = None ) → export const metadata = 'undefined';List[int]

参数

• token_ids_0 (List[int]) — ID 列表。
• token_ids_1 (List[int], 可选) — 序列对的第二个 ID 列表（可选）。

返回

List[int]

零的列表。

从传递的两个序列创建一个用于序列对分类任务的掩码。XLM-RoBERTa 不使用标记类型 ID，因此返回一个零的列表。

Pytorch 隐藏 Pytorch 内容

XGLMModel

class transformers.XGLMModel

<来源>

( config: XGLMConfig embed_tokens: Optional = None )

参数

• config (XGLMConfig) — 具有模型所有参数的模型配置类。使用配置文件初始化不会加载与模型关联的权重，只会加载配置。查看 from_pretrained()方法以加载模型权重。配置 — XGLMConfig
• embed_tokens (nn.Embedding) — 输出嵌入

裸 XGLM 模型变压器输出原始隐藏状态，没有特定的头部。此模型继承自 PreTrainedModel。查看超类文档以了解库为所有模型实现的通用方法（例如下载或保存，调整输入嵌入大小，修剪头等）。

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

由config.num_layers层组成的 Transformer 解码器。每一层都是一个XGLMDecoderLayer

forward

<来源>

( input_ids: Optional = None attention_mask: Optional = None position_ids: Optional = None encoder_hidden_states: Optional = None encoder_attention_mask: Optional = None head_mask: Optional = None cross_attn_head_mask: Optional = None past_key_values: Optional = None inputs_embeds: Optional = None use_cache: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None ) → export const metadata = 'undefined';transformers.modeling_outputs.BaseModelOutputWithPastAndCrossAttentions 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.Tensor，可选）- 用于避免在填充标记索引上执行注意力。掩码值选定在[0, 1]中：

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

• 什么是注意力掩码？
• position_ids（形状为(batch_size, sequence_length)的torch.LongTensor，可选）- 每个输入序列标记的位置在位置嵌入中的索引。选定范围为[0, config.max_position_embeddings - 1]。
  什么是位置 ID？
• encoder_hidden_states（形状为(batch_size, encoder_sequence_length, hidden_size)的torch.FloatTensor，可选）- 编码器最后一层的隐藏状态序列。用于解码器的交叉注意力。
• encoder_attention_mask（形状为(batch_size, encoder_sequence_length)的torch.LongTensor，可选）- 用于避免在编码器 input_ids 的填充标记索引上执行交叉注意力。掩码值选定在[0, 1]中：

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

• 什么是注意力掩码？
• head_mask（形状为(num_layers, attention_heads)的torch.Tensor，可选）- 用于使注意力模块的选定头部失效的掩码。掩码值选定在[0, 1]中：

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

• cross_attn_head_mask（形状为(num_layers, attention_heads)的torch.Tensor，可选）- 用于使交叉注意力模块的选定头部失效的掩码。掩码值选定在[0, 1]中：

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

• past_key_values（tuple(tuple(torch.FloatTensor))，可选，当传递use_cache=True或config.use_cache=True时返回）- 长度为config.n_layers的元组，每个元组有 2 个形状为(batch_size, num_heads, sequence_length, embed_size_per_head)的张量和 2 个额外的形状为(batch_size, num_heads, encoder_sequence_length, embed_size_per_head)的张量。
  包含预先计算的隐藏状态（自注意力块和交叉注意力块中的键和值），可用于加速顺序解码（请参见past_key_values输入）。
  如果使用past_key_values，用户可以选择仅输入最后一个decoder_input_ids（那些没有将其过去键值状态提供给此模型的）的形状为(batch_size, 1)，而不是所有decoder_input_ids的形状为(batch_size, sequence_length)。
• inputs_embeds (torch.FloatTensor，形状为(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 而不是普通元组。

返回

transformers.modeling_outputs.BaseModelOutputWithPastAndCrossAttentions 或tuple(torch.FloatTensor)

一个 transformers.modeling_outputs.BaseModelOutputWithPastAndCrossAttentions 或一个torch.FloatTensor元组（如果传递return_dict=False或config.return_dict=False）包含根据配置（XGLMConfig）和输入的各种元素。

• last_hidden_state (torch.FloatTensor，形状为(batch_size, sequence_length, hidden_size)) — 模型最后一层的隐藏状态序列。
  如果使用past_key_values，则仅输出形状为(batch_size, 1, hidden_size)序列的最后一个隐藏状态。
• past_key_values (tuple(tuple(torch.FloatTensor))，optional，当传递use_cache=True或config.use_cache=True时返回） — 长度为config.n_layers的tuple(torch.FloatTensor)元组，每个元组有 2 个形状为(batch_size, num_heads, sequence_length, embed_size_per_head)的张量，如果config.is_encoder_decoder=True还有 2 个额外的形状为(batch_size, num_heads, encoder_sequence_length, embed_size_per_head)的张量。
  包含预先计算的隐藏状态（自注意力块中的键和值，以及在交叉注意力块中，如果config.is_encoder_decoder=True，还可以使用）可用于加速顺序解码（请参见past_key_values输入）。
• 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元组（每层一个）。
  注意力 softmax 后的注意力权重，用于计算自注意力头中的加权平均值。
• cross_attentions (tuple(torch.FloatTensor)，optional，当传递output_attentions=True和config.add_cross_attention=True或config.output_attentions=True时返回） — 形状为(batch_size, num_heads, sequence_length, sequence_length)的torch.FloatTensor元组（每层一个）。
  解码器的交叉注意力层的注意力权重，在注意力 softmax 之后，用于计算交叉注意力头中的加权平均值。

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

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

示例：

>>> from transformers import AutoTokenizer, XGLMModel
>>> import torch
>>> tokenizer = AutoTokenizer.from_pretrained("facebook/xglm-564M")
>>> model = XGLMModel.from_pretrained("facebook/xglm-564M")
>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="pt")
>>> outputs = model(**inputs)
>>> last_hidden_states = outputs.last_hidden_state

XGLMForCausalLM

class transformers.XGLMForCausalLM

<来源>

( config )

参数

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

具有顶部语言建模头的 XGLM 模型转换器（线性层，其权重与输入嵌入相关联）。

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

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

前进

<来源>

( input_ids: Optional = None attention_mask: Optional = None position_ids: Optional = None encoder_hidden_states: Optional = None encoder_attention_mask: Optional = None head_mask: Optional = None cross_attn_head_mask: Optional = None past_key_values: Optional = None inputs_embeds: Optional = None labels: Optional = None use_cache: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None ) → export const metadata = 'undefined';transformers.modeling_outputs.CausalLMOutputWithCrossAttentions or tuple(torch.FloatTensor)

参数

• input_ids（torch.LongTensor，形状为(batch_size, sequence_length)）— 词汇表中输入序列令牌的索引。默认情况下，如果提供填充，则将忽略填充。
  可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.encode()和 PreTrainedTokenizer.call()。
  什么是输入 ID？
• attention_mask（torch.Tensor，形状为(batch_size, sequence_length)，可选）— 用于避免在填充令牌索引上执行注意力的掩码。选择的掩码值为[0, 1]：

• 对于未被masked的令牌为 1，
• 对于未被masked的令牌为 1，

• 什么是注意力掩码？
• position_ids（torch.LongTensor，形状为(batch_size, sequence_length)，可选）— 每个输入序列令牌在位置嵌入中的位置索引。选择范围为[0, config.max_position_embeddings - 1]。
  什么是位置 ID？
• encoder_hidden_states（torch.FloatTensor，形状为(batch_size, encoder_sequence_length, hidden_size)，可选）— 编码器最后一层的隐藏状态序列。用于解码器的交叉注意力。
• encoder_attention_mask（torch.LongTensor，形状为(batch_size, encoder_sequence_length)，可选）— 用于避免在编码器 input_ids 的填充令牌索引上执行交叉注意力的掩码。选择的掩码值为[0, 1]：

• 对于被masked的令牌为 0，
• 对于被masked的令牌为 0。

• 什么是注意力掩码？
• head_mask (torch.Tensor of shape (num_layers, attention_heads), optional) — 用于使注意力模块中选择的头部失效的掩码。掩码值选在[0, 1]之间：

• 1 表示头部未被masked。
• 0 表示头部被masked。

• cross_attn_head_mask (torch.Tensor of shape (num_layers, attention_heads), optional) — 用于使交叉注意力模块中选择的头部失效的掩码。掩码值选在[0, 1]之间：

• 1 表示头部未被masked。
• 0 表示头部被masked。

• past_key_values (tuple(tuple(torch.FloatTensor)), optional, returned when use_cache=True is passed or when config.use_cache=True) — 长度为config.n_layers的tuple(torch.FloatTensor)元组，每个元组有 2 个形状为(batch_size, num_heads, sequence_length, embed_size_per_head)的张量和 2 个额外的形状为(batch_size, num_heads, encoder_sequence_length, embed_size_per_head)的张量。
  包含预先计算的隐藏状态（自注意力块和交叉注意力块中的键和值），可以用于加速顺序解码（请参见past_key_values输入）。
  如果使用past_key_values，用户可以选择仅输入最后一个形状为(batch_size, 1)的decoder_input_ids（这些没有将它们的过去键值状态提供给此模型的输入）而不是所有形状为(batch_size, sequence_length)的decoder_input_ids。
• 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.vocab_size]范围内，或者为-100（请参见input_ids文档字符串）。索引设置为-100的标记将被忽略（masked），损失仅计算具有[0, ..., config.vocab_size]标签的标记。

返回

transformers.modeling_outputs.CausalLMOutputWithCrossAttentions 或 tuple(torch.FloatTensor)

一个 transformers.modeling_outputs.CausalLMOutputWithCrossAttentions 或一个torch.FloatTensor元组（如果传递了return_dict=False或当config.return_dict=False时）包含根据配置（XGLMConfig）和输入的不同元素。

• loss (torch.FloatTensor of shape (1,), optional, returned when labels is provided) — 语言建模损失（用于下一个标记预测）。
• logits (torch.FloatTensor of shape (batch_size, sequence_length, config.vocab_size)) — 语言建模头的预测分数（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 后的注意力权重，用于计算自注意力头中的加权平均值。
• cross_attentions（tuple(torch.FloatTensor)，可选，当传递output_attentions=True或config.output_attentions=True时返回）— 形状为(batch_size, num_heads, sequence_length, sequence_length)的torch.FloatTensor元组（每层一个）。
  注意力 softmax 后的交叉注意力权重，用于计算交叉注意力头中的加权平均值。
• past_key_values（tuple(tuple(torch.FloatTensor))，可选，当传递use_cache=True或config.use_cache=True时返回）— 长度为config.n_layers的torch.FloatTensor元组的元组，每个元组包含自注意力和交叉注意力层的缓存键、值状态，如果模型用于编码器-解码器设置，则相关。仅在config.is_decoder = True时相关。
  包含预先计算的隐藏状态（注意力块中的键和值），可用于加速顺序解码。

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

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

示例：

>>> import torch
>>> from transformers import AutoTokenizer, XGLMForCausalLM
>>> tokenizer = AutoTokenizer.from_pretrained("facebook/xglm-564M")
>>> model = XGLMForCausalLM.from_pretrained("facebook/xglm-564M")
>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="pt")
>>> outputs = model(**inputs, labels=inputs["input_ids"])
>>> loss = outputs.loss
>>> logits = outputs.logits

TensorFlow 隐藏 TensorFlow 内容

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