ESM
概述
本页面提供来自 Meta AI 的基础人工智能研究团队的 Transformer 蛋白质语言模型的代码和预训练权重，提供最先进的 ESMFold 和 ESM-2，以及之前发布的 ESM-1b 和 ESM-1v。Transformer 蛋白质语言模型在论文 通过将无监督学习扩展到 2.5 亿个蛋白质序列来揭示生物结构和功能 中提出，作者是 Alexander Rives、Joshua Meier、Tom Sercu、Siddharth Goyal、Zeming Lin、Jason Liu、Demi Guo、Myle Ott、C. Lawrence Zitnick、Jerry Ma 和 Rob Fergus。本文的第一版是在 2019 年预印 的。
ESM-2 在一系列结构预测任务中优于所有经过测试的单序列蛋白质语言模型，并实现了原子分辨率的结构预测。它在论文 进化规模的蛋白质序列语言模型使准确的结构预测成为可能 中发布，作者是 Zeming Lin、Halil Akin、Roshan Rao、Brian Hie、Zhongkai Zhu、Wenting Lu、Allan dos Santos Costa、Maryam Fazel-Zarandi、Tom Sercu、Sal Candido 和 Alexander Rives。
本文还介绍了 ESMFold。它使用 ESM-2 主干和一个可以预测折叠蛋白质结构的头部，其精度达到最先进水平。与 AlphaFold2 不同，它依赖于来自大型预训练蛋白质语言模型主干的标记嵌入，并且在推理时不执行多序列比对 (MSA) 步骤，这意味着 ESMFold 检查点是完全“独立”的 - 它们不需要数据库来预测已知蛋白质序列和结构以及相关外部查询工具，因此速度快得多。
来自“通过将无监督学习扩展到 2.5 亿个蛋白质序列来揭示生物结构和功能”的摘要是
在人工智能领域，通过无监督学习实现的数据规模和模型容量的结合，推动了表示学习和统计生成的重大进步。在生命科学领域，预期中的测序增长将为自然序列多样性提供前所未有的数据。进化规模的蛋白质语言建模是朝着生物预测性和生成式人工智能迈出的逻辑一步。为此，我们使用无监督学习在 2.5 亿个跨越进化多样性的蛋白质序列的 860 亿个氨基酸上训练了一个深度上下文语言模型。得到的模型在其表示中包含有关生物学特性的信息。表示是从序列数据中学习的。学习到的表示空间具有多尺度组织，反映了从氨基酸生化特性到蛋白质远程同源性的结构。有关二级和三级结构的信息被编码到表示中，可以通过线性投影来识别。表示学习产生了在各种应用中泛化的特征，从而能够以最先进的精度预测突变效应和二级结构，并改善用于远程接触预测的最先进特征。
来自“进化规模的蛋白质序列语言模型使准确的结构预测成为可能”的摘要是
大型语言模型最近被证明随着规模的扩大而发展出新兴的能力，超越了简单的模式匹配，而是执行更高层次的推理并生成逼真的图像和文本。虽然已经对更小规模的蛋白质序列训练的语言模型进行了研究，但对这些模型随着规模扩大而对生物学学习了什么知之甚少。在这项工作中，我们训练了高达 150 亿个参数的模型，这是迄今为止评估的最大蛋白质语言模型。我们发现，随着模型的规模扩大，它们学习了信息，使能够以原子分辨率预测蛋白质的三维结构。我们提出了 ESMFold，用于直接从蛋白质的单个序列进行高精度端到端原子级结构预测。对于语言模型可以很好理解的低困惑度的序列，ESMFold 的精度与 AlphaFold2 和 RoseTTAFold 相似。ESMFold 推理比 AlphaFold2 快一个数量级，从而能够在实际时间尺度上探索元基因组蛋白质的结构空间。
原始代码可以在 此处 找到，是由 Meta AI 的基础人工智能研究团队开发的。ESM-1b、ESM-1v 和 ESM-2 由 jasonliu 和 Matt 贡献给 huggingface。
ESMFold 由 Matt 和 Sylvain 贡献给 huggingface，非常感谢 Nikita Smetanin、Roshan Rao 和 Tom Sercu 在整个过程中提供的帮助！
使用技巧
- ESM 模型使用掩码语言建模 (MLM) 目标进行训练。
- ESMFold 的 HuggingFace 端口使用 openfold 库的部分内容。
openfold库在 Apache 许可证 2.0 下授权。
资源
EsmConfig
class transformers.EsmConfig
< 源代码 >( vocab_size = None mask_token_id = None pad_token_id = None hidden_size = 768 num_hidden_layers = 12 num_attention_heads = 12 intermediate_size = 3072 hidden_dropout_prob = 0.1 attention_probs_dropout_prob = 0.1 max_position_embeddings = 1026 initializer_range = 0.02 layer_norm_eps = 1e-12 position_embedding_type = 'absolute' use_cache = True emb_layer_norm_before = None token_dropout = False is_folding_model = False esmfold_config = None vocab_list = None **kwargs )
参数
- vocab_size (
int, 可选) — ESM 模型的词汇量大小。定义了调用ESMModel时传递的inputs_ids可以表示的不同标记数量。 - mask_token_id (
int, 可选) — 词汇表中掩码标记的索引。这必须包含在配置中，因为存在“掩码-丢弃”缩放技巧，该技巧将根据掩码标记的数量缩放输入。 - pad_token_id (
int, 可选) — 词汇表中填充标记的索引。这必须包含在配置中，因为 ESM 代码的某些部分使用它而不是注意力掩码。 - hidden_size (
int, 可选，默认值为 768) — 编码器层和池化层的维度。 - num_hidden_layers (
int, 可选，默认值为 12) — Transformer 编码器中的隐藏层数量。 - num_attention_heads (
int, 可选，默认值为 12) — Transformer 编码器中每个注意力层的注意力头的数量。 - intermediate_size (
int, 可选，默认值为 3072) — Transformer 编码器中“中间”（通常称为前馈）层的维度。 - hidden_dropout_prob (
float, optional, defaults to 0.1) — 所有嵌入、编码器和池化器中所有全连接层的 dropout 概率。 - attention_probs_dropout_prob (
float, optional, defaults to 0.1) — 注意力概率的 dropout 比率。 - max_position_embeddings (
int, optional, defaults to 1026) — 该模型可能使用的最大序列长度。通常将其设置为较大的值，以防万一（例如，512 或 1024 或 2048）。 - initializer_range (
float, optional, defaults to 0.02) — 初始化所有权重矩阵的 truncated_normal_initializer 的标准差。 - layer_norm_eps (
float, optional, defaults to 1e-12) — 层归一化层的 epsilon 值。 - position_embedding_type (
str, optional, defaults to"absolute") — 位置嵌入的类型。选择"absolute"、"relative_key"、"relative_key_query", "rotary"之一。对于位置嵌入，使用"absolute"。有关"relative_key"的更多信息，请参阅 Self-Attention with Relative Position Representations (Shaw et al.)。有关"relative_key_query"的更多信息，请参阅 Improve Transformer Models with Better Relative Position Embeddings (Huang et al.) 中的 *方法 4*。 - is_decoder (
bool, optional, defaults toFalse) — 模型是否用作解码器。如果为False，则模型用作编码器。 - use_cache (
bool, optional, defaults toTrue) — 模型是否应返回最后键值注意力（并非所有模型都使用）。仅在config.is_decoder=True时相关。 - emb_layer_norm_before (
bool, optional) — 是否在嵌入后但在网络主干之前应用层归一化。 - token_dropout (
bool, defaults toFalse) — 启用此功能时，屏蔽的标记将被视为通过输入 dropout 删除。
这是用于存储 ESMModel 配置的配置类。它用于根据指定的参数实例化 ESM 模型，定义模型架构。使用默认值实例化配置将生成与 ESM facebook/esm-1b 架构类似的配置。
配置对象继承自 PretrainedConfig，可用于控制模型输出。阅读 PretrainedConfig 中的文档以了解更多信息。
示例
>>> from transformers import EsmModel, EsmConfig
>>> # Initializing a ESM facebook/esm-1b style configuration >>> configuration = EsmConfig()
>>> # Initializing a model from the configuration >>> model = ESMModel(configuration)
>>> # Accessing the model configuration >>> configuration = model.config将此实例序列化为 Python 字典。 覆盖默认的 to_dict()。
EsmTokenizer
class transformers.EsmTokenizer
< source >( vocab_file unk_token = '<unk>' cls_token = '<cls>' pad_token = '<pad>' mask_token = '<mask>' eos_token = '<eos>' **kwargs )
构建一个 ESM 分词器。
get_special_tokens_mask
< source >( token_ids_0: List token_ids_1: Optional = None already_has_special_tokens: bool = False ) → 一个整数列表，范围在 [0, 1] 之间
从没有添加特殊令牌的令牌列表中检索序列 ID。 当使用分词器 prepare_for_model 或 encode_plus 方法添加特殊令牌时，会调用此方法。
create_token_type_ids_from_sequences
< source >( token_ids_0: List token_ids_1: Optional = None ) → List[int]
创建与传递的序列相对应的标记类型 ID。 什么是标记类型 ID？
如果模型有特殊的方式来构建这些 ID，应该在子类中被重写。
EsmModel
class transformers.EsmModel
< source >( config add_pooling_layer = True )
参数
- config (EsmConfig) — 模型配置类，包含模型的所有参数。使用配置文件初始化不会加载与模型相关的权重，只会加载配置。查看 from_pretrained() 方法来加载模型权重。
ESM 模型的裸transformer，输出原始的隐藏状态，没有任何特定的头部。
该模型继承自 PreTrainedModel。查看超类文档以了解库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入的大小、剪枝头部等）。
该模型也是一个 PyTorch torch.nn.Module 子类。将其用作普通的 PyTorch 模块，并参考 PyTorch 文档以了解有关一般用法和行为的所有事项。
该模型可以作为编码器（只有自注意力）或解码器，在这种情况下，在自注意力层之间添加一层交叉注意力，遵循 Ashish Vaswani、Noam Shazeer、Niki Parmar、Jakob Uszkoreit、Llion Jones、Aidan N. Gomez、Lukasz Kaiser 和 Illia Polosukhin 在 Attention is all you need 中描述的架构。
要作为解码器，模型需要使用配置的 `is_decoder` 参数设置为 `True` 进行初始化。要用于 Seq2Seq 模型，模型需要使用 `is_decoder` 参数和 `add_cross_attention` 设置为 `True` 进行初始化；然后，`encoder_hidden_states` 将被期望作为前向传递的输入。
forward
< source >( input_ids: Optional = None attention_mask: Optional = None position_ids: Optional = None head_mask: Optional = None inputs_embeds: Optional = None encoder_hidden_states: Optional = None encoder_attention_mask: Optional = None past_key_values: Optional = None use_cache: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None ) → transformers.modeling_outputs.BaseModelOutputWithPoolingAndCrossAttentions or 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 表示掩码的词元。
- position_ids (
torch.LongTensor形状为((batch_size, sequence_length)), 可选) — 输入序列词元在位置嵌入中的位置索引。 选择范围在[0, config.max_position_embeddings - 1]之间。 - head_mask (
torch.FloatTensor形状为(num_heads,)或(num_layers, num_heads), 可选) — 掩码，用于使自注意力模块中选定的头部无效。掩码值选择在[0, 1]之间：- 1 表示未掩码的头部，
- 0 表示掩码的头部。
- inputs_embeds (
torch.FloatTensor形状为((batch_size, sequence_length), hidden_size), 可选) — 可选地，您可以选择直接传递嵌入式表示，而不是传递input_ids。 如果你想要比模型内部嵌入查找矩阵更好地控制如何将input_ids索引转换为相关向量，这将非常有用。 - output_attentions (
bool, 可选) — 是否返回所有注意力层的注意力张量。 有关详细信息，请参阅返回张量中的attentions。 - output_hidden_states (
bool, 可选) — 是否返回所有层的隐藏状态。 有关详细信息，请参阅返回张量中的hidden_states。 - return_dict (
bool, 可选) — 是否返回 ModelOutput 而不是普通元组。 - encoder_hidden_states (
torch.FloatTensor形状为(batch_size, sequence_length, hidden_size), 可选) — 编码器最后一层输出的隐藏状态序列。如果模型配置为解码器，则在交叉注意力中使用。 - encoder_attention_mask (
torch.FloatTensor形状为(batch_size, sequence_length), 可选) — 用于避免对编码器输入的填充标记索引执行注意力的掩码。如果模型配置为解码器，则此掩码用于交叉注意力。掩码值选择在[0, 1]中：- 1 表示未掩码的标记，
- 0 表示掩码的标记。
- past_key_values (
tuple(tuple(torch.FloatTensor))长度为config.n_layers，每个元组包含 4 个形状为(batch_size, num_heads, sequence_length - 1, embed_size_per_head)的张量) — 包含预先计算的注意力块的键和值隐藏状态。可用于加速解码。如果使用
past_key_values，用户可以选择仅输入形状为(batch_size, 1)的最后一个decoder_input_ids（那些没有为该模型提供过去的键值状态的）而不是所有形状为(batch_size, sequence_length)的decoder_input_ids。 - use_cache (
bool, 可选) — 如果设置为True，则返回past_key_values键值状态，可用于加速解码（见past_key_values）。
返回
transformers.modeling_outputs.BaseModelOutputWithPoolingAndCrossAttentions 或 tuple(torch.FloatTensor)
一个 transformers.modeling_outputs.BaseModelOutputWithPoolingAndCrossAttentions 或一个 torch.FloatTensor 元组（如果传递了 return_dict=False 或者当 config.return_dict=False 时），包含取决于配置 (EsmConfig) 和输入的各种元素。
-
last_hidden_state (
torch.FloatTensor形状为(batch_size, sequence_length, hidden_size)) — 模型最后一层输出的隐藏状态序列。 -
pooler_output (
torch.FloatTensor形状为(batch_size, hidden_size)) — 序列第一个标记（分类标记）的最后一层隐藏状态，经过用于辅助预训练任务的层的进一步处理。例如，对于 BERT 家族的模型，这将返回经过线性层和 tanh 激活函数处理后的分类标记。线性层权重是在预训练期间从下一个句子预测（分类）目标中训练出来的。 -
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 之后的注意力权重，用于计算自注意力头中的加权平均值。
-
cross_attentions (
tuple(torch.FloatTensor), 可选, 当传递output_attentions=True和config.add_cross_attention=True或当config.output_attentions=True时返回) —torch.FloatTensor元组（每个层一个）形状为(batch_size, num_heads, sequence_length, sequence_length)。解码器交叉注意力层的注意力权重，在注意力 softmax 之后，用于计算交叉注意力头中的加权平均值。
-
past_key_values (
tuple(tuple(torch.FloatTensor)), 可选, 当传递use_cache=True或当config.use_cache=True时返回) —tuple(torch.FloatTensor)元组，长度为config.n_layers，每个元组包含 2 个形状为(batch_size, num_heads, sequence_length, embed_size_per_head)的张量），以及可选地，如果config.is_encoder_decoder=True，则包含 2 个形状为(batch_size, num_heads, encoder_sequence_length, embed_size_per_head)的额外张量。包含预先计算的隐藏状态（自注意力块中的键和值，以及可选地，如果
config.is_encoder_decoder=True，则包含交叉注意力块中的键和值），可用于（见past_key_values输入）加速顺序解码。
EsmModel 正向方法覆盖了 __call__ 特殊方法。
虽然正向传递的配方需要在此函数中定义，但应该在之后调用 Module 实例，而不是这个，因为前者负责运行预处理和后处理步骤，而后者则会静默地忽略它们。
示例
>>> from transformers import AutoTokenizer, EsmModel
>>> import torch
>>> tokenizer = AutoTokenizer.from_pretrained("facebook/esm2_t6_8M_UR50D")
>>> model = EsmModel.from_pretrained("facebook/esm2_t6_8M_UR50D")
>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="pt")
>>> outputs = model(**inputs)
>>> last_hidden_states = outputs.last_hidden_stateEsmForMaskedLM
class transformers.EsmForMaskedLM
< source >( config )
参数
- config (EsmConfig) — 模型配置类，包含模型的所有参数。用配置文件初始化不会加载与模型相关的权重，只会加载配置。查看 from_pretrained() 方法以加载模型权重。
带有 语言建模 头的 ESM 模型。
该模型继承自 PreTrainedModel。查看超类文档以了解库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入的大小、剪枝头部等）。
该模型也是一个 PyTorch torch.nn.Module 子类。将其用作普通的 PyTorch 模块，并参考 PyTorch 文档以了解有关一般用法和行为的所有事项。
forward
< 源代码 >( input_ids: Optional = None attention_mask: Optional = None position_ids: Optional = None head_mask: Optional = None inputs_embeds: Optional = None encoder_hidden_states: Optional = None encoder_attention_mask: Optional = None labels: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None ) → transformers.modeling_outputs.MaskedLMOutput or 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 表示被掩码的词元。
- position_ids (
torch.LongTensor形状为(batch_size, sequence_length), 可选) — 输入序列词元在位置嵌入中的位置索引。选自[0, config.max_position_embeddings - 1]范围。 - head_mask (
torch.FloatTensor形状为(num_heads,)或(num_layers, num_heads), 可选) — 用于使自注意力模块中选定的头无效的掩码。掩码值选自[0, 1]:- 1 表示未被掩码的头，
- 0 表示被掩码的头。
- inputs_embeds (
torch.FloatTensor形状为(batch_size, sequence_length, hidden_size), 可选) — 可选地，您可以选择直接传递嵌入表示，而不是传递input_ids。如果您希望对如何将input_ids索引转换为关联向量进行更多控制，这将非常有用，而不是模型的内部嵌入查找矩阵。 - output_attentions (
bool, 可选) — 是否返回所有注意力层的注意力张量。有关详细信息，请参见返回张量中的attentions。 - output_hidden_states (
bool, 可选) — 是否返回所有层的隐藏状态。有关详细信息，请参见返回张量中的hidden_states。 - return_dict (
bool, 可选) — 是否返回 ModelOutput 而不是普通的元组。 - labels (
torch.LongTensor形状为(batch_size, sequence_length), 可选) — 用于计算掩码语言建模损失的标签。索引应在[-100, 0, ..., config.vocab_size]内（参见input_ids文档字符串）。索引设置为-100的标记会被忽略（掩码），损失仅针对标签在[0, ..., config.vocab_size]内的标记计算。 - kwargs (
Dict[str, any], 可选, 默认值{}) — 用于隐藏已弃用的旧参数。
返回
transformers.modeling_outputs.MaskedLMOutput 或 tuple(torch.FloatTensor)
一个 transformers.modeling_outputs.MaskedLMOutput 或一个 torch.FloatTensor 元组（如果传递了 return_dict=False 或当 config.return_dict=False 时），包含根据配置 (EsmConfig) 和输入的不同元素。
-
loss (
torch.FloatTensor形状为(1,), 可选, 当提供labels时返回) — 掩码语言建模 (MLM) 损失。 -
logits (
torch.FloatTensor形状为(batch_size, sequence_length, config.vocab_size)) — 语言建模头的预测分数（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 之后的注意力权重，用于计算自注意力头中的加权平均值。
The EsmForMaskedLM forward 方法，覆盖了 __call__ 特殊方法。
虽然正向传递的配方需要在此函数中定义，但应该在之后调用 Module 实例，而不是这个，因为前者负责运行预处理和后处理步骤，而后者则会静默地忽略它们。
示例
>>> from transformers import AutoTokenizer, EsmForMaskedLM
>>> import torch
>>> tokenizer = AutoTokenizer.from_pretrained("facebook/esm2_t6_8M_UR50D")
>>> model = EsmForMaskedLM.from_pretrained("facebook/esm2_t6_8M_UR50D")
>>> inputs = tokenizer("The capital of France is <mask>.", return_tensors="pt")
>>> with torch.no_grad():
... logits = model(**inputs).logits
>>> # retrieve index of <mask>
>>> mask_token_index = (inputs.input_ids == tokenizer.mask_token_id)[0].nonzero(as_tuple=True)[0]
>>> predicted_token_id = logits[0, mask_token_index].argmax(axis=-1)
>>> labels = tokenizer("The capital of France is Paris.", return_tensors="pt")["input_ids"]
>>> # mask labels of non-<mask> tokens
>>> labels = torch.where(inputs.input_ids == tokenizer.mask_token_id, labels, -100)
>>> outputs = model(**inputs, labels=labels)EsmForSequenceClassification
class transformers.EsmForSequenceClassification
< 源代码 >( config )
参数
- config (EsmConfig) — 模型配置类，包含模型的所有参数。使用配置文件初始化不会加载与模型相关的权重，只会加载配置。查看 from_pretrained() 方法以加载模型权重。
具有序列分类/回归头的 ESM 模型转换器（在池化输出之上有一个线性层），例如用于 GLUE 任务。
该模型继承自 PreTrainedModel。查看超类文档以了解库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入的大小、剪枝头部等）。
该模型也是一个 PyTorch torch.nn.Module 子类。将其用作普通的 PyTorch 模块，并参考 PyTorch 文档以了解有关一般用法和行为的所有事项。
forward
< 源代码 >( input_ids: Optional = None attention_mask: Optional = None position_ids: Optional = None head_mask: Optional = None inputs_embeds: Optional = None labels: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None ) → transformers.modeling_outputs.SequenceClassifierOutput 或 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 表示 掩码 的标记。
- position_ids (
torch.LongTensor形状为(batch_size, sequence_length)，可选) — 位置嵌入中每个输入序列标记的位置索引。在[0, config.max_position_embeddings - 1]范围内选择。 - head_mask (
torch.FloatTensor形状为(num_heads,)或(num_layers, num_heads)，可选) — 用于使自注意力模块的选定头部无效的掩码。掩码值在[0, 1]中选择：- 1 表示头部 未掩码，
- 0 表示头部 掩码。
- inputs_embeds (
torch.FloatTensor形状为(batch_size, sequence_length, hidden_size)，可选) — 可选地，您可以选择直接传递嵌入表示，而不是传递input_ids。如果您想比模型的内部嵌入查找矩阵更精确地控制如何将input_ids索引转换为相关向量，这很有用。 - output_attentions (
bool，可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参阅返回张量中的attentions。 - output_hidden_states (
bool，可选) — 是否返回所有层的隐藏状态。有关更多详细信息，请参阅返回张量中的hidden_states。 - return_dict (
bool，可选) — 是否返回 ModelOutput 而不是普通元组。 - labels (
torch.LongTensor形状为(batch_size,)，可选) — 用于计算序列分类/回归损失的标签。索引应在[0, ..., config.num_labels - 1]中。如果config.num_labels == 1，则计算回归损失（均方误差损失），如果config.num_labels > 1，则计算分类损失（交叉熵）。
返回
transformers.modeling_outputs.SequenceClassifierOutput 或 tuple(torch.FloatTensor)
一个 transformers.modeling_outputs.SequenceClassifierOutput 或 torch.FloatTensor 的元组（如果传递了 return_dict=False 或当 config.return_dict=False 时），包含根据配置（EsmConfig）和输入的不同元素。
-
loss (
torch.FloatTensor形状为(1,)，可选，在提供labels时返回) — 分类（如果 config.num_labels==1 则为回归）损失。 -
logits (
torch.FloatTensor形状为(batch_size, config.num_labels)) — 分类（如果 config.num_labels==1 则为回归）分数（在 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 之后的注意力权重，用于计算自注意力头中的加权平均值。
The EsmForSequenceClassification 正向方法，覆盖 __call__ 特殊方法。
虽然正向传递的配方需要在此函数中定义，但应该在之后调用 Module 实例，而不是这个，因为前者负责运行预处理和后处理步骤，而后者则会静默地忽略它们。
单标签分类的示例
>>> import torch
>>> from transformers import AutoTokenizer, EsmForSequenceClassification
>>> tokenizer = AutoTokenizer.from_pretrained("facebook/esm2_t6_8M_UR50D")
>>> model = EsmForSequenceClassification.from_pretrained("facebook/esm2_t6_8M_UR50D")
>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="pt")
>>> with torch.no_grad():
... logits = model(**inputs).logits
>>> predicted_class_id = logits.argmax().item()
>>> # 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 = EsmForSequenceClassification.from_pretrained("facebook/esm2_t6_8M_UR50D", num_labels=num_labels)
>>> labels = torch.tensor([1])
>>> loss = model(**inputs, labels=labels).loss多标签分类的示例
>>> import torch
>>> from transformers import AutoTokenizer, EsmForSequenceClassification
>>> tokenizer = AutoTokenizer.from_pretrained("facebook/esm2_t6_8M_UR50D")
>>> model = EsmForSequenceClassification.from_pretrained("facebook/esm2_t6_8M_UR50D", 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 = EsmForSequenceClassification.from_pretrained(
... "facebook/esm2_t6_8M_UR50D", 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).lossEsmForTokenClassification
class transformers.EsmForTokenClassification
< 来源 >( config )
参数
- config (EsmConfig) — 模型配置类，包含模型的所有参数。使用配置文件进行初始化不会加载与模型关联的权重，仅加载配置。查看 from_pretrained() 方法来加载模型权重。
在 ESM 模型之上添加令牌分类头（隐藏状态输出之上的线性层），例如用于命名实体识别（NER）任务。
该模型继承自 PreTrainedModel。查看超类文档以了解库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入的大小、剪枝头部等）。
该模型也是一个 PyTorch torch.nn.Module 子类。将其用作普通的 PyTorch 模块，并参考 PyTorch 文档以了解有关一般用法和行为的所有事项。
forward
< 来源 >( input_ids: Optional = None attention_mask: Optional = None position_ids: Optional = None head_mask: Optional = None inputs_embeds: Optional = None labels: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None ) → transformers.modeling_outputs.TokenClassifierOutput 或 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 表示掩码的标记。
- position_ids (
torch.LongTensor形状为(batch_size, sequence_length), 可选) — 位置嵌入中每个输入序列标记的位置索引。选择在[0, config.max_position_embeddings - 1]范围内。 - head_mask (
torch.FloatTensor形状为(num_heads,)或(num_layers, num_heads), 可选) — 掩码以使自注意力模块的选定头无效。掩码值选择在[0, 1]中：- 1 表示未掩码的头，
- 0 表示掩码的头。
- inputs_embeds (
torch.FloatTensor形状为(batch_size, sequence_length, hidden_size), 可选) — 可选地，您可以选择直接传递嵌入表示，而不是传递input_ids。如果您想比模型的内部嵌入查找矩阵更有效地控制如何将input_ids索引转换为关联的向量，这将很有用。 - output_attentions (
bool, 可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参阅返回张量下的attentions。 - output_hidden_states (
bool, 可选) — 是否返回所有层的隐藏状态。有关更多详细信息，请参阅返回张量下的hidden_states。 - return_dict (
bool, 可选) — 是否返回 ModelOutput 而不是普通元组。 - labels (
torch.LongTensor形状为(batch_size, sequence_length), 可选) — 用于计算标记分类损失的标签。索引应在[0, ..., config.num_labels - 1]中。
返回
transformers.modeling_outputs.TokenClassifierOutput 或 tuple(torch.FloatTensor)
一个 transformers.modeling_outputs.TokenClassifierOutput 或 torch.FloatTensor 的元组（如果传递了 return_dict=False 或当 config.return_dict=False 时），包括取决于配置（EsmConfig）和输入的各种元素。
-
loss (
torch.FloatTensor形状为(1,), 可选, 当提供labels时返回) — 分类损失。 -
logits (
torch.FloatTensor形状为(batch_size, sequence_length, config.num_labels)) — 分类分数（在 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 之后的注意力权重，用于计算自注意力头中的加权平均值。
The EsmForTokenClassification 正向方法，覆盖了 __call__ 特殊方法。
虽然正向传递的配方需要在此函数中定义，但应该在之后调用 Module 实例，而不是这个，因为前者负责运行预处理和后处理步骤，而后者则会静默地忽略它们。
示例
>>> from transformers import AutoTokenizer, EsmForTokenClassification
>>> import torch
>>> tokenizer = AutoTokenizer.from_pretrained("facebook/esm2_t6_8M_UR50D")
>>> model = EsmForTokenClassification.from_pretrained("facebook/esm2_t6_8M_UR50D")
>>> 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]]
>>> labels = predicted_token_class_ids
>>> loss = model(**inputs, labels=labels).lossEsmForProteinFolding
类 transformers.EsmForProteinFolding
< 源代码 >( config )
参数
- config (EsmConfig) — 模型配置类，包含模型的所有参数。使用配置文件初始化不会加载与模型关联的权重，只加载配置。查看 from_pretrained() 方法来加载模型权重。
EsmForProteinFolding 是原始 ESMFold 模型的 HuggingFace 端口。它包含一个 ESM-2“茎”和一个蛋白质折叠“头”，尽管与大多数其他输出头不同，这个“头”的大小和运行时间与模型的其余部分相当！它输出一个字典，其中包含对输入蛋白质的预测结构信息。
该模型继承自 PreTrainedModel。查看超类文档以了解库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入的大小、剪枝头部等）。
该模型也是一个 PyTorch torch.nn.Module 子类。将其用作普通的 PyTorch 模块，并参考 PyTorch 文档以了解有关一般用法和行为的所有事项。
forward
< 源代码 >( input_ids: 张量 attention_mask: 可选 = 无 position_ids: 可选 = 无 masking_pattern: 可选 = 无 num_recycles: 可选 = 无 ) → transformers.models.esm.modeling_esmfold.EsmForProteinFoldingOutput 或 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 表示掩码的标记。
- position_ids (
torch.LongTensor形状为(batch_size, sequence_length)，可选) — 位置嵌入中每个输入序列标记的位置索引。选择范围为[0, config.max_position_embeddings - 1]。 - masking_pattern (
torch.LongTensor形状为(batch_size, sequence_length)，可选) — 训练期间作为正则化形式掩码的标记位置。掩码值选择在[0, 1]中。 - num_recycles (
int，可选，默认为None) — 循环输入序列的次数。如果为None，则默认为config.num_recycles。 “循环”包括将折叠主干的输出作为输入传递回主干。在训练期间，循环次数应在每个批次中有所不同，以确保模型学习在每次循环后输出有效预测。在推断期间，num_recycles 应设置为模型训练的最高值，以获得最大准确率。因此，当此值设置为None时，将使用 config.max_recycles。
返回
transformers.models.esm.modeling_esmfold.EsmForProteinFoldingOutput 或 tuple(torch.FloatTensor)
一个 transformers.models.esm.modeling_esmfold.EsmForProteinFoldingOutput 或 torch.FloatTensor 的元组（如果传递了 return_dict=False 或 config.return_dict=False），包括取决于配置（<class 'transformers.models.esm.configuration_esm.EsmConfig'>）和输入的各种元素。
- frames (
torch.FloatTensor) — 输出帧。 - sidechain_frames (
torch.FloatTensor) — 输出侧链帧。 - unnormalized_angles (
torch.FloatTensor) — 预测的未归一化主干和侧链扭转角。 - angles (
torch.FloatTensor) — 预测的主干和侧链扭转角。 - positions (
torch.FloatTensor) — 预测的主干和侧链原子的位置。 - states (
torch.FloatTensor) — 来自蛋白质折叠主干的隐藏状态。 - s_s (
torch.FloatTensor) — 通过连接 ESM-2 LM 茎的每一层的隐藏状态而得出的每残基嵌入。 - s_z (
torch.FloatTensor) — 成对残基嵌入。 - distogram_logits (
torch.FloatTensor) — 用于计算残基距离的 distogram 的输入 logits。 - lm_logits (
torch.FloatTensor) — ESM-2 蛋白质语言模型茎输出的 logits。 - aatype (
torch.FloatTensor) — 输入氨基酸（AlphaFold2 索引）。 - atom14_atom_exists (
torch.FloatTensor) — 每个原子是否存在于 atom14 表示中。 - residx_atom14_to_atom37 (
torch.FloatTensor) — atom14 和 atom37 表示中的原子之间的映射。 - residx_atom37_to_atom14 (
torch.FloatTensor) — atom37 和 atom14 表示中的原子之间的映射。 - atom37_atom_exists (
torch.FloatTensor) — 每个原子是否存在于 atom37 表示中。 - residue_index (
torch.FloatTensor) — 蛋白质链中每个残基的索引。除非使用内部填充标记，否则这将只是从 0 到sequence_length的整数序列。 - lddt_head (
torch.FloatTensor) — 用于计算 plddt 的 lddt 头的原始输出。 - plddt (
torch.FloatTensor) — 每个残基的置信度分数。置信度低的区域可能表明模型的预测不确定，或者蛋白质结构无序。 - ptm_logits (
torch.FloatTensor) — 用于计算 ptm 的原始 logits。 - ptm (
torch.FloatTensor) — 代表模型对整体结构的高级置信度的 TM-score 输出。 - aligned_confidence_probs (
torch.FloatTensor) — 对齐结构的每个残基的置信度分数。 - predicted_aligned_error (
torch.FloatTensor) — 模型的预测与真实值之间的预测误差。 - max_predicted_aligned_error (
torch.FloatTensor) — 每个样本的最大预测误差。
EsmForProteinFolding 正向方法，覆盖 __call__ 特殊方法。
虽然正向传递的配方需要在此函数中定义，但应该在之后调用 Module 实例，而不是这个，因为前者负责运行预处理和后处理步骤，而后者则会静默地忽略它们。
示例
>>> from transformers import AutoTokenizer, EsmForProteinFolding
>>> model = EsmForProteinFolding.from_pretrained("facebook/esmfold_v1")
>>> tokenizer = AutoTokenizer.from_pretrained("facebook/esmfold_v1")
>>> inputs = tokenizer(["MLKNVQVQLV"], return_tensors="pt", add_special_tokens=False) # A tiny random peptide
>>> outputs = model(**inputs)
>>> folded_positions = outputs.positionsTFEsmModel
class transformers.TFEsmModel
< 源代码 >( config: EsmConfig add_pooling_layer = True *inputs **kwargs )
参数
- config (EsmConfig) — 模型配置类，包含模型的所有参数。使用配置文件初始化不会加载与模型关联的权重，只会加载配置。查看 from_pretrained() 方法来加载模型权重。
ESM 模型的裸transformer，输出原始的隐藏状态，没有任何特定的头部。
此模型继承自 TFPreTrainedModel。查看超类文档以了解库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、修剪头等）。
此模型也是 Keras Model 子类。将其用作常规 Keras 模型，并参考 TF/Keras 文档以了解所有与一般使用和行为相关的事项。
调用
< 源代码 >( input_ids: TFModelInputType | None = None attention_mask: np.ndarray | tf.Tensor | None = None position_ids: np.ndarray | tf.Tensor | None = None head_mask: np.ndarray | tf.Tensor | None = None inputs_embeds: np.ndarray | tf.Tensor | None = None encoder_hidden_states: np.ndarray | tf.Tensor | None = None encoder_attention_mask: np.ndarray | tf.Tensor | None = None past_key_values: Optional[Tuple[Tuple[Union[np.ndarray, tf.Tensor]]]] = None use_cache: Optional[bool] = None output_attentions: Optional[bool] = None output_hidden_states: Optional[bool] = None return_dict: Optional[bool] = None training: Optional[bool] = False ) → transformers.modeling_tf_outputs.TFBaseModelOutputWithPoolingAndCrossAttentions or tuple(tf.Tensor)
参数
- input_ids (
tf.Tensor形状为(batch_size, sequence_length)) — 输入序列词元在词汇表中的索引。可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
tf.Tensor形状为(batch_size, sequence_length)，可选) — 掩码，用于避免在填充词元索引上执行注意力。在[0, 1]中选择掩码值：- 1 表示未掩码的词元，
- 0 表示掩码的词元。
- position_ids (
tf.Tensor形状为(batch_size, sequence_length)，可选) — 输入序列词元在位置嵌入中的位置索引。在[0, config.max_position_embeddings - 1]范围内选择。 - head_mask (
tf.Tensor形状为(num_heads,)或(num_layers, num_heads)，可选) — 掩码，用于使自注意力模块的选定头无效。在[0, 1]中选择掩码值：- 1 表示未掩码的头，
- 0 表示掩码的头。
- inputs_embeds (
tf.Tensor形状为(batch_size, sequence_length, hidden_size)，可选) — 可选地，您可以选择直接传递嵌入表示，而不是传递input_ids。如果您想对如何将input_ids索引转换为相关的向量有更多控制，而不是模型的内部嵌入查找矩阵，这将非常有用。 - output_attentions (
bool，可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参见返回张量中的attentions。 - output_hidden_states (
bool，可选) — 是否返回所有层的隐藏状态。有关更多详细信息，请参见返回张量中的hidden_states。 - return_dict (
bool，可选) — 是否返回一个 ModelOutput 而不是一个简单的元组。 - encoder_hidden_states (
tf.Tensor形状为(batch_size, sequence_length, hidden_size)，可选) — 编码器最后一层输出的隐藏状态序列。如果模型被配置为解码器，则在交叉注意力中使用。 - encoder_attention_mask (
tf.Tensor形状为(batch_size, sequence_length)，可选) — 掩码以避免对编码器输入的填充令牌索引执行注意力。如果模型被配置为解码器，则此掩码在交叉注意力中使用。掩码值选择在[0, 1]中：- 1 表示未屏蔽的令牌
- 0 表示屏蔽的令牌
- past_key_values (
Tuple[Tuple[tf.Tensor]]长度为config.n_layers) — 包含注意力块的预计算键和值隐藏状态。可用于加速解码。如果使用past_key_values，用户可以选择性地仅输入最后decoder_input_ids（那些没有将它们的过去键值状态提供给此模型的）形状为(batch_size, 1)，而不是所有decoder_input_ids形状为(batch_size, sequence_length)。 - use_cache (
bool，可选，默认为True) — 如果设置为True，则返回past_key_values键值状态，可用于加速解码（见past_key_values）。在训练期间设置为False，在生成期间设置为True
返回
transformers.modeling_tf_outputs.TFBaseModelOutputWithPoolingAndCrossAttentions 或 tuple(tf.Tensor)
一个 transformers.modeling_tf_outputs.TFBaseModelOutputWithPoolingAndCrossAttentions 或一个 tf.Tensor 的元组（如果传递了 return_dict=False 或当 config.return_dict=False 时），包括根据配置 (EsmConfig) 和输入的不同元素。
-
last_hidden_state (
tf.Tensor形状为(batch_size, sequence_length, hidden_size)) — 模型最后一层输出的隐藏状态序列。 -
pooler_output (
tf.Tensor形状为(batch_size, hidden_size)) — 序列第一个令牌（分类令牌）的最后一层隐藏状态，经过线性层和 Tanh 激活函数进一步处理。线性层权重是在预训练期间从下一个句子预测（分类）目标中训练出来的。此输出通常不是输入语义内容的良好总结，您通常最好对整个输入序列的隐藏状态序列进行平均或池化。
-
past_key_values (
List[tf.Tensor]，可选，在传递use_cache=True或config.use_cache=True时返回) — 长度为config.n_layers的tf.Tensor列表，每个张量形状为(2, batch_size, num_heads, sequence_length, embed_size_per_head)。包含预计算的隐藏状态（注意力块中的键和值），可用于（见
past_key_values输入）加速顺序解码。 -
hidden_states (
tuple(tf.Tensor)，可选，在传递output_hidden_states=True或config.output_hidden_states=True时返回) —tf.Tensor的元组（一个用于嵌入的输出，一个用于每一层的输出），形状为(batch_size, sequence_length, hidden_size)。模型在每一层输出的隐藏状态，以及初始嵌入输出。
-
attentions (
tuple(tf.Tensor)，可选，在传递output_attentions=True或config.output_attentions=True时返回) —tf.Tensor的元组（每一层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 之后的注意力权重，用于计算自注意力头中的加权平均值。
-
cross_attentions (
tuple(tf.Tensor)，可选，在传递output_attentions=True或config.output_attentions=True时返回) —tf.Tensor的元组（每一层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。解码器交叉注意力层的注意力权重，在注意力 softmax 之后，用于计算交叉注意力头中的加权平均值。
TFEsmModel 正向方法，覆盖 __call__ 特殊方法。
虽然正向传递的配方需要在此函数中定义，但应该在之后调用 Module 实例，而不是这个，因为前者负责运行预处理和后处理步骤，而后者则会静默地忽略它们。
示例
>>> from transformers import AutoTokenizer, TFEsmModel
>>> import tensorflow as tf
>>> tokenizer = AutoTokenizer.from_pretrained("facebook/esm2_t6_8M_UR50D")
>>> model = TFEsmModel.from_pretrained("facebook/esm2_t6_8M_UR50D")
>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="tf")
>>> outputs = model(inputs)
>>> last_hidden_states = outputs.last_hidden_stateTFEsmForMaskedLM
class transformers.TFEsmForMaskedLM
< 源代码 >( config )
参数
- config (EsmConfig) — 模型配置类，包含模型的所有参数。使用配置文件初始化不会加载与模型相关的权重，只会加载配置。查看 from_pretrained() 方法以加载模型权重。
带有 语言建模 头的 ESM 模型。
此模型继承自 TFPreTrainedModel。查看超类文档以了解库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、修剪头等）。
此模型也是 Keras Model 子类。将其用作常规 Keras 模型，并参考 TF/Keras 文档以了解所有与一般使用和行为相关的事项。
调用
< 源代码 >( input_ids: TFModelInputType | None = None attention_mask: np.ndarray | tf.Tensor | None = None position_ids: np.ndarray | tf.Tensor | None = None head_mask: np.ndarray | tf.Tensor | None = None inputs_embeds: np.ndarray | tf.Tensor | None = None encoder_hidden_states: np.ndarray | tf.Tensor | None = None encoder_attention_mask: np.ndarray | tf.Tensor | None = None labels: np.ndarray | tf.Tensor | None = None output_attentions: Optional[bool] = None output_hidden_states: Optional[bool] = None return_dict: Optional[bool] = None training: bool = False ) → transformers.modeling_tf_outputs.TFMaskedLMOutput 或者 tuple(tf.Tensor)
参数
- input_ids (
tf.Tensor形状为(batch_size, sequence_length)) — 输入序列标记在词汇表中的索引。可以使用 AutoTokenizer 获取索引。查看 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call() 以了解详细信息。
- attention_mask (
tf.Tensor形状为(batch_size, sequence_length), 可选) — 掩码用于避免对填充标记索引执行注意力。掩码值选择在[0, 1]中:- 1 表示标记未被掩盖，
- 0 表示标记被掩盖。
- position_ids (
tf.Tensor形状为(batch_size, sequence_length), 可选) — 位置嵌入中每个输入序列标记的位置索引。选择范围[0, config.max_position_embeddings - 1]中的索引。 - head_mask (
tf.Tensor形状为(num_heads,)或(num_layers, num_heads), 可选) — 掩码用于使自注意力模块的选定头部失效。掩码值选择在[0, 1]中:- 1 表示头部未被掩盖，
- 0 表示头部被掩盖。
- inputs_embeds (
tf.Tensor形状为(batch_size, sequence_length, hidden_size)，可选) — 可选地，您可选择直接传入嵌入式表示而不是input_ids。如果您希望对如何将input_ids索引转换为关联向量有更多控制权，这将非常有用，而不仅仅是使用模型的内部嵌入查找矩阵。 - output_attentions (
bool，可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参见返回张量中的attentions。 - output_hidden_states (
bool，可选) — 是否返回所有层的隐藏状态。有关更多详细信息，请参见返回张量中的hidden_states。 - return_dict (
bool，可选) — 是否返回一个 ModelOutput 而不是一个简单的元组。 - labels (
tf.Tensor形状为(batch_size, sequence_length)，可选) — 用于计算掩码语言建模损失的标签。索引应在[-100, 0, ..., config.vocab_size]中（参见input_ids文档字符串）索引设置为-100的标记将被忽略（掩码），损失仅针对标签在[0, ..., config.vocab_size]中的标记进行计算。 - kwargs (
Dict[str, any]，可选，默认值为{}) — 用于隐藏已弃用的旧参数。
返回
transformers.modeling_tf_outputs.TFMaskedLMOutput 或 tuple(tf.Tensor)
一个 transformers.modeling_tf_outputs.TFMaskedLMOutput 或 tf.Tensor 的元组（如果传递了 return_dict=False 或当 config.return_dict=False 时），包含取决于配置 (EsmConfig) 和输入的各种元素。
-
loss (
tf.Tensor形状为(n,)，可选，其中 n 是非掩码标签的数量，在提供labels时返回) — 掩码语言建模 (MLM) 损失。 -
logits (
tf.Tensor形状为(batch_size, sequence_length, config.vocab_size)) — 语言建模头的预测分数（SoftMax 之前的每个词汇标记的分数）。 -
hidden_states (
tuple(tf.Tensor)，可选，在传递output_hidden_states=True或config.output_hidden_states=True时返回) —tf.Tensor的元组（一个用于嵌入的输出，一个用于每一层的输出），形状为(batch_size, sequence_length, hidden_size)。模型在每一层输出的隐藏状态，以及初始嵌入输出。
-
attentions (
tuple(tf.Tensor)，可选，在传递output_attentions=True或config.output_attentions=True时返回) —tf.Tensor的元组（每一层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 之后的注意力权重，用于计算自注意力头中的加权平均值。
该 TFEsmForMaskedLM 前向方法覆盖了 __call__ 特殊方法。
虽然正向传递的配方需要在此函数中定义，但应该在之后调用 Module 实例，而不是这个，因为前者负责运行预处理和后处理步骤，而后者则会静默地忽略它们。
示例
>>> from transformers import AutoTokenizer, TFEsmForMaskedLM
>>> import tensorflow as tf
>>> tokenizer = AutoTokenizer.from_pretrained("facebook/esm2_t6_8M_UR50D")
>>> model = TFEsmForMaskedLM.from_pretrained("facebook/esm2_t6_8M_UR50D")
>>> inputs = tokenizer("The capital of France is <mask>.", return_tensors="tf")
>>> logits = model(**inputs).logits
>>> # retrieve index of <mask>
>>> mask_token_index = tf.where((inputs.input_ids == tokenizer.mask_token_id)[0])
>>> selected_logits = tf.gather_nd(logits[0], indices=mask_token_index)
>>> predicted_token_id = tf.math.argmax(selected_logits, axis=-1)TFEsmForSequenceClassification
class transformers.TFEsmForSequenceClassification
< source >( config )
参数
- config (EsmConfig) — 模型配置类，包含模型的所有参数。使用配置文件进行初始化不会加载与模型关联的权重，而只会加载配置。查看 from_pretrained() 方法以加载模型权重。
具有序列分类/回归头的 ESM 模型转换器（在池化输出之上有一个线性层），例如用于 GLUE 任务。
此模型继承自 TFPreTrainedModel。查看超类文档以了解库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、修剪头等）。
此模型也是 Keras Model 子类。将其用作常规 Keras 模型，并参考 TF/Keras 文档以了解所有与一般使用和行为相关的事项。
调用
< 源代码 >( input_ids: TFModelInputType | None = None attention_mask: np.ndarray | tf.Tensor | None = None position_ids: np.ndarray | tf.Tensor | None = None head_mask: np.ndarray | tf.Tensor | None = None inputs_embeds: np.ndarray | tf.Tensor | None = None labels: np.ndarray | tf.Tensor | None = None output_attentions: Optional[bool] = None output_hidden_states: Optional[bool] = None return_dict: Optional[bool] = None training: bool = False ) → transformers.modeling_tf_outputs.TFSequenceClassifierOutput or tuple(tf.Tensor)
参数
- input_ids (
tf.Tensor形状为(batch_size, sequence_length)) — 输入序列标记在词表的索引。索引可以通过 AutoTokenizer 获取。请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call() 获取详细信息。
- attention_mask (
tf.Tensor形状为(batch_size, sequence_length), 可选) — 掩码，用于避免对填充标记索引执行注意力。掩码值在[0, 1]中选择：- 1 表示标记 **未被掩码**，
- 0 表示标记 **被掩码**。
- position_ids (
tf.Tensor形状为(batch_size, sequence_length), 可选) — 输入序列标记在位置嵌入中的位置索引。在[0, config.max_position_embeddings - 1]范围内选择。 - head_mask (
tf.Tensor形状为(num_heads,)或(num_layers, num_heads), 可选) — 掩码，用于使自注意力模块中选定的头无效。掩码值在[0, 1]中选择：- 1 表示头 **未被掩码**，
- 0 表示头 **被掩码**。
- inputs_embeds (
tf.Tensor形状为(batch_size, sequence_length, hidden_size), 可选) — 可选地，您可以选择直接传递嵌入式表示，而不是传递input_ids。如果您想比模型的内部嵌入查找矩阵更好地控制如何将input_ids索引转换为相关的向量，这将非常有用。 - output_attentions (
bool, 可选) — 是否返回所有注意力层的注意力张量。有关详细信息，请参阅返回张量中的attentions。 - output_hidden_states (
bool, 可选) — 是否返回所有层的隐藏状态。有关详细信息，请参阅返回张量中的hidden_states。
返回
transformers.modeling_tf_outputs.TFSequenceClassifierOutput 或 tuple(tf.Tensor)
一个 transformers.modeling_tf_outputs.TFSequenceClassifierOutput 或一个 tf.Tensor 元组（如果传递了 return_dict=False 或当 config.return_dict=False 时），包含根据配置 (EsmConfig) 和输入而变化的各种元素。
-
loss (
tf.Tensor形状为(batch_size, )，可选，在提供labels时返回) — 分类（或回归，如果 config.num_labels==1）损失。 -
logits (
tf.Tensor形状为(batch_size, config.num_labels)) — 分类（或回归，如果 config.num_labels==1）分数（在 SoftMax 之前）。 -
hidden_states (
tuple(tf.Tensor)，可选，在传递output_hidden_states=True或config.output_hidden_states=True时返回) —tf.Tensor的元组（一个用于嵌入的输出，一个用于每一层的输出），形状为(batch_size, sequence_length, hidden_size)。模型在每一层输出的隐藏状态，以及初始嵌入输出。
-
attentions (
tuple(tf.Tensor)，可选，在传递output_attentions=True或config.output_attentions=True时返回) —tf.Tensor的元组（每一层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 之后的注意力权重，用于计算自注意力头中的加权平均值。
The TFEsmForSequenceClassification 前向方法覆盖了 __call__ 特殊方法。
虽然正向传递的配方需要在此函数中定义，但应该在之后调用 Module 实例，而不是这个，因为前者负责运行预处理和后处理步骤，而后者则会静默地忽略它们。
示例
>>> from transformers import AutoTokenizer, TFEsmForSequenceClassification
>>> import tensorflow as tf
>>> tokenizer = AutoTokenizer.from_pretrained("facebook/esm2_t6_8M_UR50D")
>>> model = TFEsmForSequenceClassification.from_pretrained("facebook/esm2_t6_8M_UR50D")
>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="tf")
>>> logits = model(**inputs).logits
>>> predicted_class_id = int(tf.math.argmax(logits, axis=-1)[0])>>> # 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 = TFEsmForSequenceClassification.from_pretrained("facebook/esm2_t6_8M_UR50D", num_labels=num_labels)
>>> labels = tf.constant(1)
>>> loss = model(**inputs, labels=labels).lossTFEsmForTokenClassification
class transformers.TFEsmForTokenClassification
< source >( config )
参数
- config (EsmConfig) — 模型配置类，包含模型的所有参数。使用配置文件初始化不会加载与模型相关的权重，只会加载配置。查看 from_pretrained() 方法以加载模型权重。
在 ESM 模型之上添加令牌分类头（隐藏状态输出之上的线性层），例如用于命名实体识别（NER）任务。
此模型继承自 TFPreTrainedModel。查看超类文档以了解库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、修剪头等）。
此模型也是 Keras Model 子类。将其用作常规 Keras 模型，并参考 TF/Keras 文档以了解所有与一般使用和行为相关的事项。
调用
< source >( input_ids: TFModelInputType | None = None attention_mask: np.ndarray | tf.Tensor | None = None position_ids: np.ndarray | tf.Tensor | None = None head_mask: np.ndarray | tf.Tensor | None = None inputs_embeds: np.ndarray | tf.Tensor | None = None labels: np.ndarray | tf.Tensor | None = None output_attentions: Optional[bool] = None output_hidden_states: Optional[bool] = None return_dict: Optional[bool] = None training: bool = False ) → transformers.modeling_tf_outputs.TFTokenClassifierOutput 或 tuple(tf.Tensor)
参数
- input_ids (
tf.Tensor形状为(batch_size, sequence_length)) — 输入序列标记在词汇表中的索引。索引可以使用 AutoTokenizer 获取。查看 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call() 获取详细信息。
- attention_mask (
tf.Tensor形状为(batch_size, sequence_length)，可选) — 掩码，用于避免对填充标记索引执行注意力。在[0, 1]中选择掩码值：- 1 代表未被掩码的标记，
- 0 代表被掩码的标记。
- position_ids (
tf.Tensor形状为(batch_size, sequence_length), 可选) — 位置嵌入中每个输入序列标记的位置索引。选择范围为[0, config.max_position_embeddings - 1]。 - head_mask (
tf.Tensor形状为(num_heads,)或(num_layers, num_heads), 可选) — 用于使自注意力模块中选定头部无效的掩码。掩码值选择范围为[0, 1]:- 1 表示头部未被掩码,
- 0 表示头部被掩码。
- inputs_embeds (
tf.Tensor形状为(batch_size, sequence_length, hidden_size), 可选) — 可选地，您可以选择直接传递嵌入表示，而不是传递input_ids。如果您希望对如何将input_ids索引转换为相关向量进行比模型内部嵌入查找矩阵更多的控制，这将很有用。 - output_attentions (
bool, 可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参阅返回张量中的attentions。 - output_hidden_states (
bool, 可选) — 是否返回所有层的隐藏状态。有关更多详细信息，请参阅返回张量中的hidden_states。 - return_dict (
bool, 可选) — 是否返回一个 ModelOutput 而不是一个普通元组。 - labels (
tf.Tensor形状为(batch_size, sequence_length), 可选) — 用于计算标记分类损失的标签。索引应在[0, ..., config.num_labels - 1]范围内。
返回
transformers.modeling_tf_outputs.TFTokenClassifierOutput 或 tuple(tf.Tensor)
一个 transformers.modeling_tf_outputs.TFTokenClassifierOutput 或一个 tf.Tensor 元组（如果传递了 return_dict=False 或当 config.return_dict=False 时），包含根据配置 (EsmConfig) 和输入的不同元素。
-
loss (
tf.Tensor形状为(n,), 可选，其中 n 是未屏蔽标签的数量，在提供labels时返回) — 分类损失。 -
logits (
tf.Tensor形状为(batch_size, sequence_length, config.num_labels)) — 分类分数（在 SoftMax 之前）。 -
hidden_states (
tuple(tf.Tensor)，可选，在传递output_hidden_states=True或config.output_hidden_states=True时返回) —tf.Tensor的元组（一个用于嵌入的输出，一个用于每一层的输出），形状为(batch_size, sequence_length, hidden_size)。模型在每一层输出的隐藏状态，以及初始嵌入输出。
-
attentions (
tuple(tf.Tensor)，可选，在传递output_attentions=True或config.output_attentions=True时返回) —tf.Tensor的元组（每一层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 之后的注意力权重，用于计算自注意力头中的加权平均值。
The TFEsmForTokenClassification forward method, overrides the __call__ special method.
虽然正向传递的配方需要在此函数中定义，但应该在之后调用 Module 实例，而不是这个，因为前者负责运行预处理和后处理步骤，而后者则会静默地忽略它们。
示例
>>> from transformers import AutoTokenizer, TFEsmForTokenClassification
>>> import tensorflow as tf
>>> tokenizer = AutoTokenizer.from_pretrained("facebook/esm2_t6_8M_UR50D")
>>> model = TFEsmForTokenClassification.from_pretrained("facebook/esm2_t6_8M_UR50D")
>>> inputs = tokenizer(
... "HuggingFace is a company based in Paris and New York", add_special_tokens=False, return_tensors="tf"
... )
>>> logits = model(**inputs).logits
>>> predicted_token_class_ids = tf.math.argmax(logits, axis=-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] for t in predicted_token_class_ids[0].numpy().tolist()]