PEFT documentation

Tuners

Hugging Face's logo
Join the Hugging Face community

and get access to the augmented documentation experience

to get started

Tuners

Bir tuner (veya adapter), torch.nn.Module'e takılabilen bir modüldür. Diğer tuner'lar için BaseTuner taban sınıfı, bir adapter yapılandırmasını hazırlamak ve hedef modülü adapter modülüyle değiştirmek için paylaşılan yöntemler ve öznitelikler sağlar. BaseTunerLayer, adapter katmanları için bir taban sınıfıdır. Adapter'leri etkinleştirme ve devre dışı bırakma gibi adapter'leri yönetmek için yöntemler ve öznitelikler sunar.

BaseTuner

sınıf peft.tuners.tuners_utils.BaseTuner

< >

( modelpeft_config: Union[PeftConfig, dict[str, PeftConfig]]adapter_name: strlow_cpu_mem_usage: bool = Falsestate_dict: Optional[dict[str, torch.Tensor]] = None )

Parametreler

  • model (torch.nn.Module) — Adapter tuner katmanlarının bağlanacağı model.
  • forward (Callable) — Modelin forward metodu.
  • peft_config (Union[PeftConfig, dict[str, PeftConfig]]) — Uyarlama yapılandırma nesnesi, str anahtarlarından PeftConfig nesnelerine giden bir sözlük olmalıdır. Ayrıca bir PeftConfig nesnesi de geçirilebilir ve varsayılan ad olan adapter ile yeni bir uyarlama oluşturulur ya da adapter_name anahtarına sahip ve değeri ilgili peft yapılandırması olan yeni bir sözlük oluşturulur.
  • config (dict[str, Any]) — Model yapılandırma nesnesi, str ile Any nesneleri arasındaki bir sözlük olmalıdır.
  • targeted_module_names (list[str]) — Gerçekten uyarlanan modül adlarının listesi. config.target_modules değerlerinin doğru belirtildiğini hızlıca kontrol etmek istiyorsanız incelemek için faydalı olabilir.
  • targeted_parameter_names (list[str]) — Gerçekte uyarlanan parametre adlarının listesi. config.target_parameters değerlerinin doğru belirtildiğini hızlıca kontrol etmek istiyorsanız incelemek için faydalı olabilir.
  • prefix (str) — PEFT yönteminin kendine özgü benzersiz öneki. Örn. LoRA için "lora_".

Tüm enjekte edilebilir tuner'lar için ortak yöntemleri ve öznitelikleri sağlayan, torch.nn.Module'a enjekte edilebilen bir temel tuner modeli

Yeni bir Tuner sınıfı eklemek için aşağıdaki yöntemlerin yeniden yazılması gerekir:

  • _prepare_adapter_config: Örneğin target_modules alanı eksikse, adapter yapılandırmasını hazırlamak için nihayetinde kullanılacak özel bir yöntem.
  • _create_and_replace: Hedef modülü adaptör modülüyle oluşturup değiştirmek için özel bir yöntem.
  • _check_target_module_exists: adapter_config içindeki hedef modüllerden herhangi birinin, geçirilen modülün anahtar adıyla eşleşip eşleşmediğini kontrol etmek için kullanılan özel yardımcı bir yöntemdir.

En kolay yol, peft.tuners.lora.LoraModel sınıfında ne yapıldığını kontrol etmektir.

delete_adapter

< >

( adapter_name: str )

Parametreler

  • adapter_name (str) — Silinecek adaptörün adı.

Mevcut bir adaptörü siler.

disable_adapter_layers

< >

( )

Tüm adaptörleri yerinde devre dışı bırakın.

Tüm adaptörler devre dışı bırakıldığında, model çıktısı temel modelin çıktısıyla eşleşir.

enable_adapter_layers

< >

( )

Tüm adaptörleri yerinde etkinleştir

get_model_config

< >

( model: nn.Module )

Parametreler

  • model (nn.Module) — Model to get the config from.
  • default (dict|None, isteğe bağlı) —: Modelin bir config özniteliği yoksa ne döndürüleceği.

