File size: 11,399 Bytes
1dff0e6
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1b95b2b
 
96e7316
1dff0e6
551770f
 
b687218
551770f
 
 
 
 
b687218
1dff0e6
 
 
 
 
 
551770f
 
 
 
 
 
1dff0e6
551770f
1dff0e6
 
551770f
1dff0e6
551770f
1dff0e6
 
551770f
1dff0e6
551770f
1dff0e6
 
551770f
1dff0e6
551770f
 
 
 
 
 
1dff0e6
 
 
 
 
 
 
 
 
 
 
 
 
 
 
9c6f885
551770f
1dff0e6
 
b687218
551770f
b687218
551770f
b687218
 
 
 
 
551770f
 
b687218
551770f
b687218
 
 
 
 
551770f
 
b687218
551770f
b687218
 
 
 
 
551770f
 
b687218
551770f
b687218
 
 
 
 
551770f
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
b687218
 
1dff0e6
 
 
199a5db
 
 
 
551770f
199a5db
 
1dff0e6
 
551770f
1dff0e6
 
 
 
 
551770f
1dff0e6
199a5db
 
551770f
199a5db
 
1dff0e6
 
551770f
1dff0e6
 
 
 
 
551770f
1dff0e6
199a5db
551770f
199a5db
 
1dff0e6
 
551770f
1dff0e6
 
 
 
 
551770f
1dff0e6
199a5db
 
551770f
199a5db
 
 
 
551770f
199a5db
 
 
 
 
551770f
199a5db
 
 
551770f
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
199a5db
1dff0e6
 
 
 
 
 
 
 
 
 
 
 
 
3ad401a
1dff0e6
 
 
a05d061
e0ebd5f
1dff0e6
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
# coding=utf-8
# 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.
"""PAUQ: Text-to-SQL in Russian"""

import json
import os

import datasets

logger = datasets.logging.get_logger(__name__)

_CITATION = """\
@inproceedings{bakshandaeva-etal-2022-pauq,
    title = "{PAUQ}: Text-to-{SQL} in {R}ussian",
    author = "Bakshandaeva, Daria  and
      Somov, Oleg  and
      Dmitrieva, Ekaterina  and
      Davydova, Vera  and
      Tutubalina, Elena",
    booktitle = "Findings of the Association for Computational Linguistics: EMNLP 2022",
    month = dec,
    year = "2022",
    address = "Abu Dhabi, United Arab Emirates",
    publisher = "Association for Computational Linguistics",
    url = "https://aclanthology.org/2022.findings-emnlp.175",
"""

_DESCRIPTION = """\
    Pauq is a first Russian text-to-SQL dataset translated from original Spider dataset 
    with corrections and refinements of question, queries and databases.
"""

_LICENSE = "CC BY-SA 4.0"

_HOMEPAGE = "https://github.com/ai-spiderweb/pauq"

_URL = "https://huggingface.co/datasets/composite/pauq/resolve/main/formatted_pauq.zip"

RUSSIAN_PAUQ_TRL_DESCRIPTION = "Russian PAUQ train/test split based on target length of SQL query. Long query template in train, short query template in test."
ENGLISH_PAUQ_TRL_DESCRIPTION = "English PAUQ train/test split based on target length of SQL query. Long query template in train, short query template in test."

RUSSIAN_PAUQ_TSL_DESCRIPTION = "Russian PAUQ train/test split based on target length of SQL query. Short query template in train, long query template in test."
ENGLISH_PAUQ_TSL_DESCRIPTION = "English PAUQ train/test split based on target length of SQL query. Short query template in train, long query template in test."

RUSSIAN_PAUQ_OS_DESCRIPTION = "Independent and identical Russian PAUQ train/test split. Сorresponds to original Spider splitting."
ENGLISH_PAUQ_OS_DESCRIPTION = "Independent and identical English PAUQ train/test split. Сorresponds to original Spider splitting."


