Transformers 文档

CPMAnt

Transformers

加入 Hugging Face 社区

并获取增强的文档体验

协作处理模型、数据集和 Spaces

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

切换文档主题

开始使用

CPMAnt

概述

CPM-Ant 是一个拥有 100 亿参数的开源中文预训练语言模型 (PLM)。它也是 CPM-Live 持续训练过程的第一个里程碑。训练过程具有成本效益且环境友好。CPM-Ant 在 CUGE 基准测试中通过 delta tuning 也取得了可喜的成果。除了完整模型外，我们还提供各种压缩版本，以满足不同硬件配置的需求。查看更多

此模型由 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 可以表示的不同 token 的数量。
hidden_size (int, 可选, 默认为 4096) — 编码器层的维度。
num_attention_heads (int, 可选, 默认为 32) — Transformer 编码器中 attention heads 的数量。
dim_head (int, 可选, 默认为 128) — Transformer 编码器中每个 attention 层的 attention heads 的维度。
dim_ff (int, 可选, 默认为 10240) — Transformer 编码器中“中间”（即，前馈）层的维度。
num_hidden_layers (int, 可选, 默认为 48) — Transformer 编码器的层数。
dropout_p (float, 可选, 默认为 0.0) — 嵌入层、编码器中所有全连接层的 dropout 概率。
position_bias_num_buckets (int, 可选, 默认为 512) — position_bias buckets 的数量。
position_bias_max_distance (int, 可选, 默认为 2048) — 此模型可能使用的最大序列长度。通常将其设置为较大的值以防万一（例如，512 或 1024 或 2048）。
eps (float, 可选, 默认为 1e-06) — layer normalization 层使用的 epsilon 值。
init_std (float, 可选, 默认为 1.0) — 使用 std = init_std 初始化参数。
prompt_types (int, 可选, 默认为 32) — prompt 的类型。
prompt_length (int, 可选, 默认为 32) — prompt 的长度。
segment_types (int, 可选, 默认为 32) — segment 的类型。
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 = '<pad>' unk_token = '<unk>' line_token = '</n>' space_token = '</_>' padding_side = 'left' **kwargs )

参数

vocab_file (str) — 词汇表文件的路径。
bod_token (str, 可选, 默认为 "<d>") — 文档开始 token。
eod_token (str, 可选, 默认为 "</d>") — 文档结束 token。
bos_token (str, 可选, 默认为 "<s>") — 序列开始 token。
eos_token (str, 可选, 默认为 "</s>") — 序列结束 token。
pad_token (str, 可选, 默认为 "<pad>") — 用于 padding 的 token。
unk_token (str, 可选, 默认为 "<unk>") — 未知 token。
line_token (str, 可选, 默认为 "</n>") — 行 token。
space_token (str, optional, defaults to "</_>") — 空格符。(str, 可选，默认为 "</_>") — 空格符。

构建 CPMAnt tokenizer。基于字节级字节对编码（Byte-Pair-Encoding）。

build_inputs_with_special_tokens

< 源码 >

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

参数

token_ids_0 (List[int]) — 第一个分词序列，将添加特殊 token。
token_ids_1 (List[int]) — 可选的第二个分词序列，将添加特殊 token。

返回值

List[int]

带有特殊 token 的模型输入。

通过拼接和添加特殊 token，从单个序列或一对序列构建模型输入，用于序列分类任务。CPMAnt 序列具有以下格式：

单个序列：[BOS] 序列。

get_special_tokens_mask

< 源码 >

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

参数

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

返回值

List[int]

一个整数列表，取值范围为 [0, 1]：1 代表特殊 token，0 代表序列 token。

从没有添加特殊 token 的 token 列表中检索序列 ID。当使用 tokenizer 的 prepare_for_model 方法添加特殊 token 时，会调用此方法。

CpmAntModel

class transformers.CpmAntModel

< 源码 >

( config: CpmAntConfig )

裸 CPMAnt 模型，输出原始的 hidden-states，顶部没有任何特定的 head。此模型是 PyTorch torch.nn.Module 子类。您可以像使用常规 PyTorch Module 一样使用它，并参考 PyTorch 文档了解所有与通用用法和行为相关的事项。

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

forward

< 源码 >

( input_ids: typing.Optional[torch.Tensor] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None past_key_values: typing.Optional[typing.Tuple[typing.Tuple[torch.Tensor]]] = None use_cache: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None **kwargs ) → transformers.modeling_outputs.BaseModelOutputWithPast 或 tuple(torch.FloatTensor)

参数

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

索引可以使用 CPMAntTokenizer 获得。请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call() 了解详情。

什么是输入 ID？
past_key_values (tuple(tuple(torch.FloatTensor)), 可选，当传递 use_cache=True 或 config.use_cache=True 时返回) — 包含预计算的 hidden-states（自注意力模块和交叉注意力模块中的键和值），可以用于加速顺序解码（请参阅 past_key_values 输入）。
use_cache (bool, 可选) — 如果设置为 True，则返回 past_key_values 键值状态，并可用于加速解码（请参阅 past_key_values）。
output_attentions (bool, 可选) — 是否返回所有注意力层的注意力张量。
output_hidden_states (bool, 可选) — 是否返回所有层的 hidden states。
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 (形状为 (batch_size, sequence_length, hidden_size) 的 torch.FloatTensor) — 模型最后一层输出的 hidden-states 序列。

