Transformers 文档

XXGLM

Hugging Face's logo
加入 Hugging Face社区

并获得增强文档体验的访问权限

开始使用

XGLM

概览

基于多语言语言模型的少样本学习(Few-shot Learning with Multilingual Language Models)这篇论文中,由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等提出。

该论文的摘要如下:

大规模自回归语言模型,如GPT-3,是一种少样本学习器,能够在没有微调的情况下执行各种语言任务。尽管这些模型已知能够联合表示许多不同的语言,但其训练数据主要由英语构成,这可能会限制其跨语言泛化。在这项工作中,我们使用覆盖多种语言平衡语料库来训练多语言自回归语言模型,并研究了它们在广泛任务中的少样本和零样本学习能力。我们的最大模型具有75亿参数,在超过20种代表性语言的少样本学习中达到了最新的技术水平,优于同规模的多语言普遍推理领域的GPT-3(在0次样本设置中绝对准确率提高7.4%,在4次样本设置中提高9.4%),以及在自然语言推理任务中(0次和4次样本设置中各提高5.4%)。在FLORES-101机器翻译基准测试中,我们的模型在32个训练实例下,在182个翻译方向中的171个方向上超过了GPT-3,同时,在45个方向上超过了官方监督基线。我们详细分析了模型的成功与失败之处,特别是模型在某些任务上实现了跨语言上下文学习,但在表面形态鲁棒性和对没有自然填空形式的任务的适应性方面仍有改进空间。最后,我们在如仇恨言论检测等社会价值任务中评估了我们的模型,发现其限制与同规模的GPT-3模型类似。

该模型由Suraj提供。原始代码可以在这里找到:这里

资源

XGLMConfig

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模型的词汇大小。定义了当调用inputs_ids时可以由inputs_ids表示的不同标记的数量,当调用XGLMModelFlaxXGLMModel时。
  • max_position_embeddings (int, 可选,默认为2048) — 此模型可能使用的最大序列长度。通常设置的大一些以防万一(例如,512或1024或2048)。
  • d_model (int, 可选,默认为1024) — 层和池化层的维度。
  • ffn_dimint可选,默认为4096) — 解码器中“中间”层(通常称为前馈层)的维度。
  • num_layersint可选,默认为24) — Transformer解码器中隐藏层的数量。
  • attention_headsint可选,默认为16) — Transformer解码器中每个注意力层中的注意力头数量。
  • activation_functionstrfunction可选,默认为 "gelu") — 编码器和池器中的非线性激活函数(函数或字符串)。如果为字符串,则支持 "gelu""relu""silu""gelu_new"
  • dropout (float, 可选, 默认值 0.1) — 在嵌入层、dencoder 和 pooler 中的所有全连接层的 dropout 几率。
  • attention_dropout (float, 可选, 默认值 0.1) — 注意力概率的 dropout 比率。
  • activation_dropout (float, 可选, 默认值 0.0) — 内部全连接层的激活的 dropout 比率。
  • layerdrop (float, 可选, 默认值 0.0) — 编码器的 LayerDrop 几率。有关更详细的信息,请参阅[LayerDrop 论文](https://arxiv.org/abs/1909.11556)。
  • init_std (float, 可选,默认为 0.02) — 用于初始化所有权重矩阵的 truncated_normal_initializer 的均方差。
  • 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

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: 可选 = None **kwargs )

参数

  • vocab_file (str) — 词汇文件的路径。
  • bos_token (str, 可选, 默认为 "<s>") — 在预训练阶段使用的序列起始标记。可以用作序列分类标记。

    当使用特殊标记构建序列时,这并不是用的序列起始标记。所使用的标记是 cls_token

  • eos_token (str, 可选, 默认为 "</s>") — 序列结束标记。

    当使用特殊标记构建序列时,这并不是用的序列结束标记。所使用的标记是 sep_token

  • sep_token (字符串,可选,默认为 "</s>") — 分隔符标记,在构建由多个序列组成的序列时使用,例如用于序列分类的两个序列或用于问答任务的文本和问题。它也用作由特殊标记构建的序列的最后一个标记。
  • cls_token (字符串,可选,默认为 "<s>") — 类别标记,在执行序列分类(对整个序列进行分类而不是按标记分类)时使用。它是在特殊标记构建的序列中的第一个标记。
  • unk_token (字符串,可选,默认为 "<unk>") — 未知标记。不在词汇表中的标记无法转换为ID,并将其设置为这个标记。
  • pad_token (str, 可选, 默认为 "<pad>") — 用于填充的标记,例如在处理不同长度的序列时。
  • sp_model_kwargs (dict, 可选) — 将传给 SentencePieceProcessor.__init__() 方法。可以使用Python wrapper for SentencePiece来设置,例如:
  • sp_model (SentencePieceProcessor) — 用于每次转换(字符串,标记和 ID)的 SentencePiece 处理器。

修改自 RobertaTokenizerXLNetTokenizer。基于 SentencePiece

此标记器继承自 PreTrainedTokenizer,其中包含大多数主要方法。用户应参考这个超类来了解更多有关这些方法的信息。

build_inputs_with_special_tokens

< >

( token_ids_0: List token_ids_1: Optional = None ) List[int]

参数

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

返回

List[int]

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

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

  • 单个序列:` X `
  • 序列对:` A B `

get_special_tokens_mask

< >

( token_ids_0: List token_ids_1: Optional = None already_has_special_tokens: bool = False ) 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 ) List[int]

参数

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

返回

List[int]

零的列表。

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

save_vocabulary

< >

( save_directory: str filename_prefix: Optional = None )

