Transformers 文档

Qwen2

Hugging Face's logo
加入 Hugging Face 社区

并获得增强的文档体验

开始使用

此模型于 2024-07-15 发布,并于 2024-01-17 添加到 Hugging Face Transformers。

PyTorch FlashAttention SDPA Tensor parallelism

Qwen2

Qwen2 是一个大型语言模型系列(包括预训练、指令微调和混合专家模型),参数量从 0.5B 到 72B 不等。该模型基于 Transformer 架构构建,并包含分组查询注意力(GQA)、旋转位置嵌入(RoPE)、滑动窗口与全注意力混合,以及用于训练稳定性的带 YARN 的双块注意力等增强功能。Qwen2 模型支持多种语言,并具有高达 131,072 个 token 的上下文长度。

您可以在 Qwen2 集合下找到所有官方 Qwen2 检查点。

点击右侧边栏中的 Qwen2 模型,可查看更多如何将 Qwen2 应用于不同语言任务的示例。

以下示例演示了如何使用 PipelineAutoModel 以及通过命令行使用指令微调模型来生成文本。

流水线
自动模型
Transformers CLI
import torch
from transformers import pipeline

pipe = pipeline(
    task="text-generation",
    model="Qwen/Qwen2-1.5B-Instruct",
    dtype=torch.bfloat16,
    device_map=0
)

messages = [
    {"role": "system", "content": "You are a helpful assistant."},
    {"role": "user", "content": "Tell me about the Qwen2 model family."},
]
outputs = pipe(messages, max_new_tokens=256, do_sample=True, temperature=0.7, top_k=50, top_p=0.95)
print(outputs[0]["generated_text"][-1]['content'])

量化通过以较低精度表示权重来减少大型模型的内存负担。有关更多可用量化后端,请参阅量化概述。

以下示例使用 bitsandbytes 将权重量化为 4 位。

# pip install -U flash-attn --no-build-isolation
import torch
from transformers import AutoTokenizer, AutoModelForCausalLM, BitsAndBytesConfig

quantization_config = BitsAndBytesConfig(
    load_in_4bit=True,
    bnb_4bit_compute_dtype=torch.bfloat16,
    bnb_4bit_quant_type="nf4",
    bnb_4bit_use_double_quant=True,
)

tokenizer = AutoTokenizer.from_pretrained("Qwen/Qwen2-7B")
model = AutoModelForCausalLM.from_pretrained(
    "Qwen/Qwen2-7B",
    dtype=torch.bfloat16,
    device_map="auto",
    quantization_config=quantization_config,
    attn_implementation="flash_attention_2"
)

inputs = tokenizer("The Qwen2 model family is", return_tensors="pt").to(model.device)
outputs = model.generate(**inputs, max_new_tokens=100)
print(tokenizer.decode(outputs[0], skip_special_tokens=True))

注意事项

  • 请确保您的 Transformers 库版本是最新的。Qwen2 需要 Transformers>=4.37.0 才能获得完全支持。

Qwen2Config

class transformers.Qwen2Config

< >

( vocab_size: int | None = 151936 hidden_size: int | None = 4096 intermediate_size: int | None = 22016 num_hidden_layers: int | None = 32 num_attention_heads: int | None = 32 num_key_value_heads: int | None = 32 hidden_act: str | None = 'silu' max_position_embeddings: int | None = 32768 initializer_range: float | None = 0.02 rms_norm_eps: int | None = 1e-06 use_cache: bool | None = True tie_word_embeddings: bool | None = False rope_parameters: transformers.modeling_rope_utils.RopeParameters | dict[str, transformers.modeling_rope_utils.RopeParameters] | None = None use_sliding_window: bool | None = False sliding_window: int | None = 4096 max_window_layers: int | None = 28 layer_types: list[str] | None = None attention_dropout: float | None = 0.0 pad_token_id: int | None = None bos_token_id: int | None = None eos_token_id: int | None = None **kwargs )

