SwitchTransformers
概述
SwitchTransformers模型由William Fedus、Barret Zoph和Noam Shazeer在Switch Transformers: Scaling to Trillion Parameter Models with Simple and Efficient Sparsity中提出。
Switch Transformer 模型使用了一种稀疏的 T5 编码器-解码器架构,其中 MLP 被专家混合(MoE)所取代。路由机制(在这种情况下是 top 1)将每个标记与一个专家关联起来,每个专家都是一个密集的 MLP。虽然 Switch Transformer 比其等效的密集模型有更多的权重,但稀疏性允许更好的扩展性和在大规模情况下的更好的微调性能。 在前向传播过程中,只使用了一部分权重。路由机制允许模型动态选择相关权重,从而在不增加操作数量的情况下增加模型容量。
论文的摘要如下:
在深度学习中,模型通常为所有输入重用相同的参数。专家混合模型(MoE)则不同,它为每个输入示例选择不同的参数。结果是一个稀疏激活的模型——具有惊人的参数数量——但计算成本是恒定的。然而,尽管MoE取得了一些显著的成功,但其广泛采用仍受到复杂性、通信成本和训练不稳定性的阻碍——我们通过Switch Transformer解决了这些问题。我们简化了MoE路由算法,并设计了直观的改进模型,减少了通信和计算成本。我们提出的训练技术有助于解决不稳定性问题,并且我们首次展示了可以使用较低精度(bfloat16)格式训练大型稀疏模型。我们基于T5-Base和T5-Large设计了模型,在相同的计算资源下,预训练速度提高了7倍。这些改进在多语言环境中也得到了体现,我们在所有101种语言中测量了相对于mT5-Base版本的增益。最后,我们通过在“Colossal Clean Crawled Corpus”上预训练高达万亿参数的模型,推进了当前语言模型的规模,并实现了相对于T5-XXL模型的4倍加速。
该模型由Younes Belkada和Arthur Zucker贡献。 原始代码可以在这里找到。
使用提示
- SwitchTransformers 使用 T5Tokenizer,可以直接从每个模型的存储库中加载。
- 发布的权重是在英语Masked Language Modeling任务上预训练的,应该进行微调。
资源
SwitchTransformersConfig
类 transformers.SwitchTransformersConfig
< source >( vocab_size = 32128 d_model = 768 d_kv = 64 d_ff = 2048 expert_capacity = 64 num_layers = 12 num_sparse_encoder_layers = 3 num_decoder_layers = 12 num_sparse_decoder_layers = 3 num_heads = 12 num_experts = 8 router_bias = False router_jitter_noise = 0.01 router_dtype = 'float32' router_ignore_padding_tokens = False relative_attention_num_buckets = 32 relative_attention_max_distance = 128 dropout_rate = 0.1 layer_norm_epsilon = 1e-06 router_z_loss_coef = 0.001 router_aux_loss_coef = 0.001 initializer_factor = 1.0 dense_act_fn = 'relu' is_encoder_decoder = True add_router_probs = False use_cache = True pad_token_id = 0 eos_token_id = 1 **kwargs )
参数
- vocab_size (
int
, optional, 默认为 32128) — SwitchTransformers 模型的词汇表大小。定义了调用 SwitchTransformersModel 时传递的inputs_ids
可以表示的不同标记的数量。 - d_model (
int
, optional, 默认为 768) — 编码器层和池化层的大小. - d_kv (
int
, optional, 默认为 64) — 每个注意力头的键、查询、值投影的大小。d_kv
必须等于d_model // num_heads
. - d_ff (
int
, 可选, 默认为 2048) — 每个SwitchTransformersBlock
中中间前馈层的大小. - expert_capacity (
int
, optional, 默认为 64) — 每个专家可以存储的令牌数量。如果设置为1,模型将表现得像一个普通的Transformer。 - num_layers (
int
, optional, defaults to 12) — Transformer编码器层中的密集隐藏层数量。 - num_sparse_encoder_layers (
int
, optional, defaults to 3) — Transformer编码器层中稀疏(MoE)密集隐藏层的数量。 - num_decoder_layers (
int
, 可选, 默认为 12) — Transformer 解码器中的隐藏层数。如果未设置,将使用与num_layers
相同的值。 - num_sparse_decoder_layers (
int
, optional, defaults to 3) — Transformer解码器层中稀疏(MoE)密集隐藏层的数量。 - num_heads (
int
, optional, defaults to 12) — Transformer编码器中每个注意力层的注意力头数。 - num_experts (
int
, optional, defaults to 8) — 每个SwitchTransformer层的专家数量。 - router_bias (
bool
, optional, defaults toFalse
) — 是否向路由器添加偏置。 - router_jitter_noise (
float
, optional, defaults to 0.01) — 添加到路由器的噪声量 - router_dtype (
str
, 可选, 默认为"float32"
) — 用于路由器的dtype
。最好将dtype
保持为"float32"
,如论文中的选择性精度讨论中所指定的那样。 - router_ignore_padding_tokens (
bool
, optional, defaults toFalse
) — 是否在路由时忽略填充标记。 - relative_attention_num_buckets (
int
, optional, defaults to 32) — 用于每个注意力层的桶的数量。 - relative_attention_max_distance (
int
, optional, 默认为 128) — 用于桶分离的较长序列的最大距离。 - dropout_rate (
float
, optional, defaults to 0.1) — 所有 dropout 层的比率。 - layer_norm_eps (
float
, optional, defaults to 1e-6) — 层归一化层使用的epsilon值。 - router_z_loss_coef (
float
, optional, defaults to 0.001) — 总损失的z损失因子。 - router_aux_loss_coef (
float
, optional, defaults to 0.001) — 总损失的辅助损失因子。 - initializer_factor (
float
, 可选, 默认为 1.0) — 用于初始化所有权重矩阵的因子(应保持为1,内部用于初始化测试)。 - dense_act_fn (
string
, 可选, 默认为"relu"
) — 要使用的前馈层类型。应为"relu"
或"gated-gelu"
之一。SwitchTransformersv1.1 使用"gated-gelu"
前馈投影。原始 SwitchTransformers 使用"relu"
. - add_router_probs (
bool
, 可选, 默认为False
) — 是否输出路由器概率以计算路由器辅助损失。 - use_cache (
bool
, 可选, 默认为True
) — 模型是否应返回最后的键/值注意力(并非所有模型都使用)。
这是用于存储SwitchTransformersModel配置的配置类。它用于根据指定的参数实例化一个SwitchTransformers模型,定义模型架构。使用默认值实例化配置将产生类似于google/switch-base-8架构的SwitchTransformers配置。
配置对象继承自PretrainedConfig,可用于控制模型输出。阅读PretrainedConfig的文档以获取更多信息。
SwitchTransformersTop1Router
使用令牌的路由器选择前1位专家分配。
该路由器使用与Switch Transformer(https://arxiv.org/abs/2101.03961)和V-MoE(https://arxiv.org/abs/2106.05974)相同的机制:令牌选择其顶级专家。项目按router_probs排序,然后路由到他们选择的专家,直到达到专家的expert_capacity。不能保证每个令牌都由专家处理,也不能保证每个专家至少接收一个令牌。
_compute_router_probabilities
< source >( hidden_states: Tensor ) → 路由概率 (torch.Tensor
)
参数
- hidden_states (
torch.Tensor
) — (batch_size, sequence_length, hidden_dim) 从中计算路由器概率。
返回
路由器概率 (torch.Tensor
)
形状为 (batch_size, sequence_length, num_experts) 的张量,对应于每个标记和专家的概率。用于将标记路由到专家。
router_logits (torch.Tensor
):
形状为 (batch_size, sequence_length, num_experts) 的 logits 张量,对应于原始路由器 logits。
这稍后用于计算路由器 z-loss。
从输入的隐藏状态计算路由器概率。
前进
< source >( hidden_states: Tensor )
参数
- hidden_states (
torch.Tensor
) — [num_groups, tokens_per_group, hidden_dim] 输入发送给专家的数据.
每个Router类的通用前向函数。每个Router期望具有相同的输入隐藏状态
(hidden_states
) 对应于每个标记的隐藏状态,expert_capacity
对应于
Router将发送给每个专家的标记数量,一些Router可以发送少量标记给每个专家。
每个路由器的工作方式如下:它期望每个标记的隐藏状态,从router_weights
中获取router_probs
和router_logits
。这将为每个标记分配原始概率,以分配给专家。然后每个路由器类必须定义自己的_compute_routing_instructions
。
SwitchTransformersSparseMLP
类 transformers.SwitchTransformersSparseMLP
< source >( config: SwitchTransformersConfig expert_class: Module =
Switch Transformers 稀疏 MLP 模块的实现。
稍等,这可能会有点难以理解。按照正确的顺序,MoE层会执行以下操作:
1- 从路由器获取router_mask
。掩码的形状为(batch_size, sequence_length, num_expert)
,并且对应于router_probs
的argmax。在计算隐藏状态时需要这些概率:它们被广播到隐藏状态值(可以解释为缩放因子)。
2- 将令牌分派给其关联的专家。我们对专家进行经典的循环,并为每个专家分配相应的隐藏状态。
SwitchTransformersModel
类 transformers.SwitchTransformersModel
< source >( config: SwitchTransformersConfig )
参数
- config (SwitchTransformersConfig) — 包含模型所有参数的模型配置类。 使用配置文件初始化不会加载与模型相关的权重,只会加载配置。查看 from_pretrained() 方法以加载模型权重。
裸的SWITCH_TRANSFORMERS模型变压器输出原始隐藏状态,没有任何特定的头部。
SWITCH_TRANSFORMERS模型由Switch Transformers: Scaling to Trillion Parameter Models with Simple and Efficient Sparsity中的William Fedus、Barret Zoph和Noam Shazeer提出。它是一个类似于T5的编码器-解码器模型,具有稀疏的前馈网络,代表专家混合(MoE)架构。
该模型继承自PreTrainedModel。请查看超类文档以了解库为其所有模型实现的通用方法(如下载或保存、调整输入嵌入的大小、修剪头部等)。
该模型也是一个PyTorch torch.nn.Module 子类。 将其作为常规的PyTorch模块使用,并参考PyTorch文档以获取与一般使用和行为相关的所有信息。
前进
< source >( input_ids: typing.Optional[torch.LongTensor] = None attention_mask: typing.Optional[torch.FloatTensor] = None decoder_input_ids: typing.Optional[torch.LongTensor] = None decoder_attention_mask: typing.Optional[torch.BoolTensor] = None head_mask: typing.Optional[torch.FloatTensor] = None decoder_head_mask: typing.Optional[torch.FloatTensor] = None cross_attn_head_mask: typing.Optional[torch.Tensor] = None encoder_outputs: typing.Optional[typing.Tuple[typing.Tuple[torch.FloatTensor]]] = None past_key_values: typing.Optional[typing.Tuple[typing.Tuple[torch.FloatTensor]]] = None inputs_embeds: typing.Optional[torch.Tensor] = None decoder_inputs_embeds: typing.Optional[torch.Tensor] = None use_cache: typing.Optional[bool] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None output_router_logits: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None cache_position: typing.Optional[torch.LongTensor] = None ) → transformers.modeling_outputs.Seq2SeqMoEModelOutput
或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensor
of shape(batch_size, sequence_length)
) — Indices of input sequence tokens in the vocabulary. SWITCH_TRANSFORMERS is a model with relative position embeddings so you should be able to pad the inputs on both the right and the left.可以使用AutoTokenizer获取索引。详情请参见PreTrainedTokenizer.encode()和 PreTrainedTokenizer.call()。
要了解更多关于如何为预训练准备
input_ids
的信息,请查看SWITCH_TRANSFORMERS Training. - attention_mask (
torch.FloatTensor
of shape(batch_size, sequence_length)
, optional) — Mask to avoid performing attention on padding token indices. Mask values selected in[0, 1]
:- 1 for tokens that are not masked,
- 0 for tokens that are masked.
- decoder_input_ids (
torch.LongTensor
of shape(batch_size, target_sequence_length)
, optional) — Indices of decoder input sequence tokens in the vocabulary.可以使用AutoTokenizer获取索引。详情请参见PreTrainedTokenizer.encode()和 PreTrainedTokenizer.call()。
SWITCH_TRANSFORMERS 使用
pad_token_id
作为decoder_input_ids
生成的起始标记。如果使用了past_key_values
,则可以选择只输入最后一个decoder_input_ids
(参见past_key_values
)。要了解更多关于如何为预训练准备
decoder_input_ids
的信息,请查看SWITCH_TRANSFORMERS Training. - decoder_attention_mask (
torch.BoolTensor
of shape(batch_size, target_sequence_length)
, optional) — 默认行为:生成一个忽略decoder_input_ids
中填充标记的张量。默认情况下也会使用因果掩码。 - head_mask (
torch.FloatTensor
形状为(num_heads,)
或(num_layers, num_heads)
, 可选) — 用于在编码器中屏蔽自注意力模块中选定的头部的掩码。掩码值在[0, 1]
中选择:- 1 表示头部未被屏蔽,
- 0 表示头部被屏蔽.
- decoder_head_mask (
torch.FloatTensor
形状为(num_heads,)
或(num_layers, num_heads)
, 可选) — 用于在解码器中屏蔽自注意力模块中选定的头部的掩码。掩码值在[0, 1]
中选择:- 1 表示头部 未被屏蔽,
- 0 表示头部 被屏蔽.
- cross_attn_head_mask (
torch.Tensor
形状为(num_heads,)
或(num_layers, num_heads)
, 可选) — 用于在解码器中取消选择交叉注意力模块的特定头部的掩码。掩码值在[0, 1]
中选择:- 1 表示头部 未被掩码,
- 0 表示头部 被掩码.
- encoder_outputs (
tuple(tuple(torch.FloatTensor)
, 可选) — 元组由 (last_hidden_state
,可选
: hidden_states,可选
: attentions) 组成last_hidden_state
的形状为(batch_size, sequence_length, hidden_size)
是编码器最后一层输出的隐藏状态序列。用于解码器的交叉注意力中。 - past_key_values (
tuple(tuple(torch.FloatTensor))
of lengthconfig.n_layers
with each tuple having 4 tensors of shape(batch_size, num_heads, sequence_length - 1, embed_size_per_head)
) — Contains precomputed key and value hidden states of the attention blocks. Can be used to speed up decoding.如果使用了
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
索引转换为相关向量有更多控制,而不是使用模型的内部嵌入查找矩阵,这将非常有用。 - decoder_inputs_embeds (
torch.FloatTensor
of shape(batch_size, target_sequence_length, hidden_size)
, optional) — Optionally, instead of passingdecoder_input_ids
you can choose to directly pass an embedded representation. Ifpast_key_values
is used, optionally only the lastdecoder_inputs_embeds
have to be input (seepast_key_values
). This is useful if you want more control over how to convertdecoder_input_ids
indices into associated vectors than the model’s internal embedding lookup matrix.如果
decoder_input_ids
和decoder_inputs_embeds
都未设置,decoder_inputs_embeds
将取inputs_embeds
的值。 - use_cache (
bool
, 可选) — 如果设置为True
,past_key_values
键值状态将被返回,并可用于加速解码(参见past_key_values
)。 - output_attentions (
bool
, 可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息,请参见返回张量下的attentions
。 - output_hidden_states (
bool
, 可选) — 是否返回所有层的隐藏状态。有关更多详细信息,请参见返回张量下的hidden_states
。 - output_router_logits (
bool
, optional) — 是否返回所有路由器的logits。它们对于计算路由器损失非常有用,并且在推理期间不应返回。 - return_dict (
bool
, 可选) — 是否返回一个 ModelOutput 而不是一个普通的元组。 - cache_position (
torch.LongTensor
of shape(sequence_length)
, optional) — 表示输入序列标记在序列中的位置的索引。它用于在正确的位置更新缓存并推断完整的序列长度。
返回
transformers.modeling_outputs.Seq2SeqMoEModelOutput
或 tuple(torch.FloatTensor)
一个 transformers.modeling_outputs.Seq2SeqMoEModelOutput
或一个由 torch.FloatTensor
组成的元组(如果传递了 return_dict=False
或当 config.return_dict=False
时),包含根据配置(SwitchTransformersConfig)和输入的各种元素。
-
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=True
或当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
输入)加速顺序解码。 -
decoder_hidden_states (
tuple(torch.FloatTensor)
, 可选, 当传递了output_hidden_states=True
或当config.output_hidden_states=True
时返回) — 由torch.FloatTensor
组成的元组(一个用于嵌入层的输出,如果模型有嵌入层,+ 一个用于每层的输出),形状为(batch_size, sequence_length, hidden_size)
。解码器每层输出的隐藏状态加上可选的初始嵌入输出。
-
decoder_attentions (
tuple(torch.FloatTensor)
, 可选, 当传递了output_attentions=True
或当config.output_attentions=True
时返回) — 由torch.FloatTensor
组成的元组(每层一个),形状为(batch_size, num_heads, sequence_length, sequence_length)
。解码器的注意力权重,在注意力 softmax 之后,用于计算自注意力头中的加权平均值。
-
decoder_router_logits (
tuple(torch.FloatTensor)
, 可选, 当传递了output_router_logits=True
或当config.add_router_probs=True
时返回) — 由torch.FloatTensor
组成的元组(每层一个),形状为(batch_size, sequence_length, num_experts)
。解码器模型的路由 logits,用于计算专家混合模型的辅助损失。
-
cross_attentions (
tuple(torch.FloatTensor)
, 可选, 当传递了output_attentions=True
或当config.output_attentions=True
时返回) — 由torch.FloatTensor
组成的元组(每层一个),形状为(batch_size, num_heads, sequence_length, sequence_length)
。解码器交叉注意力层的注意力权重,在注意力 softmax 之后,用于计算交叉注意力头中的加权平均值。
-
encoder_last_hidden_state (
torch.FloatTensor
形状为(batch_size, sequence_length, hidden_size)
, 可选) — 模型编码器最后一层输出的隐藏状态序列。 -
encoder_hidden_states (
tuple(torch.FloatTensor)
, 可选, 当传递了output_hidden_states=True
或当config.output_hidden_states=True
时返回) — 由torch.FloatTensor
组成的元组(一个用于嵌入层的输出,如果模型有嵌入层,+ 一个用于每层的输出),形状为(batch_size, sequence_length, hidden_size)
。编码器每层输出的隐藏状态加上可选的初始嵌入输出。
-
encoder_attentions (
tuple(torch.FloatTensor)
, 可选, 当传递了output_attentions=True
或当config.output_attentions=True
时返回) — 由torch.FloatTensor
组成的元组(每层一个),形状为(batch_size, num_heads, sequence_length, sequence_length)
。编码器的注意力权重,在注意力 softmax 之后,用于计算自注意力头中的加权平均值。
-
encoder_router_logits (
tuple(torch.FloatTensor)
, 可选, 当传递了output_router_logits=True
或当config.add_router_probs=True
时返回) — 由torch.FloatTensor
组成的元组(每层一个),形状为(batch_size, sequence_length, num_experts)
。编码器模型的路由 logits,用于计算稀疏模块的辅助损失和 z_loss。
SwitchTransformersModel 的 forward 方法,重写了 __call__
特殊方法。
尽管前向传递的配方需要在此函数内定义,但之后应该调用Module
实例而不是这个,因为前者负责运行预处理和后处理步骤,而后者会默默地忽略它们。
示例:
>>> from transformers import AutoTokenizer, SwitchTransformersModel
>>> tokenizer = AutoTokenizer.from_pretrained("google/switch-base-8")
>>> model = SwitchTransformersModel.from_pretrained("google/switch-base-8")
>>> input_ids = tokenizer(
... "Studies have been shown that owning a dog is good for you", return_tensors="pt"
... ).input_ids # Batch size 1
>>> decoder_input_ids = tokenizer("Studies show that", return_tensors="pt").input_ids # Batch size 1
>>> # preprocess: Prepend decoder_input_ids with start token which is pad token for SwitchTransformersModel.
>>> # This is not needed for torch's SwitchTransformersForConditionalGeneration as it does this internally using labels arg.
>>> decoder_input_ids = model._shift_right(decoder_input_ids)
>>> # forward pass
>>> outputs = model(input_ids=input_ids, decoder_input_ids=decoder_input_ids)
>>> last_hidden_states = outputs.last_hidden_state
SwitchTransformersForConditionalGeneration
类 transformers.SwitchTransformersForConditionalGeneration
< source >( config: SwitchTransformersConfig )
参数
- config (SwitchTransformersConfig) — 包含模型所有参数的模型配置类。 使用配置文件初始化不会加载与模型相关的权重,只会加载配置。查看 from_pretrained() 方法以加载模型权重。
SWITCH_TRANSFORMERS 模型,顶部带有language modeling
头。
SWITCH_TRANSFORMERS模型由Switch Transformers: Scaling to Trillion Parameter Models with Simple and Efficient Sparsity中的William Fedus、Barret Zoph和Noam Shazeer提出。它是一个类似于T5的编码器-解码器模型,具有稀疏的前馈网络,代表专家混合(MoE)架构。
该模型继承自PreTrainedModel。请查看超类文档以了解库为其所有模型实现的通用方法(如下载或保存、调整输入嵌入的大小、修剪头部等)。
该模型也是一个PyTorch torch.nn.Module 子类。 将其作为常规的PyTorch模块使用,并参考PyTorch文档以获取与一般使用和行为相关的所有信息。
前进
< source >( input_ids: typing.Optional[torch.LongTensor] = None attention_mask: typing.Optional[torch.FloatTensor] = None decoder_input_ids: typing.Optional[torch.LongTensor] = None decoder_attention_mask: typing.Optional[torch.BoolTensor] = None head_mask: typing.Optional[torch.FloatTensor] = None decoder_head_mask: typing.Optional[torch.FloatTensor] = None cross_attn_head_mask: typing.Optional[torch.Tensor] = None encoder_outputs: typing.Optional[typing.Tuple[typing.Tuple[torch.Tensor]]] = None past_key_values: typing.Optional[typing.Tuple[typing.Tuple[torch.Tensor]]] = None inputs_embeds: typing.Optional[torch.FloatTensor] = None decoder_inputs_embeds: typing.Optional[torch.FloatTensor] = None labels: typing.Optional[torch.LongTensor] = None use_cache: typing.Optional[bool] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None output_router_logits: typing.Optional[bool] = True return_dict: typing.Optional[bool] = None cache_position: typing.Optional[torch.LongTensor] = None ) → transformers.modeling_outputs.Seq2SeqMoEOutput
或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensor
of shape(batch_size, sequence_length)
) — Indices of input sequence tokens in the vocabulary. SWITCH_TRANSFORMERS is a model with relative position embeddings so you should be able to pad the inputs on both the right and the left.可以使用AutoTokenizer获取索引。详情请参见PreTrainedTokenizer.encode()和 PreTrainedTokenizer.call()。
要了解更多关于如何为预训练准备
input_ids
的信息,请查看SWITCH_TRANSFORMERS Training. - attention_mask (
torch.FloatTensor
of shape(batch_size, sequence_length)
, optional) — Mask to avoid performing attention on padding token indices. Mask values selected in[0, 1]
:- 1 for tokens that are not masked,
- 0 for tokens that are masked.
- decoder_input_ids (
torch.LongTensor
of shape(batch_size, target_sequence_length)
, optional) — Indices of decoder input sequence tokens in the vocabulary.可以使用AutoTokenizer获取索引。详情请参见PreTrainedTokenizer.encode()和 PreTrainedTokenizer.call()。
SWITCH_TRANSFORMERS 使用
pad_token_id
作为decoder_input_ids
生成的起始标记。如果使用了past_key_values
,则可以选择只输入最后一个decoder_input_ids
(参见past_key_values
)。要了解更多关于如何为预训练准备
decoder_input_ids
的信息,请查看SWITCH_TRANSFORMERS Training. - decoder_attention_mask (
torch.BoolTensor
of shape(batch_size, target_sequence_length)
, optional) — 默认行为:生成一个忽略decoder_input_ids
中填充标记的张量。默认情况下也会使用因果掩码。 - head_mask (
torch.FloatTensor
形状为(num_heads,)
或(num_layers, num_heads)
, 可选) — 用于在编码器中屏蔽自注意力模块中选定的头。屏蔽值在[0, 1]
中选择:- 1 表示头 未被屏蔽,
- 0 表示头 被屏蔽.
- decoder_head_mask (
torch.FloatTensor
形状为(num_heads,)
或(num_layers, num_heads)
, 可选) — 用于在解码器中屏蔽自注意力模块中选定的头部的掩码。掩码值在[0, 1]
中选择:- 1 表示头部 未被屏蔽,
- 0 表示头部 被屏蔽.
- cross_attn_head_mask (
torch.Tensor
of shape(num_heads,)
or(num_layers, num_heads)
, optional) — 用于在解码器中取消选择交叉注意力模块中特定头部的掩码。掩码值在[0, 1]
中选择:- 1 表示头部未被掩码,
- 0 表示头部被掩码.
- encoder_outputs (
tuple(tuple(torch.FloatTensor)
, optional) — 元组由 (last_hidden_state
,optional
: hidden_states,optional
: attentions) 组成last_hidden_state
的形状为(batch_size, sequence_length, hidden_size)
是编码器最后一层输出的隐藏状态序列。用于解码器的交叉注意力中。 - past_key_values (
tuple(tuple(torch.FloatTensor))
of lengthconfig.n_layers
with each tuple having 4 tensors of shape(batch_size, num_heads, sequence_length - 1, embed_size_per_head)
) — Contains precomputed key and value hidden states of the attention blocks. Can be used to speed up decoding.如果使用了
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
索引转换为相关向量有更多控制,而不是使用模型的内部嵌入查找矩阵,这将非常有用。 - decoder_inputs_embeds (
torch.FloatTensor
of shape(batch_size, target_sequence_length, hidden_size)
, optional) — Optionally, instead of passingdecoder_input_ids
you can choose to directly pass an embedded representation. Ifpast_key_values
is used, optionally only the lastdecoder_inputs_embeds
have to be input (seepast_key_values
). This is useful if you want more control over how to convertdecoder_input_ids
indices into associated vectors than the model’s internal embedding lookup matrix.如果
decoder_input_ids
和decoder_inputs_embeds
都未设置,decoder_inputs_embeds
将取inputs_embeds
的值。 - use_cache (
bool
, 可选) — 如果设置为True
,past_key_values
键值状态将被返回,并可用于加速解码(参见past_key_values
)。 - output_attentions (
bool
, 可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息,请参见返回张量下的attentions
。 - output_hidden_states (
bool
, optional) — 是否返回所有层的隐藏状态。有关更多详细信息,请参见返回张量下的hidden_states
。 - output_router_logits (
bool
, optional) — 是否返回所有路由器的logits。它们对于计算路由器损失非常有用,并且在推理期间不应返回。 - return_dict (
bool
, 可选) — 是否返回一个ModelOutput而不是一个普通的元组。 - cache_position (
torch.LongTensor
of shape(sequence_length)
, optional) — 表示输入序列标记在序列中的位置的索引。它用于在正确的位置更新缓存并推断完整的序列长度。 - labels (
torch.LongTensor
of shape(batch_size,)
, optional) — 用于计算序列分类/回归损失的标签。索引应在[-100, 0, ..., config.vocab_size - 1]
范围内。所有设置为-100
的标签将被忽略(掩码),损失仅计算在[0, ..., config.vocab_size]
范围内的标签
返回
transformers.modeling_outputs.Seq2SeqMoEOutput
或 tuple(torch.FloatTensor)
一个 transformers.modeling_outputs.Seq2SeqMoEOutput
或一个由 torch.FloatTensor
组成的元组(如果传递了 return_dict=False
或当 config.return_dict=False
时),包含各种元素,具体取决于配置(SwitchTransformersConfig)和输入。
-
loss (
torch.FloatTensor
形状为(1,)
,可选,当提供labels
时返回) — 语言建模损失。 -
logits (
torch.FloatTensor
形状为(batch_size, sequence_length, config.vocab_size)
) — 语言建模头的预测分数(SoftMax 之前的每个词汇标记的分数)。 -
past_key_values (
tuple(tuple(torch.FloatTensor))
,可选,当传递use_cache=True
或当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
输入)加速顺序解码。 -
decoder_hidden_states (
tuple(torch.FloatTensor)
,可选,当传递output_hidden_states=True
或当config.output_hidden_states=True
时返回) — 由torch.FloatTensor
组成的元组(一个用于嵌入层的输出,如果模型有嵌入层,+ 一个用于每层的输出),形状为(batch_size, sequence_length, hidden_size)
。解码器在每层输出处的隐藏状态加上初始嵌入输出。
-
decoder_attentions (
tuple(torch.FloatTensor)
,可选,当传递output_attentions=True
或当config.output_attentions=True
时返回) — 由torch.FloatTensor
组成的元组(每层一个),形状为(batch_size, num_heads, sequence_length, sequence_length)
。解码器的注意力权重,在注意力 softmax 之后,用于计算自注意力头中的加权平均值。
-
decoder_router_logits (
tuple(torch.FloatTensor)
,可选,当传递output_router_logits=True
或当config.add_router_probs=True
时返回) — 由torch.FloatTensor
组成的元组(每层一个),形状为(batch_size, sequence_length, num_experts)
。解码器模型的路由 logits,用于计算专家混合模型的辅助损失。
-
cross_attentions (
tuple(torch.FloatTensor)
,可选,当传递output_attentions=True
或当config.output_attentions=True
时返回) — 由torch.FloatTensor
组成的元组(每层一个),形状为(batch_size, num_heads, sequence_length, sequence_length)
。解码器交叉注意力层的注意力权重,在注意力 softmax 之后,用于计算交叉注意力头中的加权平均值。
-
encoder_last_hidden_state (
torch.FloatTensor
形状为(batch_size, sequence_length, hidden_size)
,可选) — 模型编码器最后一层输出的隐藏状态序列。 -
encoder_hidden_states (
tuple(torch.FloatTensor)
,可选,当传递output_hidden_states=True
或当config.output_hidden_states=True
时返回) — 由torch.FloatTensor
组成的元组(一个用于嵌入层的输出,如果模型有嵌入层,+ 一个用于每层的输出),形状为(batch_size, sequence_length, hidden_size)
。编码器在每层输出处的隐藏状态加上初始嵌入输出。
-
encoder_attentions (
tuple(torch.FloatTensor)
,可选,当传递output_attentions=True
或当config.output_attentions=True
时返回) — 由torch.FloatTensor
组成的元组(每层一个),形状为(batch_size, num_heads, sequence_length, sequence_length)
。编码器的注意力权重,在注意力 softmax 之后,用于计算自注意力头中的加权平均值。
-
encoder_router_logits (
tuple(torch.FloatTensor)
,可选,当传递output_router_logits=True
或当config.add_router_probs=True
时返回) — 由torch.FloatTensor
组成的元组(每层一个),形状为(batch_size, sequence_length, num_experts)
。编码器模型的路由 logits,用于计算专家混合模型的辅助损失和 z_loss。
SwitchTransformersForConditionalGeneration 的前向方法,重写了 __call__
特殊方法。
尽管前向传递的配方需要在此函数内定义,但之后应该调用Module
实例而不是这个,因为前者负责运行预处理和后处理步骤,而后者会默默地忽略它们。
示例:
>>> from transformers import AutoTokenizer, SwitchTransformersForConditionalGeneration
>>> tokenizer = AutoTokenizer.from_pretrained("google/switch-base-8")
>>> model = SwitchTransformersForConditionalGeneration.from_pretrained("google/switch-base-8")
>>> # training
>>> input_ids = tokenizer("The <extra_id_0> walks in <extra_id_1> park", return_tensors="pt").input_ids
>>> labels = tokenizer("<extra_id_0> cute dog <extra_id_1> the <extra_id_2>", return_tensors="pt").input_ids
>>> outputs = model(input_ids=input_ids, labels=labels)
>>> loss = outputs.loss
>>> logits = outputs.logits
>>> # inference
>>> input_ids = tokenizer(
... "summarize: studies have shown that owning a dog is good for you", return_tensors="pt"
... ).input_ids # Batch size 1
>>> outputs = model.generate(input_ids)
>>> # . To, let’s say you have a dog. To summarize:
>>> # Since the model has been trained on MLM, this will output gibberish
SwitchTransformersEncoderModel
类 transformers.SwitchTransformersEncoderModel
< source >( config: SwitchTransformersConfig )
参数
- config (SwitchTransformersConfig) — 包含模型所有参数的模型配置类。 使用配置文件初始化不会加载与模型相关的权重,只会加载配置。查看 from_pretrained() 方法以加载模型权重。
裸的SWITCH_TRANSFORMERS模型变压器输出编码器的原始隐藏状态,没有任何特定的头部。
SWITCH_TRANSFORMERS模型由Switch Transformers: Scaling to Trillion Parameter Models with Simple and Efficient Sparsity中的William Fedus、Barret Zoph和Noam Shazeer提出。它是一个类似于T5的编码器-解码器模型,具有稀疏的前馈网络,代表专家混合(MoE)架构。
该模型继承自PreTrainedModel。请查看超类文档以了解库为其所有模型实现的通用方法(如下载或保存、调整输入嵌入的大小、修剪头部等)。
该模型也是一个PyTorch torch.nn.Module 子类。 将其作为常规的PyTorch模块使用,并参考PyTorch文档以获取与一般使用和行为相关的所有信息。
前进
< source >( input_ids: typing.Optional[torch.LongTensor] = None attention_mask: typing.Optional[torch.FloatTensor] = None head_mask: typing.Optional[torch.FloatTensor] = None inputs_embeds: typing.Optional[torch.FloatTensor] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None output_router_logits: typing.Optional[bool] = True return_dict: typing.Optional[bool] = None ) → transformers.modeling_outputs.MoEModelOutput
或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensor
of shape(batch_size, sequence_length)
) — Indices of input sequence tokens in the vocabulary. SWITCH_TRANSFORMERS is a model with relative position embeddings so you should be able to pad the inputs on both the right and the left.可以使用AutoTokenizer获取索引。详情请参见PreTrainedTokenizer.encode()和 PreTrainedTokenizer.call()。
要了解更多关于如何为预训练准备
input_ids
的信息,请查看SWITCH_TRANSFORMERS Training. - attention_mask (
torch.FloatTensor
of shape(batch_size, sequence_length)
, optional) — Mask to avoid performing attention on padding token indices. Mask values selected in[0, 1]
:- 1 for tokens that are not masked,
- 0 for tokens that are masked.
- head_mask (
torch.FloatTensor
形状为(num_heads,)
或(num_layers, num_heads)
, 可选) — 用于屏蔽自注意力模块中选定的头部的掩码。掩码值在[0, 1]
中选择:- 1 表示头部 未被屏蔽,
- 0 表示头部 被屏蔽.
- inputs_embeds (
torch.FloatTensor
of shape(batch_size, sequence_length, hidden_size)
, optional) — 可选地,您可以选择直接传递嵌入表示,而不是传递input_ids
。如果您希望对如何将input_ids
索引转换为相关向量有更多控制,而不是使用模型的内部嵌入查找矩阵,这将非常有用。 - output_attentions (
bool
, 可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息,请参见返回张量下的attentions
。 - output_hidden_states (
bool
, optional) — 是否返回所有层的隐藏状态。有关更多详细信息,请参见返回张量下的hidden_states
。 - output_router_logits (
bool
, optional) — 是否返回所有路由器的logits。它们对于计算路由器损失非常有用,并且在推理期间不应返回。 - return_dict (
bool
, 可选) — 是否返回一个ModelOutput而不是一个普通的元组。
返回
transformers.modeling_outputs.MoEModelOutput
或 tuple(torch.FloatTensor)
一个 transformers.modeling_outputs.MoEModelOutput
或一个由 torch.FloatTensor
组成的元组(如果传递了 return_dict=False
或当 config.return_dict=False
时),包含各种元素,具体取决于配置(SwitchTransformersConfig)和输入。
-
last_hidden_state (
torch.FloatTensor
,形状为(batch_size, sequence_length, hidden_size)
) — 模型最后一层的输出的隐藏状态序列。 -
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 后的注意力权重,用于计算自注意力头中的加权平均值。
-
router_probs (
tuple(torch.FloatTensor)
,可选,当传递了output_router_probs=True
和config.add_router_probs=True
或当config.output_router_probs=True
时返回) — 由torch.FloatTensor
组成的元组(每一层一个),形状为(batch_size, sequence_length, num_experts)
。由 MoE 路由器计算的原始路由器概率,这些项用于计算专家混合模型的辅助损失和 z_loss。
SwitchTransformersEncoderModel 的前向方法,重写了 __call__
特殊方法。
尽管前向传递的配方需要在此函数内定义,但之后应该调用Module
实例而不是这个,因为前者负责运行预处理和后处理步骤,而后者会默默地忽略它们。
示例:
>>> from transformers import AutoTokenizer, SwitchTransformersEncoderModel
>>> tokenizer = AutoTokenizer.from_pretrained("google/switch-base-8")
>>> model = SwitchTransformersEncoderModel.from_pretrained("google/switch-base-8")
>>> input_ids = tokenizer(
... "Studies have been shown that owning a dog is good for you", return_tensors="pt"
... ).input_ids # Batch size 1
>>> outputs = model(input_ids=input_ids)
>>> last_hidden_states = outputs.last_hidden_state