Transformers 文档

CPMAnt

Transformers

加入 Hugging Face 社区

并获得增强版文档体验

协作模型、数据集和空间

使用加速推理更快地运行示例

在文档主题之间切换

开始使用

CPMAnt

概述

CPM-Ant 是一个开源的 100 亿参数中文预训练语言模型 (PLM)。它也是 CPM-Live 实时训练过程中的第一个里程碑。训练过程具有成本效益且环保。CPM-Ant 在 CUGE 基准上通过增量微调也取得了令人满意的结果。除了完整模型之外，我们还提供各种压缩版本以满足不同硬件配置的需求。了解更多

此模型由 OpenBMB 贡献。原始代码可以在此处找到。

资源

关于 CPM-Live 的教程。

CpmAntConfig

class transformers.CpmAntConfig

< 源代码 >

( vocab_size: int = 30720 hidden_size: int = 4096 num_attention_heads: int = 32 dim_head: int = 128 dim_ff: int = 10240 num_hidden_layers: int = 48 dropout_p: int = 0.0 position_bias_num_buckets: int = 512 position_bias_max_distance: int = 2048 eps: int = 1e-06 init_std: float = 1.0 prompt_types: int = 32 prompt_length: int = 32 segment_types: int = 32 use_cache: bool = True **kwargs )

参数

vocab_size (int, 可选, 默认为 30720) — CPMAnt 模型的词典大小。定义了调用 CpmAntModel 时传递的 input 可以表示的不同标记的数量。
hidden_size (int, 可选, 默认为 4096) — 编码器层的维度。
num_attention_heads (int, 可选, 默认为 32) — Transformer 编码器中的注意力头的数量。
dim_head (int, 可选, 默认为 128) — Transformer 编码器中每个注意力层中的注意力头的维度。
dim_ff (int, 可选, 默认为 10240) — Transformer 编码器中“中间”(即前馈)层的维度。
num_hidden_layers (int, 可选, 默认为 48) — Transformer 编码器的层数。
position_bias_num_buckets (int, 可选, 默认为 512) — 位置偏差桶的数量。
position_bias_max_distance (int, 可选, 默认为 2048) — 此模型可能使用的最大序列长度。通常将此设置为一个较大的值以防万一（例如，512 或 1024 或 2048）。
eps (float, 可选, 默认为 1e-06) — 层归一化层使用的epsilon。
init_std (float, 可选, 默认为 1.0) — 使用 std = init_std 初始化参数。
prompt_types (int, 可选, 默认为 32) — 提示类型。
prompt_length (int, 可选, 默认为 32) — 提示的长度。
segment_types (int, 可选, 默认为 32) — 段类型。
use_cache (bool, 可选, 默认为 True) — 是否使用缓存。

这是一个配置类，用于存储 CpmAntModel 的配置。它用于根据指定的参数实例化 CPMAnt 模型，定义模型架构。使用默认值实例化配置将产生类似于 CPMAnt openbmb/cpm-ant-10b 架构的配置。

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

示例

>>> from transformers import CpmAntModel, CpmAntConfig

>>> # Initializing a CPMAnt cpm-ant-10b style configuration
>>> configuration = CpmAntConfig()

>>> # Initializing a model from the cpm-ant-10b style configuration
>>> model = CpmAntModel(configuration)

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

CpmAntTokenizer

class transformers.CpmAntTokenizer

< 源代码 >