参数

  • vocab_size (int, optional, defaults to 151936) — Qwen2 模型词汇量大小。定义了在调用 Qwen2Model 时传入 inputs_ids 时可以表示的不同 token 的数量。
  • hidden_size (int, optional, defaults to 4096) — 隐藏表示的维度。
  • intermediate_size (int, optional, defaults to 22016) — MLP 表示的维度。
  • num_hidden_layers (int, optional, defaults to 32) — Transformer 编码器中的隐藏层数量。
  • num_attention_heads (int, optional, defaults to 32) — Transformer 编码器中每个注意力层的注意力头数量。
  • num_key_value_heads (int, optional, defaults to 32) — 这是实现分组查询注意力(Grouped Query Attention)所需的 key_value 头数。如果 num_key_value_heads=num_attention_heads,模型将使用多头注意力(MHA);如果 num_key_value_heads=1,模型将使用多查询注意力(MQA);否则使用 GQA。在将多头检查点转换为 GQA 检查点时,每个分组的 key 和 value 头应通过对该分组内的所有原始头进行平均池化来构建。更多细节请参阅 此论文。如果未指定,默认为 32
  • hidden_act (str or function, optional, defaults to "silu") — 解码器中的非线性激活函数(函数或字符串)。
  • max_position_embeddings (int, optional, defaults to 32768) — 此模型可能使用的最大序列长度。
  • initializer_range (float, optional, defaults to 0.02) — 用于初始化所有权重矩阵的截断正态分布初始器的标准差。
  • rms_norm_eps (float, optional, defaults to 1e-06) — RMS 归一化层使用的 epsilon。
  • use_cache (bool, optional, defaults to True) — 模型是否应返回最后一个 key/values 注意力(并非所有模型都使用)。仅在 config.is_decoder=True 时相关。
  • tie_word_embeddings (bool, optional, defaults to False) — 模型输入的词嵌入和输出的词嵌入是否应该绑定。
  • rope_parameters (RopeParameters, optional) — 包含 RoPE 嵌入配置参数的字典。字典应包含 rope_theta 的值,以及在您希望使用更长的 max_position_embeddings 结合 RoPE 时可选的缩放参数。
  • use_sliding_window (bool, optional, defaults to False) — 是否使用滑动窗口注意力。
  • sliding_window (int, optional, defaults to 4096) — 滑动窗口注意力(SWA)的窗口大小。如果未指定,默认为 4096
  • max_window_layers (int, optional, defaults to 28) — 使用完全注意力的层数。前 max_window_layers 层将使用完全注意力,而之后的任何附加层将使用 SWA(滑动窗口注意力)。
  • layer_types (list, optional) — 每层的注意力模式。
  • attention_dropout (float, optional, defaults to 0.0) — 注意力概率的 dropout 比率。
  • pad_token_id (int, optional) — 填充 token ID。
  • bos_token_id (int, optional) — 起始 token ID。
  • eos_token_id (int, optional) — 结束 token ID。

这是用于存储 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

class transformers.Qwen2Tokenizer

< >

( vocab: str | dict[str, int] | None = None merges: str | list[str] | None = None unk_token: str = '<|endoftext|>' bos_token = None eos_token: str = '<|endoftext|>' pad_token: str = '<|endoftext|>' add_prefix_space = None **kwargs )

save_vocabulary

< >

( save_directory: str filename_prefix: str | None = None )

Qwen2TokenizerFast

class transformers.Qwen2Tokenizer

< >

( vocab: str | dict[str, int] | None = None merges: str | list[str] | None = None unk_token: str = '<|endoftext|>' bos_token = None eos_token: str = '<|endoftext|>' pad_token: str = '<|endoftext|>' add_prefix_space = None **kwargs )

Qwen2RMSNorm

class transformers.Qwen2RMSNorm

< >

( hidden_size eps: float = 1e-06 )

forward

< >

( hidden_states: Tensor )

Qwen2Model

class transformers.Qwen2Model

< >

( config: Qwen2Config )

参数

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

一个不带任何特定头部的、输出原始隐藏状态的 Qwen2 模型。

此模型继承自 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 cache_position: torch.LongTensor | None = None **kwargs: typing_extensions.Unpack[transformers.utils.generic.TransformersKwargs] ) transformers.modeling_outputs.BaseModelOutputWithPasttuple(torch.FloatTensor)

