Hugging Face's logo

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

Model ini dipublikasikan di HF papers pada 2024-12-13 dan disumbangkan ke Hugging Face Transformers pada 2025-09-19.

FlashAttention SDPA

Byte Latent Transformer (BLT)

Ikhtisar

Model BLT diusulkan dalam Byte Latent Transformer: Patches Scale Better Than Tokens oleh 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 adalah LLM tingkat byte yang mencapai kinerja tingkat tokenisasi melalui patching dinamis berbasis entropi.

Abstrak dari makalah tersebut adalah sebagai berikut:

Kami memperkenalkan Byte Latent Transformer (BLT), sebuah arsitektur LLM berbasis byte baru yang, untuk pertama kalinya, menyamai kinerja LLM berbasis tokenisasi pada skala besar dengan peningkatan signifikan dalam efisiensi inferensi dan robustness. BLT mengkodekan byte menjadi patch berukuran dinamis, yang berfungsi sebagai unit komputasi utama. Patch disegmentasikan berdasarkan entropi byte berikutnya, mengalokasikan lebih banyak komputasi dan kapasitas model di mana kompleksitas data yang meningkat membutuhkannya. Kami menyajikan studi scaling terkendali flop pertama untuk model berbasis byte hingga 8B parameter dan 4T byte pelatihan. Hasil kami menunjukkan kelayakan scaling model yang dilatih pada byte mentah tanpa kosakata tetap. Baik efisiensi pelatihan maupun inferensi meningkat berkat pemilihan patch panjang secara dinamis ketika data dapat diprediksi, disertai peningkatan kualitatif pada penalaran dan generalisasi long tail. Secara keseluruhan, untuk biaya inferensi yang tetap, BLT menunjukkan scaling yang jauh lebih baik daripada model berbasis tokenisasi, dengan secara simultan meningkatkan ukuran patch dan model.

Tips Penggunaan

  • Arsitektur Model Ganda: BLT terdiri dari dua model terlatih yang terpisah:

    • Patcher (Model Entropi): Model transformer yang lebih kecil yang memprediksi entropi tingkat byte untuk menentukan batas patch dan memsegmentasikan input.
    • Model Transformer Utama: Model utama yang memproses patch melalui Local Encoder, Global Transformer, dan Local Decoder.

  • Patching Dinamis: Model menggunakan patching dinamis berbasis entropi di mana:

    • Wilayah entropi tinggi (data kompleks) mendapatkan patch yang lebih pendek dengan perhatian komputasi yang lebih besar
    • Wilayah entropi rendah (data yang dapat diprediksi) mendapatkan patch yang lebih panjang untuk efisiensi
    • Hal ini memungkinkan model untuk mengalokasikan sumber daya komputasi di tempat yang paling dibutuhkan

  • Local Encoder: Memproses sekuens byte dengan cross-attention ke patch embeddings

  • Global Transformer: Memproses representasi tingkat patch dengan perhatian penuh di seluruh patch

  • Local Decoder: Menghasilkan output dengan cross-attention kembali ke urutan byte asli

  • Byte-Level Tokenizer: Berbeda dengan tokenizer tradisional yang menggunakan kosakata yang dipelajari, tokenizer BLT hanya mengonversi teks menjadi byte UTF-8 dan memetakan setiap byte ke ID token. Tidak diperlukan kosakata.

Model dapat dimuat melalui:

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

Model ini disumbangkan oleh itazap. Kode aslinya dapat ditemukan di sini.

BltConfig

kelas 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 )

