Transformers 文档

BioGPT

Transformers

加入 Hugging Face 社区

并获得增强的文档体验

在模型、数据集和 Spaces 上进行协作

通过加速推理获得更快的示例

切换文档主题

开始使用

此模型于 2022 年 10 月 19 日在 HF papers 上发布，并于 2022 年 12 月 5 日贡献给 Hugging Face Transformers。

BioGPT

BioGPT 是一个基于 GPT-2 的生成式 Transformer 模型，并在 1500 万篇 PubMed 摘要上进行了预训练。它专为生物医学语言任务而设计。

您可以在 Microsoft 组织下找到所有原始的 BioGPT 检查点。

点击右侧边栏中的 BioGPT 模型，获取有关如何将 BioGPT 应用于不同语言任务的更多示例。

下面的示例演示了如何使用 Pipeline、AutoModel 以及从命令行生成生物医学文本。

流水线

自动模型

量化通过以较低精度表示权重来减少大型模型的内存负担。有关更多可用量化后端，请参阅量化概述。

下面的示例使用 bitsandbytes 仅将权重量化为 4 位精度。

import torch

from transformers import AutoModelForCausalLM, AutoTokenizer, BitsAndBytesConfig


bnb_config = BitsAndBytesConfig(
    load_in_4bit=True,
    bnb_4bit_quant_type="nf4",
    bnb_4bit_compute_dtype=torch.bfloat16,
    bit_use_double_quant=True
)