参数

  • input_ids (torch.LongTensor of shape (batch_size, sequence_length), optional) — 词汇表中的输入序列 token 索引。默认情况下,填充将被忽略。

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

    什么是 input IDs?

  • attention_mask (torch.Tensor of shape (batch_size, sequence_length), optional) — 用于避免对填充 token 索引执行 attention 的掩码。值选择在 [0, 1] 中:

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

    什么是 attention masks?

  • position_ids (torch.LongTensor of shape (batch_size, sequence_length), optional) — 位置嵌入中每个输入序列 token 的位置索引。选择范围为 [0, config.n_positions - 1]

    什么是 position IDs?

  • past_key_values (~cache_utils.Cache, optional) — 预先计算好的隐藏状态(自 attention 块和交叉 attention 块中的 key 和 value),可用于加速序列解码。这通常由上一阶段解码时模型返回的 `past_key_values` 组成,当 `use_cache=True` 或 `config.use_cache=True` 时。

    只允许 Cache 实例作为输入,请参阅我们的 kv cache 指南。如果不传入 `past_key_values`,默认会初始化 DynamicCache

    模型将输出与输入相同的 cache 格式。

    如果使用 `past_key_values`,用户应仅输入未处理的 `input_ids`(即没有将其 past key value 状态传递给此模型的 `input_ids`),形状为 `(batch_size, unprocessed_length)`,而不是所有 `input_ids`,其形状为 `(batch_size, sequence_length)`。

  • inputs_embeds (torch.FloatTensor of shape (batch_size, sequence_length, hidden_size), optional) — 可选地,您可以直接传入嵌入表示,而不是传递 `input_ids`。如果您想比模型内部的嵌入查找矩阵更精细地控制如何将 `input_ids` 索引转换为相关的向量,这将非常有用。
  • use_cache (bool, optional) — 如果设置为 True,将返回 `past_key_values` 键值状态,并可用于加速解码。
  • cache_position (torch.LongTensor of shape (sequence_length), optional) — 描述输入序列 token 在序列中位置的索引。与 `position_ids` 不同,此张量不受填充的影响。它用于在正确的位置更新 cache 并推断完整的序列长度。

返回

transformers.modeling_outputs.BaseModelOutputWithPast or tuple(torch.FloatTensor)

一个 transformers.modeling_outputs.BaseModelOutputWithPast 或一个 torch.FloatTensor 的元组(如果传入 `return_dict=False` 或当 `config.return_dict=False` 时),根据配置(Qwen2Config)和输入而包含各种元素。

  • last_hidden_state (torch.FloatTensor, 形状为 (batch_size, sequence_length, hidden_size)) — 模型最后一层输出的隐藏状态序列。

    如果使用了 past_key_values,则只输出形状为 (batch_size, 1, hidden_size) 的序列的最后一个隐藏状态。

  • past_key_values (Cache, optional, 当传递 use_cache=True 或当 config.use_cache=True 时返回) — 它是 Cache 实例。更多详情,请参阅我们的 kv cache 指南

    Contains pre-computed hidden-states (key and values in the self-attention blocks and optionally if config.is_encoder_decoder=True in the cross-attention blocks) that can be used (see past_key_values input) 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 后的注意力权重,用于计算自注意力头中的加权平均值。

Qwen2Model 的 forward 方法,重写了 `__call__` 特殊方法。

虽然 forward pass 的实现需要在此函数中定义,但你应该在之后调用 Module 实例而不是这个,因为前者负责运行预处理和后处理步骤,而后者会静默地忽略它们。

Qwen2ForCausalLM

class transformers.Qwen2ForCausalLM

< >

( 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 (Qwen2ForCausalLM) — 模型配置类,包含模型的所有参数。使用配置文件初始化不会加载与模型关联的权重,只会加载配置。请查看 `from_pretrained()` 方法来加载模型权重。

用于因果语言建模的 Qwen2 模型。

此模型继承自 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 cache_position: torch.LongTensor | None = None logits_to_keep: int | torch.Tensor = 0 **kwargs: typing_extensions.Unpack[transformers.utils.generic.TransformersKwargs] ) transformers.modeling_outputs.CausalLMOutputWithPasttuple(torch.FloatTensor)

