First commit

DBLP-QuAD.py

@@ -0,0 +1,121 @@
+# coding=utf-8
+# Copyright 2020 The TensorFlow Datasets Authors and the HuggingFace Datasets Authors.
+#
+# 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.
+
+# Lint as: python3
+"""DBLP-QuAD: A Question Answering Dataset over the DBLP Scholarly Knowledge Graph."""
+
+
+import json
+import os
+
+import datasets
+
+
+logger = datasets.logging.get_logger(__name__)
+
+
+_CITATION = """
+    @article{DBLP-QuAD,
+        title={DBLP-QuAD: A Question Answering Dataset over the DBLP Scholarly Knowledge Graph},
+        author={Banerjee, Debayan and Awale, Sushil and Usbeck, Ricardo and Biemann, Chris},
+        year={2023}
+"""
+
+_DESCRIPTION = """\
+    DBLP-QuAD is a scholarly knowledge graph question answering dataset with \
+    10,000 question - SPARQL query pairs targeting the DBLP knowledge graph. \
+    The dataset is split into 7,000 training, 1,000 validation and 2,000 test \
+    questions.
+"""
+
+_URL = "https://zenodo.org/record/7554379/files/DBLP-QuAD.zip"
+
+
+class DBLPQuAD(datasets.GeneratorBasedBuilder):
+    """
+        DBLP-QuAD: A Question Answering Dataset over the DBLP Scholarly Knowledge Graph.
+        Version 1.0.0
+    """
+
+    VERSION = datasets.Version("1.0.0")
+
+    def _info(self):
+        return datasets.DatasetInfo(
+            # This is the description that will appear on the datasets page.
+            description=_DESCRIPTION,
+            # datasets.features.FeatureConnectors
+            features=datasets.Features(
+                {   
+                    "id": datasets.Value("string"),
+                    "query_type": datasets.Value("string"),
+                    "question": datasets.dataset_dict.DatasetDict({
+                        "string": datasets.Value("string")
+                    }),
+                    "paraphrased_question": datasets.dataset_dict.DatasetDict({
+                        "string": datasets.Value("string")
+                    }),
+                    "query": datasets.dataset_dict.DatasetDict({
+                        "sparql": datasets.Value("string")
+                    }),
+                    "template_id": datasets.Value("string"),
+                    "entities": datasets.features.Sequence(datasets.Value("string")),
+                    "relations": datasets.features.Sequence(datasets.Value("string")),
+                    "temporal": datasets.Value("bool"),
+                    "held_out": datasets.Value("bool")
+                }
+            ),
+            supervised_keys=None,
+            citation=_CITATION,
+        )
+
+    def _split_generators(self, dl_manager):
+        """Returns SplitGenerators."""
+
+        dl_dir = dl_manager.download_and_extract(_URL)
+        dl_dir = os.path.join(dl_dir, "DBLP-QuAD")
+
+        return [
+            datasets.SplitGenerator(
+                name=datasets.Split.TRAIN,
+                gen_kwargs={"filepath": os.path.join(dl_dir, "train", "questions.json")},
+            ),
+            datasets.SplitGenerator(
+                name=datasets.Split.VALID,
+                gen_kwargs={"filepath": os.path.join(dl_dir, "valid", "questions.json")},
+            ),
+            datasets.SplitGenerator(
+                name=datasets.Split.TEST,
+                gen_kwargs={"filepath": os.path.join(dl_dir, "test", "questions.json")},
+            ),
+        ]
+
+    def _generate_examples(self, filepath):
+        """Yields examples."""
+
+        with open(filepath, encoding="utf-8") as f:
+            data = json.load(f)["questions"]
+            for id_, row in enumerate(data):
+                yield id_, {
+                    "id": row["id"],
+                    "query_type": row["query_type"],
+                    "question": row["question"],
+                    "paraphrased_question": row["paraphrased_question"],
+                    "query": row["query"],
+                    "template_id": row["template_id"],
+                    "entities": row["entities"],
+                    "relations": row["relations"],
+                    "temporal": row["temporal"],
+                    "held_out": row["held_out"]
+                }

README.md

@@ -1,3 +1,122 @@
 ---
-license: cc-by-4.0
+annotations_creators:
+- expert-generated
+language:
+- en
+language_creators:
+- machine-generated
+license:
+- cc-by-4.0
+multilinguality:
+- monolingual
+pretty_name: 'DBLP-QuAD: A Question Answering Dataset over the DBLP Scholarly Knowledge Graph'
+size_categories:
+- 1K<n<10K
+source_datasets:
+- original
+tags:
+- knowledge-base-qa
+task_categories:
+- question-answering
+task_ids: []
 ---
+
+# Dataset Card for DBLP-QuAD
+
+## 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:** [DBLP-QuAD Homepage]()
+- **Repository:** [DBLP-QuAD Repository](https://github.com/awalesushil/DBLP-QuAD)
+- **Paper:** DBLP-QuAD: A Question Answering Dataset over the DBLP Scholarly Knowledge Graph
+- **Point of Contact:** [Sushil Awale](mailto:[email protected])
+
+### Dataset Summary
+
+DBLP-QuAD is a scholarly knowledge graph question answering dataset with 10,000 question - SPARQL query pairs targeting the DBLP knowledge graph. The dataset is split into 7,000 training, 1,000 validation and 2,000 test questions.
+
+## Dataset Structure
+
+### Data Instances
+
+An example of a question is given below:
+
+```
+{
+    "id": "Q0577",
+    "query_type": "MULTI_FACT",
+    "question": {
+        "string": "What are the primary affiliations of the authors of the paper 'Graphical Partitions and Graphical Relations'?"
+    },
+    "paraphrased_question": {
+        "string": "List the primary affiliations of the authors of 'Graphical Partitions and Graphical Relations'."
+    },
+    "query": {
+        "sparql": "SELECT DISTINCT ?answer WHERE { <https://dblp.org/rec/journals/fuin/ShaheenS19> <https://dblp.org/rdf/schema#authoredBy> ?x . ?x <https://dblp.org/rdf/schema#primaryAffiliation> ?answer }"
+    },
+    "template_id": "TP11",
+    "entities": [
+        "<https://dblp.org/rec/journals/fuin/ShaheenS19>"
+    ],
+    "relations": [
+        "<https://dblp.org/rdf/schema#authoredBy>",
+        "<https://dblp.org/rdf/schema#primaryAffiliation>"
+    ],
+    "temporal": false,
+    "held_out": true
+}
+
+```
+### Data Fields
+
+- `id`: the id of the question
+- `question`: a string containing the question
+- `paraphrased_question`: a paraphrased version of the question
+- `query`: a SPARQL query that answers the question
+- `query_type`: the type of the query
+- `query_template`: the template of the query
+- `entities`: a list of entities in the question
+- `relations`: a list of relations in the question
+- `temporal`: a boolean indicating whether the question contains a temporal expression
+- `held_out`: a boolean indicating whether the question is held out from the training set
+
+### Data Splits
+
+The dataset is split into 7,000 training, 1,000 validation and 2,000 test questions.
+
+## Additional Information
+
+### Licensing Information
+
+DBLP-QuAD is licensed under the [Creative Commons Attribution 4.0 International License (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/).
+
+### Citation Information
+
+In review.
+
+### Contributions
+
+Thanks to [@awalesushil](https://github.com/awalesushil) for adding this dataset.