XGLMTokenizerFast

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 (字符串) — 词汇表文件的路径。
  • bos_token (str, 可选, 默认为 "<s>") — 预训练过程中使用的序列开始标记。可以作为序列分类标记使用。

    当使用特殊标记构建序列时,这不是序列开始的标记。使用的标记是 cls_token

  • eos_token (str, 可选, 默认为 "</s>") — 序列结束标记。

    当使用特殊标记构建序列时,这不是序列结束的标记。使用的标记是 sep_token

  • sep_token (str, 可选, 默认为 "</s>") — 分隔符标记,在从多个序列(例如,用于序列分类的两个序列或用于问答的文本和问题)构建序列时使用。它也是特殊标记构建的序列的最后标记。
  • cls_token (str, 可选, 默认值为 "<s>") — 分类标记token,用于做序列分类(对整个序列的分类而不是按标记分类)。在加入特殊标记构建时,它是序列的第一个标记。
  • unk_token (str, 可选, 默认值为 "<unk>") — 未知标记。词汇表中不存在的标记无法转换为ID,将被设置为该标记。
  • pad_token (str, 可选, 默认值为 "<pad>") — 填充标记,用于不同长度序列的批处理。
  • additional_special_tokens (List[str], optional, 默认为 ["<s>NOTUSED", "</s>NOTUSED"]) — 由编码器使用的额外特殊标记。

构建一个“快速”XGLM编码器(由HuggingFace的tokenizers库支持),改编自RobertaTokenizerXLNetTokenizer。基于BPE

此编码器继承自PreTrainedTokenizerFast,其中包含大多数主要方法。用户应参考这个超类获取关于这些方法的更多信息。

build_inputs_with_special_tokens

< >

( token_ids_0: List token_ids_1: Optional = None ) 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 ) List[int]

参数

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

返回

List[int]

零的列表。

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

Pytorch
隐藏Pytorch内容

XGLMModel

transformers.XGLMModel

< >

( config: XGLMConfig embed_tokens: 可选 = None )

参数

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

裸XGLM模型,输出原始隐藏状态,顶部没有添加任何特定头。该模型继承自 PreTrainedModel。请查看超类文档,了解库为所有模型实现的通用方法(例如下载或保存、调整输入嵌入、剪枝头部等)。

该模型也是PyTorch torch.nn.Module的子类。将其作为常规的PyTorch Module使用,并参考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 ) transformers.modeling_outputs.BaseModelOutputWithPastAndCrossAttentions or tuple(torch.FloatTensor)

参数

  • input_ids (torch.LongTensor of shape (batch_size, sequence_length)) — 输入序列单词在词汇表中的索引。如果你提供填充,默认会忽略填充内容。

    可以使用 AutoTokenizer 获取索引。有关详细信息,请参阅 PreTrainedTokenizer.encode()PreTrainedTokenizer.call()

    什么是输入ID?

  • attention_mask (torch.Tensor 形状 (batch_size, sequence_length)可选) — 用于避免在填充标记索引上执行注意力的掩码。掩码值在 [0, 1] 范围内选择:

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

    什么是注意力掩码?

  • 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 (形状为 (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=Trueconfig.use_cache=True 时返回) — 长度为 config.n_layerstuple,其中每个 tuple 包含 2 个形状为 (batch_size, num_heads, sequence_length, embed_size_per_head) 的张量以及 2 个形状为 (batch_size, num_heads, encoder_sequence_length, embed_size_per_head) 的额外张量。

    它包含预计算的隐藏状态(self-attention 和 cross-attention 块中的键和值),可以用于(参见 past_key_values 输入)加快顺序解码。

    如果使用 past_key_values,用户可以选择只输入最后一个 decoder_input_ids(那些没有向此模型提供过去键值状态的 decoder_input_ids),形状为 (batch_size, 1),而不是形状为 (batch_size, sequence_length) 的所有 decoder_input_ids

  • 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 而非 plain tuple。

返回

transformers.modeling_outputs.BaseModelOutputWithPastAndCrossAttentionstuple(torch.FloatTensor)

它可以是 transformers.modeling_outputs.BaseModelOutputWithPastAndCrossAttentions 或一个包含 torch.FloatTensor 的元组(如果传递 return_dict=Falseconfig.return_dict=False),具体元素取决于配置和输入。

  • 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)), 可选, 当传递 use_cache=Trueconfig.use_cache=True 时返回) — 长度为 config.n_layerstuple(torch.FloatTensor) 的元组,每个元组包含两个形状为 (batch_size, num_heads, sequence_length, embed_size_per_head) 的张量,如果有 config.is_encoder_decoder=True,则还包括两个形状为 (batch_size, num_heads, encoder_sequence_length, embed_size_per_head) 的张量。

    包含预计算的隐藏状态(self-attention 块中的键和值以及在 cross-attention 块中的可选值),这些状态可以用于(参见 past_key_values 输入)加速顺序解码。

  • hidden_states (tuple(torch.FloatTensor), 可选, 当传递 output_hidden_states=Trueconfig.output_hidden_states=True 时返回) — 包含形状为 (batch_size, sequence_length, hidden_size)torch.FloatTensor 的元组(如果模型有嵌入层,则包括嵌入层的输出之一,加上每个层的输出)。

    模型在每一层输出的隐藏状态以及可选的初始嵌入输出。

  • 注意事项 (tuple(torch.FloatTensor), 可选,当传递output_attentions=True或当config.output_attentions=True时返回) — torch.FloatTensor的元组(每个层一个)的元组,形状为(batch_size, num_heads, sequence_length, sequence_length)

    在注意力softmax之后的注意力权重,用于在自注意力头中计算加权平均。

  • 交叉注意力 (tuple(torch.FloatTensor), 可选,当output_attentions=Trueconfig.add_cross_attention=True被传递,或当config.output_attentions=True时返回) — torch.FloatTensor的元组(每个层一个),形状为(batch_size, num_heads, sequence_length, sequence_length)

    解码器的交叉 attentions 层在注意力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)

参数

  • configXGLMConfig) — 拥有模型所有参数的模型配置类。使用配置文件初始化时不会加载模型相关的权重,只加载配置。请查看 from_pretrained() 方法以加载模型权重。

XGLM模型变体,顶部带有语言建模头(权重与输入嵌入绑定的一层线性层)。

此模型继承自 PreTrainedModel。请查看超类文档,了解库为其所有模型实现的通用方法(例如下载或保存、调整输入嵌入大小、剪枝头等)。

该模型也是PyTorch torch.nn.Module的子类。将其作为常规的PyTorch Module使用,并参考PyTorch文档,获取有关通用用途和行为的所有事宜。

forward

< >

