# 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. """The SOTAB dataset is a large-scale dataset for the task of column type annotation on semi-structured tables.""" import os import datasets # Find for instance the citation on arxiv or on the dataset repo/website _CITATION = """\ """ # You can copy an official description _DESCRIPTION = """\ """ _HOMEPAGE = "" _LICENSE = "" # The HuggingFace Datasets library doesn't host the datasets but only points to the original files. # This can be an arbitrary nested dict/list of URLs (see below in `_split_generators` method) _DATA_URL = ( # "https://github.com/ppasupat/WikiTableQuestions/releases/download/v1.0.2/WikiTableQuestions-1.0.2-compact.zip" ) class WikiTableQuestions(datasets.GeneratorBasedBuilder): """The SOTAB dataset is a large-scale dataset for the task of column type annotation on semi-structured tables.""" VERSION = datasets.Version("1.0.2") # This is an example of a dataset with multiple configurations. # If you don't want/need to define several sub-sets in your dataset, # just remove the BUILDER_CONFIG_CLASS and the BUILDER_CONFIGS attributes. # If you need to make complex sub-parts in the datasets with configurable options # You can create your own builder configuration class to store attribute, inheriting from datasets.BuilderConfig # BUILDER_CONFIG_CLASS = MyBuilderConfig # You will be able to load one or the other configurations in the following list with # data = datasets.load_dataset('my_dataset', 'first_domain') # data = datasets.load_dataset('my_dataset', 'second_domain') BUILDER_CONFIGS = [ datasets.BuilderConfig( name="random-split-1", version=VERSION, description="", ), ] DEFAULT_CONFIG_NAME = ( "random-split-1" # It's not mandatory to have a default configuration. Just use one if it make sense. ) def _info(self): features = datasets.Features( { "id": datasets.Value("string"), "column_index": datasets.Value("int32"), "label": datasets.features.Sequence(datasets.Value("string")), "table": { "header": datasets.features.Sequence(datasets.Value("string")), "rows": datasets.features.Sequence(datasets.features.Sequence(datasets.Value("string"))), "name": datasets.Value("string"), }, } ) return datasets.DatasetInfo( # This is the description that will appear on the datasets page. description=_DESCRIPTION, # This defines the different columns of the dataset and their types features=features, # Here we define them above because they are different between the two configurations # If there's a common (input, target) tuple from the features, uncomment supervised_keys line below and # specify them. They'll be used if as_supervised=True in builder.as_dataset. # supervised_keys=("sentence", "label"), # Homepage of the dataset for documentation homepage=_HOMEPAGE, # License for the dataset if available license=_LICENSE, # Citation for the dataset citation=_CITATION, ) def _split_generators(self, dl_manager): train_url = "https://huggingface.co/datasets/shivangibithel/SOTAB/resolve/main/CTA_Training.zip" dev_url = "https://huggingface.co/datasets/shivangibithel/SOTAB/resolve/main/CTA_Validation.zip" test_url = "https://huggingface.co/datasets/shivangibithel/SOTAB/resolve/main/CTA_Test.zip" CTA_Training = os.path.join(dl_manager.download_and_extract(train_url), "CTA_Training") CTA_Validation = os.path.join(dl_manager.download_and_extract(dev_url), "CTA_Validation") CTA_Test = os.path.join(dl_manager.download_and_extract(test_url), "CTA_Test") train_file = "{}.json.gz".format(self.config.name) test_file = "{}.json.gz".format(self.config.name) dev_file = "{}.json.gz".format(self.config.name) return [ datasets.SplitGenerator( name=datasets.Split.TRAIN, # These kwargs will be passed to _generate_examples gen_kwargs={"main_filepath": os.path.join(root_dir, "Train", train_file), "root_dir": CTA_Training}, ), datasets.SplitGenerator( name=datasets.Split.TEST, # These kwargs will be passed to _generate_examples gen_kwargs={"main_filepath": os.path.join(root_dir, "Test", test_file), "root_dir": CTA_Test}, ), datasets.SplitGenerator( name=datasets.Split.VALIDATION, # These kwargs will be passed to _generate_examples gen_kwargs={"main_filepath": os.path.join(root_dir, "Validation", dev_file), "root_dir": CTA_Validation}, ), ] def _read_table_from_file(self, table_name: str, root_dir: str): def _extract_table_content(_line: str): _vals = [_.replace("\n", " ").strip() for _ in _line.strip("\n").split("\t")] return _vals rows = [] # assert ".csv" in _wtq_table_name # use the normalized table file table_name = table_name.replace(".csv", ".tsv") with open(os.path.join(root_dir, table_name), "r", encoding="utf8") as table_f: table_lines = table_f.readlines() # the first line is header header = _extract_table_content(table_lines[0]) for line in table_lines[1:]: rows.append(_extract_table_content(line)) return {"header": header, "rows": rows, "name": table_name} # method parameters are unpacked from `gen_kwargs` as given in `_split_generators` def _generate_examples(self, main_filepath, root_dir): # The `key` is for legacy reasons (tfds) and is not important in itself, but must be unique for each example. with open(main_filepath, encoding="utf-8") as f: # skip the first line since it is the tsv header next(f) for idx, line in enumerate(f): example_id, question, table_name, answer = line.strip("\n").split("\t") answer = answer.split("|") # must contain rows and header keys table_content = self._read_table_from_file(table_name, root_dir) yield idx, {"id": example_id, "question": question, "answers": answer, "table": table_content}