( vocab_file bod_token = '<d>' eod_token = '</d>' bos_token = '<s>' eos_token = '</s>' pad_token

参数

vocab_file (str) — 词汇文件路径。
bod_token (str, optional, defaults to "<d>") — 文档开始标记。
eod_token (str, optional, defaults to "</d>") — 文档结束标记。
bos_token (str, optional, defaults to "<s>") — 序列开始标记。
eos_token (str, optional, defaults to "</s>") — 序列结束标记。
pad_token (str, optional, defaults to "<pad>") — 用于填充的标记。
unk_token (str, optional, defaults to "<unk>") — 未知标记。
line_token (str, optional, defaults to "</n>") — 行标记。
space_token (str, optional, defaults to "</_>") — 空格标记。

构建 CPMAnt 分词器。基于字节级字节对编码。

build_inputs_with_special_tokens

< 源代码 >

( token_ids_0: List token_ids_1: List = None ) → List[int]

参数

token_ids_1 (List[int]) — 可选的第二个被添加特殊标记的标记化序列。

List[int]

带有特殊标记的模型输入。

通过串联和添加特殊标记，从序列或一对序列构建用于序列分类任务的模型输入。CPMAnt 序列具有以下格式

单个序列：[BOS] 序列。

get_special_tokens_mask

< source >

( token_ids_0: List token_ids_1: Optional = None already_has_special_tokens: bool = False ) → List[int]

参数

token_ids_0 (List[int]) — ID 列表。
token_ids_1 (List[int], 可选) — 用于序列对的可选第二个 ID 列表。
already_has_special_tokens (bool, 可选, 默认为 False) — 令牌列表是否已使用模型的特殊标记进行格式化。

List[int]

一个在范围 [0, 1] 内的整数列表：特殊标记为 1，序列标记为 0。

从没有添加特殊标记的令牌列表中检索序列 ID。当使用标记器prepare_for_model方法添加特殊标记时，会调用此方法。

CpmAntModel

class transformers.CpmAntModel

< source >

( config: CpmAntConfig )

CPMAnt 模型，输出原始隐藏状态，没有任何特定的头部。此模型是 PyTorch torch.nn.Module 的子类。将其用作常规 PyTorch 模块，并参考 PyTorch 文档了解与一般使用和行为相关的所有事项。

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

forward

< source >

( input_ids: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None past_key_values: Optional = None use_cache: Optional = None return_dict: Optional = None **kwargs ) → transformers.modeling_outputs.BaseModelOutputWithPast 或 tuple(torch.FloatTensor)

参数

input_ids (torch.Tensor 形状为 (batch_size, seq_len)) — 词汇表中输入序列标记的索引。

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

什么是输入 ID？
past_key_values (tuple(tuple(torch.FloatTensor)), 可选, 当传递 use_cache=True 或 config.use_cache=True 时返回) — 包含预先计算的隐藏状态（自注意力块和交叉注意力块中的键和值），可用于（参见 past_key_values 输入）加快顺序解码速度。
use_cache (bool, 可选) — 如果设置为 True，则将返回 past_key_values 键值状态，可用于加快解码速度（参见 past_key_values）。
output_attentions (bool, 可选) — 是否返回所有注意力层的注意力张量。
output_hidden_states (bool, 可选) — 是否返回所有层的隐藏状态。
return_dict (bool, 可选) — 是否返回一个 ModelOutput 而不是一个简单元组。

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

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

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

如果使用 past_key_values，则仅输出形状为 (batch_size, 1, hidden_size) 的序列的最后一个隐藏状态。
past_key_values (tuple(tuple(torch.FloatTensor)), 可选, 当传递 use_cache=True 或 config.use_cache=True 时返回) — 长度为 config.n_layers 的 tuple(torch.FloatTensor) 元组，每个元组包含 2 个形状为 (batch_size, num_heads, sequence_length, embed_size_per_head)) 的张量，并且如果 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 输入）加快顺序解码速度。
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 CpmAntModel 正向方法，覆盖 __call__ 特殊方法。

虽然正向传递的配方需要在此函数内定义，但应该在之后调用 Module 实例，而不是这个，因为前者负责运行前处理和后处理步骤，而后者会静默地忽略它们。

示例

>>> from transformers import AutoTokenizer, CpmAntModel
>>> import torch

>>> tokenizer = AutoTokenizer.from_pretrained("openbmb/cpm-ant-10b")
>>> model = CpmAntModel.from_pretrained("openbmb/cpm-ant-10b")

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

>>> last_hidden_states = outputs.last_hidden_state

CpmAntForCausalLM

class transformers.CpmAntForCausalLM

< 源代码 >

( config: CpmAntConfig )

带有语言建模头的 CPMAnt 模型（权重与输入嵌入绑定的线性层）。

此模型是 PyTorch torch.nn.Module 子类。将其用作常规的 PyTorch 模块，并参考 PyTorch 文档了解有关一般用法和行为的所有事宜。

forward

< 源代码 >

( input_ids: Optional = None past_key_values: Optional = None use_cache: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None labels: Optional = None return_dict: Optional = None attention_mask: Optional = None **kwargs ) → transformers.modeling_outputs.CausalLMOutputWithPast 或 tuple(torch.FloatTensor)

参数

input_ids (torch.Tensor 形状为 (batch_size, seq_len)) — 输入序列词元的词汇索引。