( input_ids: 可选 = None attention_mask: 可选 = None position_ids: 可选 = None encoder_hidden_states: 可选 = None encoder_attention_mask: 可选 = None head_mask: 可选 = None cross_attn_head_mask: 可选 = None past_key_values: 可选 = None inputs_embeds: 可选 = None labels: 可选 = None use_cache: 可选 = None output_attentions: 可选 = None output_hidden_states: 可选 = None return_dict: 可选 = None ) transformers.modeling_outputs.CausalLMOutputWithCrossAttentions or tuple(torch.FloatTensor)

参数

  • input_ids (torch.LongTensor of shape (batch_size, sequence_length)) — 输入序列的词库中的标记索引。如果提供了填充,则默认会忽略填充。

  • attention_mask(《torch.Tensor》类型,形状为(批大小, 序列长度)可选)— 用于避免在填充token的索引上执行注意力的掩码。掩码值在【0,1】内选取:
    • 1 用于未掩码的token,
    • 0 用于掩码的token。
  • position_ids(《torch.LongTensor》类型,形状为(批大小, 序列长度)可选)— 每个输入sequence token在位置嵌入中的位置索引。在范围【0,config.max_position_embeddings - 1】内选择。
  • encoder_hidden_states(《torch.FloatTensor》类型,形状为(批大小, 编码器序列长度, 隐藏层大小)可选)— 编码器最后层输出的隐藏状态序列。在解码器的交叉注意力中使用。
  • encoder_attention_mask (torch.LongTensor 形状为 (batch_size, encoder_sequence_length), 可选) — 避免在编码器输入的 padding tokens 索引上执行交叉注意力的 mask。mask 值选在 [0, 1] 之间:

    • 1 对应未 mask 的 tokens,
    • 0 对应被 mask 的 tokens。

    什么是注意力 mask?

  • head_mask (torch.Tensor 形状为 (num_layers, attention_heads), 可选) — 用于屏蔽注意力模块中选定 head 的 mask。mask 值选在 [0, 1] 之间:

    • 1 表示 head 未进行 mask,
    • 0 表示 head 已进行 mask。
  • cross_attn_head_mask (torch.Tensor 形状为 (num_layers, attention_heads), 可选) — 用于屏蔽交叉注意力模块中选定 head 的 mask。mask 值选在 [0, 1] 之间:

    • 1 表示 head 未进行 mask,
    • 0 表示 head 已进行 mask。
  • past_key_values(《代码元组》(tuple(tuple(torch.FloatTensor))(可选),当传递use_cache=True或当config.use_cache=True时返回)— 长度为config.n_layerstuple(torch.FloatTensor),每个元组包含形状为(batch_size, num_heads, sequence_length, embed_size_per_head)的2个张量,以及形状为(batch_size, num_heads, encoder_sequence_length, embed_size_per_head)的2个额外的张量。

    包含预先计算的隐藏状态(self-attention块和cross-attention块中的key和value),可以在(参见past_key_values输入)时用作(加速)序列解码。

    如果使用past_key_values,则用户可以选择只输入最后一个decoder_input_ids(没有给此模型的过去key value状态的那些,形状为(batch_size, 1)),而不是所有形状为(batch_size, sequence_length)decoder_input_ids

  • 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, 可选) — 是否返回<code>ModelOutput</code>而不是原始元组。
  • labels (torch.LongTensor,形状为(batch_size, sequence_length)可选) — 用于计算掩码语言模型损失的标签。索引可以是[0, ..., config.vocab_size]或-100 (请参阅input_ids文档字符串)。设置为-100的索引的标记将被忽略(掩码),损失仅对具有标签[0, ..., config.vocab_size]的标记计算。

返回

transformers.modeling_outputs.CausalLMOutputWithCrossAttentionstuple(torch.FloatTensor)

A transformers.modeling_outputs.CausalLMOutputWithCrossAttentions或一个包含torch.FloatTensor的元组(如果传递了 return_dict=False 或当 config.return_dict=False)根据配置(XGLMConfig)和输入确定。

  • loss (torch.FloatTensor,形状为(1,)可选,当提供labels时返回) — 语言模型损失(用于预测下一个标记)。

  • logits (torch.FloatTensor 的 shape 为 (batch_size, sequence_length, config.vocab_size)) — 语言建模头的预测分数(SoftMax 之前每个词汇的分数)。

  • hidden_states (tuple(torch.FloatTensor), 可选, 当传递 output_hidden_states=Trueconfig.output_hidden_states=True 时返回) — 包含形状为 (batch_size, sequence_length, hidden_size)torch.FloatTensor 的元组(如果模型有嵌入层,则包括嵌入层的输出之一,加上每个层的输出)。

    模型在每一层输出的隐藏状态以及可选的初始嵌入输出。

  • 注意事项 (tuple(torch.FloatTensor), 可选,当传递output_attentions=True或当config.output_attentions=True时返回) — torch.FloatTensor的元组(每个层一个)的元组,形状为(batch_size, num_heads, sequence_length, sequence_length)

    在注意力softmax之后的注意力权重,用于在自注意力头中计算加权平均。

  • cross_attentions (tuple(torch.FloatTensor), 可选,在传递 output_attentions=Trueconfig.output_attentions=True 时返回) — 一个包含 torch.FloatTensor 元组的元组(每个层一个),shape 为 (batch_size, num_heads, sequence_length, sequence_length)

    注意力 softmax 后的交叉注意力权重,用于计算交叉注意力头中的加权和。

  • past_key_values (tuple(tuple(torch.FloatTensor)), 可选,在传递 use_cache=Trueconfig.use_cache=True 时返回) — torch.FloatTensor 元组的元组,长度为 config.n_layers,每个元组包含用于编码器-解码器设置的模型中的自注意力和交叉注意力层的缓存的键、值状态。仅当 config.is_decoder = True 时相关。

    包含预计算的内嵌状态(注意力和值,用于注意力块),可用于(参见 past_key_values 输入)加速序列解码。

《XGLMForCausalLM》的 forward 方法覆盖了 __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 内容

TFXGLMModel

class transformers.TFXGLMModel

< >

( config: XGLMConfig embed_tokens: Optional[TFSharedEmbeddings] = None *inputs: Any **kwargs: Any )

