Transformers documentation

Mamba

Transformers

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

Join the Hugging Face community

and get access to the augmented documentation experience

Collaborate on models, datasets and Spaces

Faster examples with accelerated inference

Switch between documentation themes

to get started

Model ini dipublikasikan di HF papers pada 2023-12-01 dan disumbangkan ke Hugging Face Transformers pada 2024-03-05.

Mamba

Mamba adalah model ruang keadaan terstruktur selektif (SSMs) yang dirancang untuk mengatasi inefisiensi komputasi Transformers saat menangani urutan panjang. Arsitekturnya sepenuhnya bebas perhatian (attention-free) dan terdiri dari kombinasi blok H3 dan MLP bergerbang (blok Mamba). “Penalaran berbasis konten” Mamba memungkinkannya untuk berfokus pada bagian tertentu dari input tergantung pada token saat ini. Mamba juga menggunakan algoritma paralel baru yang sadar perangkat keras untuk mengompensasi ketiadaan operasi konvolusional. Akibatnya, Mamba memiliki inferensi yang cepat dan dapat diskalakan ke urutan yang sangat panjang.

Anda dapat menemukan semua checkpoint Mamba asli di bawah organisasi State Space Models.

Model ini disumbangkan oleh Molbap dan AntonV. Klik model Mamba di bilah sisi kanan untuk melihat lebih banyak contoh penerapan Mamba pada berbagai tugas bahasa.

Contoh di bawah ini menunjukkan cara menghasilkan teks dengan Pipeline, AutoModel, dan dari baris perintah.

Pipeline

AutoModel

Quantization mengurangi beban memori model besar dengan merepresentasikan bobot dalam presisi yang lebih rendah. Lihat ringkasan Quantization untuk backend quantization lain yang tersedia.

Contoh di bawah menggunakan torchao untuk hanya mengkuantisasi bobot menjadi bilangan bulat 4-bit.

from torchao.quantization import Int4WeightOnlyConfig

from transformers import AutoModelForCausalLM, AutoTokenizer, TorchAoConfig


quantization_config = Int4WeightOnlyConfig(group_size=128)
quantization_config = TorchAoConfig(quant_type=quant_config)
tokenizer = AutoTokenizer.from_pretrained("state-spaces/mamba-2.8b-hf")
model = AutoModelForCausalLM.from_pretrained("state-spaces/mamba-2.8b-hf", quantization_config=quantization_config, device_map="auto")
input_ids = tokenizer("Plants create energy through a process known as", return_tensors="pt").to(model.device)

output = model.generate(**input_ids)
print(tokenizer.decode(output[0], skip_special_tokens=True))

Catatan

Implementasi saat ini menggunakan kernel CUDA asli. Implementasi ekuivalen FlashAttention dihosting di repositori mamba-ssm dan causal_conv1d. Pastikan untuk menginstalnya jika perangkat keras Anda mendukungnya!
Mamba menumpuk lapisan mixer yang ekuivalen dengan lapisan Attention. Anda dapat menemukan logika utama Mamba di kelas MambaMixer.

Contoh di bawah ini menunjukkan cara melakukan fine-tuning Mamba dengan PEFT.

from datasets import load_dataset
from trl import SFTConfig, SFTTrainer
from peft import LoraConfig

model_id = "state-spaces/mamba-130m-hf"
dataset = load_dataset("Abirate/english_quotes", split="train")
training_args = SFTConfig(dataset_text_field="quote")
lora_config =  LoraConfig(target_modules=["x_proj", "embeddings", "in_proj", "out_proj"])
trainer = SFTTrainer(
    model=model_id,
    args=training_args,
    train_dataset=dataset,
    peft_config=lora_config,
)
trainer.train()

Gunakan padding kiri untuk generasi batched. Lihat Sisi padding.

MambaConfig

kelas transformers.MambaConfig

< source >

( 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 = 50280hidden_size: int = 768state_size: int = 16num_hidden_layers: int = 32layer_norm_epsilon: float = 1e-05pad_token_id: int | None = 0bos_token_id: int | None = 0eos_token_id: int | list[int] | None = 0expand: int = 2conv_kernel: int = 4use_bias: bool = Falseuse_conv_bias: bool = Truehidden_act: str = 'silu'initializer_range: float = 0.1residual_in_fp32: bool = Truetime_step_rank: str | int = 'auto'time_step_scale: float = 1.0time_step_min: float = 0.001time_step_max: float = 0.1time_step_init_scheme: str = 'random'time_step_floor: float = 0.0001rescale_prenorm_residual: bool = Falseuse_cache: bool = Trueuse_mambapy: bool = Falseuse_associative_scan: bool = Truetie_word_embeddings: bool = True )

Parameter

