Transformers 文档
GLM-4
并获得增强的文档体验
开始使用
该模型于 2024-06-18 发布,并于 2024-10-18 添加到 Hugging Face Transformers。
GLM-4
概述
GLM 模型在 ChatGLM: A Family of Large Language Models from GLM-130B to GLM-4 All Tools 中由 GLM Team, THUDM & ZhipuAI 提出。
论文摘要如下:
我们介绍 ChatGLM,一个我们一直在开发的演进式大型语言模型系列。本报告主要关注 GLM-4 语言系列,其中包括 GLM-4、GLM-4-Air 和 GLM-4-9B。它们代表了我们从前三代 ChatGLM 中汲取了所有见解和经验教训后训练出来的最强大的模型。截至目前,GLM-4 模型已在万亿级别(trillions of tokens)的中文和英文数据上进行了预训练,并包含少量来自 24 种语言的语料库,主要针对中文和英文使用进行了对齐。高质量的对齐是通过多阶段的后训练过程实现的,包括监督微调和人类反馈学习。评估结果表明,GLM-4 在通用指标(如 MMLU、GSM8K、MATH、BBH、GPQA 和 HumanEval)方面,1) 与 GPT-4 旗鼓相当或优于 GPT-4;2) 在 IFEval 衡量的指令遵循能力上接近 GPT-4-Turbo;3) 在长上下文任务上与 GPT-4 Turbo (128K) 和 Claude 3 相当;4) 在 AlignBench 衡量的中文对齐能力上优于 GPT-4。GLM-4 All Tools 模型进一步对齐,能够理解用户意图,并自主决定何时以及使用哪些工具(包括网页浏览器、Python 解释器、文本到图像模型以及用户定义的函数)来有效完成复杂任务。在实际应用中,它在通过网页浏览访问在线信息和使用 Python 解释器解决数学问题等任务上,能够媲美甚至超越 GPT-4 All Tools。在此过程中,我们开源了一系列模型,包括 ChatGLM-6B(三代)、GLM-4-9B(128K、1M)、GLM-4V-9B、WebGLM 和 CodeGeeX,仅在 2023 年就在 Hugging Face 上吸引了超过 1000 万次下载。
技巧
使用技巧
GLM-4 可以在 Huggingface Hub 上找到。
接下来,我们将演示如何使用 glm-4-9b-chat 进行推理。请注意,我们使用了 ChatML 格式进行对话,在这个演示中,我们将展示如何为此目的利用 apply_chat_template。
>>> from transformers import AutoModelForCausalLM, AutoTokenizer
from accelerate import Accelerator
>>> device = Accelerator().device # the device to load the model onto
>>> model = AutoModelForCausalLM.from_pretrained("THUDM/glm-4-9b-chat", device_map="auto", trust_remote_code=True)
>>> tokenizer = AutoTokenizer.from_pretrained("THUDM/glm-4-9b-chat")
>>> 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(model.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]GlmConfig
class transformers.GlmConfig
< source >( vocab_size: int | None = 151552 hidden_size: int | None = 4096 intermediate_size: int | None = 13696 num_hidden_layers: int | None = 40 num_attention_heads: int | None = 32 num_key_value_heads: int | None = 2 head_dim: int | None = 128 hidden_act: str | None = 'silu' attention_dropout: float | None = 0.0 max_position_embeddings: int | None = 131072 initializer_range: float | None = 0.02 rms_norm_eps: float | None = 1.5625e-07 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 pad_token_id: int | None = 151329 eos_token_id: list[int] | None = [151329, 151336, 151338] bos_token_id: int | None = None attention_bias: bool | None = True **kwargs )
参数
- vocab_size (
int, optional, defaults to 151552) — Glm 模型词汇表大小。定义在调用 GlmModel 时传递的inputs_ids所能表示的不同 token 的数量。 - hidden_size (
int, optional, defaults to 4096) — 隐藏表示的维度。 - intermediate_size (
int, optional, defaults to 13696) — MLP 表示的维度。 - num_hidden_layers (
int, optional, defaults to 40) — Transformer 解码器中的隐藏层数。 - num_attention_heads (
int, optional, defaults to 32) — Transformer 解码器中每个注意力层的注意力头数量。 - num_key_value_heads (
int, optional, defaults to 2) — 这是实现分组查询注意力(Grouped Query Attention)所需的 key_value 头数。如果num_key_value_heads=num_attention_heads,模型将使用多头注意力 (MHA);如果num_key_value_heads=1,模型将使用多查询注意力 (MQA);否则使用 GQA。在将多头检查点转换为 GQA 检查点时,每个组的键和值头应通过平均池化该组内的所有原始头来构建。更多详情,请参阅 这篇论文。如果未指定,将默认为num_attention_heads。 - head_dim (
int, optional, defaults to 128) — 注意力头的维度。 - hidden_act (
strorfunction, optional, defaults to"silu") — 遗留激活函数。它会被hidden_activation覆盖。 - attention_dropout (
float, optional, defaults to 0.0) — 注意力概率的 dropout 比率。 - max_position_embeddings (
int, optional, defaults to 131072) — 此模型可能使用的最大序列长度。 - initializer_range (
float, optional, defaults to 0.02) — 初始化所有权重矩阵的 truncated_normal_initializer 的标准差。 - rms_norm_eps (
float, optional, defaults to 1.5625e-07) — RMS 归一化层使用的 epsilon 值。 - use_cache (
bool, optional, defaults toTrue) — 是否应返回最后一个键/值注意力(并非所有模型都使用)。仅当config.is_decoder=True时相关。 - tie_word_embeddings (
bool, optional, defaults toFalse) — 是否绑定词嵌入权重。 - rope_parameters (
RopeParameters, optional) — 包含 RoPE 嵌入配置参数的字典。该字典应包含rope_theta的值,以及可选的用于缩放的参数,以防您想在更长的max_position_embeddings下使用 RoPE。 - pad_token_id (
int, optional, defaults to 151329) — 填充 token ID。 - eos_token_id (
int|list, optional, defaults to[151329, 151336, 151338]) — 结束流 token ID。 - bos_token_id (
int, optional) — 开始流 token ID。 - attention_bias (
bool, defaults toFalse, optional, defaults toTrue) — 在自注意力期间查询、键、值和输出投影层中使用偏差。
这是存储 GlmModel 配置的配置类。它用于根据指定的参数实例化 Glm 模型,定义模型的架构。使用默认值实例化配置将产生与 Glm-4-9b-chat 类似的配置。例如 THUDM/glm-4-9b-chat。配置对象继承自 PreTrainedConfig,并可用于控制模型输出。有关更多信息,请阅读 PreTrainedConfig 的文档。
>>> from transformers import GlmModel, GlmConfig
>>> # Initializing a Glm glm-4-9b-chat style configuration
>>> configuration = GlmConfig()
>>> # Initializing a model from the glm-4-9b-chat style configuration
>>> model = GlmModel(configuration)
>>> # Accessing the model configuration
>>> configuration = model.configGlmModel
class transformers.GlmModel
< 源代码 >( config: GlmConfig )
参数
- config (GlmConfig) — 模型配置类,包含模型的全部参数。使用配置文件初始化不会加载与模型相关的权重,只会加载配置。查看 from_pretrained() 方法来加载模型权重。
模型输出原始的 hidden-states,没有任何特定的头。
此模型继承自 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 cache_position: torch.LongTensor | None = None use_cache: bool | None = None **kwargs: typing_extensions.Unpack[transformers.utils.generic.TransformersKwargs] ) → transformers.modeling_outputs.BaseModelOutputWithPast 或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensor, shape(batch_size, sequence_length), optional) — 词汇表中的输入序列 token 索引。默认情况下会忽略填充(padding)。可以使用 AutoTokenizer 获取索引。详情请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
torch.Tensor, shape(batch_size, sequence_length), optional) — 用于避免对填充 token 索引执行 attention 的掩码。掩码值选择在[0, 1]:- 1 表示未被掩码的 token,
- 0 表示被掩码的 token。
- position_ids (
torch.LongTensor, shape(batch_size, sequence_length), optional) — 位置嵌入中每个输入序列 token 的位置索引。选择范围为[0, config.n_positions - 1]。 - past_key_values (
~cache_utils.Cache, optional) — 可用于加速顺序解码的预计算 hidden-states(自注意力块和交叉注意力块中的键和值)。这通常是当use_cache=True或config.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, shape(batch_size, sequence_length, hidden_size), optional) — 可选地,您可以通过传入嵌入表示来代替input_ids。如果您希望对如何将input_ids索引转换为关联向量有比模型内部嵌入查找矩阵更多的控制,则此选项很有用。 - cache_position (
torch.LongTensor, shape(sequence_length), optional) — 描绘输入序列 token 在序列中位置的索引。与position_ids不同,此张量不受填充(padding)的影响。它用于在正确位置更新 cache 并推断完整序列长度。 - use_cache (
bool, optional) — 如果设置为True,则会返回past_key_values键值状态,可用于加速解码(请参阅past_key_values)。
返回
transformers.modeling_outputs.BaseModelOutputWithPast or tuple(torch.FloatTensor)
一个 transformers.modeling_outputs.BaseModelOutputWithPast 或一个 torch.FloatTensor 元组(如果传入 return_dict=False 或当 config.return_dict=False 时),包含根据配置(GlmConfig)和输入而变化的各种元素。
-
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=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 后的注意力权重,用于计算自注意力头中的加权平均值。
transformers.GlmModel 的 forward 方法,覆盖了 __call__ 特殊方法。
虽然 forward pass 的实现需要在此函数中定义,但你应该在之后调用
Module实例而不是这个,因为前者负责运行预处理和后处理步骤,而后者会静默地忽略它们。
GlmForCausalLM
class transformers.GlmForCausalLM
< 源代码 >( 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 (GlmForCausalLM) — 模型配置类,包含模型的全部参数。使用配置文件初始化不会加载与模型相关的权重,只会加载配置。查看 from_pretrained() 方法来加载模型权重。
用于因果语言建模的 Glm 模型。
此模型继承自 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.CausalLMOutputWithPast 或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensor, shape(batch_size, sequence_length), optional) — 词汇表中的输入序列 token 索引。默认情况下会忽略填充(padding)。可以使用 AutoTokenizer 获取索引。详情请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
torch.Tensor, shape(batch_size, sequence_length), optional) — 用于避免对填充 token 索引执行 attention 的掩码。掩码值选择在[0, 1]:- 1 表示未被掩码的 token,
- 0 表示被掩码的 token。
- position_ids (
torch.LongTensor, shape(batch_size, sequence_length), optional) — 位置嵌入中每个输入序列 token 的位置索引。选择范围为[0, config.n_positions - 1]。 - past_key_values (
~cache_utils.Cache, optional) — 可用于加速顺序解码的预计算 hidden-states(自注意力块和交叉注意力块中的键和值)。这通常是当use_cache=True或config.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, shape(batch_size, sequence_length, hidden_size), optional) — 可选地,您可以通过传入嵌入表示来代替input_ids。如果您希望对如何将input_ids索引转换为关联向量有比模型内部嵌入查找矩阵更多的控制,则此选项很有用。 - labels (
torch.LongTensor, shape(batch_size, sequence_length), optional) — 用于计算掩码语言模型损失的标签。索引应在[0, ..., config.vocab_size]或 -100 范围内(请参阅input_ids文档字符串)。索引设置为-100的 token 将被忽略(掩码),损失仅对标签在[0, ..., config.vocab_size]范围内的 token 计算。 - use_cache (
bool, 可选) — 如果设置为True,将返回past_key_values键值状态,可用于加速解码(参见past_key_values)。 - 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 的 logits 可以节省内存,这对于长序列或大词汇量来说非常显著。如果是torch.Tensor,则必须是对应于序列长度维度中要保留的索引的 1D 张量。当使用打包张量格式(批次和序列长度的单维)时,这很有用。
返回
transformers.modeling_outputs.CausalLMOutputWithPast or tuple(torch.FloatTensor)
A transformers.modeling_outputs.CausalLMOutputWithPast 或一个元组(如果传递了 return_dict=False 或当 config.return_dict=False 时,元组包含 torch.FloatTensor),其中包含各种元素,具体取决于配置 (GlmConfig) 和输入。
-
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 后的注意力权重,用于计算自注意力头中的加权平均值。
GlmForCausalLM 的前向方法,覆盖了 __call__ 特殊方法。
虽然 forward pass 的实现需要在此函数中定义,但你应该在之后调用
Module实例而不是这个,因为前者负责运行预处理和后处理步骤,而后者会静默地忽略它们。
示例
>>> from transformers import AutoTokenizer, GlmForCausalLM
>>> model = GlmForCausalLM.from_pretrained("meta-glm/Glm-2-7b-hf")
>>> tokenizer = AutoTokenizer.from_pretrained("meta-glm/Glm-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."GlmForSequenceClassification
forward
< source >( 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 或 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)。
返回
transformers.modeling_outputs.SequenceClassifierOutputWithPast 或 tuple(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实例而不是这个,因为前者负责运行预处理和后处理步骤,而后者会静默地忽略它们。
GlmForTokenClassification
forward
< source >( 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 或 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, optional) — If set toTrue,past_key_valueskey value states are returned and can be used to speed up decoding (seepast_key_values).
返回
transformers.modeling_outputs.TokenClassifierOutput 或 tuple(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实例而不是这个,因为前者负责运行预处理和后处理步骤,而后者会静默地忽略它们。