参数

  • config (XGLMConfig) — 包含模型所有参数的模型配置类。使用配置文件初始化不加载与模型关联的权重,只加载配置。请查阅 from_pretrained() 方法以加载模型权重。config — XGLMConfig embed_tokens — [TFSharedEmbeddings]: 输出嵌入

仅输出原始隐含状态的裸XGLM模型 transformer,没有顶层特定头。该模型继承自 TFPreTrainedModel。请查阅超类文档,了解库为所有模型实现的通用方法(如下载或保存、调整输入嵌入、剪枝头部等)

该模型也是一个 keras.Model 子类。您可以将其作为常规的 TF 2.0 Keras 模型使用,并参阅 TF 2.0 文档了解所有与通用使用和行为相关的内容。

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

  • 将所有输入作为关键字参数(类似于 PyTorch 模型),或
  • 将所有输入作为一个列表、元组或字典作为第一个位置参数。

支持第二种格式的理由是,Keras 方法在将输入传递给模型和层时更喜欢这种格式。正因为这种支持,当使用如 model.fit() 等方法时,应该“自然而然”地为您工作——只需以 model.fit() 支持的任何格式传递您的输入和标签即可!但是,如果您想在 fit()predict() 等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函数一样传递输入!

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

调用

< >

( input_ids: TFModelInputType | None = None attention_mask: np.ndarray | tf.Tensor | None = None position_ids: np.ndarray | tf.Tensor | None = None encoder_hidden_states: np.ndarray | tf.Tensor | None = None encoder_attention_mask: np.ndarray | tf.Tensor | None = None head_mask: np.ndarray | tf.Tensor | None = None cross_attn_head_mask: np.ndarray | tf.Tensor | None = None past_key_values: Optional[Tuple[Tuple[Union[np.ndarray, tf.Tensor]]]] = None inputs_embeds: np.ndarray | tf.Tensor | None = None use_cache: Optional[bool] = None output_attentions: Optional[bool] = None output_hidden_states: Optional[bool] = None return_dict: Optional[bool] = None training: Optional[bool] = False **kwargs: Any ) transformers.modeling_tf_outputs.TFBaseModelOutputWithPastAndCrossAttentionstuple(tf.Tensor)

参数

  • input_ids (形状为 {0}tf.Tensor) — 输入序列单词在词汇表中的索引。

    可以使用 AutoTokenizer 获取索引。详见 PreTrainedTokenizer.encode()PreTrainedTokenizer.call()

    什么是输入 ID?

  • attention_mask (形状为 {0}tf.Tensor,可选) — 用于避免在填充令牌索引上执行注意机制的掩码。掩码值在 [0, 1] 中选择:

    • 值为 1 的为未掩码的令牌,
    • 值为 0 的为掩码的令牌。

    什么是注意掩码?

  • position_ids (形状为 (batch_size, sequence_length)tf.TensorNumpy array,可选) — 每个输入序列单词在位置嵌入中的位置索引。选择范围为 [0, config.max_position_embeddings - 1]

    什么是位置 ID?

  • encoder_hidden_states (tf.Tensor 形状为 (batch_size, encoder_sequence_length, hidden_size)可选) — 编码器最后一层的输出隐含状态序列。用于解码器的跨注意力机制。
  • encoder_attention_mask (tf.Tensor 形状为 (batch_size, encoder_sequence_length)可选) — 避免在编码器输入_ids的填充标记索引处执行跨注意力的掩码。掩码值选择在 [0, 1] 范围内:

    • 1 表示 未掩码 的标记;
    • 0 表示 已掩码 的标记。

    什么是注意力掩码?

  • head_mask (tf.Tensor 形状为 (num_layers, attention_heads)可选) — 用于使编码器注意力模块中选定的头部失效的掩码。掩码值选择在 [0, 1] 范围内:

    • 1 表示头部 未掩码
    • 0 表示头部 已掩码
  • cross_attn_head_mask (tf.Tensor of shape (num_layers, attention_heads)可选)—用于取消选中跨注意力模块中的 heads 的掩码。掩码值在 [0, 1] 中选择:

    • 1 表示 head 未被掩码,
    • 0 表示 head 被掩码。
  • past_key_values (Tuple[Tuple[tf.Tensor]] of length config.num_layers) — 包含预计算的注意力块的键和值隐藏状态。可用于加速解码。如果使用了 past_key_values,则用户可以可选地只输入最后 decoder_input_ids(那些没有给此模型提供过去键值状态的)的形状为 (batch_size, 1) 的值,而不是所有 decoder_input_ids 的形状为 (batch_size, sequence_length) 的值。
  • inputs_embeds (tf.Tensor of shape (batch_size, sequence_length, hidden_size)可选)—可选地,您可以选择直接传递嵌入表示,而不是通过 input_ids。这在您想要比模型的内部嵌入查找矩阵有更多控制权时很有用,以将 input_ids 索引转换为相互关联的向量。
  • use_cache (布尔值, 可选,默认为 True) — 如果设置为 True,将返回 past_key_values 键值状态,并可用来加速解码(参见 past_key_values)。训练期间设置为 False,生成期间设置为 True
  • output_attentions (布尔值, 可选) — 是否返回所有注意力层的注意力张量。详见返回张量中的 attentions。此参数仅在急切模式下可用,在图模式中,将使用配置中的值。
  • output_hidden_states (布尔值, 可选) — 是否返回所有层的隐藏状态。详见返回张量中的 hidden_states。此参数仅在急切模式下可用,在图模式中,将使用配置中的值。
  • return_dict (bool, optional) — 是否返回ModelOutput对象而不是普通元组。此参数在effective mode中可用,在graph mode中该值始终设置为True。
  • training (bool, optional, defaults to False) — 是否以训练模式使用模型(某些模块(如dropout模块)在训练和评估之间有不同的行为)。

返回

transformers.modeling_tf_outputs.TFBaseModelOutputWithPastAndCrossAttentionstuple(tf.Tensor)

