Hugging Face 的 LOGO

Transformers 文档

BLOOM

Hugging Face's logo
加入 Hugging Face 社区

并获得增强的文档体验

开始使用

BLOOM

PyTorch Flax

概述

BLOOM 模型及其各种版本是通过 BigScience 工作坊 提出的。BigScience 的灵感来源于其他开放科学倡议，在这些倡议中，研究人员汇集他们的时间和资源，共同实现更大的影响力。BLOOM 的架构本质上与 GPT3 类似（用于下一个词元预测的自回归模型），但在 46 种不同语言和 13 种编程语言上进行了训练。该模型的几个较小版本也在同一数据集上进行了训练。BLOOM 提供以下版本：

资源

Hugging Face 官方和社区（由 🌎 标识）提供的资源列表，帮助您开始使用 BLOOM。如果您有兴趣提交资源以包含在此处，请随时发起拉取请求，我们将对其进行审核！资源最好能展示一些新内容，而不是重复现有资源。

文本生成

另请参阅

⚡️ 推理

⚙️ 训练

BloomConfig

class transformers.BloomConfig

< >

( vocab_size = 250880 hidden_size = 64 n_layer = 2 n_head = 8 layer_norm_epsilon = 1e-05 initializer_range = 0.02 use_cache = True bos_token_id = 1 eos_token_id = 2 apply_residual_connection_post_layernorm = False hidden_dropout = 0.0 attention_dropout = 0.0 pretraining_tp = 1 slow_but_exact = False **kwargs )

参数

  • vocab_size (int, 可选, 默认为 250880) — Bloom 模型的词汇表大小。定义了调用 BloomModel 时传入的 inputs_ids 所能表示的最大不同词元数量。请查看此讨论了解 vocab_size 是如何定义的。
  • hidden_size (int, 可选, 默认为 64) — 嵌入层和隐藏层的维度。
  • n_layer (int, 可选, 默认为 2) — Transformer 编码器中的隐藏层数。
  • n_head (int, 可选, 默认为 8) — Transformer 编码器中每个注意力层的注意力头数。
  • layer_norm_epsilon (float, 可选, 默认为 1e-5) — 层归一化层中使用的 epsilon。
  • initializer_range (float, 可选, 默认为 0.02) — 用于初始化所有权重矩阵的 truncated_normal_initializer 的标准差。
  • apply_residual_connection_post_layernorm (bool, 可选, 默认为 False) — 如果启用，则在 Transformer 模块中使用隐藏状态的层归一化作为残差。
  • hidden_dropout (float, 可选, 默认为 0.1) — 偏置丢弃函数中的丢弃率。
  • attention_dropout (float, 可选, 默认为 0.1) — 应用于注意力概率的丢弃率。
  • use_cache (bool, 可选, 默认为 True) — 模型是否应返回最后一个键/值注意力（并非所有模型都使用）。
  • pretraining_tp (int, 可选, 默认为 1) — 实验性功能。使用 Megatron 进行预训练时使用的张量并行等级。请参阅此文档以了解更多信息。此值对于确保预训练结果的精确可复现性是必要的。请参阅此问题。请注意，此功能仅在 slow_but_exact=True 时启用。
  • slow_but_exact (bool, 可选, 默认为 False) — 实验性功能。是否使用缓慢但精确的注意力机制实现。在合并张量并行（TP）等级张量时，由于切片操作，在 Megatron 上训练的模型与我们的模型之间的结果可能略有不同。请参阅此问题。获取更准确结果的一种解决方案是启用此功能。启用此功能会影响推理的计算时间。未来一旦主模型使用 TP_rank=1 进行微调，此问题可能会得到解决。

这是用于存储 BloomModel 配置的配置类。它用于根据指定的参数实例化一个 Bloom 模型，定义模型架构。使用默认值实例化配置将产生与 Bloom 架构 bigscience/bloom 相似的配置。

配置对象继承自 PretrainedConfig，可用于控制模型输出。有关更多信息，请阅读 PretrainedConfig 的文档。

示例

>>> from transformers import BloomConfig, BloomModel

>>> # Initializing a Bloom configuration
>>> configuration = BloomConfig()

>>> # Initializing a model (with random weights) from the configuration
>>> model = BloomModel(configuration)

>>> # Accessing the model configuration
>>> configuration = model.config

BloomTokenizerFast

class transformers.BloomTokenizerFast

< >

( vocab_file = None merges_file = None tokenizer_file = None unk_token = '<unk>' bos_token = '<s>' eos_token = '</s>' pad_token = '<pad>' add_prefix_space = False clean_up_tokenization_spaces = False **kwargs )

