Transformers 文档
SwitchTransformers
并获得增强的文档体验
开始使用
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）将每个 token 与其中一个专家关联起来，每个专家都是一个密集 MLP。虽然 Switch Transformer 比其等效的密集模型拥有更多的权重，但稀疏性允许在规模上实现更好的扩展和更好的微调性能。在前向传播期间，只使用一小部分权重。路由机制允许模型即时选择相关权重，从而在不增加操作数量的情况下增加模型容量。
论文摘要如下：
在深度学习中，模型通常对所有输入重用相同的参数。专家混合 (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
< 源 >( 词汇表大小 = 32128 d_model = 768 d_kv = 64 d_ff = 2048 专家容量 = 64 层数 = 12 稀疏编码器层数 = 3 解码器层数 = 12 稀疏解码器层数 = 3 头数 = 12 专家数 = 8 路由器偏差 = False 路由器抖动噪声 = 0.01 路由器数据类型 = 'float32' 路由器忽略填充标记 = False 相对注意力桶数 = 32 相对注意力最大距离 = 128 dropout_rate = 0.1 layer_norm_epsilon = 1e-06 router_z_loss_coef = 0.001 router_aux_loss_coef = 0.001 初始化因子 = 1.0 dense_act_fn = 'relu' is_encoder_decoder = True 添加路由器概率 = False 使用缓存 = 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) — 每个专家可以存储的 token 数量。如果设置为 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 编码器中每个注意力层的注意力头数。 - num_experts (
int, 可选, 默认为 8) — 每个 SwitchTransformer 层的专家数量。 - router_bias (
bool, 可选, 默认为False) — 是否为路由器添加偏差。 - router_jitter_noise (
float, 可选, 默认为 0.01) — 添加到路由器中的噪声量。 - router_dtype (
str, 可选, 默认为"float32") — 路由器使用的数据类型。根据论文中的“选择性精度”讨论，最好将数据类型保持为"float32"。 - router_ignore_padding_tokens (
bool, 可选, 默认为False) — 路由时是否忽略填充标记。 - 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) — 总损失的辅助损失因子。 - 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 模型，定义模型架构。使用默认值实例化配置将生成与 SwitchTransformers google/switch-base-8 架构类似的配置。
配置对象继承自 PretrainedConfig，可用于控制模型输出。有关更多信息，请阅读 PretrainedConfig 的文档。
SwitchTransformersTop1Router
使用 token 选择 top-1 专家分配的路由。
该路由器使用与 Switch Transformer (https://huggingface.co/papers/2101.03961) 和 V-MoE (https://huggingface.co/papers/2106.05974) 中相同的机制：token 选择它们的最佳专家。项目按 router_probs 排序，然后路由到它们选择的专家，直到达到专家的 expert_capacity。不保证每个 token 都由一个专家处理，也不保证每个专家至少接收一个 token。
_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) 的张量，对应每个 token 和专家的概率。用于将 token 路由到专家。router_logits (torch.Tensor): 形状为 (batch_size, sequence_length, num_experts) 的对数张量，对应原始路由器 logits。这在后面用于计算路由器 z-loss。
从输入隐藏状态计算路由器概率。
forward
< 来源 >( hidden_states: Tensor )
参数
- hidden_states (
torch.Tensor) — [num_groups, tokens_per_group, hidden_dim] 输入到专家。
每个路由器类的通用 forward 函数。每个路由器都期望具有相同的输入隐藏状态 (hidden_states)，对应于每个 token 的隐藏状态，expert_capacity 对应于路由器将发送到每个 token 的 token 数量，一些路由器可以向每个专家发送少量 token。
每个路由器的工作方式如下：它期望每个 token 的隐藏状态，从 router_weights 获取 router_probs 和 router_logits。这将为每个 token 分配分配给专家的原始概率。然后，每个路由器类必须定义自己的 _compute_routing_instructions。
SwitchTransformersSparseMLP
类 transformers.SwitchTransformersSparseMLP
< 来源 >( config: SwitchTransformersConfig expert_class: Module = <class 'transformers.models.switch_transformers.modeling_switch_transformers.SwitchTransformersDenseActDense'> )
Switch Transformers 稀疏 MLP 模块的实现。
请注意，这会有点难以理解。按照正确的顺序，MoE 层执行以下操作：
1- 从路由器获取 router_mask。掩码的形状为 (batch_size, sequence_length, num_expert)，对应于 router_probs 的 argmax。在隐藏状态的计算中需要这些概率：它们被广播到隐藏状态值（可以解释为缩放因子）。
2- 将 token 分派到其关联的专家。我们对专家进行经典的 for 循环，并为每个专家分配相应的隐藏状态。
SwitchTransformersModel
类 transformers.SwitchTransformersModel
< 来源 >( config: SwitchTransformersConfig )
参数
- config (SwitchTransformersConfig) — 包含模型所有参数的模型配置类。使用配置文件初始化不会加载与模型关联的权重，只会加载配置。要加载模型权重，请查看 from_pretrained() 方法。
裸的 Switch Transformers 模型，输出原始隐藏状态，没有顶部的任何特定头部。
此模型继承自 PreTrainedModel。有关库为其所有模型实现的通用方法（如下载或保存、调整输入嵌入大小、修剪头部等）的更多详细信息，请查看超类文档。
此模型也是 PyTorch torch.nn.Module 子类。将其作为常规 PyTorch 模块使用，并参考 PyTorch 文档了解所有与通用用法和行为相关的事项。
forward
< 来源 >( 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[tuple[tuple[torch.FloatTensor]]] = None past_key_values: typing.Optional[tuple[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 (形状为
(batch_size, sequence_length)的torch.LongTensor) — 词汇表中输入序列 token 的索引。SWITCH_TRANSFORMERS 是一个带有相对位置嵌入的模型，因此您应该能够在输入的右侧和左侧都进行填充。索引可以使用 AutoTokenizer 获取。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
要了解有关如何准备
input_ids以进行预训练的更多信息，请参阅 SWITCH_TRANSFORMERS 训练。 - attention_mask (形状为
(batch_size, sequence_length)的torch.FloatTensor, 可选) — 遮罩以避免在填充 token 索引上执行注意力。遮罩值在[0, 1]中选择：- 1 表示 token 未被遮罩，
- 0 表示 token 被遮罩。
- decoder_input_ids (形状为
(batch_size, target_sequence_length)的torch.LongTensor, 可选) — 词汇表中解码器输入序列 token 的索引。索引可以使用 AutoTokenizer 获取。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
SWITCH_TRANSFORMERS 使用
pad_token_id作为decoder_input_ids生成的起始 token。如果使用past_key_values，可以选择只输入最后一个decoder_input_ids（那些没有将其过去的键值状态提供给此模型的）（请参阅past_key_values）。要了解有关如何准备
decoder_input_ids以进行预训练的更多信息，请参阅 SWITCH_TRANSFORMERS 训练。 - decoder_attention_mask (形状为
(batch_size, target_sequence_length)的torch.BoolTensor, 可选) — 默认行为：生成一个忽略decoder_input_ids中填充 token 的张量。因果遮罩也将默认使用。 - head_mask (形状为
(num_heads,)或(num_layers, num_heads)的torch.FloatTensor, 可选) — 遮罩以使自注意力模块的选定头部无效。遮罩值在[0, 1]中选择：- 1 表示头部未被遮罩，
- 0 表示头部被遮罩。
- decoder_head_mask (形状为
(num_heads,)或(num_layers, num_heads)的torch.FloatTensor, 可选) — 遮罩以使解码器中自注意力模块的选定头部无效。遮罩值在[0, 1]中选择：- 1 表示头部未被遮罩，
- 0 表示头部被遮罩。
- cross_attn_head_mask (形状为
(num_heads,)或(num_layers, num_heads)的torch.Tensor, 可选) — 遮罩以使解码器中交叉注意力模块的选定头部无效。遮罩值在[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]], 可选) — 预先计算的隐藏状态（自注意力块和交叉注意力块中的键和值），可用于加速顺序解码。这通常包括模型在解码上一阶段返回的past_key_values，当use_cache=True或config.use_cache=True时。允许两种格式：
- Cache 实例，请参阅我们的 kv 缓存指南；
- 长度为
config.n_layers的tuple(torch.FloatTensor)元组，每个元组包含 2 个形状为(batch_size, num_heads, sequence_length, embed_size_per_head)的张量）。这也被称为旧版缓存格式。
模型将输出与输入相同的缓存格式。如果未传递
past_key_values，将返回旧版缓存格式。如果使用
past_key_values，用户可以选择只输入最后一个input_ids（那些没有将其过去的键值状态提供给此模型的），形状为(batch_size, 1)，而不是所有input_ids的形状(batch_size, sequence_length)。 - inputs_embeds (形状为
(batch_size, sequence_length, hidden_size)的torch.Tensor, 可选) — 可选地，您可以选择直接传递嵌入表示，而不是传递input_ids。如果您想对如何将input_ids索引转换为关联向量（而不是模型的内部嵌入查找矩阵）进行更多控制，这会很有用。 - decoder_inputs_embeds (形状为
(batch_size, target_sequence_length, hidden_size)的torch.Tensor, 可选) — 可选地，您可以选择直接传递嵌入表示，而不是传递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 而不是普通元组。 - cache_position (形状为
(sequence_length)的torch.LongTensor, 可选) — 描绘输入序列 token 在序列中位置的索引。与position_ids不同，此张量不受填充影响。它用于在正确位置更新缓存并推断完整的序列长度。
返回
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 (
EncoderDecoderCache, 可选, 当传递use_cache=True或当config.use_cache=True时返回) — 这是一个 EncoderDecoderCache 实例。有关更多详细信息，请参阅我们的 kv 缓存指南。包含预先计算的隐藏状态（自注意力块和交叉注意力块中的键和值），可用于（参见
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__ 特殊方法。
尽管 forward pass 的配方需要在此函数中定义，但此后应该调用 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
类 transformers.SwitchTransformersForConditionalGeneration
< 来源 >( config: SwitchTransformersConfig )
参数
- config (SwitchTransformersConfig) — 包含模型所有参数的模型配置类。使用配置文件初始化不会加载与模型关联的权重，只会加载配置。要加载模型权重，请查看 from_pretrained() 方法。
带有 语言建模 头部的 SWITCH_TRANSFORMERS 模型。
此模型继承自 PreTrainedModel。有关库为其所有模型实现的通用方法（如下载或保存、调整输入嵌入大小、修剪头部等）的更多详细信息，请查看超类文档。
此模型也是 PyTorch torch.nn.Module 子类。将其作为常规 PyTorch 模块使用，并参考 PyTorch 文档了解所有与通用用法和行为相关的事项。
forward
< 来源 >( 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[tuple[tuple[torch.Tensor]]] = None past_key_values: typing.Optional[tuple[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 (形状为
(batch_size, sequence_length)的torch.LongTensor) — 词汇表中输入序列 token 的索引。SWITCH_TRANSFORMERS 是一个带有相对位置嵌入的模型，因此您应该能够在输入的右侧和左侧都进行填充。索引可以使用 AutoTokenizer 获取。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
要了解有关如何准备
input_ids以进行预训练的更多信息，请参阅 SWITCH_TRANSFORMERS 训练。 - attention_mask (形状为
(batch_size, sequence_length)的torch.FloatTensor, 可选) — 遮罩以避免在填充 token 索引上执行注意力。遮罩值在[0, 1]中选择：- 1 表示 token 未被遮罩，
- 0 表示 token 被遮罩。
- 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.Tensor]], 可选) — 元组包含 (last_hidden_state, 可选:hidden_states, 可选:attentions)last_hidden_state的形状为(batch_size, sequence_length, hidden_size)，可选) 是编码器最后一层输出的隐藏状态序列。在解码器的交叉注意力中使用。 - past_key_values (
tuple[tuple[torch.Tensor]], 可选) — 预计算的隐藏状态（自注意力块和交叉注意力块中的键和值），可用于加速顺序解码。这通常由模型在解码的先前阶段返回的past_key_values组成，当use_cache=True或config.use_cache=True时。允许两种格式：
- Cache 实例，请参阅我们的 kv 缓存指南；
- 长度为
config.n_layers的tuple(torch.FloatTensor)元组，每个元组包含 2 个形状为(batch_size, num_heads, sequence_length, embed_size_per_head)的张量）。这也称为旧式缓存格式。
模型将输出与作为输入提供的缓存格式相同的缓存格式。如果没有传入
past_key_values，则将返回旧式缓存格式。如果使用
past_key_values，用户可以选择只输入形状为(batch_size, 1)的最后一个input_ids（那些没有将其过去键值状态提供给此模型的）而不是形状为(batch_size, sequence_length)的所有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的值。 - labels (
torch.LongTensor，形状为(batch_size,)，可选) — 用于计算序列分类/回归损失的标签。索引应在[-100, 0, ..., config.vocab_size - 1]范围内。所有设置为-100的标签将被忽略（掩盖），损失仅针对[0, ..., config.vocab_size]范围内的标签计算。 - use_cache (
bool, 可选) — 如果设置为True，则返回past_key_values键值状态，可用于加速解码（参见past_key_values）。 - output_attentions (
bool, 可选) — 是否返回所有注意力层的注意力张量。更多详情请参见返回张量下的attentions。 - output_hidden_states (
bool, 可选) — 是否返回所有层的隐藏状态。更多详情请参见返回张量下的hidden_states。 - output_router_logits (
bool, 可选, 默认为True) — 是否返回所有路由器的 logits。它们对于计算路由器损失很有用，不应在推理期间返回。 - return_dict (
bool, 可选) — 是否返回 ModelOutput 而不是普通元组。 - cache_position (
torch.LongTensor，形状为(sequence_length)，可选) — 表示输入序列标记在序列中位置的索引。与position_ids不同，此张量不受填充影响。它用于在正确位置更新缓存并推断完整的序列长度。
返回
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 (形状为
(batch_size, sequence_length, config.vocab_size)的torch.FloatTensor) — 语言建模头部的预测分数（SoftMax 之前的每个词汇标记的分数）。 -
past_key_values (
EncoderDecoderCache, 可选, 当传递use_cache=True或当config.use_cache=True时返回) — 这是一个 EncoderDecoderCache 实例。有关更多详细信息，请参阅我们的 kv 缓存指南。包含预先计算的隐藏状态（自注意力块和交叉注意力块中的键和值），可用于（参见
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__ 特殊方法。
尽管 forward pass 的配方需要在此函数中定义，但此后应该调用 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() 方法加载模型权重。
裸 SwitchTransformers 模型，输出编码器的原始隐藏状态，不带任何特定头部
此模型继承自 PreTrainedModel。有关库为其所有模型实现的通用方法（如下载或保存、调整输入嵌入大小、修剪头部等）的更多详细信息，请查看超类文档。
此模型也是 PyTorch torch.nn.Module 子类。将其作为常规 PyTorch 模块使用，并参考 PyTorch 文档了解所有与通用用法和行为相关的事项。
forward
< 源代码 >( 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，形状为(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, 可选, 默认为True) — 是否返回所有路由器的 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__ 特殊方法。
尽管 forward pass 的配方需要在此函数中定义，但此后应该调用 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