Update README.md

README.md

@@ -1,21 +1,80 @@
 ---
 library_name: peft
+license: mit
+language:
+- en
+- fr
+datasets:
+- kaitchup/opus-French-to-English
+tags:
+- translation
 ---
-## Training procedure
+# Model Card for Model ID
 
+This is an adapter for Meta's Llama 2 7B fine-tuned for translating French text into English. 
+## Model Details
 
-The following `bitsandbytes` quantization config was used during training:
-- quant_method: bitsandbytes
-- load_in_8bit: False
-- load_in_4bit: True
-- llm_int8_threshold: 6.0
-- llm_int8_skip_modules: None
-- llm_int8_enable_fp32_cpu_offload: False
-- llm_int8_has_fp16_weight: False
-- bnb_4bit_quant_type: nf4
-- bnb_4bit_use_double_quant: True
-- bnb_4bit_compute_dtype: float16
-### Framework versions
+### Model Description
 
+<!-- Provide a longer summary of what this model is. -->
 
-- PEFT 0.5.0
+
+
+- **Developed by:** [The Kaitchup](https://kaitchup.substack.com/)
+- **Model type:** LoRA Adapter for Llama 2 7B
+- **Language(s) (NLP):** French, English
+- **License:** MIT license
+
+
+
+## Uses
+
+This adapter must be loaded on top of Llama 2 7B. It has been fine-tuned with QLoRA. For optimal results, the base model must be loaded with the exact same configuration used during fine-tuning.
+You can use the following code to load the model:
+```
+from transformers import AutoTokenizer, AutoModelForCausalLM, BitsAndBytesConfig
+import torch
+from peft import PeftModel
+
+base_model = "meta-llama/Llama-2-7b-hf"
+compute_dtype = getattr(torch, "float16")
+bnb_config = BitsAndBytesConfig(
+    load_in_4bit=True,
+    bnb_4bit_quant_type="nf4",
+    bnb_4bit_compute_dtype=compute_dtype,
+    bnb_4bit_use_double_quant=True,
+)
+model = AutoModelForCausalLM.from_pretrained(
+        original_model_directory, device_map={"": 0}, quantization_config=bnb_config
+)
+tokenizer = AutoTokenizer.from_pretrained(base_model, use_fast=True)
+model = PeftModel.from_pretrained(model, "kaitchup/Llama-2-7b-mt-French-to-English")
+```
+
+Then, run the model as follows:
+
+```
+my_text = "" #put your text to translate here
+
+prompt = my_text+" ###>"
+
+tokenized_input = tokenizer(prompt, return_tensors="pt")
+input_ids = tokenized_input["input_ids"].cuda()
+
+generation_output = model.generate(
+        input_ids=input_ids,
+        num_beams=10,
+        return_dict_in_generate=True,
+        output_scores=True,
+        max_new_tokens=130
+
+)
+for seq in generation_output.sequences:
+    output = tokenizer.decode(seq, skip_special_tokens=True)
+    print(output.split("###>")[1].strip()) 
+```
+
+
+## Model Card Contact
+
+[The Kaitchup](https://kaitchup.substack.com/)