Update README.md

README.md

@@ -1,5 +1,5 @@
 ---
-license: cc-by-nc-sa-4.0
+license: apache-2.0
 task_categories:
 - question-answering
 language:
@@ -12,33 +12,71 @@ tags:
 size_categories:
 - 1K<n<10K
 ---
-# Dataset Card de Lingcomp_QA
+<!--
+Esta plantilla de Dataset Card es una adaptación de la de Hugging Face: https://github.com/huggingface/huggingface_hub/blob/main/src/huggingface_hub/templates/datasetcard_template.md
 
-<!-- Provide a quick summary of the dataset. -->
-Este es un dataset creado a partir de blogs de internet y páginas en abierto sobre lingüística computacional. Contiene algunos temas de estadística, lingüística e informática 
-(especialmente cuestiones relacionadas con Python, el principal lenguaje de programación para el procesamiento del lenguaje natural).
+¿Cómo utilizar esta plantilla? Copia el contenido en el README.md del repo de tu dataset en el Hub de Hugging Face y rellena cada sección.
 
-## Detalles del dataset
+Para más información sobre cómo rellenar cada sección ver las docs: https://huggingface.co/docs/hub/datasets-cards y https://huggingface.co/docs/datasets/dataset_card
 
-### Descripción del dataset
+Para más información sobre la dataset card metadata ver: https://github.com/huggingface/hub-docs/blob/main/datasetcard.md?plain=1
+-->
 
-<!-- Provide a longer summary of what this dataset is. -->
-Este dataset tiene la intención de ser educativo, explicando ciertos conceptos o respondiendo preguntas relacionadas con la evolución de la disciplina o de las funciones y aspectos
-básicos de Python y algunos paquetes como Wordnet o NLTK. También responde algunas cuestiones de lingüística de corpus y, por tanto, de estadística, especialmente cuestiones
-de explicación de conceptos. Actualmente tiene 1004 pares de pregunta-respuesta.
+# Dataset Card for LingComp_QA, un corpus educativo de lingüística computacional en español
 
+<!-- Suele haber un nombre corto ("pretty name") para las URLs, tablas y demás y uno largo más descriptivo. Para crear el pretty name podéis utilizar acrónimos. -->
 