参数

  • input_ids (torch.LongTensor of shape (batch_size, sequence_length), optional) — 输入序列 token 在词汇表中的索引。默认情况下将忽略填充。

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

    什么是输入 ID?

  • attention_mask (torch.Tensor of shape (batch_size, sequence_length), optional) — 用于避免对填充 token 索引执行 attention 的掩码。掩码值选择在 [0, 1]

    • 1 表示未被掩码的 tokens,
    • 0 表示被掩码的 tokens。

    什么是 attention mask?

  • position_ids (torch.LongTensor of shape (batch_size, sequence_length), optional) — 输入序列 tokens 在位置 embedding 中的位置索引。选择范围为 [0, config.n_positions - 1]

    什么是位置 ID?

  • past_key_values (~cache_utils.Cache, optional) — 预先计算好的隐藏状态(自 attention 块和交叉 attention 块中的 key 和 value),可用于加速序列解码。这通常是当 use_cache=Trueconfig.use_cache=True 时,在之前的解码阶段由模型返回的 past_key_values

    仅允许使用 Cache 实例,请参阅我们的 kv cache 指南。如果未传递 past_key_values,则默认初始化 DynamicCache

    模型将输出与输入相同的 cache 格式。

    如果使用 past_key_values,用户需要仅输入未处理的 input_ids(即没有将其 past key value 状态传递给此模型的那些),其形状为 (batch_size, unprocessed_length),而不是所有 input_ids 的形状 (batch_size, sequence_length)

  • inputs_embeds (torch.FloatTensor of shape (batch_size, sequence_length, hidden_size), optional) — 可选地,您可以直接传递嵌入表示,而不是传递 input_ids。如果您希望比模型的内部嵌入查找矩阵对如何将 input_ids 索引转换为关联向量有更强的控制,这一点很有用。
  • labels (torch.LongTensor of shape (batch_size, sequence_length), optional) — 用于计算掩码语言模型损失的标签。索引应为 [0, ..., config.vocab_size] 或 -100(请参阅 input_ids 文档字符串)。索引设置为 -100 的 tokens 将被忽略(掩码),损失仅为标签在 [0, ..., config.vocab_size] 中的 tokens 计算。
  • use_cache (bool, optional) — 如果设置为 True,则返回 past_key_values key value 状态,并可用于加速解码(请参阅 past_key_values)。
  • cache_position (torch.LongTensor of shape (sequence_length), optional) — 指示输入序列 tokens 在序列中位置的索引。与 position_ids 不同,此张量不受填充的影响。它用于在正确的位置更新 cache 并推断完整的序列长度。
  • logits_to_keep (Union[int, torch.Tensor], optional, defaults to 0) — 如果是一个 int,则计算最后 logits_to_keep 个 tokens 的 logits。如果为 0,则计算所有 input_ids 的 logits(特殊情况)。仅在生成时需要最后一个 token 的 logits,并且仅为该 token 计算它们可以节省内存,这对于长序列或大词汇量来说非常显著。如果是一个 torch.Tensor,则必须是一维的,对应于序列长度维度中要保留的索引。这在使用打包 tensor 格式(批次和序列长度的单维)时很有用。

返回

transformers.modeling_outputs.CausalLMOutputWithPast or tuple(torch.FloatTensor)

一个 transformers.modeling_outputs.CausalLMOutputWithPast 或一个元组(如果传递了 return_dict=False 或当 config.return_dict=False 时)的 torch.FloatTensor,包含各种元素,具体取决于配置(Qwen2Config)和输入。

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

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

  • past_key_values (Cache, optional, 当传递 use_cache=True 或当 config.use_cache=True 时返回) — 它是 Cache 实例。更多详情,请参阅我们的 kv cache 指南

    包含预计算的隐藏状态(自注意力块中的键和值),可用于(参见 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 后的注意力权重,用于计算自注意力头中的加权平均值。

Qwen2ForCausalLM 的 forward 方法会覆盖 __call__ 特殊方法。

虽然 forward pass 的实现需要在此函数中定义,但你应该在之后调用 Module 实例而不是这个,因为前者负责运行预处理和后处理步骤,而后者会静默地忽略它们。

示例

>>> from transformers import AutoTokenizer, Qwen2ForCausalLM

>>> model = Qwen2ForCausalLM.from_pretrained("meta-qwen2/Qwen2-2-7b-hf")
>>> tokenizer = AutoTokenizer.from_pretrained("meta-qwen2/Qwen2-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."

Qwen2ForSequenceClassification

class transformers.Qwen2ForSequenceClassification

< >

( config )

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] ) transformers.modeling_outputs.SequenceClassifierOutputWithPast or tuple(torch.FloatTensor)

