柿子
概述
柿子模型由 ADEPT 创建，作者为 Erich Elsen、Augustus Odena、Maxwell Nye、Sağnak Taşırlar、Tri Dao、Curtis Hawthorne、Deepak Moparthi 和 Arushi Somani。
作者介绍了 Persimmon-8B，这是一个基于经典 Transformer 架构的解码器模型，具有查询和键规范化功能。Persimmon-8B 是一款完全许可的模型，拥有约 80 亿个参数，以 Apache 许可证发布。Persimmon-8B 的一些关键属性包括较长的上下文大小 (16K)、性能以及用于多模态扩展的功能。
作者展示了他们的模型评估方法，重点关注实用的文本生成，反映了用户与语言模型交互的方式。该工作还包括比较分析，将 Persimmon-8B 与其他著名模型（MPT 7B Instruct 和 Llama 2 Base 7B 1-Shot）在各种评估任务中进行对比。结果表明，Persimmon-8B 即使在训练数据有限的情况下，也能展现出有竞争力的性能。
在模型细节方面，这项工作概述了 Persimmon-8B 的架构和训练方法，提供了关于其设计选择、序列长度和数据集组成的见解。作者展示了一个快速推理代码，它通过操作融合和 CUDA 图的使用，在保持代码一致性的同时，性能优于传统的实现。他们表达了对社区如何利用这一贡献推动创新的期待，暗示了未来将发布更多版本，作为一系列持续发展的组成部分。
该模型由 ArthurZ 贡献。原始代码可以在这里找到 这里。
使用技巧
Persimmon 模型使用 bfloat16 进行训练，但原始推理使用 float16。中心上传的检查点使用 torch_dtype = 'float16'，它将被 AutoModel API 用于将检查点从 torch.float32 转换为 torch.float16。
在线权重的 dtype 基本上无关紧要，除非您在使用 torch_dtype="auto" 初始化模型时使用 model = AutoModelForCausalLM.from_pretrained("path", torch_dtype = "auto")。原因是模型将首先被下载（使用在线检查点的 dtype），然后它将被转换为 torch 的默认 dtype（变为 torch.float32）。用户应该指定他们想要的 torch_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对于聊天模型
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")
tokenizer = PersimmonTokenizer.from_pretrained("/output/path")Perismmon 使用基于
sentencepiece的分词器，以及Unigram模型。它支持字节回退，它只在tokenizers==0.14.0的快速分词器中可用。LlamaTokenizer被用作sentencepiece的标准包装器。chat模板将在后续的 PR 中更新模板函数！作者建议在聊天模式下使用以下提示格式：
f"human: {prompt}\n\nadept:"
PersimmonConfig
class transformers.PersimmonConfig
< source >( vocab_size = 262144 hidden_size = 4096 intermediate_size = 16384 num_hidden_layers = 36 num_attention_heads = 64 hidden_act = 'relu2' max_position_embeddings = 16384 initializer_range = 0.02 layer_norm_eps = 1e-05 use_cache = True tie_word_embeddings = False rope_theta = 25000.0 rope_scaling = None qk_layernorm = True hidden_dropout = 0.0 attention_dropout = 0.0 partial_rotary_factor = 0.5 pad_token_id = None bos_token_id = 1 eos_token_id = 2 **kwargs )
参数
- vocab_size (
int, 可选, 默认为 262144) — Persimmon 模型的词汇量大小。定义了在调用 PersimmonModel 时，可以由传递的inputs_ids表示的不同标记数量 - hidden_size (
int, 可选, 默认为 4096) — 隐藏表示的维度。 - intermediate_size (
int, 可选, 默认为 16384) — MLP 表示的维度。 - num_hidden_layers (
int, 可选, 默认为 36) — Transformer 编码器中的隐藏层数。 - num_attention_heads (
int, 可选, 默认为 64) — Transformer 编码器中每个注意力层的注意力头数量。 - hidden_act (
str或function, 可选, 默认为"relu2") — 解码器中的非线性激活函数（函数或字符串）。 - max_position_embeddings (
int, 可选, 默认为 16384) — 该模型可能使用的最大序列长度。 - initializer_range (
float, 可选, 默认为 0.02) — 初始化所有权重矩阵的截断正态分布初始化器的标准差。 - layer_norm_eps (
float, 可选, 默认为 1e-5) — RMS 归一化层使用的 epsilon。 - use_cache (
bool, 可选, 默认为True) — 模型是否应该返回最后的键/值注意力（并非所有模型都使用）。 仅在config.is_decoder=True时相关。 - tie_word_embeddings(
bool, 可选, 默认为False) — 是否绑定权重嵌入 - rope_theta (
float, 可选, 默认为 25000.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 嵌入的缩放因子。 在大多数缩放类型中，factor为 x 将使模型能够处理长度为 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 高频分量的缩放因子 - qk_layernorm (
bool, 可选, 默认为True) — 是否在投影隐藏状态后对查询和键进行归一化 - hidden_dropout (
float, 可选, 默认为 0.0) — 对隐藏状态应用 MLP 后 的 dropout 率。 - attention_dropout (
float, 可选, 默认为 0.0) — 计算注意力分数后 的 dropout 率。 - partial_rotary_factor (
float, 可选, 默认为 0.5) — 将具有旋转嵌入的查询和键的百分比。例如 —
这是用于存储 PersimmonModel 配置的配置类。它用于根据指定的参数实例化 Persimmon 模型，定义模型架构。使用默认值实例化配置将产生与 adept/persimmon-8b-base 相似的配置。
配置对象继承自 PretrainedConfig，可用于控制模型输出。阅读 PretrainedConfig 的文档以了解更多信息。
PersimmonModel
class transformers.PersimmonModel
< 源代码 >( config: PersimmonConfig )
参数
- config (PersimmonConfig) — 模型配置类，包含模型的所有参数。使用配置文件进行初始化不会加载与模型相关的权重，仅加载配置。查看 from_pretrained() 方法以加载模型权重。config — PersimmonConfig
裸 Persimmon 模型输出原始隐藏状态，没有任何特定的头部。此模型继承自 PreTrainedModel。查看超类文档以了解库为其所有模型实现的通用方法（例如下载或保存、调整输入嵌入的大小、修剪头部等）。
此模型也是 PyTorch torch.nn.Module 子类。将其用作常规 PyTorch 模块，并参考 PyTorch 文档以了解有关通用用法和行为的所有事项。
包含 config.num_hidden_layers 层的 Transformer 解码器。每层都是一个 PersimmonDecoderLayer
正向
< 源代码 >( input_ids: LongTensor = None attention_mask: 可选 = None position_ids: 可选 = None past_key_values: 可选 = None inputs_embeds: 可选 = None use_cache: 可选 = None output_attentions: 可选 = None output_hidden_states: 可选 = None return_dict: 可选 = None cache_position: 可选 = None )
参数
- 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 用于掩码的标记。
可以使用 AutoTokenizer 获取索引。有关详细信息，请参见 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
如果使用
past_key_values，则可以选择仅输入最后一个decoder_input_ids（请参见past_key_values）。如果您想更改填充行为，您应该阅读
modeling_opt._prepare_decoder_attention_mask并根据您的需求进行修改。有关默认策略的更多信息，请参见 论文 中的图表 1。- 1 表示头部未掩码，
- 0 表示头部掩码。
- position_ids (
torch.LongTensor形状为(batch_size, sequence_length), 可选) — 输入序列标记在位置嵌入中的位置索引。在[0, config.n_positions - 1]范围内选择。 - past_key_values (
Cache或tuple(tuple(torch.FloatTensor)), 可选) — 预先计算的隐藏状态（自注意力块和交叉注意力块中的键和值），可用于加快顺序解码速度。这通常包括模型在解码的先前阶段返回的past_key_values，当use_cache=True或config.use_cache=True时。允许两种格式：
- 一个 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（那些没有将其过去的键值状态提供给此模型的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索引转换为关联的向量比模型的内部嵌入查找矩阵有更多控制，这将很有用。 - use_cache (
bool, 可选) — 如果设置为True，则将返回past_key_values键值状态，可用于加快解码速度（请参见past_key_values）。 - output_attentions (
bool, 可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参见返回张量下的attentions。 - output_hidden_states (
bool, 可选) — 是否返回所有层的隐藏状态。有关更多详细信息，请参见返回张量下的hidden_states。 - return_dict (
bool, 可选) — 是否返回一个 ModelOutput，而不是一个普通元组。 - cache_position (
torch.LongTensor形状为(sequence_length), 可选) — 表示输入序列标记在序列中的位置的索引。与position_ids相反，此张量不受填充的影响。它用于在正确的位置更新缓存并推断完整的序列长度。
该 PersimmonModel 正向方法覆盖了 __call__ 特殊方法。
虽然前向传递的配方需要在这个函数中定义，但之后应该调用Module实例而不是这个函数，因为前者负责运行前处理和后处理步骤，而后者会默默地忽略它们。
PersimmonForCausalLM
正向
< source >( input_ids: LongTensor = None attention_mask: Optional = None position_ids: Optional = None past_key_values: Optional = None inputs_embeds: Optional = None labels: Optional = None use_cache: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None cache_position: Optional = None num_logits_to_keep: int = 0 ) → transformers.modeling_outputs.CausalLMOutputWithPast 或 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 表示掩码的标记。
可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
如果使用
past_key_values，则可以选择输入仅最后一个decoder_input_ids（那些没有提供其过去键值状态的输入 ID）的形状为(batch_size, 1)，而不是所有input_ids的形状为(batch_size, sequence_length)。如果您想更改填充行为，您应该阅读
modeling_opt._prepare_decoder_attention_mask并根据您的需要进行修改。有关默认策略的更多信息，请参阅 论文 中的图表 1。- 1 表示头部未掩码，
- 0 表示头部掩码。
- position_ids (
torch.LongTensor形状为(batch_size, sequence_length), 可选) — 位置嵌入中每个输入序列标记的位置索引。在[0, config.n_positions - 1]范围内选择。 - past_key_values (
Cache或tuple(tuple(torch.FloatTensor)), 可选) — 预先计算的隐藏状态（自注意力块和交叉注意力块中的键和值），可用于加速顺序解码。这通常包含模型在解码的先前阶段返回的past_key_values，当use_cache=True或config.use_cache=True时。允许两种格式：
- 一个 Cache 实例，请参阅我们的 kv 缓存指南；
- 长度为
config.n_layers的tuple(tuple(torch.FloatTensor))，每个元组包含两个形状为(batch_size, num_heads, sequence_length, embed_size_per_head)的张量。这也称为传统缓存格式。
模型将输出与作为输入馈送的相同缓存格式。如果未传递
past_key_values，则将返回传统缓存格式。如果使用
past_key_values，用户可以选择仅输入最后一个input_ids（那些没有提供其过去键值状态的输入 ID）的形状为(batch_size, 1)，而不是所有input_ids的形状为(batch_size, sequence_length)。 - inputs_embeds (
torch.FloatTensor形状为(batch_size, sequence_length, hidden_size)，可选) — 可选地，您可以选择直接传递嵌入表示，而不是传递input_ids。如果您希望对如何将input_ids索引转换为关联向量进行更多控制，而不是模型的内部嵌入查找矩阵，这将很有用。 - use_cache (
bool，可选) — 如果设置为True，则返回past_key_values键值状态，可用于加速解码（参见past_key_values）。 - output_attentions (
bool，可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参阅返回张量中的attentions。 - output_hidden_states (
bool，可选) — 是否返回所有层的隐藏状态。有关更多详细信息，请参阅返回张量中的hidden_states。 - return_dict (
bool，可选) — 是否返回一个 ModelOutput 而不是一个简单元组。 - cache_position (
torch.LongTensor形状为(sequence_length)，可选) — 表示输入序列令牌在序列中的位置的索引。与position_ids相反，此张量不受填充影响。它用于在正确的位置更新缓存，并推断完整的序列长度。参数 — labels (
torch.LongTensor形状为(batch_size, sequence_length)，可选): 用于计算掩蔽语言建模损失的标签。索引应在[0, ..., config.vocab_size]或 -100 中（参见input_ids文档字符串）。索引设置为-100的令牌将被忽略（掩蔽），损失仅针对标签在[0, ..., config.vocab_size]中的令牌计算。num_logits_to_keep (
int，可选): 计算最后num_logits_to_keep个令牌的 logits。如果为0，则计算所有input_ids的 logits（特殊情况）。生成只需要最后一个令牌的 logits，并且仅为该令牌计算它们可以节省内存，这对于长序列或大型词汇量来说非常重要。
返回
transformers.modeling_outputs.CausalLMOutputWithPast 或 tuple(torch.FloatTensor)
一个 transformers.modeling_outputs.CausalLMOutputWithPast 或 torch.FloatTensor 的元组（如果传递了 return_dict=False 或 config.return_dict=False 时），包含取决于配置 (PersimmonConfig) 和输入的各种元素。
-
loss (
torch.FloatTensor形状为(1,)，可选，当提供labels时返回) — 语言建模损失（用于下一个令牌预测）。 -
logits (
torch.FloatTensor形状为(batch_size, sequence_length, config.vocab_size)) — 语言建模头的预测分数（SoftMax 之前的每个词汇令牌的分数）。 -
past_key_values (
tuple(tuple(torch.FloatTensor))，可选，当传递use_cache=True或config.use_cache=True时返回) — 长度为config.n_layers的tuple(torch.FloatTensor)的元组，每个元组包含 2 个形状为(batch_size, num_heads, sequence_length, embed_size_per_head)的张量。包含预先计算的隐藏状态（自注意力块中的键和值），可用于（参见
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 后的注意力权重，用于计算自注意力头中的加权平均值。
The PersimmonForCausalLM 前向方法覆盖了 __call__ 特殊方法。
虽然前向传递的配方需要在这个函数中定义，但之后应该调用Module实例而不是这个函数，因为前者负责运行前处理和后处理步骤，而后者会默默地忽略它们。
示例
>>> 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
class transformers.PersimmonForSequenceClassification
< 源代码 >( config )
参数
- config (PersimmonConfig) — 模型配置类，包含模型的所有参数。使用配置文件初始化不会加载与模型关联的权重，只加载配置。查看 from_pretrained() 方法加载模型权重。
Persimmon 变换器，顶部带有序列分类头（线性层）。
PersimmonForSequenceClassification 使用最后一个 token 进行分类，就像其他因果模型（例如 GPT-2）一样。
由于它对最后一个 token 进行分类，因此它需要知道最后一个 token 的位置。如果在配置中定义了 pad_token_id，则它会查找每行中不是填充 token 的最后一个 token。如果未定义 pad_token_id，则它只会获取批处理中每行的最后一个值。由于它无法在传递 inputs_embeds 而不是 input_ids 时猜测填充 token，因此它会执行相同的操作（获取批处理中每行的最后一个值）。
此模型继承自 PreTrainedModel。查看超类文档以获取库为其所有模型实现的通用方法（例如下载或保存、调整输入嵌入的大小、剪枝头等）。
此模型也是 PyTorch torch.nn.Module 子类。将其用作常规 PyTorch 模块，并参考 PyTorch 文档以了解有关通用用法和行为的所有事项。
正向
< 源代码 >( input_ids: Optional = None attention_mask: Optional = None position_ids: Optional = None past_key_values: Union = None inputs_embeds: Optional = None labels: Optional = None use_cache: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None )
参数
- 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。
索引可以使用 AutoTokenizer 获取。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
如果使用
past_key_values，则可以选择仅输入最后的decoder_input_ids（其过去键值状态未提供给此模型的那些）（形状为(batch_size, 1)），而不是所有input_ids（形状为(batch_size, sequence_length)）。如果您想更改填充行为，您应该阅读
modeling_opt._prepare_decoder_attention_mask并根据您的需要进行修改。有关默认策略的更多信息，请参阅 论文 中的图 1。- 1 表示头部未掩码，
- 0 表示头部已掩码。
- position_ids (
torch.LongTensor形状为(batch_size, sequence_length)，可选) — 输入序列 token 在位置嵌入中的位置索引。选择在[0, config.n_positions - 1]范围内。 - past_key_values (
Cache或tuple(tuple(torch.FloatTensor))，可选) — 预先计算的隐藏状态（自注意力块和交叉注意力块中的键和值），可用于加速顺序解码。这通常包括在解码的先前阶段由模型返回的past_key_values，当use_cache=True或config.use_cache=True时。允许两种格式：
- 一个 Cache 实例，请参阅我们的 kv 缓存指南；
- 长度为
config.n_layers的tuple(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)），而不是所有input_ids（形状为(batch_size, sequence_length)）。 - inputs_embeds (
torch.FloatTensor形状为(batch_size, sequence_length, hidden_size), 可选) — 可选地，您可以选择直接传递嵌入式表示，而不是传递input_ids。如果您想比模型内部嵌入查找矩阵更精确地控制如何将input_ids索引转换为关联向量，这很有用。 - use_cache (
bool, 可选) — 如果设置为True，将返回past_key_values键值状态，可用于加速解码 (见past_key_values)。 - output_attentions (
bool, 可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参阅返回张量中的attentions。 - output_hidden_states (
bool, 可选) — 是否返回所有层的隐藏状态。有关更多详细信息，请参阅返回张量中的hidden_states。 - return_dict (
bool, 可选) — 是否返回 ModelOutput 而不是普通元组。 - cache_position (
torch.LongTensor形状为(sequence_length), 可选) — 指示输入序列标记在序列中的位置的索引。与position_ids相反，此张量不受填充的影响。它用于在正确的位置更新缓存并推断完整的序列长度。 - labels (
torch.LongTensor形状为(batch_size,), 可选) — 用于计算序列分类/回归损失的标签。索引应在[0, ..., config.num_labels - 1]中。如果config.num_labels == 1，则计算回归损失 (均方误差损失)，如果config.num_labels > 1，则计算分类损失 (交叉熵)。
该 PersimmonForSequenceClassification 正向方法覆盖了 __call__ 特殊方法。
虽然前向传递的配方需要在这个函数中定义，但之后应该调用Module实例而不是这个函数，因为前者负责运行前处理和后处理步骤，而后者会默默地忽略它们。
PersimmonForTokenClassification
class transformers.PersimmonForTokenClassification
< 源代码 >( config )
参数
- config (PersimmonConfig) — 模型配置类，包含模型的所有参数。使用配置文件初始化不会加载与模型关联的权重，只会加载配置。查看 from_pretrained() 方法来加载模型权重。
具有顶端标记分类头的 Persimmon 模型转换器 (在隐藏状态输出之上添加一个线性层)，例如用于命名实体识别 (NER) 任务。
此模型继承自 PreTrainedModel。查看超类文档以获取库为其所有模型实现的通用方法（例如下载或保存、调整输入嵌入的大小、剪枝头等）。
此模型也是 PyTorch torch.nn.Module 子类。将其用作常规 PyTorch 模块，并参考 PyTorch 文档以了解有关通用用法和行为的所有事项。
正向
< 源代码 >( input_ids: Optional = None attention_mask: Optional = None position_ids: Optional = None past_key_values: Optional = None inputs_embeds: Optional = None labels: Optional = None use_cache: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None )
参数
- 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 表示 掩码 的标记。
索引可以通过 AutoTokenizer 获取。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
如果使用
past_key_values，可以选择仅输入最后一个decoder_input_ids（请参阅past_key_values）。如果您想更改填充行为，您应该阅读
modeling_opt._prepare_decoder_attention_mask并修改为您的需求。有关默认策略的更多信息，请参阅 论文 中的图表 1。- 1 表示头部 未掩码，
- 0 表示头部 掩码。
- position_ids (
torch.LongTensor形状为(batch_size, sequence_length)，可选) — 位置嵌入中每个输入序列标记的位置索引。在[0, config.n_positions - 1]范围内选择。 - past_key_values (
Cache或tuple(tuple(torch.FloatTensor))，可选) — 预先计算的隐藏状态（自注意力块和交叉注意力块中的键和值），可用于加速顺序解码。这通常包括模型在解码先前阶段返回的past_key_values，当use_cache=True或config.use_cache=True时。允许两种格式：
- 一个 Cache 实例，请参阅我们的 kv 缓存指南；
- 长度为
config.n_layers的tuple(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索引转换为关联向量，这将非常有用。 - use_cache (
bool，可选) — 如果设置为True，则返回past_key_values键值状态，可用于加速解码（请参阅past_key_values）。 - output_attentions (
bool, 可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参阅返回张量中的attentions。 - output_hidden_states (
bool, 可选) — 是否返回所有层的隐藏状态。有关更多详细信息，请参阅返回张量中的hidden_states。 - return_dict (
bool, 可选) — 是否返回一个 ModelOutput 而不是一个简单的元组。 - cache_position (
torch.LongTensor形状为(sequence_length), 可选) — 指示输入序列令牌在序列中的位置的索引。与position_ids相反，此张量不受填充的影响。它用于在正确的位置更新缓存并推断完整的序列长度。 - labels (
torch.LongTensor形状为(batch_size,), 可选) — 用于计算序列分类/回归损失的标签。索引应在[0, ..., config.num_labels - 1]中。如果config.num_labels == 1，则计算回归损失（均方损失），如果config.num_labels > 1，则计算分类损失（交叉熵）。
该 PersimmonForTokenClassification 正向方法覆盖了 __call__ 特殊方法。
虽然前向传递的配方需要在这个函数中定义，但之后应该调用Module实例而不是这个函数，因为前者负责运行前处理和后处理步骤，而后者会默默地忽略它们。