README.md

---
license: openrail
language:
- fr
pipeline_tag: text-generation
library_name: transformers
tags:
- alpaca
- llama
- LLM
datasets:
- tatsu-lab/alpaca
inference: false
---

<p align="center" width="100%">
<img src="https://huggingface.co/bofenghuang/vigogne-lora-7b/resolve/main/vigogne_logo.png" alt="Vigogne" style="width: 40%; min-width: 300px; display: block; margin: auto;">
</p>

# Vigogne-LoRA-7b: A French Instruct LLaMA Model

Vigogne-LoRA-7b is a LLaMA-7B model fine-tuned on the translated [Stanford Alpaca](https://github.com/tatsu-lab/stanford_alpaca) dataset to follow the 🇫🇷 French instructions.

For more information, please visit the Github repo: https://github.com/bofenghuang/vigogne

**Usage and License Notices**: Same as [Stanford Alpaca](https://github.com/tatsu-lab/stanford_alpaca), Vigogne is intended and licensed for research use only. The dataset is CC BY NC 4.0 (allowing only non-commercial use) and models trained using the dataset should not be used outside of research purposes.

## Usage

This repo only contains the low-rank adapter. In order to access the complete model, you also need to load the base LLM model and tokenizer.

```python
from peft import PeftModel
from transformers import LlamaForCausalLM, LlamaTokenizer

base_model_name_or_path = "<name/or/path/to/hf/llama/7b/model>"
lora_model_name_or_path = "bofenghuang/vigogne-lora-7b"

tokenizer = LlamaTokenizer.from_pretrained(base_model_name_or_path)
model = LlamaForCausalLM.from_pretrained(
    base_model_name_or_path,
    load_in_8bit=True,
    device_map="auto",
)
model = PeftModel.from_pretrained(model, lora_model_name_or_path)
```

You can infer this model by using the following Google Colab Notebook.

<a href="https://colab.research.google.com/github/bofenghuang/vigogne/blob/main/infer.ipynb" target="_blank"><img src="https://colab.research.google.com/assets/colab-badge.svg" alt="Open In Colab"/></a>

## Limitations

Vigogne is still under development, and there are many limitations that have to be addressed. Please note that it is possible that the model generates harmful or biased content, incorrect information or generally unhelpful answers.

## Next Steps

- Add output examples