Transformers 文档
Granite
并获得增强的文档体验
开始使用
Granite
概述
Granite 模型在 Power Scheduler: A Batch Size and Token Number Agnostic Learning Rate Scheduler 中被提出，作者为 Yikang Shen, Matthew Stallone, Mayank Mishra, Gaoyuan Zhang, Shawn Tan, Aditya Prasad, Adriana Meza Soria, David D. Cox 和 Rameswar Panda。
PowerLM-3B 是一个先进的 3B 小型语言模型，使用 Power 学习率调度器进行训练。它在各种具有宽松许可的开源和合成数据集上进行训练。PowerLM-3B 在各种基准测试中，包括自然语言多项选择、代码生成和数学推理，与其他同等规模的模型相比，显示出令人鼓舞的结果。
以下是论文的摘要
为语言模型预训练找到最佳学习率是一项具有挑战性的任务。这不仅是因为学习率、批大小、训练 tokens 数量、模型大小和其他超参数之间存在复杂的关联，还因为对具有数十亿或数万亿参数的大型语言模型执行超参数搜索的成本过高。最近的研究提出使用小型代理模型和小语料库来执行超参数搜索，并将最佳参数转移到大型模型和大型语料库。虽然对于模型大小相关的超参数（如深度和宽度），零样本可迁移性在理论和实践上都得到了证明，但从小语料库到大语料库的零样本迁移性尚未得到充分探索。在本文中，我们研究了最近提出的 WSD 调度器的最佳学习率、批大小和训练 tokens 数量之间的相关性。经过数千次小型实验，我们发现了变量之间的幂律关系，并证明了其在不同模型大小之间的可迁移性。基于这一观察，我们提出了一种新的学习率调度器，Power 调度器，它与训练 tokens 数量和批大小无关。实验表明，将 Power 调度器与最大更新参数化（\mup）相结合，可以在一组超参数下，无论训练 tokens 数量、批大小、模型大小甚至模型架构如何，都能始终如一地实现令人印象深刻的性能。我们使用 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
< source >( 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, 可选, 默认为 32000) — Granite 模型的词汇表大小。定义了在调用 GraniteModel 时传递的inputs_ids可以表示的不同 tokens 的数量 - 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, 可选) — 这是应该用于实现分组查询注意力的 key_value 头数。如果num_key_value_heads=num_attention_heads，模型将使用多头注意力（MHA），如果num_key_value_heads=1模型将使用多查询注意力（MQA），否则使用 GQA。当将多头检查点转换为 GQA 检查点时，每个组的 key 和 value 头应该通过对该组内所有原始头进行平均池化来构建。有关更多详细信息，请查看 本文。如果未指定，则默认为num_attention_heads。 - hidden_act (
str或function, 可选, 默认为"silu") — 解码器中的非线性激活函数（函数或字符串）。 - max_position_embeddings (
int, 可选, 默认为 2048) — 此模型可能使用的最大序列长度。 - initializer_range (
float, 可选, 默认为 0.02) — 用于初始化所有权重矩阵的 truncated_normal_initializer 的标准差。 - rms_norm_eps (
float, 可选, 默认为 1e-06) — rms 归一化层使用的 epsilon 值。 - use_cache (
bool, 可选, 默认为True) — 模型是否应返回最后一次的键/值注意力（并非所有模型都使用）。仅在config.is_decoder=True时相关。 - pad_token_id (
int, 可选) — 填充 token id。 - bos_token_id (
int, 可选, 默认为 1) — 流开始 token id。 - eos_token_id (
int, 可选, 默认为 2) — 流结束 token 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) — 在自注意力期间，是否在 query、key、value 和输出投影层中使用偏置。 - attention_dropout (
float, optional, defaults to 0.0) — 用于注意力概率的 dropout 比率。 - mlp_bias (
bool, optional, defaults toFalse) — 是否在 MLP 层中的 up_proj、down_proj 和 gate_proj 层中使用 bias。 - 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.configGraniteModel
class transformers.GraniteModel
< source >( config: GraniteConfig )
参数
- config (GraniteConfig) — 带有模型所有参数的模型配置类。使用配置文件初始化不会加载与模型关联的权重，仅加载配置。查看 from_pretrained() 方法以加载模型权重。
- config — GraniteConfig
裸 Granite 模型，输出原始隐藏状态，顶部没有任何特定的 head。此模型继承自 PreTrainedModel。查看超类文档，了解库为其所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、剪枝 head 等）。
此模型也是 PyTorch torch.nn.Module 子类。将其用作常规 PyTorch 模块，并参阅 PyTorch 文档，了解与常规用法和行为相关的所有事项。
Transformer 解码器，由 config.num_hidden_layers 层组成。每一层都是一个 GraniteDecoderLayer。
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[transformers.cache_utils.Cache] = 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 return_dict: typing.Optional[bool] = None cache_position: typing.Optional[torch.LongTensor] = None **flash_attn_kwargs: typing_extensions.Unpack[transformers.modeling_flash_attention_utils.FlashAttentionKwargs] )
参数
- input_ids (
torch.LongTensor, 形状为(batch_size, sequence_length)) — 词汇表中输入序列标记的索引。如果您提供填充，默认情况下将忽略填充。索引可以使用 AutoTokenizer 获得。 有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
torch.Tensor, 形状为(batch_size, sequence_length), optional) — 用于避免对 padding 标记索引执行注意力的掩码。在[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 表示 head 未被掩蔽，
- 0 表示 head 被掩蔽。
- position_ids (
torch.LongTensor, 形状为(batch_size, sequence_length), optional) — 每个输入序列标记在位置嵌入中的位置索引。在范围[0, config.n_positions - 1]中选择。 - past_key_values (
Cache或tuple(tuple(torch.FloatTensor)), optional) — 预先计算的隐藏状态（自注意力模块和交叉注意力模块中的键和值），可用于加速顺序解码。这通常包括模型在先前解码阶段返回的past_key_values，当use_cache=True或config.use_cache=True时。允许两种格式：
- Cache 实例，请参阅我们的 kv 缓存指南；
- 长度为
config.n_layers的tuple(torch.FloatTensor)元组，每个元组有 2 个形状为(batch_size, num_heads, sequence_length, embed_size_per_head)的张量。这也称为旧版缓存格式。
模型将输出与作为输入提供的缓存格式相同的格式。如果未传递
past_key_values，则将返回旧版缓存格式。如果使用
past_key_values，用户可以选择仅输入最后一个input_ids（那些没有将其过去键值状态提供给此模型的）形状为(batch_size, 1)，而不是所有形状为(batch_size, sequence_length)的input_ids。 - inputs_embeds (
torch.FloatTensor, 形状为(batch_size, sequence_length, hidden_size), optional) — 可选地，您可以选择直接传递嵌入表示，而不是传递input_ids。如果您希望比模型的内部嵌入查找矩阵更精细地控制如何将input_ids索引转换为关联向量，这将非常有用。 - use_cache (
bool, optional) — 如果设置为True，则返回past_key_values键值状态，并且可以用于加速解码（请参阅past_key_values）。 - output_attentions (
bool, optional) — 是否返回所有注意力层的注意力张量。 有关更多详细信息，请参阅返回张量下的attentions。 - output_hidden_states (
bool, optional) — 是否返回所有层的隐藏状态。 有关更多详细信息，请参阅返回张量下的hidden_states。 - return_dict (
bool, optional) — 是否返回 ModelOutput 而不是普通元组。 - cache_position (
torch.LongTensor, 形状为(sequence_length), optional) — 描述输入序列标记在序列中位置的索引。与position_ids相反，此张量不受填充的影响。它用于在正确的位置更新缓存并推断完整的序列长度。
GraniteModel forward 方法，覆盖了 __call__ 特殊方法。
尽管 forward 传递的配方需要在该函数中定义，但之后应该调用 Module 实例而不是此函数，因为前者负责运行预处理和后处理步骤，而后者会默默地忽略它们。
GraniteForCausalLM
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[transformers.cache_utils.Cache, typing.List[torch.FloatTensor], 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 cache_position: typing.Optional[torch.LongTensor] = None logits_to_keep: typing.Union[int, torch.Tensor] = 0 **kwargs: typing_extensions.Unpack[transformers.models.granite.modeling_granite.KwargsForCausalLM] ) → transformers.modeling_outputs.CausalLMOutputWithPast 或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensor, 形状为(batch_size, sequence_length)) — 词汇表中输入序列 tokens 的索引。如果您提供 padding，默认情况下 padding 将被忽略。索引可以使用 AutoTokenizer 获得。 有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
torch.Tensor, 形状为(batch_size, sequence_length), 可选) — 用于避免在 padding token 索引上执行 attention 的 Mask。 Mask 值在[0, 1]中选择：- 1 表示 tokens 未被 masked，
- 0 表示 tokens 被 masked。
索引可以使用 AutoTokenizer 获得。 有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
如果使用了
past_key_values，则可以选择只输入最后的input_ids（请参阅past_key_values）。如果您想更改 padding 行为，您应该阅读
modeling_opt._prepare_decoder_attention_mask并根据您的需求进行修改。 有关默认策略的更多信息，请参阅 论文 中的图 1。- 1 表示 head 未被 masked，
- 0 表示 head 被 masked。
- position_ids (
torch.LongTensor, 形状为(batch_size, sequence_length), 可选) — 每个输入序列 token 在 position embeddings 中的位置索引。 在范围[0, config.n_positions - 1]中选择。 - past_key_values (
Cache或tuple(tuple(torch.FloatTensor)), 可选) — 预先计算的 hidden-states （self-attention 块和 cross-attention 块中的 key 和 values），可用于加速顺序解码。 这通常包括模型在先前解码阶段返回的past_key_values，当use_cache=True或config.use_cache=True时。允许两种格式：
- Cache 实例，请参阅我们的 kv cache 指南；
- 长度为
config.n_layers的tuple(torch.FloatTensor)的元组，每个元组有 2 个形状为(batch_size, num_heads, sequence_length, embed_size_per_head)的 tensors。 这也称为旧版 cache 格式。
模型将输出与作为输入提供的 cache 格式相同的格式。 如果没有传递
past_key_values，将返回旧版 cache 格式。如果使用了
past_key_values，用户可以选择只输入最后的input_ids（那些没有将其 past key value states 提供给此模型的 ），形状为(batch_size, 1)，而不是所有形状为(batch_size, sequence_length)的input_ids。 - inputs_embeds (
torch.FloatTensor, 形状为(batch_size, sequence_length, hidden_size), 可选) — （可选）您可以选择直接传递嵌入表示，而不是传递input_ids。 如果您希望比模型的内部 embedding lookup matrix 更好地控制如何将input_ids索引转换为关联的 vectors，这将非常有用。 - use_cache (
bool, 可选) — 如果设置为True，则返回past_key_valueskey value states，并可用于加速解码（请参阅past_key_values）。 - output_attentions (
bool, 可选) — 是否返回所有 attention 层的 attentions tensors。 有关更多详细信息，请参阅返回 tensors 下的attentions。 - output_hidden_states (
bool, 可选) — 是否返回所有层的 hidden states。 有关更多详细信息，请参阅返回 tensors 下的hidden_states。 - return_dict (
bool, 可选) — 是否返回 ModelOutput 而不是普通 tuple。 - cache_position (
torch.LongTensor, 形状为(sequence_length), 可选) — 描述输入序列 tokens 在序列中位置的索引。 与position_ids相反，此 tensor 不受 padding 的影响。 它用于在正确的位置更新 cache 并推断完整序列长度。 - labels (
torch.LongTensor, 形状为(batch_size, sequence_length), 可选) — 用于计算 masked language modeling loss 的标签。 索引应为[0, ..., config.vocab_size]或 -100 （请参阅input_idsdocstring）。 索引设置为-100的 tokens 将被忽略（masked），loss 仅针对标签在[0, ..., config.vocab_size]中的 tokens 计算。 - logits_to_keep (
int或torch.Tensor, 可选) — 如果是int，则计算最后logits_to_keep个 tokens 的 logits。 如果为0，则计算所有input_ids的 logits （特殊情况）。 生成只需要最后一个 token logits，并且仅针对该 token 计算它们可以节省内存，这对于长序列或大型词汇表大小而言变得非常重要。 如果是torch.Tensor，则必须是 1D，对应于要在序列长度维度中保留的索引。 这在使用 packed tensor 格式（批次和序列长度的单个维度）时很有用。
返回
transformers.modeling_outputs.CausalLMOutputWithPast 或 tuple(torch.FloatTensor)
transformers.modeling_outputs.CausalLMOutputWithPast 或 torch.FloatTensor 的 tuple （如果传递了 return_dict=False 或当 config.return_dict=False 时），包括各种元素，具体取决于配置 (GraniteConfig) 和输入。
-
loss (
torch.FloatTensor, 形状为(1,), 可选, 当提供labels时返回) — 语言建模 loss （用于下一个 token 预测）。 -
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)的 tensors)包含预先计算的 hidden-states （self-attention 块中的 key 和 values），可用于加速顺序解码（请参阅
past_key_values输入）。 -
hidden_states (
tuple(torch.FloatTensor), 可选, 当传递了output_hidden_states=True或当config.output_hidden_states=True时返回) —torch.FloatTensor的 tuple （如果模型具有 embedding 层，则embeddings 的输出为 1 个，+ 每层的输出为 1 个），形状为(batch_size, sequence_length, hidden_size)。模型在每层输出处的 Hidden-states 加上可选的初始 embedding 输出。
-
attentions (
tuple(torch.FloatTensor), 可选, 当传递了output_attentions=True或当config.output_attentions=True时返回) —torch.FloatTensor的 tuple （每层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。attention softmax 之后的 Attentions weights，用于计算 self-attention heads 中的加权平均值。
GraniteForCausalLM forward 方法，覆盖了 __call__ 特殊方法。
尽管 forward 传递的配方需要在该函数中定义，但之后应该调用 Module 实例而不是此函数，因为前者负责运行预处理和后处理步骤，而后者会默默地忽略它们。
示例
>>> from transformers import AutoTokenizer, GraniteForCausalLM
>>> model = GraniteForCausalLM.from_pretrained("meta-granite/Granite-2-7b-hf")
>>> tokenizer = AutoTokenizer.from_pretrained("meta-granite/Granite-2-7b-hf")
>>> 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."