Transformers 文档

Qwen2

Hugging Face's logo
加入 Hugging Face 社区

并获得增强版文档体验

开始使用

Qwen2

概述

Qwen2 是来自 Qwen 团队的新一代大型语言模型系列。此前,我们发布了 Qwen 系列,包括 Qwen2-0.5B、Qwen2-1.5B、Qwen2-7B、Qwen2-57B-A14B、Qwen2-72B、Qwen2-Audio 等。

模型详情

Qwen2 是一个语言模型系列,包括不同模型尺寸的解码器语言模型。对于每个尺寸,我们都发布了基础语言模型和与其对齐的聊天模型。它基于 Transformer 架构,使用了 SwiGLU 激活函数、注意力 QKV 偏置、组查询注意力、滑动窗口注意力和全注意力混合等技术。此外,我们还改进了一个能够适应多种自然语言和代码的分词器。

使用技巧

Qwen2-7BQwen2-7B-Instruct 可以在 Huggingface Hub 上找到。

在下文中,我们将演示如何使用 Qwen2-7B-Instruct 进行推理。请注意,我们已使用 ChatML 格式进行对话,在本演示中,我们将展示如何利用 apply_chat_template 实现此目的。

>>> from transformers import AutoModelForCausalLM, AutoTokenizer
>>> device = "cuda" # the device to load the model onto

>>> model = AutoModelForCausalLM.from_pretrained("Qwen/Qwen2-7B-Instruct", device_map="auto")
>>> tokenizer = AutoTokenizer.from_pretrained("Qwen/Qwen2-7B-Instruct")

>>> prompt = "Give me a short introduction to large language model."

>>> messages = [{"role": "user", "content": prompt}]

>>> text = tokenizer.apply_chat_template(messages, tokenize=False, add_generation_prompt=True)

>>> model_inputs = tokenizer([text], return_tensors="pt").to(device)

>>> generated_ids = model.generate(model_inputs.input_ids, max_new_tokens=512, do_sample=True)

>>> generated_ids = [output_ids[len(input_ids):] for input_ids, output_ids in zip(model_inputs.input_ids, generated_ids)]

>>> response = tokenizer.batch_decode(generated_ids, skip_special_tokens=True)[0]

Qwen2Config

class transformers.Qwen2Config

< >

( vocab_size = 151936 hidden_size = 4096 intermediate_size = 22016 num_hidden_layers = 32 num_attention_heads = 32 num_key_value_heads = 32 hidden_act = 'silu' max_position_embeddings = 32768 initializer_range = 0.02 rms_norm_eps = 1e-06 use_cache = True tie_word_embeddings = False rope_theta = 10000.0 rope_scaling = None use_sliding_window = False sliding_window = 4096 max_window_layers = 28 attention_dropout = 0.0 **kwargs )

参数

  • vocab_size (int, 可选, 默认为 151936) — Qwen2 模型的词汇量大小。定义了调用 Qwen2Model 时传递的 inputs_ids 可以表示的不同标记的数量。
  • hidden_size (int, 可选, 默认为 4096) — 隐藏表示的维度。
  • intermediate_size (int, 可选, 默认为 22016) — MLP 表示的维度。
  • num_hidden_layers (int, 可选, 默认为 32) — Transformer 编码器中隐藏层的数量。
  • num_attention_heads (int, 可选, 默认为 32) — Transformer 编码器中每个注意力层的注意力头的数量。
  • num_key_value_heads (int可选,默认为 32) — 用于实现分组查询注意力(Grouped Query Attention)的关键值头数量。如果 num_key_value_heads=num_attention_heads,模型将使用多头注意力(MHA);如果 num_key_value_heads=1,模型将使用多查询注意力(MQA);否则将使用 GQA。在将多头检查点转换为 GQA 检查点时,每个组的关键和值头应通过对该组中所有原始头进行平均池化来构建。更多细节请查看这篇论文。如果未指定,将默认为 32
  • hidden_act (strfunction可选,默认为 "silu") — 解码器中的非线性激活函数(函数或字符串)。
  • max_position_embeddings (int可选,默认为 32768) — 该模型可能使用的最大序列长度。
  • initializer_range (float可选,默认为 0.02) — 用于初始化所有权重矩阵的截断正态初始化器的标准差。
  • rms_norm_eps (float可选,默认为 1e-06) — rms 正则化层使用的 epsilon。
  • use_cache (bool可选,默认为 True) — 模型是否应该返回最后的键/值注意力(并非所有模型都使用)。仅当 config.is_decoder=True 时才相关。
  • tie_word_embeddings (bool可选,默认为 False) — 模型的输入和输出词嵌入是否应该绑定。
  • 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 嵌入的缩放因子。在大多数缩放类型中,factor 为 x 将使模型能够处理长度为 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 高频分量的缩放因子。

  • use_sliding_window (bool, 可选, 默认为 False) — 是否使用滑动窗口注意力机制。
  • sliding_window (int, 可选, 默认为 4096) — 滑动窗口注意力 (SWA) 窗口大小。如果未指定,则默认为 4096
  • max_window_layers (int, 可选, 默认为 28) — 使用 SWA(滑动窗口注意力)的层数。底层使用 SWA,而顶层使用完全注意力。
  • attention_dropout (float, 可选, 默认为 0.0) — 注意力概率的 dropout 比率。

