# Byte Latent Transformer (BLT)

## 概要

BLTモデルは、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 による [Byte Latent Transformer: Patches Scale Better Than Tokens](https://huggingface.co/papers/2412.09871) で提案されました。BLTは、エントロピーベースの動的パッチングを通じて、トークナイズレベルの性能を実現するバイトレベルのLLMです。

論文の抄録は以下の通りです。

*バイトレベルのLLMアーキテクチャであるByte Latent Transformer (BLT) を紹介します。BLT は、トークナイゼーションベースのLLMと同等の性能を大規模な設定で初めて達成するとともに、推論効率と頑健性を大幅に向上させます。BLT はバイトを動的なサイズのパッチにエンコードし、これらを計算の主要な単位として扱います。パッチは次バイトのエントロピーに基づいて分割され、データの複雑さが増す部分にはより多くの計算リソースとモデル容量が割り当てられます。本研究では、8Bパラメータおよび4Tの学習バイトまでのバイトレベルモデルについて、初めてフロップス制御されたスケーリング研究を提示します。結果は、固定語彙なしで生バイトを学習したモデルのスケーリングが実現可能であることを示しています。データが予測可能な場合に長いパッチを動的に選択することで、学習効率と推論効率の両方が向上し、推論能力やロングテール汎化においても定性的な改善が見られます。全体として、推論コストを固定した場合、BLT はパッチサイズとモデルサイズを同時に拡大することで、トークナイゼーションベースのモデルよりもはるかに優れたスケーリング特性を示します。*

## 使用のコツ

- **デュアルモデルアーキテクチャ**: BLTは、2つの独立して学習されたモデルで構成されています:
  - **Patcher (エントロピーモデル)**: バイトレベルのエントロピーを予測してパッチの境界を決定し、入力をセグメント化する、より小型の Transformer モデルです。
  - **Main Transformer Model**: パッチを Local Encoder、Global Transformer、Local Decoder を通じて処理する主要なモデル。

- **動的パッチング**: モデルはエントロピーベースの動的パッチングを使用します。
  - 高エントロピー領域（複雑なデータ）には、より短いパッチが割り当てられ、より多くの計算リソースが注がれます
  - 低エントロピー領域（予測可能なデータ）には、効率化のために長いパッチが割り当てられます
  - これにより、モデルは最も必要とされる箇所に計算リソースを割り当てることができます。

- **ローカルエンコーダー**: クロスアテンションを用いて、バイトシーケンスをパッチ埋め込みに対して処理します
- **Global Transformer**: パッチレベルの表現を、パッチ全体にわたる完全なアテンションで処理します
- **ローカルデコーダー**: 元のバイト列へのクロスアテンションを用いて出力を生成します

- **Byte-Level Tokenizer**: 学習済み語彙を使用する従来のトークナイザーとは異なり、BLTのトークナイザーはテキストをUTF-8バイトに変換し、各バイトをトークンIDにマッピングするだけです。語彙は不要です。

モデルは以下のように読み込むことができます:

```python
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]))
```

このモデルは [itazap](https://huggingface.co/) によって提供されました。元のコードは [こちら]() で確認できます。

## BltConfig[[transformers.BltConfig]]

#### transformers.BltConfig[[transformers.BltConfig]]

```python
transformers.BltConfig(transformers_version: str | None = None, architectures: list[str] | None = None, output_hidden_states: bool | None = False, return_dict: bool | None = True, dtype: str | torch.dtype | None = 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: Literal['regression', 'single_label_classification', 'multi_label_classification'] | None = None, vocab_size: int = 260, max_position_embeddings: int = 4096, patch_in_forward: bool | None = True, patch_size: int | None = 4, patching_mode: str | None = 'entropy', patching_threshold: float | None = 1.335442066192627, patching_batch_size: int | None = 1, max_patch_length: int | None = None, cross_attn_k: int | None = 2, encoder_hash_byte_group_size: list[int] | None = None, encoder_hash_byte_group_vocab: int | None = 500002, encoder_hash_byte_group_nb_functions: int | None = 1, patcher_config: dict | transformers.configuration_utils.PreTrainedConfig | None = None, encoder_config: dict | transformers.configuration_utils.PreTrainedConfig | None = None, decoder_config: dict | transformers.configuration_utils.PreTrainedConfig | None = None, global_config: dict | transformers.configuration_utils.PreTrainedConfig | None = None, tie_word_embeddings: bool = False, use_cache: bool = True, pad_token_id: int | None = None, bos_token_id: int | None = None, eos_token_id: int | list[int] | None = None, initializer_range: float = 0.02, rope_parameters: transformers.modeling_rope_utils.RopeParameters | dict | None = None)
```

[ソース](https://github.com/huggingface/transformers/blob/main/src/transformers/models/blt/configuration_blt.py#L165)

**パラメータ:**

vocab_size (`int`、*任意*、デフォルトは`260`) : モデルの語彙サイズ。`input_ids`で表現できるトークンの種類数を定義します。

max_position_embeddings (`int`、*任意*、デフォルトは`4096`) : このモデルが使用される可能性のある最大シーケンス長です。

patch_in_forward (`bool`、*任意*、デフォルトは`True`) : フォワードパス中にパッチングを実行するかどうか。

patch_size (`int`, *任意*, デフォルトは 4) : パッチング機構で使用されるパッチのサイズ。

patching_mode (`str`、*任意*、デフォルトは`"entropy"`) : エントロピーベースのパッチングなど、パッチングに使用するモード。

patching_threshold (`float`、*任意*、デフォルト値は 1.34) : パッチを適用するタイミングを判定するために使用される閾値。

patching_batch_size (`int`、*optional*、デフォルトは 1) : パッチング処理中に使用されるバッチサイズ。

max_patch_length (`int`, *任意*) : 生成可能なパッチの最大長。

cross_attn_k (`int`、*任意*、デフォルトは 2) : モデルで使用されるクロスアテンションヘッドの数。

encoder_hash_byte_group_size (`list`, *任意*) : エンコーダーのハッシュ関数で使用するバイトグループサイズのリスト。

encoder_hash_byte_group_vocab (`int`, *optional*, デフォルトは 500002) : エンコーダーのハッシュバイトグループの語彙サイズ。

encoder_hash_byte_group_nb_functions (`int`、*optional*、デフォルトは 1) : エンコーダーのバイトグループ化で使用されるハッシュ関数の数。

patcher_config (`BltPatcherConfig`、*任意*) : モデルの patcher コンポーネントの設定。

encoder_config (`Union[dict, ~configuration_utils.PreTrainedConfig]`、*optional*) : エンコーダーのバックボーンの設定オブジェクトまたは辞書。

decoder_config (`Union[dict, ~configuration_utils.PreTrainedConfig]`、*optional*) : デコーダーのバックボーンの設定オブジェクトまたは辞書。

global_config (`BltGlobalTransformerConfig`、*任意*) : モデルのグローバルトランスフォーマーコンポーネントの設定。

tie_word_embeddings (`bool`, *任意*, デフォルトは `False`) : モデルの `tied_weights_keys` マッピングに従って重み埋め込みを共有するかどうか。

use_cache (`bool`、*任意*、デフォルトは `True`) : モデルが最後のキー/バリューアテンションを返すかどうか（すべてのモデルで利用されるわけではありません）。`config.is_decoder=True` の場合、またはモデルがデコーダー専用の生成モデルである場合にのみ関連します。

pad_token_id (`int`, *任意*) : 語彙内でパディングに使用されるトークンID。

bos_token_id (`int`, *任意*) : 語彙内でストリームの開始に使用されるトークン ID。

eos_token_id (`Union[int, list[int]]`、*任意*) : 語彙内でストリームの終了に使用されるトークン ID。

initializer_range (`float`、*任意*、デフォルトは`0.02`) : すべての重み行列を初期化するためのtruncated_normal_initializerの標準偏差です。

rope_parameters (`Union[~modeling_rope_utils.RopeParameters, dict]`, *optional*) : RoPE 埋め込みの設定パラメータを含む辞書です。この辞書には `rope_theta` の値が含まれていなければならず、より長い `max_position_embeddings` で RoPE を使用する場合、スケーリングに使用されるパラメータが任意で含まれます。

これは [itazap/blt-1b-hf](https://huggingface.co/itazap/blt-1b-hf) と同様の設定をデフォルト値で生成する、BltModel の設定を保存するための設定クラスです。指定された引数に基づいて Blt モデルをインスタンス化し、モデルのアーキテクチャを定義するために使用されます。

設定オブジェクトは [PreTrainedConfig](/docs/transformers/main/ja/main_classes/configuration#transformers.PreTrainedConfig) を継承し、モデルの出力を制御するために使用できます。詳細については、[PreTrainedConfig](/docs/transformers/main/ja/main_classes/configuration#transformers.PreTrainedConfig) のドキュメントを参照してください。

例:
```python
>>> 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
```

#### transformers.BltModel[[transformers.BltModel]]

```python
transformers.BltModel(config: BltConfig)
```

[ソース](https://github.com/huggingface/transformers/blob/main/src/transformers/models/blt/modeling_blt.py#L1143)

#### forward[[transformers.BltModel.forward]]

```python
forward(input_ids: typing.Optional[torch.LongTensor] = None, patch_lengths: typing.Optional[torch.Tensor] = None, attention_mask: typing.Optional[torch.Tensor] = None, position_ids: typing.Optional[torch.LongTensor] = None, past_key_values: transformers.cache_utils.Cache | None = None, inputs_embeds: typing.Optional[torch.FloatTensor] = None, use_cache: bool | None = None, **kwargs: *<class 'transformers.utils.generic.TransformersKwargs'>)
```

[ソース](https://github.com/huggingface/transformers/blob/main/src/transformers/models/blt/modeling_blt.py#L1164)

## BltForCausalLM[[transformers.BltForCausalLM]]

#### transformers.BltForCausalLM[[transformers.BltForCausalLM]]

```python
transformers.BltForCausalLM(config: BltConfig)
```

[ソース](https://github.com/huggingface/transformers/blob/main/src/transformers/models/blt/modeling_blt.py#L1323)

**パラメータ:**

config ([BltConfig](/docs/transformers/main/ja/model_doc/blt#transformers.BltConfig)) : モデルのパラメータをすべて含むモデル設定クラス。設定ファイルで初期化しても、モデルに関連する重みは読み込まれず、設定のみが読み込まれます。モデルの重みをロードするには、[from_pretrained()](/docs/transformers/main/ja/main_classes/model#transformers.PreTrainedModel.from_pretrained) メソッドを確認してください。

言語モデリングヘッドを上部に備えたBlt Text Model。

このモデルは [PreTrainedModel](/docs/transformers/main/ja/main_classes/model#transformers.PreTrainedModel) を継承しています。ライブラリがすべてのモデルに対して実装している汎用的なメソッド（ダウンロードや保存、入力埋め込みのリサイズ、ヘッドのプルーニングなど）については、スーパークラスのドキュメントを参照してください。

このモデルは、PyTorchの[torch.nn.Module](https://pytorch.org/docs/stable/nn.html#torch.nn.Module)のサブクラスでもあります。通常のPyTorch Moduleとして使用し、一般的な使用方法や動作に関する詳細については、PyTorchのドキュメントを参照してください。

#### forward[[transformers.BltForCausalLM.forward]]

```python
forward(input_ids: typing.Optional[torch.LongTensor] = None, attention_mask: typing.Optional[torch.Tensor] = None, position_ids: typing.Optional[torch.LongTensor] = None, cross_attention_states: typing.Optional[torch.LongTensor] = None, cross_attention_mask: typing.Optional[torch.LongTensor] = None, full_text_row_masked_out_mask: tuple[torch.Tensor, torch.Tensor] | None = None, past_key_values: transformers.cache_utils.Cache | None = None, inputs_embeds: typing.Optional[torch.FloatTensor] = None, labels: typing.Optional[torch.LongTensor] = None, use_cache: bool | None = None, logits_to_keep: typing.Union[int, torch.Tensor] = 0, **kwargs: *<class 'transformers.utils.generic.TransformersKwargs'>)
```

[ソース](https://github.com/huggingface/transformers/blob/main/src/transformers/models/blt/modeling_blt.py#L1338)

**パラメータ:**

input_ids (`torch.LongTensor`、shape `(batch_size, sequence_length)`、*任意*) : 語彙における入力シーケンスのトークンインデックスです。デフォルトでは、パディングは無視されます。インデックスは [AutoTokenizer](/docs/transformers/main/ja/model_doc/auto#transformers.AutoTokenizer) を使用して取得できます。詳細については、[PreTrainedTokenizer.encode()](/docs/transformers/main/ja/internal/tokenization_utils#transformers.PreTrainedTokenizerBase.encode) および [PreTrainedTokenizer.__call__()](/docs/transformers/main/ja/internal/tokenization_utils#transformers.PreTrainedTokenizerBase.__call__) を参照してください。 [入力IDとは何ですか？](../glossary#input-ids)

attention_mask (`torch.Tensor`、shape `(batch_size, sequence_length)`、*任意*) : padding トークンのインデックスに対する attention を回避するためのマスクです。マスクの値は `[0, 1]` から選択されます:  - **マスクされない**トークンは 1、- **マスクされる**トークンは 0。  [attention マスクとは?](../glossary#attention-mask)

position_ids (`torch.LongTensor`、shape `(batch_size, sequence_length)`、*任意*) : 各入力シーケンスのトークンが位置埋め込み内で占める位置のインデックスです。`[0, config.n_positions - 1]` の範囲から選択されます。 [位置 ID とは何か？](../glossary#position-ids)

cross_attention_states (`torch.FloatTensor`, *任意*) : ビジョンモデルの出力で、クロスアテンションに使用されます。このテンソルには、言語モデルがアテンションを向ける処理済みの画像特徴が含まれています。

cross_attention_mask (`torch.Tensor`、shape `(batch_size, seq_length, max_num_images, max_num_tiles)`、*optional*) : テキストトークンと画像タイル間の相互作用を制御するためのクロスアテンションマスクです。この4次元テンソルは、各テキストトークンがどの画像タイルにアテンションを向けるべきかを定義します。各テキストトークン（seq_length 内）について、- 1 は、対応する画像タイルに**アテンションを向けるべき**であることを示します - 0 は、対応する画像タイルに**アテンションを向けない**ことを示します

full_text_row_masked_out_mask (`tuple[torch.Tensor, torch.Tensor]`, *任意*) : クロスアテンション機構において行をマスクする2つのテンソルを含むタプルです。 - 最初のテンソルは形状が`(batch_size, 1, seq_length, 1)`で、0または1の値を含みます。値が0の場合、対応するテキストトークンのクロスアテンション行列における行全体がマスクされることを示します（すべての画像トークルが無視されます）。 - 2番目のテンソルは同じ形状を持ち、クロスアテンション層のフォワードパス中にマスクを適用するために内部で使用されます。このマスクはcross_attention_maskから導出され、テキストトークルがどの画像トークルにもアテンションすべきでないケースを処理するために使用されます。

past_key_values (`~cache_utils.Cache`, *任意*) : 逐次デコードを高速化するために使用できる、事前計算された hidden-states（self-attention ブロックおよび cross-attention ブロック内の key と value）です。通常、`use_cache=True` または `config.use_cache=True` の場合、モデルがデコードの以前の段階で返した `past_key_values` で構成されます。入力として許可されるのは [Cache](/docs/transformers/main/ja/internal/generation_utils#transformers.Cache) インスタンスのみです。[kv cache ガイド](https://huggingface.co/docs/transformers/en/kv_cache)を参照してください。`past_key_values` が渡されない場合、デフォルトで [DynamicCache](/docs/transformers/main/ja/internal/generation_utils#transformers.DynamicCache) が初期化されます。モデルは、入力として与えられたのと同じキャッシュ形式を出力します。`past_key_values` を使用する場合は、すべての `input_ids`（形状 `(batch_size, sequence_length)`）の代わりに、このモデルに過去の key value 状態が与えられていない未処理の `input_ids`（形状 `(batch_size, unprocessed_length)`）のみを入力する必要があります。

inputs_embeds (`torch.FloatTensor`、shape `(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 だけで十分であり、そのトークンのみについて計算することでメモリを節約できます。これは、長いシーケンスや大規模な語彙サイズの場合に特に顕著な効果があります。`torch.Tensor` の場合、シーケンス長次元で保持するインデックスに対応する 1 次元である必要があります。これは、パックされたテンソル形式（バッチとシーケンス長を単一の次元にまとめる形式）を使用する場合に有用です。

**戻り値:** [CausalLMOutputWithPast](/docs/transformers/main/ja/main_classes/output#transformers.modeling_outputs.CausalLMOutputWithPast) または `tuple(torch.FloatTensor)`

[BltConfig](/docs/transformers/main/ja/model_doc/blt#transformers.BltConfig) や入力に応じて、さまざまな要素で構成される [CausalLMOutputWithPast](/docs/transformers/main/ja/main_classes/output#transformers.modeling_outputs.CausalLMOutputWithPast) または `torch.FloatTensor` のタプル(`return_dict=False` が渡された場合、または `config.return_dict=False` の場合)。

[BltForCausalLM](/docs/transformers/main/ja/model_doc/blt#transformers.BltForCausalLM) の forward メソッドは、`__call__` という特殊メソッドをオーバーライドします。

この関数内でフォワードパスの手順を定義する必要がありますが、その後、この関数ではなく`Module`インスタンスを呼び出すべきです。前者は前処理と後処理の実行を適切に処理するのに対し、後者はそれらを無視してしまいます。

- **loss** (`torch.FloatTensor`、shape `(1,)`、*optional*、`labels` が指定された場合に返されます) -- 言語モデリングの損失(次のトークンの予測用)。
- **logits** (`torch.FloatTensor`、shape `(batch_size, sequence_length, config.vocab_size)`) -- 言語モデリングヘッドの予測スコア（SoftMax 適用前の各語彙トークンのスコア）。
- **past_key_values** (`Cache`、*任意*、`use_cache=True` が渡された場合または `config.use_cache=True` の場合に返されます) -- [Cache](/docs/transformers/main/ja/internal/generation_utils#transformers.Cache) のインスタンスです。詳細については、[kv cache ガイド](https://huggingface.co/docs/transformers/en/kv_cache)を参照してください。

  逐次デコーディングを高速化するために使用できる（`past_key_values` 入力参照）、事前計算済みの隠れ状態（自己注意ブロックのキーとバリュー）が含まれます。
- **hidden_states** (`tuple(torch.FloatTensor)`、*optional*、`output_hidden_states=True` が渡された場合または `config.output_hidden_states=True` の場合に返されます) -- `torch.FloatTensor` のタプル（埋め込み層を持つモデルの場合、埋め込みの出力用が 1 つ、各層の出力用が 1 つずつ）で、形状は `(batch_size, sequence_length, hidden_size)` です。

  各層の出力におけるモデルのHidden-states、および任意の初期埋め込み出力。
- **attentions** (`tuple(torch.FloatTensor)`、*optional*、`output_attentions=True` が渡された場合または `config.output_attentions=True` の場合に返されます) -- `torch.FloatTensor` のタプル（各レイヤーごとに1つ）で、形状は `(batch_size, num_heads, sequence_length, sequence_length)` です。

  アテンションのsoftmax後のアテンション重み。自己アテンションヘッド内で加重平均を計算するために使用されます。

例:

```python
>>> 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
```