Transformers 文档
Cohere2 MoE
并获得增强的文档体验
开始使用
该模型于 2026-05-20 贡献给 Hugging Face Transformers。
Cohere2 MoE
[Command A+] 是来自 Cohere 的混合专家(Mixture-of-Experts, MoE)语言模型。它具有结合了滑动窗口和全注意力层的混合注意力模式,包含共享专家和路由专家,并支持极大的上下文窗口。
Cohere2MoeConfig
class transformers.Cohere2MoeConfig
< 源码 >( transformers_version: str | None = None architectures: list[str] | None = None output_hidden_states: bool | None = False return_dict: bool | None = True dtype: typing.Union[str, ForwardRef('torch.dtype'), NoneType] = None chunk_size_feed_forward: int = 0 is_encoder_decoder: bool = False id2label: dict[int, str] | dict[str, str] | None = None label2id: dict[str, int] | dict[str, str] | None = None problem_type: typing.Optional[typing.Literal['regression', 'single_label_classification', 'multi_label_classification']] = None vocab_size: int = 256000 hidden_size: int = 8192 intermediate_size: int = 22528 logit_scale: float = 0.0625 num_hidden_layers: int = 40 num_attention_heads: int = 64 num_key_value_heads: int | None = None head_dim: int = 128 hidden_act: str = 'silu' max_position_embeddings: int = 8192 initializer_range: float = 0.02 layer_norm_eps: float = 1e-05 use_cache: bool = True pad_token_id: int | None = 0 bos_token_id: int | None = 5 eos_token_id: int | list[int] | None = 255001 tie_word_embeddings: bool = True rope_theta: float | int = 10000.0 rope_scaling: dict | None = None attention_bias: bool = False attention_dropout: float = 0.0 sliding_window: int | None = 4096 num_experts_per_tok: int = 2 num_experts: int = 8 num_shared_experts: int = 0 shared_expert_combination_strategy: str = 'average' expert_selection_fn: str = 'softmax' layer_types: list[str] | None = None mlp_layer_types: list | None = None prefix_dense_sliding_window_pattern: int = 1 norm_topk_prob: bool = True prefix_dense_intermediate_size: int | None = None rms_norm_eps: float | None = None sliding_window_pattern: int = 4 )
参数
- vocab_size (
int, 可选, 默认为256000) — 模型的词汇表大小。定义了input_ids可以表示的不同标记(tokens)的数量。 - hidden_size (
int, 可选, 默认为8192) — 隐藏层表示的维度。 - intermediate_size (
int, 可选, 默认为22528) — MLP 表示的维度。 - logit_scale (
float, 可选, 默认为 0.0625) — 输出 logit 的缩放因子。 - num_hidden_layers (
int, 可选, 默认为40) — Transformer 解码器中的隐藏层数量。 - num_attention_heads (
int, 可选, 默认为64) — Transformer 解码器中每个注意力层的注意力头数。 - num_key_value_heads (
int, 可选) — 这是用于实现分组查询注意力(Grouped Query Attention, GQA)的 key_value 头数。如果num_key_value_heads=num_attention_heads,模型将使用多头注意力(MHA);如果num_key_value_heads=1,模型将使用多查询注意力(MQA);否则使用 GQA。在将多头检查点转换为 GQA 检查点时,每个组的键(key)和值(value)头应通过对该组内的所有原始头进行平均池化来构建。更多详情,请参阅 此论文。如果未指定,将默认为num_attention_heads。 - head_dim (
int, 可选, 默认为128) — 注意力头的维度。如果为 None,则默认为 hidden_size // num_attention_heads - hidden_act (
str, 可选, 默认为silu) — 解码器中的非线性激活函数(函数或字符串)。例如:"gelu"、"relu"、"silu"等。 - max_position_embeddings (
int, 可选, 默认为8192) — 此模型可能使用的最大序列长度。 - initializer_range (
float, 可选, 默认为0.02) — 用于初始化所有权重矩阵的 truncated_normal_initializer 的标准差。 - layer_norm_eps (
float, 可选, 默认为1e-05) — 层归一化层使用的 epsilon 值。 - use_cache (
bool, 可选, 默认为True) — 模型是否应返回最后的键/值注意力(并非所有模型都使用)。仅当config.is_decoder=True或模型是仅解码器生成模型时才相关。 - pad_token_id (
int, 可选, 默认为0) — 词汇表中用于填充(padding)的标记 ID。 - bos_token_id (
int, 可选, 默认为5) — 词汇表中用于流开始(beginning-of-stream)的标记 ID。 - eos_token_id (
Union[int, list[int]], 可选, 默认为255001) — 词汇表中用于流结束(end-of-stream)的标记 ID。 - tie_word_embeddings (
bool, 可选, 默认为True) — 是否根据模型的tied_weights_keys映射来绑定权重嵌入。 - rope_theta (
float, 可选, 默认为 10000.0) — RoPE 嵌入的基周期。 - rope_scaling (
dict, 可选) — 包含 RoPE 嵌入缩放配置的字典。 - attention_bias (
bool, 可选, 默认为False) — 是否在自注意力期间的查询、键、值和输出投影层中使用偏置(bias)。 - attention_dropout (
float, 可选, 默认为0.0) — 注意力概率的丢弃(dropout)比例。 - sliding_window (
int, 可选, 默认为4096) — 滑动窗口注意力窗口大小。如果为None,则不应用滑动窗口。 - num_experts_per_tok (
int, optional, defaults to 2) — 每个 token 选择的专家数量。 - num_experts (
int, optional, defaults to 8) — 路由专家的数量。 - num_shared_experts (
int, optional, defaults to 0) — 共享专家的数量。 - shared_expert_combination_strategy (
str, optional, defaults to"average") — 共享专家的组合策略,必须是 ['average', 'sum'] 中的一个。 - expert_selection_fn (
str, optional, defaults to"softmax") — 路由器的专家选择函数。 - layer_types (
list, optional) — 每层的注意力模式。 - mlp_layer_types (
list, optional) — 每层的 MLP(MoE 与稠密层)模式。 - prefix_dense_sliding_window_pattern (
int, optional, defaults to 1) — 前缀稠密层的滑动窗口模式。 - norm_topk_prob (
bool, optional, defaults toTrue) — 在使用 sigmoid 时,是否归一化 top-k 专家概率。 - prefix_dense_intermediate_size (
int, optional) — 稠密前缀层的中间维度。 - rms_norm_eps (
float, optional) — RMS 归一化层使用的 epsilon 值。 - sliding_window_pattern (
int, optional, defaults to 4) — 层的滑动窗口模式。
这是用于存储 Cohere2MoeModel 配置的配置类。它根据指定的参数实例化 Cohere2 Moe 模型,定义模型架构。使用默认值初始化配置将产生与 CohereLabs/command-a-plus-05-2026 类似的配置。
配置对象继承自 PreTrainedConfig,可用于控制模型输出。阅读 PreTrainedConfig 的文档以获取更多信息。
>>> from transformers import Cohere2MoeModel, Cohere2MoeConfig
>>> # Initializing a Cohere2Moe model configuration
>>> configuration = Cohere2MoeConfig()
>>> # Initializing a model from the Cohere2Moe configuration
>>> model = Cohere2MoeModel(configuration)
>>> # Accessing the model configuration
>>> configuration = model.configCohere2MoeModel
class transformers.Cohere2MoeModel
< 源代码 >( config: Cohere2MoeConfig )
参数
- config (Cohere2MoeConfig) — 模型配置类,包含模型的所有参数。使用配置文件初始化不会加载与模型相关的权重,仅加载配置。请查看 from_pretrained() 方法来加载模型权重。
基础的 Cohere2 Moe 模型,输出原始隐藏状态,顶部没有任何特定的层。
该模型继承自 PreTrainedModel。请查看超类文档以了解该库为所有模型实现的通用方法(例如下载或保存、调整输入嵌入大小、剪枝头部等)。
此模型也是一个 PyTorch torch.nn.Module 子类。像普通的 PyTorch Module 一样使用它,并参考 PyTorch 文档了解一般用法和行为的所有相关信息。
forward
< 源代码 >( input_ids: torch.LongTensor | None = None attention_mask: torch.Tensor | None = None position_ids: torch.LongTensor | None = None past_key_values: transformers.cache_utils.Cache | None = None inputs_embeds: torch.FloatTensor | None = None use_cache: bool | None = None **kwargs: typing_extensions.Unpack[transformers.utils.generic.TransformersKwargs] ) → MoeModelOutputWithPast 或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensor形状为(batch_size, sequence_length), optional) — 词汇表中输入序列 token 的索引。默认情况下填充(padding)将被忽略。可以使用 AutoTokenizer 获取索引。有关详细信息,请参见 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
torch.Tensor形状为(batch_size, sequence_length), optional) — 用于避免对填充 token 索引执行注意力操作的掩码。掩码值在[0, 1]中选择:- 1 表示未被遮罩的 token,
- 0 表示被遮罩的 token。
- position_ids (
torch.LongTensor形状为(batch_size, sequence_length), optional) — 每个输入序列 token 在位置嵌入中的位置索引。在范围[0, config.n_positions - 1]中选择。 - past_key_values (
~cache_utils.Cache, optional) — 预先计算的隐藏状态(自注意力块和交叉注意力块中的键和值),可用于加速顺序解码。这通常由模型在解码的先前阶段返回(当use_cache=True或config.use_cache=True时)。仅允许使用 Cache 实例作为输入,请参阅我们的 kv 缓存指南。如果没有传递
past_key_values,将默认初始化 DynamicCache。模型将输出与输入时相同的缓存格式。
如果使用了
past_key_values,用户应仅输入未处理的input_ids(那些没有向模型提供先前键值状态的索引),其形状为(batch_size, unprocessed_length),而不是形状为(batch_size, sequence_length)的所有input_ids。 - inputs_embeds (
torch.FloatTensor形状为(batch_size, sequence_length, hidden_size), optional) — 可选地,您可以选择直接传入嵌入表示,而不是传入input_ids。如果您想比模型内部的嵌入查找矩阵更精细地控制如何将input_ids索引转换为相关向量,这非常有用。 - use_cache (
bool, optional) — 如果设置为True,则返回past_key_values键值状态,并可用于加速解码(参见past_key_values)。
返回
MoeModelOutputWithPast 或 tuple(torch.FloatTensor)
一个 MoeModelOutputWithPast 对象或一个 torch.FloatTensor 的元组(如果传递了 return_dict=False 或 config.return_dict=False),根据配置(Cohere2MoeConfig)和输入,包含各种元素。
Cohere2MoeModel 的 forward 方法,重写了 __call__ 特殊方法。
虽然 forward pass 的实现需要在此函数中定义,但你应该在之后调用
Module实例而不是这个,因为前者负责运行预处理和后处理步骤,而后者会静默地忽略它们。
last_hidden_state (
torch.FloatTensor, 形状为(batch_size, sequence_length, hidden_size)) — 模型最后一层输出的隐藏状态序列。past_key_values (
Cache,*可选*,当传入use_cache=True或config.use_cache=True时返回) — 这是一个 Cache 实例。欲了解更多细节,请参阅我们的 KV 缓存指南。Contains pre-computed hidden-states (key and values in the self-attention blocks and optionally if
config.is_encoder_decoder=Truein the cross-attention blocks) that can be used (seepast_key_valuesinput) to speed up sequential decoding.hidden_states (
tuple(torch.FloatTensor), optional, 当传递output_hidden_states=True或当config.output_hidden_states=True时返回) —torch.FloatTensor的元组(一个用于嵌入层的输出,如果模型有嵌入层;+一个用于每个层的输出),形状为(batch_size, sequence_length, hidden_size)。模型在每个层输出的隐藏状态以及可选的初始嵌入输出。
attentions (
tuple(torch.FloatTensor), optional, 当传递output_attentions=True或当config.output_attentions=True时返回) —torch.FloatTensor的元组(每个层一个),形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 后的注意力权重,用于计算自注意力头中的加权平均值。
router_logits (
tuple(torch.FloatTensor), 可选, 当传递output_router_probs=True且config.add_router_probs=True时,或config.output_router_probs=True时返回) — 形状为(batch_size, sequence_length, num_experts)的torch.FloatTensor元组(每一层一个)。由 MoE 路由器计算的原始路由器对数(softmax 后),这些术语用于计算专家混合模型的辅助损失。
Cohere2MoeForCausalLM
class transformers.Cohere2MoeForCausalLM
< 源代码 >( config model_args: ~utils.generic.ModelArgs | None = None adapter_args: ~utils.generic.AdapterArgs | None = None lora_args: ~utils.generic.LoRAArgs | None = None tokenizer_args: ~utils.generic.TokenizerArgs | None = None dataset_args: ~utils.generic.DatasetArgs | None = None data_args: ~utils.generic.DataArgs | None = None training_args: ~utils.generic.TrainingArgs | None = None generation_args: ~utils.generic.GenerationArgs | None = None vision_tower_args: ~utils.generic.VisionTowerArgs | None = None qlora_args: ~utils.generic.QLoRAArgs | None = None vision_tower_template_args: ~utils.generic.VisionTowerTemplateArgs | None = None video_tower_args: ~utils.generic.VideoTowerArgs | None = None vision_config: ~utils.generic.VisionConfig | None = None video_config: ~utils.generic.VideoConfig | None = None load_dataset: bool | None = None load_data_collator: bool | None = None load_processor: bool | None = None load_lora_adapter: bool | None = None load_adapter: bool | None = None load_qlora_adapter: bool | None = None **kwargs: typing_extensions.Unpack[transformers.modeling_utils.PreTrainedModelKwargs] )
参数
- config (Cohere2MoeForCausalLM) — 模型配置类,包含模型的所有参数。使用配置文件初始化不会加载与模型相关的权重,仅加载配置。请查看 from_pretrained() 方法来加载模型权重。
用于因果语言建模的 Cohere2 Moe 模型。
该模型继承自 PreTrainedModel。请查看超类文档以了解该库为所有模型实现的通用方法(例如下载或保存、调整输入嵌入大小、剪枝头部等)。
此模型也是一个 PyTorch torch.nn.Module 子类。像普通的 PyTorch Module 一样使用它,并参考 PyTorch 文档了解一般用法和行为的所有相关信息。
forward
< 源代码 >( input_ids: torch.LongTensor | None = None attention_mask: torch.Tensor | None = None position_ids: torch.LongTensor | None = None past_key_values: transformers.cache_utils.Cache | None = None inputs_embeds: torch.FloatTensor | None = None labels: torch.LongTensor | None = None use_cache: bool | None = None logits_to_keep: int | torch.Tensor = 0 **kwargs: typing_extensions.Unpack[transformers.utils.generic.TransformersKwargs] ) → MoeCausalLMOutputWithPast 或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensor,形状为(batch_size, sequence_length),可选) — 输入序列标记在词表中的索引。填充(padding)将默认被忽略。可以使用 AutoTokenizer 获取索引。有关详情,请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
torch.Tensor,形状为(batch_size, sequence_length),可选) — 用于避免对填充标记索引执行注意力计算的掩码。掩码值选自[0, 1]:- 1 表示未遮蔽的标记,
- 0 表示被遮蔽的标记。
- position_ids (
torch.LongTensor,形状为(batch_size, sequence_length),可选) — 每个输入序列标记在位置嵌入中的位置索引。选自范围[0, config.n_positions - 1]。 - past_key_values (
~cache_utils.Cache,可选) — 预计算的隐藏状态(自注意力模块和交叉注意力模块中的键和值),可用于加速序列解码。这通常包括模型在解码的前一阶段返回的past_key_values(当use_cache=True或config.use_cache=True时)。仅允许使用 Cache 实例作为输入,请参阅我们的 KV 缓存指南。如果未传入
past_key_values,则默认初始化 DynamicCache。模型将输出与输入格式相同的缓存。
如果使用了
past_key_values,用户应仅输入未处理的input_ids(那些其键值状态未提供给此模型的输入),其形状应为(batch_size, unprocessed_length),而不是形状为(batch_size, sequence_length)的所有input_ids。 - inputs_embeds (
torch.FloatTensor,形状为(batch_size, sequence_length, hidden_size),可选) — 可选地,你可以选择直接传入嵌入表示,而不是传入input_ids。如果你希望比模型内部的嵌入查找矩阵更精细地控制如何将input_ids索引转换为关联向量,这非常有用。 - labels (
torch.LongTensor,形状为(batch_size, sequence_length),可选) — 用于计算掩码语言模型损失的标签。索引应在[0, ..., config.vocab_size]范围内或为 -100(参阅input_ids文档字符串)。索引设置为-100的标记将被忽略(遮蔽),损失仅针对标签在[0, ..., config.vocab_size]范围内的标记进行计算。 - use_cache (
bool,可选) — 如果设置为True,则返回past_key_values键值状态,并可用于加速解码(参阅past_key_values)。 - logits_to_keep (
Union[int, torch.Tensor],可选,默认为0) — 如果是int,则计算最后logits_to_keep个标记的 Logits。如果为0,则计算所有input_ids的 Logits(特殊情况)。生成时通常只需要最后一个标记的 Logits,仅计算该标记的 Logits 可以节省内存,对于长序列或大词表规模来说,这变得非常显著。如果为torch.Tensor,则必须是对应于要在序列长度维度中保留的索引的一维张量。这在使用打包(packed)张量格式(批次和序列长度使用单一维度)时很有用。
返回
MoeCausalLMOutputWithPast 或 tuple(torch.FloatTensor)
一个 MoeCausalLMOutputWithPast 或一个 torch.FloatTensor 元组(如果传入了 return_dict=False 或当 config.return_dict=False 时),根据配置(Cohere2MoeConfig)和输入包含各种元素。
Cohere2MoeForCausalLM 的 forward 方法,重写了 __call__ 特殊方法。
虽然 forward pass 的实现需要在此函数中定义,但你应该在之后调用
Module实例而不是这个,因为前者负责运行预处理和后处理步骤,而后者会静默地忽略它们。
loss (
torch.FloatTensor形状为(1,),可选,当提供labels时返回) — 语言建模损失(用于下一个 token 预测)。logits (形状为
(batch_size, sequence_length, config.vocab_size)的torch.FloatTensor) — 语言建模头部的预测分数(SoftMax 之前的每个词汇标记的分数)。aux_loss (
torch.FloatTensor,可选,当提供labels时返回) — 稀疏模块的辅助损失。router_logits (
tuple(torch.FloatTensor), 可选, 当传递output_router_probs=True且config.add_router_probs=True时,或config.output_router_probs=True时返回) — 形状为(batch_size, sequence_length, num_experts)的torch.FloatTensor元组(每一层一个)。由 MoE 路由器计算的原始路由器对数(softmax 后),这些术语用于计算专家混合模型的辅助损失。
past_key_values (
Cache,*可选*,当传入use_cache=True或config.use_cache=True时返回) — 这是一个 Cache 实例。欲了解更多细节,请参阅我们的 KV 缓存指南。包含预计算的隐藏状态(自注意力块中的键和值),可用于(参见
past_key_values输入)加速顺序解码。hidden_states (
tuple(torch.FloatTensor), optional, 当传递output_hidden_states=True或当config.output_hidden_states=True时返回) —torch.FloatTensor的元组(一个用于嵌入层的输出,如果模型有嵌入层;+一个用于每个层的输出),形状为(batch_size, sequence_length, hidden_size)。模型在每个层输出的隐藏状态以及可选的初始嵌入输出。
attentions (
tuple(torch.FloatTensor), optional, 当传递output_attentions=True或当config.output_attentions=True时返回) —torch.FloatTensor的元组(每个层一个),形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 后的注意力权重,用于计算自注意力头中的加权平均值。
示例
>> from transformers import AutoTokenizer, Cohere2MoeForCausalLM
>> model = Cohere2MoeForCausalLM.from_pretrained("Cohere2MoeForAI/c4ai-command-r-v01")
>> tokenizer = AutoTokenizer.from_pretrained("Cohere2MoeForAI/c4ai-command-r-v01")
>> prompt = "Hey, are you conscious? Can you talk to me?"
>> inputs = tokenizer(prompt, return_tensors="pt")
>> # Generate
>> generate_ids = model.generate(inputs.input_ids, max_length=30)
>> tokenizer.batch_decode(generate_ids, skip_special_tokens=True, clean_up_tokenization_spaces=False)[0]
"Hey, are you conscious? Can you talk to me?\nI'm not conscious, but I can talk to you."