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

Bu model 2023-12-01 tarihinde HF papers'ta yayımlandı ve 2024-03-05 tarihinde Hugging Face Transformers'a katkıda bulunuldu.

Mamba

Mamba, uzun dizilerle uğraşırken Transformers'ın hesaplama verimsizliğini aşmak üzere tasarlanmış seçici yapılandırılmış durum uzayı modelidir (SSM). Tamamen dikkat (attention) içermeyen bir mimariye sahiptir ve H3 ile kapılı MLP bloklarının (Mamba bloğu) bir kombinasyonundan oluşur. Mamba'nın "içerik tabanlı çıkarım" yeteneği, modelin mevcut token'a bağlı olarak girdinin belirli kısımlarına odaklanmasını sağlar. Mamba ayrıca, konvolüsyonel işlemlerin yokluğunu telafi etmek için yeni bir donanım duyarlı paralel algoritma kullanır. Sonuç olarak Mamba, hızlı çıkarım (inference) sunar ve çok uzun dizilere ölçeklenebilir.

Tüm orijinal Mamba kontrol noktalarını State Space Models kuruluşu altında bulabilirsiniz.

Bu model Molbap ve AntonV tarafından katkıda bulunmuştur. Mamba'nın farklı dil görevlerine nasıl uygulanacağına dair daha fazla örnek için sağ kenar çubuğundaki Mamba modellerine tıklayın.

Aşağıdaki örnek, Pipeline, AutoModel ve komut satırından metin üretmenin nasıl yapılacağını göstermektedir.

Pipeline

AutoModel

Quantization, ağırlıkları daha düşük bir hassasiyetle temsil ederek büyük modellerin bellek yükünü azaltır. Daha fazla kullanılabilir quantization backend'i için Quantization genel bakışına başvurun.

Aşağıdaki örnek, ağırlıkları yalnızca 4 bit tamsayılara kuantize etmek için torchao kullanır.

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

Notlar

Mevcut uygulama, orijinal CUDA çekirdeklerini kullanır. FlashAttention eşdeğeri uygulama, mamba-ssm ve causal_conv1d depolarında barındırılmaktadır. Donanımınız destekliyorsa bunları kurduğunuzdan emin olun!
Mamba yığınları, Attention katmanlarına eşdeğer olan mixer katmanlarını kullanır. Mamba'nın ana mantığı MambaMixer sınıfında bulunur.

Aşağıdaki örnek, Mamba'nın PEFT ile nasıl ince ayarlanacağını göstermektedir.

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

Toplu üretim için sol dolguyu kullanın. Dolgu tarafı bölümüne bakın.

MambaConfig

sınıf 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 )

Parametreler

