Transformers documentation

Beam

You are viewing main version, which requires installation from source. If you'd like regular pip install, checkout the latest stable version (v5.22.1).
Hugging Face's logo
Join the Hugging Face community

and get access to the augmented documentation experience

to get started

Ce modèle a été contribué à Hugging Face Transformers le 2026-10-16.

FlashAttention SDPA Tensor parallelism Expert parallelism

Beam

Aperçu

Beam est le premier modèle à poids ouverts de Reflection, un modèle de langage sparse mixture-of-experts (MoE) doté de 501 Md de paramètres au total et de 23 Md de paramètres actifs par jeton, conçu pour les tâches de codage, de raisonnement et d’agents. Il a été pré-entraîné sur 23,8 T de jetons puis post-entraîné à l’aide d’un apprentissage par renforcement asynchrone à grande échelle. Beam est exclusivement textuel et il raisonne avant chaque réponse. Un paramètre d’effort de raisonnement dans le modèle de dialogue permet de contrôler l’intensité de ce raisonnement.

Beam comporte 52 couches décodeur et combine les fonctionnalités suivantes :

  • Attention glissante hybride et attention complète. Chaque sixième couche et la dernière couche utilisent l’attention complète, tandis que les autres portent sur les sliding_window (512) jetons les plus récents. layer_types définit le motif.
  • RoPE sur les couches glissantes, NoPE sur les couches complètes. rope_parameters est indexé par type de couche, et None indique un type de couche sans encodage positionnel. Les couches d'attention complète échangent les requêtes à la place (softmax scalable) : la requête à la position n (base 1) est multipliée par (1 + n / 2048) ** 0.1, ce qui empêche l'attention de s'aplatir lorsque le contexte augmente.
  • Attention à porte. Attention à requêtes groupées avec 48 têtes de requête et 8 têtes clé/valeur, et RMSNorm sur chaque tête de requête et de clé. Une porte sigmoïde calculée à partir de l'entrée de l'attention, avec un biais appris par tête, met à l'échelle la sortie de l'attention élément par élément avant la projection de sortie.
  • MoE creux. Les 3 premières couches utilisent un MLP SwiGLU dense, et les 49 couches restantes acheminent chaque jeton vers 8 experts parmi 256, sans expert partagé (mlp_layer_types définit le motif). Le routeur évalue les experts avec une sigmoïde, équilibre la charge avec un biais appris par expert au lieu d'une perte auxiliaire, et restreint chaque jeton aux meilleurs topk_group parmi n_group groupes d'experts. Les poids de routage sont normalisés, et la sortie du MoE est mise à l'échelle par routed_scaling_factor.
  • Normes en sandwich avec résidus mis à l'échelle selon la profondeur. Chaque bloc d'attention et de MLP est encadré par une RMSNorm avant et après. Les additions résiduelles sont remises à l'échelle de sorte qu'après k contributions (en comptant les embeddings comme la première), le flux résiduel est leur somme divisée par sqrt(k).
  • Limitation douce des logits finaux. Les logits sont limités par 30 * tanh(logits / 30) (final_logit_softcapping).

L'implémentation calcule le mise à l'échelle RMSNorm, l'activation SwiGLU, RoPE, la mise à l'échelle des requêtes, le routage et le softcapping en FP32 afin de correspondre à la numérisation avec laquelle Beam a été entraîné et servi. Les poids du routeur et le biais des experts sont conservés en FP32 au moment du chargement, et les logits renvoyés sont toujours en FP32.

Vous pouvez trouver tous les points de contrôle Beam originaux sous l'organisation Reflection.

Ce modèle a été contribué par yonigozlan.

Exemples d'utilisation

Le modèle de chat de Beam met en forme les conversations au format Harmony de Beam, et son modèle de réponse analyse le texte généré pour le convertir en un message avec les champs thinking, content et tool_calls. Les exemples ci-dessous génèrent une réponse avec Pipeline ou la classe AutoModelForCausalLM.

Le checkpoint BF16 fait environ 1 To, les exemples le répartissent donc sur 8 appareils en plaçant des experts routés entiers sur chaque appareil grâce au parallelisme d'experts. Lancez-les avec torchrun --nproc-per-node 8 <script.py>.