这是用于存储 Qwen2Model 配置的配置类。它用于根据指定的参数实例化 Qwen2 模型,定义模型架构。使用默认值实例化配置将产生与 Qwen2-7B-beta Qwen/Qwen2-7B-beta 类似的配置。

配置对象继承自 PretrainedConfig,可用于控制模型输出。阅读 PretrainedConfig 的文档以获取更多信息。

>>> from transformers import Qwen2Model, Qwen2Config

>>> # Initializing a Qwen2 style configuration
>>> configuration = Qwen2Config()

>>> # Initializing a model from the Qwen2-7B style configuration
>>> model = Qwen2Model(configuration)

>>> # Accessing the model configuration
>>> configuration = model.config

Qwen2Tokenizer

transformers.Qwen2Tokenizer

< >

( vocab_file merges_file errors = 'replace' unk_token = '<|endoftext|>' bos_token = None eos_token = '<|endoftext|>' pad_token = '<|endoftext|>' clean_up_tokenization_spaces = False split_special_tokens = False **kwargs )

参数

  • vocab_file (str) — 词汇表文件路径。
  • merges_file (str) — 合并文件路径。
  • errors (str, 可选, 默认为 "replace") — 将字节解码为 UTF-8 时遵循的范式。有关更多信息,请参阅 bytes.decode
  • unk_token (str, 可选, 默认为 "<|endoftext|>") — 未知词元。不在词汇表中的词元无法转换为 ID,而是设置为该词元。
  • bos_token (str, 可选) — 序列开始词元。此分词器不适用。
  • eos_token (str, 可选, 默认为 "<|endoftext|>") — 序列结束词元。
  • pad_token (str, 可选, 默认为 "<|endoftext|>") — 用于填充的词元,例如在批处理不同长度的序列时。
  • clean_up_tokenization_spaces (bool, 可选, 默认为 False) — 模型是否应该清理在分词过程中分割输入文本时添加的空格。此分词器不适用,因为分词不会添加空格。
  • split_special_tokens (bool, 可选, 默认为 False) — 特殊词元在分词过程中是否应该被分割。默认行为是不分割特殊词元。这意味着如果 <|endoftext|>eos_token,则 tokenizer.tokenize("<|endoftext|>") = ['<|endoftext|>']。否则,如果 split_special_tokens=True,则 tokenizer.tokenize("<|endoftext|>") 将给出 ['<', '|', 'endo', 'ft', 'ext', '|', '>']。此参数目前仅支持 slow 分词器。

构建一个 Qwen2 分词器。基于字节级字节对编码。

与 GPT2Tokenizer 一样,此分词器经过训练,将空格视为词元的一部分,因此一个单词

无论它是否位于句子的开头(没有空格),其编码方式都不同。

>>> from transformers import Qwen2Tokenizer

>>> tokenizer = Qwen2Tokenizer.from_pretrained("Qwen/Qwen-tokenizer")
>>> tokenizer("Hello world")["input_ids"]
[9707, 1879]

>>> tokenizer(" Hello world")["input_ids"]
[21927, 1879]
这是预期的行为。

由于不同的预分词规则,您不应该使用 GPT2Tokenizer 代替。

此分词器继承自 PreTrainedTokenizer,其中包含大多数主要方法。用户应参考此超类以获取有关这些方法的更多信息。

保存词汇表

< >

( save_directory: str filename_prefix: Optional = None )

Qwen2TokenizerFast

transformers.Qwen2TokenizerFast

< >