参数

  • vocab_file (str) — 词汇表文件的路径。
  • merges_file (str) — 合并文件的路径。
  • errors (str, 可选, 默认为 "replace") — 解码字节到 UTF-8 时遵循的范式。有关更多信息，请参阅 bytes.decode。
  • unk_token (str, 可选, 默认为 <|endoftext|>) — 未知词元。不在词汇表中的词元无法转换为 ID，将被设置为此词元。
  • bos_token (str, 可选, 默认为 <|endoftext|>) — 序列开始词元。
  • eos_token (str, 可选, 默认为 <|endoftext|>) — 序列结束词元。
  • add_prefix_space (bool, 可选, 默认为 False) — 是否在输入前添加一个初始空格。这允许将开头的单词与其他任何单词同等对待。（Bloom 分词器通过前面的空格检测单词的开头）。
  • trim_offsets (bool, 可选, 默认为 True) — 后处理步骤是否应修剪偏移量以避免包含空格。

构建一个“快速”的 Bloom 分词器（由 HuggingFace 的 tokenizers 库支持）。基于字节级的字节对编码（Byte-Pair-Encoding）。

这个分词器经过训练，将空格视为词元的一部分（有点像 sentencepiece），所以一个词会

无论是否在句子开头（无空格），编码方式都会不同

>>> from transformers import BloomTokenizerFast

>>> tokenizer = BloomTokenizerFast.from_pretrained("bigscience/bloom")
>>> tokenizer("Hello world")["input_ids"]
[59414, 8876]

>>> tokenizer(" Hello world")["input_ids"]
[86153, 8876]

您可以通过在实例化此分词器时传递 add_prefix_space=True 来绕过此行为，但由于模型并非以此方式进行预训练，这可能会导致性能下降。

当与 is_split_into_words=True 一起使用时，此分词器需要以 add_prefix_space=True 进行实例化。

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

Pytorch
隐藏 Pytorch 内容

BloomModel

class transformers.BloomModel

< >

( config: BloomConfig )

参数

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

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

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

此模型也是 PyTorch 的 torch.nn.Module 子类。可以像常规的 PyTorch 模块一样使用它，并参考 PyTorch 文档了解所有与通用用法和行为相关的事项。

forward

< >

( input_ids: typing.Optional[torch.LongTensor] = None past_key_values: typing.Union[transformers.cache_utils.Cache, tuple[tuple[torch.Tensor, torch.Tensor], ...], NoneType] = None attention_mask: typing.Optional[torch.Tensor] = None head_mask: typing.Optional[torch.LongTensor] = None inputs_embeds: typing.Optional[torch.LongTensor] = None use_cache: typing.Optional[bool] = 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.LongTensor] = None **deprecated_arguments ) → transformers.modeling_outputs.BaseModelOutputWithPastAndCrossAttentions 或 tuple(torch.FloatTensor)

