initial commit

.gitattributes

@@ -53,3 +53,4 @@ saved_model/**/* filter=lfs diff=lfs merge=lfs -text
 *.jpg filter=lfs diff=lfs merge=lfs -text
 *.jpeg filter=lfs diff=lfs merge=lfs -text
 *.webp filter=lfs diff=lfs merge=lfs -text
+*.jsonl filter=lfs diff=lfs merge=lfs -text

README.md

@@ -1,11 +1,161 @@
 ---
 license: cc
 task_categories:
-- text-classification
+  - text-classification
 language:
-- pl
-- en
+  - pl
+  - en
 pretty_name: Cross-Document Structure Theory datasets
 size_categories:
-- 1K<n<10K
----
+  - 1K<n<10K
+---
+
+# Cross Document Structure Theory datasets
+
+## 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)
+    - [Source Data](#source-data)
+    - [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
+
+- **Homepage:**
+- **Repository:**
+- **Paper:**
+- **Point of Contact:** arkadiusz.janz@pwr.edu.pl
+
+### Dataset Summary
+
+Collection of sentence pairs annotated for the Cross-Document Structure Theory (CST) task.
+It consists of 3 distinct datasets, manually annotated based on plWordNet-4.5:
+
+- WUT
+- PODCAST
+- SNLI
+- WNLI
+
+### Supported Tasks and Leaderboards
+
+[More Information Needed]
+
+### Languages
+
+Polish language, PL
+English language, EN
+
+## Dataset Structure
+
+### Data Instances
+
+Data are structured in JSONL format, each single text sample is divided by sentence.
+
+```
+{
+  "id": 0, 
+  "sentence_1": "According to the television coverage of the royal wedding, the bride looked beautiful.", 
+  "sentence_2": "The bride looked exceptionally beautiful.", 
+  "cst": [
+    {
+      "supertype": "overlap", 
+      "type": "attribution", 
+      "knowledge": "text"
+    }, 
+    {
+      "supertype": "overlap", 
+      "type": "elaboration", 
+      "knowledge": "text"
+    }
+  ]
+}
+```
+
+### Data Fields
+
+Description of json keys:
+
+- `id`: identifier of the sentence pair
+- `sentence_1`: first sentence
+- `sentence_2`: second sentence
+- `cst`: list of CST labels
+    - `supertype`: relation supertype
+    - `type`: specific relation type
+    - `knowledge`: premise knowledge source
+
+### Data Splits
+
+We do not specify an exact data split for training and evaluation.
+
+## Dataset Creation
+
+### Curation Rationale
+
+[More Information Needed]
+
+### Source Data
+
+#### Initial Data Collection, Normalization and Post-processing
+
+[More Information Needed]
+
+### Annotations
+
+![Obraz](typology_cst.png)
+
+#### Annotation process
+
+[More Information Needed]
+
+#### Who are the annotators?
+
+- professional linguists (mention all people involved)
+
+### Personal and Sensitive Information
+
+The datasets do not contain any personal or sensitive information.
+
+## Considerations for Using the Data
+
+### Discussion of Biases
+
+[More Information Needed]
+
+### Other Known Limitations
+
+[More Information Needed]
+
+## Additional Information
+
+### Dataset Curators
+
+Arkadiusz Janz (arkadiusz.janz@pwr.edu.pl)
+
+### Licensing Information
+
+WUT [CC-BY 2.5](https://creativecommons.org/licenses/by/2.5/)  
+PODCAST [CC-BY-SA 4.0](https://creativecommons.org/licenses/by-sa/4.0/)  
+SNLI [CC-BY-SA 4.0](https://creativecommons.org/licenses/by-sa/4.0/)  
+WNLI [CC-BY-SA 4.0](https://creativecommons.org/licenses/by-sa/4.0/)
+
+### Citation Information
+
+[More Information Needed]

cst_directed_datasets.py

@@ -0,0 +1,119 @@
+# Copyright 2020 The HuggingFace Datasets Authors and the current dataset script contributor.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+import json
+
+import datasets
+
+logger = datasets.logging.get_logger(__name__)
+
+_DESCRIPTION = """\
+Data for Polish CST task annotated manually
+"""
+
+_BASE_URL = "https://huggingface.co/datasets/clarin-knext/WUT_pl/resolve/main/data/"
+
+_DATASET_NAME = [
+    "wut_pl",
+    "wut_en",
+    "podcast_pl",
+    "podcast_en",
+    "snli_pl",
+    "snli_en",
+    "wnli_pl",
+    "wnli_en",
+]
+
+_URLS = {
+    dataset: f"{_BASE_URL}{dataset}_cst_directed_{lang}.jsonl"
+    for dataset, lang in (dataset_name.split('_') for dataset_name in _DATASET_NAME)
+}
+
+
+class CSTDirectedDatasetBuilderConfig(datasets.BuilderConfig):
+    def __init__(
+        self,
+        data_url: str,
+        name: str,
+        **kwargs,
+    ):
+        super(CSTDirectedDatasetBuilderConfig, self).__init__(
+            name=name,
+            version=datasets.Version("1.0.0"),
+            **kwargs,
+        )
+
+        self.name = name
+        self.data_url = data_url
+        if self.name not in _DATASET_NAME:
+            raise ValueError(
+                f"Config name `{self.name}` is not available. Enter one of: {_DATASET_NAME}"
+            )
+
+
+class CSTDirectedDataset(datasets.GeneratorBasedBuilder):
+    """Polish WSD training data"""
+
+    BUILDER_CONFIGS = [
+        CSTDirectedDatasetBuilderConfig(
+            name=dataset,
+            data_url=_URLS[dataset],
+            description=f"Dataset {dataset} with CST annotation including relation direction.",
+        )
+        for dataset in _DATASET_NAME
+    ]
+
+    DEFAULT_CONFIG_NAME = "podcast_en"
+
+    def _info(self) -> datasets.DatasetInfo:
+        features = {
+            "id": datasets.Value("int32"),
+            "sentence_1": datasets.Value("string"),
+            "sentence_2": datasets.Value("string"),
+            "cst": datasets.features.Sequence(
+                dict(
+                    {
+                        "supertype": datasets.Value("string"),
+                        "type": datasets.Value("string"),
+                        "knowledge": datasets.Value("string"),
+                    }
+                )
+            ),
+        }
+
+        return datasets.DatasetInfo(
+            description=_DESCRIPTION,
+            features=datasets.Features(features),
+            supervised_keys=None,
+            # license=_LICENSE,
+            # citation=_CITATION,
+        )
+
+    def _split_generators(self, dl_manager):
+        filepath = dl_manager.download_and_extract(self.config.data_url)
+
+        return [
+            datasets.SplitGenerator(
+                name=datasets.Split.TRAIN,
+                gen_kwargs={
+                    "filepath": filepath,
+                },
+            ),
+        ]
+
+    def _generate_examples(self, filepath: str):
+        key_iter = 0
+        with open(filepath, encoding="utf-8") as f:
+            for data in (json.loads(line) for line in f):
+                yield key_iter, data
+                key_iter += 1

data/podcast_cst_directed_en.jsonl

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:fb6d3482b18571e88437abb1bdbca66bbcead483fedd404b9da8eb718b248aad
+size 2622625

data/podcast_cst_directed_pl.jsonl

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:24de2c031b1623103188dbd1a1fa70ecbe93e312bb5696650eb6e8a5af6e0527
+size 2617347

data/snli_cst_directed_en.jsonl

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:e861a39aa85e94d1c00567e806f287eb3ef708ac6ec39b92b211a8a9bf9097bb
+size 267605

data/snli_cst_directed_pl.jsonl

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:d0bec4963ad9f8c1193dc36b90b8739f8d244a737354ca4db428f32985294b29
+size 278564

data/wut_cst_directed_en.jsonl

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:3e6364fdca2a82e2de17ca07dacf2c2cfc667328e098f4771aa00b0cabf559e7
+size 504969

data/wut_cst_directed_pl.jsonl

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:fc07dca3edb3561774fdc39f982322bfef35f48a2b460fa1e8fcdbf2cce5092a
+size 513012