transformers.modeling_tf_outputs.TFBaseModelOutputWithPastAndCrossAttentions 或一个包含各种元素的 tf.Tensor 元组(如果传递了 return_dict=Falseconfig.return_dict=False 时),这些元素的构成取决于配置(XGLMConfig)和输入。

  • last_hidden_state (tf.Tensor of shape (batch_size, sequence_length, hidden_size)) — 模型最后层的输出隐藏状态序列。

    如果使用了 past_key_values,则仅输出形状为 (batch_size, 1, hidden_size) 的序列的最后一个隐藏状态。

  • past_key_values (List[tf.Tensor], optional, returned when use_cache=True is passed or when config.use_cache=True) — 包含长度为 config.n_layerstf.Tensor 列表,每个张量的形状为 (2, batch_size, num_heads, sequence_length, embed_size_per_head)

    包含预计算的内嵌状态(注意力和值,用于注意力块),可用于(参见 past_key_values 输入)加速序列解码。

  • hidden_states (tuple(tf.FloatTensor), optional, returned when output_hidden_states=True is passed or when config.output_hidden_states=True) — 包含一个用于词嵌入输出的 tf.Tensor 和每个层的输出的 tf.Tensor 的元组,形状为 (batch_size, sequence_length, hidden_size)

    模型每层的输出隐藏状态以及初始嵌入输出。

  • attentions (tuple(tf.Tensor), optional, returned when output_attentions=True is passed or when config.output_attentions=True) — 一个形状为 (batch_size, num_heads, sequence_length, sequence_length)tf.Tensor 元组(一个用于每一层)。

    在注意力softmax之后的注意力权重,用于在自注意力头中计算加权平均。

  • cross_attentions (tuple(tf.Tensor), optional, returned when output_attentions=True is passed or when config.output_attentions=True) — 一个形状为 (batch_size, num_heads, sequence_length, sequence_length)tf.Tensor 元组(一个用于每一层)。

    解码器的交叉 attentions 层在注意力softmax之后的注意力权重,用于在交叉注意力头中计算加权平均。

TFXGLMModel 前向方法重载了特殊方法 __call__

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

示例

>>> from transformers import AutoTokenizer, TFXGLMModel
>>> import tensorflow as tf

>>> tokenizer = AutoTokenizer.from_pretrained("facebook/xglm-564M")
>>> model = TFXGLMModel.from_pretrained("facebook/xglm-564M")

>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="tf")
>>> outputs = model(inputs)

>>> last_hidden_states = outputs.last_hidden_state

TFXGLMForCausalLM

transformers.TFXGLMForCausalLM

< >

( config: XGLMConfig embed_tokens: Optional[TFSharedEmbeddings] = None *inputs: Any **kwargs: Any )

参数

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

XGLM模型变体,顶部带有语言建模头(权重与输入嵌入绑定的一层线性层)。

此模型继承自 TFPreTrainedModel。检查超类文档,了解库为所有模型实现的一般方法(如下载或保存、调整输入嵌入的大小、剪枝头部等)。

该模型也是一个 keras.Model 子类。您可以将其作为常规的 TF 2.0 Keras 模型使用,并参阅 TF 2.0 文档了解所有与通用使用和行为相关的内容。

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

  • 将所有输入作为关键字参数(类似于 PyTorch 模型),或
  • 将所有输入作为一个列表、元组或字典作为第一个位置参数。

支持第二种格式的理由是,Keras 方法在将输入传递给模型和层时更喜欢这种格式。正因为这种支持,当使用如 model.fit() 等方法时,应该“自然而然”地为您工作——只需以 model.fit() 支持的任何格式传递您的输入和标签即可!但是,如果您想在 fit()predict() 等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函数一样传递输入!

调用

< >

( input_ids: TFModelInputType | None = None attention_mask: np.ndarray | tf.Tensor | None = None position_ids: np.ndarray | tf.Tensor | None = None encoder_hidden_states: np.ndarray | tf.Tensor | None = None encoder_attention_mask: np.ndarray | tf.Tensor | None = None head_mask: np.ndarray | tf.Tensor | None = None cross_attn_head_mask: np.ndarray | tf.Tensor | None = None past_key_values: Optional[Tuple[Tuple[Union[np.ndarray, tf.Tensor]]]] = None inputs_embeds: np.ndarray | tf.Tensor | None = None labels: np.ndarray | tf.Tensor | None = None use_cache: Optional[bool] = None output_attentions: Optional[bool] = None output_hidden_states: Optional[bool] = None return_dict: Optional[bool] = None training: Optional[bool] = False **kwargs: 任何类型的参数 ) transformers.modeling_tf_outputs.TFCausalLMOutputWithCrossAttentions 或者 tuple(tf.Tensor)