Parameter

  • vocab_size (int, opsional, default 260) — Ukuran kosakata model. Menentukan jumlah token berbeda yang dapat direpresentasikan oleh input_ids.
  • max_position_embeddings (int, opsional, default 4096) — Panjang maksimum urutan yang mungkin digunakan dengan model ini.
  • patch_in_forward (bool, opsional, defaultnya True) — Apakah akan melakukan patching selama forward pass.
  • patch_size (int, opsional, default 4) — Ukuran patch yang digunakan dalam mekanisme patching.
  • patching_mode (str, opsional, defaultnya "entropy") — Mode yang digunakan untuk patching, seperti patching berbasis entropi.
  • patching_threshold (float, opsional, default 1.34) — Nilai ambang yang digunakan untuk menentukan kapan menerapkan patch.
  • patching_batch_size (int, opsional, default 1) — Ukuran batch yang digunakan selama proses patching.
  • max_patch_length (int, opsional) — Panjang maksimum patch yang dapat dihasilkan.
  • local_attention_window_len (int, opsional, default 512) — Ukuran jendela perhatian lokal yang digunakan oleh encoder lokal dan decoder lokal, yang sesuai dengan local_attention_window_len di checkpoint yang dirilis. Atur ke None untuk memperhatikan seluruh konteks kausal.
  • cross_attn_k (int, opsional, default 2) — Jumlah kepala cross-attention yang digunakan dalam model.
  • encoder_hash_byte_group_size (list, opsional) — Daftar ukuran grup byte yang digunakan dalam fungsi hash encoder.
  • encoder_hash_byte_group_vocab (int, opsional, default 500002) — Ukuran kosakata untuk grup byte hash encoder.
  • encoder_hash_byte_group_nb_functions (int, opsional, default 1) — Jumlah fungsi hash yang digunakan dalam pengelompokan byte encoder.
  • patcher_config (BltPatcherConfig, opsional) — Konfigurasi untuk komponen patcher dari model.
  • encoder_config (Union[dict, ~configuration_utils.PreTrainedConfig], opsional) — Objek config atau dictionary dari backbone encoder.
  • decoder_config (Union[dict, ~configuration_utils.PreTrainedConfig], opsional) — Objek config atau dictionary dari backbone decoder.
  • global_config (BltGlobalTransformerConfig, opsional) — Konfigurasi untuk komponen transformer global dari model.
  • tie_word_embeddings (bool, opsional, default False) — Apakah akan mengikat bobot embedding sesuai dengan pemetaan tied_weights_keys model.
  • use_cache (bool, opsional, defaultnya True) — Apakah model harus mengembalikan perhatian kunci/nilai terakhir (tidak digunakan oleh semua model). Hanya relevan jika config.is_decoder=True atau ketika model adalah model generatif yang hanya decoder.
  • pad_token_id (int, opsional) — ID token yang digunakan untuk padding dalam kosakata.
  • bos_token_id (int, opsional) — ID token yang digunakan untuk awal aliran (beginning-of-stream) dalam kosakata.
  • eos_token_id (Union[int, list[int]], opsional) — ID token yang digunakan untuk akhir aliran dalam kosakata.
  • initializer_range (float, opsional, defaultnya 0.02) — Standar deviasi dari truncated_normal_initializer untuk menginisialisasi semua matriks bobot.
  • rope_parameters (Union[~modeling_rope_utils.RopeParameters, dict], opsional) — Kamus yang berisi parameter konfigurasi untuk embedding RoPE. Kamus tersebut harus berisi nilai untuk rope_theta dan secara opsional parameter yang digunakan untuk penskalaan jika Anda ingin menggunakan RoPE dengan max_position_embeddings yang lebih panjang.

Ini adalah kelas konfigurasi untuk menyimpan konfigurasi dari BltModel. Kelas ini digunakan untuk membuat instans model Blt berdasarkan argumen yang ditentukan, sehingga mendefinisikan arsitektur model. Membuat instans konfigurasi dengan nilai bawaan akan menghasilkan konfigurasi yang serupa dengan konfigurasi dari itazap/blt-1b-hf

Objek konfigurasi mewarisi dari PreTrainedConfig dan dapat digunakan untuk mengontrol output model. Baca dokumentasi dari PreTrainedConfig untuk informasi lebih lanjut.

Contoh:

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

kelas 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

kelas transformers.BltForCausalLM

< >

( config: BltConfig )

Parameter

  • config (BltConfig) — Kelas konfigurasi model dengan semua parameter model. Inisialisasi dengan file konfigurasi tidak memuat bobot yang terkait dengan model, hanya konfigurasinya. Lihat metode from_pretrained() untuk memuat bobot model.

Model Teks Blt dengan kepala pemodelan bahasa di atasnya.

