Transformers 文档
BioGPT
并获得增强的文档体验
开始使用
BioGPT
BioGPT 是一个基于 GPT-2 并预训练于1500万份 PubMed 摘要的生成式 Transformer 模型。它专为生物医学语言任务设计。
你可以在 Microsoft 组织下找到所有原始 BioGPT 检查点。
点击右侧边栏的 BioGPT 模型，查看如何将 BioGPT 应用于不同语言任务的更多示例。
下面的示例展示了如何使用 Pipeline、AutoModel 以及通过命令行生成生物医学文本。
import torch
from transformers import pipeline
generator = pipeline(
task="text-generation",
model="microsoft/biogpt",
torch_dtype=torch.float16,
device=0,
)
result = generator("Ibuprofen is best used for", truncation=True, max_length=50, do_sample=True)[0]["generated_text"]
print(result)量化通过以较低精度表示权重来减少大型模型的内存负担。有关更多可用量化后端，请参阅量化概述。
下面的示例使用 bitsandbytes 仅将权重量化为 4 位精度。
import torch
from transformers import AutoTokenizer, AutoModelForCausalLM, BitsAndBytesConfig
bnb_config = BitsAndBytesConfig(
load_in_4bit=True,
bnb_4bit_quant_type="nf4",
bnb_4bit_compute_dtype=torch.bfloat16,
bnb_4bit_use_double_quant=True
)
tokenizer = AutoTokenizer.from_pretrained("microsoft/BioGPT-Large")
model = AutoModelForCausalLM.from_pretrained(
"microsoft/BioGPT-Large",
quantization_config=bnb_config,
torch_dtype=torch.bfloat16,
device_map="auto"
)
input_text = "Ibuprofen is best used for"
inputs = tokenizer(input_text, return_tensors="pt").to(model.device)
with torch.no_grad():
generated_ids = model.generate(**inputs, max_length=50)
output = tokenizer.decode(generated_ids[0], skip_special_tokens=True)
print(output)注意事项
由于 BioGPT 使用绝对位置嵌入，请在右侧填充输入。
BioGPT 可以重用先前计算的键值注意力对。通过
BioGPTModel.forward中的 past_key_values 参数访问此功能。当使用“eager”以外的注意力实现时，
head_mask参数将被忽略。如果想使用head_mask，请确保attn_implementation="eager"。from transformers import AutoModelForCausalLM model = AutoModelForCausalLM.from_pretrained( "microsoft/biogpt", attn_implementation="eager" )
BioGptConfig
class transformers.BioGptConfig
< 源文件 >( vocab_size = 42384 hidden_size = 1024 num_hidden_layers = 24 num_attention_heads = 16 intermediate_size = 4096 hidden_act = 'gelu' hidden_dropout_prob = 0.1 attention_probs_dropout_prob = 0.1 max_position_embeddings = 1024 initializer_range = 0.02 layer_norm_eps = 1e-12 scale_embedding = True use_cache = True layerdrop = 0.0 activation_dropout = 0.0 pad_token_id = 1 bos_token_id = 0 eos_token_id = 2 **kwargs )
参数
- vocab_size (
int, 可选, 默认为 42384) — BioGPT 模型的词汇表大小。定义了调用 BioGptModel 时传入的inputs_ids可以表示的不同标记的数量。 - hidden_size (
int, 可选, 默认为 1024) — 编码器层和池化层的维度。 - num_hidden_layers (
int, 可选, 默认为 24) — Transformer 编码器中的隐藏层数量。 - num_attention_heads (
int, 可选, 默认为 16) — Transformer 编码器中每个注意力层的注意力头数量。 - intermediate_size (
int, 可选, 默认为 4096) — Transformer 编码器中“中间”（即前馈）层的维度。 - hidden_act (
str或function, 可选, 默认为"gelu") — 编码器和池化器中的非线性激活函数（函数或字符串）。如果是字符串，支持"gelu"、"relu"、"selu"和"gelu_new"。 - hidden_dropout_prob (
float, 可选, 默认为 0.1) — 嵌入、编码器和池化器中所有全连接层的 dropout 概率。 - attention_probs_dropout_prob (
float, 可选, 默认为 0.1) — 注意力概率的 dropout 比率。 - max_position_embeddings (
int, 可选, 默认为 1024) — 此模型可能使用的最大序列长度。通常为了以防万一会将其设置为一个较大的值（例如 512 或 1024 或 2048）。 - initializer_range (
float, 可选, 默认为 0.02) — 用于初始化所有权重矩阵的 truncated_normal_initializer 的标准差。 - layer_norm_eps (
float, 可选, 默认为 1e-12) — 层归一化层使用的 epsilon 值。 - scale_embedding (
bool, 可选, 默认为True) — 通过除以 sqrt(d_model) 来缩放嵌入。 - use_cache (
bool, 可选, 默认为True) — 模型是否应返回最后一个键/值注意力（并非所有模型都使用此功能）。仅当config.is_decoder=True时相关。 - layerdrop (
float, 可选, 默认为 0.0) — 关于 LayerDrop 的更多细节，请参阅论文：https://huggingface.co/papers/1909.11556 - activation_dropout (
float, 可选, 默认为 0.0) — 全连接层内部激活的 dropout 比率。 - pad_token_id (
int, 可选, 默认为 1) — 填充标记 ID。 - bos_token_id (
int, 可选, 默认为 0) — 流的起始标记 ID。 - eos_token_id (
int, 可选, 默认为 2) — 流的结束标记 ID。
这是用于存储 BioGptModel 配置的配置类。它用于根据指定的参数实例化 BioGPT 模型，定义模型架构。使用默认值实例化配置将生成类似于 BioGPT microsoft/biogpt 架构的配置。
配置对象继承自 PretrainedConfig，可用于控制模型输出。有关更多信息，请阅读 PretrainedConfig 的文档。
示例
>>> from transformers import BioGptModel, BioGptConfig
>>> # Initializing a BioGPT microsoft/biogpt style configuration
>>> configuration = BioGptConfig()
>>> # Initializing a model from the microsoft/biogpt style configuration
>>> model = BioGptModel(configuration)
>>> # Accessing the model configuration
>>> configuration = model.configBioGptTokenizer
class transformers.BioGptTokenizer
< 源文件 >( vocab_file merges_file unk_token = '<unk>' bos_token = '<s>' eos_token = '</s>' sep_token = '</s>' pad_token = '<pad>' **kwargs )
参数
- vocab_file (
str) — 词汇表文件的路径。 - merges_file (
str) — 合并文件。 - unk_token (
str, 可选, 默认为"<unk>") — 未知标记。不在词汇表中的标记不能转换为 ID，而是设置为此标记。 - bos_token (
str, 可选, 默认为"<s>") — 预训练期间使用的序列开始标记。可用作序列分类器标记。使用特殊标记构建序列时，这不是用于序列开始的标记。使用的标记是
cls_token。 - eos_token (
str, 可选, 默认为"</s>") — 序列结束标记。使用特殊标记构建序列时，这不是用于序列结束的标记。使用的标记是
sep_token。 - sep_token (
str, 可选, 默认为"</s>") — 分隔符标记，用于从多个序列构建序列时，例如用于序列分类的两个序列，或用于问答的文本和问题。它也用作使用特殊标记构建的序列的最后一个标记。 - pad_token (
str, 可选, 默认为"<pad>") — 用于填充的标记，例如在批处理不同长度的序列时。
构建一个 FAIRSEQ Transformer 分词器。Moses 分词后接字节对编码。
此分词器继承自 PreTrainedTokenizer，其中包含大部分主要方法。用户应参阅此超类以获取有关这些方法的更多信息。
BioGptModel
class transformers.BioGptModel
< source >( config: BioGptConfig )
参数
- config (BioGptConfig) — 包含模型所有参数的模型配置类。使用配置文件初始化不会加载与模型关联的权重，只加载配置。请查阅 from_pretrained() 方法以加载模型权重。
裸露的 Biogpt 模型，输出原始的隐藏状态，没有任何特定的顶层。
此模型继承自 PreTrainedModel。查阅超类文档以获取库为其所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、修剪头部等）。
此模型也是 PyTorch torch.nn.Module 子类。将其作为常规 PyTorch 模块使用，并参阅 PyTorch 文档以获取所有与通用用法和行为相关的事项。
forward
< source >( input_ids: typing.Optional[torch.LongTensor] = None attention_mask: typing.Optional[torch.FloatTensor] = None head_mask: typing.Optional[torch.FloatTensor] = None inputs_embeds: typing.Optional[torch.FloatTensor] = None past_key_values: typing.Optional[tuple[tuple[torch.Tensor]]] = None use_cache: typing.Optional[bool] = None position_ids: typing.Optional[torch.LongTensor] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None cache_position: typing.Optional[torch.Tensor] = None **flash_attn_kwargs: typing_extensions.Unpack[transformers.modeling_flash_attention_utils.FlashAttentionKwargs] ) → transformers.modeling_outputs.BaseModelOutputWithPastAndCrossAttentions 或 tuple(torch.FloatTensor)
参数
- input_ids (形状为
(batch_size, sequence_length)的torch.LongTensor，可选) — 词汇表中输入序列标记的索引。默认情况下将忽略填充。可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (形状为
(batch_size, sequence_length)的torch.FloatTensor，可选) — 用于避免对填充标记索引执行注意力的掩码。掩码值在[0, 1]中选择：- 1 表示未被掩码的标记，
- 0 表示被掩码的标记。
- head_mask (形状为
(num_heads,)或(num_layers, num_heads)的torch.FloatTensor，可选) — 用于将自注意力模块的选定头部置零的掩码。掩码值在[0, 1]中选择：- 1 表示头部未被掩码，
- 0 表示头部被掩码。
- inputs_embeds (形状为
(batch_size, sequence_length, hidden_size)的torch.FloatTensor，可选) — 可选地，你可以选择直接传递嵌入表示，而不是传递input_ids。如果你想对如何将input_ids索引转换为关联向量有更多的控制，而不是模型内部的嵌入查找矩阵，这会很有用。 - past_key_values (
tuple[tuple[torch.Tensor]], 可选) — 预先计算的隐藏状态（自注意力块和交叉注意力块中的键和值），可用于加速顺序解码。这通常包括模型在解码上一阶段返回的past_key_values，当use_cache=True或config.use_cache=True时。允许两种格式：
- 一个 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)，而不是所有input_ids形状为(batch_size, sequence_length)。 - use_cache (
bool, 可选) — 如果设置为True，则返回past_key_values键值状态，可用于加速解码（请参阅past_key_values）。 - position_ids (形状为
(batch_size, sequence_length)的torch.LongTensor，可选) — 每个输入序列标记在位置嵌入中的位置索引。在[0, config.n_positions - 1]范围内选择。 - output_attentions (
bool, 可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参阅返回张量下的attentions。 - output_hidden_states (
bool, 可选) — 是否返回所有层的隐藏状态。有关更多详细信息，请参阅返回张量下的hidden_states。 - return_dict (
bool, 可选) — 是否返回 ModelOutput 而不是普通元组。 - cache_position (形状为
(sequence_length)的torch.Tensor，可选) — 描述输入序列标记在序列中位置的索引。与position_ids不同，此张量不受填充影响。它用于在正确位置更新缓存并推断完整的序列长度。
返回
transformers.modeling_outputs.BaseModelOutputWithPastAndCrossAttentions 或 tuple(torch.FloatTensor)
一个 transformers.modeling_outputs.BaseModelOutputWithPastAndCrossAttentions 或一个 torch.FloatTensor 元组（如果传递 return_dict=False 或 config.return_dict=False 时），其中包含根据配置 (BioGptConfig) 和输入的不同元素。
-
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 cache 指南。包含预先计算的隐藏状态（自注意力块中的键和值，以及可选地，如果
config.is_encoder_decoder=True，则在交叉注意力块中），可用于加速顺序解码（请参阅past_key_values输入）。 -
hidden_states (形状为
(batch_size, sequence_length, hidden_size)的tuple(torch.FloatTensor)，可选，当传递output_hidden_states=True或config.output_hidden_states=True时返回) —torch.FloatTensor元组（一个用于嵌入层的输出，如果模型有嵌入层，再加上每个层的输出）。模型在每个层输出的隐藏状态以及可选的初始嵌入输出。
-
attentions (形状为
(batch_size, num_heads, sequence_length, sequence_length)的tuple(torch.FloatTensor)，可选，当传递output_attentions=True或config.output_attentions=True时返回) —torch.FloatTensor元组（每个层一个）。注意力 softmax 后的注意力权重，用于计算自注意力头中的加权平均值。
-
cross_attentions (形状为
(batch_size, num_heads, sequence_length, sequence_length)的tuple(torch.FloatTensor)，可选，当传递output_attentions=True和config.add_cross_attention=True或config.output_attentions=True时返回) —torch.FloatTensor元组（每个层一个）。解码器交叉注意力层的注意力权重，在注意力 softmax 之后，用于计算交叉注意力头中的加权平均。
BioGptModel 的 forward 方法，覆盖了 __call__ 特殊方法。
尽管前向传递的配方需要在此函数中定义，但之后应调用 Module 实例，而不是此函数，因为前者负责运行预处理和后处理步骤，而后者则默默地忽略它们。
BioGptForCausalLM
class transformers.BioGptForCausalLM
< source >( config )
参数
- config (BioGptForCausalLM) — 包含模型所有参数的模型配置类。使用配置文件初始化不会加载与模型关联的权重，只加载配置。请查阅 from_pretrained() 方法以加载模型权重。
BioGPT 模型，顶部带有 语言建模 头部，用于 CLM 微调。
此模型继承自 PreTrainedModel。查阅超类文档以获取库为其所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、修剪头部等）。
此模型也是 PyTorch torch.nn.Module 子类。将其作为常规 PyTorch 模块使用，并参阅 PyTorch 文档以获取所有与通用用法和行为相关的事项。
forward
< source >( input_ids: typing.Optional[torch.LongTensor] = None attention_mask: typing.Optional[torch.FloatTensor] = None head_mask: typing.Optional[torch.FloatTensor] = None inputs_embeds: typing.Optional[torch.FloatTensor] = None past_key_values: typing.Optional[tuple[tuple[torch.Tensor]]] = None labels: typing.Optional[torch.LongTensor] = None use_cache: typing.Optional[bool] = None position_ids: typing.Optional[torch.LongTensor] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None cache_position: typing.Optional[torch.Tensor] = None **kwargs: typing_extensions.Unpack[transformers.models.biogpt.modeling_biogpt.KwargsForCausalLM] ) → transformers.modeling_outputs.CausalLMOutputWithCrossAttentions 或 tuple(torch.FloatTensor)
参数
- input_ids (形状为
(batch_size, sequence_length)的torch.LongTensor，可选) — 词汇表中输入序列标记的索引。默认情况下将忽略填充。可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (形状为
(batch_size, sequence_length)的torch.FloatTensor，可选) — 用于避免对填充标记索引执行注意力的掩码。掩码值在[0, 1]中选择：- 1 表示未被掩码的标记，
- 0 表示被掩码的标记。
- head_mask (形状为
(num_heads,)或(num_layers, num_heads)的torch.FloatTensor，可选) — 用于将自注意力模块的选定头部置零的掩码。掩码值在[0, 1]中选择：- 1 表示头部未被掩码，
- 0 表示头部被掩码。
- inputs_embeds (形状为
(batch_size, sequence_length, hidden_size)的torch.FloatTensor，可选) — 可选地，你可以选择直接传递嵌入表示，而不是传递input_ids。如果你想对如何将input_ids索引转换为关联向量有更多的控制，而不是模型内部的嵌入查找矩阵，这会很有用。 - past_key_values (
tuple[tuple[torch.Tensor]], 可选) — 预先计算的隐藏状态（自注意力块和交叉注意力块中的键和值），可用于加速顺序解码。这通常包括模型在解码上一阶段返回的past_key_values，当use_cache=True或config.use_cache=True时。允许两种格式：
- 一个 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)，而不是所有input_ids形状为(batch_size, sequence_length)。 - labels (形状为
(batch_size, sequence_length)的torch.LongTensor，可选) — 语言建模的标签。请注意，标签在模型内部会偏移，即您可以设置labels = input_ids。索引在[-100, 0, ..., config.vocab_size]中选择。所有设置为-100的标签都被忽略（被掩码），损失仅针对[0, ..., config.vocab_size]中的标签计算。 - use_cache (
bool, 可选) — 如果设置为True，则返回past_key_values键值状态，可用于加速解码（请参阅past_key_values）。 - position_ids (形状为
(batch_size, sequence_length)的torch.LongTensor，可选) — 每个输入序列标记在位置嵌入中的位置索引。在[0, config.n_positions - 1]范围内选择。 - output_attentions (
bool, 可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参阅返回张量下的attentions。 - output_hidden_states (
bool, 可选) — 是否返回所有层的隐藏状态。有关更多详细信息，请参阅返回张量下的hidden_states。 - return_dict (
bool, 可选) — 是否返回 ModelOutput 而不是普通元组。 - cache_position (形状为
(sequence_length)的torch.Tensor，可选) — 描述输入序列标记在序列中位置的索引。与position_ids不同，此张量不受填充影响。它用于在正确位置更新缓存并推断完整的序列长度。
返回
transformers.modeling_outputs.CausalLMOutputWithCrossAttentions 或 tuple(torch.FloatTensor)
一个 transformers.modeling_outputs.CausalLMOutputWithCrossAttentions 或一个 torch.FloatTensor 元组（如果传递 return_dict=False 或 config.return_dict=False 时），其中包含根据配置 (BioGptConfig) 和输入的不同元素。
-
loss (
torch.FloatTensor形状为(1,)，可选，当提供labels时返回) — 语言建模损失（用于下一个 token 预测）。 -
logits (形状为
(batch_size, sequence_length, config.vocab_size)的torch.FloatTensor) — 语言建模头部的预测分数（SoftMax 之前的每个词汇标记的分数）。 -
hidden_states (形状为
(batch_size, sequence_length, hidden_size)的tuple(torch.FloatTensor)，可选，当传递output_hidden_states=True或config.output_hidden_states=True时返回) —torch.FloatTensor元组（一个用于嵌入层的输出，如果模型有嵌入层，再加上每个层的输出）。模型在每个层输出的隐藏状态以及可选的初始嵌入输出。
-
attentions (形状为
(batch_size, num_heads, sequence_length, sequence_length)的tuple(torch.FloatTensor)，可选，当传递output_attentions=True或config.output_attentions=True时返回) —torch.FloatTensor元组（每个层一个）。注意力 softmax 后的注意力权重，用于计算自注意力头中的加权平均值。
-
cross_attentions (形状为
(batch_size, num_heads, sequence_length, sequence_length)的tuple(torch.FloatTensor)，可选，当传递output_attentions=True时返回或当config.output_attentions=True时返回) —torch.FloatTensor元组（每个层一个）。注意力 softmax 后的交叉注意力权重，用于计算交叉注意力头中的加权平均。
-
past_key_values (
Cache, 可选, 当传递use_cache=True或config.use_cache=True时返回) — 它是一个 Cache 实例。有关更多详细信息，请参阅我们的 kv cache 指南。包含预先计算的隐藏状态（注意力块中的键和值），可用于（参见
past_key_values输入）加速顺序解码。
BioGptForCausalLM 的 forward 方法，覆盖了 __call__ 特殊方法。
尽管前向传递的配方需要在此函数中定义，但之后应调用 Module 实例，而不是此函数，因为前者负责运行预处理和后处理步骤，而后者则默默地忽略它们。
BioGptForTokenClassification
class transformers.BioGptForTokenClassification
< source >( config )
参数
- config (BioGptForTokenClassification) — 包含模型所有参数的模型配置类。使用配置文件初始化不会加载与模型关联的权重，只加载配置。请查阅 from_pretrained() 方法以加载模型权重。
Biogpt Transformer 顶部带有一个标记分类头部（在隐藏状态输出顶部的线性层），例如用于命名实体识别（NER）任务。
此模型继承自 PreTrainedModel。查阅超类文档以获取库为其所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、修剪头部等）。
此模型也是 PyTorch torch.nn.Module 子类。将其作为常规 PyTorch 模块使用，并参阅 PyTorch 文档以获取所有与通用用法和行为相关的事项。
forward
< source >( input_ids: typing.Optional[torch.LongTensor] = None token_type_ids: typing.Optional[torch.LongTensor] = None attention_mask: typing.Optional[torch.FloatTensor] = None head_mask: typing.Optional[torch.FloatTensor] = None past_key_values: typing.Optional[tuple[tuple[torch.Tensor]]] = None inputs_embeds: typing.Optional[torch.FloatTensor] = None labels: typing.Optional[torch.LongTensor] = None use_cache: typing.Optional[bool] = None position_ids: typing.Optional[torch.LongTensor] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None cache_position: typing.Optional[torch.Tensor] = None ) → transformers.modeling_outputs.TokenClassifierOutput 或 tuple(torch.FloatTensor)
参数
- input_ids (形状为
(batch_size, sequence_length)的torch.LongTensor，可选) — 词汇表中输入序列标记的索引。默认情况下将忽略填充。可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- token_type_ids (形状为
(batch_size, sequence_length)的torch.LongTensor，可选) — 分段标记索引，指示输入的第一个和第二个部分。索引在[0, 1]中选择：- 0 对应于句子 A 标记，
- 1 对应于句子 B 标记。
- attention_mask (
torch.FloatTensor，形状为(batch_size, sequence_length)，可选) — 用于避免在填充标记索引上执行注意力操作的掩码。掩码值选择范围为[0, 1]：- 1 表示**未被掩码**的标记，
- 0 表示**被掩码**的标记。
- head_mask (
torch.FloatTensor，形状为(num_heads,)或(num_layers, num_heads)，可选) — 用于使自注意力模块中的选定头无效的掩码。掩码值选择范围为[0, 1]：- 1 表示头部**未被掩码**，
- 0 表示头部**被掩码**。
- past_key_values (
tuple[tuple[torch.Tensor]]，可选) — 预计算的隐藏状态（自注意力块和交叉注意力块中的键和值），可用于加速顺序解码。这通常包括模型在解码上一阶段返回的past_key_values，当use_cache=True或config.use_cache=True时。允许两种格式：
- 一个 Cache 实例，请参阅我们的 kv cache 指南；
- 长度为
config.n_layers的tuple(torch.FloatTensor)元组，每个元组包含两个形状为(batch_size, num_heads, sequence_length, embed_size_per_head)的张量。这也被称为传统缓存格式。
模型将输出与输入相同的缓存格式。如果没有传入
past_key_values，将返回传统缓存格式。如果使用
past_key_values，用户可以选择仅输入形状为(batch_size, 1)的最新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,)，可选) — 用于计算序列分类/回归损失的标签。索引应在[0, ..., config.num_labels - 1]范围内。如果config.num_labels == 1，则计算回归损失（均方损失），如果config.num_labels > 1，则计算分类损失（交叉熵）。 - use_cache (
bool，可选) — 如果设置为True，则返回past_key_values键值状态，可用于加速解码（参见past_key_values）。 - position_ids (
torch.LongTensor，形状为(batch_size, sequence_length)，可选) — 输入序列中每个标记在位置嵌入中的位置索引。选择范围为[0, config.n_positions - 1]。 - output_attentions (
bool，可选) — 是否返回所有注意力层的注意力张量。更多详情请参阅返回张量中的attentions。 - output_hidden_states (
bool，可选) — 是否返回所有层的隐藏状态。更多详情请参阅返回张量中的hidden_states。 - return_dict (
bool，可选) — 是否返回 ModelOutput 而不是普通元组。 - cache_position (
torch.Tensor，形状为(sequence_length)，可选) — 描述输入序列标记在序列中位置的索引。与position_ids不同，此张量不受填充影响。它用于在正确位置更新缓存并推断完整的序列长度。
返回
transformers.modeling_outputs.TokenClassifierOutput 或 tuple(torch.FloatTensor)
一个 transformers.modeling_outputs.TokenClassifierOutput 或 torch.FloatTensor 元组（如果传入 return_dict=False 或当 config.return_dict=False 时），包含根据配置（BioGptConfig）和输入而定的各种元素。
-
loss (形状为
(1,)的torch.FloatTensor，可选，当提供labels时返回) — 分类损失。 -
logits (形状为
(batch_size, sequence_length, config.num_labels)的torch.FloatTensor) — 分类分数（SoftMax 之前）。 -
hidden_states (形状为
(batch_size, sequence_length, hidden_size)的tuple(torch.FloatTensor)，可选，当传递output_hidden_states=True或config.output_hidden_states=True时返回) —torch.FloatTensor元组（一个用于嵌入层的输出，如果模型有嵌入层，再加上每个层的输出）。模型在每个层输出的隐藏状态以及可选的初始嵌入输出。
-
attentions (形状为
(batch_size, num_heads, sequence_length, sequence_length)的tuple(torch.FloatTensor)，可选，当传递output_attentions=True或config.output_attentions=True时返回) —torch.FloatTensor元组（每个层一个）。注意力 softmax 后的注意力权重，用于计算自注意力头中的加权平均值。
BioGptForTokenClassification 的 forward 方法重写了 __call__ 特殊方法。
尽管前向传递的配方需要在此函数中定义，但之后应调用 Module 实例，而不是此函数，因为前者负责运行预处理和后处理步骤，而后者则默默地忽略它们。
示例
>>> from transformers import AutoTokenizer, BioGptForTokenClassification
>>> import torch
>>> tokenizer = AutoTokenizer.from_pretrained("microsoft/biogpt")
>>> model = BioGptForTokenClassification.from_pretrained("microsoft/biogpt")
>>> 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)
...BioGptForSequenceClassification
class transformers.BioGptForSequenceClassification
< source >( config: BioGptConfig )
参数
- config (BioGptConfig) — 模型配置类，包含模型的所有参数。使用配置文件初始化并不会加载与模型关联的权重，只加载配置。请查看 from_pretrained() 方法以加载模型权重。
BioGpt 模型 Transformer，顶部带有一个序列分类头（线性层）。
BioGptForSequenceClassification 与其他因果模型（例如 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.FloatTensor] = None head_mask: typing.Optional[torch.FloatTensor] = None past_key_values: typing.Optional[tuple[tuple[torch.Tensor]]] = None inputs_embeds: typing.Optional[torch.FloatTensor] = None labels: typing.Optional[torch.LongTensor] = None use_cache: typing.Optional[bool] = None position_ids: typing.Optional[torch.LongTensor] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None cache_position: typing.Optional[torch.Tensor] = None ) → transformers.modeling_outputs.SequenceClassifierOutputWithPast 或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensor，形状为(batch_size, sequence_length)，可选) — 词汇表中输入序列标记的索引。填充将默认被忽略。索引可以使用 AutoTokenizer 获取。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
torch.FloatTensor，形状为(batch_size, sequence_length)，可选) — 用于避免在填充标记索引上执行注意力操作的掩码。掩码值选择范围为[0, 1]：- 1 表示**未被掩码**的标记，
- 0 表示**被掩码**的标记。
- head_mask (
torch.FloatTensor，形状为(num_heads,)或(num_layers, num_heads)，可选) — 用于使自注意力模块中的选定头无效的掩码。掩码值选择范围为[0, 1]：- 1 表示头部**未被掩码**，
- 0 表示头部**被掩码**。
- past_key_values (
tuple[tuple[torch.Tensor]]，可选) — 预计算的隐藏状态（自注意力块和交叉注意力块中的键和值），可用于加速顺序解码。这通常包括模型在解码上一阶段返回的past_key_values，当use_cache=True或config.use_cache=True时。允许两种格式：
- 一个 Cache 实例，请参阅我们的 kv cache 指南；
- 长度为
config.n_layers的tuple(torch.FloatTensor)元组，每个元组包含两个形状为(batch_size, num_heads, sequence_length, embed_size_per_head)的张量。这也被称为传统缓存格式。
模型将输出与输入相同的缓存格式。如果没有传入
past_key_values，将返回传统缓存格式。如果使用
past_key_values，用户可以选择仅输入形状为(batch_size, 1)的最新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,)，可选) — 用于计算序列分类/回归损失的标签。索引应在[0, ..., config.num_labels - 1]范围内。如果config.num_labels == 1，则计算回归损失（均方损失），如果config.num_labels > 1，则计算分类损失（交叉熵）。 - use_cache (
bool，可选) — 如果设置为True，则返回past_key_values键值状态，可用于加速解码（参见past_key_values）。 - position_ids (
torch.LongTensor，形状为(batch_size, sequence_length)，可选) — 输入序列中每个标记在位置嵌入中的位置索引。选择范围为[0, config.n_positions - 1]。 - output_attentions (
bool，可选) — 是否返回所有注意力层的注意力张量。更多详情请参阅返回张量中的attentions。 - output_hidden_states (
bool，可选) — 是否返回所有层的隐藏状态。更多详情请参阅返回张量中的hidden_states。 - return_dict (
bool，可选) — 是否返回 ModelOutput 而不是普通元组。 - cache_position (
torch.Tensor，形状为(sequence_length)，可选) — 描述输入序列标记在序列中位置的索引。与position_ids不同，此张量不受填充影响。它用于在正确位置更新缓存并推断完整的序列长度。
返回
transformers.modeling_outputs.SequenceClassifierOutputWithPast 或 tuple(torch.FloatTensor)
一个 transformers.modeling_outputs.SequenceClassifierOutputWithPast 或 torch.FloatTensor 元组（如果传入 return_dict=False 或当 config.return_dict=False 时），包含根据配置（BioGptConfig）和输入而定的各种元素。
-
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 cache 指南。包含预计算的隐藏状态（自注意力块中的键和值），可用于（参见
past_key_values输入）加速顺序解码。 -
hidden_states (形状为
(batch_size, sequence_length, hidden_size)的tuple(torch.FloatTensor)，可选，当传递output_hidden_states=True或config.output_hidden_states=True时返回) —torch.FloatTensor元组（一个用于嵌入层的输出，如果模型有嵌入层，再加上每个层的输出）。模型在每个层输出的隐藏状态以及可选的初始嵌入输出。
-
attentions (形状为
(batch_size, num_heads, sequence_length, sequence_length)的tuple(torch.FloatTensor)，可选，当传递output_attentions=True或config.output_attentions=True时返回) —torch.FloatTensor元组（每个层一个）。注意力 softmax 后的注意力权重，用于计算自注意力头中的加权平均值。
BioGptForSequenceClassification 的 forward 方法重写了 __call__ 特殊方法。
尽管前向传递的配方需要在此函数中定义，但之后应调用 Module 实例，而不是此函数，因为前者负责运行预处理和后处理步骤，而后者则默默地忽略它们。
单标签分类示例
>>> import torch
>>> from transformers import AutoTokenizer, BioGptForSequenceClassification
>>> tokenizer = AutoTokenizer.from_pretrained("microsoft/biogpt")
>>> model = BioGptForSequenceClassification.from_pretrained("microsoft/biogpt")
>>> 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 = BioGptForSequenceClassification.from_pretrained("microsoft/biogpt", num_labels=num_labels)
>>> labels = torch.tensor([1])
>>> loss = model(**inputs, labels=labels).loss
>>> round(loss.item(), 2)
...多标签分类示例
>>> import torch
>>> from transformers import AutoTokenizer, BioGptForSequenceClassification
>>> tokenizer = AutoTokenizer.from_pretrained("microsoft/biogpt")
>>> model = BioGptForSequenceClassification.from_pretrained("microsoft/biogpt", 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 = BioGptForSequenceClassification.from_pretrained(
... "microsoft/biogpt", 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).loss