Bu yöntem, modelin yapılandırmasını sözlük biçiminde alır. Modelin config özniteliği yoksa bu yöntem varsayılan bir config döndürür.

inject_adapter

< >

( model: nn.Moduleadapter_name: strautocast_adapter_dtype: bool = Truelow_cpu_mem_usage: bool = Falsestate_dict: Optional[dict[str, torch.Tensor]] = None )

Parametreler

  • model (nn.Module) — Ayarlanacak model.
  • adapter_name (str) — Adaptör adı.
  • autocast_adapter_dtype (bool, isteğe bağlı) — Adapter veri türünün otomatik olarak dönüştürülüp dönüştürülmeyeceğini belirtir. Varsayılan değeri True'dür.
  • low_cpu_mem_usage (bool, optional, defaults to False) — Meta cihazda boş adaptör ağırlıkları oluşturur. Yükleme sürecini hızlandırmak için faydalıdır.
  • state_dict (dict, isteğe bağlı, varsayılan None) — Buraya bir state_dict geçirilirse, adaptörler state_dict girdilerine göre enjekte edilir. Bu, örneğin checkpoint meta veri olmadan oluşturulduğundan PEFT yönteminin tam target_modules değerinin bilinmediği durumlarda faydalı olabilir. Not: state_dict değerleri kullanılmaz, uyarlanacak doğru katmanları belirlemek için yalnızca anahtarlar kullanılır.

Adapter katmanları oluşturur ve hedef modülleri adapter katmanlarıyla değiştirir. Bu yöntem, bir prompt tuning dışı adapter sınıfı geçirildiğinde peft.mapping.get_peft_model tarafından arka planda çağrılır.

İlgili PEFT yapılandırması, BaseTuner sınıfının peft_config özniteliğinden doğrudan alınır.

merge_adapter

< >

( adapter_names: Optional[list[str]] = Nonesafe_merge: bool = False )

Parametreler

  • adapter_names (list[str], isteğe bağlı) — Birleştirilecek adaptör adlarının listesi. None ise tüm etkin adaptörler birleştirilir. Varsayılan değer None'dir.
  • safe_merge (bool, isteğe bağlı) — True ise, birleştirme işlemi orijinal ağırlıkların bir kopyasında gerçekleştirilir ve ağırlıklar birleştirilmeden önce NaN değerleri kontrol edilir. Birleştirme işleminin NaN üreteceğini kontrol etmek istiyorsanız bu işe yarar. Varsayılan değer False'tur.

Bu yöntem, adaptör katmanlarını temel modele birleştirir.

Adaptörlerin birleştirilmesi, ileri geçişin hızlanmasına yol açabilir. Adaptörleri birleştirmeden (unmerge) çıkabilmek için adaptör ağırlıklarının bir kopyası bellekte tutulmaya devam eder. Adaptör ağırlıklarını bellekte tutmadan birleştirmek için lütfen merge_and_unload fonksiyonunu çağırın.

Bir katman, adaptör ağırlıklarını birleştirdiğinde, ileri geçişinde yalnızca bu ağırlıkları kullanır. Bu nedenle, adapter_names tüm etkin adaptörleri kapsamıyorsa, kalan etkin adaptörler hâlâ etkin olarak raporlansalar bile sessizce uygulanmaz. Tüm etkin adaptörleri birleştirin veya önce unmerge_adapter çağrısını yapın. Bu davranışın v1.0 sürümünde değiştirilmesi planlanmaktadır.

merge_and_unload

< >

( progressbar: bool = Falsesafe_merge: bool = Falseadapter_names: Optional[list[str]] = None )

Parametreler

  • progressbar (bool) — yükleme kaldırma ve birleştirme sürecini gösteren bir ilerleme çubuğu gösterilip gösterilmeyeceğini belirtir (varsayılan: False).
  • safe_merge (bool) — adaptör ağırlıklarında potansiyel Nan olup olmadığını kontrol etmek için güvenli birleştirme kontrolünün etkinleştirilip etkinleştirilmeyeceğini belirtir.
  • adapter_names (List[str], isteğe bağlı) — Birleştirilecek adaptör adlarının listesi. None ise, tüm etkin adaptörler birleştirilir. Varsayılan değer None'dir.

