PEFT documentation

HiRA

Hugging Face's logo
Join the Hugging Face community

and get access to the augmented documentation experience

to get started

HiRA

High-Rank Adaptation (HiRA) adalah metode PEFT yang memperluas pendekatan LoRA dengan menerapkan modulasi element-wise pada matriks bobot asli. Alih-alih menambahkan pembaruan rank rendah secara langsung, HiRA menghitung: Wβ€²=W0+W0βŠ™(BA) W' = W_0 + W_0 \odot (B A)

di mana W0W_0 adalah bobot dasar, dan A,BA, B adalah faktor ber-rank rendah dengan rank $r \ll \min(\text{in_features}, \text{out_features})$. Formulasi ini memungkinkan HiRA untuk menyesuaikan bobot yang ada dengan modulasi multiplikatif yang bergantung pada input, yang sering kali meningkatkan efisiensi fine-tuning pada tugas turunan.

Abstrak dari paper HiRA adalah:

Kami mengusulkan Hadamard High-Rank Adaptation (HiRA), sebuah metode fine-tuning yang efisien secara parameter (PEFT) yang meningkatkan kemampuan adaptasi Large Language Models (LLM). Meskipun Low-rank Adaptation (LoRA) banyak digunakan untuk mengurangi kebutuhan sumber daya, pembaruan ber-rank rendah dapat membatasi ekspresivitasnya untuk tugas-tugas baru. HiRA mengatasi hal ini dengan menggunakan produk Hadamard untuk mempertahankan parameter pembaruan ber-rank tinggi, sehingga meningkatkan kapasitas model. Secara empiris, HiRA melampaui LoRA dan variasinya pada beberapa tugas, dengan studi ablasif yang luas yang memvalidasi efektivitasnya.

Contoh

from transformers import AutoModelForCausalLM, AutoTokenizer
from peft import get_peft_model
from peft.tuners.hira import HiraConfig

# Example 1: HiRA on opt-125m for causal language modeling
model_id = "facebook/opt-125m"
base_model = AutoModelForCausalLM.from_pretrained(model_id)
tokenizer = AutoTokenizer.from_pretrained(model_id)

# Define HiRA configuration: apply to the MLP dense layers in each transformer block
hira_config = HiraConfig(
    r=32,
    target_modules=["k_proj", "q_proj", "v_proj", "fc1", "fc2"],
    hira_dropout=0.0,
    init_weights=True,
)
peft_model = get_peft_model(base_model, hira_config)

peft_model.print_healthcheck()

Ikhtisar benchmark

Sitasi:

Jika Anda merasa HiRA berguna, silakan kutip HiRA sebagai:

