Update README.md

README.md

@@ -16,7 +16,9 @@ inference: false
 
 # Model Card for LINCE-ZERO
 
-**LINCE ZERO** (Llm for Instructions from Natural Corpus en Español) is a state-of-the-art Spanish instruction language model. Developed by [Clibrain](https://www.clibrain.com/), it is a causal decoder-only model with 7B parameters. LINCE-ZERO is based on [Falcon-7B](https://huggingface.co/tiiuae/falcon-7b) and has been fine-tuned using an augmented combination of the [Alpaca](https://huggingface.co/datasets/tatsu-lab/alpaca) and [Dolly](https://huggingface.co/datasets/databricks/databricks-dolly-15k) datasets, both translated into Spanish.
+**LINCE-ZERO** (Llm for Instructions from Natural Corpus en Español) is a SOTA Spanish instruction-tuned LLM 🔥
+
+Developed by [Clibrain](https://www.clibrain.com/), it is a causal decoder-only model with 7B parameters. LINCE-ZERO is based on [Falcon-7B](https://huggingface.co/tiiuae/falcon-7b) and has been fine-tuned using a combination of the [Alpaca](https://huggingface.co/datasets/tatsu-lab/alpaca) and [Dolly](https://huggingface.co/datasets/databricks/databricks-dolly-15k) datasets, both translated into Spanish and augmented to 80k examples.
 
 The model is released under the Apache 2.0 license.
 
@@ -24,6 +26,7 @@ The model is released under the Apache 2.0 license.
     <img src="https://huggingface.co/clibrain/lince-zero/resolve/main/LINCE-CLIBRAIN-HD.jpg" alt="lince logo"">
 </div>
 
+<br />
 
 # Table of Contents
 
@@ -46,7 +49,6 @@ The model is released under the Apache 2.0 license.
     - [Factors](#factors)
     - [Metrics](#metrics)
   - [Results](#results)
-- [Model Examination](#model-examination)
 - [Environmental Impact](#environmental-impact)
 - [Technical Specifications](#technical-specifications)
   - [Model Architecture and Objective](#model-architecture-and-objective)
@@ -57,24 +59,24 @@ The model is released under the Apache 2.0 license.
 - [Contact](#contact)
 - [How to Get Started with the Model](#how-to-get-started-with-the-model)
 
-# Model Details
+# 🐯 Model Details
 
 ## Model Description
 
-LINCE-ZERO (Llm for Instructions from Natural Corpus en Español) is a state-of-the-art Spanish instruction language model. Developed by [Clibrain](https://www.clibrain.com/), it is a causal decoder-only model with 7B parameters. LINCE-ZERO is based on [Falcon-7B](https://huggingface.co/tiiuae/falcon-7b) and has been fine-tuned using an augmented combination of the [Alpaca](https://huggingface.co/datasets/tatsu-lab/alpaca) and [Dolly](https://huggingface.co/datasets/databricks/databricks-dolly-15k) datasets, both translated into Spanish.
+LINCE-ZERO (Llm for Instructions from Natural Corpus en Español) is a state-of-the-art Spanish instruction-tuned large language model. Developed by [Clibrain](https://www.clibrain.com/), it is a causal decoder-only model with 7B parameters. LINCE-ZERO is based on [Falcon-7B](https://huggingface.co/tiiuae/falcon-7b) and has been fine-tuned using an 80k examples augmented combination of the [Alpaca](https://huggingface.co/datasets/tatsu-lab/alpaca) and [Dolly](https://huggingface.co/datasets/databricks/databricks-dolly-15k) datasets, both translated into Spanish.
 
 - **Developed by:** [Clibrain](https://www.clibrain.com/)
 - **Model type:** Language model, instruction model, causal decoder-only
 - **Language(s) (NLP):** es
 - **License:** apache-2.0
-- **Parent Model:** [https://huggingface.co/tiiuae/falcon-7b](https://huggingface.co/tiiuae/falcon-7b)
+- **Parent Model:** https://huggingface.co/tiiuae/falcon-7b
 
 ## Model Sources
 
-- **Paper**: Coming soon!
-- **Demo**: Coming soon!
+- **Paper**: Coming soon! ✨
+- **Demo**: Coming soon! ✨
 
-# Uses
+# 💡 Uses
 
 ## Direct Use
 
@@ -90,7 +92,7 @@ LINCE-ZERO is an instruct model, it’s primarily intended for direct use and ma
 
 LINCE-ZERO should not be used for production purposes without conducting a thorough assessment of risks and mitigation strategies. 
 
-# Bias, Risks, and Limitations
+# ⚠️ Bias, Risks, and Limitations
 
 LINCE-ZERO has limitations associated with both the underlying language model and the instruction tuning data. It is crucial to acknowledge that predictions generated by the model may inadvertently exhibit common deficiencies of language models, including hallucination, toxicity, and perpetuate harmful stereotypes across protected classes, identity characteristics, and sensitive, social, and occupational groups.
 
@@ -105,7 +107,7 @@ Please, when utilizing LINCE-ZERO, exercise caution and critically assess the ou
 
 If considering LINCE-ZERO for production use, it is crucial to thoroughly evaluate the associated risks and adopt suitable precautions. Conduct a comprehensive assessment to address any potential biases and ensure compliance with legal and ethical standards.
 
-# Training Details
+# 📚 Training Details
 
 ## Training Data
 
@@ -115,6 +117,8 @@ Alpaca is a 24.2 MB dataset of 52,002 instructions and demonstrations in English
 
 Dolly is a 13.1 MB dataset of 15,011 instruction-following records in American English. It was generated by thousands of Databricks employees, who were requested to provide reference texts copied from Wikipedia for specific categories. To learn more, consult [Dolly’s Data Card](https://huggingface.co/datasets/databricks/databricks-dolly-15k).
 
+After combining both translations, the dataset was augmented to a total of 80k examples.
+
 ## Training Procedure
 
 For detailed information about the model architecture and compute infrastructure, please refer to the Technical Specifications section.
@@ -133,7 +137,7 @@ More information needed
 
 More information needed (throughput, start/end time, checkpoint size if relevant, etc.)
 
-# Evaluation
+# ✅ Evaluation
 
 ## Testing Data, Factors & Metrics
 
@@ -149,9 +153,9 @@ Since LINCE-ZERO is an instruction model, the metrics used to evaluate it are:
 
 ### Results
 
-Paper coming soon. Meanwhile, check the [OpenLLM Leaderboard](https://huggingface.co/spaces/HuggingFaceH4/open_llm_leaderboard).
+Paper coming soon! Meanwhile, check the [OpenLLM Leaderboard](https://huggingface.co/spaces/HuggingFaceH4/open_llm_leaderboard).
 
-# Technical Specifications
+# ⚙️ Technical Specifications
 
 ## Model Architecture and Objective
 
@@ -173,7 +177,7 @@ LINCE-ZERO was trained on AWS SageMaker, on ... GPUs in ... instances.
 
 More information needed
 
-# Environmental Impact
+# 🌳 Environmental Impact
 
 Carbon emissions can be estimated using the [Machine Learning Impact calculator](https://mlco2.github.io/impact#compute) presented in [Lacoste et al. (2019)](https://arxiv.org/abs/1910.09700).
 
@@ -183,25 +187,25 @@ Carbon emissions can be estimated using the [Machine Learning Impact calculator]
 - **Compute Region:** More information needed
 - **Carbon Emitted:** More information needed
 
-# Citation
+# 📝 Citation
 
 There is a paper coming soon! Meanwhile, when using LINCE-ZERO please use the following information to cite:
 
 ```markdown
 @article{lince-zero,
-  title={{LINCE}: Llm for Instructions from Natural Corpus en Español},
+  title={{LINCE-ZERO}: Llm for Instructions from Natural Corpus en Español},
   author={},
   year={2023}
 }
 ```
 
-# Contact
+# 📧 Contact
 
 [contacto@clibrain.com](mailto:contacto@clibrain.com)
 
-# How to Get Started with LINCE-ZERO
+# 🔥 How to Get Started with LINCE-ZERO
 
-Use the code below to get started with LINCE-ZERO 🔥
+Use the code below to get started with LINCE-ZERO!
 
 ```py
 import torch