( vocab_file = None merges_file = None tokenizer_file = None unk_token = '<|endoftext|>' bos_token = None eos_token = '<|endoftext|>' pad_token = '<|endoftext|>' **kwargs )

参数

  • 词汇文件路径 (str, 可选) — 词汇表文件路径。
  • 合并文件路径 (str, 可选) — 合并文件路径。
  • 分词器文件路径 (str, 可选) — 分词器 文件路径(通常扩展名为 .json),包含加载分词器所需的所有内容。
  • 未知词元 (str, 可选, 默认为 "<|endoftext|>") — 未知词元。词汇表中不存在的词元无法转换为 ID,而是设置为此词元。不适用于此分词器。
  • 序列开始词元 (str, 可选) — 序列开始词元。不适用于此分词器。
  • 序列结束词元 (str, 可选, 默认为 "<|endoftext|>") — 序列结束词元。
  • 填充词元 (str, 可选, 默认为 "<|endoftext|>") — 用于填充的词元,例如在批处理不同长度的序列时。

构建一个“快速”的 Qwen2 分词器(由 HuggingFace 的 tokenizers 库支持)。基于字节级字节对编码。

与 GPT2Tokenizer 一样,此分词器经过训练,将空格视为词元的一部分,因此一个单词

无论它是否位于句子的开头(没有空格),其编码方式都不同。

>>> from transformers import Qwen2TokenizerFast

>>> tokenizer = Qwen2TokenizerFast.from_pretrained("Qwen/Qwen-tokenizer")
>>> tokenizer("Hello world")["input_ids"]
[9707, 1879]

>>> tokenizer(" Hello world")["input_ids"]
[21927, 1879]
这是预期的行为。

此分词器继承自 PreTrainedTokenizerFast,其中包含大部分主要方法。用户应参考此超类以获取有关这些方法的更多信息。

Qwen2Model

transformers.Qwen2Model

< >

( 配置: Qwen2Config )

参数

  • config (Qwen2Config) — 模型配置类,包含模型的所有参数。使用配置文件进行初始化不会加载与模型关联的权重,仅加载配置。查看 from_pretrained() 方法以加载模型权重。config — Qwen2Config

基本的 Qwen2 模型,输出原始隐藏状态,没有任何特定的头部。此模型继承自 PreTrainedModel。查看超类文档以了解库为其所有模型实现的通用方法(例如下载或保存、调整输入嵌入大小、修剪头部等)。

此模型也是 PyTorch torch.nn.Module 的子类。将其用作常规 PyTorch 模块,并参考 PyTorch 文档以了解与通用用法和行为相关的所有事项。

包含 config.num_hidden_layers 层的 Transformer 解码器。每一层都是一个 Qwen2DecoderLayer

前向传播

< >

( input_ids: LongTensor = None attention_mask: Optional = None position_ids: Optional = None past_key_values: 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 )

