Update README.md

README.md

@@ -9,11 +9,11 @@ language:
 
 # Llama3-8B Adapter Fine-Tuned for Galician language
 
-This repository contains a Lora adapter to finetune Meta's LLaMA 3-8B Instruct LLM to Galician language.
+This repository contains a Lora Adapter to finetune Meta's LLaMA 3-8B Instruct LLM to Galician language.
 
-## Model Description
+## Model Adapter Description
 
-This Lora adapter has been specifically fine-tuned to understand and generate text in Galician. It was refined using a modified version of the [irlab-udc/alpaca_data_galician](https://huggingface.co/datasets/irlab-udc/alpaca_data_galician) dataset, enriched with synthetic data to enhance its text generation and comprehension capabilities in specific contexts.
+This Lora Adapter has been specifically fine-tuned to understand and generate text in Galician. It was refined using a modified version of the [irlab-udc/alpaca_data_galician](https://huggingface.co/datasets/irlab-udc/alpaca_data_galician) dataset, enriched with synthetic data to enhance its text generation and comprehension capabilities in specific contexts.
 
 ### Technical Details
 
@@ -35,7 +35,7 @@ The project is still in the testing phase, and the training parameters will cont
 - learning_rate=5e-5
 - max_grad_norm=1.0
 
-## Testing The Model
+## Testing The Adapter
 
 Below, we have several examples of question-answer pairs comparing the pure Llama3 model with the Llama3 model fine tunned for the Galician language.
 
@@ -44,7 +44,7 @@ Below, we have several examples of question-answer pairs comparing the pure Llam
 User: Cal é a capital de Canadá?
 Assistant: Não! Cal não é a capital de Canadá. A capital de Canadá é Ottawa.
 ```
-*Llama3-8B-Galician-Chat* ✅ 👍
+*Llama3-8B-Galician-Chat-Lora* ✅ 👍
 ```bash
 User: Cal é a capital de Canadá?
 Assistant: A capital de Canadá é Ottawa.
@@ -54,7 +54,7 @@ Assistant: A capital de Canadá é Ottawa.
 User: Cantos habitantes ten Galicia?
 Assistant: Según el Instituto Nacional de Estadística (INE) de España, la población residente en Galicia al 1 de enero de 2021 era de aproximadamente 2.79 millones de personas.
 ```
-*Llama3-8B-Galician-Chat* ✅ 👍
+*Llama3-8B-Galician-Chat-Lora* ✅ 👍
 ```bash
 User: Cantos habitantes ten Galicia?
 Assistant: Segundo as últimas estimacións, Galicia ten uns 2,8 millóns de habitantes.
@@ -62,18 +62,18 @@ Assistant: Segundo as últimas estimacións, Galicia ten uns 2,8 millóns de hab
 
 ## How to Use the Model
 
-To use this model, follow the example code provided below. Ensure you have the necessary libraries installed (e.g., Hugging Face's `transformers`).
+To use this adapter, follow the example code provided below. Ensure you have the necessary libraries installed (e.g., Hugging Face's `transformers`).
 
 ### Installation
 ```bash
-git clone https://huggingface.co/abrahammg/Llama3-8B-Galician-Chat
+git clone https://huggingface.co/abrahammg/Llama3-8B-Galician-Chat-Lora
 ```
 
 ```bash
 pip install transformers bitsandbytes "unsloth[colab-new] @ git+https://github.com/unslothai/unsloth.git" llmtuner xformers
 ```
 
-### Run the model
+### Run the adapter
 
 ```bash
 from llmtuner import ChatModel
@@ -81,10 +81,10 @@ from llmtuner.extras.misc import torch_gc
 
 chat_model = ChatModel(dict(
   model_name_or_path="unsloth/llama-3-8b-Instruct-bnb-4bit", # use bnb-4bit-quantized Llama-3-8B-Instruct model
-  adapter_name_or_path="./",            # load the saved LoRA adapters
-  finetuning_type="lora",                  # same to the one in training
-  template="llama3",                     # same to the one in training
-  quantization_bit=4,                    # load 4-bit quantized model
+  adapter_name_or_path="./",            # load Llama3-8B-Galician-Chat-Lora adapter
+  finetuning_type="lora",               
+  template="llama3",                    
+  quantization_bit=4,                   # load 4-bit quantized model
   use_unsloth=True,                     # use UnslothAI's LoRA optimization for 2x faster generation
 ))
 
@@ -114,12 +114,12 @@ torch_gc()
 ## Citation
 
 ```markdown
-@misc{Llama3-8B-Galician-Chat,
+@misc{Llama3-8B-Galician-Chat-Lora,
   author = {Abraham Martínez Gracia},
   organization={Galicia Supercomputing Center},
-  title = {Llama3-8B-Galician-Chat: A finetuned chat model for Galician language},
+  title = {Llama3-8B-Galician-Chat-Lora: A finetuned chat model for Galician language},
   year = {2024},
-  url = {https://huggingface.co/abrahammg/Llama3-8B-Galician-Chat}
+  url = {https://huggingface.co/abrahammg/Llama3-8B-Galician-Chat-Lora}
 }
 ```