Transformers 文档

JetMoe

Transformers

加入 Hugging Face 社区

并获取增强的文档体验

协作开发模型、数据集和 Spaces

通过加速推理获得更快的示例

切换文档主题

开始使用

JetMoe

概述

JetMoe-8B 是一个由 Yikang Shen 和 MyShell 开发的 80 亿参数混合专家 (MoE) 语言模型。JetMoe 项目旨在以有限的预算提供 LLaMA2 级别的性能和高效的语言模型。为了实现这一目标，JetMoe 使用了受 ModuleFormer 启发的稀疏激活架构。每个 JetMoe 块由两个 MoE 层组成：注意力头混合层和 MLP 专家混合层。给定输入 tokens，它会激活一部分专家来处理它们。这种稀疏激活方案使 JetMoe 能够实现比类似大小的密集模型好得多的训练吞吐量。JetMoe-8B 的训练吞吐量在使用简单的 3 向流水线并行策略的 96 个 H100 GPU 集群上约为每天 100B tokens。

此模型由 Yikang Shen 贡献。

JetMoeConfig

class transformers.JetMoeConfig

< source >

( vocab_size = 32000 hidden_size = 2048 num_hidden_layers = 12 num_key_value_heads = 16 kv_channels = 128 intermediate_size = 5632 max_position_embeddings = 4096 activation_function = 'silu' num_local_experts = 8 num_experts_per_tok = 2 output_router_logits = False aux_loss_coef = 0.01 use_cache = True bos_token_id = 1 eos_token_id = 2 tie_word_embeddings = True rope_theta = 10000.0 rms_norm_eps = 1e-06 initializer_range = 0.01 attention_dropout = 0.0 **kwargs )

Parameters

vocab_size (int, optional, defaults to 32000) — JetMoe 模型的词汇表大小。定义了在调用 JetMoeModel 时可以通过 inputs_ids 传入的不同 token 的数量
hidden_size (int, optional, defaults to 2048) — 隐藏层表示的维度。
num_hidden_layers (int, optional, defaults to 12) — Transformer 编码器中的隐藏层数。
num_key_value_heads (int, optional, defaults to 16) — Transformer 编码器中每个键和值的注意力头的数量。
kv_channels (int, optional, defaults to 128) — 定义键和值张量的通道数。
intermediate_size (int, optional, defaults to 5632) — MLP 表示的维度。
max_position_embeddings (int, optional, defaults to 4096) — 此模型可能使用的最大序列长度。JetMoe 的注意力机制允许最长 4096 个 token 的序列。
activation_function (string, optional, defaults to "silu") — 定义 MLP experts 的激活函数。
num_local_experts (int, optional, defaults to 8) — 定义 MoE 和 MoA 中的专家数量。
num_experts_per_tok (int, optional, defaults to 2) — 每个 token 以及 MoE 和 MoA 要路由的专家数量。
output_router_logits (bool, optional, defaults to False) — 模型是否应返回路由器 logits。启用此项还将允许模型输出辅助损失。
aux_loss_coef (float, optional, defaults to 0.01) — 辅助损失的系数。
use_cache (bool, optional, defaults to True) — 模型是否应该返回上次的键/值注意力（并非所有模型都使用）。仅当 config.is_decoder=True 时相关。
bos_token_id (int, optional, defaults to 1) — “序列开始” token 的 id。
eos_token_id (int, optional, defaults to 2) — “序列结束” token 的 id。
tie_word_embeddings (bool, optional, defaults to True) — 模型输入和输出词嵌入是否应该绑定。
rope_theta (float, optional, defaults to 10000.0) — RoPE 嵌入的基础周期。
rms_norm_eps (float, optional, defaults to 1e-06) — rms 归一化层使用的 epsilon 值。
initializer_range (float, optional, defaults to 0.01) — 用于初始化所有权重矩阵的 truncated_normal_initializer 的标准差。
attention_dropout (float, optional, defaults to 0.0) — 注意力概率的 dropout 比率。

这是用于存储 JetMoeModel 配置的配置类。它用于根据指定的参数实例化 JetMoe 模型，定义模型架构。使用默认值实例化配置将生成 JetMoe-4B 的配置。

jetmoe/jetmoe-8b

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

>>> from transformers import JetMoeModel, JetMoeConfig

>>> # Initializing a JetMoe 4B style configuration
>>> configuration = JetMoeConfig()

>>> # Initializing a model from the JetMoe 4B style configuration
>>> model = JetMoeModel(configuration)

>>> # Accessing the model configuration
>>> configuration = model.config