参数

  • input_ids (torch.LongTensor of shape (batch_size, sequence_length), optional) — 输入序列 token 在词汇表中的索引。默认情况下将忽略填充。

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

    什么是输入 ID?

  • attention_mask (torch.Tensor of shape (batch_size, sequence_length), optional) — 用于避免对填充 token 索引执行 attention 的掩码。掩码值选择在 [0, 1]

    • 1 表示未被掩码的 tokens,
    • 0 表示被掩码的 tokens。

    什么是 attention mask?

  • position_ids (torch.LongTensor of shape (batch_size, sequence_length), optional) — 输入序列 tokens 在位置 embedding 中的位置索引。选择范围为 [0, config.n_positions - 1]

    什么是位置 ID?

  • past_key_values (~cache_utils.Cache, optional) — 预先计算好的隐藏状态(自 attention 块和交叉 attention 块中的 key 和 value),可用于加速序列解码。这通常是当 use_cache=Trueconfig.use_cache=True 时,在之前的解码阶段由模型返回的 past_key_values

    仅允许使用 Cache 实例,请参阅我们的 kv cache 指南。如果未传递 past_key_values,则默认初始化 DynamicCache

    模型将输出与输入相同的 cache 格式。

    如果使用 past_key_values,用户需要仅输入未处理的 input_ids(即没有将其 past key value 状态传递给此模型的那些),其形状为 (batch_size, unprocessed_length),而不是所有 input_ids 的形状 (batch_size, sequence_length)

  • inputs_embeds (torch.FloatTensor of shape (batch_size, sequence_length, hidden_size), optional) — 可选地,您可以直接传递嵌入表示,而不是传递 input_ids。如果您希望比模型的内部嵌入查找矩阵对如何将 input_ids 索引转换为关联向量有更强的控制,这一点很有用。
  • labels (torch.LongTensor of shape (batch_size, sequence_length), optional) — 用于计算掩码语言模型损失的标签。索引应为 [0, ..., config.vocab_size] 或 -100(请参阅 input_ids 文档字符串)。索引设置为 -100 的 tokens 将被忽略(掩码),损失仅为标签在 [0, ..., config.vocab_size] 中的 tokens 计算。
  • use_cache (bool, optional) — 如果设置为 True,则返回 past_key_values key value 状态,并可用于加速解码(请参阅 past_key_values)。

返回

transformers.modeling_outputs.SequenceClassifierOutputWithPasttuple(torch.FloatTensor)

A transformers.modeling_outputs.SequenceClassifierOutputWithPast or a tuple of torch.FloatTensor (if return_dict=False is passed or when config.return_dict=False) comprising various elements depending on the configuration (None) and inputs.

  • 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, optional, 当传递 use_cache=True 或当 config.use_cache=True 时返回) — 它是 Cache 实例。更多详情,请参阅我们的 kv cache 指南

    包含预计算的隐藏状态(自注意力块中的键和值),可用于(参见 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 后的注意力权重,用于计算自注意力头中的加权平均值。

The GenericForSequenceClassification forward method, overrides the __call__ special method.

虽然 forward pass 的实现需要在此函数中定义,但你应该在之后调用 Module 实例而不是这个,因为前者负责运行预处理和后处理步骤,而后者会静默地忽略它们。

Qwen2ForTokenClassification

class transformers.Qwen2ForTokenClassification

< >

( config )

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] ) transformers.modeling_outputs.TokenClassifierOutput or tuple(torch.FloatTensor)

参数

  • input_ids (torch.LongTensor of shape (batch_size, sequence_length), optional) — 输入序列 token 在词汇表中的索引。默认情况下将忽略填充。

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

    什么是输入 ID?

  • attention_mask (torch.Tensor, 形状为 (batch_size, sequence_length), 可选) — 用于避免在 padding token 索引上执行 attention 的掩码。掩码值选择在 [0, 1] 之间:

    • 1 表示未被掩码的 token,
    • 0 表示被掩码的 token。

    什么是 attention masks?

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

    什么是 position IDs?

  • past_key_values (~cache_utils.Cache, 可选) — 可用于加速顺序解码的预计算隐藏状态(自 attention 块和交叉 attention 块中的键和值)。这通常是在 use_cache=Trueconfig.use_cache=True 时,由模型在之前的解码阶段返回的 past_key_values

    仅允许输入 Cache 实例,请参阅我们的 kv cache 指南。如果未传递 past_key_values,则默认初始化 DynamicCache

    模型将输出与输入相同的 cache 格式。

    如果使用 past_key_values,用户应仅输入未处理的 input_ids(即没有其 past key value 状态传递给此模型的 input_ids),形状为 (batch_size, unprocessed_length),而不是所有 input_ids,形状为 (batch_size, sequence_length)

  • inputs_embeds (torch.FloatTensor, 形状为 (batch_size, sequence_length, hidden_size), 可选) — 可选地,您可以选择直接传入嵌入表示,而不是传递 input_ids。如果您想比模型内部的嵌入查找矩阵更精细地控制如何将 input_ids 索引转换为关联向量,这将非常有用。
  • labels (torch.LongTensor, 形状为 (batch_size, sequence_length), 可选) — 用于计算 masked language modeling 损失的标签。索引应在 [0, ..., config.vocab_size] 或 -100 之间(请参阅 input_ids 的文档字符串)。索引设置为 -100 的 token 将被忽略(掩码),损失仅为具有 [0, ..., config.vocab_size] 标签的 token 计算。
  • use_cache (bool, 可选) — 如果设置为 True,将返回 past_key_values 键值状态,并可用于加速解码(请参阅 past_key_values)。

