Transformers documentation

Byte Latent Transformer (BLT)

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é publié dans HF papers le 2024-12-13 et ajouté à Hugging Face Transformers le 2025-09-19.

FlashAttention SDPA

Byte Latent Transformer (BLT)

Aperçu

Le modèle BLT a été proposé dans Byte Latent Transformer: Patches Scale Better Than Tokens par Artidoro Pagnoni, Ram Pasunuru, Pedro Rodriguez, John Nguyen, Benjamin Muller, Margaret Li1, Chunting Zhou, Lili Yu, Jason Weston, Luke Zettlemoyer, Gargi Ghosh, Mike Lewis, Ari Holtzman†, Srinivasan Iyer. BLT est un LLM au niveau des octets qui atteint des performances au niveau de la tokenisation grâce à un patching dynamique basé sur l'entropie.

L'abstract de l'article est le suivant :

Nous présentons le Byte Latent Transformer (BLT), une nouvelle architecture de LLM au niveau des octets qui, pour la première fois, égale les performances des LLM basés sur la tokenisation à grande échelle, avec des améliorations significatives de l'efficacité d'inférence et de la robustesse. BLT encode les octets en patches de taille dynamique, qui servent d'unités de calcul principales. Les patches sont segmentés en fonction de l'entropie de l'octet suivant, allouant davantage de calcul et de capacité du modèle là où la complexité accrue des données l'exige. Nous présentons la première étude de mise à l'échelle contrôlée par les flops de modèles au niveau des octets, jusqu'à 8 milliards de paramètres et 4T d'octets d'entraînement. Nos résultats démontrent la faisabilité de mettre à l'échelle des modèles entraînés sur des octets bruts sans vocabulaire fixe. L'efficacité de l'entraînement et de l'inférence s'améliore grâce à la sélection dynamique de patches longs lorsque les données sont prévisibles, ainsi qu'à des améliorations qualitatives en matière de raisonnement et de généralisation sur la longue traîne. Dans l'ensemble, pour des coûts d'inférence fixes, BLT montre une mise à l'échelle nettement meilleure que les modèles basés sur la tokenisation, en augmentant simultanément la taille des patches et celle du modèle.

