Transformers 文档

GraniteMoe

Hugging Face's logo
加入 Hugging Face 社区

并获得增强的文档体验

开始使用

GraniteMoe

概述

GraniteMoe 模型在 Yikang Shen、Matthew Stallone、Mayank Mishra、Gaoyuan Zhang、Shawn Tan、Aditya Prasad、Adriana Meza Soria、David D. Cox 和 Rameswar Panda 发表的论文 Power Scheduler: A Batch Size and Token Number Agnostic Learning Rate Scheduler 中被提出。

PowerMoE-3B 是一个 30 亿参数的稀疏专家混合 (sMoE) 语言模型,使用 Power 学习率调度器进行训练。它为每个 token 稀疏激活 8 亿个参数。它在开源和专有数据集的混合数据集上进行训练。与其他具有 2 倍激活参数的密集模型相比,PowerMoE-3B 在各种基准测试中(包括自然语言多项选择、代码生成和数学推理)表现出了良好的结果。

论文的摘要如下:

为语言模型预训练找到最佳学习率是一项具有挑战性的任务。这不仅是因为学习率、批大小、训练 token 数量、模型大小和其他超参数之间存在复杂的关联,还因为对具有数十亿或数万亿参数的大型语言模型执行超参数搜索成本过高。最近的研究建议使用小型代理模型和小规模语料库来执行超参数搜索,并将最佳参数移植到大型模型和大型语料库中。虽然对于模型大小相关的超参数(如深度和宽度)的零样本可迁移性在理论上和经验上都得到了证明,但从小规模语料库到大型语料库的零样本迁移尚未得到充分探索。在本文中,我们研究了最近提出的 WSD 调度器中最佳学习率、批大小和训练 token 数量之间的相关性。经过数千次小型实验,我们发现变量之间存在幂律关系,并证明了其跨模型尺寸的可迁移性。基于这一观察结果,我们提出了一种新的学习率调度器——Power 调度器,该调度器与训练 token 数量和批大小无关。实验表明,将 Power 调度器与最大更新参数化 (\mup) 相结合,无论训练 token 数量、批大小、模型大小甚至模型架构如何,都能够以一组超参数持续取得令人印象深刻的性能。我们使用 Power 调度器训练的 30 亿参数密集模型和 MoE 模型实现了与最先进的小型语言模型相当的性能。我们已将这些预训练模型 开源

提示

import torch
from transformers import AutoModelForCausalLM, AutoTokenizer

model_path = "ibm/PowerMoE-3b"
tokenizer = AutoTokenizer.from_pretrained(model_path)

# drop device_map if running on CPU
model = AutoModelForCausalLM.from_pretrained(model_path, device_map="auto")
model.eval()

# change input text as desired
prompt = "Write a code to find the maximum value in a list of numbers."

# tokenize the text
input_tokens = tokenizer(prompt, return_tensors="pt")
# generate output tokens
output = model.generate(**input_tokens, max_new_tokens=100)
# decode output tokens into text
output = tokenizer.batch_decode(output)
# loop over the batch to print, in this example the batch size is 1
for i in output:
    print(i)

此模型由 mayank-mishra 贡献。

GraniteMoeConfig

class transformers.GraniteMoeConfig

< >

( vocab_size = 32000 hidden_size = 4096 intermediate_size = 11008 num_hidden_layers = 32 num_attention_heads = 32 num_key_value_heads = None hidden_act = 'silu' max_position_embeddings = 2048 initializer_range = 0.02 rms_norm_eps = 1e-06 use_cache = True pad_token_id = None bos_token_id = 1 eos_token_id = 2 tie_word_embeddings = False rope_theta = 10000.0 rope_scaling = None attention_bias = False attention_dropout = 0.0 embedding_multiplier = 1.0 logits_scaling = 1.0 residual_multiplier = 1.0 attention_multiplier = 1.0 num_local_experts = 8 num_experts_per_tok = 2 output_router_logits = False router_aux_loss_coef = 0.001 **kwargs )