vocab_size (int, isteğe bağlı, varsayılan 50280) — Modelin sözlük boyutu. input_ids ile temsil edilebilecek farklı token sayısını belirler.
hidden_size (int, isteğe bağlı, varsayılan 768) — Gizli temsillerin boyutu.
state_size (int, isteğe bağlı, varsayılan 16) — Mamba katmanlarında SSM durumunun boyutu (gizli durum boyutu).
num_hidden_layers (int, isteğe bağlı, varsayılan 32) — Transformer çözücüdeki gizli katman sayısı.
layer_norm_epsilon (float, isteğe bağlı, varsayılan 1e-05) — Katman normalizasyonu katmanlarında kullanılacak epsilon değeri.
pad_token_id (int, isteğe bağlı, varsayılan 0) — Sözlükte dolgu için kullanılan token kimliği.
bos_token_id (int, isteğe bağlı, varsayılan 0) — Sözlükte akış başlangıcı için kullanılan token kimliği.
eos_token_id (Union[int, list[int]], isteğe bağlı, varsayılan 0) — Sözlükte akış sonu için kullanılan token kimliği.
expand (int, isteğe bağlı, varsayılan 2) — Ara boyutu belirlemek için kullanılan genişletme çarpanı.
conv_kernel (int, isteğe bağlı, varsayılan 4) — Konvolüsyon çekirdeğinin boyutu.
use_bias (bool, isteğe bağlı, varsayılan False) — Mixer bloğunun [“in_proj”, “out_proj”] bileşenlerinde bias kullanılıp kullanılmayacağı
use_conv_bias (bool, isteğe bağlı, varsayılan True) — Mixer bloğundaki konvolüsyon katmanında bias kullanılıp kullanılmayacağı.
hidden_act (str, isteğe bağlı, varsayılan silu) — Çözücüdeki doğrusal olmayan aktivasyon fonksiyonu (fonksiyon veya dize). Örneğin, "gelu", "relu", "silu" vb.
initializer_range (float, isteğe bağlı, varsayılan 0.1) — Tüm ağırlık matrislerini başlatmak için kullanılan truncated_normal_initializer'ın standart sapması.
residual_in_fp32 (bool, isteğe bağlı, varsayılan True) — Residüllerin float32 içinde tutulup tutulmayacağı. False olarak ayarlanırsa residüller, modelin geri kalanıyla aynı dtype değerini korur.
time_step_rank (Union[str, int], isteğe bağlı, varsayılan auto) — Delta (zaman adımı) projeksiyonunun rütbesi. Otomatik olarak ayarlamak için "auto" olabilir.
time_step_scale (float, isteğe bağlı, varsayılan 1.0) — Ayrıklaştırma (discretization) öncesinde zaman adımı farkına (time step delta) uygulanan ölçek.
time_step_min (float, isteğe bağlı, varsayılan 0.001) — dt_proj.bias için sınır olarak kullanılan minimum time_step.
time_step_max (float, isteğe bağlı, varsayılan 0.1) — dt_proj.bias için sınır olarak kullanılan maksimum time_step.
time_step_init_scheme (str, isteğe bağlı, varsayılan random) — Zaman adımı farkı için başlatma şeması. "random" veya "uniform" olabilir.
time_step_floor (float, isteğe bağlı, varsayılan 0.0001) — Softplus aktivasyonu sonrası ayrık zaman adımı farkı için izin verilen minimum değer.
rescale_prenorm_residual (bool, isteğe bağlı, varsayılan False) — Başlatma sırasında out_proj ağırlıklarının yeniden ölçeklendirilip ölçeklendirilmeyeceğini belirtir.
use_cache (bool, isteğe bağlı, varsayılan True) — Modelin son anahtar/değer dikkatlerini (tüm modellerde kullanılmaz) döndürüp döndürmeyeceği. Yalnızca config.is_decoder=True olduğunda veya model yalnızca çözücü tabanlı üretken bir model olduğunda geçerlidir.
use_mambapy (bool, isteğe bağlı, varsayılan False) — Mamba'nın CUDA tabanlı resmi uygulaması kullanılamadığında eğitim sırasında yedek stratejiyi belirler. True ise mamba.py uygulaması kullanılır. False ise basit ve daha yavaş uygulama kullanılır. Bellek sınırlıysa basit sürüme geçmeyi düşünün.
use_associative_scan (bool, isteğe bağlı, varsayılan True) — Sıradan ardışık uygulama yerine paralel tarama için PyTorch'un torch._higher_order_ops.associative_scan işlevinin kullanılıp kullanılmayacağını belirtir. İlişkisel tarama yalnızca torch.compile izleme sırasında etkin olur ve torch >= 2.9.0 gerektirir. Her iki yolun da sayısal olarak aynı sonuçları ürettiği test edilmiştir (bkz. test_associative_scan_matches_sequential). Ardışık döngüye geri dönmek için False olarak ayarlayın.
tie_word_embeddings (bool, isteğe bağlı, varsayılan True) — Modelin tied_weights_keys eşlemesine göre ağırlık gömme bağlamalarının yapılıp yapılmayacağı.

