Hugging Face's logo

Transformers documentation

FalconMamba

You are viewing main version, which requires installation from source. If you'd like regular pip install, checkout the latest stable version (v5.22.2).
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-10-07 dan disumbangkan ke Hugging Face Transformers pada 2024-08-12.

FalconMamba

FalconMamba adalah model bahasa besar 7B, tersedia dalam varian pra-terlatih dan terlatih instruksi, yang didasarkan pada Mamba. Model ini mengimplementasikan desain Mamba murni yang berfokus pada efisiensi komputasi sambil mempertahankan kinerja yang kuat. FalconMamba jauh lebih cepat saat inferensi dan membutuhkan memori yang jauh lebih sedikit untuk generasi sekuens panjang. Model-model ini dipra-terlatih pada dataset 5,8T token yang beragam, termasuk RefinedWeb, konten teknis, kode, dan data matematika.

Anda dapat menemukan checkpoint resmi FalconMamba dalam koleksi FalconMamba 7B.

Klik model FalconMamba di bilah sisi kanan untuk melihat lebih banyak contoh cara menerapkan FalconMamba ke berbagai tugas bahasa.

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

Pipeline
AutoModel
CLI transformers
from transformers import pipeline


pipeline = pipeline(
    "text-generation",
    model="tiiuae/falcon-mamba-7b-instruct",
    device=0
)
pipeline(
    "Explain the difference between transformers and SSMs",
    max_length=100,
    do_sample=True,
    temperature=0.7
)

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 bitsandbytes untuk mengkuantisasi bobot menjadi 4-bit.

from transformers import AutoTokenizer, BitsAndBytesConfig, FalconMambaForCausalLM


quantization_config = BitsAndBytesConfig(
    load_in_4bit=True,
    bnb_4bit_quant_type="nf4",
    bnb_4bit_use_double_quant=True,
)

tokenizer = AutoTokenizer.from_pretrained("tiiuae/falcon-mamba-7b")
model = FalconMambaForCausalLM.from_pretrained(
    "tiiuae/falcon-mamba-7b",
    device_map="auto",
    quantization_config=quantization_config,
)

inputs = tokenizer("Explain the concept of state space models in simple terms", return_tensors="pt").to(model.device)
outputs = model.generate(**inputs, max_new_tokens=100)
print(tokenizer.decode(outputs[0], skip_special_tokens=True))

Catatan

  • Gunakan padding kiri untuk generasi batched. Lihat Sisi padding.

FalconMambaConfig

kelas transformers.FalconMambaConfig

< >

( 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 = Truemixer_rms_eps: float = 1e-06 )

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, defaultnya 1e-05) — Epsilon yang digunakan oleh 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, default 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.
  • mixer_rms_eps (float, opsional, default 1e-06) — Nilai epsilon untuk RMS norm yang digunakan dalam Mixer RMS norm untuk state B, C, dan dt.

Ini adalah kelas konfigurasi untuk menyimpan konfigurasi dari FalconMambaModel. Kelas ini digunakan untuk membuat instans model Falcon Mamba sesuai dengan argumen yang ditentukan, yang mendefinisikan arsitektur model. Membuat instans konfigurasi dengan nilai bawaan akan menghasilkan konfigurasi yang serupa dengan konfigurasi dari tiiuae/falcon-mamba-7b

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

Contoh:

>>> from transformers import FalconMambaConfig, FalconMambaModel

>>> # Initializing a FalconMamba configuration
>>> configuration = FalconMambaConfig()

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

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

FalconMambaModel

kelas transformers.FalconMambaModel

< >

( config: FalconMambaConfig )

Parameter

  • config (FalconMambaConfig) — 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 Falcon 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

< >

( 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 ) → FalconMambaOutput 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

FalconMambaOutput atau tuple(torch.Tensor)

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

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

FalconMambaLMHeadModel

kelas transformers.FalconMambaForCausalLM

< >

( config: FalconMambaConfig )

Parameter

  • config (FalconMambaConfig) — 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 FALCON_MAMBA dengan kepala pemodelan bahasa di atasnya (lapisan linear dengan bobot yang 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] = 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 ) → FalconMambaCausalLMOutput 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

FalconMambaCausalLMOutput atau tuple(torch.Tensor)

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

Metode forward dari FalconMambaForCausalLM 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

←FalconH1 FLAN-T5→