Bu yöntem, adaptör katmanlarını temel modele birleştirir.

Bu, birinin temel modeli bağımsız bir model olarak kullanmak istemesi durumunda gereklidir. Dönen model, orijinal temel modelle aynı mimariye sahiptir.

Dönen modeli bir değişkene atamak ve onu kullanmak önemlidir, bu bir yerinde (in-place) işlem değildir!

Örnek:

>>> from transformers import AutoModelForCausalLM
>>> from peft import PeftModel

>>> model_id = ...
>>> base_model = AutoModelForCausalLM.from_pretrained(model_id)
>>> peft_model_id = ...
>>> model = PeftModel.from_pretrained(base_model, peft_model_id)
>>> merged_model = model.merge_and_unload()

set_adapter

< >

( adapter_name: str | list[str]inference_mode: bool = False )

Parametreler

  • adapter_name (str, list[str]) — Aktif olarak ayarlanacak adaptör(ler)in adı(ları)
  • inference_mode (bool, isteğe bağlı) — Aktif olan adaptörün dondurulup dondurulmayacağı (yani requires_grad=False). Varsayılan değer False'tur.

Aktif adaptör(ler)i ayarlayın.

set_requires_grad

< >

( adapter_names: str | Sequence[str]requires_grad: bool = True )

Parametreler

  • adapter_names (str veya Sequence[str]) — Gradyanları etkinleştirilecek/devre dışı bırakılacak adaptör(ler)in adı.
  • requires_grad (bool, isteğe bağlı) — Etkinleştirilecek (True, varsayılan) veya devre dışı bırakılacak (False).

Verilen adaptör(ler) için gradyanları etkinleştirin veya devre dışı bırakın.

supports_lora_conversion

< >

( adapter_name: str = 'default' )

Bu modelin adaptörünün LoRA'ya dönüştürülüp dönüştürülemeyeceği.

Normalde, PEFT yöntemi additif ise, yani W’ = W_base + delta_weight ise, bu çalışır.

unload

< >

( )

PEFT modüllerinin tümünü kaldırarak temel modeli döndürür.

Dönen modeli bir değişkene atamak ve onu kullanmak önemlidir, bu bir yerinde (in-place) işlem değildir!

unmerge_adapter

< >

( )

Bu yöntem, temel modelden birleştirilmiş tüm adaptör katmanlarını ayırır.

BaseTunerLayer

sınıf peft.tuners.tuners_utils.BaseTunerLayer

< >

( )

Parametreler

  • is_pluggable (bool, isteğe bağlı) — Uyarlama katmanının herhangi bir pytorch modülüne takılıp takılamayacağı
  • active_adapters (Union[Liststr, str], isteğe bağlı) — Aktif adaptörün adı.

Tüm tuner'lar için ortak yöntemleri ve öznitelikleri sağlayan bir tuner katman karışımı (mixin).

delete_adapter

< >

( adapter_name: str )

Parametreler

  • adapter_name (str) — Silinecek adaptörün adı

Katmandan bir adaptörü sil

Bu, tüm adaptör katmanlarında çağrılmalıdır; aksi takdirde tutarsız bir durumla karşılaşırız.

Bu yöntem, silinen adaptör aktif bir adaptörse, yeni bir aktif adaptör de ayarlayacaktır. Tüm katmanlarda aynı adaptörün seçilmesini sağlamak için yeni adaptörün deterministik bir şekilde seçilmesi önemlidir.

enable_adapters

< >

( enabled: bool )

Parametreler

  • enabled (bool) — Adaptörleri etkinleştirmek için True, devre dışı bırakmak için False

Eklentilerin etkinleştirilmesini ve devre dışı bırakılmasını değiştir

Uyarlama ağırlıkları için requires_grad bayrağını ayarlamaktan sorumludur.

get_additive_delta

< >

( adapter_name: str = 'default' )

Parametreler

  • adapter_name (str) — Adaptörün adı. Varsayılan olarak "default"'tır.