参数

  • vocab_size (int, 可选, 默认为 32000) — GraniteMoe 模型的词汇量大小。定义了调用 GraniteMoeModel 时传递的 inputs_ids 可以表示的不同 token 的数量
  • hidden_size (int可选,默认为 4096) — 隐藏表示的维度。
  • intermediate_size (int可选,默认为 11008) — MLP 表示的维度。
  • num_hidden_layers (int可选,默认为 32) — Transformer 解码器中隐藏层的数量。
  • num_attention_heads (int可选,默认为 32) — Transformer 解码器中每个注意力层的注意力头的数量。
  • num_key_value_heads (int可选) — 这是用于实现分组查询注意力的键值头的数量。如果 num_key_value_heads=num_attention_heads,则模型将使用多头注意力 (MHA),如果 num_key_value_heads=1,则模型将使用多查询注意力 (MQA),否则将使用 GQA。在将多头检查点转换为 GQA 检查点时,每个组键和值头应通过对该组中所有原始头进行平均池化来构建。有关更多详细信息,请查看 这篇论文。如果未指定,将默认为 num_attention_heads
  • hidden_act (strfunction可选,默认为 "silu") — 解码器中的非线性激活函数(函数或字符串)。
  • max_position_embeddings (int可选,默认为 2048) — 此模型可能使用的最大序列长度。
  • initializer_range (float可选,默认为 0.02) — 用于初始化所有权重矩阵的截断正态初始化器的标准差。
  • rms_norm_eps (float可选,默认为 1e-06) — rms 归一化层使用的 epsilon。
  • use_cache (bool可选,默认为 True) — 模型是否应该返回最后的键/值注意力(并非所有模型都使用)。仅当 config.is_decoder=True 时才相关。
  • bos_token_id (int可选,默认为 1) — 流的起始标记 ID。
  • eos_token_id (int可选,默认为 2) — 流的结束标记 ID。
  • tie_word_embeddings (bool可选,默认为 False) — 是否绑定权重嵌入
  • rope_theta (float可选,默认为 10000.0) — RoPE 嵌入的基本周期。
  • rope_scaling (Dict可选) — 包含 RoPE 嵌入缩放配置的字典。目前支持两种缩放策略:线性缩放和动态缩放。它们的缩放因子必须大于 1 的浮点数。预期格式为 {"type": 策略名称, "factor": 缩放因子}。使用此标志时,请勿将 max_position_embeddings 更新为预期的新的最大值。有关这些缩放策略的行为方式的更多信息,请参阅以下帖子: https://www.reddit.com/r/LocalLLaMA/comments/14mrgpr/dynamically_scaled_rope_further_increases/。这是一项实验性功能,在将来的版本中可能会发生破坏性 API 更改。
  • attention_bias (bool可选,默认为 False) — 是否在自注意力期间在查询、键、值和输出投影层中使用偏差。
  • attention_dropout (float可选,默认为 0.0) — 注意力概率的 dropout 比率。
  • embedding_multiplier (float可选,默认为 1.0) — 嵌入乘数
  • logits_scaling (float可选,默认为 1.0) — 输出 logits 的除数
  • residual_multiplier (float可选,默认为 1.0) — 残差乘数
  • num_local_experts (int可选,默认为 8) — 专家总数
  • num_experts_per_tok (int可选,默认为 2) — 每个 Token 的专家数量
  • output_router_logits (bool可选,默认为 False) — 模型是否应该返回路由 logits。启用此选项也将允许模型输出辅助损失。
  • router_aux_loss_coef (float可选,默认为 0.001) — 路由辅助损失系数

这是用于存储 GraniteMoeModel 配置的配置类。它用于根据指定的参数实例化 GraniteMoe 模型,定义模型架构。使用默认值实例化配置将产生与 GraniteMoe-3B 类似的配置。

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

>>> from transformers import GraniteMoeModel, GraniteMoeConfig

>>> # Initializing a GraniteMoe granitemoe-3b style configuration
>>> configuration = GraniteMoeConfig()

>>> # Initializing a model from the granitemoe-7b style configuration
>>> model = GraniteMoeModel(configuration)

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

GraniteMoeModel

transformers.GraniteMoeModel

< >

( config: GraniteMoeConfig )

参数

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

不带任何特定头的基本 GraniteMoe 模型,输出原始隐藏状态。此模型继承自 PreTrainedModel。查看超类文档以了解库为其所有模型实现的通用方法(例如下载或保存、调整输入嵌入的大小、修剪头等)。

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

由 *config.num_hidden_layers* 层组成的 Transformer 解码器。每一层都是一个 GraniteMoeDecoderLayer

前向传播

< >