class Pauq(datasets.GeneratorBasedBuilder):
    VERSION = datasets.Version("1.0.0")

    BUILDER_CONFIGS = [
        datasets.BuilderConfig(
            name="ru_trl",
            version=VERSION,
            description=RUSSIAN_PAUQ_TRL_DESCRIPTION,
        ),
        datasets.BuilderConfig(
            name="en_trl",
            version=VERSION,
            description=ENGLISH_PAUQ_TRL_DESCRIPTION,
        ),
        datasets.BuilderConfig(
            name="ru_tsl",
            version=VERSION,
            description=RUSSIAN_PAUQ_TSL_DESCRIPTION,
        ),
        datasets.BuilderConfig(
            name="en_tsl",
            version=VERSION,
            description=ENGLISH_PAUQ_TSL_DESCRIPTION,
        ),
        datasets.BuilderConfig(
            name="ru_os",
            version=VERSION,
            description=RUSSIAN_PAUQ_OS_DESCRIPTION,
        ),
        datasets.BuilderConfig(
            name="en_os",
            version=VERSION,
            description=ENGLISH_PAUQ_OS_DESCRIPTION,
        ),
    ]

    def _info(self):
        features = datasets.Features(
            {
                "id": datasets.Value("string"),
                "db_id": datasets.Value("string"),
                "source": datasets.Value("string"),
                "type": datasets.Value("string"),
                "question": datasets.Value("string"),
                "query": datasets.Value("string"),
                "sql": datasets.features.Sequence(datasets.Value("string")),
                "question_toks": datasets.features.Sequence(datasets.Value("string")),
                "query_toks": datasets.features.Sequence(datasets.Value("string")),
                "query_toks_no_values": datasets.features.Sequence(datasets.Value("string")),
                "template": datasets.Value("string")
            }
        )
        dataset_info = None
        if self.config.name == 'ru_trl':
            dataset_info = datasets.DatasetInfo(
                description=RUSSIAN_PAUQ_TRL_DESCRIPTION,
                features=features,
                supervised_keys=None,
                homepage=_HOMEPAGE,
                license=_LICENSE,
                citation=_CITATION,
                config_name="ru_trl")
        elif self.config.name == "en_trl":
            dataset_info = datasets.DatasetInfo(
                description=ENGLISH_PAUQ_TRL_DESCRIPTION,
                features=features,
                supervised_keys=None,
                homepage=_HOMEPAGE,
                license=_LICENSE,
                citation=_CITATION,
                config_name="en_trl")
        elif self.config.name == 'ru_os':
            dataset_info = datasets.DatasetInfo(
                description=RUSSIAN_PAUQ_OS_DESCRIPTION,
                features=features,
                supervised_keys=None,
                homepage=_HOMEPAGE,
                license=_LICENSE,
                citation=_CITATION,
                config_name="ru_os")
        elif self.config.name == 'en_os':
            dataset_info = datasets.DatasetInfo(
                description=ENGLISH_PAUQ_OS_DESCRIPTION,
                features=features,
                supervised_keys=None,
                homepage=_HOMEPAGE,
                license=_LICENSE,
                citation=_CITATION,
                config_name="en_os")
        elif self.config.name == 'ru_tsl':
            dataset_info = datasets.DatasetInfo(
                description=RUSSIAN_PAUQ_TSL_DESCRIPTION,
                features=features,
                supervised_keys=None,
                homepage=_HOMEPAGE,
                license=_LICENSE,
                citation=_CITATION,
                config_name="ru_tsl")
        elif self.config.name == "en_tsl":
            dataset_info = datasets.DatasetInfo(
                description=ENGLISH_PAUQ_TSL_DESCRIPTION,
                features=features,
                supervised_keys=None,
                homepage=_HOMEPAGE,
                license=_LICENSE,
                citation=_CITATION,
                config_name="en_tsl")

        return dataset_info

    def _split_generators(self, dl_manager):
        downloaded_filepath = dl_manager.download_and_extract(_URL)
        
        dataset_name = self.config.name
        
        splits = []
        if dataset_name == 'ru_trl':
            splits = [
                datasets.SplitGenerator(
                name=datasets.Split.TRAIN,
                gen_kwargs={
                    "data_filepath": os.path.join(downloaded_filepath, "formatted_pauq/splits/ru_trl_train.json"),
                },
            ),
            datasets.SplitGenerator(
                name=datasets.Split.TEST,
                gen_kwargs={
                    "data_filepath": os.path.join(downloaded_filepath, "formatted_pauq/splits/ru_trl_test.json"),
                },
            )
            ]
        elif dataset_name == 'en_trl':
            splits = [
                datasets.SplitGenerator(
                name=datasets.Split.TRAIN,
                gen_kwargs={
                    "data_filepath": os.path.join(downloaded_filepath, "formatted_pauq/splits/en_trl_train.json"),
                },
            ),
            datasets.SplitGenerator(
                name=datasets.Split.TEST,
                gen_kwargs={
                    "data_filepath": os.path.join(downloaded_filepath, "formatted_pauq/splits/en_trl_test.json"),
                },
            )]
        elif dataset_name == 'ru_os':
            splits = [
                datasets.SplitGenerator(
                name=datasets.Split.TRAIN,
                gen_kwargs={
                    "data_filepath": os.path.join(downloaded_filepath, "formatted_pauq/splits/ru_os_train.json"),
                },
            ),
            datasets.SplitGenerator(
                name=datasets.Split.TEST,
                gen_kwargs={
                    "data_filepath": os.path.join(downloaded_filepath, "formatted_pauq/splits/ru_os_test.json"),
                },
            )
            ]
        elif dataset_name == 'en_os':
            splits = [
                datasets.SplitGenerator(
                    name=datasets.Split.TRAIN,
                    gen_kwargs={
                        "data_filepath": os.path.join(downloaded_filepath, "formatted_pauq/splits/en_os_train.json"),
                    },
                ),
                datasets.SplitGenerator(
                    name=datasets.Split.TEST,
                    gen_kwargs={
                        "data_filepath": os.path.join(downloaded_filepath, "formatted_pauq/splits/en_os_test.json"),
                    },
                )
            ]
        elif dataset_name == 'ru_tsl':
            splits = [
                datasets.SplitGenerator(
                name=datasets.Split.TRAIN,
                gen_kwargs={
                    "data_filepath": os.path.join(downloaded_filepath, "formatted_pauq/splits/ru_tsl_train.json"),
                },
            ),
            datasets.SplitGenerator(
                name=datasets.Split.TEST,
                gen_kwargs={
                    "data_filepath": os.path.join(downloaded_filepath, "formatted_pauq/splits/ru_tsl_test.json"),
                },
            )
            ]
        elif dataset_name == 'en_tsl':
            splits = [
                datasets.SplitGenerator(
                name=datasets.Split.TRAIN,
                gen_kwargs={
                    "data_filepath": os.path.join(downloaded_filepath, "formatted_pauq/splits/en_tsl_train.json"),
                },
            ),
            datasets.SplitGenerator(
                name=datasets.Split.TEST,
                gen_kwargs={
                    "data_filepath": os.path.join(downloaded_filepath, "formatted_pauq/splits/en_tsl_test.json"),
                },
            )]
        return splits

    def _generate_examples(self, data_filepath):
        """This function returns the examples in the raw (text) form."""
        logger.info("generating examples from = %s", data_filepath)
        with open(data_filepath, encoding="utf-8") as f:
            pauq = json.load(f)
            for idx, sample in enumerate(pauq):
                yield idx, {
                    "id": sample["id"],
                    "db_id": sample["db_id"],
                    "source": sample["source"],
                    "type": sample["type"],
                    "query": sample["query"],
                    "sql": sample['sql'],
                    "question": sample["question"],
                    "question_toks": sample["question_toks"],
                    "query_toks": sample["query_toks"],
                    "query_toks_no_values": sample["query_toks_no_values"],
                    "template": sample["template"]
                }