Transformers 文档
AFMoE
并获得增强的文档体验
开始使用
该模型于 2025 年 11 月 29 日贡献给 Hugging Face Transformers。
AFMoE
AFMoE (Arcee Foundational Mixture of Experts) 是一个仅解码器的 Transformer 模型,它通过稀疏混合专家 (MoE) 方法扩展了 Llama 架构。该模型结合了 Token 选择路由与共享专家机制,并采用了多项架构创新,以实现高效推理和性能提升。
关键架构特性
AFMoE 对标准 Transformer 架构引入了几项关键修改:
- 混合专家与共享专家 (Mixture of Experts with Shared Experts):结合了路由专家(通过学习到的路由按 Token 激活)和始终激活的共享专家,以实现稳定的基础计算。
- Token 选择路由 (Token-Choice Routing):使用基于 Sigmoid 或 Softmax 的路由,并结合归一化和缩放来进行专家选择。
- Q/K 归一化与门控 (Q/K Normalization and Gating):对查询(Query)和键(Key)投影应用 RMSNorm,并在注意力输出上使用 Sigmoid 门控,以提高稳定性。
- 混合注意力模式 (Hybrid Attention Patterns):在层之间交替使用滑动窗口注意力和全注意力,从而在长上下文处理中实现高效率。
- 双重归一化 (Dual Normalization):在注意力模块和 MLP 模块前后均使用归一化,以保证训练稳定性。
- 可配置的密集层 (Configurable Dense Layers):允许初始层使用密集 MLP,然后再过渡到稀疏 MoE 层。
该模型支持通过 RoPE 嵌入扩展上下文长度,并包含所有标准 Transformers 功能,包括 Flash Attention 2、SDPA、梯度检查点(gradient checkpointing)以及量化支持。
AFMoE 特别适用于需要通过稀疏性实现高效扩展同时保持强大性能的场景。共享专家提供了稳定的计算基准,而路由专家则实现了模型容量的扩展。
下方的示例演示了如何使用 Pipeline 或 AutoModel 通过 AFMoE 生成文本。
from transformers import pipeline
pipeline = pipeline(
task="text-generation",
model="arcee-ai/Trinity-Mini",
device=0
)
output = pipeline("The key innovation in mixture of experts is")
print(output[0]["generated_text"])模型架构详情
专家路由
AFMoE 使用 Token 选择路由,其中每个 Token 根据路由器 Logits 独立选择 Top-k 专家。路由机制包括:
- 可配置的评分函数(Sigmoid 或 Softmax)
- 用于均衡专家利用率的可选路由归一化
- 用于控制专家贡献强度的路由缩放
- 专家选择的偏差修正
共享专家
与标准的 MoE 模型不同,AFMoE 包含始终为每个 Token 激活的共享专家,提供:
- 所有 Token 上稳定的计算基准
- 模型输出的方差降低
- 对分布外 (OOD) 输入更好的处理能力
注意力机制
混合注意力模式在以下两者之间交替:
- 滑动窗口注意力:用于长序列处理,具备效率优势,窗口大小可配置
- 全注意力:每 N 层应用一次(通过
global_attn_every_n_layers配置),用于全局上下文
所有注意力层均包含 Q/K 归一化和输出门控,以改善训练动态。
AfmoeConfig
class transformers.AfmoeConfig
< 源代码 >( 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 = 200192 hidden_size: int = 2048 intermediate_size: int = 6144 moe_intermediate_size: int = 1408 num_hidden_layers: int = 32 num_dense_layers: int | None = 1 num_attention_heads: int = 16 num_key_value_heads: int | None = None head_dim: int | None = 128 hidden_act: str = 'silu' max_position_embeddings: int = 16384 initializer_range: float = 0.02 rms_norm_eps: float = 1e-05 use_cache: bool = True tie_word_embeddings: bool = False rope_parameters: transformers.modeling_rope_utils.RopeParameters | dict | None = None num_experts: int | None = 64 num_experts_per_tok: int | None = 6 num_shared_experts: int | None = 2 route_scale: float | None = 1.0 output_router_logits: bool = False global_attn_every_n_layers: int | None = 4 sliding_window: int | None = 1024 layer_types: list[str] | None = None attention_dropout: float | int | None = 0.0 mup_enabled: bool | None = False eos_token_id: int | list[int] | None = None pad_token_id: int | None = None bos_token_id: int | None = None attention_bias: bool = False )
参数
- vocab_size (
int, 可选, 默认值为200192) — 模型的词汇表大小。定义了input_ids可以表示的不同 Token 的数量。 - hidden_size (
int, 可选, 默认值为2048) — 隐藏表示的维度。 - intermediate_size (
int, 可选, 默认值为6144) — MLP 表示的维度。 - moe_intermediate_size (
int, 可选, 默认值为1408) — 路由专家 MLP 的中间层大小。 - num_hidden_layers (
int, 可选, 默认值为32) — Transformer 解码器中的隐藏层数量。 - num_dense_layers (
int, 可选, 默认值为1) — 在 MoE 层开始之前的初始密集层数量。索引小于num_dense_layers的层将使用标准密集 MLP,而不是 MoE。 - num_attention_heads (
int, 可选, 默认值为16) — Transformer 解码器中每个注意力层的注意力头数量。 - num_key_value_heads (
int, 可选) — 这是用于实现分组查询注意力(Grouped Query Attention)的键值头数量。如果num_key_value_heads=num_attention_heads,模型将使用多头注意力(MHA);如果num_key_value_heads=1,模型将使用多查询注意力(MQA),否则使用 GQA。在将多头检查点转换为 GQA 检查点时,应通过对组内所有原始头进行平均池化来构造每个组的键和值头。更多详细信息,请查看此论文。如果不指定,默认值为num_attention_heads。 - head_dim (
int, 可选, 默认值为128) — 注意力头维度。如果为 None,默认值为hidden_size // num_attention_heads。 - hidden_act (
str, 可选, 默认值为silu) — 解码器中的非线性激活函数(函数或字符串)。例如:"gelu","relu","silu"等。 - max_position_embeddings (
int, 可选, 默认值为16384) — 此模型可能使用的最大序列长度。 - initializer_range (
float, 可选, 默认值为0.02) — 用于初始化所有权重矩阵的truncated_normal_initializer的标准差。 - rms_norm_eps (
float, 可选, 默认值为1e-05) — RMS 归一化层使用的 Epsilon 值。 - use_cache (
bool, 可选, 默认值为True) — 模型是否应返回最后的键/值注意力(并非所有模型都使用)。仅在config.is_decoder=True或模型为仅解码器的生成模型时相关。 - tie_word_embeddings (
bool, 可选, 默认值为False) — 是否根据模型的tied_weights_keys映射来绑定权重嵌入。 - rope_parameters (
Union[~modeling_rope_utils.RopeParameters, dict], 可选) — 包含 RoPE 嵌入配置参数的字典。该字典应包含rope_theta的值,并可选包含在需要使用具有更大max_position_embeddings的 RoPE 时用于缩放的参数。 - num_experts (
int, 可选, 默认值为64) — MoE 层中路由专家的数量。 - num_experts_per_tok (
int, 可选, 默认值为6) — 每个 Token 路由到的专家数量。这是 Token 选择路由的 Top-k 值。 - num_shared_experts (
int, 可选, 默认值为2) — 为所有 Token 始终激活的共享专家数量。 - route_scale (
float, 可选, 默认值为1.0) — 路由专家的缩放因子。 - output_router_logits (
bool, 可选, 默认值为False) — 模型是否应返回路由 Logits。启用此项后,模型还可以输出辅助损失,包括负载均衡损失和路由器 Z-损失。 - global_attn_every_n_layers (
int, 可选, 默认值为 4) — 全注意力层的频率。每隔 N 层将使用全注意力,而其他层使用滑动窗口注意力。 - sliding_window (
int, 可选, 默认值为1024) — 滑动窗口注意力窗口大小。如果为None,则不应用滑动窗口。 - layer_types (
list[str], 可选) — 明确将每个层索引映射到其层类型的列表。如果不提供,将根据配置值自动生成。 - attention_dropout (
Union[float, int], 可选, 默认值为0.0) — 注意力概率的 Dropout 比率。 - mup_enabled (
bool, 可选, 默认值为False) — 是否启用 muP(最大化更新参数化)输入缩放。启用后,输入嵌入将按sqrt(hidden_size)进行缩放。 - eos_token_id (
Union[int, list[int]], 可选) — 词汇表中用于流结束(End-of-stream)的 Token ID。 - pad_token_id (
int, 可选) — 词汇表中用于填充(Padding)的 Token ID。 - bos_token_id (
int, 可选) — 词汇表中用于流开始(Beginning-of-stream)的 Token ID。 - attention_bias (
bool, 可选, 默认值为False) — 是否在自注意力机制的查询、键、值和输出投影层中使用偏置(Bias)。
AFMoE 是一种自适应前馈 MoE(混合专家)模型,具有 Token 选择路由、共享专家机制以及结合了滑动窗口和全注意力模式的混合注意力机制。
示例
>>> from transformers import AfmoeModel, AfmoeConfig
>>> # Initializing an AFMoE configuration
>>> configuration = AfmoeConfig()
>>> # Initializing a model from the afmoe-small-sft-v1 style configuration
>>> model = AfmoeModel(configuration)
>>> # Accessing the model configuration
>>> configuration = model.configAfmoeModel
class transformers.AfmoeModel
< 源代码 >( config: AfmoeConfig )
参数
- config (AfmoeConfig) — 包含模型所有参数的模型配置类。使用配置文件初始化不会加载与模型关联的权重,仅加载配置。查看 from_pretrained() 方法以加载模型权重。
基础的 Afmoe 模型,输出原始隐藏状态,顶部没有任何特定的头。
该模型继承自 PreTrainedModel。请查看超类文档以了解该库为所有模型实现的通用方法(例如下载或保存、调整输入嵌入大小、剪枝头部等)。
此模型也是一个 PyTorch torch.nn.Module 子类。像普通的 PyTorch Module 一样使用它,并参考 PyTorch 文档了解一般用法和行为的所有相关信息。
forward
< 源代码 >( input_ids: torch.LongTensor | None = None attention_mask: torch.Tensor | None = None inputs_embeds: torch.FloatTensor | None = None position_ids: torch.LongTensor | None = None past_key_values: transformers.cache_utils.Cache | 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),可选) — 词汇表中输入序列 Token 的索引。默认情况下,填充(Padding)将被忽略。索引可以使用 AutoTokenizer 获取。详细信息请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
torch.Tensor,形状为(batch_size, sequence_length),可选) — 用于避免对填充 Token 索引执行注意力的掩码。掩码值在[0, 1]中选择:- 1 表示 未被掩码 的 Token,
- 0 表示 被掩码 的 Token。
- inputs_embeds (
torch.FloatTensor,形状为(batch_size, sequence_length, hidden_size),可选) — 可选参数,您可以选择直接传入嵌入表示,而不是传入input_ids。如果您想比模型内部的嵌入查找矩阵更精细地控制如何将input_ids索引转换为关联向量,这将非常有用。 - position_ids (
torch.LongTensor,形状为(batch_size, sequence_length),可选) — 每个输入序列 token 在位置嵌入中的位置索引。选择范围为[0, config.n_positions - 1]。 - past_key_values (
~cache_utils.Cache,可选) — 预计算的隐藏状态(自注意力模块和交叉注意力模块中的键和值),可用于加速序列解码。当use_cache=True或config.use_cache=True时,这通常由模型在解码的上一个阶段返回。仅允许使用 Cache 实例作为输入,请参阅我们的 kv 缓存指南。如果未传递
past_key_values,默认将初始化DynamicCache。模型将输出与输入时相同格式的缓存。
如果使用了
past_key_values,用户应仅输入未处理的input_ids(即没有向该模型提供其过去键值状态的 token),形状为(batch_size, unprocessed_length),而不是形状为(batch_size, sequence_length)的所有input_ids。 - use_cache (
bool,可选) — 如果设置为True,将返回past_key_values键值状态,并可用于加速解码(参见past_key_values)。
返回
MoeModelOutputWithPast 或 tuple(torch.FloatTensor)
一个 MoeModelOutputWithPast 或一个 torch.FloatTensor 元组(如果传入 return_dict=False 或 config.return_dict=False),根据配置 (None) 和输入,包含不同的元素。
AfmoeModel 的 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 后),这些术语用于计算专家混合模型的辅助损失。
AfmoeForCausalLM
class transformers.AfmoeForCausalLM
< 源代码 >( 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] )
用于因果语言建模的 Afmoe 模型。
该模型继承自 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 output_router_logits: 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),可选) — 词汇表中输入序列 token 的索引。填充(Padding)默认将被忽略。索引可以使用
AutoTokenizer获取。详情请参阅PreTrainedTokenizer.encode()和PreTrainedTokenizer.__call__()。 - attention_mask (
torch.Tensor,形状为(batch_size, sequence_length),可选) — 用于避免对填充 token 索引执行注意力机制的掩码。掩码值在[0, 1]中选择:- 1 表示 未被掩码 的 token,
- 0 表示 被掩码 的 token。
- position_ids (
torch.LongTensor,形状为(batch_size, sequence_length),可选) — 每个输入序列 token 在位置嵌入中的位置索引。选择范围为[0, config.n_positions - 1]。 - past_key_values (
~cache_utils.Cache,可选) — 预计算的隐藏状态(自注意力模块和交叉注意力模块中的键和值),可用于加速序列解码。当use_cache=True或config.use_cache=True时,这通常由模型在解码的上一个阶段返回。仅允许使用 Cache 实例作为输入,请参阅我们的 kv 缓存指南。如果未传递
past_key_values,默认将初始化DynamicCache。模型将输出与输入时相同格式的缓存。
如果使用了
past_key_values,用户应仅输入未处理的input_ids(即没有向该模型提供其过去键值状态的 token),形状为(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的 token 将被忽略(掩码),损失仅针对标签在[0, ..., config.vocab_size]范围内的 token 进行计算。 - use_cache (
bool,可选) — 如果设置为True,将返回past_key_values键值状态,并可用于加速解码(参见past_key_values)。 - output_router_logits (
bool,可选) — 是否返回所有路由器的 logits。它们可用于计算路由损失,不应在推理期间返回。 - logits_to_keep (
Union[int, torch.Tensor],可选,默认为0) — 如果为int,则计算最后logits_to_keep个 token 的 logits。如果为0,则计算所有input_ids的 logits(特殊情况)。生成时只需要最后一个 token 的 logits,且仅计算该 token 的 logits 可以节省内存,这对于长序列或大词汇表大小的情况非常显著。如果是torch.Tensor,则必须是对应于要在序列长度维度中保留的索引的一维张量。在使用打包张量格式(batch 和序列长度的单一维度)时,这非常有用。
返回
MoeCausalLMOutputWithPast 或 tuple(torch.FloatTensor)
一个 MoeCausalLMOutputWithPast 或一个 torch.FloatTensor 元组(如果传递了 return_dict=False 或当 config.return_dict=False 时),根据配置(AfmoeConfig)和输入包含各种元素。
AfmoeForCausalLM 的 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, AfmoeForCausalLM
>>> model = AfmoeForCausalLM.from_pretrained("meta-afmoe/Afmoe-2-7b-hf")
>>> tokenizer = AutoTokenizer.from_pretrained("meta-afmoe/Afmoe-2-7b-hf")
>>> 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."