Transformers 文档

JetMoe

Transformers

加入 Hugging Face 社区

并获得增强文档体验的访问权限

在模型、数据集和 Spaces 上协作

使用加速推理加快示例速度

在文档主题之间切换

开始使用

JetMoe

概述

JetMoe-8B 是由沈奕康和 MyShell 开发的 8B 混合专家 (MoE) 语言模型。JetMoe 项目旨在以有限的预算提供具有 LLaMA2 级性能和效率的语言模型。为了实现这一目标，JetMoe 使用了一种受 ModuleFormer 启发的稀疏激活架构。每个 JetMoe 块由两个 MoE 层组成：混合注意力头和混合 MLP 专家。给定输入标记，它会激活其专家的一个子集来处理它们。这种稀疏激活方案使 JetMoe 能够比同等规模的密集模型实现更好的训练吞吐量。JetMoe-8B 的训练吞吐量在 96 个 H100 GPU 的集群上约为每天 1000 亿个标记，采用简单的 3 路管道并行策略。

该模型由 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 )

参数

vocab_size (int, 可选, 默认值为 32000) — JetMoe 模型的词汇量大小。定义调用 JetMoeModel 时可以由 inputs_ids 表示的不同标记数量。
hidden_size (int, 可选, 默认值为 2048) — 隐藏表示的维度。
num_hidden_layers (int, 可选, 默认值为 12) — Transformer 编码器中的隐藏层数量。
num_key_value_heads (int, 可选, 默认值为 16) — Transformer 编码器中每个键和值的注意力头的数量。
kv_channels (int, 可选, 默认值为 128) — 定义键和值张量的通道数。
intermediate_size (int, 可选, 默认值为 5632) — MLP 表示的维度。
max_position_embeddings (int, 可选, 默认为 4096) — 该模型可能用到的最大序列长度。JetMoe 的注意力机制允许序列长度达到 4096 个 token。
activation_function (string, 可选, 默认为 "silu") — 定义 MLP 专家使用的激活函数。
num_local_experts (int, 可选, 默认为 8) — 定义 MoE 和 MoA 中的专家数量。
num_experts_per_tok (`int, 可选, 默认为 2) — 每个 token 以及 MoE 和 MoA 中路由的专家数量。
output_router_logits (bool, 可选, 默认为 False) — 是否应由模型返回路由 logits。启用此选项也将允许模型输出辅助损失。
aux_loss_coef (float, 可选, 默认为 0.01) — 辅助损失的系数。
use_cache (bool, 可选, 默认为 True) — 模型是否应该返回最后键值注意力（并非所有模型都使用）。仅当 config.is_decoder=True 时才相关。
bos_token_id (int, 可选, 默认为 1) — “序列开始”标记的 ID。
eos_token_id (int, 可选, 默认为 2) — “序列结束”标记的 ID。
tie_word_embeddings (bool, 可选, 默认为 True) — 模型的输入和输出词嵌入是否应该绑定。
rms_norm_eps (float, 可选, 默认为 1e-06) — RMS 归一化层使用的 ε 值。
initializer_range (float, 可选, 默认为 0.01) — 初始化所有权重矩阵的截断正态分布初始化器的标准差。
attention_dropout (float, 可选, 默认为 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

< 源代码 >

( config: JetMoeConfig )

参数

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

没有特定头部顶部的基本 JetMoe 模型，输出原始隐藏状态。此模型是 PyTorch torch.nn.Module 的子类。将其用作常规 PyTorch 模块，并参考 PyTorch 文档以了解有关一般用法和行为的所有事项。

包含 config.num_hidden_layers 层的 Transformer 解码器。每层都是一个 JetMoeBlock

forward

< 源代码 >

( input_ids: LongTensor = None attention_mask: Optional = None position_ids: Optional = None past_key_values: Union = None 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 cache_position: Optional = None )

参数

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

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

什么是输入 ID？
position_ids (torch.LongTensor 形状为 ({0}), 可选) — 每个输入序列令牌在位置嵌入中的位置索引。选定范围为 [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), 可选) — 指示输入序列令牌在序列中的位置的索引。与 position_ids 相反，此张量不受填充的影响。它用于在正确的位置更新缓存并推断完整的序列长度。

The JetMoeModel forward method, overrides the __call__ special method.

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

JetMoeForCausalLM

class transformers.JetMoeForCausalLM

< source >

( config )

forward

< source >

( input_ids: LongTensor = None attention_mask: Optional = None position_ids: Optional = None past_key_values: Optional = None inputs_embeds: Optional = None labels: Optional = None use_cache: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None output_router_logits: Optional = None return_dict: Optional = None cache_position: Optional = None num_logits_to_keep: int = 0 ) → transformers.modeling_outputs.MoeCausalLMOutputWithPast 或 tuple(torch.FloatTensor)

参数

input_ids (torch.LongTensor 形状为 ({0})) — 输入序列词元的词典索引。

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

什么是输入 ID？
attention_mask (torch.FloatTensor 形状为 ({0}), 可选) — 用于避免对填充词元索引执行注意力的掩码。掩码值选择在 [0, 1] 内：
- 1 表示未掩码的词元，
- 0 表示掩码的词元。
什么是注意力掩码？
position_ids (torch.LongTensor 形状为 ({0}), 可选) — 输入序列词元在位置嵌入中的位置索引。选择在 [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), 可选) — 表示输入序列标记在序列中的位置的索引。与 position_ids 相反，此张量不受填充的影响。它用于在正确位置更新缓存并推断完整的序列长度。

参数 — labels (torch.LongTensor 形状为 (batch_size, sequence_length), 可选): 用于计算掩码语言建模损失的标签。索引应为 [0, ..., config.vocab_size] 或 -100 (参见 input_ids 文档字符串)。索引设置为 -100 的标记将被忽略（掩码），损失仅针对标签位于 [0, ..., config.vocab_size] 的标记进行计算。

num_logits_to_keep (int, 可选): 计算最后 num_logits_to_keep 个标记的 logits。如果为 0，则计算所有 input_ids 的 logits（特殊情况）。生成仅需要最后一个标记的 logits，并且仅针对该标记计算它们可以节省内存，这对长序列或大词汇量来说非常重要。

返回值

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 时返回) — 稀疏模块的辅助损失。
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)。

由 MoE 路由器计算的原始路由器 logits（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) 的张量。

包含预先计算的隐藏状态（自注意力块中的键和值），可用于（参见 past_key_values 输入）加速顺序解码。
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 之后的注意力权重，用于计算自注意力头中的加权平均值。

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

JetMoeForSequenceClassification

class transformers.JetMoeForSequenceClassification

< source >

( config )

参数

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

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

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

由于它对最后一个标记进行分类，因此需要知道最后一个标记的位置。如果在配置中定义了 pad_token_id，它会找到每行中不是填充标记的最后一个标记。如果没有定义 pad_token_id，它只会简单地获取批处理中每行的最后一个值。由于它无法在传递 inputs_embeds 而不是 input_ids 时猜测填充标记，因此它也会执行相同的操作（获取批处理中每行的最后一个值）。

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

forward

< source >

( input_ids: Optional = None attention_mask: Optional = None position_ids: Optional = None past_key_values: Union = None inputs_embeds: Optional = None labels: Optional = None use_cache: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None )

参数

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

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

什么是输入 ID？
attention_mask (torch.FloatTensor 形状为 ({0})，可选) — 用于避免对填充标记索引执行注意力的掩码。在 [0, 1] 中选择的掩码值：
- 1 表示未掩码的标记，
- 0 表示掩码的标记。
什么是注意力掩码？
position_ids (torch.LongTensor 形状为 ({0})，可选) — 每个输入序列标记在位置嵌入中的位置索引。在 [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)，可选) — 用于描述输入序列标记在序列中的位置的索引。与 position_ids 不同，该张量不受填充的影响。它用于在正确的位置更新缓存并推断完整的序列长度。
labels (torch.LongTensor 形状为 (batch_size,)，可选) — 用于计算序列分类/回归损失的标签。索引应在 [0, ..., config.num_labels - 1] 中。如果 config.num_labels == 1，则计算回归损失（均方误差损失），如果 config.num_labels > 1，则计算分类损失（交叉熵）。

The JetMoeForSequenceClassification forward method, overrides the __call__ special method.

< > 更新在 GitHub 上

←Jamba Jukebox→