Update README.md

README.md

@@ -9,6 +9,10 @@ base_model: tiiuae/falcon-7b
 model-index:
 - name: falcon7b-linear-equations
   results: []
+datasets:
+- Menouar/LinearEquations
+language:
+- en
 ---
 
 <!-- This model card has been generated automatically according to the information the Trainer had access to. You
@@ -16,22 +20,35 @@ should probably proofread and complete it, then remove this comment. -->
 
 # falcon7b-linear-equations
 
-This model is a fine-tuned version of [tiiuae/falcon-7b](https://huggingface.co/tiiuae/falcon-7b) on an unknown dataset.
+This model is a fine-tuned version of [tiiuae/falcon-7b](https://huggingface.co/tiiuae/falcon-7b) on a simple dataset of [linear equations](https://huggingface.co/datasets/Menouar/LinearEquations). 
 
 ## Model description
 
-More information needed
+The objective of this model is to test Falcon7B's ability to solve mathematical linear equations after fine-tuning. The linear equations are in the form:
+
+```
+Ay + ay + b + B = Dy + dy + c + C
+```
+This model was trained using TRL, LoRA quantization, and Flash Attention.
+
+Due to limited GPU resources, I only considered 20,000 samples for training.
+
+For more information, check my [Notebook](https://colab.research.google.com/drive/1e8t5Cj6ZDAOc-z3bweWuBxF8mQZ9IPsH?usp=sharing).
 
-## Intended uses & limitations
 
-More information needed
+## Intended uses & limitations
+The model can solve any equation of the form ```Ay + ay + b + B = Dy + dy + c + C``` with integer coefficients ranging from -10 to 10. It cannot solve linear equations which have more constants than: A, a, b, B, c, C. It also cannot solve linear equations which have constants larger than 10 or smaller than -10. These limitations are due to the nature of the samples within the dataset and the ability of Large Language Models (LLMs) to perform simple computations between numbers. The goal of this work is to demonstrate that fine-tuning an LLM on a specific dataset can yield excellent results for handling a specific task, as is the case with our new model compared to the original one.
 
 ## Training and evaluation data
 
-More information needed
+I will complete the evaluation data later, but for now, 
+let’s show an example of a linear equation where this model finds the correct solution, unlike other models such as ChatGPT3.5, Bard, Llama 70B, and Mixtral:
+
 
 ## Training procedure
 
+For more information, check my [Notebook](https://colab.research.google.com/drive/1e8t5Cj6ZDAOc-z3bweWuBxF8mQZ9IPsH?usp=sharing).
+
 ### Training hyperparameters
 
 The following hyperparameters were used during training:
@@ -48,7 +65,7 @@ The following hyperparameters were used during training:
 
 ### Training results
 
-
+The training results can be found [here](https://huggingface.co/Menouar/falcon7b-linear-equations/tensorboard)
 
 ### Framework versions