Transformers 文档
Persimmon
并获得增强的文档体验
开始使用
该模型于 2023-09-12 被贡献给 Hugging Face Transformers。
Persimmon
概述
Persimmon 模型由 ADEPT 创建，作者包括 Erich Elsen、Augustus Odena、Maxwell Nye、Sağnak Taşırlar、Tri Dao、Curtis Hawthorne、Deepak Moparthi 和 Arushi Somani。
作者们推出了 Persimmon-8B，这是一款基于经典 Transformer 架构的解码器模型，具有查询（query）和键（key）归一化。Persimmon-8B 是一款完全宽松授权的模型，拥有约 80 亿参数，在 Apache 许可证下发布。Persimmon-8B 的一些关键属性包括长上下文大小（16K）、优异的性能以及多模态扩展能力。
作者展示了他们的模型评估方法，重点关注实际的文本生成，从而反映用户与语言模型的真实交互方式。该研究还进行了一项对比分析，在各种评估任务中，将 Persimmon-8B 与其他知名模型（MPT 7B Instruct 和 Llama 2 Base 7B 1-Shot）进行了比较。结果表明，即使在有限的训练数据下，Persimmon-8B 依然展现出了极具竞争力的性能。
在模型细节方面，该研究概述了 Persimmon-8B 的架构和训练方法，深入探讨了其设计选择、序列长度和数据集构成。作者们展示了一段快速推理代码，通过算子融合和 CUDA 图（CUDA graph）利用，在保持代码一致性的同时，其性能超越了传统实现。他们表达了对社区将如何利用这一贡献推动创新的期待，并暗示该系列后续还将有更多发布。
使用技巧
Persimmon模型是使用bfloat16进行训练的，但原始推理使用的是float16。上传到 Hub 上的检查点使用dtype = 'float16'，AutoModelAPI 将使用该参数将检查点从torch.float32转换为torch.float16。在线权重的
dtype基本上是不相关的，除非您在使用model = AutoModelForCausalLM.from_pretrained("path", dtype = "auto")初始化模型时使用了dtype="auto"。原因是模型会先被下载（使用在线检查点的dtype），然后会被转换为torch的默认dtype（变为torch.float32，device_map="auto"）。用户应当指定他们想要的dtype，如果未指定，默认将为torch.float32。不建议在
float16下对模型进行微调，因为这已知会导致产生nan，因此模型应该在bfloat16下进行微调。
技巧
- 要转换模型，您需要使用
git clone https://github.com/persimmon-ai-labs/adept-inference克隆原始仓库，然后获取检查点。
git clone https://github.com/persimmon-ai-labs/adept-inference
wget https://axtkn4xl5cip.objectstorage.us-phoenix-1.oci.customer-oci.com/n/axtkn4xl5cip/b/adept-public-data/o/8b_base_model_release.tar
tar -xvf 8b_base_model_release.tar
python src/transformers/models/persimmon/convert_persimmon_weights_to_hf.py --input_dir /path/to/downloaded/persimmon/weights/ --output_dir /output/path \
--pt_model_path /path/to/8b_chat_model_release/iter_0001251/mp_rank_00/model_optim_rng.pt
--ada_lib_path /path/to/adept-inference对于 Chat（聊天）模型
wget https://axtkn4xl5cip.objectstorage.us-phoenix-1.oci.customer-oci.com/n/axtkn4xl5cip/b/adept-public-data/o/8b_chat_model_release.tar tar -xvf 8b_base_model_release.tar
此后，可以通过以下方式加载模型
from transformers import PersimmonForCausalLM, PersimmonTokenizer
model = PersimmonForCausalLM.from_pretrained("/output/path", device_map="auto")
tokenizer = PersimmonTokenizer.from_pretrained("/output/path")Persimmon 使用基于
sentencepiece且采用Unigram模型的分词器（tokenizer）。它支持字节回退（bytefallback），这在快速分词器中仅适用于tokenizers==0.14.0。由于LlamaTokenizer是对 sentencepiece 的标准封装，因而采用了它。chat模板将在后续的 PR 中通过模板函数进行更新！作者建议在聊天模式下使用以下提示词格式：
f"human: {prompt}\n\nadept:"
PersimmonConfig
class transformers.PersimmonConfig
< source >( 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 = 262144 hidden_size: int = 4096 intermediate_size: int = 16384 num_hidden_layers: int = 36 num_attention_heads: int = 64 hidden_act: str = 'relu2' max_position_embeddings: int = 16384 initializer_range: float = 0.02 layer_norm_eps: float = 1e-05 use_cache: bool = True tie_word_embeddings: bool = False rope_parameters: transformers.modeling_rope_utils.RopeParameters | dict | None = None qk_layernorm: bool = True hidden_dropout: float | int = 0.0 attention_dropout: float | int = 0.0 pad_token_id: int | None = None bos_token_id: int | None = 1 eos_token_id: int | list[int] | None = 2 )
参数
- vocab_size (
int, 可选, 默认为262144) — 模型的词表大小。定义了input_ids可以表示的不同 token 的数量。 - hidden_size (
int, 可选, 默认为4096) — 隐层表示的维度。 - intermediate_size (
int, 可选, 默认为16384) — MLP 表示的维度。 - num_hidden_layers (
int, 可选, 默认为36) — Transformer 解码器中的隐层数量。 - num_attention_heads (
int, 可选, 默认为64) — Transformer 解码器中每个注意力层的注意力头数。 - hidden_act (
str, 可选, 默认为relu2) — 解码器中的非线性激活函数（函数或字符串）。例如"gelu"、"relu"、"silu"等。 - max_position_embeddings (
int, 可选, 默认为16384) — 该模型可能使用的最大序列长度。 - initializer_range (
float, 可选, 默认为0.02) — 用于初始化所有权重矩阵的 truncated_normal_initializer 的标准差。 - layer_norm_eps (
float, 可选, 默认为1e-05) — 层归一化（layer normalization）层所使用的 epsilon 值。 - use_cache (
bool, 可选, 默认为True) — 模型是否应该返回最后的键/值（key/values）注意力（并非所有模型都使用）。仅在config.is_decoder=True或模型是仅解码器（decoder-only）生成模型时才相关。 - tie_word_embeddings (
bool, 可选, 默认为False) — 是否根据模型的tied_weights_keys映射来绑定权重嵌入（weight embeddings）。 - rope_parameters (
Union[~modeling_rope_utils.RopeParameters, dict], 可选) — 包含 RoPE 嵌入配置参数的字典。该字典应包含rope_theta的值，以及在您希望使用更长max_position_embeddings的 RoPE 时，可选的缩放参数。 - qk_layernorm (
bool, 可选, 默认为True) — 是否在投影隐层状态后对查询（Queries）和键（Keys）进行归一化。 - hidden_dropout (
Union[float, int], 可选, 默认为0.0) — 嵌入层、编码器和池化器中所有全连接层的丢弃（dropout）概率。 - attention_dropout (
Union[float, int], 可选, 默认为0.0) — 注意力概率的丢弃（dropout）比例。 - pad_token_id (
int, 可选) — 词表中用于填充（padding）的 token id。 - bos_token_id (
int, 可选, 默认为1) — 词表中用于流开始（beginning-of-stream）的 token id。 - eos_token_id (
Union[int, list[int]], 可选, 默认为2) — 词表中用于流结束（end-of-stream）的 token id。
这是用于存储 PersimmonModel 配置的配置类。它用于根据指定的参数实例化 Persimmon 模型，从而定义模型架构。使用默认值实例化配置将产生与 adept/persimmon-8b-base 类似的配置。
配置对象继承自 PreTrainedConfig，可用于控制模型输出。阅读 PreTrainedConfig 的文档以获取更多信息。
PersimmonModel
class transformers.PersimmonModel
< source >( config: PersimmonConfig )
参数
- config (PersimmonConfig) — 包含模型所有参数的模型配置类。使用配置文件进行初始化不会加载与模型关联的权重，只会加载配置。请查看 from_pretrained() 方法以加载模型权重。
基础的 Persimmon 模型，输出原始的隐藏状态（hidden-states），顶部没有添加任何特定的任务头。
该模型继承自 PreTrainedModel。请查看超类文档以了解该库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、剪枝头部等）。
此模型也是一个 PyTorch torch.nn.Module 子类。像普通的 PyTorch Module 一样使用它，并参考 PyTorch 文档了解一般用法和行为的所有相关信息。
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 use_cache: bool | None = None **kwargs: typing_extensions.Unpack[transformers.utils.generic.TransformersKwargs] ) → BaseModelOutputWithPast 或 tuple(torch.FloatTensor)
参数
- input_ids (形状为
(batch_size, sequence_length)的torch.LongTensor, 可选) — 输入序列 token 在词表中的索引。默认情况下将忽略填充（padding）。可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (形状为
(batch_size, sequence_length)的torch.Tensor, 可选) — 用于避免在填充 token 索引上执行注意力的掩码（mask）。掩码值选在[0, 1]之间：- 对于未被掩码的 token 为 1，
- 对于被掩码的 token 为 0。
- position_ids (形状为
(batch_size, sequence_length)的torch.LongTensor, 可选) — 每个输入序列 token 在位置嵌入（position embeddings）中的位置索引。选值范围在[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，用户应仅输入未处理的input_ids（即未将其过去键值状态提供给该模型的那些 token），其形状为(batch_size, unprocessed_length)，而不是所有形状为(batch_size, sequence_length)的input_ids。 - inputs_embeds (形状为
(batch_size, sequence_length, hidden_size)的torch.FloatTensor, 可选) — 选填。你可以选择直接传递嵌入表示（embedded representation），而不是传递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 时），包含取决于配置（PersimmonConfig）和输入的各种元素。
PersimmonModel 的前向传播（forward）方法，重写了 __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 后的注意力权重，用于计算自注意力头中的加权平均值。
PersimmonForCausalLM
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 logits_to_keep: int | torch.Tensor = 0 **kwargs: typing_extensions.Unpack[transformers.utils.generic.TransformersKwargs] ) → CausalLMOutputWithPast or tuple(torch.FloatTensor)
参数
- input_ids (形状为
(batch_size, sequence_length)的torch.LongTensor, 可选) — 输入序列 token 在词表中的索引。默认情况下将忽略填充（padding）。可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (形状为
(batch_size, sequence_length)的torch.Tensor, 可选) — 用于避免在填充 token 索引上执行注意力的掩码（mask）。掩码值选在[0, 1]之间：- 对于未被掩码的 token 为 1，
- 对于被掩码的 token 为 0。
- position_ids (形状为
(batch_size, sequence_length)的torch.LongTensor, 可选) — 每个输入序列 token 在位置嵌入（position embeddings）中的位置索引。选值范围在[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，用户应仅输入未处理的input_ids（即未将其过去键值状态提供给该模型的那些 token），其形状为(batch_size, unprocessed_length)，而不是所有形状为(batch_size, sequence_length)的input_ids。 - inputs_embeds (形状为
(batch_size, sequence_length, hidden_size)的torch.FloatTensor, 可选) — 选填。你可以选择直接传递嵌入表示（embedded representation），而不是传递input_ids。这对于以下情况非常有用：与使用模型内部的嵌入查找矩阵相比，你希望能够更自主地控制如何将input_ids索引转换为关联的向量。 - labels (形状为
(batch_size, sequence_length)的torch.LongTensor, 可选) — 用于计算掩码语言模型（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）。 - logits_to_keep (
Union[int, torch.Tensor], 可选, 默认为0) — 如果是int，则计算最后logits_to_keep个 token 的 logits。如果是0，则计算所有input_ids的 logits（特殊情况）。生成时仅需要最后一个 token 的 logits，仅为该 token 计算 logits 可以节省内存，这在长序列或词表较大时非常显著。如果是torch.Tensor，则必须是一维的，对应要在序列长度维度上保留的索引。这在使用打包张量格式（Packed Tensor Format，即批次和序列长度为单维度）时非常有用。
返回
CausalLMOutputWithPast or tuple(torch.FloatTensor)
一个 CausalLMOutputWithPast 或 torch.FloatTensor 元组（如果传入了 return_dict=False 或当 config.return_dict=False 时），包含根据配置（PersimmonConfig）和输入而定的各种元素。
PersimmonForCausalLM 的前向传播（forward）方法，重写了 __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, PersimmonForCausalLM
>>> model = PersimmonForCausalLM.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'PersimmonForSequenceClassification
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)，可选) — 词表中输入序列 token 的索引。默认情况下将忽略填充（Padding）。可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
torch.Tensor，形状为(batch_size, sequence_length)，可选) — 用于避免在填充 token 索引上进行注意力操作的掩码。掩码值选在[0, 1]之间：- 对于 未被掩码 的 token，值为 1，
- 对于 已被掩码 的 token，值为 0。
- position_ids (
torch.LongTensor，形状为(batch_size, sequence_length)，可选) — 每个输入序列 token 在位置嵌入中的位置索引。取值范围在[0, config.n_positions - 1]之间。 - past_key_values (
~cache_utils.Cache，可选) — 预先计算好的隐状态（自注意力块和交叉注意力块中的 key 和 value），可用于加速顺序解码。这通常由模型在之前的解码阶段返回的past_key_values组成（当use_cache=True或config.use_cache=True时）。仅允许将 Cache 实例作为输入，请参阅我们的 KV 缓存指南。如果未传递
past_key_values，默认情况下将初始化 DynamicCache。模型将输出与输入相同的缓存格式。
如果使用了
past_key_values，用户应仅输入形状为(batch_size, unprocessed_length)的未处理的input_ids（即尚未将过去 key-value 状态提供给本模型的那些 token），而不是形状为(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）。
返回
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 后的注意力权重，用于计算自注意力头中的加权平均值。
PersimmonForTokenClassification
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)，可选) — 词表中输入序列 token 的索引。默认情况下将忽略填充（Padding）。可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
torch.Tensor，形状为(batch_size, sequence_length)，可选) — 用于避免在填充 token 索引上进行注意力操作的掩码。掩码值选在[0, 1]之间：- 对于 未被掩码 的 token，值为 1，
- 对于 已被掩码 的 token，值为 0。
- position_ids (
torch.LongTensor，形状为(batch_size, sequence_length)，可选) — 每个输入序列 token 在位置嵌入中的位置索引。取值范围在[0, config.n_positions - 1]之间。 - past_key_values (
~cache_utils.Cache，可选) — 预先计算好的隐状态（自注意力块和交叉注意力块中的 key 和 value），可用于加速顺序解码。这通常由模型在之前的解码阶段返回的past_key_values组成（当use_cache=True或config.use_cache=True时）。仅允许将 Cache 实例作为输入，请参阅我们的 KV 缓存指南。如果未传递
past_key_values，默认情况下将初始化 DynamicCache。模型将输出与输入相同的缓存格式。
如果使用了
past_key_values，用户应仅输入形状为(batch_size, unprocessed_length)的未处理的input_ids（即尚未将过去 key-value 状态提供给本模型的那些 token），而不是形状为(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）。
返回
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 后的注意力权重，用于计算自注意力头中的加权平均值。