Remove old wikipedia leftovers (#3989)

* Remove old wikipedia leftovers

* Fix some typos in wiki_snippets script

* Update metadata JSON of wiki_snippets dataset

* Update dataset card of wiki_snippets

* Fix tag in dataset card

* Add task tags to dataset card

* Make consistent the conversion to MB

* Add comment warning not to use load_dataset in another script

Commit from https://github.com/huggingface/datasets/commit/58ee1bbd36b87b8a791cc663b90553bcf903b71f

README.md

@@ -1,8 +1,27 @@
 ---
+annotations_creators:
+- no-annotation
+language_creators:
+- crowdsourced
 languages:
 - en
-paperswithcode_id: null
+licenses:
+- unknown
+multilinguality:
+- multilingual
 pretty_name: WikiSnippets
+size_categories:
+- "10M<n<100M"
+source_datasets:
+- extended|wiki40b
+- extended|wikipedia
+task_categories:
+- sequence-modeling
+- other
+task_ids:
+- language-modeling
+- other-text-search
+paperswithcode_id: null
 ---
 
 # Dataset Card for "wiki_snippets"
@@ -37,9 +56,6 @@ pretty_name: WikiSnippets
 - **Repository:** [More Information Needed](https://github.com/huggingface/datasets/blob/master/CONTRIBUTING.md#how-to-contribute-to-the-dataset-cards)
 - **Paper:** [More Information Needed](https://github.com/huggingface/datasets/blob/master/CONTRIBUTING.md#how-to-contribute-to-the-dataset-cards)
 - **Point of Contact:** [More Information Needed](https://github.com/huggingface/datasets/blob/master/CONTRIBUTING.md#how-to-contribute-to-the-dataset-cards)
-- **Size of downloaded dataset files:** 0.00 MB
-- **Size of the generated dataset:** 35001.08 MB
-- **Total amount of disk used:** 35001.08 MB
 
 ### Dataset Summary
 
@@ -55,37 +71,56 @@ Wikipedia version split into plain text snippets for dense semantic indexing.
 
 ## Dataset Structure
 
-We show detailed information for up to 5 configurations of the dataset.
+We show detailed information for 2 configurations of the dataset (with 100 snippet passage length and 0 overlap) in
+English:
+- wiki40b_en_100_0: Wiki-40B
+- wikipedia_en_100_0: Wikipedia
 
 ### Data Instances
 
 #### wiki40b_en_100_0
 
 - **Size of downloaded dataset files:** 0.00 MB
-- **Size of the generated dataset:** 12268.10 MB
-- **Total amount of disk used:** 12268.10 MB
+- **Size of the generated dataset:** 12339.25 MB
+- **Total amount of disk used:** 12339.25 MB
 
-An example of 'train' looks as follows.
+An example of 'train' looks as follows:
 ```
-
+{'_id': '{"datasets_id": 0, "wiki_id": "Q1294448", "sp": 2, "sc": 0, "ep": 6, "ec": 610}',
+ 'datasets_id': 0,
+ 'wiki_id': 'Q1294448',
+ 'start_paragraph': 2,
+ 'start_character': 0,
+ 'end_paragraph': 6,
+ 'end_character': 610,
+ 'article_title': 'Ági Szalóki',
+ 'section_title': 'Life',
+ 'passage_text': "Ági Szalóki Life She started singing as a toddler, considering Márta Sebestyén a role model. Her musical background is traditional folk music; she first won recognition for singing with Ökrös in a traditional folk style, and Besh o droM, a Balkan gypsy brass band. With these ensembles she toured around the world from the Montreal Jazz Festival, through Glastonbury Festival to the Théatre de la Ville in Paris, from New York to Beijing.\nSince 2005, she began to pursue her solo career and explore various genres, such as jazz, thirties ballads, or children's songs.\nUntil now, three of her six released albums"}
 ```
 
 #### wikipedia_en_100_0
 
 - **Size of downloaded dataset files:** 0.00 MB
-- **Size of the generated dataset:** 22732.97 MB
-- **Total amount of disk used:** 22732.97 MB
+- **Size of the generated dataset:** 25184.52 MB
+- **Total amount of disk used:** 25184.52 MB
 
-An example of 'train' looks as follows.
+An example of 'train' looks as follows:
 ```
-
+{'_id': '{"datasets_id": 0, "wiki_id": "Anarchism", "sp": 0, "sc": 0, "ep": 2, "ec": 129}',
+ 'datasets_id': 0,
+ 'wiki_id': 'Anarchism',
+ 'start_paragraph': 0,
+ 'start_character': 0,
+ 'end_paragraph': 2,
+ 'end_character': 129,
+ 'article_title': 'Anarchism',
+ 'section_title': 'Start',
+ 'passage_text': 'Anarchism is a political philosophy and movement that is sceptical of authority and rejects all involuntary, coercive forms of hierarchy. Anarchism calls for the abolition of the state, which it holds to be unnecessary, undesirable, and harmful. As a historically left-wing movement, placed on the farthest left of the political spectrum, it is usually described alongside communalism and libertarian Marxism as the libertarian wing (libertarian socialism) of the socialist movement, and has a strong historical association with anti-capitalism and socialism.  Humans lived in societies without formal hierarchies long before the establishment of formal states, realms, or empires. With the'}
 ```
 
 ### Data Fields
 
-The data fields are the same among all splits.
-
-#### wiki40b_en_100_0
+The data fields are the same for all configurations:
 - `_id`: a `string` feature.
 - `datasets_id`: a `int32` feature.
 - `wiki_id`: a `string` feature.
@@ -97,24 +132,13 @@ The data fields are the same among all splits.
 - `section_title`: a `string` feature.
 - `passage_text`: a `string` feature.
 
-#### wikipedia_en_100_0
-- `_id`: a `string` feature.
-- `datasets_id`: a `int32` feature.
-- `wiki_id`: a `string` feature.
-- `start_paragraph`: a `int32` feature.
-- `start_character`: a `int32` feature.
-- `end_paragraph`: a `int32` feature.
-- `end_character`: a `int32` feature.
-- `article_title`: a `string` feature.
-- `section_title`: a `string` feature.
-- `passage_text`: a `string` feature.
 
 ### Data Splits
 
-|       name       | train  |
-|------------------|-------:|
-|wiki40b_en_100_0  |17553713|
-|wikipedia_en_100_0|30820408|
+| name               |    train |
+|:-------------------|---------:|
+| wiki40b_en_100_0   | 17553713 |
+| wikipedia_en_100_0 | 33849898 |
 
 ## Dataset Creation
 
@@ -168,17 +192,29 @@ The data fields are the same among all splits.
 
 ### Licensing Information
 
-[More Information Needed](https://github.com/huggingface/datasets/blob/master/CONTRIBUTING.md#how-to-contribute-to-the-dataset-cards)
+See licensing information of source datasets.
 
 ### Citation Information
 
+Cite source datasets:
+
+- Wiki-40B:
+```
+@inproceedings{49029,
+title = {Wiki-40B: Multilingual Language Model Dataset},
+author = {Mandy Guo and Zihang Dai and Denny Vrandecic and Rami Al-Rfou},
+year = {2020},
+booktitle   = {LREC 2020}
+}
 ```
-@ONLINE {wikidump,
+
+- Wikipedia:
+```
+@ONLINE{wikidump,
     author = "Wikimedia Foundation",
     title  = "Wikimedia Downloads",
     url    = "https://dumps.wikimedia.org"
 }
-
 ```
 
 

dataset_infos.json

@@ -1 +1 @@
-{"wiki40b_en_100_0": {"description": "Wikipedia version split into plain text snippets for dense semantic indexing.\n", "citation": "@ONLINE {wikidump,\n    author = \"Wikimedia Foundation\",\n    title  = \"Wikimedia Downloads\",\n    url    = \"https://dumps.wikimedia.org\"\n}\n", "homepage": "https://dumps.wikimedia.org", "license": "", "features": {"_id": {"dtype": "string", "id": null, "_type": "Value"}, "datasets_id": {"dtype": "int32", "id": null, "_type": "Value"}, "wiki_id": {"dtype": "string", "id": null, "_type": "Value"}, "start_paragraph": {"dtype": "int32", "id": null, "_type": "Value"}, "start_character": {"dtype": "int32", "id": null, "_type": "Value"}, "end_paragraph": {"dtype": "int32", "id": null, "_type": "Value"}, "end_character": {"dtype": "int32", "id": null, "_type": "Value"}, "article_title": {"dtype": "string", "id": null, "_type": "Value"}, "section_title": {"dtype": "string", "id": null, "_type": "Value"}, "passage_text": {"dtype": "string", "id": null, "_type": "Value"}}, "supervised_keys": null, "builder_name": "wiki_snippets", "config_name": "wiki40b_en_100_0", "version": {"version_str": "1.0.0", "description": null, "datasets_version_to_prepare": null, "major": 1, "minor": 0, "patch": 0}, "splits": {"train": {"name": "train", "num_bytes": 12864038411, "num_examples": 17553713, "dataset_name": "wiki_snippets"}}, "download_checksums": {}, "download_size": 0, "dataset_size": 12864038411, "size_in_bytes": 12864038411}, "wikipedia_en_100_0": {"description": "Wikipedia version split into plain text snippets for dense semantic indexing.\n", "citation": "@ONLINE {wikidump,\n    author = \"Wikimedia Foundation\",\n    title  = \"Wikimedia Downloads\",\n    url    = \"https://dumps.wikimedia.org\"\n}\n", "homepage": "https://dumps.wikimedia.org", "license": "", "features": {"_id": {"dtype": "string", "id": null, "_type": "Value"}, "datasets_id": {"dtype": "int32", "id": null, "_type": "Value"}, "wiki_id": {"dtype": "string", "id": null, "_type": "Value"}, "start_paragraph": {"dtype": "int32", "id": null, "_type": "Value"}, "start_character": {"dtype": "int32", "id": null, "_type": "Value"}, "end_paragraph": {"dtype": "int32", "id": null, "_type": "Value"}, "end_character": {"dtype": "int32", "id": null, "_type": "Value"}, "article_title": {"dtype": "string", "id": null, "_type": "Value"}, "section_title": {"dtype": "string", "id": null, "_type": "Value"}, "passage_text": {"dtype": "string", "id": null, "_type": "Value"}}, "supervised_keys": null, "builder_name": "wiki_snippets", "config_name": "wikipedia_en_100_0", "version": {"version_str": "1.0.0", "description": null, "datasets_version_to_prepare": null, "major": 1, "minor": 0, "patch": 0}, "splits": {"train": {"name": "train", "num_bytes": 23837250095, "num_examples": 30820408, "dataset_name": "wiki_snippets"}}, "download_checksums": {}, "download_size": 0, "dataset_size": 23837250095, "size_in_bytes": 23837250095}}
+{"wiki40b_en_100_0": {"description": "Wikipedia version split into plain text snippets for dense semantic indexing.\n", "citation": "@ONLINE {wikidump,\n    author = {Wikimedia Foundation},\n    title  = {Wikimedia Downloads},\n    url    = {https://dumps.wikimedia.org}\n}\n", "homepage": "https://dumps.wikimedia.org", "license": "", "features": {"_id": {"dtype": "string", "id": null, "_type": "Value"}, "datasets_id": {"dtype": "int32", "id": null, "_type": "Value"}, "wiki_id": {"dtype": "string", "id": null, "_type": "Value"}, "start_paragraph": {"dtype": "int32", "id": null, "_type": "Value"}, "start_character": {"dtype": "int32", "id": null, "_type": "Value"}, "end_paragraph": {"dtype": "int32", "id": null, "_type": "Value"}, "end_character": {"dtype": "int32", "id": null, "_type": "Value"}, "article_title": {"dtype": "string", "id": null, "_type": "Value"}, "section_title": {"dtype": "string", "id": null, "_type": "Value"}, "passage_text": {"dtype": "string", "id": null, "_type": "Value"}}, "post_processed": null, "supervised_keys": null, "task_templates": null, "builder_name": "wiki_snippets", "config_name": "wiki40b_en_100_0", "version": {"version_str": "1.0.0", "description": null, "major": 1, "minor": 0, "patch": 0}, "splits": {"train": {"name": "train", "num_bytes": 12938641686, "num_examples": 17553713, "dataset_name": "wiki_snippets"}}, "download_checksums": {}, "download_size": 0, "post_processing_size": null, "dataset_size": 12938641686, "size_in_bytes": 12938641686}, "wikipedia_en_100_0": {"description": "Wikipedia version split into plain text snippets for dense semantic indexing.\n", "citation": "@ONLINE {wikidump,\n    author = {Wikimedia Foundation},\n    title  = {Wikimedia Downloads},\n    url    = {https://dumps.wikimedia.org}\n}\n", "homepage": "https://dumps.wikimedia.org", "license": "", "features": {"_id": {"dtype": "string", "id": null, "_type": "Value"}, "datasets_id": {"dtype": "int32", "id": null, "_type": "Value"}, "wiki_id": {"dtype": "string", "id": null, "_type": "Value"}, "start_paragraph": {"dtype": "int32", "id": null, "_type": "Value"}, "start_character": {"dtype": "int32", "id": null, "_type": "Value"}, "end_paragraph": {"dtype": "int32", "id": null, "_type": "Value"}, "end_character": {"dtype": "int32", "id": null, "_type": "Value"}, "article_title": {"dtype": "string", "id": null, "_type": "Value"}, "section_title": {"dtype": "string", "id": null, "_type": "Value"}, "passage_text": {"dtype": "string", "id": null, "_type": "Value"}}, "post_processed": null, "supervised_keys": null, "task_templates": null, "builder_name": "wiki_snippets", "config_name": "wikipedia_en_100_0", "version": {"version_str": "2.0.0", "description": null, "major": 2, "minor": 0, "patch": 0}, "splits": {"train": {"name": "train", "num_bytes": 26407884393, "num_examples": 33849898, "dataset_name": "wiki_snippets"}}, "download_checksums": {}, "download_size": 0, "post_processing_size": null, "dataset_size": 26407884393, "size_in_bytes": 26407884393}}

wiki_snippets.py

@@ -1,3 +1,6 @@
+# WARNING: Please, do not use the code in this script as a template to create another script:
+# - It is a bad practice to use `datasets.load_dataset` inside a loading script. Please, avoid doing it.
+
 import json
 import math
 
@@ -80,7 +83,7 @@ def wikipedia_article_snippets(article, passage_len=100, overlap=0):
     for i in range(math.ceil(len(word_map) / step_size)):
         pre_toks = word_map[i * step_size : i * step_size + passage_len]
         start_section_id = max([0] + [j for j in section_indices if j <= pre_toks[0][0]])
-        section_ids = [j for j in section_indices if j >= start_section_id and j <= pre_toks[-1][0]]
+        section_ids = [j for j in section_indices if start_section_id <= j <= pre_toks[-1][0]]
         section_ids = section_ids if len(section_ids) > 0 else [-1]
         passage_text = " ".join([w for p_id, s_id, w in pre_toks])
         passages += [
@@ -98,15 +101,15 @@ def wikipedia_article_snippets(article, passage_len=100, overlap=0):
     return passages
 
 
-_SPLIT_FUCNTION_MAP = {
+_SPLIT_FUNCTION_MAP = {
     "wikipedia": wikipedia_article_snippets,
     "wiki40b": wiki40b_article_snippets,
 }
 
 
-def generate_snippets(wikipedia, split_funtion, passage_len=100, overlap=0):
+def generate_snippets(wikipedia, split_function, passage_len=100, overlap=0):
     for i, article in enumerate(wikipedia):
-        for doc in split_funtion(article, passage_len, overlap):
+        for doc in split_function(article, passage_len, overlap):
             part_id = json.dumps(
                 {
                     "datasets_id": i,
@@ -152,9 +155,9 @@ class WikiSnippets(datasets.GeneratorBasedBuilder):
         ),
         WikiSnippetsConfig(
             name="wikipedia_en_100_0",
-            version=datasets.Version("1.0.0"),
+            version=datasets.Version("2.0.0"),
             wikipedia_name="wikipedia",
-            wikipedia_version_name="20200501.en",
+            wikipedia_version_name="20220301.en",
             snippets_length=100,
             snippets_overlap=0,
         ),
@@ -185,7 +188,7 @@ class WikiSnippets(datasets.GeneratorBasedBuilder):
         )
 
     def _split_generators(self, dl_manager):
-
+        # WARNING: It is a bad practice to use `datasets.load_dataset` inside a loading script. Please, avoid doing it.
         wikipedia = datasets.load_dataset(
             path=self.config.wikipedia_name,
             name=self.config.wikipedia_version_name,
@@ -199,7 +202,7 @@ class WikiSnippets(datasets.GeneratorBasedBuilder):
         logger.info(f"generating examples from = {self.config.wikipedia_name} {self.config.wikipedia_version_name}")
         for split in wikipedia:
             dset = wikipedia[split]
-            split_function = _SPLIT_FUCNTION_MAP[self.config.wikipedia_name]
+            split_function = _SPLIT_FUNCTION_MAP[self.config.wikipedia_name]
             for doc in generate_snippets(
                 dset, split_function, passage_len=self.config.snippets_length, overlap=self.config.snippets_overlap
             ):