Hugging Face's logo

Transformers documentation

Mamba 2

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-05-31 dan disumbangkan ke Hugging Face Transformers pada 2024-08-06.

Mamba 2

Mamba 2 didasarkan pada kerangka kerja dualitas ruang keadaan (SSD) yang menghubungkan model ruang keadaan terstruktur (SSM) dan varian perhatian. Ia menggunakan algoritma SSD yang lebih efisien, yaitu 2-8 kali lebih cepat daripada Mamba, serta memodifikasi arsitektur untuk memungkinkan paralelisme tensor dan struktur kepala perhatian nilai berkelompok (GVA).

Anda dapat menemukan semua checkpoint Mamba 2 asli di bawah organisasi State Space Models, tetapi contoh yang ditunjukkan di bawah ini menggunakan mistralai/Mamba-Codestral-7B-v0.1 karena implementasi Hugging Face belum didukung untuk checkpoint asli.

Arsitektur berbasis Mamba 2 lainnya meliputi Bamba, FalconH1, dan Zamba2.

Model ini disumbangkan oleh ArthurZ. 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
from transformers import pipeline


pipeline = pipeline(
    task="text-generation",
    model="mistralai/Mamba-Codestral-7B-v0.1",
    device=0
)
pipeline("Plants create energy through a process known as")

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 transformers import AutoModelForCausalLM, AutoTokenizer, TorchAoConfig


quantization_config = TorchAoConfig("int4_weight_only", group_size=128)
tokenizer = AutoTokenizer.from_pretrained("mistralai/Mamba-Codestral-7B-v0.1")
model = AutoModelForCausalLM.from_pretrained("mistralai/Mamba-Codestral-7B-v0.1", 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

  • Codestral Mamba memiliki groups=8 yang mirip dengan jumlah kv heads pada model berbasis attention.

  • Codestral Mamba memiliki dua jalur forward yang berbeda, torch_forward atau cuda_kernels_forward, dan hasilnya diharapkan sedikit berbeda.

    • torch_forward tanpa kompilasi 3-4 kali lebih cepat daripada cuda_kernels_forward.
    • cuda_kernels_forward menggunakan kernel CUDA asli jika tersedia di lingkungan Anda. Proses ini lebih lambat saat prefill karena memerlukan “warmup run” akibat overhead CPU yang lebih tinggi (lihat ini komentar untuk detail lebih lanjut).

  • Tidak ada positional embeddings dalam model ini, tetapi terdapat attention_mask dan logika spesifik untuk mem-mask hidden states di dua tempat dalam kasus batched generation (lihat komentar ini untuk detail lebih lanjut). Hal ini (dan penambahan kernel Mamba 2 yang diimplementasikan ulang) menyebabkan sedikit perbedaan antara batched dan cached generation.

  • Algoritma SSM sangat bergantung pada kontraksi tensor, yang memiliki ekuivalen matmul tetapi urutan operasinya sedikit berbeda. Hal ini membuat perbedaannya lebih besar pada presisi yang lebih kecil.

  • Padding hanya diuji dengan padding kiri. Padding kanan memperbarui cache dengan posisi pad dan memberikan hasil yang tidak dapat diandalkan. Atur tokenizer.padding_side="left" untuk generasi batch. Lihat Sisi padding.

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

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


model_id = "mistralai/Mamba-Codestral-7B-v0.1"
dataset = load_dataset("Abirate/english_quotes", split="train")
training_args = SFTConfig(dataset_text_field="quote", gradient_checkpointing=True, per_device_train_batch_size=4)
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()

Mamba2Config

kelas transformers.Mamba2Config

< >

( 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 = Nonenum_heads: int = 128head_dim: int = 64vocab_size: int = 32768hidden_size: int = 4096state_size: int = 128num_hidden_layers: int = 64layer_norm_epsilon: float = 1e-05pad_token_id: int | None = 1bos_token_id: int | None = 0eos_token_id: int | list[int] | None = 2expand: int = 2conv_kernel: int = 4n_groups: int = 8use_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_min: float = 0.001time_step_max: float = 0.1time_step_floor: float = 0.0001time_step_limit: list[float] | tuple[float, ...] = (0.0, inf)rescale_prenorm_residual: bool = Falseuse_cache: bool = Truechunk_size: int = 256tie_word_embeddings: bool = False )

Parameter

  • num_heads (int, opsional, default 128) — Jumlah kepala perhatian untuk setiap lapisan perhatian dalam decoder Transformer.
  • head_dim (int, opsional, default 64) — Dimensi head perhatian. Jika None, nilainya akan default ke hidden_size // num_attention_heads
  • vocab_size (int, opsional, default 32768) — Ukuran kosakata model. Menentukan jumlah token berbeda yang dapat direpresentasikan oleh input_ids.
  • hidden_size (int, opsional, default 4096) — Dimensi dari representasi tersembunyi.
  • state_size (int, opsional, default 128) — Ukuran state SSM (dimensi state laten) pada lapisan Mamba.
  • num_hidden_layers (int, opsional, default 64) — 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 1) — 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 2) — 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.
  • n_groups (int, opsional, defaultnya 8) — Jumlah grup untuk matriks evolusi dari mamba 2.
  • 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_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_floor (float, opsional, default 0.0001) — Nilai minimum yang diizinkan untuk delta langkah waktu diskret setelah aktivasi softplus.
  • time_step_limit (Union[list[float], tuple[float, ...]], opsional, defaultnya (0.0, inf)) — Rentang nilai time step yang diterima untuk clamping.
  • 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.
  • chunk_size (int, opsional, defaultnya 256) — Ukuran chunk yang akan membentuk urutan.
  • tie_word_embeddings (bool, opsional, default False) — Apakah akan mengikat bobot embedding sesuai dengan pemetaan tied_weights_keys model.

