Transformers 文档
GLM-4-0414
并获得增强的文档体验
开始使用
该模型于 2024 年 6 月 18 日在 HF papers 上发布,并于 2025 年 4 月 9 日贡献至 Hugging Face Transformers 库。
GLM-4-0414
概述
GLM 家族迎来了新成员:GLM-4-0414 系列模型。
GLM-4-32B-0414 系列模型包含 320 亿参数。其性能可媲美 OpenAI 的 GPT 系列和 DeepSeek 的 V3/R1 系列,并支持非常便捷的本地部署功能。GLM-4-32B-Base-0414 使用了 15T 高质量数据进行预训练,其中包含了大量的推理型合成数据,这为后续的强化学习扩展奠定了基础。在后训练阶段,我们针对对话场景采用了人类偏好对齐,并通过拒绝采样和强化学习等技术,增强了模型在指令遵循、工程代码和函数调用方面的能力,从而强化了 Agent 任务所需的原子能力。GLM-4-32B-0414 在工程代码、Artifact 生成、函数调用、基于搜索的问答和报告生成等方面均取得了优异的成果。特别是在代码生成或特定问答任务等多个基准测试中,GLM-4-32B-Base-0414 达到了与 GPT-4o 和 DeepSeek-V3-0324(671B)等大型模型相当的性能。
GLM-Z1-32B-0414 是一款具备深度思考能力的推理模型。它是在 GLM-4-32B-0414 的基础上,通过冷启动、扩展强化学习以及针对数学、代码和逻辑等任务的进一步训练而开发的。与基础模型相比,GLM-Z1-32B-0414 在数学能力和复杂任务求解能力上有了显著提升。在训练过程中,我们还引入了基于成对排序反馈的通用强化学习,进一步增强了模型的通用能力。
GLM-Z1-Rumination-32B-0414 是一款具备“反刍”(Rumination)能力的深度推理模型(对标 OpenAI 的 Deep Research)。与典型的深度思考模型不同,该“反刍”模型能够进行更深层次、更长时间的思考,以解决更为开放和复杂的难题(例如:撰写两座城市人工智能发展的比较分析及其未来发展规划)。Z1-Rumination 通过端到端强化学习进行扩展训练,其响应由真值答案或评分标准进行评估,并能在深度思考过程中利用搜索工具来处理复杂任务。该模型在研究型写作和复杂任务表现上展现出显著改进。
最后,GLM-Z1-9B-0414 是一个惊喜。我们利用上述所有技术训练了一个小参数模型(9B)。GLM-Z1-9B-0414 在数学推理和通用任务中表现出色。其整体性能在同尺寸的所有开源模型中处于顶尖水平。特别是在资源受限的场景下,该模型在效率和效果之间实现了极佳的平衡,为寻求轻量化部署的用户提供了一个强大的选择。
Glm4Config
class transformers.Glm4Config
< 源码 >( 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 = 151552 hidden_size: int = 4096 intermediate_size: int = 13696 num_hidden_layers: int = 40 num_attention_heads: int = 32 num_key_value_heads: int = 2 head_dim: int = 128 hidden_act: str = 'silu' attention_dropout: float | int = 0.0 max_position_embeddings: int = 131072 initializer_range: float = 0.02 rms_norm_eps: float = 1.5625e-07 use_cache: bool = True tie_word_embeddings: bool = False rope_parameters: transformers.modeling_rope_utils.RopeParameters | dict | None = None pad_token_id: int | None = 151329 eos_token_id: int | list[int] | None = None bos_token_id: int | None = None attention_bias: bool = True )
参数
- vocab_size (
int, 可选, 默认为151552) — 模型的词汇表大小。定义了input_ids可表示的不同 token 的数量。 - hidden_size (
int, 可选, 默认为4096) — 隐藏层表示的维度。 - intermediate_size (
int, 可选, 默认为13696) — MLP 表示的维度。 - num_hidden_layers (
int, 可选, 默认为40) — Transformer 解码器中的隐藏层数量。 - num_attention_heads (
int, 可选, 默认为32) — Transformer 解码器中每个注意力层的注意力头数。 - num_key_value_heads (
int, 可选, 默认为2) — 这是用于实现分组查询注意力(Grouped Query Attention)的 key_value 头数。如果num_key_value_heads=num_attention_heads,模型将使用多头注意力(MHA);如果num_key_value_heads=1,模型将使用多查询注意力(MQA);否则使用 GQA。在将多头检查点转换为 GQA 检查点时,每个组的 key 和 value 头应通过对原始组内的所有头进行均值池化(meanpooling)来构建。更多详细信息,请查看此论文。如果未指定,默认为num_attention_heads。 - head_dim (
int, 可选, 默认为128) — 注意力头维度。如果为 None,则默认为 hidden_size // num_attention_heads。 - hidden_act (
str, 可选, 默认为silu) — 解码器中的非线性激活函数(函数或字符串)。例如,"gelu","relu","silu"等。 - attention_dropout (
Union[float, int], 可选, 默认为0.0) — 注意力权重的 dropout 比率。 - max_position_embeddings (
int, 可选, 默认为131072) — 模型可能使用的最大序列长度。 - initializer_range (
float, 可选, 默认为0.02) — 用于初始化所有权重矩阵的 truncated_normal_initializer 的标准差。 - rms_norm_eps (
float, 可选, 默认为1.5625e-07) — rms 归一化层使用的 epsilon 值。 - use_cache (
bool, 可选, 默认为True) — 模型是否应返回最后的键/值注意力(并非所有模型都使用)。仅在config.is_decoder=True或模型是纯解码器生成模型时相关。 - tie_word_embeddings (
bool, 可选, 默认为False) — 是否根据模型的tied_weights_keys映射来绑定权重嵌入。 - rope_parameters (
Union[~modeling_rope_utils.RopeParameters, dict], 可选) — 包含 RoPE 嵌入配置参数的字典。该字典应包含rope_theta的值,如果希望在更长的max_position_embeddings下使用 RoPE,还可以选择包含缩放参数。 - pad_token_id (
int, 可选, 默认为151329) — 用于在词汇表中进行填充的 token ID。 - eos_token_id (
Union[int, list[int]], 可选) — 用于词汇表中流结束(end-of-stream)的 token ID。 - bos_token_id (
int, 可选) — 用于词汇表中流开始(beginning-of-stream)的 token ID。 - attention_bias (
bool, 可选, 默认为True) — 在自注意力期间是否在查询、键、值和输出投影层中使用偏置。
这是一个用于存储 Glm4Model 配置的配置类。它用于根据指定的参数实例化 Glm4 模型,定义模型架构。使用默认值实例化配置将产生与 zai-org/GLM-OCR 类似的配置。
配置对象继承自 PreTrainedConfig,可用于控制模型输出。阅读 PreTrainedConfig 的文档以获取更多信息。
示例
>>> from transformers import Glm4Model, Glm4Config
>>> # Initializing a Glm4 glm4-4-9b-chat style configuration
>>> configuration = Glm4Config()
>>> # Initializing a model from the glm4-4-9b-chat style configuration
>>> model = Glm4Model(configuration)
>>> # Accessing the model configuration
>>> configuration = model.configGlm4Model
class transformers.Glm4Model
< 源码 >( config: Glm4Config )
参数
- config (Glm4Config) — 包含模型所有参数的模型配置类。使用配置文件初始化不会加载与模型相关的权重,仅加载配置。请查看 from_pretrained() 方法以加载模型权重。
原始的 Glm4 模型,输出原始隐藏状态,顶部没有任何特定的头部。
该模型继承自 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),可选) — 词表中输入序列标记的索引。默认情况下,填充(padding)将被忽略。索引可以使用 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 缓存指南。如果不传递
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 时),根据配置 (Glm4Config) 和输入包含不同的元素。
Glm4Model 的前向传播方法,覆盖了 __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 后的注意力权重,用于计算自注意力头中的加权平均值。
Glm4ForCausalLM
class transformers.Glm4ForCausalLM
< 源代码 >( 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 (Glm4ForCausalLM) — 包含模型所有参数的模型配置类。使用配置文件初始化不会加载与模型相关的权重,仅加载配置。请查看 from_pretrained() 方法以加载模型权重。
用于因果语言建模(causal language modeling)的 Glm4 模型。
该模型继承自 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),可选) — 词表中输入序列标记的索引。默认情况下,填充(padding)将被忽略。索引可以使用 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 缓存指南。如果不传递
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的标记将被忽略(掩码),损失仅针对标签在[0, ..., config.vocab_size]范围内的标记进行计算。 - use_cache (
bool,可选) — 如果设为True,将返回past_key_values键值状态,可用于加速解码(参见past_key_values)。 - logits_to_keep (
Union[int, torch.Tensor],可选,默认为0) — 如果为int,则计算最后logits_to_keep个标记的对数几率(logits)。如果为0,则计算所有input_ids的对数几率(特殊情况)。生成时仅需要最后一个标记的对数几率,仅针对该标记进行计算可以节省内存,这对于长序列或大词表规模来说非常显著。如果为torch.Tensor,则必须是对应于序列长度维度中要保留的索引的一维张量。这在使用填充张量格式(批次和序列长度的单一维度)时非常有用。
返回
CausalLMOutputWithPast or tuple(torch.FloatTensor)
一个 CausalLMOutputWithPast 或一个 torch.FloatTensor 元组(如果传递了 return_dict=False 或 config.return_dict=False 时),根据配置 (Glm4Config) 和输入包含不同的元素。
Glm4ForCausalLM 的前向传播方法,覆盖了 __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, Glm4ForCausalLM
>>> model = Glm4ForCausalLM.from_pretrained("THUDM/GLM-4-9B-0414")
>>> tokenizer = AutoTokenizer.from_pretrained("THUDM/GLM-4-9B-0414")
>>> 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."Glm4ForSequenceClassification
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 (
torch.LongTensor,形状为(batch_size, sequence_length),可选) — 词表中输入序列标记的索引。默认情况下,填充(padding)将被忽略。索引可以使用 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 指南。如果不传入
past_key_values,将默认初始化 DynamicCache。模型将输出与输入格式相同的缓存。
如果使用
past_key_values,用户只需输入形状为(batch_size, unprocessed_length)的未处理input_ids(即其过去键值状态未提供给此模型的那些输入),而不是形状为(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的标记将被忽略(掩盖),损失仅针对标签在[0, ..., config.vocab_size]范围内的标记计算。 - 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 后的注意力权重,用于计算自注意力头中的加权平均值。
Glm4ForTokenClassification
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 (
torch.LongTensor,形状为(batch_size, sequence_length),可选) — 词表中输入序列标记的索引。填充(Padding)将被默认忽略。索引可以使用 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 指南。如果不传入
past_key_values,将默认初始化 DynamicCache。模型将输出与输入格式相同的缓存。
如果使用
past_key_values,用户只需输入形状为(batch_size, unprocessed_length)的未处理input_ids(即其过去键值状态未提供给此模型的那些输入),而不是形状为(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的标记将被忽略(掩盖),损失仅针对标签在[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 后的注意力权重,用于计算自注意力头中的加权平均值。