Transformers 文档
FalconH1
并获得增强的文档体验
开始使用
FalconH1
概述
FalconH1 模型由 TII 预训练团队开发。一篇涵盖架构、预训练动态、实验结果和结论的综合研究论文即将发表。您可以在此网站上阅读有关该系列的更多信息。
贡献者
此模型由 DhiyaEddine、ybelkada、JingweiZuo、IlyasChahed 和 MaksimVelikanov 贡献。原始代码可以在这里找到。
FalconH1Config
| 模型 | 深度 | 维度 | 注意力头 | KV | Mamba 头 | d_head | d_state | 上下文长度 |
|---|---|---|---|---|---|---|---|---|
| H1 0.5B | 36 | 1024 | 8 | 2 | 24 | 64 / 64 | 128 | 4K, 16K-SFT |
| H1 1.5B | 24 | 2048 | 8 | 2 | 48 | 128 / 64 | 256 | 128K |
| H1 1.5B-d | 66 | 1280 | 6 | 2 | 24 | 128 / 64 | 256 | 128K |
| H1 3B | 32 | 2560 | 10 | 2 | 32 | 128 / 128 | 256 | 128K |
| H1 7B | 44 | 3072 | 12 | 2 | 24 | 128 / 128 | 256 | 256K |
| H1 34B | 72 | 5120 | 20 | 4 | 32 | 128 / 128 | 256 | 256K |
class transformers.FalconH1Config
< 来源 >( vocab_size = 128000 tie_word_embeddings = False hidden_size = 4096 intermediate_size = 14336 num_hidden_layers = 32 num_attention_heads = 32 num_key_value_heads = 8 hidden_act = 'silu' initializer_range = 0.02 rms_norm_eps = 1e-05 use_cache = True num_logits_to_keep = 1 pad_token_id = 0 bos_token_id = 1 eos_token_id = 2 max_position_embeddings = 8192 attention_dropout = 0.0 mamba_d_ssm = 1024 mamba_n_heads = 128 mamba_d_head = 'auto' mamba_n_groups = 1 mamba_d_state = 256 mamba_d_conv = 4 mamba_expand = 2 mamba_chunk_size = 256 mamba_conv_bias = True mamba_proj_bias = False mamba_norm_before_gate = True mamba_rms_norm = False projectors_bias = False rope_theta = 100000.0 rope_scaling = None lm_head_multiplier = 1.0 embedding_multiplier = 1.0 mlp_multipliers = None key_multiplier = None attention_out_multiplier = None attention_in_multiplier = None ssm_multipliers = None ssm_in_multiplier = None ssm_out_multiplier = None **kwargs )
参数
- vocab_size (
int，可选，默认为 128000) — FalconH1 模型的词汇表大小。定义了在调用 FalconH1Model 时传递的inputs_ids可以表示的不同标记的数量。 - tie_word_embeddings (
bool，可选，默认为False) — 是否应将模型的输入和输出词嵌入绑定。请注意，这仅在模型具有输出词嵌入层时才相关。 - hidden_size (
int，可选，默认为 4096) — 隐藏表示的维度。 - intermediate_size (
int，可选，默认为 14336) — MLP 表示的维度。 - num_hidden_layers (
int，可选，默认为 32) — Transformer 编码器中的隐藏层数量。 - num_attention_heads (
int，可选，默认为 32) — Transformer 编码器中每个注意力层的注意力头数量。 - num_key_value_heads (
int，可选，默认为 8) — 这是用于实现分组查询注意力 (Grouped Query Attention) 的键值头 (key_value heads) 的数量。如果num_key_value_heads=num_attention_heads，模型将使用多头注意力 (MHA)；如果num_key_value_heads=1，模型将使用多查询注意力 (MQA)；否则将使用 GQA。将多头检查点转换为 GQA 检查点时，每个组的键和值头应通过对该组内所有原始头进行均值池化来构建。更多详情，请查看这篇论文。如果未指定，将默认为8。 - hidden_act (
str或function，可选，默认为"silu") — 解码器中的非线性激活函数（函数或字符串）。 - initializer_range (
float，可选，默认为 0.02) — 用于初始化所有权重矩阵的截断正态分布初始化器的标准差。 - rms_norm_eps (
float，可选，默认为 1e-05) — RMS 归一化层使用的 epsilon 值。 - use_cache (
bool，可选，默认为True) — 模型是否应返回最后一个键/值注意力（并非所有模型都使用）。仅在config.is_decoder=True时相关。 - num_logits_to_keep (
int或None，可选，默认为 1) — 在生成过程中要计算的提示 logits 的数量。如果为None，则计算所有 logits。如果为整数值，则只计算最后num_logits_to_keep个 logits。默认为 1，因为生成时只需要最后一个提示标记的 logits。对于长序列，整个序列的 logits 可能会占用大量内存，因此将num_logits_to_keep=1可以显著减少内存占用。 - pad_token_id (
int，可选，默认为 0) — 填充标记的 ID。 - bos_token_id (
int，可选，默认为 1) — “序列开始”标记的 ID。 - eos_token_id (
int，可选，默认为 2) — “序列结束”标记的 ID。 - max_position_embeddings (
int，可选，默认为 8192) — 模型的最大缓存序列长度 - attention_dropout (
float，可选，默认为 0.0) — 注意力概率的丢弃率。 - mamba_d_ssm (
int，可选，默认为 1024) — SSM 状态空间潜变量的维度。 - mamba_n_heads (
int, 可选, 默认为 128) — 在 v2 实现中使用的 mamba头的数量。 - mamba_d_head (
int, 可选, 默认为"auto") — 头嵌入维度大小 - mamba_n_groups (
int, 可选, 默认为 1) — 在 v2 实现中使用的 mamba 组的数量。 - mamba_d_state (
int, 可选, 默认为 256) — mamba 状态空间潜变量的维度 - mamba_d_conv (
int, 可选, 默认为 4) — mamba 卷积核的大小 - mamba_expand (
int, 可选, 默认为 2) — 用于确定 mamba 中间大小的扩展因子（相对于 hidden_size） - mamba_chunk_size (
int, 可选, 默认为 256) — 在进行预填充/训练时，将序列拆分成的块大小 - mamba_conv_bias (
bool, 可选, 默认为True) — 指示是否在 mamba 混合块的卷积层中使用偏置的标志。 - mamba_proj_bias (
bool, 可选, 默认为False) — 指示是否在 mamba 混合块的输入和输出投影（[“in_proj”, “out_proj”]）中使用偏置的标志 - mamba_norm_before_gate (
bool, 可选, 默认为True) — 是否在 Mamba 块的门控之前使用 RMSNorm - mamba_rms_norm (
bool, 可选, 默认为False) — 是否在 Mamba 块中使用 RMSNorm 而不是 LayerNorm - projectors_bias (
bool, 可选, 默认为False) — 指示是否在注意力块的输入和输出投影（[“in_proj”, “out_proj”]）中使用偏置的标志 - rope_theta (
float, 可选, 默认为 100000.0) — 用于 RoPE 嵌入的 theta 值。 - rope_scaling (
float, 可选) — 用于 RoPE 嵌入的缩放值。如果为 `None`，则不应用缩放。 - lm_head_multiplier (
float, 可选, 默认为 1.0) — LM 头的乘数。用于缩放 LM 头的输出。 - embedding_multiplier (
float, 可选, 默认为 1.0) — 嵌入层的乘数。用于缩放嵌入层的输出。 - mlp_multipliers (
list[float], 可选) — MLP 层的乘数。用于缩放 MLP 层的输出。第一个值是门控层的乘数，第二个值是 down_proj 层的乘数。 - key_multiplier (
float, 可选) — 键层的乘数。用于缩放键层的输出。 - attention_out_multiplier (
float, 可选) — 注意力输出层的乘数。用于缩放注意力输出。 - attention_in_multiplier (
float, 可选) — 注意力输入层的乘数。用于缩放注意力输入层的输出。 - ssm_multipliers (
list[float], 可选) — SSM 层的乘数。用于缩放 SSM 层的输出。 - ssm_in_multiplier (
float, 可选) — SSM 输入层的乘数。用于缩放 SSM 输入层的输出。 - ssm_out_multiplier (
float, 可选) — SSM 输出层的乘数。用于缩放 SSM 输出层的输出。
这是用于存储 FalconH1Model 配置的配置类。它用于根据指定的参数实例化 FalconH1Model 模型，定义模型架构。使用从 ibm-fms/FalconH1-9.8b-2.2T-hf 获取的默认值实例化配置。FalconH1Model 是一种混合了 SwiGLU 的 mamba2 架构。这些检查点由 IBM、普林斯顿大学和伊利诺伊大学厄巴纳-香槟分校联合训练。配置对象继承自 PretrainedConfig，可用于控制模型输出。请阅读 PretrainedConfig 的文档以获取更多信息。
FalconH1ForCausalLM
from transformers import AutoModelForCausalLM, AutoTokenizer
model = AutoModelForCausalLM.from_pretrained("tiiuae/Falcon-H1-7B-Instruct")
tokenizer = AutoTokenizer.from_pretrained("tiiuae/Falcon-H1-7B-Instruct")
message = ["Mamba is a snake with following properties "]
inputs = tokenizer(message, return_tensors='pt', return_token_type_ids=False)
response = model.generate(**inputs, max_new_tokens=64)
print(tokenizer.batch_decode(response, skip_special_tokens=True)[0])class transformers.FalconH1ForCausalLM
< source >( config )
参数
- config (FalconH1ForCausalLM) — 包含模型所有参数的模型配置类。使用配置文件进行初始化不会加载与模型相关的权重，只会加载配置。请查看 from_pretrained() 方法来加载模型权重。
用于因果语言建模的 Falcon H1 模型。
此模型继承自 PreTrainedModel。请查看超类文档以了解该库为其所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、修剪注意力头等）。
该模型也是 PyTorch torch.nn.Module 的子类。可以像常规 PyTorch 模块一样使用它，并参考 PyTorch 文档了解所有与常规用法和行为相关的事项。
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.models.falcon_h1.modeling_falcon_h1.FalconHybridMambaAttentionDynamicCache] = 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 cache_position: typing.Optional[torch.LongTensor] = None logits_to_keep: typing.Union[int, torch.Tensor] = 0 **kwargs ) → transformers.modeling_outputs.CausalLMOutputWithPast 或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensor，形状为(batch_size, sequence_length)) — 词汇表中输入序列词元的索引。默认情况下将忽略填充。可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
torch.Tensor，形状为(batch_size, sequence_length), 可选) — 用于避免对填充词元索引执行注意力的掩码。掩码值选自[0, 1]：- 1 表示**未被掩码**的词元，
- 0 表示**被掩码**的词元。
- position_ids (
torch.LongTensor，形状为(batch_size, sequence_length), 可选) — 每个输入序列词元在位置嵌入中的位置索引。选定范围为[0, config.n_positions - 1]。 - past_key_values (
~models.falcon_h1.modeling_falcon_h1.FalconHybridMambaAttentionDynamicCache, 可选) — 预计算的隐藏状态（自注意力和交叉注意力块中的键和值），可用于加速序列解码。这通常包括在解码的先前阶段由模型返回的 `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`（那些没有为其提供过去键值状态的 `input_ids`），形状为 `(batch_size, 1)`，而不是所有形状为 `(batch_size, sequence_length)` 的 `input_ids`。
- inputs_embeds (
torch.FloatTensor，形状为(batch_size, sequence_length, hidden_size), 可选) — 可选地，您可以选择直接传递嵌入表示，而不是传递input_ids。如果您希望比模型内部的嵌入查找矩阵更能控制如何将input_ids索引转换为关联向量，这将非常有用。 - labels (
torch.LongTensor，形状为(batch_size, sequence_length), 可选) — 用于计算掩码语言建模损失的标签。索引应在[0, ..., config.vocab_size]或 -100 之间（请参阅input_ids文档字符串）。索引设置为-100的词元将被忽略（掩码），损失仅对标签在[0, ..., config.vocab_size]内的词元计算。 - use_cache (
bool, 可选) — 如果设置为True，则返回past_key_values键值状态，可用于加速解码（请参阅past_key_values）。 - output_attentions (
bool, 可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参阅返回张量下的 `attentions`。 - output_hidden_states (
bool, 可选) — 是否返回所有层的隐藏状态。有关更多详细信息，请参阅返回张量下的 `hidden_states`。 - cache_position (
torch.LongTensor，形状为(sequence_length), 可选) — 描绘输入序列词元在序列中位置的索引。与 `position_ids` 不同，此张量不受填充影响。它用于在正确的位置更新缓存并推断完整的序列长度。 - logits_to_keep (
Union[int, torch.Tensor], 默认为0) — 如果是 `int`，则计算最后 `logits_to_keep` 个词元的 logits。如果是 `0`，则计算所有 `input_ids` 的 logits（特殊情况）。生成时只需要最后一个词元的 logits，仅为该词元计算 logits 可以节省内存，这对于长序列或大词汇表来说非常重要。如果是 `torch.Tensor`，则必须是 1D，对应于序列长度维度中要保留的索引。当使用打包张量格式（批处理和序列长度使用单个维度）时，这非常有用。
返回
transformers.modeling_outputs.CausalLMOutputWithPast 或 tuple(torch.FloatTensor)
一个 transformers.modeling_outputs.CausalLMOutputWithPast 或一个 `torch.FloatTensor` 元组（如果传递了 `return_dict=False` 或当 `config.return_dict=False` 时），根据配置（FalconH1Config）和输入，包含各种元素。
-
loss (
torch.FloatTensor形状为(1,)，可选，当提供labels时返回) — 语言建模损失（用于下一个 token 预测）。 -
logits (形状为
(batch_size, sequence_length, config.vocab_size)的torch.FloatTensor) — 语言建模头部的预测分数（SoftMax 之前的每个词汇标记的分数）。 -
past_key_values (
Cache, 可选, 当传递 `use_cache=True` 或 `config.use_cache=True` 时返回) — 这是一个 Cache 实例。有关更多详细信息，请参阅我们的 kv 缓存指南。包含预计算的隐藏状态（自注意力块中的键和值），可用于（参见
past_key_values输入）加速顺序解码。 -
hidden_states (
tuple(torch.FloatTensor), 可选, 当传递 `output_hidden_states=True` 或 `config.output_hidden_states=True` 时返回) — 形状为 `(batch_size, sequence_length, hidden_size)` 的 `torch.FloatTensor` 元组（如果模型有嵌入层，则第一个是嵌入层的输出，然后是每个层的输出）。模型在每个层输出的隐藏状态以及可选的初始嵌入输出。
-
attentions (
tuple(torch.FloatTensor), 可选, 当传递 `output_attentions=True` 或 `config.output_attentions=True` 时返回) — 形状为 `(batch_size, num_heads, sequence_length, sequence_length)` 的 `torch.FloatTensor` 元组（每层一个）。注意力 softmax 后的注意力权重，用于计算自注意力头中的加权平均值。
FalconH1ForCausalLM 的 forward 方法覆盖了 `__call__` 特殊方法。
虽然前向传播的流程需要在此函数中定义，但之后应该调用 `Module` 实例而不是这个函数，因为前者会处理前处理和后处理步骤，而后者会静默地忽略它们。
示例
>>> from transformers import AutoTokenizer, FalconH1ForCausalLM
>>> model = FalconH1ForCausalLM.from_pretrained("...")
>>> tokenizer = AutoTokenizer.from_pretrained("...")
>>> 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."此 HF 实现由 younesbelkada 和 DhiaEddineRhaiem 贡献。
< > 在 GitHub 上更新