vocab_size (int, opsional, default 50280) — Ukuran kosakata model. Menentukan jumlah token berbeda yang dapat direpresentasikan oleh input_ids.
hidden_size (int, opsional, default 768) — Dimensi dari representasi tersembunyi.
state_size (int, opsional, default 16) — Ukuran state SSM (dimensi state laten) pada lapisan Mamba.
num_hidden_layers (int, opsional, default 32) — Jumlah lapisan tersembunyi dalam decoder Transformer.
layer_norm_epsilon (float, opsional, default 1e-05) — Nilai epsilon yang digunakan pada lapisan normalisasi lapisan.
pad_token_id (int, opsional, default 0) — ID token yang digunakan untuk padding dalam kosakata.
bos_token_id (int, opsional, default 0) — ID token yang digunakan untuk awal aliran (beginning-of-stream) dalam kosakata.
eos_token_id (Union[int, list[int]], opsional, default 0) — ID token yang digunakan untuk end-of-stream dalam kosakata.
expand (int, opsional, defaultnya 2) — Faktor ekspansi yang digunakan untuk menentukan ukuran antara.
conv_kernel (int, opsional, defaultnya 4) — Ukuran kernel konvolusi.
use_bias (bool, opsional, default False) — Apakah akan menggunakan bias pada [“in_proj”, “out_proj”] dari blok mixer
use_conv_bias (bool, opsional, default True) — Apakah akan menggunakan bias pada lapisan konvolusi dari blok mixer.
hidden_act (str, opsional, defaultnya silu) — Fungsi aktivasi non-linear (fungsi atau string) di decoder. Misalnya, "gelu", "relu", "silu", dan sebagainya.
initializer_range (float, opsional, defaultnya 0.1) — Standar deviasi dari truncated_normal_initializer untuk menginisialisasi semua matriks bobot.
residual_in_fp32 (bool, opsional, defaultnya True) — Apakah residual harus dalam float32. Jika diatur ke False, residual akan mempertahankan dtype yang sama dengan bagian lain dari model
time_step_rank (Union[str, int], opsional, default auto) — Rank dari proyeksi delta (time step). Bisa diset ke "auto" untuk menentukannya secara otomatis.
time_step_scale (float, opsional, default 1.0) — Skala yang diterapkan pada delta langkah waktu sebelum diskretisasi.
time_step_min (float, opsional, default 0.001) — time_step minimum yang digunakan untuk membatasi dt_proj.bias.
time_step_max (float, opsional, default 0.1) — time_step maksimum yang digunakan untuk membatasi dt_proj.bias.
time_step_init_scheme (str, opsional, default random) — Skema inisialisasi untuk delta langkah waktu. Bisa berupa "random" atau "uniform".
time_step_floor (float, opsional, default 0.0001) — Nilai minimum yang diizinkan untuk delta langkah waktu diskret setelah aktivasi softplus.
rescale_prenorm_residual (bool, opsional, default False) — Apakah akan melakukan penskalaan ulang bobot out_proj saat inisialisasi.
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.
use_mambapy (bool, opsional, default False) — Menentukan strategi fallback selama pelatihan jika implementasi resmi Mamba berbasis CUDA tidak tersedia. Jika True, implementasi mamba.py yang digunakan. Jika False, implementasi naif dan lebih lambat yang digunakan. Pertimbangkan untuk beralih ke versi naif jika memori terbatas.
use_associative_scan (bool, opsional, default True) — Apakah akan menggunakan torch._higher_order_ops.associative_scan dari PyTorch untuk parallel scan alih-alih implementasi sequential naif. Associative scan hanya aktif selama tracing torch.compile dan memerlukan torch >= 2.9.0. Kedua jalur diuji untuk menghasilkan hasil yang identik secara numerik (lihat test_associative_scan_matches_sequential). Atur ke False untuk kembali ke loop sequential.
tie_word_embeddings (bool, opsional, default True) — Apakah akan mengikat bobot embedding sesuai dengan pemetaan tied_weights_keys model.

Ini adalah kelas konfigurasi untuk menyimpan konfigurasi dari MambaModel. Kelas ini digunakan untuk membuat instans model Mamba sesuai dengan argumen yang ditentukan, sehingga mendefinisikan arsitektur model. Membuat instans konfigurasi dengan nilai bawaan akan menghasilkan konfigurasi yang serupa dengan konfigurasi dari state-spaces/mamba-2.8b

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

Contoh:

>>> from transformers import MambaConfig, MambaModel

>>> # Initializing a Mamba configuration
>>> configuration = MambaConfig()

>>> # Initializing a model (with random weights) from the configuration
>>> model = MambaModel(configuration)

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

MambaModel

kelas transformers.MambaModel

< source >

( config: MambaConfig )

Parameter

config (MambaConfig) — 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 Mamba polos yang menghasilkan hidden-states mentah tanpa head spesifik 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

< source >