Bu, bir MambaModel yapılandırmasını depolamak için kullanılan yapılandırma sınıfıdır. Belirtilen argümanlara göre bir Mamba modelini örneklemek ve model mimarisini tanımlamak için kullanılır. Varsayılan değerlerle bir yapılandırma örneği oluşturmak, state-spaces/mamba-2.8b ile benzer bir yapılandırmaya yol açar.

Yapılandırma nesneleri PreTrainedConfig sınıfından devralır ve model çıktılarını kontrol etmek için kullanılabilir. Daha fazla bilgi için PreTrainedConfig belgesini okuyun.

Örnek:

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

sınıf transformers.MambaModel

< source >

( config: MambaConfig )

Parametreler

config (MambaConfig) — Modelin tüm parametrelerini içeren model yapılandırma sınıfı. Bir yapılandırma dosyasıyla başlatmak, modelle ilişkili ağırlıkları yüklemez, yalnızca yapılandırmayı yükler. Model ağırlıklarını yüklemek için from_pretrained() yöntemine bakın.

Üzerinde herhangi bir özel head olmadan ham hidden-state çıktısı üreten çıplak Mamba Model.

Bu model PreTrainedModel sınıfından devralır. Kütüphanenin tüm modelleri için uyguladığı genel yöntemler (indirme veya kaydetme, giriş gömme boyutlarını yeniden boyutlandırma, başları budama vb.) için üst sınıf belgelendirmesine bakın.

Bu model aynı zamanda bir PyTorch torch.nn.Module alt sınıfıdır. Bunu standart bir PyTorch Module olarak kullanın ve genel kullanım ve davranışla ilgili tüm konular için PyTorch dokümantasyonuna başvurun.

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

Parametreler

input_ids (torch.LongTensor şeklinde (batch_size, sequence_length), isteğe bağlı) — Sözlükteki girdi dizisi belirteçlerinin (token) indeksleri. Varsayılan olarak dolgu (padding) yok sayılır.
Dizinler AutoTokenizer kullanılarak elde edilebilir. Ayrıntılar için PreTrainedTokenizer.encode() ve PreTrainedTokenizer.call() konularına bakın.

Girdi kimlikleri nelerdir?
inputs_embeds (torch.LongTensor, şekli (batch_size, sequence_length, hidden_size), isteğe bağlı) — İsteğe bağlı olarak, input_ids yerine gömülü bir temsil doğrudan geçmeyi tercih edebilirsiniz. Bu, input_ids dizinlerini ilgili vektörlere dönüştürme biçimi üzerinde modelin dahili gömme arama matrisinden daha fazla kontrol sahibi olmak istiyorsanız faydalıdır.
cache_params (Cache, isteğe bağlı) — Verilirse, model tüm bloklarda önceki durumu kullanır (bu, modelin state_input_ids + input_ids bağlamını eklediği varsayımıyla, sağlanan input_ids için çıktıyı verir).
use_cache (bool, isteğe bağlı) — True olarak ayarlanırsa, cache_params döndürülür ve bir sonraki logits'leri hızlıca üretmek için kullanılabilir.
output_hidden_states (bool, isteğe bağlı) — Tüm katmanların gizli durumlarının (hidden states) döndürülüp döndürülmeyeceğini belirtir. Daha fazla ayrıntı için döndürülen tensörler altındaki hidden_states bölümüne bakın.
return_dict (bool, isteğe bağlı) — Düz bir tuple yerine ModelOutput döndürülecek mi?
attention_mask (torch.LongTensor şeklinde (batch_size, sequence_length), isteğe bağlı) — Doldurma (padding) token indekslerinde dikkat (attention) işlemi yapmaktan kaçınmak için kullanılan maske. Seçilen maske değerleri [0, 1]:
- 1, maskelenmemiş jetonlar için,
- maskelenmiş jetonlar için 0.
Dikkat maskeleri nedir?

Dönüş değeri

MambaOutput veya tuple(torch.FloatTensor)