Ini adalah kelas konfigurasi untuk menyimpan konfigurasi dari Mamba2Model. Kelas ini digunakan untuk membuat instans model Mamba2 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/mamba2-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 Mamba2Config, Mamba2Model

>>> # Initializing a Mamba2 configuration
>>> configuration = Mamba2Config()

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

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

Mamba2Model

kelas transformers.Mamba2Model

< >

( config: Mamba2Config )

Parameter

  • config (Mamba2Config) — 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 Mamba2 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

< >

( 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.Tensor] = None**kwargs ) → Mamba2Output or tuple(torch.FloatTensor)

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

Mengembalikan

Mamba2Output atau tuple(torch.FloatTensor)

Mamba2Output atau tuple dari torch.FloatTensor (jika return_dict=False diteruskan atau ketika config.return_dict=False) yang terdiri dari berbagai elemen tergantung pada konfigurasi (Mamba2Config) dan input.

Metode forward dari Mamba2Model 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.FloatTensor 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.FloatTensor], opsional, dikembalikan saat output_hidden_states=True dilewatkan atau saat config.output_hidden_states=True) — Tuple dari torch.FloatTensor (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.

Mamba2LMHeadModel

kelas transformers.Mamba2ForCausalLM

< >

( config: Mamba2Config )

Parameter

  • config (Mamba2Config) — 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 MAMBA2 dengan kepala pemodelan bahasa di atasnya (lapisan linear dengan bobot yang tidak terikat ke embedding input).

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] = Noneinputs_embeds: typing.Optional[torch.FloatTensor] = 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 = Noneattention_mask: typing.Optional[torch.Tensor] = Nonelogits_to_keep: typing.Union[int, torch.Tensor] = 0**kwargs ) → Mamba2CausalLMOutput or tuple(torch.FloatTensor)

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.FloatTensor 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.
  • 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?

  • 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

Mamba2CausalLMOutput atau tuple(torch.FloatTensor)

Mamba2CausalLMOutput atau tuple dari torch.FloatTensor (jika return_dict=False diteruskan atau ketika config.return_dict=False) yang terdiri dari berbagai elemen tergantung pada konfigurasi (Mamba2Config) dan input.

Metode forward dari Mamba2ForCausalLM 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.FloatTensor dengan bentuk (1,), opsional, dikembalikan saat labels disediakan) — Loss pemodelan bahasa (untuk prediksi token berikutnya).

  • logits (torch.FloatTensor 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.FloatTensor], opsional, dikembalikan saat output_hidden_states=True dilewatkan atau saat config.output_hidden_states=True) — Tuple dari torch.FloatTensor (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

←Mamba MarianMT→