Create README.md (#6)

- Create README.md (668281199328a516fb5ca3eb446916fb2f79f2e1)


Co-authored-by: Gabriela Zuñiga <[email protected]>

README_ES.md

@@ -1,51 +1,181 @@
 ---
-license: cc-by-nc-sa-4.0
+license: cc-by-4.0
 task_categories:
 - text-classification
 language:
 - es
-pretty_name: Pa
-tags:
-- climate
+pretty_name: ClimID
+size_categories:
+- 1K<n<10K
 ---
-## Resumen: 
-El siguiente dataset es una fusión de diferentes fuentes (open-source), que incluye:
-- Traducción al español del dataset: https://huggingface.co/datasets/climatebert/climate_detection 
-- Noticias en español de temas no relacionados al cambio climatico:  https://www.kaggle.com/datasets/kevinmorgado/spanish-news-classification
-  Para este dataset se ha discriminado la columna con noticias y los temas Macroeconomía, Innovación, Regulaciones, Alianzas, Reputación, los que han sido etiquetados con (0)
-  El dataset también contenía el tema Sustentabilidad como tema pero fue eliminado (solo requerimos textos no relacionados).
-- Traduccion de opiniones relacionadas al cambio climatico: https://data.world/crowdflower/sentiment-of-climate-change
-  En este dataset todas las opiniones son relacionadas al cambio climatico por lo que fueron etiquetadas con (1). Se ha realizado una limpieza de datos quitando harshtags, usernames y emogis para usar solo el contenido textual de los tweets.   
-- Traduccion de tweets de noticias no relacionadas al cambio climatico: https://www.kaggle.com/datasets/muhammadmemoon/los-angeles-twitter-news-dataset
-  En este dataset las noticias estan categorizadas y tienen longitud corta (como las opiniones)todo texto es no relacionado al cambio climatico por lo que fueron etiquetados con (0). Se ha realizado una limpieza de datos quitando harshtags, usernames y emogis para usar solo el contenido textual de los tweets. Se ha elegido este dataset para equilibrar la cantidad de texto relacionado y para incluir textos cortos no relacionados al entrenamiento.
-### Tareas en las que se puede utilizar: 
-Clasificación binaria sobre párrafos relacionados a cambio climatico o sustentabilidad. 
-
-## Estructura del dataset:
-- **question:** Texto
-- **answer:** etiqueta binaria, si el texto es relacionado a cambio climatico o sustentabilidad (1) si el texto no es relacionado (0)
-- **dominio:** Identifica a que tema esta relacionada el texto, en nuestro caso tenemos 3 tipos "cambio_climatico_reportes", "prensa_miscelaneo", "cambio_climatico". Cambio climatico reportes hace referencia a los parrafos que hablan de cambio climatico pero fueron extraidos de reportes anuales corporativos. Prensa miscelaneo son parrafos de temas diversos extraidos de prensa. Cambio climatico, todos los parrafos que hablen de esta tematica y no tengan alguna fuenta de información especial.
-- **Pais de origen:** De donde provienen estos datos geograficamente. Incluimos 3 categorías: "global", "España", "USA". Global son los datos que fueron tomados de fuentes que no indican su origen especifico pero sabemos que fueron tomados de repositorios de datos con fuentes de cualquier país de origen.
-- **Idioma:** Variedad geografica del español utilizado. En este caso utilizamos 2 tipos "es_pe", "es_esp", esto debido a que muchos de los datos tuvieron que ser traducidos del ingles a español, se realizaron anotaciones utilizando el idioma regional del equipo que colaboró con la traducción.
-- **Registro:** Variedad funcional del lenguaje. Dentro de este dataset se identifican 3 tipos: "culto", "medio", "coloquial" en dependencia del origen de los datos.
-- **Tarea:** Identifica a que fin esta destinado el dato de entrada.
-- **Periodo:** En que época se ubica el lenguaje utilizado. Este dataset se utiliza lenguaje actual.
-
-### Ejemplo de una instancia:
-```
-{
-  'question': 'En enero de 2020, se introdujo en Australia un nuevo método de estimación para notificar las emisiones de gas no contabilizadas (UAFG) resultantes de las actividades de distribución de gas natural. Este método permite utilizar valores de UAFG específicos de cada emplazamiento/red, lo que nos permite traducir las actividades de mantenimiento y sustitución de la red en reducciones notificables de las emisiones de UAFG.',
-  'answer': 1
-  'dominio':'cambio_climatico_reportes'
-  'país_de_origen':'global'
-  'idioma':'es_pe'
-  'registro':'culto'
-  'tarea':'clasificacion'
-  'periodo':'actual'
-}
-```
+# Dataset Card for BERTIN-ClimID: BERTIN-Base Climate-related text Identification
+README Spanish Version: [README_ES](https://huggingface.co/datasets/somosnlp/spa_climate_detection/blob/main/README_ES.md) 
+
+Dataset for BERTIN-ClimID was developed as the fusion of different sources (open-source).
+
+<!--
+
+Nombre del corpus:
+
+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.
+
+Idioma:
+
+La Dataset Card puede estar en español o en inglés. Recomendamos que sea en inglés para que la comunidad internacional pueda utilizar vuestro dataset. Teniendo en cuenta que somos una comunidad hispanohablante y no queremos que el idioma sea una barrera, la opción más inclusiva sería escribirla en un idioma y traducirla (automáticamente?) al otro. En el repo entonces habría un README.md (Dataset Card en inglés) que enlazaría a un README_ES.md (Dataset Card en español), o viceversa, README.md y README_EN.md. Si necesitáis apoyo con la traducción os podemos ayudar.
+
+Qué incluir en esta sección:
+
+Esta sección es como el abstract. Escribir un resumen del corpus y motivación del proyecto (inc. los ODS relacionados).  Si el proyecto tiene un logo, incluidlo aquí.
+
+Si queréis incluir una versión de la Dataset Card en español, enlazadla aquí al principio (e.g. "A Spanish version of this Dataset Card can be found under [`README_es.md`](URL)"). De manera análoga para el inglés.
+
+-->
+
+## Dataset Details
+
+### Dataset Description
+
+<!-- Una frase de resumen del dataset. -->
+- **Curated by:** [Gerardo Huerta](https://huggingface.co/Gerard-1705) [Gabriela Zuñiga](https://huggingface.co/Gabrielaz)
+- **Funded by:** SomosNLP, HuggingFace
+- **Language(s):** es-ES, es-PE
+- **License:** cc-by-nc-sa-4.0
+
+### Dataset Sources
+
+- **Repository:** [somosnlp/spa_climate_detection](https://huggingface.co/datasets/somosnlp/spa_climate_detection) <!-- Enlace al `main` del repo donde tengáis los scripts, i.e.: o del mismo repo del dataset en HuggingFace o a GitHub. -->
+- **Paper:** [WIP] <!-- 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. -->
+- **Video presentation:** [Proyecto BERTIN-ClimID](https://www.youtube.com/watch?v=sfXLUP9Ei-o) <!-- Enlace a vuestro vídeo de presentación en YouTube (están todos subidos aquí: https://www.youtube.com/playlist?list=PLTA-KAy8nxaASMwEUWkkTfMaDxWBxn-8J) -->
+
+<!-- ### 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. -->
+
+### Direct Use
+- News classification: With this model it is possible to classify news headlines related to the areas of climate change.
+- Paper classification: The identification of scientific texts that disclose solutions and/or effects of climate change. For this use, the abstract of each paper can be used for identification.
+-Social Media posts Classification: Classify social media posts (short texts) related or not to climate areas
+<!-- This section describes suitable use cases for the dataset. -->
+
+
+### Out-of-Scope Use
+- For the creation of information repositories regarding climate issues.
+- This model can serve as a basis for creating new classification systems for climate solutions to disseminate new efforts to combat climate change in different sectors.
+- Creation of new datasets that address the issue. 
+<!-- This section addresses misuse, malicious use, and uses that the dataset will not work well for. -->
+
+## Dataset Structure
+- **question:** Text
+- **answer:** binary label, if the text is related to climate change or sustainability (1) if the text is not related (0)
+- **domain:** Identifies what topic the text is related to, in our case we have 3 types "climate_change_reports", "miscellaneous_press", "climate_change". Climate change reports refers to the paragraphs that talk about climate change but were extracted from corporate annual reports. Miscellaneous press are paragraphs on various topics extracted from the press. Climate change, all paragraphs that talk about this topic and do not have any special source of information.
+- **Country of origin:** Where this data comes from geographically. We include 3 categories: "global", "Spain", "USA". Global is data that was taken from sources that do not indicate its specific origin but we know that it was taken from data repositories with sources from any country of origin.
+- **Language:** Geographic variety of Spanish used. In this case we used 2 types "es_pe", "es_esp", this is because many of the data had to be translated from English to Spanish, annotations were made using the regional language of the team that collaborated with the translation.
+- **Registration:** Functional variety of language. Within this dataset, 3 types are identified: "cult", "medium", "colloquial" depending on the origin of the data.
+- **Task:** Identifies the purpose for which the input data is intended.
+- **Period:** In what era the language used is located. This dataset uses actual language.
+<!-- 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. -->
+
+<!--
+
+Enumerar y explicar cada columna del corpus. Para cada columna que sea de tipo "categoría" indicar el porcentaje de ejemplos. Podéis encontrar la estructura de corpus propuesta en [estructura_corpus.md](/plantillas_docs_proyectos/estructura_corpus.md).
+
+Ejemplo:
+
+El corpus cuenta con un total de X ejemplos y contiene las siguientes columnas:
+- `pregunta`
+- `respuesta`
+- `idioma` (variedad geográfica): código ISO del idioma. Distribución: 33% `es_AR`, 33% `es_UY`, 33% `es_PY`
+- `registro` (variedad funcional): `coloquial`, `medio` o `culto`. Distribución: 100% `coloquial.
+- `periodo` (variedad histórica): `actual`, `moderno` (ss. XVIII-XIX), `clásico` (ss. XVI-XVII) o `medieval`. Distribución: 100% `actual`.
+- `dominio`: dominio de la instrucción. Distribución: 10% `sociales_historia`, ...
+- `tarea`: tarea de la instrucción. Distribución: 100% `resumen`.
+- `país_origen`: código ISO del país de origen de los datos. Distribución:
+- `país_referencia`: código ISO del país al que hace referencia la pregunta. Distribución: 55% en blanco, 5% ..., ...
+
+-->
+
+[More Information Needed]
+
+## Dataset Creation
+
+### Curation Rationale
+The motivation of the dataset creation was to create a repository in Spanish on information or resources on topics such as: climate change, sustainability, global warming, energy, etc; this because we didn't found a dataset like this one. Climate change and global warming are current main problems globally so it's important to fight this harm in all places with all languages, also to bring solutions and share information accesible for everyone
+
+<!-- Motivation for the creation of this dataset. -->
+
+### Source Data
+We used several sources of data to make a varied dataset that could work with different types of texts, from articles, news, social media posts and other texts. we included:
+
+- Spanish translation of the dataset: [climate Bert] (https://huggingface.co/datasets/climatebert/climate_detection)
+- News in Spanish on topics not related to climate change:[Spanish news headers](https://www.kaggle.com/datasets/kevinmorgado/spanish-news-classification)
+- Translation of opinions related to climate change: [Opinions](https://data.world/crowdflower/sentiment-of-climate-change)
+- Translation of news tweets not related to climate change: [Posts](https://www.kaggle.com/datasets/muhammadmemoon/los-angeles-twitter-news-dataset)
+   
+<!-- This section describes the source data (e.g. news text and headlines, social media posts, translated sentences, ...). -->
+
+<!-- Incluir siempre que sea posible enlaces a los datos de origen. -->
+
+#### Data Collection and Processing
+
+- Spanish translation of the dataset: [climate Bert](https://huggingface.co/datasets/climatebert/climate_detection)
+- News in Spanish on topics not related to climate change:[Spanish news headers](https://www.kaggle.com/datasets/kevinmorgado/spanish-news-classification)
+   For this dataset, the column with news and the topics Macroeconomics, Innovation, Regulations, Alliances, Reputation have been discriminated, which have been labeled with (0)
+   The dataset also contained the topic Sustainability as a topic but it was removed (we only required unrelated texts).
+- Translation of opinions related to climate change: [Opinions](https://data.world/crowdflower/sentiment-of-climate-change)
+   In this dataset all opinions are related to climate change, which is why they were labeled with (1). Data cleaning has been carried out by removing harshtags, usernames and emogis to use only the textual content of the tweets.
+- Translation of news tweets not related to climate change: [Posts](https://www.kaggle.com/datasets/muhammadmemoon/los-angeles-twitter-news-dataset)
+   In this dataset the news is categorized and has short length (like opinions) all text is not related to climate change so they were labeled with (0). Data cleaning has been carried out by removing harshtags, usernames and emogis to use only the textual content of the tweets. This dataset has been chosen to balance the amount of related text and to include short texts not related to training.
+   <!-- 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. -->
+
+#### Who are the source data producers?
+- Climate bert dataset: Large Companies listed on paper(original dataset).
+- Spanish News: Web scrapping from Bank news sites
+- Opinions from climate change: Tweets extraction
+- Opinions not related to climate change: Tweets of around 2 month of Los Angeles News from twitter. 
+
+<!-- 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. -->
+
+### Annotations 
+
+<!-- If the dataset contains annotations which are not part of the initial data collection, use this section to describe them. -->
+
+#### Annotation process
+All the records had the corresponding annotation (related or not related to climate and global warming), but we only changed the text values to binary values (1 / 0)
+<!-- 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. -->
+
+
+
+#### Who are the annotators?
+
+<!-- This section describes the people or systems who created the annotations. -->
+
+[More Information Needed]
+
+#### Personal and Sensitive Information
+In this case it was not necessary to have an anonymization process
+<!-- 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. -->
+
+
+## Bias, Risks, and Limitations
+
+<!-- This section is meant to convey both technical and sociotechnical limitations. -->
+
+<!-- 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. -->
+At this point, no specific studies have been carried out on biases and limitations, however we make the following notes based on previous experience and model testing:
+- It inherits the biases and limitations of the base model with which it was trained.
+- Direct biases such as the majority use of high-level language in the dataset due to the use of texts extracted from news, legal documentation of companies that can complicate the identification of texts with low-level languages (example: colloquial). To mitigate these biases, diverse opinions on climate change topics extracted from sources such as social networks were included in the dataset, and the labels were additionally rebalanced (see tables below).
+- The dataset inherits other limitations such as: the model loses performance in short texts, this is because most of the texts used in the dataset have a long length of between 200 - 500 words. Once again, an attempt was made to mitigate these limitations with the inclusion of short texts.
 
-### Esta dividido en:
 - train:
 
 | Número | Label | % |
@@ -54,9 +184,54 @@ Clasificación binaria sobre párrafos relacionados a cambio climatico o sustent
 | 1300   | 0   | 45%   |
   
 - test:
+
 | Número | Label | % |
 |----------|----------|----------|
 | 480    | 1  | 62%   |
 | 300   | 0   | 38%   |
 
 
+### Recommendations
+Our recommendation is to continue adding more samples of spanish text in both large and short length.
+<!-- 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
+cc-by-nc-sa-4.0  Due to inheritance of the data used in the dataset.
+<!-- 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). -->
+
+## 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:**
+```
+@misc{BERTIN-ClimID,
+  author = {Gerardo Huerta, Gabriela Zuñiga},
+  title = {Dataset for BERTIN-ClimID: BERTIN-Base Climate-related text Identification},
+  month = Abril,
+  year = 2024,
+  url = {https://huggingface.co/datasets/somosnlp/spa_climate_detectiona}
+}
+
+```
+
+<!--## Glossary [optional]
+ 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. We thank all event organizers and sponsors for their support during the event.
+
+**Team:**
+
+- [Gerardo Huerta](https://huggingface.co/Gerard-1705)
+- [Gabriela Zuñiga](https://huggingface.co/Gabrielaz)
+
+## Contact
+
+- [email protected]
+- [email protected]