Pipeline
AutoModel
from transformers import DistributedConfig, pipeline

pipe = pipeline(
    task="text-generation",
    model="reflection/Beam-1.0-501B-A23B",
    model_kwargs={"distributed_config": DistributedConfig(tp_size=8, ep_size=8)},
)

messages = [{"role": "user", "content": "Explain in one sentence why the sky is usually blue."}]
output = pipe(messages, max_new_tokens=2048)
reply = output[0]["generated_text"][-1]
print(reply["thinking"])
print(reply["content"])

Préférez cette option à device_map="auto", qui place des couches entières sur chaque appareil, les exécute un appareil à la fois et peut épuiser la mémoire pendant le chargement.

Échantillons de génération avec la temperature=0.7 et le top_p=0.99 recommandés par Beam, définis par défaut dans la GenerationConfig du point de contrôle. Passez do_sample=False pour un décodage glouton.

Effort de raisonnement

Passez reasoning_effort à apply_chat_template() pour contrôler le niveau de raisonnement de Beam. Il accepte un budget entier ou l’un des libellés ci-dessous. Beam n’a pas été entraîné avec des efforts inférieurs à 8, les valeurs plus petites ne sont donc pas respectées.

Étiquetteminimallowmediumhighxhighmax
Effort83264128256512

Lorsque reasoning_effort n’est pas défini, le modèle utilise max. Si max_new_tokens est épuisé pendant le raisonnement, le message analysé contient thinking mais pas content.

Conversations multi-tours

Ajoutez le message analysé à l’historique tel quel. La sortie de Beam se dégrade sans son raisonnement antérieur, que le modèle de conversation lit depuis thinking (reasoning_content et reasoning sont également acceptés). Par défaut, un tour d’assistant sans raisonnement est rendu avec un bloc de raisonnement vide. Passez allow_missing_thinking=False pour lever une erreur à la place lorsque add_generation_prompt=True, ce qui est recommandé lors du service de Beam.

messages.append(message)
messages.append({"role": "user", "content": "And why are sunsets red?"})
inputs = tokenizer.apply_chat_template(
    messages, add_generation_prompt=True, return_tensors="pt", return_dict=True
).to(model.device)

Appel d'outils

Passez tools à la fois à apply_chat_template() et à parse_response(). Avec tools, les arguments analysés sont convertis aux types définis dans le schéma de chaque outil ; sans cela, chaque argument est une chaîne de caractères.

def get_weather(city: str):
    """
    Get the current weather in a city.

    Args:
        city: The city name.
    """
    return "Sunny, 22 C"


messages = [{"role": "user", "content": "What's the weather like in Paris right now?"}]
inputs = tokenizer.apply_chat_template(
    messages, tools=[get_weather], add_generation_prompt=True, return_tensors="pt", return_dict=True
).to(model.device)
outputs = model.generate(**inputs, max_new_tokens=2048)
generated = tokenizer.decode(outputs[0, inputs["input_ids"].shape[1] :])
message = tokenizer.parse_response(generated, prefix=inputs["input_ids"][0], tools=[get_weather])
print(message["tool_calls"])
# [{'type': 'function', 'function': {'name': 'get_weather', 'arguments': {'city': 'Paris'}}}]

messages.append(message)
for call in message["tool_calls"]:
    result = get_weather(**call["function"]["arguments"])
    messages.append({"role": "tool", "name": call["function"]["name"], "content": result})

Générez ensuite à nouveau à partir de messages pour obtenir la réponse finale. Les appels d’outils analysés n’ont pas d’id, et le format associe les résultats aux appels par position, il faut donc renvoyer les résultats des outils dans l’ordre des appels. La génération s’arrête après une réponse finale (<|return|>) ou un appel d’outil (<|call|>) ; generation_config.json liste les deux.

Pour le streaming, get_response_parser() renvoie un parseur auquel vous feed() des fragments de texte au fur et à mesure de leur génération. Consultez Response parsing pour plus de détails.