参数

  • input_ids (tf.Tensor 形状 ({0})) — 词汇表中输入序列tokens的索引。

    可以使用 AutoTokenizer 获取索引。详细信息请参阅 PreTrainedTokenizer.encode()PreTrainedTokenizer.call()

    什么是input IDs?

  • attention_mask (tf.Tensor 形状 ({0})可选) — 避免对填充token索引执行attention的掩码。选定的掩码值在 [0, 1] 范围内:

    • 1 表示 未掩码 的tokens,
    • 0 表示 掩码 的tokens。

    什么是attention masks?

  • position_ids (tf.TensorNumpy array 形状 (batch_size, sequence_length)可选) — 每个输入序列tokens在位置嵌入中的位置索引。在 [0, config.max_position_embeddings - 1] 范围内选择。

    什么是position IDs?

  • encoder_hidden_states (tf.Tensor of shape (batch_size, encoder_sequence_length, hidden_size), optional) — 编码器最后一层输出的隐藏状态序列。在解码器的交叉注意力中 使用。
  • encoder_attention_mask (tf.Tensor of shape (batch_size, encoder_sequence_length), optional) — 避免在编码器输入 IDs 的填充 token 索引上执行交叉注意力的掩码。掩码值选自 [0, 1]

    • 1 表示 未掩码 的 token,
    • 0 表示 掩码 的 token。

    什么是注意力掩码?

  • head_mask (tf.Tensor of shape (num_layers, attention_heads), optional) — 用于取消编码器注意力模块中选定的头部的掩码。掩码值选自 [0, 1]

    • 1 表示头部 未掩码
    • 0 表示头部 掩码
  • cross_attn_head_mask (tf.Tensor 形状 (num_layers, attention_heads)可选)- 用于取消跨注意力模块选定的头的掩码。掩码值选在 [0, 1] 之间:

    • 1 表示该头未置掩码,
    • 0 表示该头已置掩码。
  • past_key_values (一个长度为 config.num_layers 的元组,元素为 Tuple[tf.Tensor])- 包含注意力块的预计算键和值隐藏状态。可用于加速解码。如果使用 past_key_values,用户可以可选地输入只包含最后 decoder_input_ids (没有过去键值状态输入给此模型的那些)的形状为 (batch_size, 1),而不是所有形状为 (batch_size, sequence_length)decoder_input_ids
  • inputs_embeds (tf.Tensor 形状 (batch_size, sequence_length, hidden_size)可选)- 可选地,您可以选择直接传递嵌入表示而不是 input_ids。这在您希望有更多控制,以便将 input_ids 索引转换为相关向量时非常有用,而不是使用模型内部嵌入查找矩阵。
  • use_cache (bool, 可选,默认为 True) — 如果设置为 True,将返回 past_key_values 的键值状态,可用于加速解码(参见 past_key_values)。在训练期间设置为 False,在生成期间设置为 True
  • output_attentions (bool, 可选) — 是否返回所有注意力层的注意力张量。请参阅返回张量下的 attentions 以获取更多详细信息。此参数仅可用于快速模式,在图模式中,使用配置中的值。
  • output_hidden_states (bool, 可选) — 是否返回所有层的隐藏状态。请参阅返回张量下的 hidden_states 以获取更多详细信息。此参数仅可用于快速模式,在图模式中,使用配置中的值。
  • return_dict (bool, 可选) — 是否返回 ModelOutput 而不是纯元组。这个参数可以在急切模式下使用,在图模式下该值始终设置为True。
  • training (bool, 可选, 默认为 False) — 是否使用模型进行训练模式(某些模块如dropout模块在训练和评估之间有不同行为)。
  • labels (np.ndarraytf.Tensor 形状为 (batch_size, sequence_length), 可选) — 为语言建模提供的标签。注意,标签在模型内部会发生位移,即你可以将 labels = input_ids。索引会在 [-100, 0, ..., config.vocab_size] 中选择。所有设置为 -100 的标签都会被忽略(掩码),仅在 [0, ..., config.vocab_size] 的标签上计算损失。

返回

transformers.modeling_tf_outputs.TFCausalLMOutputWithCrossAttentionstuple(tf.Tensor)

一个 transformers.modeling_tf_outputs.TFCausalLMOutputWithCrossAttentions 或一个 tf.Tensor 的元组(如果传递了 return_dict=False 或当 config.return_dict=False 时),它包含根据配置(XGLMConfig)和输入的不同元素。

  • 损失 (tf.Tensor 形状 (n,)可选,当提供 labels 时返回,其中 n 是非掩码标签的数量) — 语言模型损失(用于下一个标记的预测)。

  • logits (tf.Tensor 形状 (batch_size, sequence_length, config.vocab_size)) — 语言建模头部的预测得分(SoftMax 之前每个词汇标记的得分)。

  • hidden_states (tuple(tf.Tensor)可选,在传递 output_hidden_states=True 时返回或在 config.output_hidden_states=True 时返回) — 形状为 (batch_size, sequence_length, hidden_size)tf.Tensor 元组(一个用于嵌入层的输出,一个用于每层的输出)。

    模型每层的输出隐藏状态以及初始嵌入输出。

  • attentions (tuple(tf.Tensor), optional, returned when output_attentions=True is passed or when config.output_attentions=True) — 一个形状为 (batch_size, num_heads, sequence_length, sequence_length)tf.Tensor 元组(一个用于每一层)。

    在注意力softmax之后的注意力权重,用于在自注意力头中计算加权平均。

  • cross_attentions (tuple(tf.Tensor), optional, returned when output_attentions=True is passed or when config.output_attentions=True) — 一个形状为 (batch_size, num_heads, sequence_length, sequence_length)tf.Tensor 元组(一个用于每一层)。

    解码器的交叉 attentions 层在注意力softmax之后的注意力权重,用于在交叉注意力头中计算加权平均。

  • past_key_values (List[tf.Tensor], optional, returned when use_cache=True is passed or when config.use_cache=True) — 包含长度为 config.n_layerstf.Tensor 列表,每个张量的形状为 (2, batch_size, num_heads, sequence_length, embed_size_per_head)

    包含预计算的内嵌状态(注意力和值,用于注意力块),可用于(参见 past_key_values 输入)加速序列解码。

transformers.modeling_tf_outputs.TFCausalLMOutputWithCrossAttentionstuple(tf.Tensor):一个 transformers.modeling_tf_outputs.TFCausalLMOutputWithCrossAttentions 或一个 tf.Tensor 的元组(如果传入 return_dict=False 或当 config.return_dict=False)根据配置(XGLMConfig)和输入包含各种元素。

  • 损失 (tf.Tensor 形状 (n,)可选,当提供 labels 时返回,其中 n 是非掩码标签的数量) — 语言模型损失(用于下一个标记的预测)。

  • logits (tf.Tensor 形状 (batch_size, sequence_length, config.vocab_size)) — 语言建模头部的预测得分(SoftMax 之前每个词汇标记的得分)。

  • hidden_states (tuple(tf.Tensor)可选,在传递 output_hidden_states=True 时返回或在 config.output_hidden_states=True 时返回) — 形状为 (batch_size, sequence_length, hidden_size)tf.Tensor 元组(一个用于嵌入层的输出,一个用于每层的输出)。

    模型每层的输出隐藏状态以及初始嵌入输出。

  • attentions (tuple(tf.Tensor), optional, returned when output_attentions=True is passed or when config.output_attentions=True) — 一个形状为 (batch_size, num_heads, sequence_length, sequence_length)tf.Tensor 元组(一个用于每一层)。

    在注意力softmax之后的注意力权重,用于在自注意力头中计算加权平均。

  • cross_attentions (tuple(tf.Tensor), optional, returned when output_attentions=True is passed or when config.output_attentions=True) — 一个形状为 (batch_size, num_heads, sequence_length, sequence_length)tf.Tensor 元组(一个用于每一层)。

    解码器的交叉 attentions 层在注意力softmax之后的注意力权重,用于在交叉注意力头中计算加权平均。

  • past_key_values (List[tf.Tensor], optional, returned when use_cache=True is passed or when config.use_cache=True) — 包含长度为 config.n_layerstf.Tensor 列表,每个张量的形状为 (2, batch_size, num_heads, sequence_length, embed_size_per_head)

    包含预计算的内嵌状态(注意力和值,用于注意力块),可用于(参见 past_key_values 输入)加速序列解码。

