Pull Request: Adding HiRA integration into PEFT library#2668
Pull Request: Adding HiRA integration into PEFT library#2668hqsiswiliam wants to merge 105 commits intohuggingface:mainfrom
Conversation
BenjaminBossan
left a comment
There was a problem hiding this comment.
Thanks for this PR to add HiRA to PEFT. The method looks promising and the provided code is already quite mature.
When I started reading the paper, I was at first reminded of FedPara, aka LoHa, which is already integrated into PEFT, as that method also relies on the Hadamard product. However, IIUC, the two methods are still distinct: HiRA basically corresponds to LoRA, but instead of adding dW, we multiply it. In that way, it is much closer to LoRA than to LoHa. Still, I wanted to flag this, as I'm not sure you are aware (your paper doesn't seem to be reference FedPara).
At the moment, I haven't done a full in-depth review, but I think that makes more sense once we have completed the next step.
I noticed that you have formatted some unrelated files in method_comparison, could you please undo those changes? Usually, when you run make style, that directory should not be included.
I think a good next step is to add HiRA to the testing matrix we have in PEFT. For now, let's add some entries similar to the ones you can find here:
peft/tests/test_custom_models.py
Lines 70 to 72 in 92d65ca
Since you also support embedding and conv layers, please make sure to include examples with those layers as well (basically, copy the relevant examples from LoRA and adjust them).
Then, please run pytest tests/test_custom_models.py -k "hira and not shira" -v and see if those tests pass. Once we get there, we can discuss the best next steps.
|
This issue has been automatically marked as stale because it has not had recent activity. If you think this still needs to be addressed please comment on this thread. |
|
@hqsiswiliam Do you still plan on working on this PR? |
Hi, BenjaminBossan. Thanks for checking in! I’ll continue working on this PR over the next few days. |
- modify config.__class__ to config_cls - remove _check_merge_allowed in hira model.
- adding HiRA cases to `MULTIPLE_ACTIVE_ADAPTERS_TEST_CASES`.
|
@hqsiswiliam There is a merge conflict, could you please take care? Also, once you're finished with your changes, please ping me for another review. |
# Resolve Conflicts: - tests/test_custom_models.py
|
@BenjaminBossan Thanks for your update and the earlier review. I’ve resolved the merge conflict, and the changes are ready for another review. 😃 |
BenjaminBossan
left a comment
There was a problem hiding this comment.
There is a small error in the docs. Also, could you please run make style to ensure that the linter is happy?
Hi @BenjaminBossan, thank you for the helpful comments and review. I’ve addressed the documentation issue and run |
BenjaminBossan
left a comment
There was a problem hiding this comment.
Thanks for the updates. There are still a few tests that are failing, could you please check?
|
This issue has been automatically marked as stale because it has not had recent activity. If you think this still needs to be addressed please comment on this thread. |
|
Hi, shall we continue to do the integration? 😊 |
|
Hi @hqsiswiliam could you please merge with/rebase on latest main? |
Certainly, I will merge with the latest main in a few days. |
|
Hi @BenjaminBossan, I’ve merged the latest |
|
The docs for this PR live here. All of your documentation changes will be reflected on that endpoint. The docs are available until 30 days after the last update. |
BenjaminBossan
left a comment
There was a problem hiding this comment.
Thanks for updating the PR. Generally, not much is missing, but I found a few smaller issues, please check. A few HiRA tests are still failing, could you please check and resolve these errors?
On top of this, let's also add tests to test_config.py, test_decoder_models.py, test_feature_extraction_models.py, and test_seq_classifier.py. Moreover, I would strongly suggest to add an experiment to the MetaMathQA benchmark. This has the advantage that we can run an experiment to check that training works as expected and is more or less aligned with the expectations from the paper.
|
Thank you for your review. I have updated the code accordingly. I will also look into integrating an experiment on the MetaMathQA benchmark following the provided guidelines. |
BenjaminBossan
left a comment
There was a problem hiding this comment.
Thanks for the latest updates.
Thank you for your review. I have updated the code accordingly. I will also look into integrating an experiment on the MetaMathQA benchmark following the provided guidelines.
Sounds good. Please ping me once that is done, + the missing unit tests I mentioned in my last comment.
There was a problem hiding this comment.
Not sure what happened here, but GH shows the whole file being changed. Could you please check out the original file and re-apply your changed?
There was a problem hiding this comment.
Resolved: LF was converted to CRLF; now restored.
Feature request
This request proposes integrating HiRA (Hadamard High-Rank Adaptation) as described in the ICLR 2025 oral paper (https://openreview.net/pdf?id=TwJrTz9cRS) (https://iclr.cc/virtual/2025/oral/31839) and implemented in the hqsiswiliam/hira repository into the core PEFT library. This will enable users to apply HiRA through the familiar
get_peft_modelAPI and benefit from its high-rank updates without adding any inference overhead.Motivation
General Motivation
PEFT methods like LoRA achieve parameter-efficient fine-tuning by injecting low-rank updates into pre-trained weights. While effective, purely low-rank adaptation can struggle to capture complex patterns in large language models.
1. Expressiveness grows with the rank
Empirically, increasing the LoRA rank in LLM training yields better downstream performance:
Higher LoRA rank correlates with improved task accuracy.
2. HiRA: Hadamard high-rank updates without extra parameters
HiRA sidesteps the expressiveness constraint by computing a Hadamard-enhanced update:
HiRA uses the Hadamard product to inject high-rank structure into the frozen weight matrix
3. Singular-value patterns
After training, HiRA exhibits a rich singular-value pattern, akin to full-rank fine-tuning (FFT), indicating its ability to model complex transformations without the expensive computational overhead:
HiRA’s singular-value distribution closely mirrors that of FFT.
4. Performance gains
Across commonsense reasoning benchmarks, HiRA outperforms LoRA and other PEFT baselines:
HiRA delivers notable accuracy improvements over baseline adapters.
5. No extra parameter or compute cost
Despite its high-rank behaviour, HiRA introduces no additional trainable parameters compared to LoRA:
HiRA matches LoRA’s GRAM usage and training hours.
6. Complementary with LoRA (HiLoRA)
Combining HiRA and LoRA into a hybrid “HiLoRA” setup yields even stronger results than either method alone:
HiLoRA leverages both low-rank and Hadamard high-rank updates for better expressiveness.
By integrating HiRA into PEFT, users gain richer adaptation capability without sacrificing the parameter efficiency and usability that PEFT provides.
Your contribution
We would be pleased to submit a pull request to integrate HiRA class implementation into the PEFT framework. We welcome any suggestions for alternative integration approaches and appreciate any guidance on best practices.