( 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 (形状为 (batch_size, sequence_length)torch.LongTensor) — 词汇表中输入序列标记的索引。如果您提供填充,
  • attention_mask (torch.Tensor 形状为 (batch_size, sequence_length)可选) — 用于避免对填充标记索引执行注意力操作的掩码。掩码值选择在 [0, 1] 中:

    • 1 表示未被掩码的标记,
    • 0 表示被掩码的标记。

    什么是注意力掩码?

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

    如果使用 past_key_values,则可以选择仅输入最后的 input_ids(参见 past_key_values)。

    如果要更改填充行为,则应阅读 modeling_opt._prepare_decoder_attention_mask 并根据您的需要进行修改。有关默认策略的更多信息,请参阅 论文 中的图 1。

    • 1 表示头部未被掩码
    • 0 表示头部被掩码
  • position_ids (torch.LongTensor 形状为 (batch_size, sequence_length)可选) — 输入序列中每个标记在位置嵌入中的位置索引。选择范围在 [0, config.n_positions - 1] 中。

    什么是位置 ID?

  • past_key_values (Cachetuple(tuple(torch.FloatTensor))可选) — 预先计算的隐藏状态(自注意力块和交叉注意力块中的键和值),可用于加速顺序解码。这通常包括模型在解码的先前阶段返回的 past_key_values,当 use_cache=Trueconfig.use_cache=True 时。

    允许两种格式:

    • 一个 Cache 实例;
    • 长度为 config.n_layerstuple(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 (torch.FloatTensor 形状为 (batch_size, sequence_length, hidden_size)可选) — 可选地,您可以选择直接传递嵌入表示,而不是传递 input_ids。如果您希望对如何将 input_ids 索引转换为关联向量进行更多控制,而不是模型内部的嵌入查找矩阵,这将很有用。
  • use_cache (bool可选) — 如果设置为 True,则返回 past_key_values 键值状态,可用于加速解码(参见 past_key_values)。
  • output_attentions (bool可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息,请参阅返回张量中的 attentions
  • output_hidden_states (bool可选) — 是否返回所有层的隐藏状态。有关更多详细信息,请参阅返回张量中的 hidden_states
  • return_dict (bool可选) — 是否返回 ModelOutput 而不是普通元组。
  • cache_position (torch.LongTensor 形状为 (sequence_length)可选) — 表示输入序列标记在序列中的位置的索引。与 position_ids 相反,此张量不受填充影响。它用于在正确的位置更新缓存并推断完整的序列长度。

GraniteMoeModel 的前向方法覆盖了 __call__ 特殊方法。

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

GraniteMoeForCausalLM

transformers.GraniteMoeForCausalLM

< >

( config: GraniteMoeConfig )

前向传播

< >

( input_ids: LongTensor = 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 output_router_logits: Optional = None return_dict: Optional = None cache_position: Optional = None ) transformers.modeling_outputs.MoeCausalLMOutputWithPasttuple(torch.FloatTensor)

参数

  • input_ids (torch.LongTensor 形状为 (batch_size, sequence_length)) — 词汇表中输入序列标记的索引。默认情况下,如果您提供填充,则会忽略填充。

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

    什么是输入 ID?

  • attention_mask (torch.Tensor 形状为 (batch_size, sequence_length)可选) — 用于避免对填充标记索引执行注意力的掩码。在 [0, 1] 中选择掩码值:

    • 1 表示未掩码的标记,
    • 0 表示掩码的标记。

    什么是注意力掩码?

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

    如果使用 past_key_values,则可以选择仅输入最后的 input_ids(那些没有将其过去的键值状态提供给此模型的)(参见 past_key_values)。

    如果您想更改填充行为,则应阅读 modeling_opt._prepare_decoder_attention_mask 并根据您的需要进行修改。有关默认策略的更多信息,请参阅论文中的图 1。

    • 1 表示头部未掩码
    • 0 表示头部掩码
  • position_ids (torch.LongTensor 形状为 (batch_size, sequence_length)可选) — 位置嵌入中每个输入序列标记的位置索引。在 [0, config.n_positions - 1] 范围内选择。

    什么是位置 ID?

  • past_key_values (Cachetuple(tuple(torch.FloatTensor))可选) — 预先计算的隐藏状态(自注意力块和交叉注意力块中的键和值),可用于加速顺序解码。这通常包括模型在解码的先前阶段返回的 past_key_values,当 use_cache=Trueconfig.use_cache=True 时。

    允许两种格式:

    • 一个 Cache 实例;
    • 长度为 config.n_layerstuple(tuple(torch.FloatTensor)),每个元组具有两个形状为 (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 (torch.FloatTensor 形状为 (batch_size, sequence_length, hidden_size)可选) — 可选地,而不是传递 input_ids,您可以选择直接传递嵌入表示。如果您希望比模型的内部嵌入查找矩阵更精细地控制如何将 input_ids 索引转换为关联向量,这将非常有用。
  • use_cache (bool可选) — 如果设置为 True,则返回 past_key_values 密钥值状态,可用于加速解码(请参阅 past_key_values)。
  • output_attentions (bool可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息,请参阅返回张量下的 attentions
  • output_hidden_states (bool可选) — 是否返回所有层的隐藏状态。有关更多详细信息,请参阅返回张量下的 hidden_states
  • 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] 中的标记计算。

返回

transformers.modeling_outputs.MoeCausalLMOutputWithPasttuple(torch.FloatTensor)

一个 transformers.modeling_outputs.MoeCausalLMOutputWithPast 或一个 torch.FloatTensor 的元组(如果传递了 return_dict=False 或当 config.return_dict=False 时),包含取决于配置 (GraniteMoeConfig) 和输入的各种元素。

  • 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=Trueconfig.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_layerstuple(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 后的注意力权重,用于计算自注意力头中的加权平均值。

GraniteMoeForCausalLM 前向方法覆盖了 __call__ 特殊方法。

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

示例

>>> from transformers import AutoTokenizer, GraniteMoeForCausalLM

>>> model = GraniteMoeForCausalLM.from_pretrained("ibm/PowerMoE-3b")
>>> tokenizer = AutoTokenizer.from_pretrained("ibm/PowerMoE-3b")

>>> prompt = "Hey, are you conscious? Can you talk to me?"
>>> inputs = tokenizer(prompt, return_tensors="pt")

>>> # Generate
>>> generate_ids = model.generate(inputs.input_ids, max_length=30)
>>> tokenizer.batch_decode(generate_ids, skip_special_tokens=True, clean_up_tokenization_spaces=False)[0]
"Hey, are you conscious? Can you talk to me?\nI'm not conscious, but I can talk to you."
< > 在 GitHub 上更新