JetMoeModel

class transformers.JetMoeModel

< source >

( config: JetMoeConfig )

Parameters

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

裸 JetMoe 模型，输出原始隐藏状态，顶部没有任何特定的 head。此模型是 PyTorch torch.nn.Module 子类。将其用作常规 PyTorch 模块，并参阅 PyTorch 文档以了解所有与常规用法和行为相关的事项。

Transformer 解码器，由 config.num_hidden_layers 层组成。每一层都是一个 JetMoeBlock

forward

< source >

( input_ids: LongTensor = None attention_mask: typing.Optional[torch.Tensor] = None position_ids: typing.Optional[torch.LongTensor] = None past_key_values: typing.Union[typing.List[torch.FloatTensor], transformers.cache_utils.Cache, NoneType] = None inputs_embeds: typing.Optional[torch.FloatTensor] = 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 )

Parameters

input_ids (形状为 ({0}) 的 torch.LongTensor) — 词汇表中输入序列 token 的索引。

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

什么是输入 ID？
attention_mask (形状为 ({0}) 的 torch.FloatTensor, optional) — 掩码，以避免对 padding token 索引执行注意力机制。掩码值在 [0, 1] 中选择：
- 1 表示 未被掩码 的 token，
- 0 表示 被掩码 的 token。
什么是注意力掩码？
position_ids (torch.LongTensor, 形状为 ({0}), 可选) — 每个输入序列令牌在位置嵌入中的位置索引。在范围 [0, config.n_positions - 1] 中选择。

什么是位置 IDs？
inputs_embeds (torch.FloatTensor, 形状为 ({0}, hidden_dim), 可选) — （可选）您可以选择直接传递嵌入表示，而不是传递 input_ids。如果您希望比模型的内部嵌入查找矩阵更精细地控制如何将 input_ids 索引转换为关联的向量，这将非常有用。
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), 可选) — 描述输入序列令牌在序列中位置的索引。与 position_ids 相反，此张量不受填充的影响。它用于在正确的位置更新缓存并推断完整的序列长度。

JetMoeModel 前向方法，覆盖了 __call__ 特殊方法。

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

JetMoeForCausalLM

class transformers.JetMoeForCausalLM

< source >

( config )

forward

< source >

( input_ids: LongTensor = None attention_mask: typing.Optional[torch.Tensor] = None position_ids: typing.Optional[torch.LongTensor] = None past_key_values: typing.Optional[typing.List[torch.FloatTensor]] = None 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] = None return_dict: typing.Optional[bool] = None cache_position: typing.Optional[torch.LongTensor] = None logits_to_keep: typing.Union[int, torch.Tensor] = 0 **kwargs ) → transformers.modeling_outputs.MoeCausalLMOutputWithPast 或 tuple(torch.FloatTensor)

Parameters

input_ids (torch.LongTensor, 形状为 ({0})) — 词汇表中输入序列令牌的索引。

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

什么是输入 IDs？
attention_mask (torch.FloatTensor, 形状为 ({0}), 可选) — 用于避免在填充令牌索引上执行注意力的掩码。掩码值在 [0, 1] 中选择：
- 1 表示未被掩码的令牌，
- 0 表示被掩码的令牌。
什么是注意力掩码？
position_ids (torch.LongTensor, 形状为 ({0}), 可选) — 每个输入序列令牌在位置嵌入中的位置索引。在范围 [0, config.n_positions - 1] 中选择。

什么是位置 IDs？
inputs_embeds (torch.FloatTensor, 形状为 ({0}, hidden_dim), 可选) — （可选）您可以选择直接传递嵌入表示，而不是传递 input_ids。如果您希望比模型的内部嵌入查找矩阵更精细地控制如何将 input_ids 索引转换为关联的向量，这将非常有用。
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), 可选) — 描述输入序列令牌在序列中位置的索引。与 position_ids 相反，此张量不受填充的影响。它用于在正确的位置更新缓存并推断完整的序列长度。
labels (torch.LongTensor, 形状为 (batch_size, sequence_length), 可选) — 用于计算掩码语言建模损失的标签。索引应在 [0, ..., config.vocab_size] 或 -100 中（请参阅 input_ids 文档字符串）。索引设置为 -100 的令牌将被忽略（掩码），损失仅针对标签在 [0, ..., config.vocab_size] 中的令牌计算。
logits_to_keep (int 或 torch.Tensor, 可选) — 如果是 int，则计算最后 logits_to_keep 个令牌的 logits。如果为 0，则计算所有 input_ids 的 logits（特殊情况）。仅生成最后一个令牌 logits 是必需的，并且仅为该令牌计算它们可以节省内存，这对于长序列或大型词汇表大小而言变得非常重要。如果为 torch.Tensor，则必须是与序列长度维度中要保留的索引相对应的 1D 张量。这在使用打包张量格式（批次和序列长度的单个维度）时非常有用。

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

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