tokenizer = AutoTokenizer.from_pretrained("microsoft/BioGPT-Large")
model = AutoModelForCausalLM.from_pretrained(
    "microsoft/BioGPT-Large",
    quantization_config=bnb_config,
    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 参数来访问此功能。

BioGptConfig

class transformers.BioGptConfig

< 源代码 >

( 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 = 42384 hidden_size: int = 1024 num_hidden_layers: int = 24 num_attention_heads: int = 16 intermediate_size: int = 4096 hidden_act: str = 'gelu' hidden_dropout_prob: float | int = 0.1 attention_probs_dropout_prob: float | int = 0.1 max_position_embeddings: int = 1024 initializer_range: float = 0.02 layer_norm_eps: float = 1e-12 scale_embedding: bool = True use_cache: bool = True layerdrop: float | int = 0.0 activation_dropout: float | int = 0.0 pad_token_id: int | None = 1 bos_token_id: int | None = 0 eos_token_id: int | list[int] | None = 2 tie_word_embeddings: bool = True )

参数

vocab_size (int, optional, 默认为 42384) — 模型的词汇表大小。定义了 input_ids 可以表示的不同 token 的数量。
hidden_size (int, optional, 默认为 1024) — 隐藏表示的维度。
num_hidden_layers (int, optional, 默认为 24) — Transformer 解码器中的隐藏层数量。
num_attention_heads (int, optional, 默认为 16) — Transformer 解码器中每个注意力层的注意力头数量。
intermediate_size (int, optional, 默认为 4096) — MLP 表示的维度。
hidden_act (str, optional, 默认为 gelu) — 解码器中的非线性激活函数（函数或字符串）。例如："gelu", "relu", "silu" 等。
hidden_dropout_prob (Union[float, int], optional, 默认为 0.1) — 嵌入、编码器和池化层中所有全连接层的丢弃率。
attention_probs_dropout_prob (Union[float, int], optional, 默认为 0.1) — 注意力概率的丢弃率。
max_position_embeddings (int, optional, 默认为 1024) — 该模型可能使用的最大序列长度。
initializer_range (float, optional, 默认为 0.02) — 用于初始化所有权重矩阵的 truncated_normal_initializer 的标准差。
layer_norm_eps (float, optional, 默认为 1e-12) — 层归一化层使用的 epsilon 值。
scale_embedding (bool, optional, 默认为 True) — 是否通过除以 sqrt(d_model) 来缩放嵌入。
use_cache (bool, optional, 默认为 True) — 模型是否应该返回最后的键/值注意力（并非所有模型都使用）。仅在 config.is_decoder=True 或模型是仅解码器生成模型时相关。
layerdrop (Union[float, int], optional, 默认为 0.0) — LayerDrop 概率。更多详细信息请参阅 LayerDrop 论文。
activation_dropout (Union[float, int], optional, 默认为 0.0) — 全连接层内激活的丢弃率。
pad_token_id (int, optional, 默认为 1) — 词汇表中用于填充的 token ID。
bos_token_id (int, optional, 默认为 0) — 词汇表中用于流起始的 token ID。
eos_token_id (Union[int, list[int]], optional, 默认为 2) — 词汇表中用于流结束的 token ID。
tie_word_embeddings (bool, optional, 默认为 True) — 是否根据模型的 tied_weights_keys 映射绑定权重嵌入。

这是用于存储 BioGptModel 配置的配置类。它用于根据指定的参数实例化 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.config

BioGptTokenizer

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>") — 未知标记（unknown token）。不在词汇表中的标记无法转换为 ID，将被替换为此标记。
bos_token (str, 可选, 默认为 "<s>") — 预训练期间使用的序列开始标记。可用作序列分类标记。

当使用特殊标记构建序列时，此标记并非用于序列开头，实际使用的是 cls_token。
eos_token (str, 可选, 默认为 "</s>") — 序列结束标记。

当使用特殊标记构建序列时，此标记并非用于序列结尾，实际使用的是 sep_token。
sep_token (str, 可选, 默认为 "</s>") — 分隔符标记，用于从多个序列构建序列时（例如，序列分类任务中的两个序列，或问答任务中的文本和问题）。它也用作使用特殊标记构建的序列的最后一个标记。
pad_token (str, 可选, 默认为 "<pad>") — 用于填充的标记，例如在对不同长度的序列进行批处理（batching）时使用。

构建一个 FAIRSEQ Transformer 分词器。采用 Moses 分词后接字节对编码（BPE）。

该分词器继承自 PreTrainedTokenizer，其中包含大部分主要方法。用户应参考此超类以获取有关这些方法的更多信息。

save_vocabulary

< 源码 >

( save_directory: str filename_prefix: str | None = None )

BioGptModel

class transformers.BioGptModel

< 源码 >

( config: BioGptConfig )

参数

config (BioGptConfig) — 模型配置类，包含模型的所有参数。使用配置文件初始化不会加载与模型相关的权重，仅加载配置。查看 from_pretrained() 方法以加载模型权重。

基础的 BioGpt 模型，输出原始隐藏状态，顶部没有任何特定的分类头。

该模型继承自 PreTrainedModel。请查看超类文档以了解该库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、剪枝头部等）。

此模型也是一个 PyTorch torch.nn.Module 子类。像普通的 PyTorch Module 一样使用它，并参考 PyTorch 文档了解一般用法和行为的所有相关信息。

forward

< 源码 >

( input_ids: torch.LongTensor | None = None attention_mask: torch.FloatTensor | None = None inputs_embeds: torch.FloatTensor | None = None past_key_values: transformers.cache_utils.Cache | None = None use_cache: bool | None = None position_ids: torch.LongTensor | None = None **kwargs: typing_extensions.Unpack[transformers.utils.generic.TransformersKwargs] ) → BaseModelOutputWithPastAndCrossAttentions 或 tuple(torch.FloatTensor)

参数

input_ids (torch.LongTensor，形状为 (batch_size, sequence_length)，可选) — 词汇表中输入序列标记的索引。默认情况下将忽略填充（padding）。

索引可以通过 AutoTokenizer 获取。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。

什么是输入 ID？
attention_mask (torch.FloatTensor，形状为 (batch_size, sequence_length)，可选) — 用于避免对填充标记索引执行注意力机制的掩码。掩码值选自 [0, 1]：
- 1 表示未被遮罩的标记，
- 0 表示被遮罩的标记。
什么是注意力掩码？
inputs_embeds (torch.FloatTensor，形状为 (batch_size, sequence_length, hidden_size)，可选) — 还可以选择不传递 input_ids，而是直接传递嵌入表示。如果您想比使用模型内部的嵌入查找矩阵更好地控制如何将 input_ids 索引转换为关联向量，这会很有用。
past_key_values (~cache_utils.Cache，可选) — 预计算的隐藏状态（自注意力块和交叉注意力块中的键和值），可用于加速顺序解码。这通常由模型在解码的前一阶段返回，当 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。
use_cache (bool，可选) — 如果设置为 True，则返回 past_key_values 键值状态，并可用于加速解码（参见 past_key_values）。
position_ids (torch.LongTensor，形状为 (batch_size, sequence_length)，可选) — 每个输入序列标记在位置嵌入中的位置索引。选自 [0, config.n_positions - 1] 范围。

什么是位置 ID？

BaseModelOutputWithPastAndCrossAttentions 或 tuple(torch.FloatTensor)

一个 BaseModelOutputWithPastAndCrossAttentions 对象或一个 torch.FloatTensor 元组（如果传入 return_dict=False 或当 config.return_dict=False 时），根据配置（BioGptConfig）和输入包含不同的元素。

BioGptModel 的前向传播方法，覆盖了 __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=True in the cross-attention blocks) that can be used (see past_key_values input) 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 后的注意力权重，用于计算自注意力头中的加权平均值。
cross_attentions (tuple(torch.FloatTensor), optional, returned when output_attentions=True and config.add_cross_attention=True is passed or when config.output_attentions=True) — Tuple of torch.FloatTensor (one for each layer) of shape (batch_size, num_heads, sequence_length, sequence_length).

