Transformers 文档
DiffLlama
并获得增强的文档体验
开始使用
该模型于 2024 年 10 月 7 日发布在 HF 论文中,并于 2025 年 1 月 7 日贡献给 Hugging Face Transformers。
DiffLlama
概述
DiffLlama 模型由 Kazuma Matsumoto 等人在 Differential Transformer 中提出。该模型结合了 Llama 模型和 Differential Transformer 的注意力机制。
论文摘要如下:
Transformer 往往会将过多的注意力分配给不相关的上下文。在这项工作中,我们引入了 Diff Transformer,它能够放大对相关上下文的注意力,同时消除噪声。具体而言,差分注意力机制(differential attention mechanism)将注意力分数计算为两个独立 softmax 注意力图之间的差值。这种减法运算抵消了噪声,促进了稀疏注意力模式的涌现。语言建模的实验结果表明,在扩大模型规模和训练 token 数量的各种设置下,Diff Transformer 的性能均优于 Transformer。更引人注目的是,它在实际应用中具有显著优势,例如长上下文建模、关键信息检索、缓解幻觉、上下文学习(in-context learning)以及减少激活离群值。通过减少不相关上下文的干扰,Diff Transformer 可以缓解问答和文本摘要中的幻觉问题。对于上下文学习,Diff Transformer 不仅提高了准确率,而且对顺序排列(order permutation)更加稳健,这曾被认为是一个长期存在的稳健性问题。这些结果使 Diff Transformer 成为推进大语言模型研究的一种高效且极具前景的架构。
使用技巧
该模型的超参数与 Llama 模型相同。
DiffLlamaConfig
class transformers.DiffLlamaConfig
< 源码 >( transformers_version: str | None = None architectures: list[str] | None = None output_hidden_states: bool | None = False return_dict: bool | None = True dtype: typing.Union[str, ForwardRef('torch.dtype'), NoneType] = None chunk_size_feed_forward: int = 0 is_encoder_decoder: bool = False id2label: dict[int, str] | dict[str, str] | None = None label2id: dict[str, int] | dict[str, str] | None = None problem_type: typing.Optional[typing.Literal['regression', 'single_label_classification', 'multi_label_classification']] = None vocab_size: int = 32000 hidden_size: int = 2048 intermediate_size: int = 8192 num_hidden_layers: int = 16 num_attention_heads: int = 32 num_key_value_heads: int | None = None hidden_act: str = 'silu' max_position_embeddings: int = 2048 initializer_range: float = 0.02 rms_norm_eps: float = 1e-05 use_cache: bool = True pad_token_id: int | None = None bos_token_id: int | None = 1 eos_token_id: int | list[int] | None = 2 tie_word_embeddings: bool = False rope_parameters: transformers.modeling_rope_utils.RopeParameters | dict | None = None attention_bias: bool = False attention_dropout: float | int | None = 0.0 lambda_std_dev: float | None = 0.1 head_dim: int | None = None )
参数
- vocab_size (
int, 可选, 默认为32000) — 模型的词汇表大小。定义了input_ids可以表示的不同 token 的数量。 - hidden_size (
int, 可选, 默认为2048) — 隐藏表示的维度。 - intermediate_size (
int, 可选, 默认为8192) — MLP 表示的维度。 - num_hidden_layers (
int, 可选, 默认为16) — Transformer 解码器中的隐藏层数量。 - num_attention_heads (
int, 可选, 默认为32) — Transformer 解码器中每个注意力层的注意力头数量。 - num_key_value_heads (
int, 可选) — 这是用于实现分组查询注意力(Grouped Query Attention, GQA)的 key_value 头数量。如果num_key_value_heads=num_attention_heads,模型将使用多头注意力(MHA);如果num_key_value_heads=1,模型将使用多查询注意力(MQA);否则使用 GQA。在将多头检查点转换为 GQA 检查点时,每个组的 key 和 value 头应通过对该组内的所有原始头进行均值池化(meanpooling)来构建。更多详细信息,请查看这篇论文。如果未指定,将默认为num_attention_heads。 - hidden_act (
str, 可选, 默认为silu) — 解码器中的非线性激活函数(函数或字符串)。例如:"gelu"、"relu"、"silu"等。 - max_position_embeddings (
int, 可选, 默认为2048) — 该模型可能使用的最大序列长度。 - 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, 可选) — 词汇表中用于填充的 token ID。 - bos_token_id (
int, 可选, 默认为1) — 词汇表中用于流开始的 token ID。 - eos_token_id (
Union[int, list[int]], 可选, 默认为2) — 词汇表中用于流结束的 token ID。 - tie_word_embeddings (
bool, 可选, 默认为False) — 是否根据模型的tied_weights_keys映射来绑定权重嵌入。 - rope_parameters (
Union[~modeling_rope_utils.RopeParameters, dict], 可选) — 包含 RoPE 嵌入配置参数的字典。该字典应包含rope_theta的值,以及在需要将 RoPE 与更长的max_position_embeddings一起使用时可选的缩放参数。 - attention_bias (
bool, 可选, 默认为False) — 在自注意力机制期间,是否在查询、键、值和输出投影层中使用偏置。 - attention_dropout (
Union[float, int], 可选, 默认为0.0) — 注意力概率的 dropout 比率。 - lambda_std_dev (
float, 可选, 默认为 0.1) — 注意力层中参数 lambda 的初始化的标准差。 - head_dim (
int, 可选) — 注意力头的维度。如果为 None,则默认为 hidden_size // num_attention_heads
这是用于存储 DiffLlamaModel 配置的配置类。它根据指定的参数实例化 DiffLlama 模型,定义了模型架构。使用默认值实例化配置将产生与 kajuma/DiffLlama-0.3B-handcut 相似的配置。
配置对象继承自 PreTrainedConfig,可用于控制模型输出。阅读 PreTrainedConfig 的文档以获取更多信息。
>>> from transformers import DiffLlamaModel, DiffLlamaConfig
>>> # Initializing a DiffLlama diffllama-7b style configuration
>>> configuration = DiffLlamaConfig()
>>> # Initializing a model from the diffllama-7b style configuration
>>> model = DiffLlamaModel(configuration)
>>> # Accessing the model configuration
>>> configuration = model.configDiffLlamaModel
class transformers.DiffLlamaModel
< 源码 >( config: DiffLlamaConfig )
参数
- config (DiffLlamaConfig) — 模型配置类,包含模型的所有参数。使用配置文件初始化不会加载与模型相关的权重,仅加载配置。请查看 from_pretrained() 方法以加载模型权重。
原始的 Diffllama 模型,输出原始隐藏状态,顶部没有任何特定的分类头。
该模型继承自 PreTrainedModel。请查看超类文档以了解该库为所有模型实现的通用方法(例如下载或保存、调整输入嵌入大小、剪枝头部等)。
此模型也是一个 PyTorch torch.nn.Module 子类。像普通的 PyTorch Module 一样使用它,并参考 PyTorch 文档了解一般用法和行为的所有相关信息。
forward
< 源码 >( input_ids: torch.LongTensor | None = None attention_mask: torch.Tensor | None = None position_ids: torch.LongTensor | None = None past_key_values: transformers.cache_utils.Cache | None = None inputs_embeds: torch.FloatTensor | None = None use_cache: bool | None = None **kwargs: typing_extensions.Unpack[transformers.utils.generic.TransformersKwargs] ) → BaseModelOutputWithPast 或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensor,形状为(batch_size, sequence_length),可选) — 词表中输入序列 token 的索引。默认情况下,填充(Padding)将被忽略。可以使用 AutoTokenizer 获取索引。有关详情,请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
torch.Tensor,形状为(batch_size, sequence_length),可选) — 用于避免对填充 token 索引执行注意力操作的掩码。掩码值选自[0, 1]:- 1 表示 未掩码 的 token,
- 0 表示 已掩码 的 token。
- position_ids (
torch.LongTensor,形状为(batch_size, sequence_length),可选) — 每个输入序列 token 在位置嵌入中的位置索引。选择范围为[0, config.n_positions - 1]。 - past_key_values (
~cache_utils.Cache,可选) — 预计算的隐藏状态(自注意力块和交叉注意力块中的键和值),可用于加速顺序解码。这通常包含模型在解码的先前阶段返回的past_key_values(当use_cache=True或config.use_cache=True时)。输入仅允许 Cache 实例,请参阅我们的 kv 缓存指南。如果未传递
past_key_values,将默认初始化 DynamicCache。模型将输出与输入相同格式的缓存。
如果使用
past_key_values,用户应仅输入未处理的input_ids(即未将其过去键值状态提供给该模型的输入),形状为(batch_size, unprocessed_length),而不是形状为(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)。
返回
BaseModelOutputWithPast 或 tuple(torch.FloatTensor)
一个 BaseModelOutputWithPast 或一个 torch.FloatTensor 元组(如果传入 return_dict=False 或当 config.return_dict=False 时),根据配置(DiffLlamaConfig)和输入包含各种元素。
DiffLlamaModel 的前向传播方法,覆盖了 __call__ 特殊方法。
虽然 forward pass 的实现需要在此函数中定义,但你应该在之后调用
Module实例而不是这个,因为前者负责运行预处理和后处理步骤,而后者会静默地忽略它们。
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 缓存指南。Contains pre-computed hidden-states (key and values in the self-attention blocks and optionally if
config.is_encoder_decoder=Truein the cross-attention blocks) that can be used (seepast_key_valuesinput) to speed up sequential decoding.hidden_states (
tuple(torch.FloatTensor), optional, 当传递output_hidden_states=True或当config.output_hidden_states=True时返回) —torch.FloatTensor的元组(一个用于嵌入层的输出,如果模型有嵌入层;+一个用于每个层的输出),形状为(batch_size, sequence_length, hidden_size)。模型在每个层输出的隐藏状态以及可选的初始嵌入输出。
attentions (
tuple(torch.FloatTensor), optional, 当传递output_attentions=True或当config.output_attentions=True时返回) —torch.FloatTensor的元组(每个层一个),形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 后的注意力权重,用于计算自注意力头中的加权平均值。
DiffLlamaForCausalLM
class transformers.DiffLlamaForCausalLM
< 源码 >( config model_args: ~utils.generic.ModelArgs | None = None adapter_args: ~utils.generic.AdapterArgs | None = None lora_args: ~utils.generic.LoRAArgs | None = None tokenizer_args: ~utils.generic.TokenizerArgs | None = None dataset_args: ~utils.generic.DatasetArgs | None = None data_args: ~utils.generic.DataArgs | None = None training_args: ~utils.generic.TrainingArgs | None = None generation_args: ~utils.generic.GenerationArgs | None = None vision_tower_args: ~utils.generic.VisionTowerArgs | None = None qlora_args: ~utils.generic.QLoRAArgs | None = None vision_tower_template_args: ~utils.generic.VisionTowerTemplateArgs | None = None video_tower_args: ~utils.generic.VideoTowerArgs | None = None vision_config: ~utils.generic.VisionConfig | None = None video_config: ~utils.generic.VideoConfig | None = None load_dataset: bool | None = None load_data_collator: bool | None = None load_processor: bool | None = None load_lora_adapter: bool | None = None load_adapter: bool | None = None load_qlora_adapter: bool | None = None **kwargs: typing_extensions.Unpack[transformers.modeling_utils.PreTrainedModelKwargs] )
参数
- config (DiffLlamaForCausalLM) — 模型配置类,包含模型的所有参数。使用配置文件初始化不会加载与模型相关的权重,仅加载配置。请查看 from_pretrained() 方法以加载模型权重。
用于因果语言建模的 Diffllama 模型。
该模型继承自 PreTrainedModel。请查看超类文档以了解该库为所有模型实现的通用方法(例如下载或保存、调整输入嵌入大小、剪枝头部等)。
此模型也是一个 PyTorch torch.nn.Module 子类。像普通的 PyTorch Module 一样使用它,并参考 PyTorch 文档了解一般用法和行为的所有相关信息。
forward
< 源码 >( input_ids: torch.LongTensor | None = None attention_mask: torch.Tensor | None = None position_ids: torch.LongTensor | None = None past_key_values: transformers.cache_utils.Cache | None = None inputs_embeds: torch.FloatTensor | None = None labels: torch.LongTensor | None = None use_cache: bool | None = None logits_to_keep: int | torch.Tensor = 0 **kwargs: typing_extensions.Unpack[transformers.utils.generic.TransformersKwargs] ) → CausalLMOutputWithPast or 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]:- 1 表示 未掩码 的 token,
- 0 表示 已掩码 的 token。
- position_ids (
torch.LongTensor,形状为(batch_size, sequence_length),可选) — 每个输入序列 token 在位置嵌入中的位置索引。选择范围为[0, config.n_positions - 1]。 - past_key_values (
~cache_utils.Cache,可选) — 预计算的隐藏状态(自注意力块和交叉注意力块中的键和值),可用于加速顺序解码。这通常包含模型在解码的先前阶段返回的past_key_values(当use_cache=True或config.use_cache=True时)。输入仅允许 Cache 实例,请参阅我们的 kv 缓存指南。如果未传递
past_key_values,将默认初始化 DynamicCache。模型将输出与输入相同格式的缓存。
如果使用
past_key_values,用户应仅输入未处理的input_ids(即未将其过去键值状态提供给该模型的输入),形状为(batch_size, unprocessed_length),而不是形状为(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)。 - logits_to_keep (
Union[int, torch.Tensor],可选,默认为0) — 如果是int,则计算最后logits_to_keep个 token 的 logit。如果为0,则计算所有input_ids的 logit(特殊情况)。生成仅需要最后一个 token 的 logit,仅针对该 token 计算 logit 可以节省内存,这对于长序列或大词表大小来说非常显著。如果传入torch.Tensor,则必须是对应于序列长度维度中要保留的索引的一维张量。在使用打包张量格式(批次和序列长度的单维度)时,这非常有用。
返回
CausalLMOutputWithPast or tuple(torch.FloatTensor)
一个 CausalLMOutputWithPast 或一个 torch.FloatTensor 元组(如果传入 return_dict=False 或当 config.return_dict=False 时),根据配置(DiffLlamaConfig)和输入包含各种元素。
DiffLlamaForCausalLM 的前向传播方法,覆盖了 __call__ 特殊方法。
虽然 forward pass 的实现需要在此函数中定义,但你应该在之后调用
Module实例而不是这个,因为前者负责运行预处理和后处理步骤,而后者会静默地忽略它们。
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), optional, 当传递output_hidden_states=True或当config.output_hidden_states=True时返回) —torch.FloatTensor的元组(一个用于嵌入层的输出,如果模型有嵌入层;+一个用于每个层的输出),形状为(batch_size, sequence_length, hidden_size)。模型在每个层输出的隐藏状态以及可选的初始嵌入输出。
attentions (
tuple(torch.FloatTensor), optional, 当传递output_attentions=True或当config.output_attentions=True时返回) —torch.FloatTensor的元组(每个层一个),形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 后的注意力权重,用于计算自注意力头中的加权平均值。
示例
>>> from transformers import AutoTokenizer, DiffLlamaForCausalLM
>>> model = DiffLlamaForCausalLM.from_pretrained("google/diffllama-7b")
>>> tokenizer = AutoTokenizer.from_pretrained("google/diffllama-7b")
>>> prompt = "What is your favorite condiment?"
>>> 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]
"What is your favorite condiment?"DiffLlamaForSequenceClassification
forward
< 源码 >( input_ids: torch.LongTensor | None = None attention_mask: torch.Tensor | None = None position_ids: torch.LongTensor | None = None past_key_values: transformers.cache_utils.Cache | None = None inputs_embeds: torch.FloatTensor | None = None labels: torch.LongTensor | None = None use_cache: bool | None = None **kwargs: typing_extensions.Unpack[transformers.utils.generic.TransformersKwargs] ) → SequenceClassifierOutputWithPast or tuple(torch.FloatTensor)
参数
- input_ids (形状为
(batch_size, sequence_length)的torch.LongTensor,可选) — 词汇表中输入序列 token 的索引。默认情况下将忽略填充(padding)。索引可以通过 AutoTokenizer 获取。详细信息请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (形状为
(batch_size, sequence_length)的torch.Tensor,可选) — 用于避免对填充 token 索引执行注意力机制的掩码。掩码值在[0, 1]中选择:- 1 表示未被掩码的 token,
- 0 表示已被掩码的 token。
- position_ids (形状为
(batch_size, sequence_length)的torch.LongTensor,可选) — 每个输入序列 token 在位置嵌入中的位置索引。在范围[0, config.n_positions - 1]内选择。 - past_key_values (
~cache_utils.Cache,可选) — 预计算的隐藏状态(自注意力模块和交叉注意力模块中的键和值),可用于加速序列解码。当use_cache=True或config.use_cache=True时,这通常由模型在解码的先前阶段返回。仅允许使用 Cache 实例作为输入,请参阅我们的 kv 缓存指南。如果未传递
past_key_values,则默认初始化 DynamicCache。模型将输出与输入相同缓存格式的结果。
如果使用了
past_key_values,用户应仅输入未处理的input_ids(即没有向该模型提供其过去键值状态的那些),其形状应为(batch_size, unprocessed_length),而不是形状为(batch_size, sequence_length)的所有input_ids。 - inputs_embeds (形状为
(batch_size, sequence_length, hidden_size)的torch.FloatTensor,可选) — 还可以选择直接传入嵌入表示,而不是传递input_ids。如果您想比模型内部的嵌入查找矩阵更精确地控制如何将input_ids索引转换为关联向量,这将非常有用。 - labels (形状为
(batch_size, sequence_length)的torch.LongTensor,可选) — 用于计算掩码语言建模损失的标签。索引应为[0, ..., config.vocab_size]或 -100(请参阅input_ids文档字符串)。索引设置为-100的 token 将被忽略(掩码),损失仅针对标签在[0, ..., config.vocab_size]中的 token 计算。 - use_cache (
bool,可选) — 如果设置为True,将返回past_key_values键值状态,可用于加速解码(请参阅past_key_values)。
返回
SequenceClassifierOutputWithPast 或 tuple(torch.FloatTensor)
一个 SequenceClassifierOutputWithPast 或 torch.FloatTensor 元组(如果传入了 return_dict=False 或当 config.return_dict=False 时),根据配置(None)和输入,其包含不同的元素。
The GenericForSequenceClassification forward method, overrides the __call__ special method.
虽然 forward pass 的实现需要在此函数中定义,但你应该在之后调用
Module实例而不是这个,因为前者负责运行预处理和后处理步骤,而后者会静默地忽略它们。
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 缓存指南。包含预计算的隐藏状态(自注意力块中的键和值),可用于(参见
past_key_values输入)加速顺序解码。hidden_states (
tuple(torch.FloatTensor), optional, 当传递output_hidden_states=True或当config.output_hidden_states=True时返回) —torch.FloatTensor的元组(一个用于嵌入层的输出,如果模型有嵌入层;+一个用于每个层的输出),形状为(batch_size, sequence_length, hidden_size)。模型在每个层输出的隐藏状态以及可选的初始嵌入输出。
attentions (
tuple(torch.FloatTensor), optional, 当传递output_attentions=True或当config.output_attentions=True时返回) —torch.FloatTensor的元组(每个层一个),形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 后的注意力权重,用于计算自注意力头中的加权平均值。
DiffLlamaForQuestionAnswering
forward
< 源码 >( input_ids: torch.LongTensor | None = None attention_mask: torch.Tensor | None = None position_ids: torch.LongTensor | None = None past_key_values: transformers.cache_utils.Cache | None = None inputs_embeds: torch.FloatTensor | None = None start_positions: torch.LongTensor | None = None end_positions: torch.LongTensor | None = None **kwargs: typing_extensions.Unpack[transformers.utils.generic.TransformersKwargs] ) → QuestionAnsweringModelOutput 或 tuple(torch.FloatTensor)
参数
- input_ids (形状为
(batch_size, sequence_length)的torch.LongTensor,可选) — 词汇表中输入序列 token 的索引。默认情况下将忽略填充。索引可以通过 AutoTokenizer 获取。详细信息请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (形状为
(batch_size, sequence_length)的torch.Tensor,可选) — 用于避免对填充 token 索引执行注意力机制的掩码。掩码值在[0, 1]中选择:- 1 表示未被掩码的 token,
- 0 表示已被掩码的 token。
- position_ids (形状为
(batch_size, sequence_length)的torch.LongTensor,可选) — 每个输入序列 token 在位置嵌入中的位置索引。在范围[0, config.n_positions - 1]内选择。 - past_key_values (
~cache_utils.Cache,可选) — 预计算的隐藏状态(自注意力模块和交叉注意力模块中的键和值),可用于加速序列解码。当use_cache=True或config.use_cache=True时,这通常由模型在解码的先前阶段返回。仅允许使用 Cache 实例作为输入,请参阅我们的 kv 缓存指南。如果未传递
past_key_values,则默认初始化 DynamicCache。模型将输出与输入相同缓存格式的结果。
如果使用了
past_key_values,用户应仅输入未处理的input_ids(即没有向该模型提供其过去键值状态的那些),其形状应为(batch_size, unprocessed_length),而不是形状为(batch_size, sequence_length)的所有input_ids。 - inputs_embeds (形状为
(batch_size, sequence_length, hidden_size)的torch.FloatTensor,可选) — 还可以选择直接传入嵌入表示,而不是传递input_ids。如果您想比模型内部的嵌入查找矩阵更精确地控制如何将input_ids索引转换为关联向量,这将非常有用。 - start_positions (形状为
(batch_size,)的torch.LongTensor,可选) — 用于标记跨度开始位置(索引)的标签,用于计算 token 分类损失。位置被截断为序列长度 (sequence_length)。序列之外的位置在计算损失时不予考虑。 - end_positions (形状为
(batch_size,)的torch.LongTensor,可选) — 用于标记跨度结束位置(索引)的标签,用于计算 token 分类损失。位置被截断为序列长度 (sequence_length)。序列之外的位置在计算损失时不予考虑。
返回
QuestionAnsweringModelOutput 或 tuple(torch.FloatTensor)
一个 QuestionAnsweringModelOutput 或 torch.FloatTensor 元组(如果传递了 return_dict=False 或 config.return_dict=False),包含取决于配置 (None) 和输入的各种元素。
The GenericForQuestionAnswering forward method, overrides the __call__ special method.
虽然 forward pass 的实现需要在此函数中定义,但你应该在之后调用
Module实例而不是这个,因为前者负责运行预处理和后处理步骤,而后者会静默地忽略它们。
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), optional, 当传递output_hidden_states=True或当config.output_hidden_states=True时返回) —torch.FloatTensor的元组(一个用于嵌入层的输出,如果模型有嵌入层;+一个用于每个层的输出),形状为(batch_size, sequence_length, hidden_size)。模型在每个层输出的隐藏状态以及可选的初始嵌入输出。
attentions (
tuple(torch.FloatTensor), optional, 当传递output_attentions=True或当config.output_attentions=True时返回) —torch.FloatTensor的元组(每个层一个),形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 后的注意力权重,用于计算自注意力头中的加权平均值。
DiffLlamaForTokenClassification
forward
< 源码 >( input_ids: torch.LongTensor | None = None attention_mask: torch.Tensor | None = None position_ids: torch.LongTensor | None = None past_key_values: transformers.cache_utils.Cache | None = None inputs_embeds: torch.FloatTensor | None = None labels: torch.LongTensor | None = None use_cache: bool | None = None **kwargs: typing_extensions.Unpack[transformers.utils.generic.TransformersKwargs] ) → TokenClassifierOutput 或 tuple(torch.FloatTensor)
参数
- input_ids (形状为
(batch_size, sequence_length)的torch.LongTensor,可选) — 词汇表中输入序列 token 的索引。默认情况下将忽略填充。索引可以通过 AutoTokenizer 获取。详细信息请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (形状为
(batch_size, sequence_length)的torch.Tensor,可选) — 用于避免对填充 token 索引执行注意力机制的掩码。掩码值在[0, 1]中选择:- 1 表示未被掩码的 token,
- 0 表示已被掩码的 token。
- position_ids (形状为
(batch_size, sequence_length)的torch.LongTensor,可选) — 每个输入序列 token 在位置嵌入中的位置索引。在范围[0, config.n_positions - 1]内选择。 - past_key_values (
~cache_utils.Cache,可选) — 预计算的隐藏状态(自注意力模块和交叉注意力模块中的键和值),可用于加速序列解码。当use_cache=True或config.use_cache=True时,这通常由模型在解码的先前阶段返回。仅允许使用 Cache 实例作为输入,请参阅我们的 kv 缓存指南。如果未传递
past_key_values,则默认初始化 DynamicCache。模型将输出与输入相同缓存格式的结果。
如果使用了
past_key_values,用户应仅输入未处理的input_ids(即没有向该模型提供其过去键值状态的那些),其形状应为(batch_size, unprocessed_length),而不是形状为(batch_size, sequence_length)的所有input_ids。 - inputs_embeds (形状为
(batch_size, sequence_length, hidden_size)的torch.FloatTensor,可选) — 还可以选择直接传入嵌入表示,而不是传递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)。
返回
TokenClassifierOutput 或 tuple(torch.FloatTensor)
一个 TokenClassifierOutput 或 torch.FloatTensor 元组(如果传递了 return_dict=False 或 config.return_dict=False),包含取决于配置 (None) 和输入的各种元素。
The GenericForTokenClassification forward method, overrides the __call__ special method.
虽然 forward pass 的实现需要在此函数中定义,但你应该在之后调用
Module实例而不是这个,因为前者负责运行预处理和后处理步骤,而后者会静默地忽略它们。
loss (形状为
(1,)的torch.FloatTensor,可选,当提供labels时返回) — 分类损失。logits (形状为
(batch_size, sequence_length, config.num_labels)的torch.FloatTensor) — 分类分数(SoftMax 之前)。hidden_states (
tuple(torch.FloatTensor), optional, 当传递output_hidden_states=True或当config.output_hidden_states=True时返回) —torch.FloatTensor的元组(一个用于嵌入层的输出,如果模型有嵌入层;+一个用于每个层的输出),形状为(batch_size, sequence_length, hidden_size)。模型在每个层输出的隐藏状态以及可选的初始嵌入输出。
attentions (
tuple(torch.FloatTensor), optional, 当传递output_attentions=True或当config.output_attentions=True时返回) —torch.FloatTensor的元组(每个层一个),形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 后的注意力权重,用于计算自注意力头中的加权平均值。