( input_ids: typing.Optional[torch.LongTensor] = Noneinputs_embeds: typing.Optional[torch.LongTensor] = Nonecache_params: transformers.cache_utils.Cache | None = Noneuse_cache: bool | None = Noneoutput_hidden_states: bool | None = Nonereturn_dict: bool | None = Noneattention_mask: typing.Optional[torch.LongTensor] = None**kwargs ) → MambaOutput 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?
inputs_embeds (torch.LongTensor 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.
cache_params (Cache, opsional) — Jika diteruskan, model menggunakan keadaan sebelumnya di semua blok (yang akan memberikan output untuk input_ids yang diberikan seolah-olah model menambahkan state_input_ids + input_ids sebagai konteks).
use_cache (bool, opsional) — Jika diset ke True, cache_params akan dikembalikan dan dapat digunakan untuk dengan cepat menghasilkan logits berikutnya.
output_hidden_states (bool, opsional) — Apakah akan mengembalikan hidden states dari semua lapisan. Lihat hidden_states di bawah tensor yang dikembalikan untuk detail lebih lanjut.
return_dict (bool, opsional) — Apakah akan mengembalikan ModelOutput alih-alih tuple biasa.
attention_mask (torch.LongTensor 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?

Mengembalikan

MambaOutput atau tuple(torch.Tensor)

MambaOutput atau tuple dari torch.Tensor (jika return_dict=False diteruskan atau ketika config.return_dict=False) yang terdiri dari berbagai elemen tergantung pada konfigurasi (MambaConfig) dan input.

Metode forward dari MambaModel 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.

last_hidden_state (torch.Tensor dengan bentuk (batch_size, sequence_length, hidden_size), opsional) — Urutan hidden-states pada keluaran lapisan terakhir model.
cache_params (~cache_utils.Cache, opsional) — Status model pada langkah waktu terakhir. Dapat digunakan dalam metode forward dengan input_ids berikutnya untuk menghindari penyediaan input_ids lama.

Termasuk matriks state model State space setelah selective scan, dan state Konvolusional
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.

MambaLMHeadModel

kelas transformers.MambaForCausalLM

< source >

( config: MambaConfig )

Parameter

config (MambaConfig) — 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.

Transformer model MAMBA dengan kepala pemodelan bahasa di atasnya (lapisan linear dengan bobot yang terikat ke embedding input).

forward

< source >

( input_ids: typing.Optional[torch.LongTensor] = Noneattention_mask: typing.Optional[torch.LongTensor] = Noneinputs_embeds: typing.Optional[torch.Tensor] = Nonecache_params: transformers.cache_utils.Cache | None = Nonelabels: typing.Optional[torch.LongTensor] = Noneoutput_hidden_states: bool | None = Nonereturn_dict: bool | None = Noneuse_cache: bool | None = Nonelogits_to_keep: typing.Union[int, torch.Tensor] = 0**kwargs ) → MambaCausalLMOutput 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.LongTensor 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?
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.
cache_params (Cache, opsional) — Jika diteruskan, model menggunakan keadaan sebelumnya di semua blok (yang akan memberikan output untuk input_ids yang diberikan seolah-olah model menambahkan state_input_ids + input_ids sebagai konteks).
labels (torch.LongTensor dengan bentuk (batch_size, sequence_length), opsional) — Label untuk pemodelan bahasa. Perhatikan bahwa label digeser di dalam model, yaitu Anda dapat mengatur labels = input_ids Indeks dipilih dalam [-100, 0, ..., config.vocab_size] Semua label yang diatur ke -100 diabaikan (dipertahankan), loss hanya dihitung untuk label dalam [0, ..., config.vocab_size]
output_hidden_states (bool, opsional) — Apakah akan mengembalikan hidden states dari semua lapisan. Lihat hidden_states di bawah tensor yang dikembalikan untuk detail lebih lanjut.
return_dict (bool, opsional) — Apakah akan mengembalikan ModelOutput alih-alih tuple biasa.
use_cache (bool, opsional) — Jika diset ke True, cache_params akan dikembalikan dan dapat digunakan untuk dengan cepat menghasilkan logits berikutnya.
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

MambaCausalLMOutput atau tuple(torch.Tensor)

MambaCausalLMOutput atau tuple dari torch.Tensor (jika return_dict=False diteruskan atau ketika config.return_dict=False) yang terdiri dari berbagai elemen tergantung pada konfigurasi (MambaConfig) dan input.

Metode forward dari MambaForCausalLM 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).
cache_params (~cache_utils.Cache, opsional) — Status model pada langkah waktu terakhir. Dapat digunakan dalam metode forward dengan input_ids berikutnya untuk menghindari penyediaan input_ids lama.

Termasuk matriks state model State space setelah selective scan, dan state Konvolusional
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.

Contoh:

Update on GitHub

←MADLAD-400 Mamba2→