Verilen adaptör için, W taban ağırlığı ve W' adaptörün taban ağırlığına birleştirilmesi sonrasındaki ağırlık olmak üzere, toplam delta ağırlığı W' - W'yi döndürür. Bu, birleştirilmiş ağırlığın base_weight + module.get_additive_delta(adapter_name) yoluyla yeniden oluşturulabileceği anlamına gelir.

Çekirdek PEFT yöntemleri (ör. LoRA, LoKr, LoHa) için bu, get_delta_weight ile eşdeğerdir. Çarpmalı yöntemler (ör. OFT, BOFT) için bu yöntem, etkin ağırlığı W’ oluşturur ve taban ağırlığı W’yi çıkarır.

Herhangi bir adaptör birleştirilmişken bu yöntemin çağrılması, birleştirme işlemi temel ağırlığı değiştirdiği ve bu da dönüş değerinin şu anda birleştirilmiş adaptörlere bağlı olmasına neden olacağı için bir ValueError yükseltir. Önce adaptörleri birleştirmeyi geri alın.

Dönen tensörün dtype'ı, temel katman ağırlığının dtype'ı değil, adaptör katmanı ağırlıklarının dtype'ıdır (ör. LoRA için lora_A). Bu, dönüştürülmüş LoRA adaptörünün kullanacağı dtype'tır.

Sonuç, convert_to_lora tarafından adaptörün bir LoRA adaptörü olarak SVD tabanlı bir yaklaşık olarak gerçekleştirilmesi için kullanılır.

Varsayılan olarak bu, bir NotImplementedError yükseltir. Bunu destekleyen PEFT yöntemleri, additif deltayı döndürmek için _get_additive_delta yöntemini geçersiz kılmalıdır.

get_base_layer

< >

( )

(Özyinelemeli olarak) base_layer'ı alın.

Bu, ayarlayıcı katmanının başka bir ayarlayıcı katmanını sarmaladığı durumlar için gereklidir.

get_base_weight

< >

( )

Taban katmanının ağırlığını döndürür.

Bu, ağırlık kuantize edilmişse potansiyel olarak kuantizasyonunu kaldırır.

set_adapter

< >

( adapter_names: str | list[str]inference_mode: bool = False )

Parametreler

  • adapter_names (str veya list[str]) — Aktif olarak ayarlanacak adaptör(ler)in adı(ları).
  • inference_mode (bool, isteğe bağlı) — Aktif olan adaptörün dondurulup dondurulmayacağı (yani requires_grad=False). Varsayılan değer False'tur.

Aktif adaptör(ler)i ayarlayın.

Ayrıca, bu işlev, inference_mode değeri True olmadıkça, belirtilen adaptörü eğitilebilir (yani requires_grad=True) olarak ayarlar.

set_base_weight

< >

( weight_data: torch.Tensor )

Taban katmanının taban ağırlığını yeni tensöre ayarlar

Bu, kuantize ağırlıklarla da çalışır.

set_requires_grad

< >

( adapter_names: str | Sequence[str]requires_grad: bool = True )

Parametreler

  • adapter_names (str veya Sequence[str]) — Gradyanları etkinleştirilecek/devre dışı bırakılacak adaptör(ler)in adı.
  • requires_grad (bool, isteğe bağlı) — Etkinleştirilecek (True, varsayılan) veya devre dışı bırakılacak (False).

Verilen adaptör(ler) için gradyanları etkinleştirin veya devre dışı bırakın.

set_training

< >

( adapter_names: str | Sequence[str]training: bool = True )

Parametreler

  • adapter_names (str veya Sequence[str]) — Eğitim modunun güncellenmesi gereken adaptör(ler)in adı.
  • training (bool, isteğe bağlı) — Eğitim modunun etkinleştirilip (True, varsayılan) etkinleştirilmeyeceğini (False) belirtir.

Verilen adaptör modüllerinde eğitim modunu etkinleştirin veya devre dışı bırakın.

supports_lora_conversion

< >

( adapter_name: str = 'default' )

Bu katman türünün LoRA'ya dönüştürülüp dönüştürülemeyeceği.

Normalde, PEFT yöntemi additif ise, yani W’ = W_base + delta_weight ise, bu çalışır.

Update on GitHub