loss (torch.FloatTensor, 形状为 (1,), 可选, 当提供 labels 时返回) — 语言建模损失（用于下一个令牌预测）。
logits (torch.FloatTensor, 形状为 (batch_size, sequence_length, config.vocab_size)) — 语言建模头的预测分数（SoftMax 之前每个词汇表令牌的分数）。
aux_loss (torch.FloatTensor, 可选, 当提供 labels 时返回) — 稀疏模块的 aux_loss。
router_logits (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)。

原始路由器 logits（softmax 后），由 MoE 路由器计算，这些项用于计算专家混合模型的辅助损失。
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) 的张量）

包含预先计算的隐藏状态（自注意力块中的键和值），可以用于（请参阅 past_key_values 输入）加速顺序解码。
hidden_states (tuple(torch.FloatTensor), 可选, 当传递了 output_hidden_states=True 或当 config.output_hidden_states=True 时返回) — torch.FloatTensor 元组（对于嵌入的输出，如果模型具有嵌入层，则为 1 个，+ 对于每层的输出，则为 1 个），形状为 (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 之后的注意力权重，用于计算自注意力头中的加权平均值。

JetMoeForCausalLM 前向方法，覆盖了 __call__ 特殊方法。

JetMoeForSequenceClassification

class transformers.JetMoeForSequenceClassification

< source >

( config )

Parameters

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

带有序列分类头（线性层）的 JetMoe 模型转换器。

JetMoeForSequenceClassification 使用最后一个 token 来进行分类，就像其他因果模型（例如 GPT-2）一样。

由于它对最后一个 token 进行分类，因此需要知道最后一个 token 的位置。如果在配置中定义了 pad_token_id，它会在每行中找到最后一个不是 padding token 的 token。如果未定义 pad_token_id，它只需获取批次中每行的最后一个值。由于当传递 inputs_embeds 而不是 input_ids 时，它无法猜测 padding token，因此它执行相同的操作（获取批次中每行的最后一个值）。

此模型是 PyTorch torch.nn.Module 子类。将其用作常规 PyTorch 模块，并参阅 PyTorch 文档，了解与常规用法和行为相关的所有事项。

forward

< source >

( input_ids: typing.Optional[torch.LongTensor] = None attention_mask: typing.Optional[torch.Tensor] = None position_ids: typing.Optional[torch.LongTensor] = None past_key_values: typing.Union[typing.List[torch.FloatTensor], transformers.cache_utils.Cache, NoneType] = None 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 return_dict: typing.Optional[bool] = None )

Parameters

input_ids (torch.LongTensor，形状为 ({0})) — 词汇表中输入序列 token 的索引。

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

什么是输入 ID？
attention_mask (torch.FloatTensor，形状为 ({0})，可选) — 掩码，用于避免在 padding token 索引上执行注意力机制。掩码值在 [0, 1] 中选择：
- 1 代表未被掩码的 token，
- 0 代表被掩码的 token。
什么是注意力掩码？
position_ids (torch.LongTensor，形状为 ({0})，可选) — 位置嵌入中每个输入序列 token 的位置索引。在范围 [0, config.n_positions - 1] 中选择。

什么是位置 ID？
inputs_embeds (torch.FloatTensor，形状为 ({0}, hidden_dim)，可选) — （可选）您可以选择直接传递嵌入表示，而不是传递 input_ids。如果您希望比模型的内部嵌入查找矩阵更灵活地控制如何将 input_ids 索引转换为关联向量，这将非常有用。
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)，可选) — 索引，描述输入序列 token 在序列中的位置。与 position_ids 相反，此张量不受 padding 的影响。它用于在正确的位置更新缓存并推断完整序列长度。
labels (torch.LongTensor，形状为 (batch_size,)，可选) — 用于计算序列分类/回归损失的标签。索引应在 [0, ..., config.num_labels - 1] 中。如果 config.num_labels == 1，则计算回归损失（均方损失）；如果 config.num_labels > 1，则计算分类损失（交叉熵）。

JetMoeForSequenceClassification forward 方法覆盖了 __call__ 特殊方法。

< > 在 GitHub 上更新

←Jamba Jukebox→