added 'entities' dataset

.gitattributes

@@ -25,4 +25,4 @@ saved_model/**/* 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
-data/good-pages/scrapped/final-dataset.csv filter=lfs diff=lfs merge=lfs -text
+data.tar.gz filter=lfs diff=lfs merge=lfs -text

frwiki_good_pages_el.py

@@ -57,19 +57,25 @@ _HOMEPAGE = "https://github.com/GaaH/frwiki_good_pages_el"
 # TODO: Add the licence for the dataset here if you can find it
 _LICENSE = ""
 
-# TODO: Add link to the official dataset URLs here
-# The HuggingFace dataset library don't host the datasets but only point to the original files
-# This can be an arbitrary nested dict/list of URLs (see below in `_split_generators` method)
 _URLs = {
     "frwiki": "data.tar.gz",
+    "entities": "data.tar.gz",
 }
 
-_CLASS_LABELS = [
+_NER_CLASS_LABELS = [
     "B",
     "I",
     "O",
 ]
 
+_ENTITY_TYPES = [
+    "DATE",
+    "PERSON",
+    "GEOLOC",
+    "ORG",
+    "OTHER",
+]
+
 
 def text_to_el_features(doc_qid, doc_title, text, title2qid, title2wikipedia, title2wikidata):
     res = {
@@ -176,6 +182,8 @@ class FrWikiGoodPagesELDataset(datasets.GeneratorBasedBuilder):
     BUILDER_CONFIGS = [
         datasets.BuilderConfig(name="frwiki", version=VERSION,
                                description="The frwiki dataset for Entity Linking"),
+        datasets.BuilderConfig(name="entities", version=VERSION,
+                               description="Entities and their descriptions"),
     ]
 
     # It's not mandatory to have a default configuration. Just use one if it make sense.
@@ -189,10 +197,21 @@ class FrWikiGoodPagesELDataset(datasets.GeneratorBasedBuilder):
                 "words": [datasets.Value("string")],
                 "wikipedia": [datasets.Value("string")],
                 "wikidata": [datasets.Value("string")],
-                "labels": [datasets.ClassLabel(names=_CLASS_LABELS)],
+                "labels": [datasets.ClassLabel(names=_NER_CLASS_LABELS)],
                 "titles": [datasets.Value("string")],
                 "qids": [datasets.Value("string")],
             })
+        elif self.config.name == "entities":
+            features = datasets.Features({
+                "qid": datasets.Value("string"),
+                "title": datasets.Value("string"),
+                "url": datasets.Value("string"),
+                "label": datasets.Value("string"),
+                "aliases": [datasets.Value("string")],
+                "type": datasets.ClassLabel(names=_ENTITY_TYPES),
+                "wikipedia": datasets.Value("string"),
+                "wikidata": datasets.Value("string"),
+            })
 
         return datasets.DatasetInfo(
             # This is the description that will appear on the datasets page.
@@ -241,31 +260,58 @@ class FrWikiGoodPagesELDataset(datasets.GeneratorBasedBuilder):
         # This method handles input defined in _split_generators to yield (key, example) tuples from the dataset.
         # The `key` is here for legacy reason (tfds) and is not important in itself.
 
-        with open(Path(data_dir, "list-good-pages.txt"), "rt", encoding="UTF-8") as f:
-            good_pages_list = set(f.read().split("\n")).difference("")
-
         entities_path = Path(data_dir, "entities.jsonl.gz")
         corpus_path = Path(data_dir, "corpus.jsonl.gz")
-        title2wikipedia = {}
-        title2wikidata = {}
-        title2qid = {}
-        with gzip.open(entities_path, "rt", encoding="UTF-8") as ent_file:
-            for line in ent_file:
-                item = json.loads(line, parse_int=lambda x: x,
-                                  parse_float=lambda x: x, parse_constant=lambda x: x)
-                title = item["title"]
-                title2wikipedia[title] = item["wikipedia_description"]
-                title2wikidata[title] = item["wikidata_description"]
-                title2qid[title] = item["qid"]
-
-        with gzip.open(corpus_path, "rt", encoding="UTF-8") as crps_file:
-            for id, line in enumerate(crps_file):
-                item = json.loads(line, parse_int=lambda x: x,
-                                  parse_float=lambda x: x, parse_constant=lambda x: x)
-                qid = item["qid"]
-                title = item["title"]
-                text = item["text"]
-
-                features = text_to_el_features(
-                    qid, title, text, title2qid, title2wikipedia, title2wikidata)
-                yield id, features
+
+        def _identiy(x):
+            return x
+
+        if self.config.name == "frwiki":
+            title2wikipedia = {}
+            title2wikidata = {}
+            title2qid = {}
+            with gzip.open(entities_path, "rt", encoding="UTF-8") as ent_file:
+                for line in ent_file:
+                    item = json.loads(
+                        line, parse_int=_identiy, parse_float=_identiy, parse_constant=_identiy)
+                    title = item["title"]
+                    title2wikipedia[title] = item["wikipedia_description"]
+                    title2wikidata[title] = item["wikidata_description"]
+                    title2qid[title] = item["qid"]
+
+            with gzip.open(corpus_path, "rt", encoding="UTF-8") as crps_file:
+                for id, line in enumerate(crps_file):
+                    item = json.loads(line, parse_int=lambda x: x,
+                                      parse_float=lambda x: x, parse_constant=lambda x: x)
+                    qid = item["qid"]
+                    title = item["title"]
+                    text = item["text"]
+
+                    features = text_to_el_features(
+                        qid, title, text, title2qid, title2wikipedia, title2wikidata)
+                    yield id, features
+        elif self.config.name == "entities":
+            entity_pattern = r"\[E=(.+?)\](.+?)\[/E\]"
+            with gzip.open(entities_path, "rt", encoding="UTF-8") as ent_file:
+                for id, line in enumerate(ent_file):
+                    item = json.loads(
+                        line, parse_int=_identiy, parse_float=_identiy, parse_constant=_identiy)
+                    try:
+                        qid = item["qid"]
+                        item["wikipedia"] = re.sub(
+                            entity_pattern,
+                            r"\2",
+                            item.pop("wikipedia_description")
+                        )
+                        item["wikidata"] = item.pop("wikidata_description")
+                        if qid is None or qid == "" or item["type"] not in _ENTITY_TYPES:
+                            item["qid"] = ""
+                            item["wikidata"] = ""
+                            item["label"] = ""
+                            item["aliases"] = []
+                            item["type"] = "OTHER"
+                        yield id, item
+                    except:
+                        import sys
+                        print(item, file=sys.stderr)
+                        return