Upload climate-evaluation.py

climate-evaluation.py

@@ -0,0 +1,254 @@
+"""Climate Evaluation: Datasets used in the ClimateGPT paper"""
+
+import os
+import datasets
+import csv
+import textwrap
+import json
+
+
+_CITATION = """
+@misc{thulke2024climategpt,
+      title={ClimateGPT: Towards AI Synthesizing Interdisciplinary Research on Climate Change}, 
+      author={David Thulke and Yingbo Gao and Petrus Pelser and Rein Brune and Rricha Jalota and Floris Fok and Michael Ramos and Ian van Wyk and Abdallah Nasir and Hayden Goldstein and Taylor Tragemann and Katie Nguyen and Ariana Fowler and Andrew Stanco and Jon Gabriel and Jordan Taylor and Dean Moro and Evgenii Tsymbalov and Juliette de Waal and Evgeny Matusov and Mudar Yaghi and Mohammad Shihadah and Hermann Ney and Christian Dugast and Jonathan Dotan and Daniel Erasmus},
+      year={2024},
+      eprint={2401.09646},
+      archivePrefix={arXiv},
+      primaryClass={cs.LG}
+}
+"""
+
+_HOMEPAGE = "https://arxiv.org/abs/2401.09646"
+
+_LICENSE = ""
+
+_ClimateEvaluation_BASE_KWARGS = dict(
+    citation=_CITATION,
+    url=_HOMEPAGE,
+)
+
+# DEFAULT_CONFIG_NAME = "climate_stance"
+
+class ClimateEvaluationConfig(datasets.BuilderConfig):
+    """BuilderConfig for ClimateEvaluation."""
+
+    def __init__(
+        self,
+        data_dir,
+        citation,
+        url=None,
+        text_features=None,
+        label_column=None,
+        label_classes=None,
+        process_label=lambda x: x,
+        **kwargs,
+    ):
+        """BuilderConfig for ClimateGPT-Evaluation.
+        Args:
+          text_features: `dict[string, string]`, map from the name of the feature
+            dict for each text field to the name of the column in the tsv file
+          label_column: `string`, name of the column in the tsv file corresponding
+            to the label
+          data_dir: `string`, the path to the folder containing the tsv files in the
+            downloaded zip
+          citation: `string`, citation for the data set
+          url: `string`, url for information about the data set
+          label_classes: `list[string]`, the list of classes if the label is
+            categorical. If not provided, then the label will be of type
+            `datasets.Value('float32')`.
+          process_label: `Function[string, any]`, function  taking in the raw value
+            of the label and processing it to the form required by the label feature
+          **kwargs: keyword arguments forwarded to super.
+        """
+        super(ClimateEvaluationConfig, self).__init__(
+            version=datasets.Version("1.0.0", ""), **kwargs
+        )
+        self.text_features = text_features
+        self.label_column = label_column
+        self.label_classes = label_classes
+        self.data_dir = data_dir
+        self.citation = citation
+        self.url = url
+        self.process_label = process_label
+
+
+class ClimateEvaluation(datasets.GeneratorBasedBuilder):
+    """Based on ClimaBench, Pira 2.0 MCQs, Exeter datasets"""
+
+    BUILDER_CONFIGS = [
+        ClimateEvaluationConfig(
+            name="climate_stance",
+            description=textwrap.dedent(
+                """\
+            Climate-Stance contains climate change-related tweets that were posted during the 2019 United Nations Framework Convention on Climate Change. The tweets have been manually categorized into three groups for the purpose of stance detection: those expressing support for climate change prevention, those opposing it, and those with an ambiguous stance."""
+            ),
+            text_features={"text": "text"},
+            label_classes=[0, 1, 2],
+            label_column="label",
+            data_dir="ClimateStance",
+            citation=textwrap.dedent(
+                """\
+             @inproceedings{vaid-etal-2022-towards,
+                    title = "Towards Fine-grained Classification of Climate Change related Social Media Text",
+                    author = "Vaid, Roopal  and
+                    Pant, Kartikey  and
+                    Shrivastava, Manish",
+                    booktitle = "Proceedings of the 60th Annual Meeting of the Association for Computational Linguistics: Student Research Workshop",
+                    month = may,
+                    year = "2022",
+                    address = "Dublin, Ireland",
+                    publisher = "Association for Computational Linguistics",
+                    url = "https://aclanthology.org/2022.acl-srw.35",
+                    doi = "10.18653/v1/2022.acl-srw.35",
+                    pages = "434--443",
+                    abstract = "With climate change becoming a cause of concern worldwide, it becomes essential to gauge people{'}s reactions. This can help educate and spread awareness about it and help leaders improve decision-making. This work explores the fine-grained classification and Stance detection of climate change-related social media text. Firstly, we create two datasets, ClimateStance and ClimateEng, consisting of 3777 tweets each, posted during the 2019 United Nations Framework Convention on Climate Change and comprehensively outline the dataset collection, annotation methodology, and dataset composition. Secondly, we propose the task of Climate Change stance detection based on our proposed ClimateStance dataset. Thirdly, we propose a fine-grained classification based on the ClimateEng dataset, classifying social media text into five categories: Disaster, Ocean/Water, Agriculture/Forestry, Politics, and General. We benchmark both the datasets for climate change stance detection and fine-grained classification using state-of-the-art methods in text classification. We also create a Reddit-based dataset for both the tasks, ClimateReddit, consisting of 6262 pseudo-labeled comments along with 329 manually annotated comments for the label. We then perform semi-supervised experiments for both the tasks and benchmark their results using the best-performing model for the supervised experiments. Lastly, we provide insights into the ClimateStance and ClimateReddit using part-of-speech tagging and named-entity recognition.",
+                }
+            }"""
+            ),
+            url="https://github.com/roopalv54/finegrained-climate-change-social-media",
+        ),
+        ClimateEvaluationConfig(
+            name="climate_eng",
+            description=textwrap.dedent(
+                """\
+            ClimateEng contains climate change-related tweets that were posted during the 2019 United Nations Framework Convention on Climate Change. The tweets have been manually categorized for the task of fine-grained classification into topics such as: Disaster, Ocean/Water, Agriculture/forestry, Politics, General. """
+            ),
+            text_features={"text": "text"},
+            label_classes=["0", "1", "2", "3", "4"],
+            label_column="label",
+            data_dir="ClimateEng",
+            citation=textwrap.dedent(
+                """\
+            @inproceedings{vaid-etal-2022-towards,
+                    title = "Towards Fine-grained Classification of Climate Change related Social Media Text",
+                    author = "Vaid, Roopal  and
+                    Pant, Kartikey  and
+                    Shrivastava, Manish",
+                    booktitle = "Proceedings of the 60th Annual Meeting of the Association for Computational Linguistics: Student Research Workshop",
+                    month = may,
+                    year = "2022",
+                    address = "Dublin, Ireland",
+                    publisher = "Association for Computational Linguistics",
+                    url = "https://aclanthology.org/2022.acl-srw.35",
+                    doi = "10.18653/v1/2022.acl-srw.35",
+                    pages = "434--443",
+                    abstract = "With climate change becoming a cause of concern worldwide, it becomes essential to gauge people{'}s reactions. This can help educate and spread awareness about it and help leaders improve decision-making. This work explores the fine-grained classification and Stance detection of climate change-related social media text. Firstly, we create two datasets, ClimateStance and ClimateEng, consisting of 3777 tweets each, posted during the 2019 United Nations Framework Convention on Climate Change and comprehensively outline the dataset collection, annotation methodology, and dataset composition. Secondly, we propose the task of Climate Change stance detection based on our proposed ClimateStance dataset. Thirdly, we propose a fine-grained classification based on the ClimateEng dataset, classifying social media text into five categories: Disaster, Ocean/Water, Agriculture/Forestry, Politics, and General. We benchmark both the datasets for climate change stance detection and fine-grained classification using state-of-the-art methods in text classification. We also create a Reddit-based dataset for both the tasks, ClimateReddit, consisting of 6262 pseudo-labeled comments along with 329 manually annotated comments for the label. We then perform semi-supervised experiments for both the tasks and benchmark their results using the best-performing model for the supervised experiments. Lastly, we provide insights into the ClimateStance and ClimateReddit using part-of-speech tagging and named-entity recognition.",
+                }
+            }"""
+            ),
+            url="https://github.com/roopalv54/finegrained-climate-change-social-media",
+        ),
+        ClimateEvaluationConfig(
+            name="climatext",
+            description=textwrap.dedent(
+                """\
+            ClimaText is a binary classification dataset containing sentences from the web, Wikipedia and the section of US public companies' 10-K reports that addresses climate-related risks. The dataset is employed for the task of predicting whether a given sentence is relevant to climate change or not. """
+            ),
+            text_features={"text": "sentence"},
+            label_classes=["0", "1"],
+            label_column="label",
+            data_dir="ClimaText",
+            citation=textwrap.dedent(
+                """\
+                @misc{varini2021climatext,
+                    title={ClimaText: A Dataset for Climate Change Topic Detection}, 
+                    author={Francesco S. Varini and Jordan Boyd-Graber and Massimiliano Ciaramita and Markus Leippold},
+                    year={2021},
+                    eprint={2012.00483},
+                    archivePrefix={arXiv},
+                    primaryClass={cs.CL}
+                }
+            }"""
+            ),
+            url="https://www.sustainablefinance.uzh.ch/en/research/climate-fever/climatext.html",
+        ),
+        ClimateEvaluationConfig(
+            name="cdp_qa",
+            description=textwrap.dedent(
+                """\
+                CDP-QA is a dataset compiled from the questionnaires of the Carbon Disclosure Project, where cities, corporations, and states disclose their environmental information. The dataset presents pairs of questions and answers, and the objective is to predict whether a given answer is valid for the corresponding question. We benchmarked ClimateGPT on the questionnaires from the Combined split. """
+            ),
+            data_dir="CDP/Combined",
+            text_features={"question": "question", "answer": "answer"},
+            label_classes=["0", "1"],
+            label_column="label",
+            url="https://arxiv.org/abs/2301.04253"
+            citation=textwrap.dedent(
+                """\
+                @misc{laud2023Climabench,
+                    title={ClimaBench: A Benchmark Dataset For Climate Change Text Understanding in English}, 
+                    author={Tanmay Laud and Daniel Spokoyny and Tom Corringham and Taylor Berg-Kirkpatrick},
+                    year={2023},
+                    eprint={2301.04253},
+                    archivePrefix={arXiv},
+                    primaryClass={cs.CL}
+                }
+            }"""
+            ),
+        ),
+        ClimateEvaluationConfig(
+            name="exeter",
+            description=textwrap.dedent(
+                """\
+                The Exeter Climate Claims dataset contains textual data from 33 influential climate contrarian blogs and the climate-change-related content from 20 conservative think tanks spanning the years 1998 to 2020. Annotation of the dataset was done manually using a thorough three-layer taxonomy of (climate-change related) contrarian claims, which was developed by the authors. We utilize this dataset specifically for the binary classification task of discerning whether a given text contains a contrarian claim pertaining to climate change or not.  """
+            ),
+            data_dir="exeter",
+            text_features={"text": "text"},
+            label_classes=["0", "1"],
+            label_column="label",
+            url="https://www.nature.com/articles/s41598-021-01714-4"
+            citation=textwrap.dedent(
+                """\
+                @article{coan2021computer,
+                    title={Computer-assisted classification of contrarian claims about climate change},
+                    author={Coan, Travis G and Boussalis, Constantine and Cook, John and Nanko, Mirjam O},
+                    journal={Scientific reports},
+                    volume={11},
+                    number={1},
+                    pages={22320},
+                    year={2021},
+                    publisher={Nature Publishing Group UK London}
+                }
+            }"""
+            ),
+        ),
+        ClimateEvaluationConfig(
+            name="exams",
+            description=textwrap.dedent(
+                """\
+                EXAMS is a multiple choice question answering collected from high school examinations. To evaluate ClimateGPT on the cascaded machine translation approach, we evaluate on the Arabic subset of this dataset. The Arabic subset covers questions from biology, physics, science, social science and Islamic studies.
+                """
+            ),
+            data_dir="exams/translated",
+            text_features={"subject": "subject", "question_stem": "question_stem", "choices": "choices"},
+            label_classes=["A", "B", "C", "D"],
+            label_column="answerKey",
+            url="https://arxiv.org/abs/2301.04253",
+            citation=textwrap.dedent(
+                    """\
+                    @inproceedings{hardalov-etal-2020-exams,
+                    title = "{EXAMS}: A Multi-subject High School Examinations Dataset for Cross-lingual and Multilingual Question Answering",
+                    author = "Hardalov, Momchil  and
+                    Mihaylov, Todor  and
+                    Zlatkova, Dimitrina  and
+                    Dinkov, Yoan  and
+                    Koychev, Ivan  and
+                    Nakov, Preslav",
+                    editor = "Webber, Bonnie  and
+                    Cohn, Trevor  and
+                    He, Yulan  and
+                    Liu, Yang",
+                    booktitle = "Proceedings of the 2020 Conference on Empirical Methods in Natural Language Processing (EMNLP)",
+                    month = nov,
+                    year = "2020",
+                    address = "Online",
+                    publisher = "Association for Computational Linguistics",
+                    url = "https://aclanthology.org/2020.emnlp-main.438",
+                    doi = "10.18653/v1/2020.emnlp-main.438",
+                    pages = "5427--5444",
+                }
+            }"""
+            ),
+            **_ClimateEvaluation_BASE_KWARGS,
+        ),
+    ]