data release

CaSSA-catalan-structured-sentiment-analysis.py

@@ -0,0 +1,84 @@
+# Loading script for the ReviewsFinder dataset.
+
+
+import json
+
+import datasets
+
+
+logger = datasets.logging.get_logger(__name__)
+
+
+_CITATION = """ """
+
+
+_DESCRIPTION = """   """
+
+
+_HOMEPAGE = """ https://huggingface.co/datasets/projecte-aina/CaSSA-catalan-structured-sentiment-analysis/ """
+
+
+
+_URL = "https://huggingface.co/datasets/projecte-aina/CaSSA-catalan-structured-sentiment-analysis/tree/main"
+_FILE = "data.jsonl"
+
+
+class CaSSAConfig(datasets.BuilderConfig):
+    """ Builder config for the CaSSA dataset """
+
+    def __init__(self, **kwargs):
+        """BuilderConfig for CaSSA.
+        Args:
+          **kwargs: keyword arguments forwarded to super.
+        """
+        super(CaSSAConfig, self).__init__(**kwargs)
+
+
+class CaSSA(datasets.GeneratorBasedBuilder):
+    """ CaSSA Dataset """
+
+
+    BUILDER_CONFIGS = [
+        CaSSAConfig(
+            name="CaSSA",
+            version=datasets.Version("1.0.0"),
+            description="CaSSA dataset",
+        ),
+    ]
+
+
+    def _info(self):
+        return datasets.DatasetInfo(
+            description=_DESCRIPTION,
+            features=datasets.Features(
+                {"sent_id": datasets.Value("string"),
+                 "text": datasets.Value("string"),
+                "opinions": datasets.Value("string"),
+                }
+            ),
+            homepage=_HOMEPAGE,
+            citation=_CITATION,
+        )
+
+    def _split_generators(self, dl_manager):
+        """Returns SplitGenerators."""
+        urls_to_download = {
+            "data": f"{_URL}{_FILE}",
+        }
+        downloaded_files = dl_manager.download_and_extract(urls_to_download)
+
+        return [
+            datasets.SplitGenerator(name=datasets.Split.TRAIN, gen_kwargs={"filepath": downloaded_files["data"]}),
+        ]
+
+    def _generate_examples(self, filepath):
+        """This function returns the examples in the raw (text) form."""
+        logger.info("generating examples from = %s", filepath)
+        with open(filepath, encoding="utf-8") as f:
+            data = [json.loads(line) for line in f]
+            for id_, text in enumerate(data):
+                    yield id_, {
+                        "sent_id": text['sent_id'],
+                 "text": text['text'],
+                "opinions": text['opinions']
+                    }

README.md

@@ -1,3 +1,183 @@
 ---
-license: cc-by-4.0
+annotations_creators:
+- Barcelona Supercomputing Center
+language_creators:
+- Racó Català
+- GuiaCat
+language:
+- ca
+license:
+- cc-by-nc-4.0
+multilinguality:
+- monolingual
+pretty_name: CaSSA
+size_categories:
+- ?
+task_categories:
+- text-classification
+task_ids: []
 ---