Notes

  • Arguments du modèle. En plus de reasoning_effort, le modèle de chat accepte model_identity (remplace la première ligne du message système), builtin_tools et allow_missing_thinking. builtin_tools ne doit nommer que les outils search et browse, et uniquement avec les définitions avec lesquelles Beam a été entraîné. Les autres outils n’ont besoin que de tools. Les messages system et developer ne sont rendus qu’au début de la conversation.
  • Entraînement. Le modèle de conversation marque la sortie de l’assistant pour apply_chat_template(..., return_dict=True, return_assistant_tokens_mask=True), de sorte que SFTConfig(assistant_only_loss=True) de TRL entraîne le modèle uniquement sur les jetons de l’assistant. Le masque couvre le raisonnement, la réponse et les appels d’outils de chaque tour de l’assistant.
  • Aucune perte auxiliaire. Le routeur équilibre la charge des experts via son biais, de sorte que BeamForCausalLM ne calcule aucune perte d’équilibrage de charge. output_router_logits=True renvoie toujours les logits du routeur.

BeamConfig

classe transformers.BeamConfig

< >

( transformers_version: str | None = Nonearchitectures: list[str] | None = Noneoutput_hidden_states: bool | None = Falsereturn_dict: bool | None = Truedtype: str | torch.dtype | None = Nonechunk_size_feed_forward: int = 0is_encoder_decoder: bool = Falseid2label: dict[int, str] | dict[str, str] | None = Nonelabel2id: dict[str, int] | dict[str, str] | None = Noneproblem_type: Literal['regression', 'single_label_classification', 'multi_label_classification'] | None = Nonevocab_size: int = 151936hidden_size: int = 5120intermediate_size: int = 20480num_hidden_layers: int = 52num_attention_heads: int = 48num_key_value_heads: int = 8hidden_act: str = 'silu'max_position_embeddings: int = 8192initializer_range: float = 0.02rms_norm_eps: float = 1e-06use_cache: bool = Truetie_word_embeddings: bool = Falserope_parameters: transformers.modeling_rope_utils.RopeParameters | dict | None = Noneattention_bias: bool = Falsesliding_window: int | None = 512attention_dropout: float | int = 0.0moe_intermediate_size: int = 2560num_experts_per_tok: int = 8num_experts: int = 256norm_topk_prob: bool = Trueoutput_router_logits: bool = Falsepad_token_id: int | None = Nonebos_token_id: int | None = Noneeos_token_id: int | list[int] | None = Nonehead_dim: int = 128layer_types: list[str] | None = Nonemlp_layer_types: list[str] | None = Nonen_group: int | None = 8topk_group: int | None = 4routed_scaling_factor: int | float = 2.5final_logit_softcapping: int | float | None = 30.0 )

