Transformers 文档
StableLM
并获得增强的文档体验
开始使用
StableLM
概述
StableLM 3B 4E1T 由 Stability AI 在 StableLM 3B 4E1T：技术报告中提出，是多轮预训练语言模型系列中的第一个模型。
模型详情
StableLM 3B 4E1T 是一个仅解码器的基础语言模型，在1万亿个来自不同英语和代码数据集的词元上进行了四轮预训练。该模型架构基于 Transformer，采用了部分旋转位置嵌入（Partial Rotary Position Embeddings）、SwiGLU 激活函数、LayerNorm 等技术。
我们还提供了 StableLM Zephyr 3B，这是该模型的指令微调版本，可用于基于聊天的应用。
使用技巧
- 该架构类似于 LLaMA，但 RoPE 应用于 25% 的头嵌入维度，使用 LayerNorm 而非 RMSNorm，并带有可选的 QKV 偏置项。
- 基于
StableLM 3B 4E1T的模型使用与 GPTNeoXTokenizerFast 相同的分词器。
StableLM 3B 4E1T 和 StableLM Zephyr 3B 可在 Hugging Face Hub 上找到。
以下代码片段演示了如何使用 StableLM 3B 4E1T 进行推理：
>>> from transformers import AutoModelForCausalLM, AutoTokenizer, set_seed
>>> device = "cuda" # the device to load the model onto
>>> set_seed(0)
>>> tokenizer = AutoTokenizer.from_pretrained("stabilityai/stablelm-3b-4e1t")
>>> model = AutoModelForCausalLM.from_pretrained("stabilityai/stablelm-3b-4e1t")
>>> model.to(device)
>>> model_inputs = tokenizer("The weather is always wonderful in", return_tensors="pt").to(model.device)
>>> generated_ids = model.generate(**model_inputs, max_length=32, do_sample=True)
>>> responses = tokenizer.batch_decode(generated_ids, skip_special_tokens=True)
>>> responses
['The weather is always wonderful in Costa Rica, which makes it a prime destination for retirees. That’s where the Pensionado program comes in, offering']结合 StableLM 与 Flash Attention 2
首先，请确保安装最新版本的 Flash Attention v2。
pip install -U flash-attn --no-build-isolation
同时，请确保你的硬件与 Flash-Attention 2 兼容。更多信息请参阅 flash-attn 仓库的官方文档。注意：你必须以半精度（例如 `torch.bfloat16`）加载模型。
现在，要使用 Flash Attention 2 运行模型，请参考以下代码片段：
>>> import torch
>>> from transformers import AutoModelForCausalLM, AutoTokenizer, set_seed
>>> device = "cuda" # the device to load the model onto
>>> set_seed(0)
>>> tokenizer = AutoTokenizer.from_pretrained("stabilityai/stablelm-3b-4e1t")
>>> model = AutoModelForCausalLM.from_pretrained("stabilityai/stablelm-3b-4e1t", torch_dtype=torch.bfloat16, attn_implementation="flash_attention_2")
>>> model.to(device)
>>> model_inputs = tokenizer("The weather is always wonderful in", return_tensors="pt").to(model.device)
>>> generated_ids = model.generate(**model_inputs, max_length=32, do_sample=True)
>>> responses = tokenizer.batch_decode(generated_ids, skip_special_tokens=True)
>>> responses
['The weather is always wonderful in Costa Rica, which makes it a prime destination for retirees. That’s where the Pensionado program comes in, offering']StableLmConfig
class transformers.StableLmConfig
< 来源 >( vocab_size = 50304 intermediate_size = 6912 hidden_size = 2560 num_hidden_layers = 32 num_attention_heads = 32 num_key_value_heads = 32 hidden_act = 'silu' max_position_embeddings = 4096 initializer_range = 0.02 layer_norm_eps = 1e-05 use_cache = True tie_word_embeddings = False rope_theta = 10000 rope_scaling = None use_qkv_bias = False qk_layernorm = False use_parallel_residual = False hidden_dropout = 0.0 attention_dropout = 0.0 partial_rotary_factor = 0.25 bos_token_id = 0 eos_token_id = 0 **kwargs )
参数
- vocab_size (
int, 可选, 默认为 50304) — StableLM 模型的词汇表大小。定义了在调用 StableLmModel 时，可以通过inputs_ids传递的不同词元的数量。 - intermediate_size (
int, 可选, 默认为 6912) — MLP 表示的维度。 - hidden_size (
int, 可选, 默认为 2560) — Transformer 解码器中隐藏层的数量。 - 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 检查点时，每个组的键和值头应通过对该组内所有原始头进行均值池化来构建。更多详情，请查看这篇论文。如果未指定，将默认为num_attention_heads。 - hidden_act (
str或function, 可选, 默认为"silu") — 非线性激活函数（函数或字符串）。 - max_position_embeddings (
int, 可选, 默认为 4096) — 此模型可能使用的最大序列长度。通常将其设置为一个较大的值以备不时之需（例如，512、1024 或 2048）。 - initializer_range (
float, 可选, 默认为 0.02) — 用于初始化所有权重矩阵的截断正态初始化器的标准差。 - layer_norm_eps (
float, 可选, 默认为 1e-05) — 归一化层使用的 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 嵌入的缩放因子。在大多数缩放类型中，一个 x 的factor将使模型能够处理长度为 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_qkv_bias (
bool, 可选, 默认为False) — 模型是否应为 qkv 层使用偏置。 - qk_layernorm (
bool, 可选, 默认为False) — 是否在投射隐藏状态后，对每个头的查询和键进行归一化。 - use_parallel_residual (
bool, 可选, 默认为False) — 是否在每个 Transformer 层中使用“并行”公式，这可以在大规模训练时提供轻微的训练速度提升。 - hidden_dropout (
float, 可选, 默认为 0.0) — 对隐藏状态应用 MLP 后的 dropout 比率。 - attention_dropout (
float, 可选, 默认为 0.0) — 注意力概率的 dropout 比率。 - partial_rotary_factor (
float, 可选, 默认为 0.25) — 将具有旋转嵌入的查询和键的百分比。 - bos_token_id (int, 可选, 默认为 0) — 词汇表中
BOS标记的 ID。 - eos_token_id (int, 可选, 默认为 0) — 词汇表中
EOS标记的 ID。
这是用于存储 ~StableLmModel 配置的配置类。它用于根据指定的参数实例化一个 StableLM 模型，定义模型架构。使用默认值实例化配置将产生与 StableLM stabilityai/stablelm-3b-4e1t 架构相似的配置。
配置对象继承自 PretrainedConfig，可用于控制模型输出。更多信息请阅读 PretrainedConfig 的文档。
StableLmModel
class transformers.StableLmModel
< source >( config: StableLmConfig )
参数
- config (StableLmConfig) — 包含模型所有参数的模型配置类。使用配置文件进行初始化不会加载与模型相关的权重，只会加载配置。请查阅 from_pretrained() 方法来加载模型权重。
基础的 Stablelm 模型，输出原始的隐藏状态，顶部没有任何特定的头（head）。
此模型继承自 PreTrainedModel。请查阅超类的文档以了解该库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入的大小、修剪头部等）。
该模型也是一个 PyTorch torch.nn.Module 的子类。可以像使用常规的 PyTorch 模块一样使用它，并参考 PyTorch 文档了解所有与通用用法和行为相关的事项。
forward
< source >( input_ids: typing.Optional[torch.LongTensor] = None attention_mask: typing.Optional[torch.Tensor] = None position_ids: typing.Optional[torch.LongTensor] = None past_key_values: typing.Optional[list[torch.FloatTensor]] = None inputs_embeds: typing.Optional[torch.FloatTensor] = None use_cache: typing.Optional[bool] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None cache_position: typing.Optional[torch.LongTensor] = None ) → transformers.modeling_outputs.BaseModelOutputWithPast 或 tuple(torch.FloatTensor)
参数
- input_ids (形状为
(batch_size, sequence_length)的torch.LongTensor，可选) — 词汇表中输入序列标记的索引。默认情况下，填充将被忽略。可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (形状为
(batch_size, sequence_length)的torch.Tensor，可选) — 用于避免对填充标记索引执行注意力计算的掩码。掩码值选自[0, 1]：- 1 表示标记未被屏蔽，
- 0 表示标记被屏蔽。
- position_ids (形状为
(batch_size, sequence_length)的torch.LongTensor，可选) — 每个输入序列标记在位置嵌入中的位置索引。选值范围为[0, config.n_positions - 1]。 - past_key_values (
list[torch.FloatTensor]，可选) — 预先计算的隐藏状态（自注意力和交叉注意力块中的键和值），可用于加速序列解码。这通常是在解码的先前阶段，当use_cache=True或config.use_cache=True时，由模型返回的past_key_values。允许两种格式：
- Cache 实例，请参阅我们的 kv 缓存指南；
- 长度为
config.n_layers的tuple(torch.FloatTensor)元组，其中每个元组包含 2 个形状为(batch_size, num_heads, sequence_length, embed_size_per_head)的张量。这也称为旧版缓存格式。
模型将输出与输入相同的缓存格式。如果没有传递
past_key_values，将返回旧版缓存格式。如果使用
past_key_values，用户可以选择只输入最后一个input_ids（那些没有给出过去键值状态的标记），形状为(batch_size, 1)，而不是所有形状为(batch_size, sequence_length)的input_ids。 - inputs_embeds (形状为
(batch_size, sequence_length, hidden_size)的torch.FloatTensor，可选) — 可选地，你可以选择直接传递嵌入表示，而不是传递input_ids。如果你希望比模型内部的嵌入查找矩阵有更多控制权来将input_ids索引转换为相关向量，这将非常有用。 - use_cache (
bool, 可选) — 如果设置为True，将返回past_key_values键值状态，可用于加速解码（请参阅past_key_values）。 - output_attentions (
bool, 可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参阅返回张量下的attentions。 - output_hidden_states (
bool, 可选) — 是否返回所有层的隐藏状态。有关更多详细信息，请参阅返回张量下的hidden_states。 - cache_position (形状为
(sequence_length)的torch.LongTensor，可选) — 描述输入序列标记在序列中位置的索引。与position_ids不同，此张量不受填充影响。它用于在正确的位置更新缓存并推断完整的序列长度。
返回
transformers.modeling_outputs.BaseModelOutputWithPast 或 tuple(torch.FloatTensor)
一个 transformers.modeling_outputs.BaseModelOutputWithPast 或一个 torch.FloatTensor 元组（如果传递了 return_dict=False 或当 config.return_dict=False 时），根据配置（StableLmConfig）和输入，包含各种元素。
-
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 缓存指南。包含预先计算的隐藏状态（自注意块中的键和值，如果
config.is_encoder_decoder=True，则还包括交叉注意力块中的键和值），可用于（参见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=True或config.output_attentions=True时返回) —torch.FloatTensor元组（每层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 后的注意力权重，用于计算自注意力头中的加权平均值。
StableLmModel 的 forward 方法会覆盖 __call__ 特殊方法。
虽然前向传播的流程需要在此函数中定义，但之后应调用 Module 实例而不是此函数，因为前者会处理预处理和后处理步骤，而后者会默默地忽略它们。
StableLmForCausalLM
forward
< source >( input_ids: typing.Optional[torch.LongTensor] = None attention_mask: typing.Optional[torch.Tensor] = None position_ids: typing.Optional[torch.LongTensor] = None past_key_values: typing.Optional[list[torch.FloatTensor]] = None inputs_embeds: typing.Optional[torch.FloatTensor] = None labels: typing.Optional[torch.LongTensor] = None use_cache: typing.Optional[bool] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None cache_position: typing.Optional[torch.LongTensor] = None logits_to_keep: typing.Union[int, torch.Tensor] = 0 **kwargs ) → transformers.modeling_outputs.CausalLMOutputWithPast 或 tuple(torch.FloatTensor)
参数
- input_ids (形状为
(batch_size, sequence_length)的torch.LongTensor，可选) — 词汇表中输入序列标记的索引。默认情况下，填充将被忽略。可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (形状为
(batch_size, sequence_length)的torch.Tensor，可选) — 用于避免对填充标记索引执行注意力计算的掩码。掩码值选自[0, 1]：- 1 表示标记未被屏蔽，
- 0 表示标记被屏蔽。
- position_ids (形状为
(batch_size, sequence_length)的torch.LongTensor，可选) — 每个输入序列标记在位置嵌入中的位置索引。选值范围为[0, config.n_positions - 1]。 - past_key_values (
list[torch.FloatTensor]，可选) — 预先计算的隐藏状态（自注意力和交叉注意力块中的键和值），可用于加速序列解码。这通常是在解码的先前阶段，当use_cache=True或config.use_cache=True时，由模型返回的past_key_values。允许两种格式：
- Cache 实例，请参阅我们的 kv 缓存指南；
- 长度为
config.n_layers的tuple(torch.FloatTensor)元组，其中每个元组包含 2 个形状为(batch_size, num_heads, sequence_length, embed_size_per_head)的张量。这也称为旧版缓存格式。
模型将输出与输入相同的缓存格式。如果没有传递
past_key_values，将返回旧版缓存格式。如果使用
past_key_values，用户可以选择只输入最后一个input_ids（那些没有给出过去键值状态的标记），形状为(batch_size, 1)，而不是所有形状为(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的标记将被忽略（屏蔽），损失仅对标签在[0, ..., config.vocab_size]范围内的标记进行计算。 - use_cache (
bool, 可选) — 如果设置为True，将返回past_key_values键值状态，可用于加速解码（请参阅past_key_values）。 - output_attentions (
bool, 可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参阅返回张量下的attentions。 - output_hidden_states (
bool, 可选) — 是否返回所有层的隐藏状态。有关更多详细信息，请参阅返回张量下的hidden_states。 - cache_position (形状为
(sequence_length)的torch.LongTensor，可选) — 描述输入序列标记在序列中位置的索引。与position_ids不同，此张量不受填充影响。它用于在正确的位置更新缓存并推断完整的序列长度。 - logits_to_keep (
Union[int, torch.Tensor], 默认为0) — 如果是int，则为最后logits_to_keep个标记计算 logits。如果为0，则为所有input_ids计算 logits（特殊情况）。生成时只需要最后一个标记的 logits，仅为此标记计算 logits 可以节省内存，这对于长序列或大词汇量来说非常重要。如果是torch.Tensor，则必须是一维的，对应于序列长度维度中要保留的索引。这在使用打包张量格式（批次和序列长度使用单一维度）时非常有用。
返回
transformers.modeling_outputs.CausalLMOutputWithPast 或 tuple(torch.FloatTensor)
一个 transformers.modeling_outputs.CausalLMOutputWithPast 或一个 torch.FloatTensor 元组（如果传递了 return_dict=False 或当 config.return_dict=False 时），根据配置（StableLmConfig）和输入，包含各种元素。
-
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), 可选, 当传递output_hidden_states=True或config.output_hidden_states=True时返回) —torch.FloatTensor元组（如果模型有嵌入层，一个是嵌入层的输出，+ 每个层的输出一个），形状为(batch_size, sequence_length, hidden_size)。模型在每个层输出的隐藏状态以及可选的初始嵌入输出。
-
attentions (
tuple(torch.FloatTensor), 可选, 当传递output_attentions=True或config.output_attentions=True时返回) —torch.FloatTensor元组（每层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 后的注意力权重，用于计算自注意力头中的加权平均值。
StableLmForCausalLM 的 forward 方法会覆盖 __call__ 特殊方法。
虽然前向传播的流程需要在此函数中定义，但之后应调用 Module 实例而不是此函数，因为前者会处理预处理和后处理步骤，而后者会默默地忽略它们。
示例
>>> from transformers import AutoTokenizer, StableLmForCausalLM
>>> model = StableLmForCausalLM.from_pretrained("adept/persimmon-8b-base")
>>> tokenizer = AutoTokenizer.from_pretrained("adept/persimmon-8b-base")
>>> prompt = "human: Hey, what should I eat for dinner?"
>>> 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]
'human: Hey, what should I eat for dinner?\n\ncat: 🐱\n\nhuman: 😐\n\n'StableLmForSequenceClassification
class transformers.StableLmForSequenceClassification
< source >( config )
参数
- config (StableLmForSequenceClassification) — 包含模型所有参数的模型配置类。使用配置文件进行初始化不会加载与模型相关的权重，只会加载配置。请查阅 from_pretrained() 方法来加载模型权重。
带有序列分类头（线性层）的 StableLm transformer。
StableLmForSequenceClassification 使用最后一个标记来进行分类，就像其他因果模型（例如 GPT-2）一样。
由于它对最后一个标记进行分类，因此需要知道最后一个标记的位置。如果在配置中定义了 pad_token_id，它会找到每行中不是填充标记的最后一个标记。如果没有定义 pad_token_id，它会简单地取批次中每行的最后一个值。由于当传递 inputs_embeds 而不是 input_ids 时它无法猜测填充标记，因此它会做同样的操作（取批次中每行的最后一个值）。
此模型继承自 PreTrainedModel。请查阅超类的文档以了解该库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入的大小、修剪头部等）。
该模型也是一个 PyTorch torch.nn.Module 的子类。可以像使用常规的 PyTorch 模块一样使用它，并参考 PyTorch 文档了解所有与通用用法和行为相关的事项。
forward
< source >( input_ids: typing.Optional[torch.LongTensor] = None attention_mask: typing.Optional[torch.Tensor] = None position_ids: typing.Optional[torch.LongTensor] = None past_key_values: typing.Optional[transformers.cache_utils.Cache] = None inputs_embeds: typing.Optional[torch.FloatTensor] = None labels: typing.Optional[torch.LongTensor] = None use_cache: typing.Optional[bool] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None ) → transformers.modeling_outputs.SequenceClassifierOutputWithPast 或 tuple(torch.FloatTensor)
参数
- input_ids (形状为
(batch_size, sequence_length)的torch.LongTensor，可选) — 词汇表中输入序列标记的索引。默认情况下，填充将被忽略。可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (形状为
(batch_size, sequence_length)的torch.Tensor，可选) — 用于避免对填充标记索引执行注意力计算的掩码。掩码值选自[0, 1]：- 1 表示标记未被屏蔽，
- 0 表示标记被屏蔽。
- position_ids (形状为
(batch_size, sequence_length)的torch.LongTensor，可选) — 每个输入序列标记在位置嵌入中的位置索引。选值范围为[0, config.n_positions - 1]。 - past_key_values (
~cache_utils.Cache, 可选) — 预先计算的隐藏状态（自注意力和交叉注意力块中的键和值），可用于加速序列解码。这通常是在解码的先前阶段，当use_cache=True或config.use_cache=True时，由模型返回的past_key_values。允许两种格式：
- Cache 实例，请参阅我们的 kv 缓存指南；
- 长度为
config.n_layers的tuple(torch.FloatTensor)元组，其中每个元组包含 2 个形状为(batch_size, num_heads, sequence_length, embed_size_per_head)的张量。这也称为旧版缓存格式。
模型将输出与输入相同的缓存格式。如果没有传递
past_key_values，将返回旧版缓存格式。如果使用
past_key_values，用户可以选择只输入最后一个input_ids（那些没有给出过去键值状态的标记），形状为(batch_size, 1)，而不是所有形状为(batch_size, sequence_length)的input_ids。 - inputs_embeds (形状为
(batch_size, sequence_length, hidden_size)的torch.FloatTensor，可选) — 可选地，你可以选择直接传递嵌入表示，而不是传递input_ids。如果你希望比模型内部的嵌入查找矩阵有更多控制权来将input_ids索引转换为相关向量，这将非常有用。 - labels (形状为
(batch_size,)的torch.LongTensor，可选) — 用于计算序列分类/回归损失的标签。索引应在[0, ..., config.num_labels - 1]范围内。如果config.num_labels == 1，则计算回归损失（均方损失），如果config.num_labels > 1，则计算分类损失（交叉熵）。 - use_cache (
bool, 可选) — 如果设置为True，将返回past_key_values键值状态，可用于加速解码（请参阅past_key_values）。 - output_attentions (
bool, 可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参阅返回张量下的attentions。 - output_hidden_states (
bool, 可选) — 是否返回所有层的隐藏状态。有关更多详细信息，请参阅返回张量下的hidden_states。
返回
transformers.modeling_outputs.SequenceClassifierOutputWithPast 或 tuple(torch.FloatTensor)
一个 transformers.modeling_outputs.SequenceClassifierOutputWithPast 或一个 torch.FloatTensor 元组（如果传递了 return_dict=False 或当 config.return_dict=False 时），根据配置（StableLmConfig）和输入，包含各种元素。
-
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), 可选, 当传递output_hidden_states=True或config.output_hidden_states=True时返回) —torch.FloatTensor元组（如果模型有嵌入层，一个是嵌入层的输出，+ 每个层的输出一个），形状为(batch_size, sequence_length, hidden_size)。模型在每个层输出的隐藏状态以及可选的初始嵌入输出。
-
attentions (
tuple(torch.FloatTensor), 可选, 当传递output_attentions=True或config.output_attentions=True时返回) —torch.FloatTensor元组（每层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 后的注意力权重，用于计算自注意力头中的加权平均值。
StableLmForSequenceClassification 的 forward 方法会覆盖 __call__ 特殊方法。
虽然前向传播的流程需要在此函数中定义，但之后应调用 Module 实例而不是此函数，因为前者会处理预处理和后处理步骤，而后者会默默地忽略它们。
单标签分类示例
>>> import torch
>>> from transformers import AutoTokenizer, StableLmForSequenceClassification
>>> tokenizer = AutoTokenizer.from_pretrained("stabilityai/stablelm-3b-4e1t")
>>> model = StableLmForSequenceClassification.from_pretrained("stabilityai/stablelm-3b-4e1t")
>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="pt")
>>> with torch.no_grad():
... logits = model(**inputs).logits
>>> predicted_class_id = logits.argmax().item()
>>> model.config.id2label[predicted_class_id]
...
>>> # To train a model on `num_labels` classes, you can pass `num_labels=num_labels` to `.from_pretrained(...)`
>>> num_labels = len(model.config.id2label)
>>> model = StableLmForSequenceClassification.from_pretrained("stabilityai/stablelm-3b-4e1t", num_labels=num_labels)
>>> labels = torch.tensor([1])
>>> loss = model(**inputs, labels=labels).loss
>>> round(loss.item(), 2)
...多标签分类示例
>>> import torch
>>> from transformers import AutoTokenizer, StableLmForSequenceClassification
>>> tokenizer = AutoTokenizer.from_pretrained("stabilityai/stablelm-3b-4e1t")
>>> model = StableLmForSequenceClassification.from_pretrained("stabilityai/stablelm-3b-4e1t", problem_type="multi_label_classification")
>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="pt")
>>> with torch.no_grad():
... logits = model(**inputs).logits
>>> predicted_class_ids = torch.arange(0, logits.shape[-1])[torch.sigmoid(logits).squeeze(dim=0) > 0.5]
>>> # To train a model on `num_labels` classes, you can pass `num_labels=num_labels` to `.from_pretrained(...)`
>>> num_labels = len(model.config.id2label)
>>> model = StableLmForSequenceClassification.from_pretrained(
... "stabilityai/stablelm-3b-4e1t", num_labels=num_labels, problem_type="multi_label_classification"
... )
>>> labels = torch.sum(
... torch.nn.functional.one_hot(predicted_class_ids[None, :].clone(), num_classes=num_labels), dim=1
... ).to(torch.float)
>>> loss = model(**inputs, labels=labels).lossStableLmForTokenClassification
class transformers.StableLmForTokenClassification
< source >( config )
参数
- config (StableLmForTokenClassification) — 包含模型所有参数的模型配置类。使用配置文件进行初始化不会加载与模型相关的权重，只会加载配置。请查阅 from_pretrained() 方法来加载模型权重。
带有标记分类头（一个在线性层之上的隐藏状态输出层）的 Stablelm transformer，例如用于命名实体识别（NER）任务。
此模型继承自 PreTrainedModel。请查阅超类的文档以了解该库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入的大小、修剪头部等）。
该模型也是一个 PyTorch torch.nn.Module 的子类。可以像使用常规的 PyTorch 模块一样使用它，并参考 PyTorch 文档了解所有与通用用法和行为相关的事项。
forward
< source >( input_ids: typing.Optional[torch.LongTensor] = None attention_mask: typing.Optional[torch.Tensor] = None position_ids: typing.Optional[torch.LongTensor] = None past_key_values: typing.Optional[transformers.cache_utils.Cache] = None inputs_embeds: typing.Optional[torch.FloatTensor] = None labels: typing.Optional[torch.LongTensor] = None use_cache: typing.Optional[bool] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None ) → transformers.modeling_outputs.TokenClassifierOutput 或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensor，形状为(batch_size, sequence_length)，可选) — 词汇表中输入序列标记的索引。默认情况下，填充将被忽略。索引可以使用 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，可选) — 预先计算的隐藏状态（自注意力和交叉注意力块中的键和值），可用于加速序列解码。这通常是在解码的前一个阶段，当use_cache=True或config.use_cache=True时，由模型返回的past_key_values。允许两种格式：
- Cache 实例，请参阅我们的 kv cache 指南；
- 长度为
config.n_layers的tuple(torch.FloatTensor)元组，每个元组包含 2 个形状为(batch_size, num_heads, sequence_length, embed_size_per_head)的张量。这也称为传统缓存格式。
模型将输出与输入相同的缓存格式。如果未传递
past_key_values，将返回传统缓存格式。如果使用
past_key_values，用户可以选择只输入最后一个input_ids（那些没有为其提供过去键值状态的标记），其形状为(batch_size, 1)，而不是形状为(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,)，可选) — 用于计算序列分类/回归损失的标签。索引应在[0, ..., config.num_labels - 1]范围内。如果config.num_labels == 1，则计算回归损失（均方损失），如果config.num_labels > 1，则计算分类损失（交叉熵）。 - use_cache (
bool，可选) — 如果设置为True，将返回past_key_values键值状态，可用于加速解码（参见past_key_values）。 - output_attentions (
bool，可选) — 是否返回所有注意力层的注意力张量。更多详情请参阅返回张量下的attentions。 - output_hidden_states (
bool，可选) — 是否返回所有层的隐藏状态。更多详情请参阅返回张量下的hidden_states。
返回
transformers.modeling_outputs.TokenClassifierOutput 或 tuple(torch.FloatTensor)
一个 transformers.modeling_outputs.TokenClassifierOutput 或一个 torch.FloatTensor 的元组（如果传递了 return_dict=False 或当 config.return_dict=False 时），根据配置（StableLmConfig）和输入包含各种元素。
-
loss (形状为
(1,)的torch.FloatTensor，可选，当提供labels时返回) — 分类损失。 -
logits (形状为
(batch_size, sequence_length, config.num_labels)的torch.FloatTensor) — 分类分数（SoftMax 之前）。 -
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=True或config.output_attentions=True时返回) —torch.FloatTensor元组（每层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 后的注意力权重，用于计算自注意力头中的加权平均值。
StableLmForTokenClassification 的前向方法覆盖了 __call__ 特殊方法。
虽然前向传播的流程需要在此函数中定义，但之后应调用 Module 实例而不是此函数，因为前者会处理预处理和后处理步骤，而后者会默默地忽略它们。
示例
>>> from transformers import AutoTokenizer, StableLmForTokenClassification
>>> import torch
>>> tokenizer = AutoTokenizer.from_pretrained("stabilityai/stablelm-3b-4e1t")
>>> model = StableLmForTokenClassification.from_pretrained("stabilityai/stablelm-3b-4e1t")
>>> inputs = tokenizer(
... "HuggingFace is a company based in Paris and New York", add_special_tokens=False, return_tensors="pt"
... )
>>> with torch.no_grad():
... logits = model(**inputs).logits
>>> predicted_token_class_ids = logits.argmax(-1)
>>> # Note that tokens are classified rather then input words which means that
>>> # there might be more predicted token classes than words.
>>> # Multiple token classes might account for the same word
>>> predicted_tokens_classes = [model.config.id2label[t.item()] for t in predicted_token_class_ids[0]]
>>> predicted_tokens_classes
...
>>> labels = predicted_token_class_ids
>>> loss = model(**inputs, labels=labels).loss
>>> round(loss.item(), 2)
...