TFXGLMForCausalLM 的 forward 方法重写了特殊方法 __call__

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

示例

>>> from transformers import AutoTokenizer, TFXGLMForCausalLM
>>> import tensorflow as tf

>>> tokenizer = AutoTokenizer.from_pretrained("facebook/xglm-564M")
>>> model = TFXGLMForCausalLM.from_pretrained("facebook/xglm-564M")

>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="tf")
>>> outputs = model(inputs)
>>> logits = outputs.logits
JAX
隐藏 JAX 内容

FlaxXGLMModel

class transformers.FlaxXGLMModel

< >

( config: XGLMConfig input_shape: Tuple = (1, 1) seed: int = 0 dtype: dtype = <class 'jax.numpy.float32'> _do_init: bool = True **kwargs )

参数

  • config (XGLMConfig) — 包含模型所有参数的模型配置类。用配置文件初始化时不加载与模型关联的权重,只加载配置。检查 from_pretrained() 方法以加载模型权重。
  • dtype (jax.numpy.dtype, optional, 默认为 jax.numpy.float32) — 计算的数据类型。可以是 jax.numpy.float32jax.numpy.float16(在 GPU 上)和 jax.numpy.bfloat16(在 TPU 上)之一。

    这可以用于启用 GPU 或 TPU 上的混合精度训练或半精度推理。如果指定,所有计算都将使用给定的 dtype 完成。

    注意,这仅指定了计算的数据类型,不影响模型参数的数据类型。

    如果您想更改模型参数的数据类型,请参阅 to_fp16()to_bf16()

不包含任何特定头部而直接输出原始隐藏状态的裸 XGLM 模型变压器。该模型继承自 FlaxPreTrainedModel。检查超类文档以了解库为所有模型实现的通用方法(例如下载或保存、调整输入嵌入层大小、修剪头部等)。

此模型也是 Flax Linen flax.nn.Module 子类。将其作为常规 Flax 模块使用,并根据 Flax 文档查阅有关一般使用和行为的相关信息。

最后,该模型支持以下 JAX 内置特性:

__call__

< >

( input_ids: 数组 attention_mask: 可选 = None position_ids: 可选 = None encoder_hidden_states: 可选 = None encoder_attention_mask: 可选 = None output_attentions: 可选 = None output_hidden_states: 可选 = None return_dict: 可选 = None train: 布尔 = False params: 字典 = None past_key_values: 字典 = None dropout_rng: PRNGKey = None ) transformers.modeling_flax_outputs.FlaxBaseModelOutputWithPastAndCrossAttentionstuple(torch.FloatTensor)

参数

  • input_ids (jnp.ndarray of shape (batch_size, sequence_length)) — 词汇表中的输入序列标记的索引。如果提供了填充项,则默认会忽略填充项。

    可以使用 AutoTokenizer 获取索引。有关详细信息,请参阅 PreTrainedTokenizer.encode()PreTrainedTokenizer.call()

    什么是输入ID?

  • attention_mask (jnp.ndarray of shape (batch_size, sequence_length), optional) — 避免对填充标记索引执行 attention 任务的掩码。掩码值选择在 [0, 1] 之间:

    • 1 表示 未掩码 的标记,
    • 0 表示 掩码 的标记。

    什么是 attention 掩码?

  • position_ids (numpy.ndarray of shape (batch_size, sequence_length), optional) — 每个输入序列标记的定位嵌入的索引。选择范围在 [0, config.max_position_embeddings - 1]
  • output_attentions (bool, 可选) — 是否返回所有注意力层的注意力张量。更多详细内容请参见返回张量中的 attentions
  • output_hidden_states (bool, 可选) — 是否返回所有层的隐藏状态。更多详细内容请参见返回张量中的 hidden_states
  • return_dict (bool, 可选) — 是否返回一个 ModelOutput 而不是普通的元组。

返回

transformers.modeling_flax_outputs.FlaxBaseModelOutputWithPastAndCrossAttentionstuple(torch.FloatTensor)

transformers.modeling_flax_outputs.FlaxBaseModelOutputWithPastAndCrossAttentions 或一个由 torch.FloatTensor 组成的元组(如果传递了 return_dict=False 或者当 config.return_dict=False 时),包含根据配置(XGLMConfig)和输入决定的各种元素。

  • last_hidden_state (jnp.ndarray 形状为 (batch_size, sequence_length, hidden_size)]) — 模型最后层的输出隐藏状态的序列。

    如果使用了 past_key_values,则仅输出形状为 (batch_size, 1, hidden_size) 的序列的最后一个隐藏状态。

  • past_key_valuestuple(tuple(jnp.ndarray))可选,当传递 use_cache=True 或当 config.use_cache=True)时返回——长度为 config.n_layerstuple(tuple(jnp.ndarray)) 的元组,其中每个元组包含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) 的张量。

    包含预计算的隐藏状态(self-attention 块中的键和值以及在 cross-attention 块中的可选值),这些状态可以用于(参见 past_key_values 输入)加速顺序解码。

  • hidden_statestuple(jnp.ndarray)可选,当传递 output_hidden_states=True 或当 config.output_hidden_states=True)时返回——元组,包含形状为 (batch_size, sequence_length, hidden_size)jnp.ndarray(一个用于嵌入层的输出,另一个用于每一层的输出)。

    模型每层的输出隐藏状态以及初始嵌入输出。

  • attentionstuple(jnp.ndarray)可选,当传递 output_attentions=True 或当 config.output_attentions=True)时返回——包含形状为 (batch_size, num_heads, sequence_length, sequence_length)jnp.ndarray 的元组(每个层一个)。

    在注意力softmax之后的注意力权重,用于在自注意力头中计算加权平均。

  • cross_attentionstuple(jnp.ndarray)可选,当传递 output_attentions=Trueconfig.add_cross_attention=True 或当 config.output_attentions=True)时返回——包含形状为 (batch_size, num_heads, sequence_length, sequence_length)jnp.ndarray 的元组(每个层一个)。

    解码器的交叉 attentions 层在注意力softmax之后的注意力权重,用于在交叉注意力头中计算加权平均。

