Follow HF SQuAD dataset (#4)

* Change dataset format of the JSQuAD to follow the official HF dataset format of the SQuAD

* fix for the CI

JGLUE.py

@@ -109,22 +109,18 @@ def features_jnli() -> ds.Features:
 
 
 def features_jsquad() -> ds.Features:
-    title = ds.Value("string")
-    answers = ds.Sequence(
-        {"text": ds.Value("string"), "answer_start": ds.Value("int64")}
-    )
-    qas = ds.Sequence(
+    features = ds.Features(
         {
-            "question": ds.Value("string"),
             "id": ds.Value("string"),
-            "answers": answers,
+            "title": ds.Value("string"),
+            "context": ds.Value("string"),
+            "question": ds.Value("string"),
+            "answers": ds.Sequence(
+                {"text": ds.Value("string"), "answer_start": ds.Value("int32")}
+            ),
             "is_impossible": ds.Value("bool"),
         }
     )
-    paragraphs = ds.Sequence({"qas": qas, "context": ds.Value("string")})
-    features = ds.Features(
-        {"data": ds.Sequence({"title": title, "paragraphs": paragraphs})}
-    )
     return features
 
 
@@ -515,7 +511,35 @@ class JGLUE(ds.GeneratorBasedBuilder):
             if file_path is None:
                 raise ValueError(f"Invalid argument for {self.config.name}")
 
-            with open(file_path, "r") as rf:
-                for i, line in enumerate(rf):
-                    json_dict = json.loads(line)
-                    yield i, json_dict
+            if self.config.name == "JSQuAD":
+                with open(file_path, "r") as rf:
+                    json_data = json.load(rf)
+
+                for json_dict in json_data["data"]:
+                    title = json_dict["title"]
+                    paragraphs = json_dict["paragraphs"]
+                    for paragraph in paragraphs:
+                        context = paragraph["context"]
+                        questions = paragraph["qas"]
+                        for question_dict in questions:
+                            q_id = question_dict["id"]
+                            question = question_dict["question"]
+                            answers = question_dict["answers"]
+                            is_impossible = question_dict["is_impossible"]
+
+                            example_dict = {
+                                "id": q_id,
+                                "title": title,
+                                "context": context,
+                                "question": question,
+                                "answers": answers,
+                                "is_impossible": is_impossible,
+                            }
+
+                            yield q_id, example_dict
+
+            else:
+                with open(file_path, "r") as rf:
+                    for i, line in enumerate(rf):
+                        json_dict = json.loads(line)
+                        yield i, json_dict

README.md

@@ -223,12 +223,12 @@ dataset = load_dataset("shunk031/JGLUE", name="JSQuAD")
 print(dataset)
 # DatasetDict({
 #     train: Dataset({
-#         features: ['data'],
-#         num_rows: 1
+#         features: ['id', 'title', 'context', 'question', 'answers', 'is_impossible'],
+#         num_rows: 62859
 #     })
 #     validation: Dataset({
-#         features: ['data'],
-#         num_rows: 1
+#         features: ['id', 'title', 'context', 'question', 'answers', 'is_impossible'],
+#         num_rows: 4442
 #     })
 # })
 ```
@@ -237,28 +237,15 @@ An example of the JSQuAD looks as follows:
 
 ```json
 {
-  "title": "東海道新幹線 (Tokaido Shinkansen)",
-  "paragraphs": [
-    {
-      "qas": [
-        {
-          "question": "2020 年（令和 2 年）3 月現在、東京駅 - 新大阪駅間の最高速度はどのくらいか。 (What is the maximum speed between Tokyo Station and Shin-Osaka Station as of March 2020?)",
-          "id": "a1531320p0q0",
-          "answers": [
-            {
-              "text": "285 km/h",
-              "answer_start": 182
-            }
-          ],
-          "is_impossible": false
-        },
-        {
-          .. 
-        }
-      ],
-      "context": "東海道新幹線 [SEP] 1987 年（昭和 62 年）4 月 1 日の国鉄分割民営化により、JR 東海が運営を継承した。西日本旅客鉄道（JR 西日本）が継承した山陽新幹線とは相互乗り入れが行われており、東海道新幹線区間のみで運転される列車にも JR 西日本所有の車両が使用されることがある。2020 年（令和 2 年）3 月現在、東京駅 - 新大阪駅間の所要時間は最速 2 時間 21 分、最高速度 285 km/h で運行されている。"
-    }
-  ]
+  "id": "a1531320p0q0", 
+  "title": "東海道新幹線", 
+  "context": "東海道新幹線 [SEP] 1987 年（昭和 62 年）4 月 1 日の国鉄分割民営化により、JR 東海が運営を継承した。西日本旅客鉄道（JR 西日本）が継承した山陽新幹線とは相互乗り入れが行われており、東海道新幹線区間のみで運転される列車にも JR 西日本所有の車両が使用されることがある。2020 年（令和 2 年）3 月現在、東京駅 - 新大阪駅間の所要時間は最速 2 時間 21 分、最高速度 285 km/h で運行されている。", 
+  "question": "2020 年（令和 2 年）3 月現在、東京駅 - 新大阪駅間の最高速度はどのくらいか。", 
+  "answers": {
+    "text": ["285 km/h"], 
+    "answer_start": [182]
+  }, 
+  "is_impossible": false
 }
 ```
 

pyproject.toml

@@ -7,7 +7,7 @@ readme = "README.md"
 packages = []
 
 [tool.poetry.dependencies]
-python = "^3.9"
+python = "^3.8"
 datasets = "^2.10.0"
 beautifulsoup4 = "^4.11.2"
 mecab-python3 = "^1.0.6"

tests/JGLUE_test.py

@@ -12,6 +12,7 @@ def dataset_path() -> str:
     argvalues=(
         ("JSTS", 12451, 1457),
         ("JNLI", 20073, 2434),
+        ("JSQuAD", 62859, 4442),
         ("JCommonsenseQA", 8939, 1119),
     ),
 )
@@ -27,29 +28,6 @@ def test_load_dataset(
     assert dataset["validation"].num_rows == expected_num_valid
 
 
-def test_load_jsquad(
-    dataset_path: str,
-    dataset_name: str = "JSQuAD",
-    expected_num_train: int = 62859,
-    expected_num_valid: int = 4442,
-):
-    dataset = ds.load_dataset(path=dataset_path, name=dataset_name)
-
-    def count_num_data(split: str) -> int:
-        data = dataset[split]["data"]
-        assert len(data) == 1
-        data = data[0]
-
-        num_data = 0
-        for paragraphs in data["paragraphs"]:
-            for qas in paragraphs["qas"]:
-                num_data += len(qas["answers"])
-        return num_data
-
-    assert count_num_data("train") == expected_num_train
-    assert count_num_data("validation") == expected_num_valid
-
-
 def test_load_marc_ja(
     dataset_path: str,
     dataset_name: str = "MARC-ja",