解码器交叉注意力层的注意力权重，在注意力 softmax 之后，用于计算交叉注意力头中的加权平均。

BioGptForCausalLM

class transformers.BioGptForCausalLM

< 源码 >

( 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 (BioGptForCausalLM) — 模型配置类，包含模型的所有参数。使用配置文件初始化不会加载与模型相关的权重，仅加载配置。查看 from_pretrained() 方法以加载模型权重。

顶部带有 语言建模 头的 BioGPT 模型，用于因果语言建模（CLM）微调。

该模型继承自 PreTrainedModel。请查看超类文档以了解该库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、剪枝头部等）。

此模型也是一个 PyTorch torch.nn.Module 子类。像普通的 PyTorch Module 一样使用它，并参考 PyTorch 文档了解一般用法和行为的所有相关信息。

forward

< 源码 >

( input_ids: torch.LongTensor | None = None attention_mask: torch.FloatTensor | None = None inputs_embeds: torch.FloatTensor | None = None past_key_values: transformers.cache_utils.Cache | None = None labels: torch.LongTensor | None = None use_cache: bool | None = None position_ids: torch.LongTensor | None = None logits_to_keep: int | torch.Tensor = 0 **kwargs: typing_extensions.Unpack[transformers.utils.generic.TransformersKwargs] ) → CausalLMOutputWithCrossAttentions 或 tuple(torch.FloatTensor)

参数

input_ids (形状为 (batch_size, sequence_length) 的 torch.LongTensor，可选) — 词汇表中输入序列 token 的索引。默认情况下将忽略填充（Padding）。

索引可以通过 AutoTokenizer 获取。详情请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。

什么是 input IDs？
attention_mask (形状为 (batch_size, sequence_length) 的 torch.FloatTensor，可选) — 用于避免对填充 token 索引执行注意力机制的掩码。掩码值选自 [0, 1]：
- 1 表示未被掩码的 token，
- 0 表示被掩码的 token。
什么是 attention masks？
inputs_embeds (形状为 (batch_size, sequence_length, hidden_size) 的 torch.FloatTensor，可选) — 选填。你可以选择直接传入嵌入表示，而不是传入 input_ids。如果你想比模型内部的嵌入查找矩阵更灵活地控制如何将 input_ids 索引转换为关联向量，这将非常有用。
past_key_values (~cache_utils.Cache，可选) — 预计算的隐藏状态（自注意力块和交叉注意力块中的键和值），可用于加速顺序解码。这通常由模型在解码的前一阶段返回，当 use_cache=True 或 config.use_cache=True 时使用。

仅允许 Cache 实例作为输入，请参阅我们的 kv 缓存指南。如果不传递 past_key_values，默认将初始化 DynamicCache。

模型将输出与输入相同格式的缓存。

如果使用了 past_key_values，用户应仅输入形状为 (batch_size, unprocessed_length) 的未处理 input_ids（即未给出其历史键值状态的 token），而不是所有形状为 (batch_size, sequence_length) 的 input_ids。
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，可选) — 每个输入序列 token 在位置嵌入中的位置索引。选择范围为 [0, config.n_positions - 1]。

什么是 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，则必须是一维的，对应于序列长度维度中需要保留的索引。这在使用打包张量格式（batch 和序列长度维度合并）时非常有用。

CausalLMOutputWithCrossAttentions or tuple(torch.FloatTensor)

一个 CausalLMOutputWithCrossAttentions 或一个 torch.FloatTensor 元组（如果传递了 return_dict=False 或 config.return_dict=False），具体包含哪些元素取决于配置（BioGptConfig）和输入。

BioGptForCausalLM 的 forward 方法，覆盖了 __call__ 特殊方法。