FlaxXGLMPreTrainedModel 的 forward 方法重写了 __call__ 特殊方法。

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

示例

>>> from transformers import AutoTokenizer, FlaxXGLMModel

>>> tokenizer = AutoTokenizer.from_pretrained("facebook/xglm-564M")
>>> model = FlaxXGLMModel.from_pretrained("facebook/xglm-564M")

>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="jax")
>>> outputs = model(**inputs)

>>> last_hidden_states = outputs.last_hidden_state

FlaxXGLMForCausalLM

transformers.FlaxXGLMForCausalLM

< >

( config: XGLMConfig input_shape: Tuple = (1, 1) seed: int = 0 dtype: dtype = <class 'jax.numpy.float32'> _do_init: bool = True **kwargs )

参数

  • config (XGLMConfig) — 模型配置类,包含模型的所有参数。使用配置文件初始化不会加载与模型相关的权重,只会加载配置。查看from_pretrained() 方法以加载模型权重。
  • dtype (jax.numpy.dtype, 可选, 默认为 jax.numpy.float32) — 计算的数据类型。可以是 jax.numpy.float32jax.numpy.float16(在 GPU 上)和 jax.numpy.bfloat16(在 TPU 上)。可以用来启用 GPU 或 TPU 上的混合精度训练或半精度推理。如果指定,所有计算将以给定的 dtype 执行。

XGLM模型变体,顶部带有语言建模头(权重与输入嵌入绑定的一层线性层)。

该模型继承自FlaxPreTrainedModel。查看父类文档了解库为所有模型实现的通用方法(如下载或保存、调整输入嵌入层的尺寸、剪枝头部等)。

此模型也是 Flax Linen flax.nn.Module 子类。将其作为常规 Flax 模块使用,并根据 Flax 文档查阅有关一般使用和行为的相关信息。

最后,该模型支持以下 JAX 内置特性:

__call__

< >

( input_ids: 数组 attention_mask: 可选 = None position_ids: 可选 = None encoder_hidden_states: 可选 = None encoder_attention_mask: 可选 = None output_attentions: 可选 = None output_hidden_states: 可选 = None return_dict: 可选 = None train: 布尔 = False params: 字典 = None past_key_values: 字典 = None dropout_rng: PRNGKey = None ) transformers.modeling_flax_outputs.FlaxCausalLMOutputWithCrossAttentionstuple(torch.FloatTensor)

参数

  • input_ids (jnp.ndarray of shape (batch_size, sequence_length)) — 输入序列token在词汇表中的索引。如果提供了padding,则默认忽略padding。

  • attention_mask (jnp.ndarray of shape (batch_size, sequence_length), 可选) — 用于避免在padding token索引上执行注意力的掩码。在[0, 1]中的掩码值选:

  • position_ids (numpy.ndarray of shape (batch_size, sequence_length), 可选) — 每个输入序列token在位置嵌入中的位置索引。选取范围在[0, config.max_position_embeddings - 1]之内。
  • output_attentions (bool, 可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息,请参阅返回张量下的 attentions
  • output_hidden_states (bool, 可选) — 是否返回所有层的隐藏状态。有关更多详细信息,请参阅返回张量下的 hidden_states
  • return_dict (bool, 可选) — 是否返回 ModelOutput 而不是普通元组。

返回

transformers.modeling_flax_outputs.FlaxCausalLMOutputWithCrossAttentionstuple(torch.FloatTensor)

transformers.modeling_flax_outputs.FlaxCausalLMOutputWithCrossAttentions 或一个由 torch.FloatTensor 组成的元组(如果传递了 return_dict=False 或当 config.return_dict=False 时),包括根据配置(XGLMConfig)和输入的各种元素。

  • logits (jnp.ndarray 的形状为 (batch_size, sequence_length, config.vocab_size)) — 语言建模头的预测分数(SoftMax 之前的每个词汇的分数)。

  • hidden_statestuple(jnp.ndarray)可选,当传递 output_hidden_states=True 或当 config.output_hidden_states=True)时返回——元组,包含形状为 (batch_size, sequence_length, hidden_size)jnp.ndarray(一个用于嵌入层的输出,另一个用于每一层的输出)。

    模型每层的输出隐藏状态以及初始嵌入输出。

  • attentionstuple(jnp.ndarray)可选,当传递 output_attentions=True 或当 config.output_attentions=True)时返回——包含形状为 (batch_size, num_heads, sequence_length, sequence_length)jnp.ndarray 的元组(每个层一个)。

    在注意力softmax之后的注意力权重,用于在自注意力头中计算加权平均。

  • cross_attentions (tuple(jnp.ndarray), 可选,在传递 output_attentions=True 或当 config.output_attentions=True 时返回) — shape 为 (batch_size, num_heads, sequence_length, sequence_length)jnp.ndarray 元组(每个层一个)。

    注意力 softmax 后的交叉注意力权重,用于计算交叉注意力头中的加权和。

  • past_key_values (tuple(tuple(jnp.ndarray)), 可选,当传递 use_cache=True 或当 config.use_cache=True 时返回) — 长度为 config.n_layersjnp.ndarray 元组元组,每个元组包含自注意力层和交叉注意力层的缓存键、值状态,如果模型在编码器-解码器设置中使用的话。只有在 config.is_decoder = True 时才相关。

    包含预计算的内嵌状态(注意力和值,用于注意力块),可用于(参见 past_key_values 输入)加速序列解码。

FlaxXGLMPreTrainedModel 的 forward 方法重写了 __call__ 特殊方法。

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

示例

>>> from transformers import AutoTokenizer, FlaxXGLMForCausalLM

>>> tokenizer = AutoTokenizer.from_pretrained("facebook/xglm-564M")
>>> model = FlaxXGLMForCausalLM.from_pretrained("facebook/xglm-564M")

>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="np")
>>> outputs = model(**inputs)

>>> # retrieve logts for next token
>>> next_token_logits = outputs.logits[:, -1]
< > 更新GitHub