参数

  • input_ids (torch.LongTensor，形状为 (batch_size, input_ids_length)) — input_ids_length = sequence_length，如果 past_key_values 为 None，否则为 past_key_values[0][0].shape[2]（输入过去键值状态的 sequence_length）。词汇表中输入序列词元的索引。

    如果使用了 past_key_values，则只应将那些尚未计算其过去值的 input_ids 作为 input_ids 传入。

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

    什么是 input IDs？

  • past_key_values (Union[~cache_utils.Cache, tuple[tuple[torch.Tensor, torch.Tensor], ...], NoneType]) — 预先计算的隐藏状态（自注意力块和交叉注意力块中的键和值），可用于加速顺序解码。这通常包括模型在解码的先前阶段返回的 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。

  • attention_mask (torch.Tensor，形状为 (batch_size, sequence_length)，可选) — 用于避免对填充词元索引执行注意力的掩码。掩码值选自 [0, 1]：

    • 1 表示词元未被掩码，
    • 0 表示词元被掩码。

    什么是 attention mask？

  • head_mask (torch.LongTensor，形状为 (num_heads,) 或 (num_layers, num_heads)，可选) — 用于使自注意力模块中选定的注意力头无效的掩码。掩码值选自 [0, 1]：

    • 1 表示注意力头未被掩码，
    • 0 表示注意力头被掩码。
  • inputs_embeds (torch.LongTensor，形状为 (batch_size, sequence_length, hidden_size)，可选) — 可选地，您可以选择直接传递嵌入表示而不是 input_ids。如果您想比模型的内部嵌入查找矩阵更多地控制如何将 input_ids 索引转换为关联向量，这将非常有用。
  • use_cache (bool，可选) — 如果设置为 True，将返回 past_key_values 键值状态，可用于加速解码（请参阅 past_key_values）。
  • output_attentions (bool，可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参阅返回张量下的 attentions。
  • output_hidden_states (bool，可选) — 是否返回所有层的隐藏状态。有关更多详细信息，请参阅返回张量下的 hidden_states。
  • return_dict (bool，可选) — 是否返回一个 ModelOutput 而不是一个普通的元组。
  • cache_position (torch.LongTensor，形状为 (sequence_length)，可选) — 描述输入序列词元在序列中位置的索引。与 position_ids 不同，此张量不受填充影响。它用于在正确的位置更新缓存并推断完整的序列长度。

返回

transformers.modeling_outputs.BaseModelOutputWithPastAndCrossAttentions 或 tuple(torch.FloatTensor)

一个 transformers.modeling_outputs.BaseModelOutputWithPastAndCrossAttentions 或一个 torch.FloatTensor 元组（如果传递了 return_dict=False 或当 config.return_dict=False 时），根据配置（BloomConfig）和输入，包含各种元素。

  • 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 (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 之后，用于计算交叉注意力头中的加权平均。

BloomModel 的 forward 方法，重写了 __call__ 特殊方法。

虽然前向传播的流程需要在此函数中定义，但之后应调用 Module 实例而不是此函数，因为前者会处理前处理和后处理步骤，而后者会静默地忽略它们。

BloomForCausalLM

class transformers.BloomForCausalLM

< >

( config: BloomConfig )

参数

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

带有一个语言建模头部的 Bloom 模型 transformer（一个权重与输入嵌入绑定的线性层）。

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

此模型也是 PyTorch 的 torch.nn.Module 子类。可以像常规的 PyTorch 模块一样使用它，并参考 PyTorch 文档了解所有与通用用法和行为相关的事项。

forward

< >

( input_ids: typing.Optional[torch.LongTensor] = None past_key_values: typing.Union[transformers.cache_utils.Cache, tuple[tuple[torch.Tensor, torch.Tensor], ...], NoneType] = None attention_mask: typing.Optional[torch.Tensor] = None head_mask: typing.Optional[torch.Tensor] = None inputs_embeds: typing.Optional[torch.Tensor] = None labels: typing.Optional[torch.Tensor] = None use_cache: typing.Optional[bool] = 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.LongTensor] = None **deprecated_arguments ) → transformers.modeling_outputs.CausalLMOutputWithCrossAttentions 或 tuple(torch.FloatTensor)

参数

  • input_ids (torch.LongTensor，形状为 (batch_size, input_ids_length)) — input_ids_length = sequence_length，如果 past_key_values 为 None，否则为 past_key_values[0][0].shape[2]（输入过去键值状态的 sequence_length）。词汇表中输入序列词元的索引。

    如果使用了 past_key_values，则只应将那些尚未计算其过去值的 input_ids 作为 input_ids 传入。

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

    什么是 input IDs？

  • past_key_values (Union[~cache_utils.Cache, tuple[tuple[torch.Tensor, torch.Tensor], ...], NoneType]) — 预先计算的隐藏状态（自注意力块和交叉注意力块中的键和值），可用于加速顺序解码。这通常包括模型在解码的先前阶段返回的 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。

  • attention_mask (torch.Tensor，形状为 (batch_size, sequence_length)，可选) — 用于避免对填充词元索引执行注意力的掩码。掩码值选自 [0, 1]：

    • 1 表示词元未被掩码，
    • 0 表示词元被掩码。

    什么是 attention mask？

  • head_mask (torch.Tensor，形状为 (num_heads,) 或 (num_layers, num_heads)，可选) — 用于使自注意力模块中选定的注意力头无效的掩码。掩码值选自 [0, 1]：

    • 1 表示注意力头未被掩码，
    • 0 表示注意力头被掩码。
  • inputs_embeds (torch.Tensor，形状为 (batch_size, sequence_length, hidden_size)，可选) — 可选地，您可以选择直接传递嵌入表示而不是 input_ids。如果您想比模型的内部嵌入查找矩阵更多地控制如何将 input_ids 索引转换为关联向量，这将非常有用。
  • labels (torch.LongTensor，形状为 (batch_size, sequence_length)，可选) — 语言建模的标签。请注意，标签在模型内部被移动，即您可以设置 labels = input_ids。索引选自 [-100, 0, ..., config.vocab_size]。所有设置为 -100 的标签都会被忽略（掩码），损失仅针对 [0, ..., config.vocab_size] 中的标签计算。
  • use_cache (bool，可选) — 如果设置为 True，将返回 past_key_values 键值状态，可用于加速解码（请参阅 past_key_values）。
  • output_attentions (bool，可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参阅返回张量下的 attentions。
  • output_hidden_states (bool，可选) — 是否返回所有层的隐藏状态。有关更多详细信息，请参阅返回张量下的 hidden_states。
  • return_dict (bool，可选) — 是否返回一个 ModelOutput 而不是一个普通的元组。
  • cache_position (torch.LongTensor，形状为 (sequence_length)，可选) — 描述输入序列词元在序列中位置的索引。与 position_ids 不同，此张量不受填充影响。它用于在正确的位置更新缓存并推断完整的序列长度。

返回

transformers.modeling_outputs.CausalLMOutputWithCrossAttentions 或 tuple(torch.FloatTensor)

一个 transformers.modeling_outputs.CausalLMOutputWithCrossAttentions 或一个 torch.FloatTensor 元组（如果传递了 return_dict=False 或当 config.return_dict=False 时），根据配置（BloomConfig）和输入，包含各种元素。

  • loss (torch.FloatTensor 形状为 (1,)，可选，当提供 labels 时返回) — 语言建模损失（用于下一个 token 预测）。

  • logits (形状为 (batch_size, sequence_length, config.vocab_size) 的 torch.FloatTensor) — 语言建模头部的预测分数（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 后的注意力权重，用于计算自注意力头中的加权平均值。

  • cross_attentions (tuple(torch.FloatTensor)，可选，当传递 output_attentions=True 或当 config.output_attentions=True 时返回) — torch.FloatTensor 的元组（每层一个），形状为 (batch_size, num_heads, sequence_length, sequence_length)。

    注意力 softmax 后的交叉注意力权重，用于计算交叉注意力头中的加权平均。

  • past_key_values (Cache，可选，当传递 use_cache=True 或当 config.use_cache=True 时返回) — 这是一个 Cache 实例。更多详情，请参阅我们的 kv cache 指南。

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

BloomForCausalLM 的 forward 方法，重写了 __call__ 特殊方法。

虽然前向传播的流程需要在此函数中定义，但之后应调用 Module 实例而不是此函数，因为前者会处理前处理和后处理步骤，而后者会静默地忽略它们。

示例

BloomForSequenceClassification

class transformers.BloomForSequenceClassification

< >

( config: BloomConfig )

参数

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

带有一个序列分类头部的 Bloom 模型 transformer（一个线性层）。

BloomForSequenceClassification 使用最后一个词元进行分类，与其他因果模型（如 GPT-1）的做法相同。

由于它对最后一个词元进行分类，因此需要知道最后一个词元的位置。如果在配置中定义了 pad_token_id，它会找到每行中不是填充词元的最后一个词元。如果没有定义 pad_token_id，它会简单地取每行批次中的最后一个值。由于当传递 inputs_embeds 而不是 input_ids 时，它无法猜测填充词元，因此它会做同样的操作（取每行批次中的最后一个值）。

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

此模型也是 PyTorch 的 torch.nn.Module 子类。可以像常规的 PyTorch 模块一样使用它，并参考 PyTorch 文档了解所有与通用用法和行为相关的事项。

forward

< >

( input_ids: typing.Optional[torch.LongTensor] = None past_key_values: typing.Union[transformers.cache_utils.Cache, tuple[tuple[torch.Tensor, torch.Tensor], ...], NoneType] = None attention_mask: typing.Optional[torch.Tensor] = None head_mask: typing.Optional[torch.Tensor] = None inputs_embeds: typing.Optional[torch.Tensor] = None labels: typing.Optional[torch.Tensor] = None use_cache: typing.Optional[bool] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None **deprecated_arguments ) → transformers.modeling_outputs.SequenceClassifierOutputWithPast 或 tuple(torch.FloatTensor)

参数

  • input_ids (torch.LongTensor，形状为 (batch_size, input_ids_length)) — input_ids_length = sequence_length，如果 past_key_values 为 None，否则为 past_key_values[0][0].shape[2]（输入过去键值状态的 sequence_length）。词汇表中输入序列词元的索引。

    如果使用了 past_key_values，则只应将那些尚未计算其过去值的 input_ids 作为 input_ids 传入。

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

    什么是 input IDs？

  • past_key_values (Union[~cache_utils.Cache, tuple[tuple[torch.Tensor, torch.Tensor], ...], NoneType]) — 预先计算的隐藏状态（自注意力块和交叉注意力块中的键和值），可用于加速顺序解码。这通常包括模型在解码的先前阶段返回的 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。

  • attention_mask (torch.Tensor，形状为 (batch_size, sequence_length)，可选) — 用于避免对填充词元索引执行注意力的掩码。掩码值选自 [0, 1]：

    • 1 表示词元未被掩码，
    • 0 表示词元被掩码。

    什么是 attention mask？

  • head_mask (torch.Tensor，形状为 (num_heads,) 或 (num_layers, num_heads)，可选) — 用于使自注意力模块中选定的注意力头无效的掩码。掩码值选自 [0, 1]：

    • 1 表示注意力头未被掩码，
    • 0 表示注意力头被掩码。
  • inputs_embeds (torch.Tensor，形状为 (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）。
  • output_attentions (bool，可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参阅返回张量下的 attentions。
  • output_hidden_states (bool，可选) — 是否返回所有层的隐藏状态。有关更多详细信息，请参阅返回张量下的 hidden_states。
  • return_dict (bool, 可选) — 是否返回一个 ModelOutput 而不是一个普通的元组。

返回

transformers.modeling_outputs.SequenceClassifierOutputWithPast 或 tuple(torch.FloatTensor)

一个 transformers.modeling_outputs.SequenceClassifierOutputWithPast 或一个 torch.FloatTensor 元组（如果传入 return_dict=False 或 config.return_dict=False），其包含的各种元素取决于配置（BloomConfig）和输入。

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

BloomForSequenceClassification 的 forward 方法重写了 __call__ 特殊方法。

虽然前向传播的流程需要在此函数中定义，但之后应调用 Module 实例而不是此函数，因为前者会处理前处理和后处理步骤，而后者会静默地忽略它们。

单标签分类示例

>>> import torch
>>> from transformers import AutoTokenizer, BloomForSequenceClassification

>>> tokenizer = AutoTokenizer.from_pretrained("bigscience/bloom")
>>> model = BloomForSequenceClassification.from_pretrained("bigscience/bloom")

>>> 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 = BloomForSequenceClassification.from_pretrained("bigscience/bloom", num_labels=num_labels)

>>> labels = torch.tensor([1])
>>> loss = model(**inputs, labels=labels).loss
>>> round(loss.item(), 2)
...

多标签分类示例

>>> import torch
>>> from transformers import AutoTokenizer, BloomForSequenceClassification

>>> tokenizer = AutoTokenizer.from_pretrained("bigscience/bloom")
>>> model = BloomForSequenceClassification.from_pretrained("bigscience/bloom", 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 = BloomForSequenceClassification.from_pretrained(
...     "bigscience/bloom", 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

BloomForTokenClassification

class transformers.BloomForTokenClassification

< >

( config: BloomConfig )

参数

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

带有一个词元分类头的 Bloom Transformer（在隐藏状态输出之上加一个线性层），例如用于命名实体识别（NER）任务。

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

此模型也是 PyTorch 的 torch.nn.Module 子类。可以像常规的 PyTorch 模块一样使用它，并参考 PyTorch 文档了解所有与通用用法和行为相关的事项。

forward

< >

( input_ids: typing.Optional[torch.LongTensor] = None past_key_values: typing.Union[transformers.cache_utils.Cache, tuple[tuple[torch.Tensor, torch.Tensor], ...], NoneType] = None attention_mask: typing.Optional[torch.Tensor] = None head_mask: typing.Optional[torch.Tensor] = None inputs_embeds: typing.Optional[torch.Tensor] = None labels: typing.Optional[torch.Tensor] = None use_cache: typing.Optional[bool] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None **deprecated_arguments ) → transformers.modeling_outputs.TokenClassifierOutput 或 tuple(torch.FloatTensor)

参数

  • input_ids (形状为 (batch_size, input_ids_length) 的 torch.LongTensor) — input_ids_length = sequence_length（如果 past_key_values 为 None），否则为 past_key_values[0][0].shape[2]（输入过去键值状态的 sequence_length）。词汇表中输入序列词元的索引。

    如果使用了 past_key_values，则只应传递那些尚未计算其过去状态的 input_ids。

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

    什么是输入 ID？

  • past_key_values (Union[~cache_utils.Cache, tuple[tuple[torch.Tensor, torch.Tensor], ...], NoneType]) — 预计算的隐藏状态（自注意力和交叉注意力块中的键和值），可用于加速序列解码。这通常包括模型在解码的先前阶段返回的 past_key_values，当 use_cache=True 或 config.use_cache=True 时。

    允许两种格式：

    • 一个 Cache 实例，请参阅我们的 kv 缓存指南；
    • 长度为 config.n_layers 的 tuple(torch.FloatTensor) 元组，每个元组包含 2 个形状为 (batch_size, num_heads, sequence_length, embed_size_per_head) 的张量。这也称为旧版缓存格式。

    模型将输出与输入相同的缓存格式。如果没有传递 past_key_values，则将返回旧版缓存格式。

    如果使用 past_key_values，用户可以选择只输入最后的 input_ids（那些没有提供其过去键值状态给此模型的 `input_ids`），形状为 (batch_size, 1)，而不是所有形状为 (batch_size, sequence_length) 的 input_ids。

  • attention_mask (形状为 (batch_size, sequence_length) 的 torch.Tensor, 可选) — 用于避免在填充词元索引上执行注意力的掩码。掩码值选自 [0, 1]：

    • 1 表示词元未被掩码，
    • 0 表示词元被掩码。

    什么是注意力掩码？

  • head_mask (形状为 (num_heads,) 或 (num_layers, num_heads) 的 torch.Tensor, 可选) — 用于置零自注意力模块中选定头的掩码。掩码值选自 [0, 1]：

    • 1 表示头未被掩码，
    • 0 表示头被掩码。
  • inputs_embeds (形状为 (batch_size, sequence_length, hidden_size) 的 torch.Tensor, 可选) — 可选地，你可以选择直接传递嵌入表示，而不是传递 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, 可选) — 如果设置为 True，则返回 past_key_values 键值状态，可用于加速解码（参见 past_key_values）。
  • output_attentions (bool, 可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参阅返回张量下的 attentions。
  • output_hidden_states (bool, 可选) — 是否返回所有层的隐藏状态。有关更多详细信息，请参阅返回张量下的 hidden_states。
  • return_dict (bool, 可选) — 是否返回一个 ModelOutput 而不是一个普通的元组。

返回

transformers.modeling_outputs.TokenClassifierOutput 或 tuple(torch.FloatTensor)

一个 transformers.modeling_outputs.TokenClassifierOutput 或一个 torch.FloatTensor 元组（如果传入 return_dict=False 或 config.return_dict=False），其包含的各种元素取决于配置（BloomConfig）和输入。

  • loss (形状为 (1,) 的 torch.FloatTensor，可选，当提供 labels 时返回) — 分类损失。

  • logits (形状为 (batch_size, sequence_length, config.num_labels) 的 torch.FloatTensor) — 分类分数（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 后的注意力权重，用于计算自注意力头中的加权平均值。

BloomForTokenClassification 的 forward 方法重写了 __call__ 特殊方法。

虽然前向传播的流程需要在此函数中定义，但之后应调用 Module 实例而不是此函数，因为前者会处理前处理和后处理步骤，而后者会静默地忽略它们。

示例

>>> from transformers import AutoTokenizer, BloomForTokenClassification
>>> import torch

>>> tokenizer = AutoTokenizer.from_pretrained("bigscience/bloom")
>>> model = BloomForTokenClassification.from_pretrained("bigscience/bloom")

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

BloomForQuestionAnswering

class transformers.BloomForQuestionAnswering

< >

( config )

参数

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

带有一个片段分类头的 Bloom Transformer，用于抽取式问答任务，如 SQuAD（在隐藏状态输出之上加一个线性层，用于计算 片段开始 logits 和 片段结束 logits）。

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

此模型也是 PyTorch 的 torch.nn.Module 子类。可以像常规的 PyTorch 模块一样使用它，并参考 PyTorch 文档了解所有与通用用法和行为相关的事项。

forward

< >

( input_ids: typing.Optional[torch.LongTensor] = None attention_mask: typing.Optional[torch.FloatTensor] = None position_ids: typing.Optional[torch.LongTensor] = None head_mask: typing.Optional[torch.FloatTensor] = None inputs_embeds: typing.Optional[torch.FloatTensor] = None start_positions: typing.Optional[torch.LongTensor] = None end_positions: typing.Optional[torch.LongTensor] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None ) → transformers.modeling_outputs.QuestionAnsweringModelOutput 或 tuple(torch.FloatTensor)

参数

  • input_ids (形状为 (batch_size, input_ids_length) 的 torch.LongTensor) — input_ids_length = sequence_length（如果 past_key_values 为 None），否则为 past_key_values[0][0].shape[2]（输入过去键值状态的 sequence_length）。词汇表中输入序列词元的索引。

    如果使用了 past_key_values，则只应传递那些尚未计算其过去状态的 input_ids。

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

    什么是输入 ID？

  • attention_mask (形状为 (batch_size, sequence_length) 的 torch.FloatTensor, 可选) — 用于避免在填充词元索引上执行注意力的掩码。掩码值选自 [0, 1]：

    • 1 表示词元未被掩码，
    • 0 表示词元被掩码。

    什么是注意力掩码？

  • position_ids (形状为 (batch_size, sequence_length) 的 torch.LongTensor, 可选) — 位置嵌入中每个输入序列词元的位置索引。选自范围 [0, config.n_positions - 1]。

    什么是位置 ID？

  • 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 索引转换为关联向量，这会很有用。
  • start_positions (形状为 (batch_size,) 的 torch.LongTensor, 可选) — 标记片段开始位置（索引）的标签，用于计算词元分类损失。位置被限制在序列长度（sequence_length）内。超出序列的位置不计入损失计算。
  • end_positions (形状为 (batch_size,) 的 torch.LongTensor, 可选) — 标记片段结束位置（索引）的标签，用于计算词元分类损失。位置被限制在序列长度（sequence_length）内。超出序列的位置不计入损失计算。
  • output_attentions (bool, 可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参阅返回张量下的 attentions。
  • output_hidden_states (bool, 可选) — 是否返回所有层的隐藏状态。有关更多详细信息，请参阅返回张量下的 hidden_states。
  • return_dict (bool, 可选) — 是否返回一个 ModelOutput 而不是一个普通的元组。

返回

transformers.modeling_outputs.QuestionAnsweringModelOutput 或 tuple(torch.FloatTensor)

一个 transformers.modeling_outputs.QuestionAnsweringModelOutput 或一个 torch.FloatTensor 元组（如果传入 return_dict=False 或 config.return_dict=False），其包含的各种元素取决于配置（BloomConfig）和输入。

  • loss (torch.FloatTensor of shape (1,), 可选, 当提供 labels 时返回) — 总范围提取损失是起始位置和结束位置的交叉熵之和。

  • start_logits (torch.FloatTensor of shape (batch_size, sequence_length)) — 范围起始分数（SoftMax 之前）。

  • end_logits (torch.FloatTensor of shape (batch_size, sequence_length)) — 范围结束分数（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 后的注意力权重，用于计算自注意力头中的加权平均值。

BloomForQuestionAnswering 的 forward 方法重写了 __call__ 特殊方法。

虽然前向传播的流程需要在此函数中定义，但之后应调用 Module 实例而不是此函数，因为前者会处理前处理和后处理步骤，而后者会静默地忽略它们。

示例

>>> from transformers import AutoTokenizer, BloomForQuestionAnswering
>>> import torch

>>> tokenizer = AutoTokenizer.from_pretrained("bigscience/bloom")
>>> model = BloomForQuestionAnswering.from_pretrained("bigscience/bloom")

>>> question, text = "Who was Jim Henson?", "Jim Henson was a nice puppet"

>>> inputs = tokenizer(question, text, return_tensors="pt")
>>> with torch.no_grad():
...     outputs = model(**inputs)

>>> answer_start_index = outputs.start_logits.argmax()
>>> answer_end_index = outputs.end_logits.argmax()

>>> predict_answer_tokens = inputs.input_ids[0, answer_start_index : answer_end_index + 1]
>>> tokenizer.decode(predict_answer_tokens, skip_special_tokens=True)
...

>>> # target is "nice puppet"
>>> target_start_index = torch.tensor([14])
>>> target_end_index = torch.tensor([15])

>>> outputs = model(**inputs, start_positions=target_start_index, end_positions=target_end_index)
>>> loss = outputs.loss
>>> round(loss.item(), 2)
...
JAX
隐藏 JAX 内容

FlaxBloomModel

class transformers.FlaxBloomModel

< >

( config: BloomConfig input_shape: tuple = (1, 1) seed: int = 0 dtype: dtype = <class 'jax.numpy.float32'> _do_init: bool = True **kwargs )

参数

  • config (BloomConfig) — 包含模型所有参数的模型配置类。使用配置文件进行初始化不会加载与模型相关的权重，只会加载配置。请查看 from_pretrained() 方法来加载模型权重。
  • dtype (jax.numpy.dtype, 可选, 默认为 jax.numpy.float32) — 计算的数据类型。可以是 jax.numpy.float32、jax.numpy.float16（在 GPU 上）和 jax.numpy.bfloat16（在 TPU 上）之一。

    这可用于在 GPU 或 TPU 上启用混合精度训练或半精度推理。如果指定，所有计算都将使用给定的 dtype 执行。

    请注意，这仅指定计算的 dtype，不影响模型参数的 dtype。

    如果你希望更改模型参数的 dtype，请参阅 to_fp16() 和 to_bf16()。

基础的 Bloom Transformer 模型，输出原始的隐藏状态，没有任何特定的头在其之上。

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

该模型也是 Flax Linen flax.nn.Module 的子类。可将其用作常规的 Flax 模块，并参考 Flax 文档了解与一般用法和行为相关的所有事宜。

最后，此模型支持固有的 JAX 功能，例如

__call__

< >

( input_ids attention_mask = None past_key_values: typing.Optional[dict] = None params: typing.Optional[dict] = None dropout_rng: <function PRNGKey at 0x7effc7ad3a30> = None train: bool = False output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None ) → transformers.modeling_flax_outputs.FlaxBaseModelOutput 或 tuple(torch.FloatTensor)

参数

  • input_ids (形状为 (batch_size, input_ids_length) 的 numpy.ndarray) — input_ids_length = sequence_length。词汇表中输入序列词元的索引。

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

    什么是输入 ID？

  • attention_mask (形状为 (batch_size, sequence_length) 的 numpy.ndarray, 可选) — 用于避免在填充词元索引上执行注意力的掩码。掩码值选自 [0, 1]：

    • 1 表示词元未被掩码，
    • 0 表示词元被掩码。

    什么是注意力掩码？

  • past_key_values (dict[str, np.ndarray], 可选, 由 init_cache 返回或在传递先前的 past_key_values 时返回) — 预计算隐藏状态的字典（注意力块中的键和值），可用于快速自回归解码。预计算的键和值隐藏状态的形状为 [batch_size, max_length]。
  • output_attentions (bool, 可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参阅返回张量下的 attentions。
  • output_hidden_states (bool, 可选) — 是否返回所有层的隐藏状态。有关更多详细信息，请参阅返回张量下的 hidden_states。
  • return_dict (bool, 可选) — 是否返回一个 ModelOutput 而不是一个普通的元组。

返回

transformers.modeling_flax_outputs.FlaxBaseModelOutput 或 tuple(torch.FloatTensor)

一个 transformers.modeling_flax_outputs.FlaxBaseModelOutput 或一个 torch.FloatTensor 元组（如果传入 return_dict=False 或 config.return_dict=False），其包含的各种元素取决于配置（BloomConfig）和输入。

  • last_hidden_state (形状为 (batch_size, sequence_length, hidden_size) 的 jnp.ndarray) — 模型最后一层输出的隐藏状态序列。

  • hidden_states (tuple(jnp.ndarray), 可选, 当传入 output_hidden_states=True 或 config.output_hidden_states=True 时返回) — jnp.ndarray 的元组（一个用于嵌入层的输出，一个用于每层的输出），形状为 (batch_size, sequence_length, hidden_size)。

    模型在每个层输出的隐藏状态加上初始嵌入输出。

  • attentions (tuple(jnp.ndarray), 可选, 当传入 output_attentions=True 或 config.output_attentions=True 时返回) — jnp.ndarray 的元组（每层一个），形状为 (batch_size, num_heads, sequence_length, sequence_length)。

    注意力 softmax 后的注意力权重，用于计算自注意力头中的加权平均值。

FlaxBloomPreTrainedModel 的 forward 方法重写了 __call__ 特殊方法。

虽然前向传播的流程需要在此函数中定义，但之后应调用 Module 实例而不是此函数，因为前者会处理前处理和后处理步骤，而后者会静默地忽略它们。

示例

>>> from transformers import AutoTokenizer, FlaxBloomModel

>>> tokenizer = AutoTokenizer.from_pretrained("bigscience/bloom")
>>> model = FlaxBloomModel.from_pretrained("bigscience/bloom")

>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="jax")
>>> outputs = model(**inputs)

>>> last_hidden_states = outputs.last_hidden_state

FlaxBloomForCausalLM

class transformers.FlaxBloomForCausalLM

< >

( config: BloomConfig input_shape: tuple = (1, 1) seed: int = 0 dtype: dtype = <class 'jax.numpy.float32'> _do_init: bool = True **kwargs )

参数

  • config (BloomConfig) — 包含模型所有参数的模型配置类。使用配置文件进行初始化不会加载与模型相关的权重，只会加载配置。请查看 from_pretrained() 方法以加载模型权重。
  • dtype (jax.numpy.dtype, 可选, 默认为 jax.numpy.float32) — 计算的数据类型。可以是 jax.numpy.float32、jax.numpy.float16 (在 GPU 上) 和 jax.numpy.bfloat16 (在 TPU 上) 中的一种。

    这可用于在 GPU 或 TPU 上启用混合精度训练或半精度推理。如果指定，所有计算都将使用给定的 dtype 执行。

    请注意，这仅指定计算的数据类型，不影响模型参数的数据类型。

    如果你希望更改模型参数的数据类型，请参阅 to_fp16() 和 to_bf16()。

带有一个语言建模头部的 Bloom 模型 transformer（一个权重与输入嵌入绑定的线性层）。

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

该模型也是 Flax Linen flax.nn.Module 的子类。可将其用作常规的 Flax 模块，并参考 Flax 文档了解与一般用法和行为相关的所有事宜。

最后，此模型支持固有的 JAX 功能，例如

__call__

< >

( input_ids attention_mask = None past_key_values: typing.Optional[dict] = None params: typing.Optional[dict] = None dropout_rng: <function PRNGKey at 0x7effc7ad3a30> = None train: bool = False output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None ) → transformers.modeling_flax_outputs.FlaxMaskedLMOutput 或 tuple(torch.FloatTensor)

参数

  • input_ids (形状为 (batch_size, input_ids_length) 的 numpy.ndarray) — input_ids_length = sequence_length。词汇表中输入序列标记的索引。

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

    什么是输入 ID？

  • attention_mask (形状为 (batch_size, sequence_length) 的 numpy.ndarray, 可选) — 用于避免对填充标记索引执行注意力的掩码。掩码值选自 [0, 1]：

    • 1 表示标记未被遮盖，
    • 0 表示标记被遮盖。

    什么是注意力掩码？

  • past_key_values (dict[str, np.ndarray], 可选，由 init_cache 返回或在传递先前的 past_key_values 时返回) — 包含预先计算的隐藏状态（注意力块中的键和值）的字典，可用于快速自回归解码。预先计算的键和值隐藏状态的形状为 [batch_size, max_length]。
  • output_attentions (bool, 可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参阅返回张量下的 attentions。
  • output_hidden_states (bool, 可选) — 是否返回所有层的隐藏状态。有关更多详细信息，请参阅返回张量下的 hidden_states。
  • return_dict (bool, 可选) — 是返回一个 ModelOutput 而不是一个普通的元组。

返回

transformers.modeling_flax_outputs.FlaxMaskedLMOutput 或 tuple(torch.FloatTensor)

一个 transformers.modeling_flax_outputs.FlaxMaskedLMOutput 或一个 torch.FloatTensor 的元组 (如果传递了 return_dict=False 或当 config.return_dict=False 时)，包含根据配置 (BloomConfig) 和输入的不同元素。

  • logits (形状为 (batch_size, sequence_length, config.vocab_size) 的 jnp.ndarray) — 语言建模头的预测分数（SoftMax 之前每个词汇 token 的分数）。

  • hidden_states (tuple(jnp.ndarray), 可选, 当传入 output_hidden_states=True 或 config.output_hidden_states=True 时返回) — jnp.ndarray 的元组（一个用于嵌入层的输出，一个用于每层的输出），形状为 (batch_size, sequence_length, hidden_size)。

    模型在每个层输出的隐藏状态加上初始嵌入输出。

  • attentions (tuple(jnp.ndarray), 可选, 当传入 output_attentions=True 或 config.output_attentions=True 时返回) — jnp.ndarray 的元组（每层一个），形状为 (batch_size, num_heads, sequence_length, sequence_length)。

    注意力 softmax 后的注意力权重，用于计算自注意力头中的加权平均值。

FlaxBloomPreTrainedModel 的 forward 方法重写了 __call__ 特殊方法。

虽然前向传播的流程需要在此函数中定义，但之后应调用 Module 实例而不是此函数，因为前者会处理前处理和后处理步骤，而后者会静默地忽略它们。

示例

>>> from transformers import AutoTokenizer, FlaxBloomForCausalLM

>>> tokenizer = AutoTokenizer.from_pretrained("bigscience/bloom")
>>> model = FlaxBloomForCausalLM.from_pretrained("bigscience/bloom")

>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="np")
>>> outputs = model(**inputs)

>>> # retrieve logts for next token
>>> next_token_logits = outputs.logits[:, -1]
< > 在 GitHub 上更新

←Blenderbot Small BORT→