Paramètres

  • vocab_size (int, facultatif, par défaut 151936) — Taille du vocabulaire du modèle. Définit le nombre de jetons différents qui peuvent être représentés par input_ids.
  • hidden_size (int, facultatif, par défaut 5120) — Dimension des représentations cachées.
  • intermediate_size (int, facultatif, par défaut 20480) — Dimension des représentations du MLP.
  • num_hidden_layers (int, facultatif, par défaut 52) — Nombre de couches cachées dans le décodeur Transformer.
  • num_attention_heads (int, facultatif, valeur par défaut 48) — Nombre de têtes d'attention pour chaque couche d'attention du décodeur Transformer.
  • num_key_value_heads (int, facultatif, valeur par défaut 8) — Ceci est le nombre de têtes key_value à utiliser pour implémenter l'attention Grouped Query. Si num_key_value_heads=num_attention_heads, le modèle utilisera l'attention Multi Head (MHA), si num_key_value_heads=1 le modèle utilisera l'attention Multi Query (MQA), sinon l'attention GQA est utilisée. Lors de la conversion d'un checkpoint multi-têtes en checkpoint GQA, chaque tête clé et valeur de groupe doit être construite en effectuant un meanpooling de toutes les têtes d'origine au sein de ce groupe. Pour plus de détails, consultez ce papier. S'il n'est pas spécifié, la valeur par défaut sera num_attention_heads.
  • hidden_act (str, facultatif, par défaut silu) — La fonction d'activation non linéaire (fonction ou chaîne de caractères) du décodeur. Par exemple, "gelu", "relu", "silu", etc.
  • max_position_embeddings (int, facultatif, par défaut 8192) — La longueur de séquence maximale avec laquelle ce modèle pourrait être utilisé.
  • initializer_range (float, facultatif, par défaut 0.02) — L'écart-type de la truncated_normal_initializer utilisé pour initialiser toutes les matrices de poids.
  • rms_norm_eps (float, facultatif, valeur par défaut 1e-06) — L'épsilon utilisé par les couches de normalisation rms.
  • use_cache (bool, facultatif, valeur par défaut True) — Indique si le modèle doit retourner les dernières attentions clés/valeurs (non utilisé par tous les modèles). N’est pertinent que si config.is_decoder=True ou si le modèle est un modèle génératif uniquement décodeur.
  • tie_word_embeddings (bool, facultatif, valeur par défaut False) — Indique s'il faut lier les embeddings de poids selon la correspondance tied_weights_keys du modèle.
  • rope_parameters (Union[~modeling_rope_utils.RopeParameters, dict], facultatif) — Dictionnaire contenant les paramètres de configuration pour les embeddings RoPE. Le dictionnaire doit contenir une valeur pour rope_theta et, le cas échéant, les paramètres utilisés pour le mise à l’échelle si vous souhaitez utiliser RoPE avec des max_position_embeddings plus longs.
  • attention_bias (bool, facultatif, par défaut False) — Indique s'il faut utiliser un biais dans les couches de projection des requêtes, des clés, des valeurs et de la sortie lors de l'auto-attention.
  • sliding_window (int, facultatif, par défaut 512) — Taille de la fenêtre d'attention glissante. Si None, aucune fenêtre glissante n'est appliquée.
  • attention_dropout (Union[float, int], facultatif, valeur par défaut 0.0) — Le taux de dropout appliqué aux probabilités d'attention.
  • moe_intermediate_size (int, facultatif, par défaut 2560) — Taille intermédiaire des MLP des experts routés.
  • num_experts_per_tok (int, facultatif, valeur par défaut 8) — Nombre d'experts auxquels chaque jeton doit être routé. Il s'agit de la valeur top-k pour le routage par choix de jeton.
  • num_experts (int, facultatif, par défaut 256) — Nombre d'experts routés dans les couches MoE.
  • norm_topk_prob (bool, facultatif, valeur par défaut True) — Indique s'il faut normaliser les poids des experts routés.
  • output_router_logits (bool, facultatif, par défaut False) — Indique si les logits du routeur doivent être renvoyés par le modèle. L’activation de cette option permet également au modèle de renvoyer la perte auxiliaire, incluant la perte d’équilibrage de charge et la perte z du routeur.
  • pad_token_id (int, facultatif) — Identifiant du jeton utilisé pour le bourrage dans le vocabulaire.
  • bos_token_id (int, facultatif) — Identifiant du jeton utilisé pour le début de flux dans le vocabulaire.
  • eos_token_id (Union[int, list[int]], facultatif) — Identifiant du jeton utilisé pour la fin de flux dans le vocabulaire.
  • head_dim (int, facultatif, par défaut 128) — La dimension des têtes d'attention. Si None, elle est par défaut égale à hidden_size // num_attention_heads
  • layer_types (list[str], facultatif) — Une liste qui associe explicitement chaque index de couche à son type de couche. S'il n'est pas fourni, il sera généré automatiquement en fonction des valeurs de configuration.
  • mlp_layer_types (list[str], facultatif) — Type de MLP par couche, "dense" pour un MLP SwiGLU ou "sparse" pour le bloc MoE. La longueur doit être égale à num_hidden_layers. Par défaut, trois couches denses suivies de couches sparses.
  • n_group (int, facultatif, valeur par défaut 8) — Nombre de groupes pour les experts routés.
  • topk_group (int, facultatif, valeur par défaut 4) — Nombre de groupes sélectionnés pour chaque jeton (pour chaque jeton, garantissant que les experts sélectionnés ne se trouvent que dans topk_group groupes).
  • routed_scaling_factor (Union[int, float], facultatif, par défaut 2.5) — Facteur d'échelle des experts routés.
  • final_logit_softcapping (Union[int, float], facultatif, valeur par défaut 30.0) — Valeur de soft-capping appliquée aux logits finaux avant le calcul de la distribution de probabilité. Les logits sont mis à l'échelle par tanh(logit / cap) * cap.