索引可以通过 CPMAntTokenizer 获得。更多信息，请参见 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call() 。

什么是输入 ID?
past_key_values (tuple(tuple(torch.FloatTensor)), 可选, 在 use_cache=True 传入时或 config.use_cache=True 时返回) — 包含预先计算的隐藏状态（自注意力块和交叉注意力块中的键和值），可用于（参见 past_key_values 输入）加速顺序解码。
use_cache (bool, 可选) — 如果设置为 True，则会返回 past_key_values 键值状态，可用于加速解码（参见 past_key_values）。
output_attentions (bool, 可选) — 是否返回所有注意力层的注意力张量。
output_hidden_states (bool, 可选) — 是否返回所有层的隐藏状态。
return_dict (bool, 可选) — 是否返回 ModelOutput 而不是普通元组。

参数 — input_ids (torch.Tensor 形状为 (batch_size, seq_len)): 输入序列词元的词汇索引。

索引可以通过 CPMAntTokenizer 获得。更多信息，请参见 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call() 。

什么是输入 ID? past_key_values (tuple(tuple(torch.FloatTensor)), 可选, 在 use_cache=True 传入时或 config.use_cache=True 时返回): 包含预先计算的隐藏状态（自注意力块和交叉注意力块中的键和值），可用于（参见 past_key_values 输入）加速顺序解码。 use_cache (bool, 可选): 如果设置为 True，则会返回 past_key_values 键值状态，可用于加速解码（参见 past_key_values）。 output_attentions (bool, 可选): 是否返回所有注意力层的注意力张量。 output_hidden_states (bool, 可选): 是否返回所有层的隐藏状态。 labels (torch.Tensor 形状为 (batch_size, sequence_length), 可选): 用于计算掩码语言建模损失的标签。 return_dict (bool, 可选): 是否返回 ModelOutput 而不是普通元组。 attention_mask (torch.Tensor 形状为 (batch_size, sequence_length), 可选): CPMAnt 会自动处理注意力掩码，此参数是文本生成管道的虚拟参数。

示例 —
文本使用 CpmAntForCausalLM 生成。 —

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

一个 transformers.modeling_outputs.CausalLMOutputWithPast 或一个 torch.FloatTensor 元组（如果传递了 return_dict=False 或 config.return_dict=False），包含根据配置 (CpmAntConfig) 和输入的不同元素。

loss (torch.FloatTensor 形状为 (1,), 可选, 在提供 labels 时返回) — 语言建模损失（用于下一个词元预测）。
logits (torch.FloatTensor 形状为 (batch_size, sequence_length, config.vocab_size)) — 语言建模头的预测分数（SoftMax 之前的每个词汇标记的分数）。
past_key_values (tuple(tuple(torch.FloatTensor)), 可选，在传递 use_cache=True 或 config.use_cache=True 时返回) — 长度为 config.n_layers 的 tuple(tuple(torch.FloatTensor))，每个元组包含 2 个形状为 (batch_size, num_heads, sequence_length, embed_size_per_head) 的张量。

包含预先计算的隐藏状态（自注意力块中的键和值），可用于（参见 past_key_values 输入）加速顺序解码。
hidden_states (tuple(torch.FloatTensor), 可选, 当传递 output_hidden_states=True 或 config.output_hidden_states=True 时返回) — torch.FloatTensor 元组（一个用于嵌入的输出，如果模型具有嵌入层，+ 每个层的输出一个）形状为 (batch_size, sequence_length, hidden_size)。

模型中每一层输出的隐藏状态，以及可选的初始嵌入输出。
attentions (tuple(torch.FloatTensor), 可选, 当传递 output_attentions=True 或 config.output_attentions=True 时返回) — torch.FloatTensor 元组（每层一个）形状为 (batch_size, num_heads, sequence_length, sequence_length)。

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

CpmAntForCausalLM 正向方法，覆盖了 __call__ 特殊方法。

示例

>>> import torch
>>> from transformers import AutoTokenizer, CpmAntForCausalLM

>>> tokenizer = AutoTokenizer.from_pretrained("openbmb/cpm-ant-10b")
>>> model = CpmAntForCausalLM.from_pretrained("openbmb/cpm-ant-10b")

>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="pt")
>>> outputs = model(**inputs, labels=inputs["input_ids"])
>>> loss = outputs.loss
>>> logits = outputs.logits

< > 在 GitHub 上更新

←CPM CTRL→