MambaOutput veya torch.FloatTensor bir demeti (return_dict=False geçirildiğinde veya config.return_dict=False olduğunda), yapılandırmaya (MambaConfig) ve girdilere bağlı olarak çeşitli öğelerden oluşur.

MambaModel forward metodu, __call__ özel metodunu geçersiz kılar.

İleri geçiş tarifi bu fonksiyon içinde tanımlanmalı olsa da, sonrasında bunun yerine Module örneğini çağırmak gerekir; çünkü önceki, ön ve son işleme adımlarını çalıştırmaktan sorumluyken ikincisi bunları sessizce yok sayar.

last_hidden_state (torch.FloatTensor, şekli (batch_size, sequence_length, hidden_size), isteğe bağlı) — Modelin son katmanının çıktısındaki gizli durumlar dizisi.
cache_params (~cache_utils.Cache, isteğe bağlı) — Modelin son zaman adımındaki durumu. Eski input_ids değerlerini tekrar sağlamak zorunluluğunu ortadan kaldırmak için, bir forward metodunda bir sonraki input_ids ile birlikte kullanılabilir.

Seçici taramadan sonraki Durum Uzayı Modeli durum matrislerinin yanı sıra Konvolüsyonel durumları da içerir
hidden_states (tuple[torch.FloatTensor], isteğe bağlı, output_hidden_states=True geçirildiğinde veya config.output_hidden_states=True olduğunda döndürülür) — torch.FloatTensor (modelin bir gömme katmanı varsa gömme katmanının çıktısı için bir tane + her katmanın çıktısı için birer tane) içeren, (batch_size, sequence_length, hidden_size) biçiminde bir demet.

Her katmanın çıktısında modelin gizli durumları ve isteğe bağlı başlangıç gömme çıktıları.

MambaLMHeadModel

sınıf transformers.MambaForCausalLM

< source >

( config: MambaConfig )

Parametreler

config (MambaConfig) — Modelin tüm parametrelerini içeren model yapılandırma sınıfı. Bir yapılandırma dosyasıyla başlatmak, modelle ilişkili ağırlıkları yüklemez, yalnızca yapılandırmayı yükler. Model ağırlıklarını yüklemek için from_pretrained() yöntemine bakın.

Üzerinde bir dil modelleme başlığı (giriş gömme vektörleriyle ağırlıkları bağlı olan doğrusal bir katman) bulunan MAMBA Model dönüştürücüsü.

forward

< source >

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

Parametreler

input_ids (torch.LongTensor şeklinde (batch_size, sequence_length), isteğe bağlı) — Sözlükteki girdi dizisi belirteçlerinin (token) indeksleri. Varsayılan olarak dolgu (padding) yok sayılır.
Dizinler AutoTokenizer kullanılarak elde edilebilir. Ayrıntılar için PreTrainedTokenizer.encode() ve PreTrainedTokenizer.call() konularına bakın.