+
+# Dataset Card for CaSSA, the Catalan Structured Sentiment Analysis
+
+## Table of Contents
+- [Table of Contents](#table-of-contents)
+- [Dataset Description](#dataset-description)
+  - [Dataset Summary](#dataset-summary)
+  - [Supported Tasks and Leaderboards](#supported-tasks-and-leaderboards)
+  - [Languages](#languages)
+- [Dataset Structure](#dataset-structure)
+  - [Data Instances](#data-instances)
+  - [Data Fields](#data-fields)
+  - [Data Splits](#data-splits)
+- [Dataset Creation](#dataset-creation)
+  - [Curation Rationale](#curation-rationale)
+  - [Annotations](#annotations)
+  - [Personal and Sensitive Information](#personal-and-sensitive-information)
+- [Considerations for Using the Data](#considerations-for-using-the-data)
+  - [Social Impact of Dataset](#social-impact-of-dataset)
+  - [Discussion of Biases](#discussion-of-biases)
+  - [Other Known Limitations](#other-known-limitations)
+- [Additional Information](#additional-information)
+  - [Dataset Curators](#dataset-curators)
+  - [Licensing Information](#licensing-information)
+  - [Citation Information](#citation-information)
+  - [Contributions](#contributions)
+
+## Dataset Description
+
+- **Point of Contact:** [Blanca Calvo](aina@bsc.es)
+
+### Dataset Summary
+
+The CaSSA dataset is a corpus of 6,400 reviews and forum messages annotated with polar expressions. Each piece of text is annotated with all the expressions of polarity that it contains. For each polar expression, we annotated the expression itself, the target (the object of the expression), and the source (the subject expressing the sentiment). 25,453 polar expressions have been annotated.
+
+### Supported Tasks and Leaderboards
+
+This dataset can be used to train models for sentiment analysis.
+
+### Languages
+
+The dataset is in Catalan (`ca-CA`).
+
+## Dataset Structure
+
+Each instance in the dataset is a text. For each text, there can be 0 to unlimited polar expressions, which are contained in the "opinions" field. Each opinion contains a source, a target, a polar expression, a polarity value and an intensity value. 
+
+### Data Instances
+
+```
+{
+"sent_id": "2d6a3a0f-6686-4d8b-9c5f-51c424ff90be",
+"text": "El seu menú de nit de cap de setmana es boníssim, plats fets amb criteri i que surten com un rellotge. Servei proper i amable. Per poc mes de 20 euros entre pisos i flautes menges com un rei.", 
+"opinions": 
+    [
+      {
+        "Source": [[], []], 
+        "Target": [["Servei"], ["23:24"]], 
+        "Polar_expression": [["proper"], ["24:25"]], 
+        "Polarity": "Neutral", 
+        "Intensity": "Standard"
+      }, 
+      {
+        "Source": [[], []], 
+        "Target": [["Servei"], ["23:24"]], 
+        "Polar_expression": [["amable"], ["26:27"]], 
+        "Polarity": "Positive", 
+        "Intensity": "Standard"
+      }, 
+      {
+        "Source": [[], []], 
+        "Target": [[], []], 
+        "Polar_expression": [["menges com un rei"], ["38:42"]], 
+        "Polarity": "Positive", 
+        "Intensity": "Strong"
+      }, 
+      {
+        "Source": [["seu"], ["1:2"]], 
+        "Target": [["menú de nit de cap de setmana"], ["2:9"]], 
+        "Polar_expression": [["bon\u00edssim"], ["10:11"]], 
+        "Polarity": "Positive", 
+        "Intensity": "Strong"}, 
+      {
+        "Source": [[], []], 
+        "Target": [["plats"], ["12:13"]], 
+        "Polar_expression": [["amb criteri"], ["14:16"]], 
+        "Polarity": "Positive", 
+        "Intensity": "Standard"
+      }
+    ]
+}
+
+```
+
+### Data Splits
+
+The dataset does not contain splits.
+
+## Dataset Creation
+
+### Curation Rationale
+
+We created this corpus to contribute to the development of language models in Catalan, a low-resource language. 
+
+### Source Data
+
+The data was collected using the messages from the GuiaCat online guide and the forum Racó Català.
+
+#### Initial Data Collection and Normalization
+
+We selected all the restaurant reviews we had from GuiaCat, and used a LLM to select messages in Racó Català that were written in the style of reviews.
+
+#### Who are the source language producers?
+
+The source language producers are users of GuiaCat and Racó Català.
+
+### Annotations
+
+Each opinion contains a source, a target, a polar expression, a polarity value and an intensity value. Source, Target, and Polar_expressions are spans, which are represented both by the string and by the position of the tokens. Polarity and Intensity are labels, which can respectively be, Positive, Negative and Neutral, and Standard and Strong.
+
+#### Annotation process
+
+- The data was annotated by 2 annotators. In the cases in which they did not fully agree, a third annotated selected the preferred annotation.  
+
+#### Who are the annotators?
+
+All the annotators are native speakers of Catalan. 
+
+### Personal and Sensitive Information
+
+The data from Racó Català was annonymised to remove user names and emails, which were changed to random Catalan names. The mentions to the forum itself have also been changed.
+
+## Considerations for Using the Data
+
+### Social Impact of Dataset
+
+We hope this corpus contributes to the development of language models in Catalan, a low-resource language.
+
+### Discussion of Biases
+
+We are aware that, since the data comes from online reviews and a public forum, this will contain biases, hate speech and toxic content. We have not applied any steps to reduce their impact.
+
+### Other Known Limitations
+
+## Additional Information
+
+### Dataset Curators
+
+Language Technologies Unit (LangTech) at the Barcelona Supercomputing Center.
+
+This work was funded by the [Departament de la Vicepresidència i de Polítiques Digitals i Territori de la Generalitat de Catalunya](https://politiquesdigitals.gencat.cat/ca/inici/index.html#googtrans(ca|en) within the framework of [Projecte AINA](https://politiquesdigitals.gencat.cat/ca/economia/catalonia-ai/aina).
+
+
+### Licensing Information
+
+[Creative Commons Attribution 4.0](https://creativecommons.org/licenses/by/4.0/).
+
+### Citation Information
+
+```
+
+```
+
+### Contributions