-- **Recogido por:**
-(Universidad de Cádiz, Instituto de Lingüística Aplicada)
-  - [Jorge Zamora Rey] (https://huggingface.co/reddrex)
-  - [Isabel Moyano Moreno] (https://huggingface.co/issyinthesky)
-  - [Mario Crespo Miguel] (https://huggingface.co/MCMiguel)
-  
-- **Language(s) (NLP):** Spanish
-- **License:** Creative Commons Attribution Non Commercial Share Alike 4.0
+<!-- Resumen del corpus y motivación del proyecto (inc. los ODS relacionados). Esta sección es como el abstract. También se puede incluir aquí el logo del proyecto. -->
 
-### Formato del dataset
-El dataset tiene la siguiente forma:
+<!-- Si queréis incluir una versión de la Dataset Card en español, enlazarla aquí al principio (e.g. `README_es.md`).-->
+
+## Dataset Details
+
+### Dataset Description
+
+<!-- Resumen del dataset. -->
+
+- **Curated by:** Jorge Zamora Rey (https://huggingface.co/reddrex), Isabel Moyano Moreno (https://huggingface.co/issyinthesky), Mario Crespo Miguel (https://huggingface.co/MCMiguel) <!-- Nombre de los miembros del equipo -->
+- **Funded by:** SomosNLP, HuggingFace, Argilla, Universidad de Cádiz <!-- Si contasteis con apoyo de otra entidad (e.g. vuestra universidad), añadidla aquí -->
+- **Language(s) (NLP):** es-ES <!-- Enumerar las lenguas en las que se ha entrenado el modelo, especificando el país de origen. Utilizar códigos ISO. Por ejemplo: Spanish (`es-CL`, `es-ES`, `es-MX`), Catalan (`ca`), Quechua (`qu`).  -->
+- **License:** apache-2.0 <!-- Elegid una licencia lo más permisiva posible teniendo en cuenta la licencia del model pre-entrenado y los datasets utilizados -->
+
+### Dataset Sources
+
+- **Repository:** https://github.com/reddrex/lingcomp_QA/tree/main <!-- Enlace al `main` del repo donde tengáis los scripts, i.e.: o del mismo repo del dataset en HuggingFace o a GitHub. -->
+- **Paper:** Comming soon! <!-- Si vais a presentarlo a NAACL poned "WIP", "Comming soon!" o similar. Si no tenéis intención de presentarlo a ninguna conferencia ni escribir un preprint, eliminar. -->
+
+<!-- ### Dataset Versions & Formats [optional] -->
+
+<!-- Si tenéis varias versiones de vuestro dataset podéis combinarlas todas en un mismo repo y simplemente enlazar aquí los commits correspondientes. Ver ejemplo de https://huggingface.co/bertin-project/bertin-roberta-base-spanish -->
+
+<!-- Si hay varias formatos del dataset (e.g. sin anotar, pregunta/respuesta, gemma) las podéis enumerar aquí. -->
+
+## Uses
+
+<!-- Address questions around how the dataset is intended to be used. -->
+This dataset is intended for educational purposes. 
+
+### Direct Use
+
+<!-- This section describes suitable use cases for the dataset. -->
+
+
+[More Information Needed]
+
+### Out-of-Scope Use
+
+<!-- This section addresses misuse, malicious use, and uses that the dataset will not work well for. -->
+
+[More Information Needed]
+
+## Dataset Structure
+
+<!-- This section provides a description of the dataset fields, and additional information about the dataset structure such as criteria used to create the splits, relationships between data points, etc. -->
+
+<!-- En esta sección podéis enumerar y explicar cada columna del corpus. Para cada columna que sea de tipo "categoría" podéis indicar el porcentaje de ejemplos. -->
+
+The dataset's structure looks like this:
 
 ```json
 [
@@ -57,52 +95,113 @@ El dataset tiene la siguiente forma:
   {...}
 ]
 ```
+We have a "pregunta" or question column, and a "respuesta" or answer column, where each question has an answer associated. 
 
-### Uso del dataset
-Nuestra intención principal de cara al futuro es aumentarlo con otras fuentes de información y emplearlo para crear un agente conversacional que ayude a los alumnos
-de las asignaturas de Lingüística computacional e Ingeniería del Lenguaje del grado de Lingüística y lenguas aplicadas, además de otras personas interesadas en este ámbito,
-aunque nuestro foco principal son lingüistas, toda persona interesada es bienvenida.
+## Dataset Creation
 
-### Links del dataset
+### Curation Rationale
 
-<!-- Provide the basic links for the dataset. -->
-- **Repositorio:** https://github.com/reddrex/lingcomp_QA/tree/main
-<!-- Paper [optional]:** [More Information Needed] -->
+<!-- Motivation for the creation of this dataset. -->
 
-## Creación del dataset
-Para este dataset hemos empleado los apuntes de la asignatura de Lingüística computacional del grado de Lingüística y lenguas aplicadas de la universidad de Cádiz, y algunas
-cuestiones de la asignatura de Ingeniería del lenguaje. Además, hemos añadido la información que ha aparecido en páginas web en español, especialmente blogs, encontradas a través de Bootcat
-al realizar una búsqueda de términos de la lingüística computacional. Estos términos los hemos elegido de los principales temas tratados en libros específicos como el de Jurafsky y Martin de Speech and Language Processing.
+[More Information Needed]
 
-Herramientas: Bootcat para la extracción de .txt de webs, Sublime text para la organización en preguntas y respuestas en JSON y la limpieza con regex.
-
-### Fuentes de información
+### Source Data
 
 <!-- This section describes the source data (e.g. news text and headlines, social media posts, translated sentences, ...). -->
-Está conformado por preguntas y respuestas formuladas a partir de los apuntes de las asignaturas de las asignaturas mencionadas anteriormente, artículos de wikipedia y blogs
-que tratan información relacionada a términos de la lingüística computacional , o explican cómo utilizar ciertos paquetes o programar en Python.
-
-La información recogida está relacionada mayoritariamente con los siguientes conceptos:
-- Algoritmos y formalismos
-- Lenguaje de programación
-- CPU/GPU
-- Entornos como colab o jupyter
-- Python: tipos de datos, funciones built-in, métodos, programación orientada a objetos, comprensión de listas, etc.
-- NLTK
-- SpaCy
-- Historia y evolución del PLN
-- PLN/Lingüística computacional (sintaxis y semántica computacional, diferencias, conceptos...)
-- Lingüística
-- Recursos como FrameNet, WordNet, Treebank, Corpus Brown, ontologías
-- Lingüística de corpus: concordancias, colocaciones, cuestiones de estadística (chi-cuadrado, log-likelihood, datos, muestreo...)
-
-## Sesgos, Riesgos, y Limitaciones
+
+#### Data Collection and Processing
+
+<!-- This section describes the data collection and processing process such as data selection criteria, filtering and normalization methods, tools and libraries used, etc. -->
+
+<!-- Enlazar aquí los scripts y notebooks utilizados para generar el corpus. -->
+
+[More Information Needed]
+
+#### Who are the source data producers?
+
+<!-- This section describes the people or systems who originally created the data. It should also include self-reported demographic or identity information for the source data creators if this information is available. -->
+
+[More Information Needed]
+
+### Annotations [optional]
+
+<!-- If the dataset contains annotations which are not part of the initial data collection, use this section to describe them. -->
+
+#### Annotation process
+
+<!-- This section describes the annotation process such as annotation tools used in the process, the amount of data annotated, annotation guidelines provided to the annotators, interannotator statistics, annotation validation, etc. -->
+
+<!-- Enlazar aquí el notebook utilizado para crear el espacio de anotación de Argilla y la guía de anotación. -->
+
+[More Information Needed]
+
+#### Who are the annotators?
+
+<!-- This section describes the people or systems who created the annotations. -->
+The annotators are the members of our team: Jorge Zamora, Isabel Moyano and Mario Crespo. 
+
+#### Personal and Sensitive Information
+
+<!-- State whether the dataset contains data that might be considered personal, sensitive, or private (e.g., data that reveals addresses, uniquely identifiable names or aliases, racial or ethnic origins, sexual orientations, religious beliefs, political opinions, financial or health data, etc.). If efforts were made to anonymize the data, describe the anonymization process. -->
+
+[More Information Needed]
+
+## Bias, Risks, and Limitations
 
 <!-- This section is meant to convey both technical and sociotechnical limitations. -->
-Ha habido cierto límite de tiempo en el que es especialmente difícil recabar tanta información como la que puede haber en un campo como la lingüística computacional, así que
-nos hemos limitado a cubrir ciertos temas básicos relacionados con este ámbito. Además, otro problema es la escasez de información en abierto disponible para crear un corpus,
-ya que la mayoría de información que hemos encontrado en relación a estos temas pertenecía a artículos científicos. 
 
-<!-- ## Citation -->
+<!-- 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]
+
+### Recommendations
+
+<!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations.
+
+Example:
+
+Users should be made aware of the risks, biases and limitations of the dataset. More information needed for further recommendations. -->
+
+[More Information Needed]
+
+## 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). -->
+Apache 2.0
+
+## Citation
+
+<!-- If there is a paper or blog post introducing the dataset, the APA and Bibtex information for that should go in this section. -->
+
+**BibTeX:**
+
+```
+@software{LingComp_QA,
+  author = {Zamora Rey, Jorge and Crespo Miguel, Mario and Moyano Moreno, Isabel},
+  title = {LingComp_QA, un corpus educativo de lingüística computacional en español},
+  month = March,
+  year = 2024,
+  url = {https://huggingface.co/datasets/somosnlp/LingComp_QA}
+}
+```
+
+<!-- ## Glossary [optional] -->
+
+<!-- If relevant, include terms and calculations in this section that can help readers understand the dataset or dataset card. -->
+
+## More Information
+
+<!-- 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.
+
+**Team:** 
+
+- [Jorge Zamora Rey](https://huggingface.co/reddrex)
+- [Mario Crespo Miguel](https://huggingface.co/MCMiguel)
+- [Isabel Moyano Moreno](https://huggingface.co/issyinthesky)
+
+## Contact
 
-<!-- If there is a paper or blog post introducing the dataset, the APA and Bibtex information for that should go in this section. -->
+<!-- Email de contacto para posibles preguntas sobre el dataset. -->
+mario.crespo@uca.es