Add collection3 files (#1)

- Add collection3 files (caf1710341efed57c0c2ccc7b6bbad573919e94d)


Co-authored-by: Pavel Efimov <pefimov@users.noreply.huggingface.co>

README.md

@@ -1,3 +1,166 @@
 ---
-license: other
+annotations_creators:
+- other
+language:
+- ru
+language_creators:
+- found
+license:
+- other
+multilinguality:
+- monolingual
+pretty_name: Collection3
+size_categories:
+- 10K<n<100K
+source_datasets: []
+tags: []
+task_categories:
+- token-classification
+task_ids:
+- named-entity-recognition
 ---
+
+# Dataset Card for Collection3
+
+## Table of Contents
+- [Dataset Description](#dataset-description)
+  - [Dataset Summary](#dataset-summary)
+  - [Supported Tasks](#supported-tasks-and-leaderboards)
+  - [Languages](#languages)
+- [Dataset Structure](#dataset-structure)
+  - [Data Instances](#data-instances)
+  - [Data Fields](#data-instances)
+  - [Data Splits](#data-instances)
+- [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)
+
+## Dataset Description
+
+- **Homepage:** [Collection3 homepage](http://labinform.ru/pub/named_entities/index.htm)
+- **Repository:** [Needs More Information]
+- **Paper:** [Two-stage approach in Russian named entity recognition](https://ieeexplore.ieee.org/document/7584769)
+- **Leaderboard:** [Needs More Information]
+- **Point of Contact:** [Needs More Information]
+
+### Dataset Summary
+
+Collection3 is a Russian dataset for named entity recognition annotated with LOC (location), PER (person), and ORG (organization) tags. Dataset is based on collection [Persons-1000](http://ai-center.botik.ru/Airec/index.php/ru/collections/28-persons-1000) originally containing 1000 news documents labeled only with names of persons.
+
+Additional labels were obtained using guidelines similar to MUC-7 with web-based tool [Brat](http://brat.nlplab.org/) for collaborative text annotation.
+
+Currently dataset contains 26K annotated named entities (11K Persons, 7K Locations and 8K Organizations).
+
+Conversion to the IOB2 format and splitting into train, validation and test sets was done by [DeepPavlov team](http://files.deeppavlov.ai/deeppavlov_data/collection3_v2.tar.gz).
+
+### Supported Tasks and Leaderboards
+
+[Needs More Information]
+
+### Languages
+
+Russian
+
+## Dataset Structure
+
+### Data Instances
+
+An example of 'train' looks as follows.
+
+```
+{
+    "id": "851",
+    "ner_tags": [0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 3, 1, 2, 0, 0, 0],
+    "tokens": ['Главный', 'архитектор', 'программного', 'обеспечения', '(', 'ПО', ')', 'американского', 'высокотехнологичного', 'гиганта', 'Microsoft', 'Рэй', 'Оззи', 'покидает', 'компанию', '.']
+}
+```
+
+### Data Fields
+
+- id: a string feature.
+- tokens: a list of string features.
+- ner_tags: a list of classification labels (int). Full tagset with indices:
+```
+{'O': 0, 'B-PER': 1, 'I-PER': 2, 'B-ORG': 3, 'I-ORG': 4, 'B-LOC': 5, 'I-LOC': 6}
+```
+
+### Data Splits
+
+|name|train|validation|test|
+|---------|----:|---------:|---:|
+|Collection3|9301|2153|1922|
+
+## Dataset Creation
+
+### Curation Rationale
+
+[Needs More Information]
+
+### Source Data
+
+#### Initial Data Collection and Normalization
+
+[Needs More Information]
+
+#### Who are the source language producers?
+
+[Needs More Information]
+
+### Annotations
+
+#### Annotation process
+
+[Needs More Information]
+
+#### Who are the annotators?
+
+[Needs More Information]
+
+### Personal and Sensitive Information
+
+[Needs More Information]
+
+## Considerations for Using the Data
+
+### Social Impact of Dataset
+
+[Needs More Information]
+
+### Discussion of Biases
+
+[Needs More Information]
+
+### Other Known Limitations
+
+[Needs More Information]
+
+## Additional Information
+
+### Dataset Curators
+
+[Needs More Information]
+
+### Licensing Information
+
+[Needs More Information]
+
+### Citation Information
+```
+@inproceedings{mozharova-loukachevitch-2016-two-stage-russian-ner,
+  author={Mozharova, Valerie and Loukachevitch, Natalia},
+  booktitle={2016 International FRUCT Conference on Intelligence, Social Media and Web (ISMW FRUCT)},
+  title={Two-stage approach in Russian named entity recognition}, 
+  year={2016},
+  pages={1-6},
+  doi={10.1109/FRUCT.2016.7584769}}
+  ```

collection3.py

@@ -0,0 +1,111 @@
+"""Collection3: Russian dataset for named entity recognition"""
+
+import os
+
+import datasets
+
+
+logger = datasets.logging.get_logger(__name__)
+
+
+_CITATION = """\
+@inproceedings{mozharova-loukachevitch-2016-two-stage-russian-ner,
+  author={Mozharova, Valerie and Loukachevitch, Natalia},
+  booktitle={2016 International FRUCT Conference on Intelligence, Social Media and Web (ISMW FRUCT)},
+  title={Two-stage approach in Russian named entity recognition},
+  year={2016},
+  pages={1-6},
+  doi={10.1109/FRUCT.2016.7584769}}
+"""
+
+_DESCRIPTION = """\
+Collection3 is a Russian dataset for named entity recognition annotated with LOC (location), PER (person), and ORG (organization) tags.
+
+Dataset is based on collection Persons-1000 originally containing 1000 news documents labeled only with names of persons.
+Additional labels were added by Valerie Mozharova and Natalia Loukachevitch.
+Conversion to the IOB2 format and splitting into train, validation and test sets was done by DeepPavlov team.
+
+For more details see https://ieeexplore.ieee.org/document/7584769 and http://labinform.ru/pub/named_entities/index.htm
+"""
+
+_TRAINING_FILE = "train.txt"
+_DEV_FILE = "valid.txt"
+_TEST_FILE = "test.txt"
+
+
+class Collection3(datasets.GeneratorBasedBuilder):
+    """Collection3 dataset."""
+
+    BUILDER_CONFIGS = [
+        datasets.BuilderConfig(name="collection3", version=datasets.Version("1.0.0"), description=_DESCRIPTION)
+    ]
+
+    def _info(self):
+        return datasets.DatasetInfo(
+            description=_DESCRIPTION,
+            features=datasets.Features(
+                {
+                    "id": datasets.Value("string"),
+                    "tokens": datasets.Sequence(datasets.Value("string")),
+                    "ner_tags": datasets.Sequence(
+                        datasets.features.ClassLabel(
+                            names=[
+                                "O",
+                                "B-PER",
+                                "I-PER",
+                                "B-ORG",
+                                "I-ORG",
+                                "B-LOC",
+                                "I-LOC",
+                            ]
+                        )
+                    ),
+                }
+            ),
+            supervised_keys=None,
+            homepage="http://labinform.ru/pub/named_entities/index.htm",
+            citation=_CITATION,
+        )
+
+    def _split_generators(self, dl_manager):
+        """Returns SplitGenerators."""
+        data_files = {
+            "train": os.path.join('data', _TRAINING_FILE),
+            "dev": os.path.join('data', _DEV_FILE),
+            "test": os.path.join('data', _TEST_FILE),
+        }
+
+        return [
+            datasets.SplitGenerator(name=datasets.Split.TRAIN, gen_kwargs={"filepath": data_files["train"]}),
+            datasets.SplitGenerator(name=datasets.Split.VALIDATION, gen_kwargs={"filepath": data_files["dev"]}),
+            datasets.SplitGenerator(name=datasets.Split.TEST, gen_kwargs={"filepath": data_files["test"]}),
+        ]
+
+    def _generate_examples(self, filepath):
+        logger.info("⏳ Generating examples from = %s", filepath)
+        with open(filepath, encoding="utf-8") as f:
+            guid = 0
+            tokens = []
+            ner_tags = []
+            for line in f:
+                if line.startswith("<DOCSTART>") or line == "" or line == "\n":
+                    if tokens:
+                        yield guid, {
+                            "id": str(guid),
+                            "tokens": tokens,
+                            "ner_tags": ner_tags,
+                        }
+                        guid += 1
+                        tokens = []
+                        ner_tags = []
+                else:
+                    splits = line.split("\t")
+                    tokens.append(splits[0])
+                    ner_tags.append(splits[1].rstrip())
+            # last example
+            if tokens:
+                yield guid, {
+                    "id": str(guid),
+                    "tokens": tokens,
+                    "ner_tags": ner_tags,
+                }

dataset_infos.json

@@ -0,0 +1 @@
+{"collection3": {"description": "Collection3 is a Russian dataset for named entity recognition annotated with LOC (location), PER (person), and ORG (organization) tags.\n\nDataset is based on collection Persons-1000 originally containing 1000 news documents labeled only with names of persons.\nAdditional labels were added by Valerie Mozharova and Natalia Loukachevitch.\nConversion to the IOB2 format and splitting into train, validation and test sets was done by DeepPavlov team.\n\nFor more details see https://ieeexplore.ieee.org/document/7584769 and http://labinform.ru/pub/named_entities/index.htm\n", "citation": "@inproceedings{mozharova-loukachevitch-2016-two-stage-russian-ner,\n  author={Mozharova, Valerie and Loukachevitch, Natalia},\n  booktitle={2016 International FRUCT Conference on Intelligence, Social Media and Web (ISMW FRUCT)},\n  title={Two-stage approach in Russian named entity recognition},\n  year={2016},\n  pages={1-6},\n  doi={10.1109/FRUCT.2016.7584769}}\n", "homepage": "http://labinform.ru/pub/named_entities/index.htm", "license": "", "features": {"id": {"dtype": "string", "id": null, "_type": "Value"}, "tokens": {"feature": {"dtype": "string", "id": null, "_type": "Value"}, "length": -1, "id": null, "_type": "Sequence"}, "ner_tags": {"feature": {"num_classes": 7, "names": ["O", "B-PER", "I-PER", "B-ORG", "I-ORG", "B-LOC", "I-LOC"], "names_file": null, "id": null, "_type": "ClassLabel"}, "length": -1, "id": null, "_type": "Sequence"}}, "post_processed": null, "supervised_keys": null, "builder_name": "collection3", "config_name": "collection3", "version": {"version_str": "1.0.0", "description": null, "major": 1, "minor": 0, "patch": 0}, "splits": {"train": {"name": "train", "num_bytes": 4380572, "num_examples": 9301, "dataset_name": "collection3"}, "validation": {"name": "validation", "num_bytes": 1020695, "num_examples": 2153, "dataset_name": "collection3"}, "test": {"name": "test", "num_bytes": 935282, "num_examples": 1922, "dataset_name": "collection3"}}, "download_checksums": {}, "download_size": 0, "post_processing_size": null, "dataset_size": 6336549, "size_in_bytes": 6336549}}