Add tools/templates/

tools/templates/README.tmpl

@@ -0,0 +1,227 @@
+### THIS IS A GENERATED FILE.
+---
+annotations_creators:
+- expert-generated
+
+language_creators:
+- crowdsourced
+
+language:
+{%- set languages = [] -%}
+{%- for dirname,metadata in data.items()|sort(attribute='0') -%}
+    {{ languages.append(metadata.lcode)|default("", True)}}
+{%- endfor -%}
+{%- for language in languages|unique %}
+- {{ language }}
+{%- endfor %}
+
+license:
+- unknown
+
+multilinguality:
+- multilingual
+
+size_categories:
+- '1K<n<10K'
+
+source_datasets:
+- original
+
+task_categories:
+- token-classification
+
+task_ids:
+- parsing
+
+paperswithcode_id: universal-dependencies
+pretty_name: Universal Dependencies Treebank
+
+tags:
+- constituency-parsing
+- dependency-parsing
+
+dataset_info:
+{%- for dirnme,metadata in data.items()|sort(attribute='0') %}
+- config_name: {{ metadata.name }}
+  features:
+  - name: idx
+    dtype: string
+  - name: text
+    dtype: string
+  - name: tokens
+    sequence: string
+  - name: lemmas
+    sequence: string
+  - name: upos
+    sequence:
+      class_label:
+        names:
+          '0': NOUN
+          '1': PUNCT
+          '2': ADP
+          '3': NUM
+          '4': SYM
+          '5': SCONJ
+          '6': ADJ
+          '7': PART
+          '8': DET
+          '9': CCONJ
+          '10': PROPN
+          '11': PRON
+          '12': X
+          '13': _
+          '14': ADV
+          '15': INTJ
+          '16': VERB
+          '17': AUX
+  - name: xpos
+    sequence: string
+  - name: feats
+    sequence: string
+  - name: head
+    sequence: string
+  - name: deprel
+    sequence: string
+  - name: deps
+    sequence: string
+  - name: misc
+    sequence: string
+  splits:
+  {%- set ns = namespace(dataset_size=0) -%}
+  {%- for fileset_split_name,fileset_split_data in metadata.splits.items() %}
+  - name: {{ fileset_split_name }}
+    num_bytes: {{ fileset_split_data.num_bytes }}{%- set ns.dataset_size = ns.dataset_size + fileset_split_data.num_bytes %}
+    num_examples: {{ fileset_split_data.num_sentences }}
+    num_sentences: {{ fileset_split_data.num_sentences }}
+    num_tokens: {{ fileset_split_data.num_tokens }}
+    num_words: {{ fileset_split_data.num_words }}
+  {%- endfor %}
+  dataset_size: {{ ns.dataset_size }}
+{%- endfor %}
+
+config_names:
+{%- for dirname,metadata in data.items()|sort(attribute='0') %}
+- {{ metadata.name }}
+{%- endfor %}
+---
+
+# Dataset Card for Universal Dependencies Treebank
+
+## 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:** [Universal Dependencies](https://universaldependencies.org/)
+- **Repository:**
+- **Paper:**
+- **Leaderboard:**
+- **Point of Contact:**
+
+### Dataset Summary
+
+[More Information Needed]
+
+### Supported Tasks and Leaderboards
+
+[More Information Needed]
+
+### Languages
+
+[More Information Needed]
+
+## Dataset Structure
+
+### Data Instances
+
+[More Information Needed]
+
+### Data Fields
+
+[More Information Needed]
+
+### Data Splits
+
+[More Information Needed]
+
+## Dataset Creation
+
+### Curation Rationale
+
+[More Information Needed]
+
+### Source Data
+
+#### Initial Data Collection and Normalization
+
+[More Information Needed]
+
+#### Who are the source language producers?
+
+[More Information Needed]
+
+### Annotations
+
+#### Annotation process
+
+[More Information Needed]
+
+#### Who are the annotators?
+
+[More Information Needed]
+
+### Personal and Sensitive Information
+
+[More Information Needed]
+
+## Considerations for Using the Data
+
+### Social Impact of Dataset
+
+[More Information Needed]
+
+### Discussion of Biases
+
+[More Information Needed]
+
+### Other Known Limitations
+
+[More Information Needed]
+
+## Additional Information
+
+### Dataset Curators
+
+[More Information Needed]
+
+### Licensing Information
+
+[More Information Needed]
+
+### Citation Information
+
+[More Information Needed]
+### Contributions
+
+Thanks to [@patrickvonplaten](https://github.com/patrickvonplaten), [@jplu](https://github.com/jplu) for adding this dataset.

tools/templates/universal_dependencies.tmpl

@@ -0,0 +1,179 @@
+### THIS IS A GENERATED FILE.
+
+import conllu
+
+import datasets
+
+
+_CITATION = r"""\
+{{ citation }}
+"""  # noqa: W605
+
+_DESCRIPTION = """\
+{{ description }}
+"""
+
+_NAMES = [
+{%- for dirname,metadata in data.items()|sort(attribute='0') %}
+    "{{ metadata.name }}",
+{%- endfor %}
+]
+
+_DESCRIPTIONS = {
+{%- for dirname,metadata in data.items()|sort(attribute='0') %}
+    "{{ metadata.name }}": """{{ metadata.summary }}""",
+{%- endfor %}
+}
+
+_LICENSES = {
+{%- for dirname,metadata in data.items()|sort(attribute='0') %}
+    "{{ metadata.name }}": "{{ metadata.license }}",
+{%- endfor %}
+}
+
+_PREFIX = "https://raw.githubusercontent.com/UniversalDependencies/"
+_UD_DATASETS = {
+    {%- for dirname,metadata in data.items()|sort(attribute='0') %}
+        "{{ metadata.name }}": {
+            {%- for fileset_split_name,fileset_split_data in metadata.splits.items() %}
+                "{{ fileset_split_name }}": {{ fileset_split_data.files }},
+            {%- endfor %}
+        },
+    {%- endfor %}
+}
+
+
+class UniversaldependenciesConfig(datasets.BuilderConfig):
+    """BuilderConfig for Universal dependencies"""
+
+    def __init__(self, data_url, **kwargs):
+        super(UniversaldependenciesConfig,
+              self).__init__(version=datasets.Version("{{ ud_ver }}.0", ""), **kwargs)
+
+        self.data_url = data_url
+
+
+class UniversalDependencies(datasets.GeneratorBasedBuilder):
+    VERSION = datasets.Version("{{ ud_ver }}.0")
+    BUILDER_CONFIGS = [
+        UniversaldependenciesConfig(
+            name=name,
+            description=_DESCRIPTIONS[name],
+            license=_LICENSES[name],
+            data_url="https://github.com/UniversalDependencies/" + _UD_DATASETS[name]["test"].split("/")[0],
+        )
+        for name in _NAMES
+    ]
+    BUILDER_CONFIG_CLASS = UniversaldependenciesConfig
+
+    def _info(self):
+        return datasets.DatasetInfo(
+            description=_DESCRIPTION,
+            features=datasets.Features(
+                {
+                    "idx": datasets.Value("string"),
+                    "text": datasets.Value("string"),
+                    "tokens": datasets.Sequence(datasets.Value("string")),
+                    "lemmas": datasets.Sequence(datasets.Value("string")),
+                    "upos": datasets.Sequence(
+                        datasets.features.ClassLabel(
+                            names=[
+                                "NOUN",
+                                "PUNCT",
+                                "ADP",
+                                "NUM",
+                                "SYM",
+                                "SCONJ",
+                                "ADJ",
+                                "PART",
+                                "DET",
+                                "CCONJ",
+                                "PROPN",
+                                "PRON",
+                                "X",
+                                "_",
+                                "ADV",
+                                "INTJ",
+                                "VERB",
+                                "AUX",
+                            ]
+                        )
+                    ),
+                    "xpos": datasets.Sequence(datasets.Value("string")),
+                    "feats": datasets.Sequence(datasets.Value("string")),
+                    "head": datasets.Sequence(datasets.Value("string")),
+                    "deprel": datasets.Sequence(datasets.Value("string")),
+                    "deps": datasets.Sequence(datasets.Value("string")),
+                    "misc": datasets.Sequence(datasets.Value("string")),
+                }
+            ),
+            supervised_keys=None,
+            homepage="https://universaldependencies.org/",
+            citation=_CITATION,
+        )
+
+    def _split_generators(self, dl_manager):
+        """Returns SplitGenerators."""
+        urls_to_download = {}
+        for split, address in _UD_DATASETS[self.config.name].items():
+            urls_to_download[split] = []
+            if isinstance(address, list):
+                for add in address:
+                    urls_to_download[split].append(_PREFIX + add)
+            else:
+                urls_to_download[split].append(_PREFIX + address)
+
+        downloaded_files = dl_manager.download_and_extract(urls_to_download)
+        splits = []
+
+        if "train" in downloaded_files:
+            splits.append(
+                datasets.SplitGenerator(name=datasets.Split.TRAIN, gen_kwargs={"filepath": downloaded_files["train"]})
+            )
+
+        if "dev" in downloaded_files:
+            splits.append(
+                datasets.SplitGenerator(
+                    name=datasets.Split.VALIDATION, gen_kwargs={"filepath": downloaded_files["dev"]}
+                )
+            )
+
+        if "test" in downloaded_files:
+            splits.append(
+                datasets.SplitGenerator(name=datasets.Split.TEST, gen_kwargs={"filepath": downloaded_files["test"]})
+            )
+
+        return splits
+
+    def _generate_examples(self, filepath):
+        id = 0
+        for path in filepath:
+            with open(path, "r", encoding="utf-8") as data_file:
+                tokenlist = list(conllu.parse_incr(data_file))
+                for sent in tokenlist: 
+                    if "sent_id" in sent.metadata:
+                        idx = sent.metadata["sent_id"]
+                    else:
+                        idx = id
+
+                    tokens = [token["form"] for token in sent]
+
+                    if "text" in sent.metadata:
+                        txt = sent.metadata["text"]
+                    else:
+                        txt = " ".join(tokens)
+
+                    yield id, {
+                        "idx": str(idx),
+                        "text": txt,
+                        "tokens": [token["form"] for token in sent],
+                        "lemmas": [token["lemma"] for token in sent],
+                        "upos": [token["upos"] for token in sent],
+                        "xpos": [token["xpos"] for token in sent],
+                        "feats": [str(token["feats"]) for token in sent],
+                        "head": [str(token["head"]) for token in sent],
+                        "deprel": [str(token["deprel"]) for token in sent],
+                        "deps": [str(token["deps"]) for token in sent],
+                        "misc": [str(token["misc"]) for token in sent],
+                    }
+                    id += 1