Falcon
概述
Falcon是由 TII构建的一类仅解码器的因果模型。最大的 Falcon 检查点已经在超过 1 万亿个文本标记上进行了训练，特别关注 RefinedWeb 语料库。它们在 Apache 2.0 许可下提供。
Falcon 的架构非常现代化，并针对推理进行了优化，它采用了多查询注意力机制，并支持 FlashAttention 等高效的注意力变体。该模型提供两种版本：“基础”模型，仅作为因果语言模型进行训练；以及“指令”模型，在基础模型之上进行了进一步的微调。
截至 2023 年，Falcon 模型是规模最大、性能最强大的开源语言模型之一，并且在 OpenLLM 排行榜 上始终名列前茅。
转换自定义检查点
Falcon 模型最初作为自定义代码检查点添加到 Hugging Face Hub。但是，Falcon 现在在 Transformers 库中获得了全面支持。如果您从自定义代码检查点微调了一个模型，我们建议您将检查点转换为新的库内格式，因为这应该会显著提高稳定性和性能，尤其是在生成方面，并且无需再使用 trust_remote_code=True！
您可以使用 Transformers 库的 Falcon 模型目录 中的 convert_custom_code_checkpoint.py 脚本将自定义代码检查点转换为完整的 Transformers 检查点。要使用此脚本，只需使用 python convert_custom_code_checkpoint.py --checkpoint_dir my_model 调用它即可。这将原地转换您的检查点，之后您可以立即使用例如 from_pretrained() 从目录中加载它。如果您的模型尚未上传到 Hub，我们建议您在尝试转换之前进行备份，以防万一！
FalconConfig
类 transformers.FalconConfig
< 源代码 >( vocab_size = 65024 hidden_size = 4544 num_hidden_layers = 32 num_attention_heads = 71 num_ln_in_parallel_attn = None layer_norm_epsilon = 1e-05 initializer_range = 0.02 use_cache = True hidden_dropout = 0.0 attention_dropout = 0.0 num_kv_heads = None alibi = False new_decoder_architecture = False multi_query = True parallel_attn = True bias = False max_position_embeddings = 2048 rope_theta = 10000.0 rope_scaling = None bos_token_id = 11 eos_token_id = 11 ffn_hidden_size = None activation = 'gelu' **kwargs )
参数
- vocab_size (
int, 可选, 默认为 65024) — Falcon 模型的词汇表大小。 定义了在调用 FalconModel 时传递的inputs_ids可以表示的不同标记的数量。 - hidden_size (
int, 可选, 默认为 4544) — 隐藏表示的维度。 - num_hidden_layers (
int, 可选, 默认为 32) — Transformer 解码器中的隐藏层数。 - num_attention_heads (
int, 可选, 默认为 71) — Transformer 编码器中每个注意力层的注意力头数。 - num_ln_in_parallel_attn (
int, 可选) — 如果在使用并行注意力时要对 MLP 和注意力输出使用单独的层规范化，则设置为 2，否则为 1。 - layer_norm_epsilon (
float, 可选, 默认为 1e-05) — 层归一化层使用的 epsilon 值。 - initializer_range (
float, 可选, 默认为 0.02) — 用于初始化所有权重矩阵的 truncated_normal_initializer 的标准差。 - use_cache (
bool, 可选, 默认为True) — 模型是否应返回最后的键/值注意力（并非所有模型都使用）。 仅在config.is_decoder=True时相关。 - hidden_dropout (
float, 可选, 默认值为 0.0) — MLP 层的 dropout 概率。 - attention_dropout (
float, 可选, 默认值为 0.0) — 注意力层的 dropout 概率。 - num_kv_heads (
int, 可选) — 每个注意力层使用的键值头的数量。如果未设置，则默认为与num_attention_heads相同的值。 - alibi (
bool, 可选, 默认值为False) — 是否在自注意力期间使用 ALiBi 位置偏差。 - new_decoder_architecture (
bool, 可选, 默认值为False) — 是否使用新的 (Falcon-40B) 解码器架构。如果为True，则忽略multi_query和parallel_attn参数，因为新的解码器始终使用并行注意力。 - multi_query (
bool, 可选, 默认值为True) — 是否在解码器中使用多查询注意力。当new_decoder_architecture为True时忽略。 - parallel_attn (
bool, 可选, 默认值为True) — 是否与前馈层并行计算注意力。如果为 False，则它们按顺序排列，如原始 Transformer 架构中那样。当new_decoder_architecture为True时忽略。 - bias (
bool, 可选, 默认为False) — 是否在线性层上使用偏差。 - max_position_embeddings (
int, 可选, 默认为 2048) — 当alibi为False时，此模型可能使用的最大序列长度。使用 RoPE 的预训练 Falcon 模型最多支持 2048 个标记。 - rope_theta (
float, 可选, 默认为 10000.0) — RoPE 嵌入的基周期。 - rope_scaling (
Dict, 可选) — 包含 RoPE 嵌入的缩放配置的字典。注意：如果您应用了新的 rope 类型并且您希望模型在更长的max_position_embeddings上工作，我们建议您相应地更新此值。预期内容：rope_type(str): 要使用的 RoPE 子变体。可以是 [‘default’, ‘linear’, ‘dynamic’, ‘yarn’, ‘longrope’, ‘llama3’] 中的一个，其中 ‘default’ 是原始的 RoPE 实现。factor(float, 可选): 用于除 ‘default’ 之外的所有 rope 类型。应用于 RoPE 嵌入的缩放因子。在大多数缩放类型中，x 的factor将使模型能够处理长度为 x * 原始最大预训练长度的序列。original_max_position_embeddings(int, 可选): 与 ‘dynamic’, ‘longrope’ 和 ‘llama3’ 一起使用。预训练期间使用的原始最大位置嵌入。attention_factor(float, 可选): 与 ‘yarn’ 和 ‘longrope’ 一起使用。要应用于注意力计算的缩放因子。如果未指定，则默认为实现建议的值，使用factor字段推断建议值。beta_fast(float, 可选): 仅与 ‘yarn’ 一起使用。用于设置线性斜坡函数中外推（仅）边界的参数。如果未指定，则默认为 32。beta_slow(float, 可选): 仅与 ‘yarn’ 一起使用。用于设置线性斜坡函数中插值（仅）边界的参数。如果未指定，则默认为 1。short_factor(List[float], 可选): 仅与 ‘longrope’ 一起使用。要应用于短上下文（<original_max_position_embeddings）的缩放因子。必须是数字列表，其长度与隐藏大小除以注意力头数再除以 2 相同long_factor(List[float], 可选): 仅与 ‘longrope’ 一起使用。要应用于长上下文（<original_max_position_embeddings）的缩放因子。必须是数字列表，其长度与隐藏大小除以注意力头数再除以 2 相同low_freq_factor(float, 可选): 仅与 ‘llama3’ 一起使用。应用于 RoPE 低频分量的缩放因子high_freq_factor(float, 可选): 仅与 ‘llama3’ 一起使用。应用于 RoPE 高频分量的缩放因子 - bos_token_id (
int, 可选, 默认为 11) — “序列开始”标记的 ID。 - eos_token_id (
int, 可选, 默认为 11) — “序列结束”标记的 ID。 - ffn_hidden_size (
int, *可选*) — Transformer 解码器中前馈层的隐藏大小。默认为 4 倍隐藏维度 - activation (
str, *可选*, 默认为"gelu") — 前馈层中使用的激活函数。
这是用于存储 FalconModel 配置的配置类。它用于根据指定的参数实例化 Falcon 模型，定义模型架构。使用默认值实例化配置将产生与 tiiuae/falcon-7b 架构相似的配置。
配置对象继承自 PretrainedConfig，可用于控制模型输出。有关更多信息，请阅读 PretrainedConfig 的文档。
示例
>>> from transformers import FalconModel, FalconConfig
>>> # Initializing a small (2-layer) Falcon configuration
>>> configuration = FalconConfig(num_hidden_layers=2)
>>> # Initializing a model from the small configuration
>>> model = FalconModel(configuration)
>>> # Accessing the model configuration
>>> configuration = model.configFalconModel
类 transformers.FalconModel
< 来源 >( config: FalconConfig )
参数
- config (FalconConfig) — 包含模型所有参数的模型配置类。使用配置文件初始化不会加载与模型关联的权重，只会加载配置。查看 from_pretrained() 方法以加载模型权重。
裸 Falcon 模型转换器，输出原始隐藏状态，顶部没有任何特定头部。
此模型继承自 PreTrainedModel。有关库为其所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小等），请查看超类文档。
此模型也是 PyTorch torch.nn.Module 子类。将其用作常规 PyTorch 模块，并参考 PyTorch 文档以获取有关一般用法和行为的所有内容。
forward
< 来源 >( input_ids: Optional = None past_key_values: Union = None attention_mask: Optional = None position_ids: Optional = None head_mask: Optional = 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 ) → transformers.modeling_outputs.BaseModelOutputWithPastAndCrossAttentions 或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensor，形状为(batch_size, input_ids_length)) — 如果past_key_values为None，则input_ids_length=sequence_length；否则，input_ids_length=past_key_values[0][0].shape[2]（输入的过去键值状态的sequence_length）。词汇表中输入序列标记的索引。如果使用
past_key_values，则只应将尚未计算其过去的input_ids作为input_ids传递。索引可以使用 AutoTokenizer 获取。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- past_key_values (
Cache或tuple(tuple(torch.FloatTensor))，可选) — 预先计算的隐藏状态（自注意力块和交叉注意力块中的键和值），可用于加速序列解码。这通常包括在解码的先前阶段，当use_cache=True或config.use_cache=True时，模型返回的past_key_values。允许使用两种格式：
- Cache 实例，请参阅我们的 kv 缓存指南；
- 长度为
config.n_layers的tuple(tuple(torch.FloatTensor))元组，每个元组包含 2 个形状为(batch_size, num_heads, sequence_length, embed_size_per_head)的张量。这也被称为旧版缓存格式。
模型将输出与其输入相同的缓存格式。如果没有传递
past_key_values，则将返回旧版缓存格式。如果使用
past_key_values，则用户可以选择仅输入形状为(batch_size, 1)的最后input_ids（那些没有将其过去的键值状态提供给此模型的input_ids），而不是输入形状为(batch_size, sequence_length)的所有input_ids。 - attention_mask (
torch.FloatTensor，形状为(batch_size, sequence_length)，可选) — 掩码，用于避免对填充标记索引执行注意力。掩码值在[0, 1]中选择：- 未掩码 的标记为 1，
- 已掩码 的标记为 0。
- position_ids (
torch.LongTensor，形状为(batch_size, sequence_length)，可选) — 位置嵌入中每个输入序列标记的位置索引。在[0, config.n_positions - 1]范围内选择。 - head_mask (
torch.FloatTensor类型为(num_heads,)或(num_layers, num_heads), 可选) — 用于将自注意力模块的选定头部置零的掩码。掩码值在[0, 1]中选择：- 1 表示头部**未被掩码**，
- 0 表示头部**已被掩码**。
- inputs_embeds (
torch.FloatTensor类型为(batch_size, sequence_length, hidden_size), 可选) — 或者，您可以选择直接传递嵌入表示，而不是传递input_ids。如果您想更好地控制如何将input_ids索引转换为关联向量（而不是模型的内部嵌入查找矩阵），这将非常有用。如果使用了
past_key_values，则可以选择仅输入最后的inputs_embeds（请参阅past_key_values）。 - 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相反，此张量不受填充的影响。它用于更新缓存中的正确位置并推断完整的序列长度。
返回值
transformers.modeling_outputs.BaseModelOutputWithPastAndCrossAttentions 或 tuple(torch.FloatTensor)
一个 transformers.modeling_outputs.BaseModelOutputWithPastAndCrossAttentions 或一个 torch.FloatTensor 元组（如果传递了 return_dict=False 或 config.return_dict=False）包含根据配置（FalconConfig）和输入的不同元素。
-
last_hidden_state (
torch.FloatTensor类型，形状为(batch_size, sequence_length, hidden_size)) — 模型最后一层输出的隐藏状态序列。如果使用了
past_key_values，则仅输出形状为(batch_size, 1, hidden_size)的序列的最后一个隐藏状态。 -
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)的张量，并且如果config.is_encoder_decoder=True，则可选包含 2 个形状为(batch_size, num_heads, encoder_sequence_length, embed_size_per_head)的附加张量。包含预先计算的隐藏状态（自注意力块中的键和值，以及可选的，如果
config.is_encoder_decoder=True，则为交叉注意力块中的键和值），可以使用这些状态（参见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 后的注意力权重，用于计算自注意力头中的加权平均值。
-
cross_attentions (
tuple(torch.FloatTensor)，可选，当传入output_attentions=True和config.add_cross_attention=True或config.output_attentions=True时返回) —torch.FloatTensor元组（每一层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。解码器交叉注意力层的注意力权重，在注意力 softmax 之后，用于计算交叉注意力头中的加权平均值。
FalconModel 的 forward 方法重写了 __call__ 特殊方法。
尽管需要在此函数中定义前向传递的步骤，但之后应该调用 Module 实例而不是此方法，因为前者负责运行预处理和后处理步骤，而后者则会忽略它们。
示例
>>> from transformers import AutoTokenizer, FalconModel
>>> import torch
>>> tokenizer = AutoTokenizer.from_pretrained("Rocketknight1/falcon-rw-1b")
>>> model = FalconModel.from_pretrained("Rocketknight1/falcon-rw-1b")
>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="pt")
>>> outputs = model(**inputs)
>>> last_hidden_states = outputs.last_hidden_stateFalconForCausalLM
类 transformers.FalconForCausalLM
< 源代码 >( config: FalconConfig )
参数
- config (FalconConfig) — 模型配置类，包含模型的所有参数。使用配置文件初始化不会加载与模型关联的权重，而只会加载配置。查看 from_pretrained() 方法以加载模型权重。
Falcon 模型转换器，顶部带有语言建模头（线性层，其权重与输入嵌入相关联）。
此模型继承自 PreTrainedModel。有关库为其所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小等），请查看超类文档。
此模型也是 PyTorch torch.nn.Module 子类。将其用作常规 PyTorch 模块，并参考 PyTorch 文档以获取有关一般用法和行为的所有内容。
forward
< 源代码 >( input_ids: Optional = None past_key_values: Union = None attention_mask: Optional = None position_ids: Optional = None head_mask: Optional = 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 cache_position: Optional = None ) → transformers.modeling_outputs.CausalLMOutputWithCrossAttentions 或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensor形状为(batch_size, input_ids_length)) — 如果past_key_values为None，则input_ids_length=sequence_length；否则past_key_values[0][0].shape[2]（输入过去的键值状态的sequence_length）。词汇表中输入序列标记的索引。如果使用
past_key_values，则只应将尚未计算过去的input_ids作为input_ids传递。可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- past_key_values (
Cache或tuple(tuple(torch.FloatTensor))，可选) — 预先计算的隐藏状态（自注意力块和交叉注意力块中的键和值），可用于加速顺序解码。这通常包含模型在解码的先前阶段返回的past_key_values，此时use_cache=True或config.use_cache=True。允许使用两种格式：
- 一个 Cache 实例，请参阅我们的 kv 缓存指南；
- 长度为
config.n_layers的tuple(tuple(torch.FloatTensor))元组，每个元组具有 2 个形状为(batch_size, num_heads, sequence_length, embed_size_per_head)的张量）。这也称为旧版缓存格式。
模型将输出与其输入相同的缓存格式。如果没有传递
past_key_values，则将返回旧版缓存格式。如果使用
past_key_values，则用户可以选择只输入形状为(batch_size, 1)的最后一个input_ids（那些没有将其过去的键值状态提供给此模型的input_ids），而不是输入形状为(batch_size, sequence_length)的所有input_ids。 - attention_mask (
torch.FloatTensor形状为(batch_size, sequence_length)，可选) — 掩码，避免对填充标记索引执行注意力。在[0, 1]中选择的掩码值：- 未掩码 标记为 1，
- 已掩码 标记为 0。
- position_ids (
torch.LongTensor, 形状为(batch_size, sequence_length), 可选) — 位置嵌入中每个输入序列标记的位置索引。在[0, config.n_positions - 1]范围内选择。 - head_mask (
torch.FloatTensor, 形状为(num_heads,)或(num_layers, num_heads), 可选) — 用于将自注意力模块的选定头部置零的掩码。掩码值在[0, 1]中选择：- 1 表示头部**未被掩盖**，
- 0 表示头部**已被掩盖**。
- inputs_embeds (
torch.FloatTensor, 形状为(batch_size, sequence_length, hidden_size), 可选) — 或者，您可以选择直接传递嵌入表示，而不是传递input_ids。如果您希望比模型的内部嵌入查找矩阵更能控制如何将input_ids索引转换为关联向量，这将非常有用。如果使用了
past_key_values，则可以选择只输入最后的inputs_embeds（请参阅past_key_values）。 - 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)，可选) — 用于语言建模的标签。请注意，标签在模型内部是**移位的**，即您可以设置labels = input_ids。索引在[-100, 0, ..., config.vocab_size]中选择。所有设置为-100的标签都将被忽略（屏蔽），损失仅针对[0, ..., config.vocab_size]中的标签计算。
返回值
transformers.modeling_outputs.CausalLMOutputWithCrossAttentions 或 tuple(torch.FloatTensor)
一个 transformers.modeling_outputs.CausalLMOutputWithCrossAttentions 或一个 torch.FloatTensor 元组（如果传递了 return_dict=False 或 config.return_dict=False）包含根据配置 (FalconConfig) 和输入而定的各种元素。
-
loss (
torch.FloatTensor形状为(1,)，可选，当提供labels时返回) — 语言建模损失（用于下一个标记预测）。 -
logits (
torch.FloatTensor形状为(batch_size, sequence_length, config.vocab_size)) — 语言建模头的预测分数（SoftMax 之前每个词汇标记的分数）。 -
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 后的注意力权重，用于计算自注意力头中的加权平均值。
-
cross_attentions (
tuple(torch.FloatTensor)，可选，当传递output_attentions=True或config.output_attentions=True时返回) —torch.FloatTensor元组（每层一个）形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力 SoftMax 之后的交叉注意力权重，用于计算交叉注意力头中的加权平均值。
-
past_key_values (
tuple(tuple(torch.FloatTensor))，可选，当传递use_cache=True或config.use_cache=True时返回) — 长度为config.n_layers的torch.FloatTensor元组元组，每个元组包含自注意力和交叉注意力层的缓存键、值状态（如果模型在编码器-解码器设置中使用）。仅在config.is_decoder = True时相关。包含预先计算的隐藏状态（注意力块中的键和值），可以使用这些状态（请参阅
past_key_values输入）来加速顺序解码。
FalconForCausalLM 正向方法，覆盖了 __call__ 特殊方法。
尽管需要在此函数中定义前向传递的步骤，但之后应该调用 Module 实例而不是此方法，因为前者负责运行预处理和后处理步骤，而后者则会忽略它们。
示例
>>> import torch
>>> from transformers import AutoTokenizer, FalconForCausalLM
>>> tokenizer = AutoTokenizer.from_pretrained("Rocketknight1/falcon-rw-1b")
>>> model = FalconForCausalLM.from_pretrained("Rocketknight1/falcon-rw-1b")
>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="pt")
>>> outputs = model(**inputs, labels=inputs["input_ids"])
>>> loss = outputs.loss
>>> logits = outputs.logitsFalconForSequenceClassification
类 transformers.FalconForSequenceClassification
< source >( config: FalconConfig )
参数
- config (FalconConfig) — 模型配置类，包含模型的所有参数。使用配置文件初始化不会加载与模型相关的权重，只会加载配置。查看 from_pretrained() 方法来加载模型权重。
带有序列分类头（线性层）的 Falcon 模型转换器。
FalconForSequenceClassification 使用最后一个标记进行分类，就像其他因果模型（例如 GPT-1）一样。
由于它在最后一个词元上进行分类，因此需要知道最后一个词元的位置。如果在配置中定义了“pad_token_id”，它会在每一行中找到最后一个不是填充词元的词元。如果没有定义“pad_token_id”，它只是简单地取每批数据的最后一行中的最后一个值。由于当传递“inputs_embeds”而不是“input_ids”时，它无法猜测填充词元，因此它会执行相同的操作（取每批数据的最后一行中的最后一个值）。
此模型继承自 PreTrainedModel。有关库为其所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小等），请查看超类文档。
此模型也是 PyTorch torch.nn.Module 子类。将其用作常规 PyTorch 模块，并参考 PyTorch 文档以获取有关一般用法和行为的所有内容。
forward
< 源代码 >( input_ids: Optional = None past_key_values: Optional = None attention_mask: Optional = None head_mask: Optional = 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 ) → transformers.modeling_outputs.SequenceClassifierOutputWithPast 或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensor类型，形状为(batch_size, input_ids_length)) — 如果past_key_values为None，则input_ids_length=sequence_length，否则为past_key_values[0][0].shape[2]（输入过去的键值状态的sequence_length）。词汇表中输入序列词元的索引。如果使用
past_key_values，则只应将尚未计算其过去的input_ids作为input_ids传递。可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- past_key_values (
Cache或tuple(tuple(torch.FloatTensor))，可选) — 预先计算的隐藏状态（自注意力块和交叉注意力块中的键和值），可用于加速序列解码。这通常包括模型在上一个解码阶段返回的past_key_values，此时use_cache=True或config.use_cache=True。允许使用两种格式：
- Cache 实例，请参阅我们的 kv 缓存指南；
- 长度为
config.n_layers的tuple(tuple(torch.FloatTensor))元组，每个元组具有 2 个形状为(batch_size, num_heads, sequence_length, embed_size_per_head)的张量）。这也被称为旧版缓存格式。
模型将输出与其输入相同的缓存格式。如果没有传递
past_key_values，则将返回旧版缓存格式。如果使用
past_key_values，则用户可以选择只输入形状为(batch_size, 1)的最后input_ids（那些没有将其过去的键值状态提供给此模型的），而不是形状为(batch_size, sequence_length)的所有input_ids。 - attention_mask (
torch.FloatTensor类型，形状为(batch_size, sequence_length)，可选) — 掩码，用于避免对填充词元索引执行注意力。掩码值在[0, 1]中选择：- 未掩码词元的值为 1，
- 已掩码词元的值为 0。
- position_ids (
torch.LongTensor， 形状为(batch_size, sequence_length)， 可选) — 每个输入序列标记在位置嵌入中的位置索引。在[0, config.n_positions - 1]范围内选择。 - head_mask (
torch.FloatTensor， 形状为(num_heads,)或(num_layers, num_heads)， 可选) — 用于将自注意力模块的选定头部置零的掩码。掩码值在[0, 1]中选择：- 1 表示头部 **未被掩码**，
- 0 表示头部 **已被掩码**。
- inputs_embeds (
torch.FloatTensor， 形状为(batch_size, sequence_length, hidden_size)， 可选) — 您可以选择直接传递嵌入表示，而不是传递input_ids。如果您希望比模型的内部嵌入查找矩阵更能控制如何将input_ids索引转换为关联向量，则此方法非常有用。如果使用
past_key_values，则可以选择仅输入最后的inputs_embeds（请参阅past_key_values）。 - 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,), 可选) — 用于计算序列分类/回归损失的标签。索引应在[0, ..., config.num_labels - 1]中。如果config.num_labels == 1，则计算回归损失（均方损失），如果config.num_labels > 1，则计算分类损失（交叉熵）。
返回值
transformers.modeling_outputs.SequenceClassifierOutputWithPast 或 tuple(torch.FloatTensor)
transformers.modeling_outputs.SequenceClassifierOutputWithPast 或 torch.FloatTensor 的元组（如果传递 return_dict=False 或 config.return_dict=False）包含根据配置 (FalconConfig) 和输入的不同元素。
-
loss (
torch.FloatTensor形状为(1,), 可选, 在提供labels时返回) — 分类（或回归，如果 config.num_labels==1）损失。 -
logits (
torch.FloatTensor形状为(batch_size, config.num_labels)) — 分类（或回归，如果 config.num_labels==1）得分（在 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 后的注意力权重，用于计算自注意力头中的加权平均值。
FalconForSequenceClassification 正向方法，覆盖 __call__ 特殊方法。
尽管需要在此函数中定义前向传递的步骤，但之后应该调用 Module 实例而不是此方法，因为前者负责运行预处理和后处理步骤，而后者则会忽略它们。
单标签分类示例
>>> import torch
>>> from transformers import AutoTokenizer, FalconForSequenceClassification
>>> tokenizer = AutoTokenizer.from_pretrained("Rocketknight1/falcon-rw-1b")
>>> model = FalconForSequenceClassification.from_pretrained("Rocketknight1/falcon-rw-1b")
>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="pt")
>>> with torch.no_grad():
... logits = model(**inputs).logits
>>> predicted_class_id = logits.argmax().item()
>>> # To train a model on `num_labels` classes, you can pass `num_labels=num_labels` to `.from_pretrained(...)`
>>> num_labels = len(model.config.id2label)
>>> model = FalconForSequenceClassification.from_pretrained("Rocketknight1/falcon-rw-1b", num_labels=num_labels)
>>> labels = torch.tensor([1])
>>> loss = model(**inputs, labels=labels).loss多标签分类示例
>>> import torch
>>> from transformers import AutoTokenizer, FalconForSequenceClassification
>>> tokenizer = AutoTokenizer.from_pretrained("Rocketknight1/falcon-rw-1b")
>>> model = FalconForSequenceClassification.from_pretrained("Rocketknight1/falcon-rw-1b", problem_type="multi_label_classification")
>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="pt")
>>> with torch.no_grad():
... logits = model(**inputs).logits
>>> predicted_class_ids = torch.arange(0, logits.shape[-1])[torch.sigmoid(logits).squeeze(dim=0) > 0.5]
>>> # To train a model on `num_labels` classes, you can pass `num_labels=num_labels` to `.from_pretrained(...)`
>>> num_labels = len(model.config.id2label)
>>> model = FalconForSequenceClassification.from_pretrained(
... "Rocketknight1/falcon-rw-1b", num_labels=num_labels, problem_type="multi_label_classification"
... )
>>> labels = torch.sum(
... torch.nn.functional.one_hot(predicted_class_ids[None, :].clone(), num_classes=num_labels), dim=1
... ).to(torch.float)
>>> loss = model(**inputs, labels=labels).lossFalconForTokenClassification
类 transformers.FalconForTokenClassification
< 源代码 >( config: FalconConfig )
参数
- config (FalconConfig) — 模型配置类，包含模型的所有参数。使用配置文件初始化不会加载与模型关联的权重，只会加载配置。查看 from_pretrained() 方法来加载模型权重。
Falcon 模型，顶部带有标记分类头（隐藏状态输出顶部的线性层），例如用于命名实体识别 (NER) 任务。
此模型继承自 PreTrainedModel。有关库为其所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小等），请查看超类文档。
此模型也是 PyTorch torch.nn.Module 子类。将其用作常规 PyTorch 模块，并参考 PyTorch 文档以获取有关一般用法和行为的所有内容。
forward
< source >( input_ids: Optional = None past_key_values: Optional = None attention_mask: Optional = None head_mask: Optional = 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 ) → transformers.modeling_outputs.TokenClassifierOutput 或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensor，形状为(batch_size, input_ids_length)) — 如果past_key_values为None，则input_ids_length=sequence_length；否则，input_ids_length=past_key_values[0][0].shape[2]（输入历史键值状态的sequence_length）。词汇表中输入序列标记的索引。如果使用
past_key_values，则仅应将尚未计算历史记录的input_ids作为input_ids传递。可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- past_key_values (
Cache或tuple(tuple(torch.FloatTensor)), 可选) — 预先计算的隐藏状态（自注意力块和交叉注意力块中的键和值），可用于加速顺序解码。这通常包括模型在先前解码阶段返回的past_key_values，当use_cache=True或config.use_cache=True时。允许使用两种格式：
- Cache 实例，请参阅我们的 kv 缓存指南；
- 长度为
config.n_layers的tuple(tuple(torch.FloatTensor))元组，每个元组包含 2 个形状为(batch_size, num_heads, sequence_length, embed_size_per_head)的张量。这也称为传统缓存格式。
模型将输出与其输入相同的缓存格式。如果没有传递
past_key_values，则将返回传统缓存格式。如果使用
past_key_values，用户可以选择仅输入形状为(batch_size, 1)的最后一个input_ids（那些没有将其历史键值状态提供给此模型的input_ids），而不是形状为(batch_size, sequence_length)的所有input_ids。 - attention_mask (
torch.FloatTensor，形状为(batch_size, sequence_length), 可选) — 掩码以避免对填充标记索引执行注意力。在[0, 1]中选择的掩码值：- 未掩码标记为 1，
- 已掩码标记为 0。
- position_ids (
torch.LongTensor， 形状为(batch_size, sequence_length)， 可选) — 位置嵌入中每个输入序列标记的位置索引。在[0, config.n_positions - 1]范围内选择。 - head_mask (
torch.FloatTensor， 形状为(num_heads,)或(num_layers, num_heads)， 可选) — 用于将自注意力模块的选定头部置零的掩码。掩码值在[0, 1]中选择：- 1 表示头部**未被掩盖**，
- 0 表示头部**被掩盖**。
- inputs_embeds (
torch.FloatTensor， 形状为(batch_size, sequence_length, hidden_size)， 可选) — 您可以选择直接传递嵌入表示，而不是传递input_ids。如果您想更好地控制如何将input_ids索引转换为关联向量，而不是模型的内部嵌入查找矩阵，这将非常有用。如果使用
past_key_values，则可以选择仅输入最后的inputs_embeds（请参阅past_key_values）。 - 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,)，可选) — 用于计算序列分类/回归损失的标签。索引应在[0, ..., config.num_labels - 1]范围内。如果config.num_labels == 1，则计算回归损失（均方误差）；如果config.num_labels > 1，则计算分类损失（交叉熵）。
返回值
transformers.modeling_outputs.TokenClassifierOutput 或 tuple(torch.FloatTensor)
transformers.modeling_outputs.TokenClassifierOutput 或 torch.FloatTensor 元组（如果传递了 return_dict=False 或 config.return_dict=False）包含根据配置 (FalconConfig) 和输入而定的各种元素。
-
loss (
torch.FloatTensor形状为(1,)，可选，在提供labels时返回) — 分类损失。 -
logits (
torch.FloatTensor形状为(batch_size, sequence_length, config.num_labels)) — 分类分数（SoftMax 之前）。 -
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 后的注意力权重，用于计算自注意力头中的加权平均值。
FalconForTokenClassification forward 方法，重写了 __call__ 特殊方法。
尽管需要在此函数中定义前向传递的步骤，但之后应该调用 Module 实例而不是此方法，因为前者负责运行预处理和后处理步骤，而后者则会忽略它们。
示例
>>> from transformers import AutoTokenizer, FalconForTokenClassification
>>> import torch
>>> tokenizer = AutoTokenizer.from_pretrained("Rocketknight1/falcon-rw-1b")
>>> model = FalconForTokenClassification.from_pretrained("Rocketknight1/falcon-rw-1b")
>>> inputs = tokenizer(
... "HuggingFace is a company based in Paris and New York", add_special_tokens=False, return_tensors="pt"
... )
>>> with torch.no_grad():
... logits = model(**inputs).logits
>>> predicted_token_class_ids = logits.argmax(-1)
>>> # Note that tokens are classified rather then input words which means that
>>> # there might be more predicted token classes than words.
>>> # Multiple token classes might account for the same word
>>> predicted_tokens_classes = [model.config.id2label[t.item()] for t in predicted_token_class_ids[0]]
>>> labels = predicted_token_class_ids
>>> loss = model(**inputs, labels=labels).lossFalconForQuestionAnswering
class transformers.FalconForQuestionAnswering
< source >( config )
参数
- config (FalconConfig) — 模型配置类，包含模型的所有参数。使用配置文件初始化不会加载与模型关联的权重，只会加载配置。查看 from_pretrained() 方法来加载模型权重。
Falcon 模型转换器，顶部有一个用于提取式问答任务（如 SQuAD）的跨度分类头（隐藏状态输出顶部的线性层，用于计算“跨度开始 logits”和“跨度结束 logits”）。
此模型继承自 PreTrainedModel。有关库为其所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小等），请查看超类文档。
此模型也是 PyTorch torch.nn.Module 子类。将其用作常规 PyTorch 模块，并参考 PyTorch 文档以获取有关一般用法和行为的所有内容。
forward
< source >( input_ids: Optional = None attention_mask: Optional = None head_mask: Optional = None inputs_embeds: Optional = None start_positions: Optional = None end_positions: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None )
参数
- input_ids (
torch.LongTensor， 形状为(batch_size, input_ids_length)) — 如果past_key_values为None，则input_ids_length=sequence_length；否则，input_ids_length=past_key_values[0][0].shape[2]（输入 past key value 状态的sequence_length）。词汇表中输入序列标记的索引。如果使用
past_key_values，则只应将尚未计算其过去的input_ids作为input_ids传递。可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- past_key_values (
Cache或tuple(tuple(torch.FloatTensor))， 可选) — 预先计算的隐藏状态（自注意力块和交叉注意力块中的键和值），可用于加速顺序解码。这通常包括模型在解码的先前阶段返回的past_key_values，此时use_cache=True或config.use_cache=True。允许使用两种格式：
- Cache 实例，请参阅我们的 kv 缓存指南；
- 长度为
config.n_layers的tuple(tuple(torch.FloatTensor))元组，每个元组包含 2 个形状为(batch_size, num_heads, sequence_length, embed_size_per_head)的张量。这也被称为旧版缓存格式。
模型将输出与其作为输入提供的缓存格式相同的缓存格式。如果没有传递
past_key_values，则将返回旧版缓存格式。如果使用
past_key_values，则用户可以选择仅输入形状为(batch_size, 1)的最后一个input_ids（那些尚未将其 past key value 状态提供给此模型的input_ids），而不是输入形状为(batch_size, sequence_length)的所有input_ids。 - attention_mask (
torch.FloatTensor， 形状为(batch_size, sequence_length)， 可选) — 掩码，用于避免对填充标记索引执行注意力。在[0, 1]中选择的掩码值：- 未被掩码 的标记为 1，
- 被掩码 的标记为 0。
- position_ids (
torch.LongTensor， 形状为(batch_size, sequence_length)， 可选) — 位置嵌入中每个输入序列标记的位置索引。在[0, config.n_positions - 1]范围内选择。 - head_mask (
torch.FloatTensor， 形状为(num_heads,)或(num_layers, num_heads)， 可选) — 用于将自注意力模块的选定头部置零的掩码。掩码值在[0, 1]中选择：- 1 表示头部**未被掩码**，
- 0 表示头部**已被掩码**。
- inputs_embeds (
torch.FloatTensor， 形状为(batch_size, sequence_length, hidden_size)， 可选) — 可选地，您可以选择直接传递嵌入表示，而不是传递input_ids。如果您希望比模型的内部嵌入查找矩阵更能控制如何将input_ids索引转换为关联向量，则此选项很有用。如果使用
past_key_values，则可以选择只输入最后的inputs_embeds（参见past_key_values）。 - 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相反，此张量不受填充的影响。它用于更新缓存中的正确位置并推断完整的序列长度。 - start_positions (
torch.LongTensor，形状为(batch_size,)，可选) — 用于计算标记分类损失的标记跨度开始位置（索引）的标签。位置被限制在序列的长度 (sequence_length) 内。序列外的的位置不参与损失的计算。 - end_positions (
torch.LongTensor，形状为(batch_size,)，可选) — 用于计算标记分类损失的标记跨度结束位置（索引）的标签。位置被限制在序列的长度 (sequence_length) 内。序列外的的位置不参与损失的计算。
FalconForQuestionAnswering 的 forward 方法重写了 __call__ 特殊方法。
尽管需要在此函数中定义前向传递的步骤，但之后应该调用 Module 实例而不是此方法，因为前者负责运行预处理和后处理步骤，而后者则会忽略它们。