Girdi kimlikleri nelerdir?
attention_mask (torch.LongTensor şeklinde (batch_size, sequence_length), isteğe bağlı) — Doldurma (padding) token indekslerinde dikkat (attention) işlemi yapmaktan kaçınmak için kullanılan maske. Seçilen maske değerleri [0, 1]:
- 1, maskelenmemiş jetonlar için,
- maskelenmiş jetonlar için 0.
Dikkat maskeleri nedir?
inputs_embeds (torch.FloatTensor, şekli (batch_size, sequence_length, hidden_size), isteğe bağlı) — İsteğe bağlı olarak, input_ids yerine gömülü bir temsil doğrudan geçmeyi tercih edebilirsiniz. Bu, input_ids dizinlerini ilgili vektörlere dönüştürme biçimi üzerinde modelin dahili gömme arama matrisine kıyasla daha fazla kontrol sahibi olmak istiyorsanız faydalıdır.
cache_params (Cache, isteğe bağlı) — Verilirse, model tüm bloklarda önceki durumu kullanır (bu, modelin state_input_ids + input_ids bağlamını eklediği varsayımıyla, sağlanan input_ids için çıktıyı verir).
labels (torch.LongTensor, şekli (batch_size, sequence_length), isteğe bağlı) — Dil modelleme için etiketler. Not: Etiketler model içinde kaydırılır, yani labels = input_ids olarak ayarlayabilirsiniz. İndisler [-100, 0, ..., config.vocab_size] aralığından seçilir. -100 olarak ayarlanan tüm etiketler yoksayılır (maske uygulanır), kayıp yalnızca [0, ..., config.vocab_size] aralığındaki etiketler için hesaplanır.
output_hidden_states (bool, isteğe bağlı) — Tüm katmanların gizli durumlarının (hidden states) döndürülüp döndürülmeyeceğini belirtir. Daha fazla ayrıntı için döndürülen tensörler altındaki hidden_states bölümüne bakın.
return_dict (bool, isteğe bağlı) — Düz bir tuple yerine ModelOutput döndürülecek mi?
use_cache (bool, isteğe bağlı) — True olarak ayarlanırsa, cache_params döndürülür ve bir sonraki logits'leri hızlıca üretmek için kullanılabilir.
logits_to_keep (Union[int, torch.Tensor], isteğe bağlı, varsayılan 0) — int ise, son logits_to_keep token için logits hesaplanır. 0 ise, tüm input_ids için logits hesaplanır (özel durum). Üretim için yalnızca son token logits'leri gereklidir ve bunların yalnızca o token için hesaplanması bellek tasarrufu sağlar; bu, uzun diziler veya büyük sözlük boyutu için oldukça önemli hale gelir. torch.Tensor ise, dizi uzunluğu boyutundaki korunacak indekslere karşılık gelen 1B olmalıdır. Bu, paketlenmiş tensor biçimini (batch ve dizi uzunluğu için tek boyut) kullanırken faydalıdır.

Dönüş değeri

MambaCausalLMOutput veya tuple(torch.FloatTensor)

MambaCausalLMOutput veya torch.FloatTensor bir demeti (return_dict=False geçirildiğinde veya config.return_dict=False olduğunda), yapılandırma (MambaConfig) ve girdilere bağlı olarak çeşitli öğelerden oluşur.

MambaForCausalLM forward metodu, __call__ özel metodunu geçersiz kılar.

İleri geçiş tarifi bu fonksiyon içinde tanımlanmalı olsa da, sonrasında bunun yerine Module örneğini çağırmak gerekir; çünkü önceki, ön ve son işleme adımlarını çalıştırmaktan sorumluyken ikincisi bunları sessizce yok sayar.

loss (torch.FloatTensor, şekli (1,), opsiyonel, labels sağlandığında döndürülür) — Dil modelleme kaybı (sonraki token tahmini için).
logits (torch.FloatTensor, şekli (batch_size, sequence_length, config.vocab_size)) — Dil modelleme başlığının tahmin puanları (SoftMax öncesi her sözlük jetonu için puanlar).
cache_params (~cache_utils.Cache, isteğe bağlı) — Modelin son zaman adımındaki durumu. Eski input_ids değerlerini tekrar sağlamak zorunluluğunu ortadan kaldırmak için, bir forward metodunda bir sonraki input_ids ile birlikte kullanılabilir.

Seçici taramadan sonraki Durum Uzayı Modeli durum matrislerinin yanı sıra Konvolüsyonel durumları da içerir
hidden_states (tuple[torch.FloatTensor], isteğe bağlı, output_hidden_states=True geçirildiğinde veya config.output_hidden_states=True olduğunda döndürülür) — torch.FloatTensor (modelin bir gömme katmanı varsa gömme katmanının çıktısı için bir tane + her katmanın çıktısı için birer tane) içeren, (batch_size, sequence_length, hidden_size) biçiminde bir demet.

Her katmanın çıktısında modelin gizli durumları ve isteğe bağlı başlangıç gömme çıktıları.

Örnek:

Update on GitHub

←MADLAD-400 Mamba2→