Ceci est la classe de configuration destinée à stocker la configuration d'un BeamModel. Elle est utilisée pour instancier un modèle Beam en fonction des arguments spécifiés, définissant ainsi l'architecture du modèle. L'instanciation d'une configuration avec les valeurs par défaut produira une configuration similaire à celle du reflection/Beam-1.0-501B-A23B

Les objets de configuration héritent de PreTrainedConfig et peuvent être utilisés pour contrôler les sorties du modèle. Consultez la documentation de PreTrainedConfig pour plus d’informations.

>>> from transformers import BeamConfig

>>> # Initializing a Beam configuration
>>> configuration = BeamConfig()

BeamModel

classe transformers.BeamModel

< >

( config: BeamConfig )

Paramètres

  • config (BeamConfig) — Classe de configuration du modèle contenant tous les paramètres du modèle. L’initialisation à partir d’un fichier de configuration ne charge pas les poids associés au modèle, uniquement la configuration. Consultez la méthode from_pretrained() pour charger les poids du modèle.

Le modèle Beam brut qui produit des états cachés bruts sans aucune tête spécifique au sommet.

Ce modèle hérite de PreTrainedModel. Consultez la documentation de la classe parente pour les méthodes génériques que la bibliothèque implémente pour tous ses modèles (tels que le téléchargement ou l'enregistrement, le redimensionnement des embeddings d'entrée, la taille des têtes, etc.)

Ce modèle est également une sous-classe de torch.nn.Module de PyTorch. Utilisez-le comme un module PyTorch standard et consultez la documentation de PyTorch pour tout ce qui concerne l'utilisation et le comportement généraux.

forward

< >

( input_ids: typing.Optional[torch.LongTensor] = Noneattention_mask: typing.Optional[torch.Tensor] = Noneposition_ids: typing.Optional[torch.LongTensor] = Nonepast_key_values: transformers.cache_utils.Cache | None = Noneinputs_embeds: typing.Optional[torch.Tensor] = Noneuse_cache: bool | None = None**kwargs: *<class 'transformers.utils.generic.TransformersKwargs'> ) → MoeModelOutputWithPast or tuple(torch.Tensor)

Paramètres

  • input_ids (torch.LongTensor de forme (batch_size, sequence_length), facultatif) — Indices des jetons de la séquence d'entrée dans le vocabulaire. Le bourrage (padding) sera ignoré par défaut.

    Les indices peuvent être obtenus à l'aide de AutoTokenizer. Consultez PreTrainedTokenizer.encode() et PreTrainedTokenizer.call() pour plus de détails.

    Qu'est-ce que les identifiants d'entrée ?

  • attention_mask (torch.Tensor de forme (batch_size, sequence_length), facultatif) — Masque pour éviter d'appliquer l'attention aux indices des jetons de bourrage. Les valeurs du masque sont choisies dans [0, 1]:
    • 1 pour les jetons qui ne sont pas masqués,
    • 0 pour les jetons masqués.

    Qu'est-ce que les masques d'attention ?

  • position_ids (torch.LongTensor de forme (batch_size, sequence_length), facultatif) — Indices des positions des jetons de chaque séquence d'entrée dans les embeddings de position. Sélectionnés dans l'intervalle [0, config.n_positions - 1].

    Qu'est-ce que les identifiants de position ?

  • past_key_values (~cache_utils.Cache, facultatif) — États cachés précalculés (clés et valeurs dans les blocs d'auto-attention et d'attention croisée) qui peuvent être utilisés pour accélérer le décodage séquentiel. Cela consiste généralement en la past_key_values retournée par le modèle à une étape antérieure du décodage, lorsque use_cache=True ou config.use_cache=True.

    Seule une instance de Cache est autorisée en entrée, consultez notre guide du cache kv. Si aucun past_key_values n'est transmis, DynamicCache sera initialisé par défaut.

    Le modèle produira le même format de cache qui est fourni en entrée.

    Si past_key_values sont utilisés, l’utilisateur doit fournir uniquement les input_ids non traités (ceux pour lesquels les états de clés et de valeurs passées n’ont pas été fournis à ce modèle) de forme (batch_size, unprocessed_length) au lieu de tous les input_ids de forme (batch_size, sequence_length).

  • inputs_embeds (torch.Tensor de forme (batch_size, sequence_length, hidden_size), facultatif) — Facultativement, au lieu de passer input_ids, vous pouvez choisir de passer directement une représentation intégrée. Cela est utile si vous souhaitez un meilleur contrôle sur la manière de convertir les indices input_ids en vecteurs associés que la matrice de recherche d’intégration interne du modèle.
  • use_cache (bool, facultatif) — Si défini sur True, les états clé-valeur past_key_values sont renvoyés et peuvent être utilisés pour accélérer le décodage (voir past_key_values).

