CPMAnt
概述
CPM-Ant 是一个开源的10B参数的中文预训练语言模型(PLM)。它也是CPM-Live实时训练过程的第一个里程碑。训练过程具有成本效益且环保。CPM-Ant 在CUGE基准测试中通过delta调优也取得了令人瞩目的成果。除了完整模型外,我们还提供了各种压缩版本,以满足不同硬件配置的需求。查看更多
资源
- 关于CPM-Live的教程。
CpmAntConfig
类 transformers.CpmAntConfig
< source >( 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
, optional, defaults to 4096) — 编码器层的维度。 - num_attention_heads (
int
, 可选, 默认为 32) — Transformer 编码器中的注意力头数量。 - dim_head (
int
, optional, defaults to 128) — Transformer编码器中每个注意力层的注意力头维度。 - dim_ff (
int
, 可选, 默认为 10240) — Transformer编码器中“中间”(即前馈)层的维度。 - num_hidden_layers (
int
, optional, 默认为 48) — Transformer 编码器的层数。 - dropout_p (
float
, optional, defaults to 0.0) — 嵌入层和编码器中所有全连接层的丢弃概率。 - position_bias_num_buckets (
int
, optional, 默认为 512) — position_bias 的桶数。 - position_bias_max_distance (
int
, optional, defaults to 2048) — 此模型可能使用的最大序列长度。通常将其设置为较大的值以防万一(例如,512、1024或2048)。 - eps (
float
, 可选, 默认为 1e-06) — 层归一化层使用的 epsilon 值。 - init_std (
float
, optional, 默认为 1.0) — 使用 std = init_std 初始化参数. - prompt_types (
int
, 可选, 默认为 32) — 提示的类型. - prompt_length (
int
, optional, defaults to 32) — 提示的长度. - segment_types (
int
, 可选, 默认为 32) — 段落的类型. - use_cache (
bool
, optional, defaults toTrue
) — 是否使用缓存.
这是用于存储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
类 transformers.CpmAntTokenizer
< source >( vocab_file bod_token = '' eos_token = '' pad_token = '
参数
- vocab_file (
str
) — 词汇表文件的路径。 - bod_token (
str
, 可选, 默认为"
) — 文档开始标记。" - eod_token (
str
, 可选, 默认为""
) — 文档结束标记。 - bos_token (
str
, optional, defaults to"
) — 序列的开始标记。" - eos_token (
str
, optional, defaults to""
) — 序列结束标记。 - pad_token (
str
, optional, defaults to"
) — 用于填充的标记。" - unk_token (
str
, optional, defaults to"
) — 未知的标记." - line_token (
str
, 可选, 默认为""
) — 行标记. - space_token (
str
, 可选, 默认为""
) — 空格标记.
构建一个CPMAnt分词器。基于字节级的字节对编码。
build_inputs_with_special_tokens
< source >( token_ids_0: typing.List[int] token_ids_1: typing.List[int] = None ) → List[int]
通过连接和添加特殊标记,从序列或序列对构建序列分类任务的模型输入。一个CPMAnt序列具有以下格式:
- 单一序列:
[BOS] Sequence
。
get_special_tokens_mask
< source >( token_ids_0: typing.List[int] token_ids_1: typing.Optional[typing.List[int]] = None already_has_special_tokens: bool = False ) → List[int]
从没有添加特殊标记的标记列表中检索序列ID。当使用标记器的prepare_for_model
方法添加特殊标记时,会调用此方法。
CpmAntModel
裸的CPMAnt模型输出原始的隐藏状态,没有任何特定的头部。 这个模型是一个PyTorch torch.nn.Module 的子类。使用 它作为常规的PyTorch模块,并参考PyTorch文档以获取与一般使用和行为相关的所有事项。
参数 config (~CpmAntConfig): 包含所有参数的模型配置类 使用配置文件初始化不会加载与模型相关的权重,只会加载配置。查看 from_pretrained() 方法以加载模型权重。
前进
< source >( 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 (
torch.Tensor
of shape(batch_size, seq_len)
) — Indices of input sequence tokens in the vocabulary.可以使用
CPMAntTokenizer
获取索引。详情请参见PreTrainedTokenizer.encode()和 PreTrainedTokenizer.call()。 - 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
, optional) — 是否返回所有注意力层的注意力张量。 - output_hidden_states (
bool
, optional) — 是否返回所有层的隐藏状态。 - 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 后的注意力权重,用于计算自注意力头中的加权平均值。
CpmAntModel 的 forward 方法,重写了 __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
CPMAnt 模型,顶部带有语言建模头(线性层,其权重与输入嵌入绑定)。
该模型是一个PyTorch torch.nn.Module 子类。将其作为常规的PyTorch模块使用,并参考PyTorch文档以获取与一般使用和行为相关的所有信息。
参数 config (~CpmAntConfig): 包含所有参数的模型配置类 使用配置文件初始化不会加载与模型相关的权重,只会加载配置。查看 from_pretrained() 方法以加载模型权重。
前进
< source >( 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)
) — Indices of input sequence tokens in the vocabulary.可以使用
CPMAntTokenizer
获取索引。详情请参见PreTrainedTokenizer.encode()和 PreTrainedTokenizer.call()。 - 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
, optional) — 是否返回所有注意力层的注意力张量。 - output_hidden_states (
bool
, optional) — 是否返回所有层的隐藏状态。 - return_dict (
bool
, 可选) — 是否返回一个ModelOutput而不是一个普通的元组。 - Args —
input_ids (
torch.Tensor
of shape(batch_size, seq_len)
): Indices of input sequence tokens in the vocabulary.可以使用
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
of shape(batch_size, sequence_length)
, 可选): 用于计算掩码语言建模损失的标签。 return_dict (bool
, 可选): 是否返回ModelOutput而不是普通元组。 attention_mask (torch.Tensor
of shape(batch_size, sequence_length)
, 可选): CPMAnt会自动处理注意力掩码,此参数是文本生成管道的虚拟参数。 - 示例 —
- 文本 生成与 CpmAntForCausalLM。—
- ```python —
从transformers导入CPMAntTokenizer, 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(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__
特殊方法。
尽管前向传递的配方需要在此函数内定义,但之后应该调用Module
实例而不是这个,因为前者负责运行预处理和后处理步骤,而后者会默默地忽略它们。
示例:
>>> 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