Transformers 文档
Arcee
并获得增强的文档体验
开始使用
Arcee
Arcee 是一个基于 Llama 架构的仅解码器 Transformer 模型，其关键修改在于：根据最近研究表明平方激活函数能提高训练效率，它在 MLP 块中使用了 ReLU² (ReLU-squared) 激活函数而非 SiLU。该架构旨在实现高效的训练和推理，同时保持 Llama 设计的稳定性。
Arcee 模型在架构上与 Llama 相似，但在 MLP 层中使用了 `x * relu(x)` 以改善梯度流，并针对训练和推理场景进行了效率优化。
Arcee 模型支持通过 RoPE 缩放扩展上下文，并支持所有标准的 Transformers 特性，包括 Flash Attention 2、SDPA、梯度检查点和量化支持。
以下示例演示了如何使用 Pipeline 或 AutoModel 通过 Arcee 生成文本。
import torch
from transformers import pipeline
pipeline = pipeline(
task="text-generation",
model="arcee-ai/AFM-4.5B",
torch_dtype=torch.float16,
device=0
)
output = pipeline("The key innovation in Arcee is")
print(output[0]["generated_text"])ArceeConfig
class transformers.ArceeConfig
< 来源 >( vocab_size = 32000 hidden_size = 2560 intermediate_size = 18432 num_hidden_layers = 32 num_attention_heads = 32 num_key_value_heads = None hidden_act = 'relu2' max_position_embeddings = 4096 initializer_range = 0.02 rms_norm_eps = 1e-05 use_cache = True pad_token_id = None bos_token_id = 128000 eos_token_id = 128001 tie_word_embeddings = False rope_theta = 10000.0 rope_scaling = None attention_bias = False attention_dropout = 0.0 mlp_bias = False head_dim = None **kwargs )
参数
- vocab_size (
int, 可选, 默认为 32000) — Arcee 模型的词汇表大小。定义了在调用 ArceeModel 时，`inputs_ids` 可以表示的不同词元的数量。 - hidden_size (
int, 可选, 默认为 2560) — 隐藏表示的维度。 - intermediate_size (
int, 可选, 默认为 18432) — MLP 表示的维度。 - num_hidden_layers (
int, 可选, 默认为 32) — Transformer 解码器中的隐藏层数量。 - num_attention_heads (
int, 可选, 默认为 32) — Transformer 解码器中每个注意力层的注意力头数量。 - num_key_value_heads (
int, 可选) — 这是用于实现分组查询注意力（Grouped Query Attention）的键值头数量。如果 `num_key_value_heads=num_attention_heads`，模型将使用多头注意力（MHA）；如果 `num_key_value_heads=1`，模型将使用多查询注意力（MQA）；否则使用 GQA。将多头检查点转换为 GQA 检查点时，应通过对组内所有原始头进行均值池化来构建每个组的键和值头。更多详情请参阅这篇论文。如果未指定，将默认为 `num_attention_heads`。 - hidden_act (
str或function, 可选, 默认为 `"relu2"`) — 解码器中的非线性激活函数（函数或字符串）。 - max_position_embeddings (
int, 可选, 默认为 4096) — 此模型可能使用的最大序列长度。AFM-4.5B-Base 支持最多 16384 个词元。 - initializer_range (
float, 可选, 默认为 0.02) — 用于初始化所有权重矩阵的 truncated_normal_initializer 的标准差。 - rms_norm_eps (
float, 可选, 默认为 1e-05) — RMS 归一化层使用的 epsilon。 - use_cache (
bool, 可选, 默认为True) — 模型是否应返回最后一个键/值注意力（并非所有模型都使用）。仅当 `config.is_decoder=True` 时相关。 - pad_token_id (
int, 可选) — 填充词元的 ID。 - bos_token_id (
int, 可选, 默认为 128000) — 序列开始词元的 ID。 - eos_token_id (
int, 可选, 默认为 128001) — 序列结束词元的 ID。 - tie_word_embeddings (
bool, 可选, 默认为False) — 是否绑定词嵌入权重。 - rope_theta (
float, 可选, 默认为 10000.0) — RoPE 嵌入的基础周期。 - rope_scaling (
Dict, 可选) — 包含 RoPE 嵌入缩放配置的字典。注意：如果你应用了新的 RoPE 类型并期望模型能处理更长的 `max_position_embeddings`，我们建议你相应地更新此值。预期内容：`rope_type` (str)：使用的 RoPE 子变体。可以是 [‘default’, ‘yarn’] 之一，其中 ‘default’ 是原始的 RoPE 实现。`factor` (float, 可选)：除 ‘default’ 外的所有 RoPE 类型均使用。应用于 RoPE 嵌入的缩放因子。在大多数缩放类型中，`factor` 为 x 将使模型能够处理长度为 x * 原始最大预训练长度的序列。`original_max_position_embeddings` (int, *可选*)：与 ‘yarn’ 一起使用。预训练期间使用的原始最大位置嵌入。`attention_factor` (float, *可选*)：与 ‘yarn’ 一起使用。应用于注意力计算的缩放因子。如果未指定，将默认为实现推荐的值，使用 `factor` 字段推断建议值。`beta_fast` (float, *可选*)：仅与 ‘yarn’ 一起使用。用于在线性斜坡函数中设置外插（仅限）边界的参数。如果未指定，默认为 32。`beta_slow` (float, *可选*)：仅与 ‘yarn’ 一起使用。用于在线性斜坡函数中设置内插（仅限）边界的参数。如果未指定，默认为 1。 - attention_bias (
bool, 可选, 默认为False) — 是否在自注意力过程中的查询、键、值和输出投影层中使用偏置。 - attention_dropout (
float, 可选, 默认为 0.0) — 注意力概率的 dropout 比率。 - mlp_bias (
bool, 可选, 默认为False) — 是否在 MLP 层的 up_proj、down_proj 和 gate_proj 层中使用偏置。 - head_dim (
int, 可选) — 注意力头的维度。如果为 None，将默认为 hidden_size // num_attention_heads
这是用于存储 ArceeModel 配置的配置类。它用于根据指定的参数实例化一个 Arcee 模型，定义模型架构。使用默认值实例化配置将产生与 AFM-4.5B-Base 相似的配置。
预训练权重可在 arcee-ai/AFM-4.5B 获取，并用于构建以下示例。
配置对象继承自 PretrainedConfig，可用于控制模型输出。请阅读 PretrainedConfig 的文档以获取更多信息。
>>> from transformers import ArceeModel, ArceeConfig
>>> # Initializing an Arcee AFM-4.5B-Base style configuration
>>> configuration = ArceeConfig()
>>> # Initializing a model from the AFM-4.5B-Base style configuration
>>> model = ArceeModel(configuration)
>>> # Accessing the model configuration
>>> configuration = model.configArceeModel
class transformers.ArceeModel
< 来源 >( config: ArceeConfig )
参数
- config (ArceeConfig) — 包含模型所有参数的模型配置类。使用配置文件初始化不会加载与模型相关的权重，只会加载配置。请查阅 from_pretrained() 方法来加载模型权重。
基础的 Arcee 模型，输出原始的隐藏状态，顶部没有任何特定的头。
此模型继承自 PreTrainedModel。请查阅超类文档，了解该库为其所有模型实现的通用方法（如下载或保存、调整输入嵌入大小、修剪头部等）。
此模型也是 PyTorch torch.nn.Module 的子类。可以像常规 PyTorch 模块一样使用它，并参考 PyTorch 文档了解所有与通用用法和行为相关的事项。
forward
< 来源 >( input_ids: typing.Optional[torch.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 cache_position: typing.Optional[torch.LongTensor] = None **flash_attn_kwargs: typing_extensions.Unpack[transformers.modeling_flash_attention_utils.FlashAttentionKwargs] ) → transformers.modeling_outputs.BaseModelOutputWithPast 或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensor，形状为(batch_size, sequence_length)，可选) — 词汇表中输入序列 token 的索引。默认情况下，填充将被忽略。可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
torch.Tensor，形状为(batch_size, sequence_length)，可选) — 用于避免对填充 token 索引执行注意力操作的掩码。掩码值在[0, 1]中选择：- 对于未被掩码的 token，值为 1，
- 对于被掩码的 token，值为 0。
- position_ids (
torch.LongTensor，形状为(batch_size, sequence_length)，可选) — 每个输入序列 token 在位置嵌入中的位置索引。在[0, config.n_positions - 1]范围内选择。 - past_key_values (
~cache_utils.Cache，可选) — 预先计算的隐藏状态（自注意力块和交叉注意力块中的键和值），可用于加速序列解码。这通常包括在解码的先前阶段，当use_cache=True或config.use_cache=True时，由模型返回的past_key_values。允许两种格式：
- Cache 实例，请参阅我们的 kv cache 指南；
- 长度为
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索引转换为关联向量，这将非常有用。 - 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)，可选) — 描绘输入序列 token 在序列中位置的索引。与position_ids相反，该张量不受填充影响。它用于在正确的位置更新缓存并推断完整的序列长度。
返回
transformers.modeling_outputs.BaseModelOutputWithPast 或 tuple(torch.FloatTensor)
一个 transformers.modeling_outputs.BaseModelOutputWithPast 或一个 torch.FloatTensor 元组（如果传递了 return_dict=False 或当 config.return_dict=False 时），根据配置（ArceeConfig）和输入包含各种元素。
-
last_hidden_state (
torch.FloatTensor, 形状为(batch_size, sequence_length, hidden_size)) — 模型最后一层输出的隐藏状态序列。如果使用了
past_key_values，则只输出形状为(batch_size, 1, hidden_size)的序列的最后一个隐藏状态。 -
past_key_values (
Cache，可选，当传递use_cache=True或config.use_cache=True时返回) — 这是一个 Cache 实例。有关更多详细信息，请参阅我们的 kv cache 指南。包含预先计算的隐藏状态（自注意力块中的键和值，如果
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 后的注意力权重，用于计算自注意力头中的加权平均值。
ArceeModel 的前向方法会覆盖 __call__ 特殊方法。
尽管前向传递的流程需要在此函数内定义，但之后应调用 Module 实例而不是此函数，因为前者会处理运行前后处理步骤，而后者会静默地忽略它们。
ArceeForCausalLM
class transformers.ArceeForCausalLM
< 源码 >( config )
参数
- config (ArceeForCausalLM) — 包含模型所有参数的模型配置类。用配置文件初始化不会加载与模型相关的权重，只会加载配置。请查看 from_pretrained() 方法来加载模型权重。
用于因果语言建模的 Arcee 模型。
此模型继承自 PreTrainedModel。请查阅超类文档，了解该库为其所有模型实现的通用方法（如下载或保存、调整输入嵌入大小、修剪头部等）。
此模型也是 PyTorch torch.nn.Module 的子类。可以像常规 PyTorch 模块一样使用它，并参考 PyTorch 文档了解所有与通用用法和行为相关的事项。
forward
< 源码 >( input_ids: typing.Optional[torch.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 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: typing_extensions.Unpack[transformers.models.arcee.modeling_arcee.KwargsForCausalLM] ) → transformers.modeling_outputs.CausalLMOutputWithPast 或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensor，形状为(batch_size, sequence_length)，可选) — 词汇表中输入序列 token 的索引。默认情况下，填充将被忽略。可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
torch.Tensor，形状为(batch_size, sequence_length)，可选) — 用于避免对填充 token 索引执行注意力操作的掩码。掩码值在[0, 1]中选择：- 对于未被掩码的 token，值为 1，
- 对于被掩码的 token，值为 0。
- position_ids (
torch.LongTensor，形状为(batch_size, sequence_length)，可选) — 每个输入序列 token 在位置嵌入中的位置索引。在[0, config.n_positions - 1]范围内选择。 - past_key_values (
~cache_utils.Cache，可选) — 预先计算的隐藏状态（自注意力块和交叉注意力块中的键和值），可用于加速序列解码。这通常包括在解码的先前阶段，当use_cache=True或config.use_cache=True时，由模型返回的past_key_values。允许两种格式：
- Cache 实例，请参阅我们的 kv cache 指南；
- 长度为
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的 token 将被忽略（掩码），损失仅针对标签在[0, ..., config.vocab_size]中的 token 进行计算。 - 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)，可选) — 描绘输入序列 token 在序列中位置的索引。与position_ids相反，该张量不受填充影响。它用于在正确的位置更新缓存并推断完整的序列长度。 - logits_to_keep (
Union[int, torch.Tensor]，默认为0) — 如果是int，则为最后的logits_to_keep个 token 计算 logits。如果是0，则为所有input_ids计算 logits（特殊情况）。生成时只需要最后一个 token 的 logits，仅为该 token 计算可以节省内存，这对于长序列或大词汇表大小而言变得非常重要。如果是torch.Tensor，则必须是一维的，对应于序列长度维度中要保留的索引。这在使用打包张量格式（批次和序列长度为单个维度）时很有用。
返回
transformers.modeling_outputs.CausalLMOutputWithPast 或 tuple(torch.FloatTensor)
一个 transformers.modeling_outputs.CausalLMOutputWithPast 或一个 torch.FloatTensor 元组（如果传递了 return_dict=False 或当 config.return_dict=False 时），根据配置（ArceeConfig）和输入包含各种元素。
-
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 cache 指南。包含预计算的隐藏状态（自注意力块中的键和值），可用于（参见
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 后的注意力权重，用于计算自注意力头中的加权平均值。
ArceeForCausalLM 的前向方法会覆盖 __call__ 特殊方法。
尽管前向传递的流程需要在此函数内定义，但之后应调用 Module 实例而不是此函数，因为前者会处理运行前后处理步骤，而后者会静默地忽略它们。
示例
>>> from transformers import AutoTokenizer, ArceeForCausalLM
>>> model = ArceeForCausalLM.from_pretrained("meta-arcee/Arcee-2-7b-hf")
>>> tokenizer = AutoTokenizer.from_pretrained("meta-arcee/Arcee-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."ArceeForSequenceClassification
class transformers.ArceeForSequenceClassification
< 源码 >( config )
参数
- config (ArceeForSequenceClassification) — 包含模型所有参数的模型配置类。用配置文件初始化不会加载与模型相关的权重，只会加载配置。请查看 from_pretrained() 方法来加载模型权重。
带有一个序列分类/回归头的 Arcee 模型，例如用于 GLUE 任务。
此模型继承自 PreTrainedModel。请查阅超类文档，了解该库为其所有模型实现的通用方法（如下载或保存、调整输入嵌入大小、修剪头部等）。
此模型也是 PyTorch torch.nn.Module 的子类。可以像常规 PyTorch 模块一样使用它，并参考 PyTorch 文档了解所有与通用用法和行为相关的事项。
forward
< 源码 >( input_ids: typing.Optional[torch.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 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 ) → transformers.modeling_outputs.SequenceClassifierOutputWithPast 或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensor，形状为(batch_size, sequence_length)，可选) — 词汇表中输入序列 token 的索引。默认情况下，填充将被忽略。可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
torch.Tensor，形状为(batch_size, sequence_length)，可选) — 用于避免对填充 token 索引执行注意力操作的掩码。掩码值在[0, 1]中选择：- 对于未被掩码的 token，值为 1，
- 对于被掩码的 token，值为 0。
- position_ids (
torch.LongTensor，形状为(batch_size, sequence_length)，可选) — 每个输入序列 token 在位置嵌入中的位置索引。在[0, config.n_positions - 1]范围内选择。 - past_key_values (
~cache_utils.Cache，可选) — 预先计算的隐藏状态（自注意力块和交叉注意力块中的键和值），可用于加速序列解码。这通常包括在解码的先前阶段，当use_cache=True或config.use_cache=True时，由模型返回的past_key_values。允许两种格式：
- Cache 实例，请参阅我们的 kv cache 指南；
- 长度为
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,)，可选) — 用于计算序列分类/回归损失的标签。索引应在[0, ..., config.num_labels - 1]中。如果config.num_labels == 1，则计算回归损失（均方损失），如果config.num_labels > 1，则计算分类损失（交叉熵）。 - use_cache (
bool，可选) — 如果设置为True，则返回past_key_values键值状态，可用于加速解码（请参阅past_key_values）。 - output_attentions (
bool，可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参阅返回张量下的attentions。 - output_hidden_states (
bool，可选) — 是否返回所有层的隐藏状态。有关更多详细信息，请参阅返回张量下的hidden_states。
返回
transformers.modeling_outputs.SequenceClassifierOutputWithPast 或 tuple(torch.FloatTensor)
一个 transformers.modeling_outputs.SequenceClassifierOutputWithPast 或一个 torch.FloatTensor 元组（如果传递了 return_dict=False 或当 config.return_dict=False 时），根据配置（ArceeConfig）和输入包含各种元素。
-
loss (形状为
(1,)的torch.FloatTensor，可选，当提供labels时返回) — 分类损失（如果 config.num_labels==1，则为回归损失）。 -
logits (形状为
(batch_size, config.num_labels)的torch.FloatTensor) — 分类（如果 config.num_labels==1，则为回归）分数（SoftMax 之前）。 -
past_key_values (
Cache，可选，当传递use_cache=True或config.use_cache=True时返回) — 这是一个 Cache 实例。有关更多详细信息，请参阅我们的 kv cache 指南。包含预计算的隐藏状态（自注意力块中的键和值），可用于（参见
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 后的注意力权重，用于计算自注意力头中的加权平均值。
ArceeForSequenceClassification 的前向方法会覆盖 __call__ 特殊方法。
尽管前向传递的流程需要在此函数内定义，但之后应调用 Module 实例而不是此函数，因为前者会处理运行前后处理步骤，而后者会静默地忽略它们。
单标签分类示例
>>> import torch
>>> from transformers import AutoTokenizer, ArceeForSequenceClassification
>>> tokenizer = AutoTokenizer.from_pretrained("arcee-ai/AFM-4.5B")
>>> model = ArceeForSequenceClassification.from_pretrained("arcee-ai/AFM-4.5B")
>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="pt")
>>> with torch.no_grad():
... logits = model(**inputs).logits
>>> predicted_class_id = logits.argmax().item()
>>> model.config.id2label[predicted_class_id]
...
>>> # 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 = ArceeForSequenceClassification.from_pretrained("arcee-ai/AFM-4.5B", num_labels=num_labels)
>>> labels = torch.tensor([1])
>>> loss = model(**inputs, labels=labels).loss
>>> round(loss.item(), 2)
...多标签分类示例
>>> import torch
>>> from transformers import AutoTokenizer, ArceeForSequenceClassification
>>> tokenizer = AutoTokenizer.from_pretrained("arcee-ai/AFM-4.5B")
>>> model = ArceeForSequenceClassification.from_pretrained("arcee-ai/AFM-4.5B", 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 = ArceeForSequenceClassification.from_pretrained(
... "arcee-ai/AFM-4.5B", 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).lossArceeForQuestionAnswering
class transformers.ArceeForQuestionAnswering
< 源码 >( config )
参数
- config (ArceeForQuestionAnswering) — 包含模型所有参数的模型配置类。用配置文件初始化不会加载与模型相关的权重，只会加载配置。请查看 from_pretrained() 方法来加载模型权重。
带有片段分类头的 Arcee transformer，用于抽取式问答任务，如 SQuAD（在隐藏状态输出之上有一个线性层，用于计算 `span start logits` 和 `span end logits`）。
此模型继承自 PreTrainedModel。请查阅超类文档，了解该库为其所有模型实现的通用方法（如下载或保存、调整输入嵌入大小、修剪头部等）。
此模型也是 PyTorch torch.nn.Module 的子类。可以像常规 PyTorch 模块一样使用它，并参考 PyTorch 文档了解所有与通用用法和行为相关的事项。
forward
< 源码 >( input_ids: typing.Optional[torch.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 start_positions: typing.Optional[torch.LongTensor] = None end_positions: typing.Optional[torch.LongTensor] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None **kwargs ) → transformers.modeling_outputs.QuestionAnsweringModelOutput 或 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 (
~cache_utils.Cache，可选) — 预计算的隐藏状态（自注意力和交叉注意力块中的键和值），可用于加速序列解码。这通常包括模型在解码的前一阶段返回的 `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)` 的张量。这也称为旧版缓存格式。
模型将输出与输入相同的缓存格式。如果未传递 `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` 索引转换为关联向量，这很有用。 - start_positions (
torch.LongTensor，形状为(batch_size,)，可选) — 用于计算标记分类损失的标记范围起始位置（索引）的标签。位置被限制在序列长度（`sequence_length`）内。序列之外的位置不计入损失计算。 - end_positions (
torch.LongTensor，形状为(batch_size,)，可选) — 用于计算标记分类损失的标记范围结束位置（索引）的标签。位置被限制在序列长度（`sequence_length`）内。序列之外的位置不计入损失计算。 - output_attentions (
bool，可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参阅返回张量下的 `attentions`。 - output_hidden_states (
bool，可选) — 是否返回所有层的隐藏状态。有关更多详细信息，请参阅返回张量下的 `hidden_states`。
返回
transformers.modeling_outputs.QuestionAnsweringModelOutput 或 tuple(torch.FloatTensor)
一个 transformers.modeling_outputs.QuestionAnsweringModelOutput 或一个 `torch.FloatTensor` 元组（如果传递 `return_dict=False` 或 `config.return_dict=False`），根据配置（ArceeConfig）和输入包含各种元素。
-
loss (
torch.FloatTensorof shape(1,), 可选, 当提供labels时返回) — 总范围提取损失是起始位置和结束位置的交叉熵之和。 -
start_logits (
torch.FloatTensorof shape(batch_size, sequence_length)) — 范围起始分数（SoftMax 之前）。 -
end_logits (
torch.FloatTensorof shape(batch_size, sequence_length)) — 范围结束分数（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 后的注意力权重，用于计算自注意力头中的加权平均值。
ArceeForQuestionAnswering 的前向方法会覆盖 `__call__` 特殊方法。
尽管前向传递的流程需要在此函数内定义，但之后应调用 Module 实例而不是此函数，因为前者会处理运行前后处理步骤，而后者会静默地忽略它们。
示例
>>> from transformers import AutoTokenizer, ArceeForQuestionAnswering
>>> import torch
>>> tokenizer = AutoTokenizer.from_pretrained("arcee-ai/AFM-4.5B")
>>> model = ArceeForQuestionAnswering.from_pretrained("arcee-ai/AFM-4.5B")
>>> question, text = "Who was Jim Henson?", "Jim Henson was a nice puppet"
>>> inputs = tokenizer(question, text, return_tensors="pt")
>>> with torch.no_grad():
... outputs = model(**inputs)
>>> answer_start_index = outputs.start_logits.argmax()
>>> answer_end_index = outputs.end_logits.argmax()
>>> predict_answer_tokens = inputs.input_ids[0, answer_start_index : answer_end_index + 1]
>>> tokenizer.decode(predict_answer_tokens, skip_special_tokens=True)
...
>>> # target is "nice puppet"
>>> target_start_index = torch.tensor([14])
>>> target_end_index = torch.tensor([15])
>>> outputs = model(**inputs, start_positions=target_start_index, end_positions=target_end_index)
>>> loss = outputs.loss
>>> round(loss.item(), 2)
...ArceeForTokenClassification
class transformers.ArceeForTokenClassification
< 源代码 >( config )
参数
- config (ArceeForTokenClassification) — 包含模型所有参数的模型配置类。使用配置文件初始化不会加载与模型关联的权重，只会加载配置。请查看 from_pretrained() 方法来加载模型权重。
Arcee transformer 模型，在其顶部带有一个标记分类头（一个位于隐藏状态输出之上的线性层），例如用于命名实体识别（NER）任务。
此模型继承自 PreTrainedModel。请查阅超类文档，了解该库为其所有模型实现的通用方法（如下载或保存、调整输入嵌入大小、修剪头部等）。
此模型也是 PyTorch torch.nn.Module 的子类。可以像常规 PyTorch 模块一样使用它，并参考 PyTorch 文档了解所有与通用用法和行为相关的事项。
forward
< 源代码 >( input_ids: typing.Optional[torch.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 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 ) → transformers.modeling_outputs.TokenClassifierOutput 或 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 (
~cache_utils.Cache，可选) — 预计算的隐藏状态（自注意力和交叉注意力块中的键和值），可用于加速序列解码。这通常包括模型在解码的前一阶段返回的 `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)` 的张量。这也称为旧版缓存格式。
模型将输出与输入相同的缓存格式。如果未传递 `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,)，可选) — 用于计算序列分类/回归损失的标签。索引应在 `[0, ..., config.num_labels - 1]` 范围内。如果 `config.num_labels == 1`，则计算回归损失（均方损失），如果 `config.num_labels > 1`，则计算分类损失（交叉熵）。 - use_cache (
bool，可选) — 如果设置为 `True`，将返回 `past_key_values` 键值状态，可用于加速解码（参见 `past_key_values`）。 - output_attentions (
bool，可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参阅返回张量下的 `attentions`。 - output_hidden_states (
bool，可选) — 是否返回所有层的隐藏状态。有关更多详细信息，请参阅返回张量下的 `hidden_states`。
返回
transformers.modeling_outputs.TokenClassifierOutput 或 tuple(torch.FloatTensor)
一个 transformers.modeling_outputs.TokenClassifierOutput 或一个 `torch.FloatTensor` 元组（如果传递 `return_dict=False` 或 `config.return_dict=False`），根据配置（ArceeConfig）和输入包含各种元素。
-
loss (形状为
(1,)的torch.FloatTensor，可选，当提供labels时返回) — 分类损失。 -
logits (形状为
(batch_size, sequence_length, config.num_labels)的torch.FloatTensor) — 分类分数（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 后的注意力权重，用于计算自注意力头中的加权平均值。
ArceeForTokenClassification 的前向方法会覆盖 `__call__` 特殊方法。
尽管前向传递的流程需要在此函数内定义，但之后应调用 Module 实例而不是此函数，因为前者会处理运行前后处理步骤，而后者会静默地忽略它们。
示例
>>> from transformers import AutoTokenizer, ArceeForTokenClassification
>>> import torch
>>> tokenizer = AutoTokenizer.from_pretrained("arcee-ai/AFM-4.5B")
>>> model = ArceeForTokenClassification.from_pretrained("arcee-ai/AFM-4.5B")
>>> 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]]
>>> predicted_tokens_classes
...
>>> labels = predicted_token_class_ids
>>> loss = model(**inputs, labels=labels).loss
>>> round(loss.item(), 2)
...