Conseils d'utilisation

  • Architecture à double modèle : BLT se compose de deux modèles entraînés séparément :

    • Patcher (modèle d'entropie) : un modèle transformer plus petit qui prédit l'entropie au niveau des octets afin de déterminer les limites des patches et de segmenter l'entrée.
    • Modèle Transformer principal : le modèle principal qui traite les patches via un encodeur local, un Transformer global et un décodeur local.
  • Patchage dynamique : le modèle utilise un patchage dynamique basé sur l'entropie, où :

    • Les régions à haute entropie (données complexes) reçoivent des patches plus courts avec une attention computationnelle accrue
    • Les régions à faible entropie (données prévisibles) reçoivent des patches plus longs pour l'efficacité
    • Cela permet au modèle d'allouer les ressources de calcul là où elles sont le plus nécessaires
  • Encodeur local : traite les séquences d'octets avec une attention croisée sur les embeddings de patch

  • Transformeur global : traite les représentations au niveau des patches avec une attention complète entre les patches

  • Décodeur local : génère la sortie avec une attention croisée vers la séquence d'octets d'origine

  • Tokeniseur au niveau octet : Contrairement aux tokeniseurs traditionnels qui utilisent des vocabulaires appris, le tokeniseur de BLT convertit simplement le texte en octets UTF-8 et associe chaque octet à un identifiant de jeton. Aucun vocabulaire n'est nécessaire.

Le modèle peut être chargé via :

<hfoption id="AutoModel">
from transformers import AutoModelForCausalLM, AutoTokenizer


tokenizer = AutoTokenizer.from_pretrained("itazap/blt-1b-hf")
model = AutoModelForCausalLM.from_pretrained(
    "itazap/blt-1b-hf",
    device_map="auto",
)

inputs = tokenizer(prompt, return_tensors="pt").to(model.device)

prompt = "my name is"
generated_ids = model.generate(
    **inputs, max_new_tokens=NUM_TOKENS_TO_GENERATE, do_sample=False, use_cache=False
)

print(tokenizer.decode(generated_ids[0]))
</hfoption>

Ce modèle a été contribué par itazap. Le code d'origine peut être trouvé ici.

BltConfig

classe transformers.BltConfig

< >

( 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 = 260max_position_embeddings: int = 4096patch_in_forward: bool | None = Truepatch_size: int | None = 4patching_mode: str | None = 'entropy'patching_threshold: float | None = 1.335442066192627patching_batch_size: int | None = 1max_patch_length: int | None = Nonelocal_attention_window_len: int | None = 512cross_attn_k: int | None = 2encoder_hash_byte_group_size: list[int] | None = Noneencoder_hash_byte_group_vocab: int | None = 500002encoder_hash_byte_group_nb_functions: int | None = 1patcher_config: dict | transformers.configuration_utils.PreTrainedConfig | None = Noneencoder_config: dict | transformers.configuration_utils.PreTrainedConfig | None = Nonedecoder_config: dict | transformers.configuration_utils.PreTrainedConfig | None = Noneglobal_config: dict | transformers.configuration_utils.PreTrainedConfig | None = Nonetie_word_embeddings: bool = Falseuse_cache: bool = Truepad_token_id: int | None = Nonebos_token_id: int | None = Noneeos_token_id: int | list[int] | None = Noneinitializer_range: float = 0.02rope_parameters: transformers.modeling_rope_utils.RopeParameters | dict | None = None )

Paramètres

  • vocab_size (int, facultatif, par défaut 260) — Taille du vocabulaire du modèle. Définit le nombre de jetons différents qui peuvent être représentés par input_ids.
  • max_position_embeddings (int, facultatif, par défaut 4096) — La longueur de séquence maximale avec laquelle ce modèle pourrait être utilisé.
  • patch_in_forward (bool, facultatif, par défaut True) — Indique s'il faut effectuer le patching lors de la passe avant.
  • patch_size (int, facultatif, valeur par défaut 4) — Taille des patches utilisés dans le mécanisme de patching.
  • patching_mode (str, facultatif, par défaut "entropy") — Le mode utilisé pour le patching, tel que le patching basé sur l'entropie.
  • patching_threshold (float, facultatif, valeur par défaut 1.34) — Valeur seuil utilisée pour déterminer quand appliquer des correctifs.
  • patching_batch_size (int, facultatif, valeur par défaut 1) — Taille de lot utilisée pendant le processus de patching.
  • max_patch_length (int, facultatif) — Longueur maximale des patches qui peuvent être générés.
  • local_attention_window_len (int, facultatif, valeur par défaut 512) — Taille de la fenêtre d'attention locale utilisée par l'encodeur local et le décodeur local, correspondant à local_attention_window_len dans les points de contrôle publiés. Définir sur None pour porter l'attention sur le contexte causal complet.
  • cross_attn_k (int, facultatif, valeur par défaut 2) — Nombre de têtes d'attention croisée utilisées dans le modèle.
  • encoder_hash_byte_group_size (list, facultatif) — Liste des tailles de groupes d’octets utilisées dans la fonction de hachage de l’encodeur.
  • encoder_hash_byte_group_vocab (int, facultatif, valeur par défaut 500002) — Taille du vocabulaire pour les groupes d'octets de hachage de l'encodeur.
  • encoder_hash_byte_group_nb_functions (int, facultatif, valeur par défaut : 1) — Nombre de fonctions de hachage utilisées dans le regroupement des octets de l'encodeur.
  • patcher_config (BltPatcherConfig, facultatif) — Configuration du composant patcher du modèle.
  • encoder_config (Union[dict, ~configuration_utils.PreTrainedConfig], facultatif) — L'objet de configuration ou le dictionnaire du backbone de l'encodeur.
  • decoder_config (Union[dict, ~configuration_utils.PreTrainedConfig], facultatif) — L’objet de configuration ou le dictionnaire du backbone du décodeur.
  • global_config (BltGlobalTransformerConfig, facultatif) — Configuration du composant transformer global du modèle.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.

Ceci est la classe de configuration destinée à stocker la configuration d'un BltModel. Elle est utilisée pour instancier un modèle Blt 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 de itazap/blt-1b-hf

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.

Exemple :

>>> from transformers import BltModel, BltConfig

>>> # Initializing a Blt configuration
>>> configuration = BltConfig()

>>> # Initializing a model from the configuration
>>> model = BltModel(configuration)

>>> # Accessing the model configuration
>>> configuration = model.config

classe transformers.BltModel

< >

( config: BltConfig )

forward

< >

( input_ids: typing.Optional[torch.LongTensor] = Nonepatch_lengths: typing.Optional[torch.Tensor] = 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'> )

BltForCausalLM

classe transformers.BltForCausalLM

< >

( config: BltConfig )

Paramètres

  • config (BltConfig) — 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 Blt Text avec une tête de modélisation de langage 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] = Nonecross_attention_states: typing.Optional[torch.LongTensor] = Nonecross_attention_mask: typing.Optional[torch.LongTensor] = Nonefull_text_row_masked_out_mask: tuple[torch.Tensor, torch.Tensor] | None = 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'> ) → CausalLMOutputWithPast 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 ?

  • cross_attention_states (torch.Tensor, facultatif) — Sortie du modèle de vision, utilisée pour l'attention croisée. Ce tenseur contient les caractéristiques d'image traitées auxquelles le modèle de langage va prêter attention.
  • cross_attention_mask (torch.Tensor de forme (batch_size, seq_length, max_num_images, max_num_tiles), facultatif) — Masque de cross-attention pour contrôler l'interaction entre les jetons de texte et les tuiles d'image. Ce tenseur 4D définit les tuiles d'image auxquelles chaque jeton de texte doit prêter attention.

    Pour chaque jeton de texte (dans seq_length) :

    • 1 indique que le jeton doit prêter attention à la tuile d'image correspondante
    • 0 indique que le jeton ne doit pas prêter attention à la tuile d'image correspondante
  • full_text_row_masked_out_mask (tuple[torch.Tensor, torch.Tensor], facultatif) — Un tuple contenant deux tenseurs qui masquent des lignes dans le mécanisme d'attention croisée :
    • Le premier tenseur a la forme (batch_size, 1, seq_length, 1) et contient des valeurs de 0 ou 1. Une valeur de 0 indique que la ligne entière du jeton de texte correspondant dans la matrice d'attention croisée doit être masquée (tous les jetons d'image sont ignorés).
    • Le second tenseur a la même forme et est utilisé en interne pour appliquer le masquage pendant le passage avant des couches d'attention croisée. Ce masque est dérivé de cross_attention_mask et est utilisé pour gérer les cas où un jeton de texte ne doit pas prêter attention à aucun jeton d'image.
  • 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

CausalLMOutputWithPast ou tuple(torch.Tensor)

Un CausalLMOutputWithPast 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 (BltConfig) et des entrées.

La méthode forward de BltForCausalLM 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).

  • 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 :

>>> from transformers import AutoTokenizer, BltForCausalLM

>>> model = BltForCausalLM.from_pretrained("itazap/blt-1b-hf")
>>> tokenizer = AutoTokenizer.from_pretrained("itazap/blt-1b-hf")

>>> prompt = "If I had to write a haiku, it would be:"
>>> inputs = tokenizer(prompt, return_tensors="pt")

>>> # Generate
>>> generate_ids = model.generate(inputs.input_ids, max_length=40, do_sample=True, temperature=0.6)
>>> result = tokenizer.batch_decode(generate_ids, skip_special_tokens=True, clean_up_tokenization_spaces=False)[0]
>>> print(result)
If I had to write a haiku, it would be: "Snowflakes gently fall" - simple, yet peaceful.
I love the idea of snowflakes gently falling, each one
Update on GitHub