Model ini mewarisi dari PreTrainedModel. Periksa dokumentasi kelas induk untuk metode generik yang diimplementasikan oleh pustaka untuk semua model (seperti mengunduh atau menyimpan, mengubah ukuran embedding input, memangkas kepala, dll.)

Model ini juga merupakan subclass dari torch.nn.Module PyTorch. Gunakan sebagai PyTorch Module biasa dan merujuk ke dokumentasi PyTorch untuk semua hal yang berkaitan dengan penggunaan dan perilaku umum.

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)

Parameter

  • input_ids (torch.LongTensor dengan bentuk (batch_size, sequence_length), opsional) — Indeks token dari urutan input dalam kosakata. Padding akan diabaikan secara default.

    Indeks dapat diperoleh menggunakan AutoTokenizer. Lihat PreTrainedTokenizer.encode() dan PreTrainedTokenizer.call() untuk detailnya.

    Apa itu input ID?

  • attention_mask (torch.Tensor dengan bentuk (batch_size, sequence_length), opsional) — Mask untuk menghindari eksekusi attention pada indeks token padding. Nilai mask dipilih dari [0, 1]:
    • 1 untuk token yang tidak dimasker,
    • 0 untuk token yang dimasker.

    Apa itu attention mask?

  • position_ids (torch.LongTensor dengan bentuk (batch_size, sequence_length), opsional) — Indeks posisi token dari setiap urutan input dalam position embeddings. Dipilih dalam rentang [0, config.n_positions - 1].

    Apa itu ID posisi?

  • cross_attention_states (torch.Tensor, opsional) — Output dari model visi, digunakan untuk cross-attention. Tensor ini berisi fitur gambar yang telah diproses yang akan diperhatikan oleh model bahasa.
  • cross_attention_mask (torch.Tensor dengan bentuk (batch_size, seq_length, max_num_images, max_num_tiles), opsional) — Cross-attention mask untuk mengontrol interaksi antara token teks dan tile gambar. Tensor 4D ini mendefinisikan tile gambar mana yang harus diperhatikan oleh setiap token teks.

    Untuk setiap token teks (dalam seq_length):

    • 1 menunjukkan bahwa token harus memperhatikan ubin gambar yang sesuai
    • 0 menunjukkan bahwa token tidak harus memperhatikan ubin gambar yang sesuai
  • full_text_row_masked_out_mask (tuple[torch.Tensor, torch.Tensor], opsional) — Tuple yang berisi dua tensor untuk mem-mask baris dalam mekanisme cross-attention:
    • Tensor pertama memiliki bentuk (batch_size, 1, seq_length, 1) dan berisi nilai 0 atau 1. Nilai 0 menunjukkan bahwa seluruh baris untuk token teks yang sesuai dalam matriks cross-attention harus di-mask (semua token gambar diabaikan).
    • Tensor kedua memiliki bentuk yang sama dan digunakan secara internal untuk menerapkan masking selama forward pass dari lapisan cross-attention. Mask ini diturunkan dari cross_attention_mask dan digunakan untuk menangani kasus di mana token teks tidak boleh memperhatikan (attend) token gambar mana pun.
  • past_key_values (~cache_utils.Cache, opsional) — Hidden-states yang sudah dihitung sebelumnya (key dan values di blok self-attention dan di blok cross-attention) yang dapat digunakan untuk mempercepat decoding berurutan. Ini biasanya terdiri dari past_key_values yang dikembalikan oleh model pada tahap decoding sebelumnya, ketika use_cache=True atau config.use_cache=True.

    Hanya instance Cache yang diizinkan sebagai input, lihat panduan kv cache kami. Jika tidak ada past_key_values yang diteruskan, DynamicCache akan diinisialisasi secara default.

    Model akan menghasilkan format cache yang sama dengan yang diberikan sebagai input.

    Jika past_key_values digunakan, pengguna diharapkan hanya memasukkan input_ids yang belum diproses (yang tidak memiliki state past key value yang diberikan ke model ini) dengan bentuk (batch_size, unprocessed_length) alih-alih semua input_ids dengan bentuk (batch_size, sequence_length).

  • inputs_embeds (torch.Tensor dengan bentuk (batch_size, sequence_length, hidden_size), opsional) — Secara opsional, alih-alih meneruskan input_ids, Anda dapat memilih untuk langsung meneruskan representasi tertanam. Hal ini berguna jika Anda ingin memiliki kendali lebih atas cara mengonversi indeks input_ids menjadi vektor terkait, dibandingkan dengan matriks pencarian penanaman internal model.
  • labels (torch.LongTensor dengan bentuk (batch_size, sequence_length), opsional) — Label untuk menghitung kerugian pemodelan bahasa yang disamarkan (masked language modeling). Indeks harus berada dalam [0, ..., config.vocab_size] atau -100 (lihat docstring input_ids). Token dengan indeks yang disetel ke -100 diabaikan (disamarkan), kerugian hanya dihitung untuk token dengan label dalam [0, ..., config.vocab_size].
  • use_cache (bool, opsional) — Jika diset ke True, state kunci-nilai past_key_values akan dikembalikan dan dapat digunakan untuk mempercepat decoding (lihat past_key_values).
  • logits_to_keep (Union[int, torch.Tensor], opsional, default 0) — Jika berupa int, hitung logits untuk logits_to_keep token terakhir. Jika 0, hitung logits untuk semua input_ids (kasus khusus). Hanya logits token terakhir yang diperlukan untuk generasi, dan menghitungnya hanya untuk token tersebut dapat menghemat memori, yang menjadi cukup signifikan untuk urutan panjang atau ukuran kosakata besar. Jika berupa torch.Tensor, harus 1D yang sesuai dengan indeks yang akan dipertahankan pada dimensi panjang urutan. Ini berguna saat menggunakan format tensor terpadu (satu dimensi untuk batch dan panjang urutan).

