Update README.md

README.md

@@ -83,12 +83,12 @@ The following Figure illustrates examples of clickbait headlines from our datase
     <img src="https://raw.githubusercontent.com/ikergarcia1996/NoticIA/main/assets/examples.png" style="width: 100%;">
 </p>
 
-
+# Dataset Description
 - **Curated by:** [Iker García-Ferrero](https://ikergarcia1996.github.io/Iker-Garcia-Ferrero/), [Begoña Altuna](https://www.linkedin.com/in/bego%C3%B1a-altuna-78014139)
 - **Funded by:** SomosNLP, HuggingFace, Argilla, [HiTZ Zentroa](https://www.hitz.eus/)
 - **Language(s) (NLP):** es-ES
 - **License:** apache-2.0 
-- **Web Page**: [Github](https://github.com/ikergarcia1996/NoticIA)
+- **Web Page:** [Github](https://github.com/ikergarcia1996/NoticIA)
 
 ### Dataset Sources
 
@@ -109,10 +109,10 @@ the express permission of the media from which the news has been obtained.
 
 ### Direct Use
 
-- Evaluation of Language Models in Spanish.
-- Instruction-Tuning of Spanish Language Models
-- Develop new datasets on top of our data
-- Any other academic research purpose.
+- 📈 Evaluation of Language Models in Spanish.
+- 🤖 Instruction-Tuning of Spanish Language Models
+- 📚 Develop new datasets on top of our data
+- 🎓 Any other academic research purpose.
 
 ### Out-of-Scope Use
 
@@ -184,9 +184,9 @@ The dataset includes the following fields:
 
 ### Curation Rationale
 
-<!-- Motivation for the creation of this dataset. -->
+NoticIA offers an ideal scenario to test the ability of language models to understand Spanish texts. This task is complex, involving discerning the hidden question in a clickbait headline or identifying the information that the user is actually seeking. This challenge involves filtering large volumes of superfluous content to find and succinctly summarize the relevant information accurately.
 
-[More Information Needed]
+In addition, by making our data and models public, we aim to exert pressure against the use of deceptive tactics by online news providers to increase advertising revenue,
 
 ### Source Data
 
@@ -240,77 +240,78 @@ different interpretations of this information. In these cases, determining the c
 Regarding the evaluation of the guidelines, overall, they were not ambiguous, although the request to select the minimum number of words to generate a 
 valid summary is sometimes interpreted differently by the annotators: For example, the minimum length could be understood as focusing on the question in the headline or a minimum well-formed phrase.
 
+# Massive Evaluation of Language Models
 
-## Bias, Risks, and Limitations
+As is customary in summary tasks, we use the ROUGE scoring metric to automatically evaluate the summaries produced by models. Our main metric is ROUGE-1, which considers whole words as basic units. To calculate the ROUGE score, we lowercase both summaries and remove punctuation marks. In addition to the ROUGE score, we also consider the average length of the summaries. For our task, we aim for the summaries to be concise, an aspect that the ROUGE score does not evaluate. Therefore, when evaluating models, we consider both the ROUGE-1 score and the average length of the summaries. Our goal is to find a model that achieves the highest possible ROUGE score with the shortest possible summary length, balancing quality and brevity.
 
-<!-- This section is meant to convey both technical and sociotechnical limitations. -->
+We have evaluated the best current instruction-following language models. We used the previously defined prompt. The prompt is converted into the specific chat template of each model.
 
-<!-- Aquí podéis mencionar los posibles sesgos heredados según el origen de los datos y de las personas que lo han anotado, hablar del balance de las categorías representadas, los esfuerzos que habéis hecho para intentar mitigar sesgos y riesgos. -->
-
-[More Information Needed]
+The code to reproduce the results is available at the following link: [https://github.com/ikergarcia1996/NoticIA](https://github.com/ikergarcia1996/NoticIA)
 
-### Recommendations
+<p align="center">
+    <img src="https://huggingface.co/datasets/somosnlp/Resumen_Noticias_Clickbait/resolve/main/Results_zero.png" style="width: 100%;">
+</p>
 
-<!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations.
 
-Example:
+## Bias, Risks, and Limitations
 
-Users should be made aware of the risks, biases and limitations of the dataset. More information needed for further recommendations. -->
+The dataset contains a small number of articles from Latin America; however, the vast majority of the articles are from Spanish news sources. Therefore, this dataset will evaluate the proficiency of language models in Spanish from Spain.
 
-[More Information Needed]
+Although explicitly prohibited, a bad actor could use our data to train models that can generate clickbait articles automatically, contributing to polluting the internet with low-quality content. In any case, we consider the advantages of having a text comprehension dataset to evaluate language models in Spanish to be superior to the possible risks.
 
 ## License
 
-<!-- Indicar bajo qué licencia se libera el dataset explicando, si no es apache 2.0, a qué se debe la licencia más restrictiva (i.e. herencia de los datos utilizados). -->
+We release our annotations under the Apache 2.0 license. However, commercial use of this dataset is subject to the licenses of each news and media outlet.
 
 ## Citation
 
-<!-- If there is a paper or blog post introducing the dataset, the APA and Bibtex information for that should go in this section. -->
+If you use this dataset, please cite our paper: [NoticIA: A Clickbait Article Summarization Dataset in Spanish](https://arxiv.org/abs/2404.07611)
 
 **BibTeX:**
 
-[More Information Needed]
-
-<!--
-
-Aquí tenéis un ejemplo de cita de un dataset que podéis adaptar:
-
 ```
-@software{benallal2024cosmopedia,
-  author = {Ben Allal, Loubna and Lozhkov, Anton and Penedo, Guilherme and Wolf, Thomas and von Werra, Leandro},
-  title = {Cosmopedia},
-  month = February,
-  year = 2024,
-  url = {https://huggingface.co/datasets/HuggingFaceTB/cosmopedia}
+@misc{garcíaferrero2024noticia,
+      title={NoticIA: A Clickbait Article Summarization Dataset in Spanish}, 
+      author={Iker García-Ferrero and Begoña Altuna},
+      year={2024},
+      eprint={2404.07611},
+      archivePrefix={arXiv},
+      primaryClass={cs.CL}
 }
 ```
 
-- benallal2024cosmopedia -> nombre + año + nombre del dataset
-- author: lista de miembros del equipo
-- title: nombre del dataset
-- year: año
-- url: enlace al dataset
 
--->
 
-## Glossary [optional]
+## More Information
 
-<!-- If relevant, include terms and calculations in this section that can help readers understand the dataset or dataset card. -->
 
-## More Information
+This project was developed during the [Hackathon #Somos600M](https://somosnlp.org/hackathon) organized by SomosNLP. Demo endpoints were sponsored by HuggingFace.
+
+**Team:** 
+
+
+- [Iker García-Ferrero](https://huggingface.co/Iker)
+- [Begoña Altura](https://huggingface.co/baltuna)
+
+**Contact**: {iker.garciaf,begona.altuna}@ehu.eus
 
-<!-- Indicar aquí que el marco en el que se desarrolló el proyecto, en esta sección podéis incluir agradecimientos y más información sobre los miembros del equipo. Podéis adaptar el ejemplo a vuestro gusto. -->
 
-This project was developed during the [Hackathon #Somos600M](https://somosnlp.org/hackathon) organized by SomosNLP. The dataset was created using `distilabel` by Argilla and endpoints sponsored by HuggingFace.
+Este dataset ha sido creado por [Iker García-Ferrero](https://ikergarcia1996.github.io/Iker-Garcia-Ferrero/) y [Begoña Altuna](https://www.linkedin.com/in/bego%C3%B1a-altuna-78014139). 
+Somos investigadores en PLN en la Universidad del País Vasco, dentro del grupo de investigación [IXA](https://www.ixa.eus/) y formamos parte de [HiTZ, el Centro Vasco de Tecnología de la Lengua](https://www.hitz.eus/es).
 
-**Team:** [More Information Needed]
 
-<!--
-- [Name 1](Link to Hugging Face profile)
-- [Name 2](Link to Hugging Face profile)
--->
+<div style="display: flex; justify-content: space-around; width: 100%;">
+  <div style="width: 50%;" align="left">
+    <a href="http://ixa.si.ehu.es/">
+      <img src="https://raw.githubusercontent.com/ikergarcia1996/Iker-Garcia-Ferrero/master/icons/ixa.png" width="50" height="50"  alt="Ixa NLP Group">
+    </a>
+  </div>
+  <div style="width: 50%;" align="right">
+    <a href="http://www.hitz.eus/">
+      <img src="https://raw.githubusercontent.com/ikergarcia1996/Iker-Garcia-Ferrero/master/icons/Hitz.png" width="300" height="50" alt="HiTZ Basque Center for Language Technologies">
+    </a>
+  </div>
+</div>
 
-## Contact [optional]
 
-<!-- Email de contacto para´posibles preguntas sobre el dataset. -->