@inproceedings{
huang2025hira,
title={Hi{RA}: Parameter-Efficient Hadamard High-Rank Adaptation for Large Language Models},
author={Qiushi Huang and Tom Ko and Zhan Zhuang and Lilian Tang and Yu Zhang},
booktitle={The Thirteenth International Conference on Learning Representations},
year={2025},
url={https://openreview.net/forum?id=TwJrTz9cRS}
}

API

HiraConfig

kelas peft.HiraConfig

< >

( task_type: Optional[Union[str, TaskType]] = Nonepeft_type: Optional[Union[str, PeftType]] = Noneauto_mapping: Optional[dict] = Nonepeft_version: Optional[str] = Nonebase_model_name_or_path: Optional[str] = Nonerevision: Optional[str] = Noneinference_mode: bool = Falser: int = 32target_modules: Optional[Union[list[str], str]] = Noneexclude_modules: Optional[Union[list[str], str]] = Nonehira_dropout: float = 0.0fan_in_fan_out: bool = Falsemodules_to_save: Optional[list[str]] = Noneinit_weights: bool | Literal['gaussian'] | None = Truelayers_to_transform: Optional[Union[list[int], int]] = Nonelayers_pattern: Optional[Union[list[str], str]] = Nonerank_pattern: Optional[dict] = <factory> )

Parameter

  • r (int) β€” Rank dari komponen low-rank dalam HiRA. Meskipun HiRA mencapai adaptasi high-rank melalui fusi Hadamard, nilai ini mendefinisikan dimensi dari dekomposisi low-rank yang mendasarinya (matriks A dan B).
  • target_modules (Optional[Union[List[str], str]]) β€” Nama-nama modul yang akan diterapkan adapter-nya. Jika ini ditentukan, hanya modul dengan nama yang ditentukan yang akan diganti. Saat meneruskan string, pencocokan regex akan dilakukan. Saat meneruskan daftar string, pencocokan persis akan dilakukan atau diperiksa apakah nama modul diakhiri dengan salah satu string yang diteruskan. Jika ini ditentukan sebagai β€˜all-linear’, maka semua modul linear/Conv1D akan dipilih (jika modelnya adalah PreTrainedModel, lapisan output dikecualikan). Jika ini tidak ditentukan, modul akan dipilih sesuai dengan arsitektur model. Jika arsitekturnya tidak diketahui, error akan dilempar β€” dalam kasus ini, Anda harus menentukan modul target secara manual.
  • exclude_modules (Optional[Union[List[str], str]]) β€” Nama-nama modul yang tidak akan diterapkan adapter. Saat melewatkan string, pencocokan regex akan dilakukan. Saat melewatkan daftar string, pencocokan persis akan dilakukan atau diperiksa apakah nama modul berakhiran dengan salah satu string yang dilewatkan.
  • hira_dropout (float) β€” Probabilitas dropout untuk lapisan HiRA.
  • fan_in_fan_out (bool) β€” Atur ini ke True jika layer yang akan diganti menyimpan bobot seperti (fan_in, fan_out). Misalnya, gpt-2 menggunakan Conv1D yang menyimpan bobot seperti (fan_in, fan_out) sehingga ini harus diatur ke True.
  • modules_to_save (List[str]) β€” Daftar modul selain lapisan adapter yang akan diatur sebagai dapat dilatih dan disimpan dalam checkpoint akhir.
  • init_weights (bool | Literal["gaussian"]) β€” Cara menginisialisasi bobot dari lapisan HiRA. Mengirimkan True (default) menghasilkan inisialisasi default, dengan bobot HiRA B diset ke 0. Ini berarti bahwa tanpa pelatihan lebih lanjut, adapter HiRA akan menjadi no-op. Menetapkan inisialisasi ke False menyebabkan inisialisasi acak untuk HiRA A dan B, yang berarti HiRA bukan no-op sebelum pelatihan; pengaturan ini ditujukan untuk keperluan debugging. Mengirimkan 'gaussian' menghasilkan inisialisasi Gaussian yang diskalakan berdasarkan rank HiRA untuk lapisan linear.
  • layers_to_transform (Union[List[int], int]) β€” Indeks layer yang akan ditransformasi. Jika daftar int yang dilewatkan, adapter akan diterapkan pada indeks layer yang ditentukan dalam daftar ini. Jika satu integer yang dilewatkan, transformasi akan diterapkan pada layer di indeks ini.
  • layers_pattern (Optional[Union[List[str], str]]) β€” Nama pola layer, hanya digunakan jika layers_to_transform berbeda dari None. Ini harus menargetkan nn.ModuleList dari model, yang sering disebut 'layers' atau 'h'.
  • rank_pattern (dict) β€” Pemetaan dari nama layer atau ekspresi regexp ke rank yang berbeda dari r default yang ditentukan oleh r. Sebagai contoh, {'^model.decoder.layers.0.encoder_attn.k_proj': 16}.

Ini adalah kelas konfigurasi untuk menyimpan konfigurasi dari HiraModel.

HiraModel

kelas peft.HiraModel

< >

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

Parameter

  • model (torch.nn.Module) β€” Model yang akan diadaptasi.
  • config (HiraConfig) β€” Konfigurasi model HiRA.
  • adapter_name (str) β€” Nama adapter, secara default "default".
  • low_cpu_mem_usage (bool, optional, defaults to False) β€” Membuat bobot adapter kosong pada perangkat meta. Berguna untuk mempercepat proses pemuatan.

Mengembalikan

torch.nn.Module

Model HiRA.

Membuat model HiRA Adapter dari model transformers yang telah dilatih sebelumnya.

Metode ini dijelaskan secara rinci di https://openreview.net/pdf?id=TwJrTz9cRS.

Contoh:

>>> from transformers import AutoModelForSeq2SeqLM
>>> from peft import HiraConfig, get_peft_model

>>> config = HiraConfig(
...     task_type="SEQ_2_SEQ_LM",
...     r=32,
...     target_modules=["q", "v"],
...     hira_dropout=0.01,
... )

>>> model = AutoModelForSeq2SeqLM.from_pretrained("t5-base")
>>> hira_model = get_peft_model(model, config)
>>> import torch
>>> import transformers
>>> from peft import HiraConfig, get_peft_model, prepare_model_for_kbit_training

>>> rank = ...
>>> target_modules = ["q_proj", "k_proj", "v_proj", "out_proj", "fc_in", "fc_out", "wte"]
>>> config = HiraConfig(r=32, target_modules=target_modules, hira_dropout=0.1, task_type="CAUSAL_LM")
>>> quantization_config = transformers.BitsAndBytesConfig(load_in_8bit=True)

>>> tokenizer = transformers.AutoTokenizer.from_pretrained(
...     "kakaobrain/kogpt",
...     revision="KoGPT6B-ryan1.5b-float16",  # or float32 version: revision=KoGPT6B-ryan1.5b
...     bos_token="[BOS]",
...     eos_token="[EOS]",
...     unk_token="[UNK]",
...     pad_token="[PAD]",
...     mask_token="[MASK]",
... )
>>> model = transformers.GPTJForCausalLM.from_pretrained(
...     "kakaobrain/kogpt",
...     revision="KoGPT6B-ryan1.5b-float16",  # or float32 version: revision=KoGPT6B-ryan1.5b
...     pad_token_id=tokenizer.eos_token_id,
...     use_cache=False,
...     device_map={"": rank},
...     torch_dtype=torch.float16,
...     quantization_config=quantization_config,
... )
>>> model = prepare_model_for_kbit_training(model)
>>> hira_model = get_peft_model(model, config)

Atribut:

Lapisan Inti

HiraLayer

kelas peft.tuners.hira.HiraLayer

< >

( base_layer: nn.Moduleephemeral_gpu_offload: bool = False**kwargs )

Linear Adapter

kelas peft.tuners.hira.Linear

< >

( base_layeradapter_name: strconfig: HiraConfigr: int = 0fan_in_fan_out: bool = Falseis_target_conv_1d_layer: bool = False**kwargs )

get_delta_weight

< >

( adapter )

Parameter

  • adapter (str) β€” Nama adapter yang bobot delta-nya harus dihitung.

Hitung bobot delta untuk adapter yang diberikan.

merge

< >

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

Parameter

  • safe_merge (bool, opsional) β€” Jika True, operasi merge akan dilakukan pada salinan dari bobot asli dan memeriksa NaN sebelum menggabungkan bobot. Ini berguna jika Anda ingin memeriksa apakah operasi merge akan menghasilkan NaN. Defaultnya adalah False.
  • adapter_names (list[str], opsional) β€” Daftar nama adapter yang harus digabungkan. Jika None, semua adapter aktif akan digabungkan. Defaultnya adalah None.

Gabungkan bobot adapter aktif ke dalam bobot dasar

unmerge

< >

( )

Metode ini memisahkan semua lapisan adapter yang telah digabungkan dari bobot dasar.

Embedding Adapter

kelas peft.tuners.hira.Embedding

< >

( base_layer: nn.Moduleadapter_name: strconfig: HiraConfigr: int = 0fan_in_fan_out: bool = False**kwargs )

forward

< >

( x: torch.Tensor*args: Any**kwargs: Any )

HiRA forward untuk lapisan Embedding. Mendukung adapter campuran per batch atau adapter tunggal.

get_delta_weight

< >

( adapter )

Parameter

  • adapter (str) β€” Nama adapter yang bobot delta-nya harus dihitung.

Hitung bobot delta untuk adapter yang diberikan.

merge

< >

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

Parameter

  • safe_merge (bool, opsional) β€” Jika True, operasi merge akan dilakukan pada salinan dari bobot asli dan memeriksa NaN sebelum menggabungkan bobot. Ini berguna jika Anda ingin memeriksa apakah operasi merge akan menghasilkan NaN. Defaultnya adalah False.
  • adapter_names (list[str], opsional) β€” Daftar nama adapter yang harus digabungkan. Jika None, semua adapter aktif akan digabungkan. Defaultnya adalah None.

Gabungkan bobot adapter aktif ke dalam bobot dasar

unmerge

< >

( )

Metode ini memisahkan semua lapisan adapter yang telah digabungkan dari bobot dasar.

Adaptasi Konvolusional

[[autodoc]] tuners.hira.layer.Conv1d [[autodoc]] tuners.hira.layer.Conv2d [[autodoc]] tuners.hira.layer.ConvNd

Update on GitHub