Transformers 文档

花岗岩

Hugging Face's logo
加入 Hugging Face 社区

并获取增强文档体验

开始使用

花岗岩

概述

花岗岩模型由 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 中提出。

PowerLM-3B 是一个 30 亿参数的、最先进的小型语言模型,使用 Power 学习率调度器训练。它在大量使用宽松许可证的开源和合成数据集上进行训练。PowerLM-3B 在各种基准测试中(包括自然语言多项选择、代码生成和数学推理)显示出比同等规模模型更有希望的结果。

论文中的摘要如下:

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

提示

import torch
from transformers import AutoModelForCausalLM, AutoTokenizer

model_path = "ibm/PowerLM-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 贡献。

GraniteConfig

class transformers.GraniteConfig

< >

( 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 mlp_bias = False embedding_multiplier = 1.0 logits_scaling = 1.0 residual_multiplier = 1.0 attention_multiplier = 1.0 **kwargs )

参数

  • vocab_size (int, optional, defaults to 32000) — Granite 模型的词汇量。定义了调用 GraniteModel 时传递的 inputs_ids 可表示的不同令牌数量。
  • hidden_size (int, optional, defaults to 4096) — 隐藏表示的维度。
  • intermediate_size (int, optional, defaults to 11008) — MLP 表示的维度。
  • num_hidden_layers (int, optional, defaults to 32) — Transformer 解码器中的隐藏层数。
  • num_attention_heads (int, optional, defaults to 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 时相关。
  • pad_token_id (int, 可选) — 填充令牌 ID。
  • bos_token_id (int, 可选, 默认为 1) — 流的开始令牌 ID。
  • eos_token_id (int, 可选, 默认为 2) — 流的结束令牌 ID。
  • tie_word_embeddings (bool, 可选, 默认为 False) — 是否绑定权重嵌入。
  • rope_scaling (Dict, optional) — 包含 RoPE 嵌入缩放配置的字典。目前支持两种缩放策略:线性缩放和动态缩放。它们的缩放因子必须是大于 1 的浮点数。预期格式为 {"type": 缩放策略名称, "factor": 缩放因子}。使用此标记时,不要将 max_position_embeddings 更新为预期的新的最大值。有关这些缩放策略行为的更多信息,请参阅以下主题: https://www.reddit.com/r/LocalLLaMA/comments/14mrgpr/dynamically_scaled_rope_further_increases/。这是一个实验性功能,将来版本中可能会发生 API 更改。
  • attention_bias (bool, optional, defaults to False) — 是否在自注意力期间的查询、键、值和输出投影层中使用偏差。
  • attention_dropout (float, optional, defaults to 0.0) — 注意概率的 dropout 率。
  • mlp_bias (bool, optional, defaults to False) — 是否在 MLP 层中的 up_proj、down_proj 和 gate_proj 层中使用偏差。
  • embedding_multiplier (float, optional, defaults to 1.0) — 嵌入乘数
  • logits_scaling (float, optional, defaults to 1.0) — 输出 logits 的除数
  • residual_multiplier (float, optional, defaults to 1.0) — 残差乘数
  • attention_multiplier (float, optional, defaults to 1.0) — 注意力乘数

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

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

>>> from transformers import GraniteModel, GraniteConfig

>>> # Initializing a Granite granite-3b style configuration
>>> configuration = GraniteConfig()

>>> # Initializing a model from the granite-7b style configuration
>>> model = GraniteModel(configuration)

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

GraniteModel

class transformers.GraniteModel

< >

( config: GraniteConfig )

参数

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

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

    前向

    < >

    ( 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 return_dict: Optional = None cache_position: Optional = None )

    参数

    • 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(那些没有提供过去键值状态给该模型的 input_ids),形状为 (batch_size, 1),而不是所有 input_ids,形状为 (batch_size, sequence_length)

      如果您想更改填充行为,您应该阅读 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 实例,请参阅我们的 kv 缓存指南
      • 长度为 config.n_layerstuple(tuple(torch.FloatTensor)),每个元组包含 2 个形状为 (batch_size, num_heads, sequence_length, embed_size_per_head) 的张量)。这也是已知的传统缓存格式。

      模型将输出与输入相同格式的缓存。如果未传递 past_key_values,将返回传统缓存格式。

      如果您使用 past_key_values,用户可以选择仅输入最后一个 input_ids(那些没有提供过去键值状态给该模型的 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 不同,该张量不受填充的影响。 它用于在正确的位置更新缓存并推断完整的序列长度。

    GraniteModel 正向方法覆盖了 __call__ 特殊方法。

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

GraniteForCausalLM

class transformers.GraniteForCausalLM

< >

( config )

前向

< >

( input_ids: LongTensor = None attention_mask: 可选 = None position_ids: 可选 = None past_key_values: Union = None inputs_embeds: 可选 = None labels: 可选 = None use_cache: 可选 = None output_attentions: 可选 = None output_hidden_states: 可选 = None return_dict: 可选 = None cache_position: 可选 = None ) transformers.modeling_outputs.CausalLMOutputWithPasttuple(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(那些没有将其过去键值状态提供给此模型的 input_ids)(形状为 (batch_size, 1)),而不是所有 input_ids(形状为 (batch_size, sequence_length))。

    如果您想更改填充行为,则应阅读 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 实例,请参阅我们的 kv 缓存指南
    • tuple(torch.FloatTensor) 的元组,长度为 config.n_layers,每个元组包含 2 个形状为 (batch_size, num_heads, sequence_length, embed_size_per_head) 的张量。这也称为传统缓存格式。

    模型将输出与输入相同格式的缓存。如果没有传递 past_key_values,则将返回传统缓存格式。

    如果使用了 past_key_values,则用户可以选择仅输入最后一个 input_ids(那些没有将其过去键值状态提供给此模型的 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.CausalLMOutputWithPasttuple(torch.FloatTensor)

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

  • loss (torch.FloatTensor 形状为 (1,), 可选,当提供 labels 时返回) — 语言建模损失(用于下一个令牌预测)。

  • logits (torch.FloatTensor 形状为 (batch_size, sequence_length, config.vocab_size)) — 语言建模头的预测分数(SoftMax 之前的每个词汇表令牌的分数)。

  • past_key_values (tuple(tuple(torch.FloatTensor)), 可选,当传递 use_cache=True 或当 config.use_cache=True 时返回) — tuple(torch.FloatTensor) 元组,长度为 config.n_layers,每个元组具有 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 GraniteForCausalLM 正向方法,覆盖了 __call__ 特殊方法。

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

示例

>>> from transformers import AutoTokenizer, GraniteForCausalLM

>>> model = GraniteForCausalLM.from_pretrained("ibm/PowerLM-3b")
>>> tokenizer = AutoTokenizer.from_pretrained("ibm/PowerLM-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."
< > Update on GitHub