Duplicate from lst-nectec/lst20

Co-authored-by: Parquet-converter (BOT) <parquet-converter@users.noreply.huggingface.co>

.gitattributes

@@ -0,0 +1,27 @@
+*.7z filter=lfs diff=lfs merge=lfs -text
+*.arrow filter=lfs diff=lfs merge=lfs -text
+*.bin filter=lfs diff=lfs merge=lfs -text
+*.bin.* filter=lfs diff=lfs merge=lfs -text
+*.bz2 filter=lfs diff=lfs merge=lfs -text
+*.ftz filter=lfs diff=lfs merge=lfs -text
+*.gz filter=lfs diff=lfs merge=lfs -text
+*.h5 filter=lfs diff=lfs merge=lfs -text
+*.joblib filter=lfs diff=lfs merge=lfs -text
+*.lfs.* filter=lfs diff=lfs merge=lfs -text
+*.model filter=lfs diff=lfs merge=lfs -text
+*.msgpack filter=lfs diff=lfs merge=lfs -text
+*.onnx filter=lfs diff=lfs merge=lfs -text
+*.ot filter=lfs diff=lfs merge=lfs -text
+*.parquet filter=lfs diff=lfs merge=lfs -text
+*.pb filter=lfs diff=lfs merge=lfs -text
+*.pt filter=lfs diff=lfs merge=lfs -text
+*.pth filter=lfs diff=lfs merge=lfs -text
+*.rar filter=lfs diff=lfs merge=lfs -text
+saved_model/**/* filter=lfs diff=lfs merge=lfs -text
+*.tar.* filter=lfs diff=lfs merge=lfs -text
+*.tflite filter=lfs diff=lfs merge=lfs -text
+*.tgz filter=lfs diff=lfs merge=lfs -text
+*.xz filter=lfs diff=lfs merge=lfs -text
+*.zip filter=lfs diff=lfs merge=lfs -text
+*.zstandard filter=lfs diff=lfs merge=lfs -text
+*tfevents* filter=lfs diff=lfs merge=lfs -text

README.md

