Hugging Face's logo

Transformers 文档

SwitchTransformers

Hugging Face's logo
加入 Hugging Face 社区

并获取增强的文档体验

开始使用

SwitchTransformers

PyTorch

概述

SwitchTransformers 模型在 Switch Transformers: Scaling to Trillion Parameter Models with Simple and Efficient Sparsity (William Fedus, Barret Zoph, Noam Shazeer 提出)。

Switch Transformer 模型使用稀疏的 T5 编码器-解码器架构，其中 MLP 被专家混合 (MoE) 模型取代。路由机制（本例中为 top 1）将每个 token 与一个专家关联，其中每个专家都是一个密集的 MLP。虽然 switch transformers 比同等的密集模型拥有更多的权重，但稀疏性允许更好的扩展和更大规模的微调性能。在前向传递期间，仅使用一部分权重。路由机制允许模型动态选择相关权重，从而在不增加操作数量的情况下增加模型容量。

以下是论文的摘要

在深度学习中，模型通常对所有输入重用相同的参数。专家混合 (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

class transformers.SwitchTransformersConfig

< >

( 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, defaults to 32128) — SwitchTransformers 模型的词汇表大小。定义了在调用 SwitchTransformersModel 时传递的 inputs_ids 可以表示的不同 token 的数量。
  • d_model (int, optional, defaults to 768) — 编码器层和池化层的大小。
  • d_kv (int, optional, defaults to 64) — 每个 attention head 的 key, query, value 投影的大小。d_kv 必须等于 d_model // num_heads。
  • d_ff (int, optional, defaults to 2048) — 每个 SwitchTransformersBlock 中间 feed forward 层的大小。
  • expert_capacity (int, optional, defaults to 64) — 每个 expert 可以存储的 token 数量。如果设置为 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, optional, defaults to 12) — Transformer 解码器中隐藏层的数量。如果未设置，将使用与 num_layers 相同的值。
  • num_sparse_decoder_layers (int, optional, defaults to 3) — Transformer 解码器层中稀疏 (MoE) 密集隐藏层的数量。
  • num_heads (int, optional, defaults to 12) — Transformer 编码器中每个 attention 层的 attention head 数量。
  • num_experts (int, optional, defaults to 8) — 每个 SwitchTransformer 层的 expert 数量。
  • router_bias (bool, optional, defaults to False) — 是否向 router 添加 bias。
  • router_jitter_noise (float, optional, defaults to 0.01) — 添加到 router 的噪声量。
  • router_dtype (str, optional, default to "float32") — 用于 router 的 dtype。最好将 dtype 保留为 "float32"，如 论文 中 selective precision 讨论中所述。
  • router_ignore_padding_tokens (bool, optional, defaults to False) — 在路由时是否忽略 padding token。
  • relative_attention_num_buckets (int, optional, defaults to 32) — 用于每个 attention layer 的 bucket 数量。
  • relative_attention_max_distance (int, optional, defaults to 128) — 用于 bucket 分离的较长序列的最大距离。
  • dropout_rate (float, optional, defaults to 0.1) — 所有 dropout 层的比率。
  • layer_norm_eps (float, optional, defaults to 1e-6) — layer normalization 层使用的 epsilon 值。
  • router_z_loss_coef (float, optional, defaults to 0.001) — 总损失的 z 损失因子。
  • router_aux_loss_coef (float, optional, defaults to 0.001) — 总损失的 aux 损失因子。
  • initializer_factor (float, optional, defaults to 1.0) — 用于初始化所有权重矩阵的因子 (应保持为 1，内部用于初始化测试)。
  • dense_act_fn (string, optional, defaults to "relu") — 要使用的 feed forward 层类型。应为 "relu" 或 "gated-gelu" 之一。SwitchTransformersv1.1 使用 "gated-gelu" feed forward 投影。原始 SwitchTransformers 使用 "relu"。
  • add_router_probs (bool, optional, defaults to False) — 是否输出 router 概率以计算 router 辅助损失。
  • use_cache (bool, 可选, 默认为 True) — 模型是否应返回最后的键/值注意力（并非所有模型都使用）。

这是用于存储 SwitchTransformersModel 配置的配置类。它用于根据指定的参数实例化 SwitchTransformers 模型，定义模型架构。使用默认值实例化配置将生成类似于 SwitchTransformers google/switch-base-8 架构的配置。

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

SwitchTransformersTop1Router

class transformers.SwitchTransformersTop1Router

< >