如果使用 past_key_values，则仅输出形状为 (batch_size, 1, hidden_size) 的序列的最后一个 hidden-state。
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) 的额外张量。

包含预计算的 hidden-states（自注意力模块中的键和值，以及可选地，如果 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)。

模型在每一层输出的 hidden-states，加上可选的初始嵌入输出。
attentions (tuple(torch.FloatTensor), 可选，当传递 output_attentions=True 或当 config.output_attentions=True 时返回) — torch.FloatTensor 的元组（每层一个），形状为 (batch_size, num_heads, sequence_length, sequence_length)。

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

CpmAntModel 的 forward 方法覆盖了 __call__ 特殊方法。

尽管 forward 传递的配方需要在该函数中定义，但应该在之后调用 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 模型，顶部带有一个语言建模 head（权重与输入嵌入绑定的线性层）。

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

forward

< 源码 >

( input_ids: typing.Optional[torch.Tensor] = None past_key_values: typing.Optional[typing.List[typing.Tuple[torch.Tensor, torch.Tensor]]] = None use_cache: typing.Optional[bool] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None labels: typing.Optional[torch.Tensor] = None return_dict: typing.Optional[bool] = None attention_mask: typing.Optional[torch.Tensor] = None **kwargs ) → transformers.modeling_outputs.CausalLMOutputWithPast 或 tuple(torch.FloatTensor)

参数

input_ids (torch.Tensor of shape (batch_size, seq_len)) — 词汇表中输入序列 tokens 的索引。

索引可以使用 CPMAntTokenizer 获得。参见 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call() 获取详细信息。

什么是输入 IDs？
past_key_values (tuple(tuple(torch.FloatTensor)), 可选, 当传递 use_cache=True 或当 config.use_cache=True 时返回) — 包含预先计算的 hidden-states (self-attention 模块和 cross-attention 模块中的 key 和 values)，可以用于加速顺序解码（参见 past_key_values 输入）。
use_cache (bool, 可选) — 如果设置为 True，则返回 past_key_values 键值状态，并可用于加速解码（参见 past_key_values）。
output_attentions (bool, 可选) — 是否返回所有 attention 层的 attentions tensors。
output_hidden_states (bool, 可选) — 是否返回所有层的 hidden states。
return_dict (bool, 可选) — 是否返回一个 ModelOutput 而不是一个普通的 tuple。
Args — input_ids (torch.Tensor of shape (batch_size, seq_len)): 词汇表中输入序列 tokens 的索引。

索引可以使用 CPMAntTokenizer 获得。参见 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call() 获取详细信息。

什么是输入 IDs？ past_key_values (tuple(tuple(torch.FloatTensor)), 可选, 当传递 use_cache=True 或当 config.use_cache=True 时返回): 包含预先计算的 hidden-states (self-attention 模块和 cross-attention 模块中的 key 和 values)，可以用于加速顺序解码（参见 past_key_values 输入）。 use_cache (bool, 可选): 如果设置为 True，则返回 past_key_values 键值状态，并可用于加速解码（参见 past_key_values）。 output_attentions (bool, 可选): 是否返回所有 attention 层的 attentions tensors。 output_hidden_states (bool, 可选): 是否返回所有层的 hidden states。 labels (torch.Tensor of shape (batch_size, sequence_length), 可选): 用于计算 masked language modeling loss 的标签。 return_dict (bool, 可选): 是否返回一个 ModelOutput 而不是一个普通的 tuple。 attention_mask (torch.Tensor of shape (batch_size, sequence_length), 可选): CPMAnt 将自动处理 attention mask，此参数是用于文本生成管道的虚拟参数。
Example — 示例 —
Text Generation with CpmAntForCausalLM. — 使用 CpmAntForCausalLM 进行文本生成。 —
```python —

from transformers import CPMAntTokenizer, CpmAntForCausalLM

返回值

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

A transformers.modeling_outputs.CausalLMOutputWithPast 或 torch.FloatTensor 的 tuple (如果传递 return_dict=False 或当 config.return_dict=False 时) ，包含各种元素，具体取决于配置 (CpmAntConfig) 和输入。

loss (torch.FloatTensor of shape (1,), 可选, 当提供 labels 时返回) — 语言建模损失（用于预测下一个 token）。
logits (torch.FloatTensor of shape (batch_size, sequence_length, config.vocab_size)) — 语言建模头的预测分数（SoftMax 之前每个词汇表 token 的分数）。
past_key_values (tuple(tuple(torch.FloatTensor)), 可选, 当传递 use_cache=True 或当 config.use_cache=True 时返回) — 长度为 config.n_layers 的 tuple(torch.FloatTensor) 的 Tuple，其中每个 tuple 具有 2 个形状为 (batch_size, num_heads, sequence_length, embed_size_per_head) 的 tensors）

包含预先计算的 hidden-states (self-attention 模块中的 key 和 values)，可以用于加速顺序解码（参见 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)。

模型在每一层输出的 hidden-states，加上可选的初始嵌入输出。
attentions (tuple(torch.FloatTensor), 可选，当传递 output_attentions=True 或当 config.output_attentions=True 时返回) — torch.FloatTensor 的元组（每层一个），形状为 (batch_size, num_heads, sequence_length, sequence_length)。

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

The CpmAntForCausalLM forward 方法，覆盖了 __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→