Mengembalikan

CausalLMOutputWithPast atau tuple(torch.Tensor)

A CausalLMOutputWithPast atau tuple dari torch.Tensor (jika return_dict=False dilewatkan atau ketika config.return_dict=False) yang terdiri dari berbagai elemen tergantung pada konfigurasi (BltConfig) dan input.

Metode forward dari BltForCausalLM menimpa metode khusus __call__.

Meskipun resep untuk forward pass perlu didefinisikan di dalam fungsi ini, sebaiknya panggil instance Module setelahnya alih-alih fungsi ini, karena yang pertama menangani langkah-langkah pra-pemrosesan dan pasca-pemrosesan, sedangkan yang kedua mengabaikannya secara diam-diam.

  • loss (torch.Tensor dengan bentuk (1,), opsional, dikembalikan saat labels disediakan) — Loss pemodelan bahasa (untuk prediksi token berikutnya).

  • logits (torch.Tensor dengan bentuk (batch_size, sequence_length, config.vocab_size)) — Skor prediksi dari kepala pemodelan bahasa (skor untuk setiap token kosakata sebelum SoftMax).

  • past_key_values (Cache, opsional, dikembalikan saat use_cache=True dilewatkan atau saat config.use_cache=True) — Ini adalah instance Cache. Untuk detail lebih lanjut, lihat panduan kv cache kami.

    Berisi hidden-states yang telah dihitung sebelumnya (key dan values di blok self-attention) yang dapat digunakan (lihat input past_key_values) untuk mempercepat decoding berurutan.

  • hidden_states (tuple(torch.Tensor), opsional, dikembalikan saat output_hidden_states=True dilewatkan atau saat config.output_hidden_states=True) — Tuple dari torch.Tensor (satu untuk output dari embeddings, jika model memiliki lapisan embedding, + satu untuk output dari setiap lapisan) dengan bentuk (batch_size, sequence_length, hidden_size).

    Hidden-states model pada output setiap layer ditambah output embedding awal yang opsional.

  • attentions (tuple(torch.Tensor), opsional, dikembalikan saat output_attentions=True dilewatkan atau saat config.output_attentions=True) — Tuple dari torch.Tensor (satu untuk setiap layer) dengan bentuk (batch_size, num_heads, sequence_length, sequence_length).

    Bobot perhatian setelah softmax perhatian, digunakan untuk menghitung rata-rata berbobot di kepala perhatian diri (self-attention).

Contoh:

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

←BLOOM ByT5→