参数

  • input_ids (torch.LongTensor 形状为 (batch_size, sequence_length)) — 词汇表中输入序列标记的索引。如果您提供填充,则默认情况下会忽略填充。

    可以使用 AutoTokenizer 获取索引。有关详细信息,请参阅 PreTrainedTokenizer.encode()PreTrainedTokenizer.call()

    什么是输入 ID?

  • attention_mask (torch.Tensor 形状为 (batch_size, sequence_length)可选) — 用于避免对填充标记索引执行注意力的掩码。在 [0, 1] 中选择掩码值:

    • 1 表示未掩盖的标记,
    • 0 表示掩盖的标记。

    什么是注意力掩码?

    可以使用 AutoTokenizer 获取索引。有关详细信息,请参阅 PreTrainedTokenizer.encode()PreTrainedTokenizer.call()

    如果使用 past_key_values,则可以选择仅输入最后一个 decoder_input_ids(参见 past_key_values)。

    如果要更改填充行为,则应阅读 modeling_opt._prepare_decoder_attention_mask 并根据您的需要进行修改。有关默认策略的更多信息,请参阅 论文 中的图 1。

    • 1 表示头部未掩盖
    • 0 表示头部掩盖
  • position_ids (torch.LongTensor 形状为 (batch_size, sequence_length)可选) — 位置嵌入中每个输入序列标记的位置索引。在 [0, config.n_positions - 1] 范围内选择。

    什么是位置 ID?

  • past_key_values (Cachetuple(tuple(torch.FloatTensor))可选) — 预先计算的隐藏状态(自注意力块和交叉注意力块中的键和值),可用于加速顺序解码。这通常包括模型在解码的先前阶段返回的 past_key_values,当 use_cache=Trueconfig.use_cache=True 时。

    允许两种格式:

    • 一个 Cache 实例,请参阅我们的 kv 缓存指南
    • 长度为 config.n_layerstuple(tuple(torch.FloatTensor)),每个元组有两个形状为 (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

  • 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
  • return_dict (bool, 可选) — 是否返回ModelOutput而不是普通元组。
  • cache_position (torch.LongTensor 形状为(sequence_length), 可选) — 表示输入序列标记在序列中的位置的索引。与position_ids相反,此张量不受填充的影响。它用于在正确的位置更新缓存并推断完整的序列长度。

Qwen2Model 的前向方法覆盖了__call__特殊方法。

尽管需要在此函数中定义前向传递的步骤,但之后应该调用Module实例,而不是此函数,因为前者负责运行预处理和后处理步骤,而后者则会静默地忽略它们。

Qwen2ForCausalLM

transformers.Qwen2ForCausalLM

< >

( config )

前向传播

< >

( input_ids: LongTensor = None attention_mask: Optional = None position_ids: Optional = None past_key_values: 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 num_logits_to_keep: int = 0 ) transformers.modeling_outputs.CausalLMOutputWithPasttuple(torch.FloatTensor)

参数

  • input_ids (torch.LongTensor 形状为(batch_size, sequence_length)) — 词汇表中输入序列标记的索引。如果您提供填充,则默认情况下会忽略填充。

    可以使用AutoTokenizer获取索引。有关详细信息,请参阅PreTrainedTokenizer.encode()PreTrainedTokenizer.call()

    什么是输入 ID?

  • attention_mask (torch.Tensor 形状为(batch_size, sequence_length), 可选) — 用于避免对填充标记索引执行注意力的掩码。掩码值选择在[0, 1]中:

    • 1 表示未掩盖的标记,
    • 0 表示掩盖的标记。

    什么是注意力掩码?

    可以使用AutoTokenizer获取索引。有关详细信息,请参阅PreTrainedTokenizer.encode()PreTrainedTokenizer.call()

    如果使用past_key_values,则可以选择仅输入最后的decoder_input_ids(请参阅past_key_values)。

    如果您想更改填充行为,则应阅读modeling_opt._prepare_decoder_attention_mask并根据您的需要进行修改。有关默认策略的更多信息,请参阅论文中的图 1。

    • 1 表示头部未掩盖
    • 0 表示头部掩盖
  • position_ids (torch.LongTensor 形状为 (batch_size, sequence_length)可选) — 位置嵌入中每个输入序列标记的位置索引。选择范围为 [0, config.n_positions - 1]

    什么是位置 ID?

  • past_key_values (Cachetuple(tuple(torch.FloatTensor))可选) — 预计算的隐藏状态(自注意力块和交叉注意力块中的键和值),可用于加速顺序解码。这通常包括模型在解码的先前阶段返回的 past_key_values,当 use_cache=Trueconfig.use_cache=True 时。

    允许两种格式:

    • 一个 Cache 实例,请参阅我们的 kv 缓存指南
    • 长度为 config.n_layerstuple(torch.FloatTensor) 元组,每个元组包含两个形状为 (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

  • 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
  • return_dict (bool可选) — 是否返回 ModelOutput 而不是普通元组。
  • cache_position (torch.LongTensor 形状为 (sequence_length)可选) — 表示输入序列标记在序列中的位置的索引。与 position_ids 相反,此张量不受填充的影响。它用于在正确的位置更新缓存并推断完整的序列长度。

    参数 — labels (torch.LongTensor 形状为 (batch_size, sequence_length)可选): 用于计算掩码语言建模损失的标签。索引应在 [0, ..., config.vocab_size] 或 -100 中(请参阅 input_ids 文档字符串)。索引设置为 -100 的标记将被忽略(掩码),仅对标签在 [0, ..., config.vocab_size] 中的标记计算损失。

    num_logits_to_keep (int可选): 计算最后 num_logits_to_keep 个标记的 logits。如果为 0,则计算所有 input_ids 的 logits(特殊情况)。生成只需要最后一个标记的 logits,并且仅为此标记计算它们可以节省内存,对于长序列或大型词汇量来说,这变得非常重要。

返回值

transformers.modeling_outputs.CausalLMOutputWithPasttuple(torch.FloatTensor)

一个 transformers.modeling_outputs.CausalLMOutputWithPasttorch.FloatTensor 的元组(如果传递了 return_dict=False 或当 config.return_dict=False 时),包含根据配置 (Qwen2Config) 和输入的不同元素。

  • loss (torch.FloatTensor 形状为 (1,)可选,在提供 labels 时返回) — 语言建模损失(用于下一个标记预测)。

  • logits (torch.FloatTensor 形状为 (batch_size, sequence_length, config.vocab_size)) — 语言建模头的预测分数(SoftMax 之前的每个词汇标记的分数)。

  • past_key_values (tuple(tuple(torch.FloatTensor))可选,在传递 use_cache=True 或当 config.use_cache=True 时返回) — 长度为 config.n_layerstuple(torch.FloatTensor) 元组,每个元组包含两个形状为 (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=Trueconfig.output_attentions=True 时返回) — 形状为 (batch_size, num_heads, sequence_length, sequence_length)torch.FloatTensor 元组 (每个层一个)。

    注意力 softmax 之后的注意力权重,用于计算自注意力头中的加权平均值。

The Qwen2ForCausalLM 前向方法,重写了 __call__ 特殊方法。

尽管需要在此函数中定义前向传递的步骤,但之后应该调用Module实例,而不是此函数,因为前者负责运行预处理和后处理步骤,而后者则会静默地忽略它们。

示例

>>> from transformers import AutoTokenizer, Qwen2ForCausalLM

>>> model = Qwen2ForCausalLM.from_pretrained(PATH_TO_CONVERTED_WEIGHTS)
>>> tokenizer = AutoTokenizer.from_pretrained(PATH_TO_CONVERTED_TOKENIZER)

>>> 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."

Qwen2ForSequenceClassification

transformers.Qwen2ForSequenceClassification

< >

( config )

参数

  • config (Qwen2Config) — 模型配置类,包含模型的所有参数。使用配置文件初始化不会加载与模型相关的权重,仅加载配置。查看 from_pretrained() 方法以加载模型权重。

具有序列分类头的 Qwen2 模型转换器(线性层)。

Qwen2ForSequenceClassification 使用最后一个 token 进行分类,就像其他因果模型(例如 GPT-2)一样。

由于它对最后一个 token 进行分类,因此需要知道最后一个 token 的位置。如果在配置中定义了 pad_token_id,则它会查找每行中不是填充 token 的最后一个 token。如果未定义 pad_token_id,则它只需获取批处理中每行中的最后一个值。由于它无法在传递 inputs_embeds 而不是 input_ids 时猜测填充 token,因此它执行相同的操作(获取批处理中每行中的最后一个值)。

此模型继承自 PreTrainedModel。查看超类文档以了解库为其所有模型实现的通用方法(例如下载或保存、调整输入嵌入大小、修剪头等)。

此模型也是 PyTorch torch.nn.Module 的子类。将其用作常规 PyTorch 模块,并参考 PyTorch 文档以了解与通用用法和行为相关的所有事项。

前向传播

< >

( input_ids: LongTensor = None attention_mask: 可选 = None position_ids: 可选 = None past_key_values: 可选 = None inputs_embeds: 可选 = None labels: 可选 = None use_cache: 可选 = None output_attentions: 可选 = None output_hidden_states: 可选 = None return_dict: 可选 = None )

参数

  • input_ids (torch.LongTensor 形状为 (batch_size, sequence_length)) — 词汇表中输入序列 token 的索引。如果您提供填充,则默认情况下会忽略填充。

    可以使用 AutoTokenizer 获取索引。有关详细信息,请参阅 PreTrainedTokenizer.encode()PreTrainedTokenizer.call()

    什么是输入 ID?

  • attention_mask (torch.Tensor 形状为 (batch_size, sequence_length), 可选) — 用于避免对填充 token 索引执行注意力的掩码。在 [0, 1] 中选择掩码值:

    • 1 表示未掩盖的 token,
    • 0 表示掩盖的 token。

    什么是注意力掩码?

    可以使用 AutoTokenizer 获取索引。有关详细信息,请参阅 PreTrainedTokenizer.encode()PreTrainedTokenizer.call()

    如果使用 past_key_values,则可以选择仅输入最后一个 decoder_input_ids(请参阅 past_key_values)。

    如果要更改填充行为,则应阅读 modeling_opt._prepare_decoder_attention_mask 并根据您的需要进行修改。有关默认策略的更多信息,请参阅 论文 中的图 1。

    • 1 表示头未掩盖
    • 0 表示头掩盖
  • position_ids (torch.LongTensor 形状为 (batch_size, sequence_length), 可选) — 位置嵌入中每个输入序列 token 的位置索引。在 [0, config.n_positions - 1] 范围内选择。

    什么是位置 ID?

  • past_key_values (Cachetuple(tuple(torch.FloatTensor))可选) — 预先计算的隐藏状态(自注意力块和交叉注意力块中的键和值),可用于加速顺序解码。这通常包含模型在解码的先前阶段返回的 past_key_values,当 use_cache=Trueconfig.use_cache=True 时。

    允许两种格式:

    • 一个 Cache 实例,请参阅我们的 kv 缓存指南
    • 长度为 config.n_layerstuple(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

  • 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
  • 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,则计算分类损失(交叉熵)。

The Qwen2ForSequenceClassification 正向方法,覆盖了 __call__ 特殊方法。

尽管需要在此函数中定义前向传递的步骤,但之后应该调用Module实例,而不是此函数,因为前者负责运行预处理和后处理步骤,而后者则会静默地忽略它们。

Qwen2ForTokenClassification

transformers.Qwen2ForTokenClassification

<

( config )

参数

  • config (Qwen2Config) — 模型配置类,包含模型的所有参数。使用配置文件初始化不会加载与模型关联的权重,仅加载配置。查看 from_pretrained() 方法以加载模型权重。

带有一个令牌分类头的 Qwen2 模型转换器(隐藏状态输出顶部的线性层),例如用于命名实体识别 (NER) 任务。

此模型继承自 PreTrainedModel。查看超类文档以了解库为其所有模型实现的通用方法(例如下载或保存、调整输入嵌入大小、修剪头等)。

此模型也是 PyTorch torch.nn.Module 的子类。将其用作常规 PyTorch 模块,并参考 PyTorch 文档以了解与通用用法和行为相关的所有事项。

前向传播

< >

( input_ids: Optional = None attention_mask: Optional = None position_ids: Optional = None past_key_values: 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 )

参数

  • input_ids (torch.LongTensor 形状为 (batch_size, sequence_length)) — 词汇表中输入序列标记的索引。如果您提供填充,则默认情况下会忽略填充。

    可以使用 AutoTokenizer 获取索引。有关详细信息,请参阅 PreTrainedTokenizer.encode()PreTrainedTokenizer.call()

    什么是输入 ID?

  • attention_mask (torch.Tensor 形状为 (batch_size, sequence_length), 可选) — 用于避免对填充标记索引执行注意力的掩码。掩码值选择在 [0, 1] 中:

    • 1 表示未被掩盖的标记,
    • 0 表示被掩盖的标记。

    什么是注意力掩码?

    可以使用 AutoTokenizer 获取索引。有关详细信息,请参阅 PreTrainedTokenizer.encode()PreTrainedTokenizer.call()

    如果使用past_key_values,则可以选择仅输入最后一个decoder_input_ids(其过去键值状态未提供给此模型)(参见past_key_values)。

    如果要更改填充行为,则应阅读modeling_opt._prepare_decoder_attention_mask 并根据您的需要进行修改。有关默认策略的更多信息,请参阅论文中的图 1。

    • 1 表示头未被掩盖
    • 0 表示头被掩盖
  • position_ids (torch.LongTensor 形状为 (batch_size, sequence_length), 可选) — 位置嵌入中每个输入序列标记的位置索引。选择范围在 [0, config.n_positions - 1] 中。

    什么是位置 ID?

  • past_key_values (Cachetuple(tuple(torch.FloatTensor)), 可选) — 预先计算的隐藏状态(自注意力块和交叉注意力块中的键和值),可用于加速顺序解码。这通常包括模型在解码的先前阶段返回的past_key_values,当use_cache=Trueconfig.use_cache=True 时。

    允许两种格式:

    • 一个 Cache 实例,请参阅我们的kv 缓存指南
    • 长度为 config.n_layerstuple(tuple(torch.FloatTensor)),每个元组有两个形状为 (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

  • 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
  • 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,则计算分类损失(交叉熵)。

The Qwen2ForTokenClassification 前向方法,覆盖了__call__特殊方法。

尽管需要在此函数中定义前向传递的步骤,但之后应该调用Module实例,而不是此函数,因为前者负责运行预处理和后处理步骤,而后者则会静默地忽略它们。

< > 在 GitHub 上更新