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 transformers 比其等效的密集模型具有更多的权重，但稀疏性允许更好的扩展性和更好的规模化微调性能。在正向传递期间，只使用一小部分权重。路由机制允许模型动态选择相关权重，从而提高模型容量，而不会增加操作数量。
论文中的摘要如下：
在深度学习中，模型通常对所有输入重用相同的参数。混合专家 (MoE) 挑战了这一点，而是为每个传入示例选择不同的参数。结果是一个稀疏激活的模型——具有惊人的参数数量——但计算成本恒定。然而，尽管 MoE 取得了一些显著的成功，但其广泛应用却受到复杂性、通信成本和训练不稳定的阻碍——我们通过 Switch Transformer 解决这些问题。我们简化了 MoE 路由算法，并设计了具有直观改进的模型，以降低通信和计算成本。我们提出的训练技术有助于控制不稳定性，我们展示了大型稀疏模型可以首次使用较低精度 (bfloat16) 格式进行训练。我们基于 T5-Base 和 T5-Large 设计模型，以获得在相同计算资源下高达 7 倍的预训练速度提升。这些改进扩展到多语言设置，在所有 101 种语言中我们都衡量了对 mT5-Base 版本的增益。最后，我们通过在“庞大的干净爬取语料库”上预训练高达万亿参数的模型来推动当前语言模型的规模，并在 T5-XXL 模型的基础上实现 4 倍的速度提升。
该模型由 Younes Belkada 和 Arthur Zucker 贡献。原始代码可在 此处 找到。
使用技巧
- SwitchTransformers 使用 T5Tokenizer，可以直接从每个模型的仓库中加载。
- 发布的权重是在英语 掩码语言建模 任务上预训练的，应该进行微调。
资源
SwitchTransformersConfig
class 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, 可选, 默认值为 32128) — SwitchTransformers 模型的词汇量大小。 定义了调用 SwitchTransformersModel 时传递的inputs_ids可以表示的不同标记数量。 - d_model (
int, 可选, 默认值为 768) — 编码器层和池化层的尺寸。 - d_kv (
int, 可选, 默认值为 64) — 每个注意力头的键、查询、值投影的大小。d_kv必须等于d_model // num_heads。 - d_ff (
int, 可选, 默认值为 2048) — 每个SwitchTransformersBlock中的中间前馈层的尺寸。 - expert_capacity (
int, 可选, 默认值为 64) — 每个专家可以存储的标记数量。 如果设置为 1，模型将表现得像一个普通的 Transformer。 - num_layers (
int, 可选, 默认值为 12) — Transformer 编码器层中的密集隐藏层的数量。 - num_sparse_encoder_layers (
int, 可选, 默认值为 3) — Transformer 编码器层中的稀疏 (MoE) 密集隐藏层的数量。 - num_decoder_layers (
int, 可选, 默认值为 12) — Transformer 解码器中的隐藏层的数量。 如果未设置，将使用与num_layers相同的值。 - num_sparse_decoder_layers (
int, 可选, 默认值为 3) — Transformer 解码器层中的稀疏 (MoE) 密集隐藏层的数量。 - num_heads (
int, 可选, 默认值为 12) — Transformer 编码器中每个注意力层的注意力头的数量。 - router_jitter_noise (
float, 可选, 默认为 0.01) — 添加到路由器的噪声量。 - router_dtype (
str, 可选, 默认为"float32") — 路由器使用的dtype。 优先使用"float32"作为dtype，正如 论文 中选择性精度部分所述。 - router_ignore_padding_tokens (
bool, 可选, 默认为False) — 路由时是否忽略填充 token。 - relative_attention_num_buckets (
int, 可选, 默认为 32) — 每个注意力层的桶数。 - relative_attention_max_distance (
int, 可选, 默认为 128) — 用于桶分隔的更长序列的最大距离。 - dropout_rate (
float, 可选, 默认为 0.1) — 所有 dropout 层的比例。 - layer_norm_eps (
float, 可选, 默认为 1e-6) — 层归一化层使用的 epsilon。 - router_z_loss_coef (
float, 可选, 默认为 0.001) — 总损失的 z 损失因子。 - router_aux_loss_coef (
float, 可选, 默认为 0.001) — 总损失的辅助损失因子。 - add_router_probs (
bool, 可选, 默认值为False) — 是否输出路由器概率以计算路由器辅助损失。 - use_cache (
bool, 可选, 默认值为True) — 模型是否应返回最后一个键/值注意力（并非所有模型都使用）。
这是一个配置类，用于存储 SwitchTransformersModel 的配置。它用于根据指定的参数实例化 SwitchTransformers 模型，定义模型架构。使用默认值实例化配置将生成与 SwitchTransformers google/switch-base-8 架构类似的配置。
配置对象继承自 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
< 源代码 >( hidden_states: Tensor ) → router_probabilities (torch.Tensor)
参数
- hidden_states (
torch.Tensor) — (batch_size, sequence_length, hidden_dim) 用于计算路由器概率。
返回值
router_probabilities (torch.Tensor)
形状为 (batch_size, sequence_length, num_experts) 的张量，对应于每个令牌和专家的概率。用于将令牌路由到专家。router_logits (torch.Tensor): 形状为 (batch_size, sequence_length, num_experts) 的 logits 张量，对应于原始路由器 logits。这将在以后用于计算路由器 z 损失。
从输入隐藏状态计算路由器概率。
forward
< 源代码 >( hidden_states: Tensor )
参数
- hidden_states (
torch.Tensor) — [num_groups, tokens_per_group, hidden_dim] 发送给专家的输入。
每个路由器类的通用前向函数。每个路由器都希望具有相同的输入隐藏状态 (hidden_states)，对应于每个令牌的隐藏状态，expert_capacity 对应于路由器将发送到每个专家的令牌数量，一些路由器可以最多将少量令牌发送到每个专家。
每个路由器的工作原理如下：它希望获得每个令牌的隐藏状态，从 router_weights 获取 router_probs 和 router_logits。这将为每个令牌分配一个被分配到专家的原始概率。然后每个路由器类都必须定义自己的 _compute_routing_instructions。
SwitchTransformersSparseMLP
class transformers.SwitchTransformersSparseMLP
< source >( config: SwitchTransformersConfig expert_class: Module = <class 'transformers.models.switch_transformers.modeling_switch_transformers.SwitchTransformersDenseActDense'> )
Switch Transformers Sparse MLP 模块的实现。
等等，这有点难理解。按照正确的顺序，MoE 层执行以下操作：
1- 从路由器获取 router_mask。掩码的形状为 (batch_size, sequence_length, num_expert)，对应于 router_probs 的 argmax。在计算隐藏状态时需要概率：它们被广播到隐藏状态值（可以解释为缩放因子）。
2- 将标记分配到其关联的专家。我们对专家进行经典的 for 循环，并为每个专家分配相应的隐藏状态。
SwitchTransformersModel
class 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 文档了解所有与一般用法和行为相关的事项。
forward
< source >( input_ids: Optional = None attention_mask: Optional = None decoder_input_ids: Optional = None decoder_attention_mask: Optional = None head_mask: Optional = None decoder_head_mask: Optional = None cross_attn_head_mask: Optional = None encoder_outputs: Optional = None past_key_values: Optional = None inputs_embeds: Optional = None decoder_inputs_embeds: Optional = None use_cache: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None output_router_logits: Optional = None return_dict: Optional = None ) → transformers.modeling_outputs.Seq2SeqMoEModelOutput or tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensor形状为(batch_size, sequence_length)) — 词汇表中输入序列标记的索引。SWITCH_TRANSFORMERS 是一个使用相对位置嵌入的模型，因此您应该能够在左右两侧填充输入。可以使用 AutoTokenizer 获取索引。有关详细信息，请参见 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
要详细了解如何为预训练准备
input_ids，请查看 SWITCH_TRANSFORMERS 训练。 - attention_mask (
torch.FloatTensor形状为(batch_size, sequence_length)，可选) — 掩码，用于避免对填充标记索引执行注意力。在[0, 1]中选择掩码值：- 1 代表未被掩码的标记，
- 0 代表被掩码的标记。
- decoder_input_ids (
torch.LongTensor形状为(batch_size, target_sequence_length)，可选) — 词汇表中解码器输入序列标记的索引。可以使用 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 训练。 - decoder_attention_mask (
torch.BoolTensor形状为(batch_size, target_sequence_length)，可选) — 默认行为：生成一个忽略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))长度为config.n_layers，每个元组包含 4 个形状为(batch_size, num_heads, sequence_length - 1, embed_size_per_head)的张量) — 包含预先计算的注意力块的关键和值隐藏状态。可用于加速解码。如果使用
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), 可选) — 可选地，您可以选择直接传递嵌入表示，而不是传递input_ids。如果您希望对如何将input_ids索引转换为关联向量有更多控制权，而不是模型的内部嵌入查找矩阵，这将很有用。 - decoder_inputs_embeds (
torch.FloatTensor形状为(batch_size, target_sequence_length, hidden_size), 可选) — 可选地，您可以选择直接传递嵌入表示，而不是传递decoder_input_ids。如果使用past_key_values，可选地只需要输入最后的decoder_inputs_embeds（参见past_key_values）。如果您希望对如何将decoder_input_ids索引转换为关联向量有更多控制权，而不是模型的内部嵌入查找矩阵，这将很有用。如果
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, 可选) — 是否返回所有路由器的 logits。它们对于计算路由器损失很有用，在推理过程中不应返回。 - return_dict (
bool, 可选) — 是否返回一个 ModelOutput 而不是一个简单的元组。
返回值
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。
The SwitchTransformersModel 正向方法，覆盖了__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_stateSwitchTransformersForConditionalGeneration
class transformers.SwitchTransformersForConditionalGeneration
< 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 文档了解所有与一般用法和行为相关的事项。
forward
< source >( input_ids: Optional = None attention_mask: Optional = None decoder_input_ids: Optional = None decoder_attention_mask: Optional = None head_mask: Optional = None decoder_head_mask: Optional = None cross_attn_head_mask: Optional = None encoder_outputs: Optional = None past_key_values: Optional = None inputs_embeds: Optional = None decoder_inputs_embeds: Optional = None labels: Optional = None use_cache: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None output_router_logits: Optional = True return_dict: Optional = None ) → transformers.modeling_outputs.Seq2SeqMoEOutput or tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensor形状为(batch_size, sequence_length)) — 词汇表中输入序列标记的索引。SWITCH_TRANSFORMERS 是一个具有相对位置嵌入的模型，因此您应该能够在左右两侧填充输入。可以使用 AutoTokenizer 获取索引。有关详细信息，请参见 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
要详细了解如何为预训练准备
input_ids，请查看 SWITCH_TRANSFORMERS 训练。 - attention_mask (
torch.FloatTensor形状为(batch_size, sequence_length), 可选) — 掩码，用于避免对填充标记索引执行注意力。[0, 1]中选择的掩码值：- 1 表示未屏蔽的标记，
- 0 表示屏蔽的标记。
- decoder_input_ids (
torch.LongTensor形状为(batch_size, target_sequence_length), 可选) — 词汇表中解码器输入序列标记的索引。可以使用 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 训练。 - decoder_attention_mask (
torch.BoolTensor形状为(batch_size, target_sequence_length), 可选) — 默认行为：生成一个忽略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) 形状为(batch_size, sequence_length, hidden_size)的last_hidden_state是编码器最后一层输出处的隐藏状态序列。用于解码器的交叉注意力。 - past_key_values (
tuple(tuple(torch.FloatTensor))长度为config.n_layers，每个元组包含 4 个形状为(batch_size, num_heads, sequence_length - 1, embed_size_per_head)的张量) — 包含预先计算的注意力块的关键和值隐藏状态。可用于加速解码。如果使用
past_key_values，则用户可以选择仅输入形状为(batch_size, 1)的最后一个decoder_input_ids（那些没有向该模型提供其过去键值状态的），而不是所有形状为(batch_size, sequence_length)的decoder_input_ids。 - inputs_embeds (
torch.FloatTensor形状为(batch_size, sequence_length, hidden_size), 可选) — 可选地，您可以选择直接传递嵌入式表示，而不是传递input_ids。如果您希望对如何将input_ids索引转换为相关向量有更多控制权，而不是模型的内部嵌入查找矩阵，这将很有用。 - decoder_inputs_embeds (
torch.FloatTensor形状为(batch_size, target_sequence_length, hidden_size), 可选) — 可选地，您可以选择直接传递嵌入式表示，而不是传递decoder_input_ids。如果使用past_key_values，可选地只需要输入最后一个decoder_inputs_embeds(参见past_key_values)。如果您希望对如何将decoder_input_ids索引转换为相关向量有更多控制权，而不是模型的内部嵌入查找矩阵，这将很有用。如果
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, 可选) — 是否返回所有路由器的 logits。它们对于计算路由器损失很有用，在推理过程中不应该返回。 - return_dict (
bool, 可选) — 是否返回一个 ModelOutput，而不是一个普通的元组。 - labels (
torch.LongTensor形状为(batch_size,), 可选) — 用于计算序列分类/回归损失的标签。索引应在[-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。
The 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 gibberishSwitchTransformersEncoderModel
class transformers.SwitchTransformersEncoderModel
< 源代码 >( 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 文档了解所有与一般用法和行为相关的事项。
forward
< 源代码 >( input_ids: Optional = None attention_mask: Optional = None head_mask: Optional = None inputs_embeds: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None output_router_logits: Optional = True return_dict: Optional = None ) → transformers.modeling_outputs.MoEModelOutput 或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensor形状为(batch_size, sequence_length)) — 词汇表中输入序列标记的索引。SWITCH_TRANSFORMERS 是一个具有相对位置嵌入的模型，因此您应该能够在左右两侧填充输入。索引可以使用 AutoTokenizer 获得。查看 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call() 获取详细信息。
要了解有关如何为预训练准备
input_ids的更多信息，请查看 SWITCH_TRANSFORMERS 训练。 - attention_mask (
torch.FloatTensor形状为(batch_size, sequence_length), 可选) — 掩码，避免对填充标记索引执行注意力操作。掩码值选择在[0, 1]中：- 1 表示标记 **未被掩码**，
- 0 表示标记 **被掩码**。
- 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以了解更多详情。 - output_router_logits (
bool, 可选) — 是否返回所有路由器的 logits。这些 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 forward 方法，覆盖了 __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