虽然 forward pass 的实现需要在此函数中定义，但你应该在之后调用 Module 实例而不是这个，因为前者负责运行预处理和后处理步骤，而后者会静默地忽略它们。

loss (torch.FloatTensor 形状为 (1,)，可选，当提供 labels 时返回) — 语言建模损失（用于下一个 token 预测）。
logits (形状为 (batch_size, sequence_length, config.vocab_size) 的 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 后的注意力权重，用于计算自注意力头中的加权平均值。
cross_attentions (tuple(torch.FloatTensor), optional, returned when output_attentions=True is passed or when config.output_attentions=True) — Tuple of torch.FloatTensor (one for each layer) of shape (batch_size, num_heads, sequence_length, sequence_length).

注意力 softmax 后的交叉注意力权重，用于计算交叉注意力头中的加权平均。
past_key_values (Cache，*可选*，当传入 use_cache=True 或 config.use_cache=True 时返回) — 这是一个 Cache 实例。欲了解更多细节，请参阅我们的 KV 缓存指南。

包含预先计算的隐藏状态（注意力块中的键和值），可用于（参见 past_key_values 输入）加速顺序解码。

示例

BioGptForTokenClassification

class transformers.BioGptForTokenClassification

< 源代码 >

参数

config (BioGptForTokenClassification) — 包含模型所有参数的模型配置类。使用配置文件初始化模型不会加载与模型相关的权重，仅加载配置。请查看 from_pretrained() 方法来加载模型权重。

在顶部带有 token 分类头的 Biogpt transformer（即在隐藏状态输出之上增加一个线性层），例如用于命名实体识别（NER）任务。

该模型继承自 PreTrainedModel。请查看超类文档以了解该库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、剪枝头部等）。

此模型也是一个 PyTorch torch.nn.Module 子类。像普通的 PyTorch Module 一样使用它，并参考 PyTorch 文档了解一般用法和行为的所有相关信息。

forward

< 源代码 >

( input_ids: torch.LongTensor | None = None token_type_ids: torch.LongTensor | None = None attention_mask: torch.FloatTensor | 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 position_ids: torch.LongTensor | None = None **kwargs ) → TokenClassifierOutput 或 tuple(torch.FloatTensor)

参数

input_ids (形状为 (batch_size, sequence_length) 的 torch.LongTensor，可选) — 词汇表中输入序列 token 的索引。默认情况下将忽略填充。

索引可以通过 AutoTokenizer 获取。详情请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。

什么是 input IDs？
token_type_ids (形状为 (batch_size, sequence_length) 的 torch.LongTensor，可选) — 用于指示输入的第一部分和第二部分的段 token 索引。索引选择范围为 [0, 1]：
- 0 对应于 句子 A 的 token，
- 1 对应于 句子 B 的 token。
什么是 token type IDs？
attention_mask (形状为 (batch_size, sequence_length) 的 torch.FloatTensor，可选) — 用于避免对填充 token 索引执行注意力机制的掩码。掩码值选自 [0, 1]：
- 1 表示未被掩码的 token，
- 0 表示被掩码的 token。
什么是 attention masks？
past_key_values (~cache_utils.Cache，可选) — 预计算的隐藏状态（自注意力块和交叉注意力块中的键和值），可用于加速顺序解码。这通常由模型在解码的前一阶段返回，当 use_cache=True 或 config.use_cache=True 时使用。

仅允许 Cache 实例作为输入，请参阅我们的 kv 缓存指南。如果不传递 past_key_values，默认将初始化 DynamicCache。

模型将输出与输入相同格式的缓存。

如果使用了 past_key_values，用户应仅输入形状为 (batch_size, unprocessed_length) 的未处理 input_ids（即未给出其历史键值状态的 token），而不是所有形状为 (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, optional) — 如果设置为 True，则会返回 past_key_values 键值状态，并可用于加速解码（参见 past_key_values）。
position_ids (torch.LongTensor，形状为 (batch_size, sequence_length)，optional) — 每个输入序列标记在位置嵌入中的位置索引。选择范围为 [0, config.n_positions - 1]。

什么是位置 ID？

TokenClassifierOutput 或 tuple(torch.FloatTensor)

一个 TokenClassifierOutput 或一个 torch.FloatTensor 元组（如果传递了 return_dict=False 或 config.return_dict=False 时），根据配置（BioGptConfig）和输入，包含不同的元素。

BioGptForTokenClassification 的前向传播方法，覆盖了 __call__ 特殊方法。

虽然 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 后的注意力权重，用于计算自注意力头中的加权平均值。

示例

>>> 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

< 源文件 >

( config: BioGptConfig )

参数

config (BioGptConfig) — 包含模型所有参数的模型配置类。使用配置文件初始化不会加载模型相关的权重，只会加载配置。查看 from_pretrained() 方法以加载模型权重。

BioGpt 模型转换器，顶部带有序列分类头（线性层）。

BioGptForSequenceClassification 使用最后一个标记来进行分类，正如其他因果模型（如 GPT-2）所做的那样。

由于它是在最后一个标记上进行分类，因此需要知道最后一个标记的位置。如果在配置中定义了 pad_token_id，它会找到每一行中不是填充标记的最后一个标记。如果未定义 pad_token_id，它只会取批次中每一行的最后一个值。由于当传入 inputs_embeds 而不是 input_ids 时，它无法推断填充标记，因此它执行相同的操作（取批次中每一行的最后一个值）。

该模型继承自 PreTrainedModel。请查看超类文档以了解该库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、剪枝头部等）。

此模型也是一个 PyTorch torch.nn.Module 子类。像普通的 PyTorch Module 一样使用它，并参考 PyTorch 文档了解一般用法和行为的所有相关信息。

forward

< 源文件 >

( input_ids: torch.LongTensor | None = None attention_mask: torch.FloatTensor | 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 position_ids: torch.LongTensor | None = None logits_to_keep: int | torch.Tensor = 0 **kwargs ) → SequenceClassifierOutputWithPast 或 tuple(torch.FloatTensor)

参数

input_ids (torch.LongTensor，形状为 (batch_size, sequence_length)，optional) — 输入序列标记在词汇表中的索引。默认情况下，填充（Padding）将被忽略。

索引可以使用 AutoTokenizer 获取。详情请参见 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。

什么是输入 ID？
attention_mask (torch.FloatTensor，形状为 (batch_size, sequence_length)，optional) — 用于避免对填充标记索引执行注意力计算的掩码。掩码值选自 [0, 1]：
- 1 表示未被掩码的标记，
- 0 表示被掩码的标记。
什么是注意力掩码？
past_key_values (~cache_utils.Cache，optional) — 预先计算的隐藏状态（自注意力模块和交叉注意力模块中的键和值），可用于加速顺序解码。这通常由模型在先前解码阶段返回的 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)，optional) — 可选地，你可以选择直接传递嵌入表示，而不是传递 input_ids。如果你想比模型内部的嵌入查找矩阵更精细地控制如何将 input_ids 索引转换为关联向量，这非常有用。
labels (torch.LongTensor，形状为 (batch_size,)，optional) — 用于计算序列分类/回归损失的标签。索引应在 [0, ..., config.num_labels - 1] 范围内。如果 config.num_labels == 1，则计算回归损失（均方误差损失）；如果 config.num_labels > 1，则计算分类损失（交叉熵损失）。
use_cache (bool，optional) — 如果设置为 True，则会返回 past_key_values 键值状态，并可用于加速解码（参见 past_key_values）。
position_ids (torch.LongTensor，形状为 (batch_size, sequence_length)，optional) — 每个输入序列标记在位置嵌入中的位置索引。选择范围为 [0, config.n_positions - 1]。

什么是位置 ID？
logits_to_keep (Union[int, torch.Tensor]，optional，默认为 0) — 如果是 int，则计算最后 logits_to_keep 个标记的 Logits。如果为 0，则计算所有 input_ids 的 Logits（特殊情况）。生成时仅需要最后标记的 Logits，仅为该标记计算它们可以节省内存，这对于长序列或大词汇量的情况尤为显著。如果是一个 torch.Tensor，必须是对应于序列长度维度中要保留的索引的一维张量。这在使用打包张量格式（批次和序列长度为单一维度）时非常有用。

SequenceClassifierOutputWithPast 或 tuple(torch.FloatTensor)

一个 SequenceClassifierOutputWithPast 或一个 torch.FloatTensor 元组（如果传递了 return_dict=False 或 config.return_dict=False 时），根据配置（BioGptConfig）和输入，包含不同的元素。

BioGptForSequenceClassification 的前向传播方法，覆盖了 __call__ 特殊方法。

虽然 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 后的注意力权重，用于计算自注意力头中的加权平均值。

单标签分类示例

>>> 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

在 GitHub 上更新

←BigBirdPegasus BitNet→