返回

transformers.modeling_outputs.TokenClassifierOutputtuple(torch.FloatTensor)

A transformers.modeling_outputs.TokenClassifierOutput or a tuple of torch.FloatTensor (if return_dict=False is passed or when config.return_dict=False) comprising various elements depending on the configuration (None) and inputs.

  • 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 后的注意力权重,用于计算自注意力头中的加权平均值。

The GenericForTokenClassification forward method, overrides the __call__ special method.

虽然 forward pass 的实现需要在此函数中定义,但你应该在之后调用 Module 实例而不是这个,因为前者负责运行预处理和后处理步骤,而后者会静默地忽略它们。

Qwen2ForQuestionAnswering

class transformers.Qwen2ForQuestionAnswering

< >

( config )

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] ) transformers.modeling_outputs.QuestionAnsweringModelOutputtuple(torch.FloatTensor)

参数

  • input_ids (torch.LongTensor, 形状为 (batch_size, sequence_length), 可选) — 词汇表中输入序列 token 的索引。Padding 将被默认忽略。

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

    什么是 input IDs?

  • attention_mask (torch.Tensor, 形状为 (batch_size, sequence_length), 可选) — 用于避免在 padding token 索引上执行 attention 的掩码。掩码值选择在 [0, 1] 之间:

    • 1 表示未被掩码的 token,
    • 0 表示被掩码的 token。

    什么是 attention masks?

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

    什么是 position IDs?

  • past_key_values (~cache_utils.Cache, 可选) — 可用于加速顺序解码的预计算隐藏状态(自 attention 块和交叉 attention 块中的键和值)。这通常是在 use_cache=Trueconfig.use_cache=True 时,由模型在之前的解码阶段返回的 past_key_values

    仅允许输入 Cache 实例,请参阅我们的 kv cache 指南。如果未传递 past_key_values,则默认初始化 DynamicCache

    模型将输出与输入相同的 cache 格式。

    如果使用 past_key_values,用户应仅输入未处理的 input_ids(即没有其 past key value 状态传递给此模型的 input_ids),形状为 (batch_size, unprocessed_length),而不是所有 input_ids,形状为 (batch_size, sequence_length)

  • inputs_embeds (torch.FloatTensor, 形状为 (batch_size, sequence_length, hidden_size), 可选) — 可选地,您可以选择直接传入嵌入表示,而不是传递 input_ids。如果您想比模型内部的嵌入查找矩阵更精细地控制如何将 input_ids 索引转换为关联向量,这将非常有用。
  • start_positions (torch.LongTensor, 形状为 (batch_size,), 可选) — 用于计算 token 分类损失的标记跨度开始位置(索引)的标签。位置被限制在序列长度(sequence_length)范围内。序列外的位置不计入损失计算。
  • end_positions (torch.LongTensor, 形状为 (batch_size,), 可选) — 用于计算 token 分类损失的标记跨度结束位置(索引)的标签。位置被限制在序列长度(sequence_length)范围内。序列外的位置不计入损失计算。

返回

transformers.modeling_outputs.QuestionAnsweringModelOutputtuple(torch.FloatTensor)

A transformers.modeling_outputs.QuestionAnsweringModelOutput or a tuple of torch.FloatTensor (if return_dict=False is passed or when config.return_dict=False) comprising various elements depending on the configuration (None) and inputs.

  • loss (torch.FloatTensor of shape (1,), 可选, 当提供 labels 时返回) — 总范围提取损失是起始位置和结束位置的交叉熵之和。

  • start_logits (torch.FloatTensor of shape (batch_size, sequence_length)) — 范围起始分数(SoftMax 之前)。

  • end_logits (torch.FloatTensor of 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 后的注意力权重,用于计算自注意力头中的加权平均值。

The GenericForQuestionAnswering forward method, overrides the __call__ special method.

虽然 forward pass 的实现需要在此函数中定义,但你应该在之后调用 Module 实例而不是这个,因为前者负责运行预处理和后处理步骤,而后者会静默地忽略它们。

在 GitHub 上更新

© . This site is unofficial and not affiliated with Hugging Face, Inc.