( config: SwitchTransformersConfig )

路由器使用 tokens 选择 top-1 专家分配。

此路由器使用与 Switch Transformer (https://arxiv.org/abs/2101.03961) 和 V-MoE (https://arxiv.org/abs/2106.05974) 中相同的机制：tokens 选择其首选专家。项目按 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 张量，对应于原始路由器 logits。这稍后用于计算路由器 z-loss。

从输入的隐藏状态计算路由器概率。

forward

< >

( hidden_states: Tensor )

参数

  • hidden_states (torch.Tensor) — [num_groups, tokens_per_group, hidden_dim] 发送到专家的输入。

每个 Router 类通用的前向函数。每个 Router 期望具有相同的输入隐藏状态 (hidden_states)，对应于每个 token 的隐藏状态，expert_capacity 对应于 Router 将发送到每个专家的 token 数量，某些 Router 可以向每个专家发送最多几个 token。

每个 Router 的工作方式如下：它期望每个 token 的隐藏状态，从 router_weights 获取 router_probs 和 router_logits。这将为每个 token 分配分配给专家的原始概率。然后，每个 Router 类都必须定义自己的 _compute_routing_instructions。

SwitchTransformersSparseMLP

class transformers.SwitchTransformersSparseMLP

< >

( config: SwitchTransformersConfig expert_class: Module = <class 'transformers.models.switch_transformers.modeling_switch_transformers.SwitchTransformersDenseActDense'> )

Switch Transformers Sparse MLP 模块的实现。

forward

< >

( hidden_states )

稍等，这会有点难以理解。按照正确的顺序，MoE 层执行以下操作：

1- 从路由器获取 router_mask。mask 的形状为 (batch_size, sequence_length, num_expert)，对应于 router_probs 的 argmax。隐藏状态的计算需要概率：它们被广播到隐藏状态值（可以解释为缩放因子）。

2- 将 token 分派到其关联的专家。我们对专家执行经典 for 循环，并为每个专家分配相应的隐藏状态。

SwitchTransformersModel

class transformers.SwitchTransformersModel

< >

( config: SwitchTransformersConfig )

参数

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

裸机 SWITCH_TRANSFORMERS 模型转换器输出原始隐藏状态，顶部没有任何特定的 head。

SWITCH_TRANSFORMERS 模型在 Switch Transformers: Scaling to Trillion Parameter Models with Simple and Efficient Sparsity 中由 William Fedus、Barret Zoph 和 Noam Shazeer 提出。它是一个类似 T5 的编码器-解码器模型，具有稀疏的前馈网络，代表专家混合 (MoE) 架构。

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

此模型也是 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[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 (形状为 (batch_size, sequence_length) 的 torch.LongTensor) — 词汇表中输入序列 token 的索引。 SWITCH_TRANSFORMERS 是一个具有相对位置嵌入的模型，因此您应该能够在右侧和左侧填充输入。

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

    什么是输入 ID？

    要了解有关如何为预训练准备 input_ids 的更多信息，请查看 SWITCH_TRANSFORMERS 训练。

  • attention_mask (形状为 (batch_size, sequence_length) 的 torch.FloatTensor, 可选) — 遮罩，以避免在 padding token 索引上执行注意力机制。 遮罩值在 [0, 1] 中选择：

    • 1 表示 未被遮罩 的 token，
    • 0 表示 被遮罩 的 token。

    什么是注意力遮罩？

  • decoder_input_ids (形状为 (batch_size, target_sequence_length) 的 torch.LongTensor, 可选) — 词汇表中解码器输入序列 token 的索引。

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

    什么是解码器输入 ID？

    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 (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，optional：hidden_states，optional：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，用户可以选择仅输入最后一次的 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 索引转换为关联的向量，这将非常有用。
  • 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 而不是普通元组。
  • cache_position (torch.LongTensor，形状为 (sequence_length)，可选) — 索引，描述输入序列标记在序列中的位置。它用于在正确的位置更新缓存，并推断完整的序列长度。

返回

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__ 特殊方法。

虽然 forward 传递的配方需要在该函数中定义，但之后应调用 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

class transformers.SwitchTransformersForConditionalGeneration

< >

( config: SwitchTransformersConfig )

参数

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

带有 language modeling 头的 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。查看超类文档，了解库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、剪枝 head 等）。

此模型也是 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[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，形状为 (batch_size, sequence_length)) — 词汇表中输入序列 tokens 的索引。 SWITCH_TRANSFORMERS 是一个使用相对位置嵌入的模型，因此你应该能够左右两侧填充输入。

    索引可以使用 AutoTokenizer 获得。 参见 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call() 以了解详情。

    什么是输入 IDs？

    要了解更多关于如何为预训练准备 input_ids 的信息，请查看 SWITCH_TRANSFORMERS 训练。

  • attention_mask (torch.FloatTensor，形状为 (batch_size, sequence_length)，可选) — 掩码，用于避免在 padding token 索引上执行 attention。 掩码值在 [0, 1] 中选择：

    • 1 表示 tokens 未被掩盖，
    • 0 表示 tokens 被掩盖。

    什么是 attention 掩码？

  • decoder_input_ids (torch.LongTensor，形状为 (batch_size, target_sequence_length)，可选) — 词汇表中 decoder 输入序列 tokens 的索引。

    索引可以使用 AutoTokenizer 获得。 参见 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call() 以了解详情。

    什么是 decoder 输入 IDs？

    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 (torch.BoolTensor，形状为 (batch_size, target_sequence_length)，可选) — 默认行为：生成一个 tensor，该 tensor 忽略 decoder_input_ids 中的 padding tokens。 默认情况下，也会使用因果掩码。
  • head_mask (torch.FloatTensor，形状为 (num_heads,) 或 (num_layers, num_heads)，可选) — 掩码，用于置空 encoder 中 self-attention 模块的选定 heads。 掩码值在 [0, 1] 中选择：

    • 1 表示 head 未被掩盖，
    • 0 表示 head 被掩盖。
  • decoder_head_mask (torch.FloatTensor，形状为 (num_heads,) 或 (num_layers, num_heads)，可选) — 掩码，用于置空 decoder 中 self-attention 模块的选定 heads。 掩码值在 [0, 1] 中选择：

    • 1 表示 head 未被掩盖，
    • 0 表示 head 被掩盖。
  • cross_attn_head_mask (torch.Tensor，形状为 (num_heads,) 或 (num_layers, num_heads)，可选) — 掩码，用于置空 decoder 中 cross-attention 模块的选定 heads。 掩码值在 [0, 1] 中选择：

    • 1 表示 head 未被掩盖，
    • 0 表示 head 被掩盖。
  • encoder_outputs (tuple(tuple(torch.FloatTensor)，可选) — 元组由 (last_hidden_state, optional: hidden_states, optional: attentions) 组成。 形状为 (batch_size, sequence_length, hidden_size) 的 last_hidden_state 是 encoder 最后一层的输出处的 hidden states 序列。 在 decoder 的 cross-attention 中使用。
  • past_key_values (tuple(tuple(torch.FloatTensor))，长度为 config.n_layers，其中每个元组有 4 个形状为 (batch_size, num_heads, sequence_length - 1, embed_size_per_head) 的 tensors) — 包含 attention 块的预计算 key 和 value hidden states。 可用于加速解码。

    如果使用了 past_key_values，用户可以选择仅输入最后一个 decoder_input_ids (那些没有将其 past key value states 提供给此模型的) ，形状为 (batch_size, 1)，而不是所有形状为 (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，可选) — 是否返回所有 attention 层的 attention tensors。 有关更多详细信息，请参见返回的 tensors 下的 attentions。
  • output_hidden_states (bool，可选) — 是否返回所有层的 hidden states。 有关更多详细信息，请参见返回的 tensors 下的 hidden_states。
  • output_router_logits (bool，可选) — 是否返回所有 routers 的 logits。 它们对于计算 router loss 非常有用，并且不应在推理期间返回。
  • return_dict (bool，可选) — 是否返回 ModelOutput 而不是纯元组。
  • cache_position (torch.LongTensor，形状为 (sequence_length)，可选) — 索引，描述输入序列 tokens 在序列中的位置。 它用于在正确的位置更新缓存并推断完整序列长度。
  • 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)) — 语言建模 head 的预测分数（SoftMax 之前每个词汇表 token 的分数）。

  • 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 在每一层输出端的 hidden-states 加上初始嵌入输出。

  • 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 在每一层输出端的 hidden-states 加上初始嵌入输出。

  • 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)。

    encoder 模型的 Router logits，可用于计算专家混合模型的辅助损失和 z_loss。

transformers.SwitchTransformersForConditionalGeneration forward 方法，覆盖了 __call__ 特殊方法。

虽然 forward 传递的配方需要在该函数中定义，但之后应调用 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

class transformers.SwitchTransformersEncoderModel

< >

( config: SwitchTransformersConfig )

参数

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

裸机 SWITCH_TRANSFORMERS 模型 transformer，输出 encoder 的原始 hidden-states，顶部没有任何特定的 head。

SWITCH_TRANSFORMERS 模型在 Switch Transformers: Scaling to Trillion Parameter Models with Simple and Efficient Sparsity 中由 William Fedus、Barret Zoph 和 Noam Shazeer 提出。它是一个类似 T5 的编码器-解码器模型，具有稀疏的前馈网络，代表专家混合 (MoE) 架构。

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

此模型也是 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 (形状为 (batch_size, sequence_length) 的 torch.LongTensor) — 词汇表中输入序列 tokens 的索引。 SWITCH_TRANSFORMERS 是一个具有相对位置嵌入的模型，因此您应该能够在右侧和左侧填充输入。

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

    要了解更多关于如何为预训练准备 input_ids 的信息，请查看 SWITCH_TRANSFORMERS 训练。

  • attention_mask (形状为 (batch_size, sequence_length) 的 torch.FloatTensor, 可选) — 用于避免在 padding token 索引上执行 attention 的 Mask。 Mask 值在 [0, 1] 中选择：

    • 1 表示 tokens 未被 Mask，
    • 0 表示 tokens 被 Mask。

    什么是 attention masks？

  • head_mask (形状为 (num_heads,) 或 (num_layers, num_heads) 的 torch.FloatTensor, 可选) — 用于置空 self-attention 模块中选定 heads 的 Mask。 Mask 值在 [0, 1] 中选择：

    • 1 表示 head 未被 Mask，
    • 0 表示 head 被 Mask。
  • inputs_embeds (形状为 (batch_size, sequence_length, hidden_size) 的 torch.FloatTensor, 可选) — （可选）您可以选择直接传递嵌入表示，而不是传递 input_ids。 如果您想要比模型的内部嵌入查找矩阵更精细地控制如何将 input_ids 索引转换为关联向量，这将非常有用。
  • output_attentions (bool, 可选) — 是否返回所有 attention 层的 attentions tensors。 有关更多详细信息，请参阅返回 tensors 下的 attentions。
  • output_hidden_states (bool, 可选) — 是否返回所有层的 hidden states。 有关更多详细信息，请参阅返回 tensors 下的 hidden_states。
  • output_router_logits (bool, 可选) — 是否返回所有路由器的 logits。 它们对于计算路由器损失很有用，并且不应在推理期间返回。
  • return_dict (bool, 可选) — 是否返回 ModelOutput 而不是普通 tuple。

返回

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

一个 transformers.modeling_outputs.MoEModelOutput 或一个 torch.FloatTensor 的 tuple （如果传递了 return_dict=False 或当 config.return_dict=False 时），包含各种元素，具体取决于配置 (SwitchTransformersConfig) 和输入。

  • last_hidden_state (形状为 (batch_size, sequence_length, hidden_size) 的 torch.FloatTensor) — 模型最后一层的输出处的 hidden-states 序列。

  • hidden_states (tuple(torch.FloatTensor), 可选, 当传递 output_hidden_states=True 或当 config.output_hidden_states=True 时返回) — torch.FloatTensor 的 Tuple （如果模型具有嵌入层，则为嵌入输出，+ 每层输出一个），形状为 (batch_size, sequence_length, hidden_size)。

    模型在每层输出处的 Hidden-states 加上可选的初始嵌入输出。

  • attentions (tuple(torch.FloatTensor), 可选, 当传递 output_attentions=True 或当 config.output_attentions=True 时返回) — torch.FloatTensor 的 Tuple （每层一个），形状为 (batch_size, num_heads, sequence_length, sequence_length)。

    attention softmax 后的 Attention 权重，用于计算 self-attention heads 中的加权平均值。

  • router_probs (tuple(torch.FloatTensor), 可选, 当传递 output_router_probs=True 和 config.add_router_probs=True 或当 config.output_router_probs=True 时返回) — torch.FloatTensor 的 Tuple （每层一个），形状为 (batch_size, sequence_length, num_experts)。

    MoE 路由器计算的原始路由器概率，这些项用于计算专家混合模型的辅助损失和 z_loss。

SwitchTransformersEncoderModel forward 方法，覆盖了 __call__ 特殊方法。

虽然 forward 传递的配方需要在该函数中定义，但之后应调用 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
< > 在 GitHub 上更新

←Starcoder2 T5→