README.md

---
license: llama2
---

## Lazy LoRA

### Benefits

0. using the (former, since 33b model is not included in llama-2 for the public)[Meta's LLaMA-1 models](https://huggingface.co/huggyllama/llama-30b).
1. support [4-bit qlora](https://arxiv.org/abs/2305.14314), extreme GPU memory and inference time saving;
2. comparable (slightly worse, mainly due to 4-bit) MMLU evaluation dataset results, llama1-33b's 57.8% to our 56.97% (-0.83%).
3. This lazy-lora adapter is based on [Meta's LLaMA-1](https://huggingface.co/huggyllama/llama-30b), and using the [oasst1 dataset](https://huggingface.co/datasets/OpenAssistant/oasst1), following [Guanaco](https://huggingface.co/timdettmers/guanaco-65b).

### Introduction
Determine the rank of LoRA layers by the singular values of pretrained weight matrices.
Also, combines:
1. LoRA: [LORA: LOW-RANK ADAPTATION OF LARGE LANGUAGE MODELS](https://arxiv.org/abs/2106.09685)
2. Prefix Tuning: [Prefix-Tuning: Optimizing Continuous Prompts for Generation](https://aclanthology.org/2021.acl-long.3
53/), [P-Tuning v2: Prompt Tuning Can Be Comparable to Fine-tuning Universally Across Scales and Tasks](https://arxiv.or
g/pdf/2110.07602.pdf)
3. Prompt Tuning: [The Power of Scale for Parameter-Efficient Prompt Tuning](https://arxiv.org/abs/2104.08691)
4. LLaMA adapter: [LLaMA-Adapter: Efficient Fine-tuning of Language Models with Zero-init Attention] (https://arxiv.org/abs/2303.16199)
in one model.

This allows you to perform LoRA (additional low rank adapters inserted to each linear layer), and prompt learning (additional virtual tokens attached to the input and to the attention layers acting as `past_key_values`)

## Usage:
```python
import sys
sys.path.insert(1, '/workspace/asr/peft/src')
# TODO set this path to the lazy-lora source code path, 
# or you can install it from source code:
# TODO, please install lazylora for usage:
# git clone git@github.com:Xianchao-Wu/peft.git
# cd peft
# python setup.py install

from transformers import (AutoTokenizer, 
	AutoModelForCausalLM, BitsAndBytesConfig)
from peft import PeftModel, PeftConfig
import os
import torch

#import ipdb; ipdb.set_trace()
cache_dir="/workspace/asr/peft/qlora"
# TODO set this cache_dir to the path where you 
# stored (or, want to store) llama1-33b model

lazylora_dir=os.getcwd() 
# the path that contains 'adapter_config.json' 
#     and 'adapter_model.bin'

config = PeftConfig.from_pretrained(lazylora_dir)

tokenizer = AutoTokenizer.from_pretrained(
    config.base_model_name_or_path,
    cache_dir=cache_dir,
    use_auth_token=True
)

bnb_config = BitsAndBytesConfig(
    load_in_4bit=True,
    bnb_4bit_use_double_quant=True,
    bnb_4bit_quant_type='nf4',
    bnb_4bit_compute_dtype=torch.bfloat16
)

model = AutoModelForCausalLM.from_pretrained(
    config.base_model_name_or_path,
    quantization_config=bnb_config,
    device_map="auto",
    cache_dir=cache_dir,
    use_auth_token=True
)
#model.print_trainable_parameters()
print(sum(p.numel() for p in model.parameters()))
# 16,477,866,496 -> half-size of 33B due to 4-bit loading

model = PeftModel.from_pretrained(model, lazylora_dir)
print('after adding lazy lora parameters:')
model.print_trainable_parameters()
# trainable params: 0 || all params: 16,965,645,824 || trainable%: 0.0
```

## MMLU result:

```json
{"mmlu_loss": 2.6712945443520275,
 "mmlu_eval_accuracy_college_chemistry": 0.125,
 "mmlu_eval_accuracy_philosophy": 0.7647058823529411,
 "mmlu_eval_accuracy_virology": 0.3888888888888889,
 "mmlu_eval_accuracy_high_school_european_history": 0.8333333333333334,
 "mmlu_eval_accuracy_astronomy": 0.6875,
 "mmlu_eval_accuracy_elementary_mathematics": 0.34146341463414637,
 "mmlu_eval_accuracy_business_ethics": 0.5454545454545454,
 "mmlu_eval_accuracy_computer_security": 0.8181818181818182,
 "mmlu_eval_accuracy_anatomy": 0.5,
 "mmlu_eval_accuracy_high_school_physics": 0.23529411764705882,
 "mmlu_eval_accuracy_high_school_government_and_politics": 0.7619047619047619,
 "mmlu_eval_accuracy_global_facts": 0.4,
 "mmlu_eval_accuracy_logical_fallacies": 0.6666666666666666,
 "mmlu_eval_accuracy_security_studies": 0.7037037037037037,
 "mmlu_eval_accuracy_world_religions": 0.8421052631578947,
 "mmlu_eval_accuracy_professional_medicine": 0.7096774193548387,
 "mmlu_eval_accuracy_management": 0.9090909090909091,
 "mmlu_eval_accuracy_marketing": 0.8,
 "mmlu_eval_accuracy_college_physics": 0.36363636363636365,
 "mmlu_eval_accuracy_professional_law": 0.4294117647058823,
 "mmlu_eval_accuracy_college_mathematics": 0.36363636363636365,
 "mmlu_eval_accuracy_high_school_psychology": 0.8333333333333334,
 "mmlu_eval_accuracy_moral_disputes": 0.5789473684210527,
 "mmlu_eval_accuracy_professional_accounting": 0.45161290322580644,
 "mmlu_eval_accuracy_conceptual_physics": 0.4230769230769231,
 "mmlu_eval_accuracy_high_school_chemistry": 0.36363636363636365,
 "mmlu_eval_accuracy_nutrition": 0.7272727272727273,
 "mmlu_eval_accuracy_high_school_geography": 0.7272727272727273,
 "mmlu_eval_accuracy_high_school_statistics": 0.43478260869565216,
 "mmlu_eval_accuracy_prehistory": 0.5714285714285714,
 "mmlu_eval_accuracy_public_relations": 0.5833333333333334,
 "mmlu_eval_accuracy_jurisprudence": 0.5454545454545454,
 "mmlu_eval_accuracy_moral_scenarios": 0.4,
 "mmlu_eval_accuracy_sociology": 0.8181818181818182,
 "mmlu_eval_accuracy_college_biology": 0.5,
 "mmlu_eval_accuracy_human_aging": 0.6521739130434783,
 "mmlu_eval_accuracy_abstract_algebra": 0.36363636363636365,
 "mmlu_eval_accuracy_high_school_computer_science": 0.6666666666666666,
 "mmlu_eval_accuracy_electrical_engineering": 0.3125,
 "mmlu_eval_accuracy_medical_genetics": 0.8181818181818182,
 "mmlu_eval_accuracy_clinical_knowledge": 0.4827586206896552,
 "mmlu_eval_accuracy_high_school_macroeconomics": 0.5813953488372093,
 "mmlu_eval_accuracy_college_medicine": 0.5,
 "mmlu_eval_accuracy_high_school_world_history": 0.6923076923076923,
 "mmlu_eval_accuracy_high_school_mathematics": 0.3448275862068966,
 "mmlu_eval_accuracy_international_law": 0.9230769230769231,
 "mmlu_eval_accuracy_miscellaneous": 0.7558139534883721,
 "mmlu_eval_accuracy_human_sexuality": 0.4166666666666667,
 "mmlu_eval_accuracy_professional_psychology": 0.5942028985507246,
 "mmlu_eval_accuracy_econometrics": 0.4166666666666667,
 "mmlu_eval_accuracy_high_school_microeconomics": 0.5384615384615384,
 "mmlu_eval_accuracy_us_foreign_policy": 0.9090909090909091,
 "mmlu_eval_accuracy_machine_learning": 0.45454545454545453,
 "mmlu_eval_accuracy_high_school_biology": 0.53125,
 "mmlu_eval_accuracy_formal_logic": 0.14285714285714285,
 "mmlu_eval_accuracy_high_school_us_history": 0.8636363636363636,
 "mmlu_eval_accuracy_college_computer_science": 0.36363636363636365,
 "mmlu_eval_accuracy": 0.5696901987706997,
 "epoch": 3.05}
```

## License and intended use 

This lazy-lora adapter is based on [Meta's LLaMA1-33b, huggyllama/llama-30b](https://huggingface.co/huggyllama/llama-30b), and using the [oasst1 dataset](https://huggingface.co/datasets/OpenAssistant/oasst1), following [Guanaco](https://huggingface.co/timdettmers/guanaco-65b).

lazy lora adapter weights are available under LLAMA-2 license. Note the use of the lazy lora adapter weights, requires access to the LLaMA model weighs. Lazy lora is based on LLaMA and therefore should be used according to the LLaMA license.


## Risks and Biases

The model can produce factually incorrect output, and should not be relied on to produce factually accurate information. The model was trained on various public datasets; it is possible that this model could generate lewd, biased, or otherwise offensive outputs.