Retourne

MoeModelOutputWithPast ou tuple(torch.Tensor)

Un MoeModelOutputWithPast ou un tuple de torch.Tensor (si return_dict=False est passé ou lorsque config.return_dict=False) comprenant divers éléments en fonction de la configuration (BeamConfig) et des entrées.

La méthode forward de BeamModel redéfinit la méthode spéciale __call__.

Bien que la recette de la passe avant doive être définie dans cette fonction, il faut ensuite appeler l'instance Module plutôt que celle-ci, car la première gère l'exécution des étapes de prétraitement et de post-traitement, tandis que la seconde les ignore silencieusement.

  • last_hidden_state (torch.Tensor de forme (batch_size, sequence_length, hidden_size)) — Séquence d'états cachés à la sortie de la dernière couche du modèle.

  • past_key_values (Cache, facultatif, renvoyé lorsque use_cache=True est passé ou lorsque config.use_cache=True) — Il s’agit d’une instance de Cache. Pour plus de détails, consultez notre guide sur le cache kv.

    Contient des états cachés précalculés (clés et valeurs dans les blocs d'auto-attention et, le cas échéant, si config.is_encoder_decoder=True, dans les blocs d'attention croisée) qui peuvent être utilisés (voir l'entrée past_key_values) pour accélérer le décodage séquentiel.

  • hidden_states (tuple(torch.Tensor), facultatif, renvoyé lorsque output_hidden_states=True est passé ou lorsque config.output_hidden_states=True) — Tuple de torch.Tensor (un pour la sortie des embeddings, si le modèle possède une couche d’embedding, + un pour la sortie de chaque couche) de forme (batch_size, sequence_length, hidden_size).

    États cachés du modèle à la sortie de chaque couche, ainsi que les sorties d'incorporation initiales facultatives.

  • attentions (tuple(torch.Tensor), facultatif, renvoyé lorsque output_attentions=True est passé ou lorsque config.output_attentions=True) — Tuple de torch.Tensor (un par couche) de forme (batch_size, num_heads, sequence_length, sequence_length).

    Poids des attentions après le softmax d'attention, utilisés pour calculer la moyenne pondérée dans les têtes d'auto-attention.

  • router_logits (tuple(torch.Tensor), facultatif, renvoyé lorsque output_router_probs=True et config.add_router_probs=True sont passés ou lorsque config.output_router_probs=True) — Tuple de torch.Tensor (un par couche) de forme (batch_size, sequence_length, num_experts).

    Logits bruts du routeur (après softmax) calculés par les routeurs MoE, ces termes sont utilisés pour calculer la perte auxiliaire des modèles Mixture of Experts.

BeamForCausalLM

classe transformers.BeamForCausalLM

< >

( config: BeamConfig )

Paramètres

  • config (BeamConfig) — Classe de configuration du modèle contenant tous les paramètres du modèle. L’initialisation à partir d’un fichier de configuration ne charge pas les poids associés au modèle, uniquement la configuration. Consultez la méthode from_pretrained() pour charger les poids du modèle.

Le modèle Beam pour la modélisation de langage causale.

Ce modèle hérite de PreTrainedModel. Consultez la documentation de la classe parente pour les méthodes génériques que la bibliothèque implémente pour tous ses modèles (tels que le téléchargement ou l'enregistrement, le redimensionnement des embeddings d'entrée, la taille des têtes, etc.)

Ce modèle est également une sous-classe de torch.nn.Module de PyTorch. Utilisez-le comme un module PyTorch standard et consultez la documentation de PyTorch pour tout ce qui concerne l'utilisation et le comportement généraux.

forward

< >

( input_ids: typing.Optional[torch.LongTensor] = Noneattention_mask: typing.Optional[torch.Tensor] = Noneposition_ids: typing.Optional[torch.LongTensor] = Nonepast_key_values: transformers.cache_utils.Cache | None = Noneinputs_embeds: typing.Optional[torch.Tensor] = Nonelabels: typing.Optional[torch.LongTensor] = Noneuse_cache: bool | None = Nonelogits_to_keep: typing.Union[int, torch.Tensor] = 0**kwargs: *<class 'transformers.utils.generic.TransformersKwargs'> ) → MoeCausalLMOutputWithPast or tuple(torch.Tensor)

Paramètres

  • input_ids (torch.LongTensor de forme (batch_size, sequence_length), facultatif) — Indices des jetons de la séquence d'entrée dans le vocabulaire. Le bourrage (padding) sera ignoré par défaut.

    Les indices peuvent être obtenus à l'aide de AutoTokenizer. Consultez PreTrainedTokenizer.encode() et PreTrainedTokenizer.call() pour plus de détails.

    Qu'est-ce que les identifiants d'entrée ?

  • attention_mask (torch.Tensor de forme (batch_size, sequence_length), facultatif) — Masque pour éviter d'appliquer l'attention aux indices des jetons de bourrage. Les valeurs du masque sont choisies dans [0, 1]:
    • 1 pour les jetons qui ne sont pas masqués,
    • 0 pour les jetons masqués.

    Qu'est-ce que les masques d'attention ?

  • position_ids (torch.LongTensor de forme (batch_size, sequence_length), facultatif) — Indices des positions des jetons de chaque séquence d'entrée dans les embeddings de position. Sélectionnés dans l'intervalle [0, config.n_positions - 1].

    Qu'est-ce que les identifiants de position ?

  • past_key_values (~cache_utils.Cache, facultatif) — États cachés précalculés (clés et valeurs dans les blocs d'auto-attention et d'attention croisée) qui peuvent être utilisés pour accélérer le décodage séquentiel. Cela consiste généralement en la past_key_values retournée par le modèle à une étape antérieure du décodage, lorsque use_cache=True ou config.use_cache=True.

    Seule une instance de Cache est autorisée en entrée, consultez notre guide du cache kv. Si aucun past_key_values n'est transmis, DynamicCache sera initialisé par défaut.

    Le modèle produira le même format de cache qui est fourni en entrée.

    Si past_key_values sont utilisés, l’utilisateur doit fournir uniquement les input_ids non traités (ceux pour lesquels les états de clés et de valeurs passées n’ont pas été fournis à ce modèle) de forme (batch_size, unprocessed_length) au lieu de tous les input_ids de forme (batch_size, sequence_length).

  • inputs_embeds (torch.Tensor de forme (batch_size, sequence_length, hidden_size), facultatif) — Facultativement, au lieu de passer input_ids, vous pouvez choisir de passer directement une représentation intégrée. Cela est utile si vous souhaitez un meilleur contrôle sur la manière de convertir les indices input_ids en vecteurs associés que la matrice de recherche d’intégration interne du modèle.
  • labels (torch.LongTensor de forme (batch_size, sequence_length), facultatif) — Étiquettes pour le calcul de la perte de modélisation de langage masquée. Les indices doivent être dans [0, ..., config.vocab_size] ou -100 (voir la docstring de input_ids). Les jetons dont l'indice est défini sur -100 sont ignorés (masqués), la perte n'est calculée que pour les jetons dont l'étiquette est dans [0, ..., config.vocab_size].
  • use_cache (bool, facultatif) — Si défini sur True, les états clé-valeur past_key_values sont renvoyés et peuvent être utilisés pour accélérer le décodage (voir past_key_values).
  • logits_to_keep (Union[int, torch.Tensor], facultatif, valeur par défaut 0) — Si c'est un int, calcule les logits pour les logits_to_keep derniers jetons. Si 0, calcule les logits pour tous les input_ids (cas particulier). Seuls les logits du dernier jeton sont nécessaires pour la génération, et les calculer uniquement pour ce jeton peut économiser de la mémoire, ce qui devient assez significatif pour les séquences longues ou les tailles de vocabulaire importantes. Si c'est un torch.Tensor, il doit être 1D et correspondre aux indices à conserver dans la dimension de la longueur de la séquence. Cela est utile lors de l'utilisation du format de tenseurs empilés (une seule dimension pour le lot et la longueur de la séquence).

Retourne

MoeCausalLMOutputWithPast ou tuple(torch.Tensor)

Un MoeCausalLMOutputWithPast ou un tuple de torch.Tensor (si return_dict=False est passé ou lorsque config.return_dict=False) comprenant divers éléments en fonction de la configuration (BeamConfig) et des entrées.

La méthode forward de BeamForCausalLM redéfinit la méthode spéciale __call__.

Bien que la recette de la passe avant doive être définie dans cette fonction, il faut ensuite appeler l'instance Module plutôt que celle-ci, car la première gère l'exécution des étapes de prétraitement et de post-traitement, tandis que la seconde les ignore silencieusement.

  • loss (torch.Tensor de forme (1,), facultatif, renvoyé lorsque labels est fourni) — Perte de modélisation du langage (pour la prédiction du jeton suivant).

  • logits (torch.Tensor de forme (batch_size, sequence_length, config.vocab_size)) — Scores de prédiction de la tête de modélisation du langage (scores pour chaque jeton du vocabulaire avant SoftMax).

  • aux_loss (torch.Tensor, facultatif, renvoyé lorsque output_router_logits=True est passé ou lorsque config.output_router_logits=True, et que le modèle entraîne son routeur avec une perte d’équilibrage de charge) — Perte auxiliaire d’équilibrage de charge pour les modules creux. Les modèles qui équilibrent leurs experts au moyen d’un biais de routeur à la place (DeepSeek-V3 et les architectures dérivées de celui-ci) renvoient None ici tout en renvoyant toujours router_logits.

  • router_logits (tuple(torch.Tensor), facultatif, renvoyé lorsque output_router_logits=True est passé ou lorsque config.output_router_logits=True) — Tuple de torch.Tensor (un pour chaque couche creuse) de forme (batch_size * sequence_length, num_experts).

    Logits bruts du routeur calculés par les routeurs MoE. Ils peuvent être utilisés pour calculer une perte d'équilibrage de charge ou pour inspecter la manière dont les jetons sont acheminés vers les experts.

  • past_key_values (Cache, facultatif, renvoyé lorsque use_cache=True est passé ou lorsque config.use_cache=True) — Il s’agit d’une instance de Cache. Pour plus de détails, consultez notre guide sur le cache kv.

    Contient des états cachés précalculés (clés et valeurs dans les blocs d'auto-attention) qui peuvent être utilisés (voir l'entrée past_key_values) pour accélérer le décodage séquentiel.

  • hidden_states (tuple(torch.Tensor), facultatif, renvoyé lorsque output_hidden_states=True est passé ou lorsque config.output_hidden_states=True) — Tuple de torch.Tensor (un pour la sortie des embeddings, si le modèle possède une couche d’embedding, + un pour la sortie de chaque couche) de forme (batch_size, sequence_length, hidden_size).

    États cachés du modèle à la sortie de chaque couche, ainsi que les sorties d'incorporation initiales facultatives.

  • attentions (tuple(torch.Tensor), facultatif, renvoyé lorsque output_attentions=True est passé ou lorsque config.output_attentions=True) — Tuple de torch.Tensor (un par couche) de forme (batch_size, num_heads, sequence_length, sequence_length).

    Poids des attentions après le softmax d'attention, utilisés pour calculer la moyenne pondérée dans les têtes d'auto-attention.

Exemple :

Update on GitHub