@@ -0,0 +1,301 @@
+---
+annotations_creators:
+- expert-generated
+language_creators:
+- found
+language:
+- th
+license:
+- other
+multilinguality:
+- monolingual
+size_categories:
+- 10K<n<100K
+source_datasets:
+- original
+task_categories:
+- token-classification
+task_ids:
+- named-entity-recognition
+- part-of-speech
+pretty_name: LST20
+tags:
+- word-segmentation
+- clause-segmentation
+- sentence-segmentation
+dataset_info:
+  features:
+  - name: id
+    dtype: string
+  - name: fname
+    dtype: string
+  - name: tokens
+    sequence: string
+  - name: pos_tags
+    sequence:
+      class_label:
+        names:
+          '0': NN
+          '1': VV
+          '2': PU
+          '3': CC
+          '4': PS
+          '5': AX
+          '6': AV
+          '7': FX
+          '8': NU
+          '9': AJ
+          '10': CL
+          '11': PR
+          '12': NG
+          '13': PA
+          '14': XX
+          '15': IJ
+  - name: ner_tags
+    sequence:
+      class_label:
+        names:
+          '0': O
+          '1': B_BRN
+          '2': B_DES
+          '3': B_DTM
+          '4': B_LOC
+          '5': B_MEA
+          '6': B_NUM
+          '7': B_ORG
+          '8': B_PER
+          '9': B_TRM
+          '10': B_TTL
+          '11': I_BRN
+          '12': I_DES
+          '13': I_DTM
+          '14': I_LOC
+          '15': I_MEA
+          '16': I_NUM
+          '17': I_ORG
+          '18': I_PER
+          '19': I_TRM
+          '20': I_TTL
+          '21': E_BRN
+          '22': E_DES
+          '23': E_DTM
+          '24': E_LOC
+          '25': E_MEA
+          '26': E_NUM
+          '27': E_ORG
+          '28': E_PER
+          '29': E_TRM
+          '30': E_TTL
+  - name: clause_tags
+    sequence:
+      class_label:
+        names:
+          '0': O
+          '1': B_CLS
+          '2': I_CLS
+          '3': E_CLS
+  config_name: lst20
+  splits:
+  - name: train
+    num_bytes: 107725145
+    num_examples: 63310
+  - name: validation
+    num_bytes: 9646167
+    num_examples: 5620
+  - name: test
+    num_bytes: 8217425
+    num_examples: 5250
+  download_size: 0
+  dataset_size: 125588737
+---
+
+# Dataset Card for LST20
+
+## 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:** https://aiforthai.in.th/
+- **Repository:**
+- **Paper:** 
+- **Leaderboard:**
+- **Point of Contact:** [email](thepchai@nectec.or.th)
+
+### Dataset Summary
+
+LST20 Corpus is a dataset for Thai language processing developed by National Electronics and Computer Technology Center (NECTEC), Thailand.
+It offers five layers of linguistic annotation: word boundaries, POS tagging, named entities, clause boundaries, and sentence boundaries.
+At a large scale, it consists of 3,164,002 words, 288,020 named entities, 248,181 clauses, and 74,180 sentences, while it is annotated with
+16 distinct POS tags. All 3,745 documents are also annotated with one of 15 news genres. Regarding its sheer size, this dataset is
+considered large enough for developing joint neural models for NLP.
+Manually download at https://aiforthai.in.th/corpus.php
+See `LST20 Annotation Guideline.pdf` and `LST20 Brief Specification.pdf` within the downloaded `AIFORTHAI-LST20Corpus.tar.gz` for more details.
+
+### Supported Tasks and Leaderboards
+
+- POS tagging
+- NER tagging
+- clause segmentation
+- sentence segmentation
+- word tokenization
+
+### Languages
+
+Thai
+
+## Dataset Structure
+
+### Data Instances
+
+```
+{'clause_tags': [1, 2, 2, 2, 2, 2, 2, 2, 3], 'fname': 'T11964.txt', 'id': '0', 'ner_tags': [8, 0, 0, 0, 0, 0, 0, 0, 25], 'pos_tags': [0, 0, 0, 1, 0, 8, 8, 8, 0], 'tokens': ['ธรรมนูญ', 'แชมป์', 'สิงห์คลาสสิก', 'กวาด', 'รางวัล', 'แสน', 'สี่', 'หมื่น', 'บาท']}
+{'clause_tags': [1, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 3], 'fname': 'T11964.txt', 'id': '1', 'ner_tags': [8, 18, 28, 0, 0, 0, 0, 6, 0, 0, 0, 6, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 5, 15, 25, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 6, 0, 0, 0, 6], 'pos_tags': [0, 2, 0, 2, 1, 1, 2, 8, 2, 10, 2, 8, 2, 1, 0, 1, 0, 4, 7, 1, 0, 2, 8, 2, 10, 1, 10, 4, 2, 8, 2, 4, 0, 4, 0, 2, 8, 2, 10, 2, 8], 'tokens': ['ธรรมนูญ', '_', 'ศรีโรจน์', '_', 'เก็บ', 'เพิ่ม', '_', '4', '_', 'อันเดอร์พาร์', '_', '68', '_', 'เข้า', 'ป้าย', 'รับ', 'แชมป์', 'ใน', 'การ', 'เล่น', 'อาชีพ', '_', '19', '_', 'ปี', 'เป็น', 'ครั้ง', 'ที่', '_', '8', '_', 'ใน', 'ชีวิต', 'ด้วย', 'สกอร์', '_', '18', '_', 'อันเดอร์พาร์', '_', '270']}
+```
+
+### Data Fields
+
+- `id`: nth sentence in each set, starting at 0
+- `fname`: text file from which the sentence comes from
+- `tokens`: word tokens
+- `pos_tags`: POS tags
+- `ner_tags`: NER tags
+- `clause_tags`: clause tags
+
+### Data Splits
+
+|                      | train     | eval        | test        | all       |
+|----------------------|-----------|-------------|-------------|-----------|
+| words                | 2,714,848 | 240,891     | 207,295     | 3,163,034 |
+| named entities       | 246,529   | 23,176      | 18,315      | 288,020   |
+| clauses              | 214,645   | 17,486      | 16,050      | 246,181   |
+| sentences            | 63,310    | 5,620       | 5,250       | 74,180    |
+| distinct words       | 42,091    | (oov) 2,595 | (oov) 2,006 | 46,692    |
+| breaking spaces※     | 63,310    | 5,620       | 5,250       | 74,180    |
+| non-breaking spaces※※| 402,380   | 39,920      | 32,204      | 475,504   |
+
+※ Breaking space = space that is used as a sentence boundary marker
+※※ Non-breaking space = space that is not used as a sentence boundary marker
+
+## Dataset Creation
+
+### Curation Rationale
+
+[More Information Needed]
+
+### Source Data
+
+#### Initial Data Collection and Normalization
+
+[More Information Needed]
+
+#### Who are the source language producers?
+
+Respective authors of the news articles
+
+### Annotations
+
+#### Annotation process
+
+Detailed annotation guideline can be found in `LST20 Annotation Guideline.pdf`.
+
+#### Who are the annotators?
+
+[More Information Needed]
+
+### Personal and Sensitive Information
+
+All texts are from public news. No personal and sensitive information is expected to be included.
+
+## Considerations for Using the Data
+
+### Social Impact of Dataset
+
+- Large-scale Thai NER & POS tagging, clause & sentence segmentatation, word tokenization
+
+### Discussion of Biases
+
+- All 3,745 texts are from news domain:
+  - politics: 841
+  - crime and accident: 592
+  - economics: 512
+  - entertainment: 472
+  - sports: 402
+  - international: 279
+  - science, technology and education: 216
+  - health: 92
+  - general: 75
+  - royal: 54
+  - disaster: 52
+  - development: 45
+  - environment: 40
+  - culture: 40
+  - weather forecast: 33
+- Word tokenization is done accoding to Inter­BEST 2009 Guideline.
+
+
+### Other Known Limitations
+
+- Some NER tags do not correspond with given labels (`B`, `I`, and so on)
+
+## Additional Information
+
+### Dataset Curators
+
+[NECTEC](https://www.nectec.or.th/en/)
+
+### Licensing Information
+
+1. Non-commercial use, research, and open source
+
+Any non-commercial use of the dataset for research and open-sourced projects is encouraged and free of charge. Please cite our technical report for reference.
+
+If you want to perpetuate your models trained on our dataset and share them to the research community in Thailand, please send your models, code, and APIs to the AI for Thai Project. Please contact Dr. Thepchai Supnithi via thepchai@nectec.or.th for more information.
+
+Note that modification and redistribution of the dataset by any means are strictly prohibited unless authorized by the corpus authors.
+
+2. Commercial use
+
+In any commercial use of the dataset, there are two options.
+
+- Option 1 (in kind): Contributing a dataset of 50,000 words completely annotated with our annotation scheme within 1 year. Your data will also be shared and recognized as a dataset co-creator in the research community in Thailand.
+
+- Option 2 (in cash): Purchasing a lifetime license for the entire dataset is required. The purchased rights of use cover only this dataset.
+
+In both options, please contact Dr. Thepchai Supnithi via thepchai@nectec.or.th for more information.
+
+### Citation Information
+
+```
+@article{boonkwan2020annotation,
+  title={The Annotation Guideline of LST20 Corpus},
+  author={Boonkwan, Prachya and Luantangsrisuk, Vorapon and Phaholphinyo, Sitthaa and Kriengket, Kanyanat and Leenoi, Dhanon and Phrombut, Charun and Boriboon, Monthika and Kosawat, Krit and Supnithi, Thepchai},
+  journal={arXiv preprint arXiv:2008.05055},
+  year={2020}
+}
+```
+
+### Contributions
+
+Thanks to [@cstorm125](https://github.com/cstorm125) for adding this dataset.

lst20.py

@@ -0,0 +1,197 @@
+import glob
+import os
+from pathlib import Path
+
+import datasets
+
+
+_CITATION = """\
+@article{boonkwan2020annotation,
+  title={The Annotation Guideline of LST20 Corpus},
+  author={Boonkwan, Prachya and Luantangsrisuk, Vorapon and Phaholphinyo, Sitthaa and Kriengket, Kanyanat and Leenoi, Dhanon and Phrombut, Charun and Boriboon, Monthika and Kosawat, Krit and Supnithi, Thepchai},
+  journal={arXiv preprint arXiv:2008.05055},
+  year={2020}
+}
+"""
+
+_DESCRIPTION = """\
+LST20 Corpus is a dataset for Thai language processing developed by National Electronics and Computer Technology Center (NECTEC), Thailand.
+It offers five layers of linguistic annotation: word boundaries, POS tagging, named entities, clause boundaries, and sentence boundaries.
+At a large scale, it consists of 3,164,002 words, 288,020 named entities, 248,181 clauses, and 74,180 sentences, while it is annotated with
+16 distinct POS tags. All 3,745 documents are also annotated with one of 15 news genres. Regarding its sheer size, this dataset is
+considered large enough for developing joint neural models for NLP.
+Manually download at https://aiforthai.in.th/corpus.php
+"""
+
+
+class Lst20Config(datasets.BuilderConfig):
+    """BuilderConfig for Lst20"""
+
+    def __init__(self, **kwargs):
+        """BuilderConfig for Lst20.
+
+        Args:
+          **kwargs: keyword arguments forwarded to super.
+        """
+        super(Lst20Config, self).__init__(**kwargs)
+
+
+class Lst20(datasets.GeneratorBasedBuilder):
+    """Lst20 dataset."""
+
+    _SENTENCE_SPLITTERS = ["", " ", "\n"]
+    _TRAINING_FOLDER = "train"
+    _VALID_FOLDER = "eval"
+    _TEST_FOLDER = "test"
+    _POS_TAGS = ["NN", "VV", "PU", "CC", "PS", "AX", "AV", "FX", "NU", "AJ", "CL", "PR", "NG", "PA", "XX", "IJ"]
+    _NER_TAGS = [
+        "O",
+        "B_BRN",
+        "B_DES",
+        "B_DTM",
+        "B_LOC",
+        "B_MEA",
+        "B_NUM",
+        "B_ORG",
+        "B_PER",
+        "B_TRM",
+        "B_TTL",
+        "I_BRN",
+        "I_DES",
+        "I_DTM",
+        "I_LOC",
+        "I_MEA",
+        "I_NUM",
+        "I_ORG",
+        "I_PER",
+        "I_TRM",
+        "I_TTL",
+        "E_BRN",
+        "E_DES",
+        "E_DTM",
+        "E_LOC",
+        "E_MEA",
+        "E_NUM",
+        "E_ORG",
+        "E_PER",
+        "E_TRM",
+        "E_TTL",
+    ]
+    _CLAUSE_TAGS = ["O", "B_CLS", "I_CLS", "E_CLS"]
+
+    BUILDER_CONFIGS = [
+        Lst20Config(name="lst20", version=datasets.Version("1.0.0"), description="LST20 dataset"),
+    ]
+
+    @property
+    def manual_download_instructions(self):
+        return """\
+  You need to
+  1. Manually download `AIFORTHAI-LST20Corpus.tar.gz` from https://aiforthai.in.th/corpus.php (login required; website mostly in Thai)
+  2. Extract the .tar.gz; this will result in folder `LST20Corpus`
+  The <path/to/folder> can e.g. be `~/Downloads/LST20Corpus`.
+  lst20 can then be loaded using the following command `datasets.load_dataset("lst20", data_dir="<path/to/folder>")`.
+  """
+
+    def _info(self):
+        return datasets.DatasetInfo(
+            description=_DESCRIPTION,
+            features=datasets.Features(
+                {
+                    "id": datasets.Value("string"),
+                    "fname": datasets.Value("string"),
+                    "tokens": datasets.Sequence(datasets.Value("string")),
+                    "pos_tags": datasets.Sequence(datasets.features.ClassLabel(names=self._POS_TAGS)),
+                    "ner_tags": datasets.Sequence(datasets.features.ClassLabel(names=self._NER_TAGS)),
+                    "clause_tags": datasets.Sequence(datasets.features.ClassLabel(names=self._CLAUSE_TAGS)),
+                }
+            ),
+            supervised_keys=None,
+            homepage="https://aiforthai.in.th/",
+            citation=_CITATION,
+        )
+
+    def _split_generators(self, dl_manager):
+        """Returns SplitGenerators."""
+
+        data_dir = os.path.abspath(os.path.expanduser(dl_manager.manual_dir))
+
+        # check if manual folder exists
+        if not os.path.exists(data_dir):
+            raise FileNotFoundError(
+                f"{data_dir} does not exist. Make sure you insert a manual dir via `datasetts.load_dataset('lst20', data_dir=...)`. Manual download instructions: {self.manual_download_instructions})"
+            )
+
+        # check number of .txt files
+        nb_train = len(glob.glob(os.path.join(data_dir, "train", "*.txt")))
+        nb_valid = len(glob.glob(os.path.join(data_dir, "eval", "*.txt")))
+        nb_test = len(glob.glob(os.path.join(data_dir, "test", "*.txt")))
+        assert (
+            nb_train > 0
+        ), f"No files found in train/*.txt.\nManual download instructions:{self.manual_download_instructions})"
+        assert (
+            nb_valid > 0
+        ), f"No files found in eval/*.txt.\nManual download instructions:{self.manual_download_instructions})"
+        assert (
+            nb_test > 0
+        ), f"No files found in test/*.txt.\nManual download instructions:{self.manual_download_instructions})"
+
+        return [
+            datasets.SplitGenerator(
+                name=datasets.Split.TRAIN,
+                gen_kwargs={"filepath": os.path.join(data_dir, self._TRAINING_FOLDER)},
+            ),
+            datasets.SplitGenerator(
+                name=datasets.Split.VALIDATION,
+                gen_kwargs={"filepath": os.path.join(data_dir, self._VALID_FOLDER)},
+            ),
+            datasets.SplitGenerator(
+                name=datasets.Split.TEST,
+                gen_kwargs={"filepath": os.path.join(data_dir, self._TEST_FOLDER)},
+            ),
+        ]
+
+    def _generate_examples(self, filepath):
+        for file_idx, fname in enumerate(sorted(glob.glob(os.path.join(filepath, "*.txt")))):
+            with open(fname, encoding="utf-8") as f:
+                guid = 0
+                tokens = []
+                pos_tags = []
+                ner_tags = []
+                clause_tags = []
+
+                for line in f:
+                    if line in self._SENTENCE_SPLITTERS:
+                        if tokens:
+                            yield f"{file_idx}_{guid}", {
+                                "id": str(guid),
+                                "fname": Path(fname).name,
+                                "tokens": tokens,
+                                "pos_tags": pos_tags,
+                                "ner_tags": ner_tags,
+                                "clause_tags": clause_tags,
+                            }
+                            guid += 1
+                            tokens = []
+                            pos_tags = []
+                            ner_tags = []
+                            clause_tags = []
+                    else:
+                        # LST20 tokens are tab separated
+                        splits = line.split("\t")
+                        # replace junk ner tags
+                        ner_tag = splits[2] if splits[2] in self._NER_TAGS else "O"
+                        tokens.append(splits[0])
+                        pos_tags.append(splits[1])
+                        ner_tags.append(ner_tag)
+                        clause_tags.append(splits[3].rstrip())
+                # last example
+                if tokens:
+                    yield f"{file_idx}_{guid}", {
+                        "id": str(guid),
+                        "fname": Path(fname).name,
+                        "tokens": tokens,
+                        "pos_tags": pos_tags,
+                        "ner_tags": ner_tags,
+                        "clause_tags": clause_tags,
+                    }