Change structure to welcome multilingual later

README.md

@@ -13,141 +13,17 @@ configs:
 - config_name: default
   data_files:
   - split: train
-    path: 20231201/*
-- config_name: "20231201"
+    path: "*/20231201/*.parquet"
+- config_name: "fr"
   data_files:
   - split: train
-    path: 20231201/*
-- config_name: "20231201.1"
+    path: "fr/20231201/*.parquet"
+- config_name: "sample"
   data_files:
   - split: train
-    path: 20231201/train-000000-of-000032.parquet
-- config_name: "20231201.2"
-  data_files:
-  - split: train
-    path: 20231201/train-000001-of-000032.parquet
-- config_name: "20231201.3"
-  data_files:
-  - split: train
-    path: 20231201/train-000002-of-000032.parquet
-- config_name: "20231201.4"
-  data_files:
-  - split: train
-    path: 20231201/train-000003-of-000032.parquet
-- config_name: "20231201.5"
-  data_files:
-  - split: train
-    path: 20231201/train-000004-of-000032.parquet
-- config_name: "20231201.6"
-  data_files:
-  - split: train
-    path: 20231201/train-000005-of-000032.parquet
-- config_name: "20231201.7"
-  data_files:
-  - split: train
-    path: 20231201/train-000006-of-000032.parquet
-- config_name: "20231201.8"
-  data_files:
-  - split: train
-    path: 20231201/train-000007-of-000032.parquet
-- config_name: "20231201.9"
-  data_files:
-  - split: train
-    path: 20231201/train-000008-of-000032.parquet
-- config_name: "20231201.10"
-  data_files:
-  - split: train
-    path: 20231201/train-000009-of-000032.parquet
-- config_name: "20231201.11"
-  data_files:
-  - split: train
-    path: 20231201/train-000010-of-000032.parquet
-- config_name: "20231201.12"
-  data_files:
-  - split: train
-    path: 20231201/train-000011-of-000032.parquet
-- config_name: "20231201.13"
-  data_files:
-  - split: train
-    path: 20231201/train-000012-of-000032.parquet
-- config_name: "20231201.14"
-  data_files:
-  - split: train
-    path: 20231201/train-000013-of-000032.parquet
-- config_name: "20231201.15"
-  data_files:
-  - split: train
-    path: 20231201/train-000014-of-000032.parquet
-- config_name: "20231201.16"
-  data_files:
-  - split: train
-    path: 20231201/train-000015-of-000032.parquet
-- config_name: "20231201.17"
-  data_files:
-  - split: train
-    path: 20231201/train-000016-of-000032.parquet
-- config_name: "20231201.18"
-  data_files:
-  - split: train
-    path: 20231201/train-000017-of-000032.parquet
-- config_name: "20231201.19"
-  data_files:
-  - split: train
-    path: 20231201/train-000018-of-000032.parquet
-- config_name: "20231201.20"
-  data_files:
-  - split: train
-    path: 20231201/train-000019-of-000032.parquet
-- config_name: "20231201.21"
-  data_files:
-  - split: train
-    path: 20231201/train-000020-of-000032.parquet
-- config_name: "20231201.22"
-  data_files:
-  - split: train
-    path: 20231201/train-000021-of-000032.parquet
-- config_name: "20231201.23"
-  data_files:
-  - split: train
-    path: 20231201/train-000022-of-000032.parquet
-- config_name: "20231201.24"
-  data_files:
-  - split: train
-    path: 20231201/train-000023-of-000032.parquet
-- config_name: "20231201.25"
-  data_files:
-  - split: train
-    path: 20231201/train-000024-of-000032.parquet
-- config_name: "20231201.26"
-  data_files:
-  - split: train
-    path: 20231201/train-000025-of-000032.parquet
-- config_name: "20231201.27"
-  data_files:
-  - split: train
-    path: 20231201/train-000026-of-000032.parquet
-- config_name: "20231201.28"
-  data_files:
-  - split: train
-    path: 20231201/train-000027-of-000032.parquet
-- config_name: "20231201.29"
-  data_files:
-  - split: train
-    path: 20231201/train-000028-of-000032.parquet
-- config_name: "20231201.30"
-  data_files:
-  - split: train
-    path: 20231201/train-000029-of-000032.parquet
-- config_name: "20231201.31"
-  data_files:
-  - split: train
-    path: 20231201/train-000030-of-000032.parquet
-- config_name: "20231201.32"
-  data_files:
-  - split: train
-    path: 20231201/train-000031-of-000032.parquet
+    path: fr/20231201/train-000000-of-000032.parquet
 dataset_info:
-- config_name: default
+- config_name: "fr"
   features:
   - name: id
     dtype: int32
@@ -163,23 +39,7 @@ dataset_info:
     num_examples: 185700
   download_size: 1934221408
   dataset_size: 3274591809
-- config_name: "20231201"
-  features:
-  - name: id
-    dtype: int32
-  - name: url
-    dtype: string
-  - name: title
-    dtype: string
-  - name: text
-    dtype: string
-  splits:
-  - name: train
-    num_bytes: 3274591809
-    num_examples: 185700
-  download_size: 1934221408
-  dataset_size: 3274591809
-- config_name: "20231201.1"
+- config_name: "sample"
   features:
   - name: id
     dtype: int32
@@ -195,526 +55,34 @@ dataset_info:
     num_examples: 5803
   download_size: 72062489
   dataset_size: 123744195
-- config_name: "20231201.2"
-  features:
-  - name: id
-    dtype: int32
-  - name: url
-    dtype: string
-  - name: title
-    dtype: string
-  - name: text
-    dtype: string
-  splits:
-  - name: train
-    num_bytes: 119833752
-    num_examples: 5803
-  download_size: 70319583
-  dataset_size: 119833752
-- config_name: "20231201.3"
-  features:
-  - name: id
-    dtype: int32
-  - name: url
-    dtype: string
-  - name: title
-    dtype: string
-  - name: text
-    dtype: string
-  splits:
-  - name: train
-    num_bytes: 93582407
-    num_examples: 5803
-  download_size: 55892756
-  dataset_size: 93582407
-- config_name: "20231201.4"
-  features:
-  - name: id
-    dtype: int32
-  - name: url
-    dtype: string
-  - name: title
-    dtype: string
-  - name: text
-    dtype: string
-  splits:
-  - name: train
-    num_bytes: 124759512
-    num_examples: 5803
-  download_size: 73918188
-  dataset_size: 124759512
-- config_name: "20231201.5"
-  features:
-  - name: id
-    dtype: int32
-  - name: url
-    dtype: string
-  - name: title
-    dtype: string
-  - name: text
-    dtype: string
-  splits:
-  - name: train
-    num_bytes: 218079383
-    num_examples: 5803
-  download_size: 128865663
-  dataset_size: 218079383
-- config_name: "20231201.6"
-  features:
-  - name: id
-    dtype: int32
-  - name: url
-    dtype: string
-  - name: title
-    dtype: string
-  - name: text
-    dtype: string
-  splits:
-  - name: train
-    num_bytes: 197089167
-    num_examples: 5803
-  download_size: 117614222
-  dataset_size: 197089167
-- config_name: "20231201.7"
-  features:
-  - name: id
-    dtype: int32
-  - name: url
-    dtype: string
-  - name: title
-    dtype: string
-  - name: text
-    dtype: string
-  splits:
-  - name: train
-    num_bytes: 172121506
-    num_examples: 5803
-  download_size: 101849830
-  dataset_size: 172121506
-- config_name: "20231201.8"
-  features:
-  - name: id
-    dtype: int32
-  - name: url
-    dtype: string
-  - name: title
-    dtype: string
-  - name: text
-    dtype: string
-  splits:
-  - name: train
-    num_bytes: 71770351
-    num_examples: 5804
-  download_size: 41996881
-  dataset_size: 71770351
-- config_name: "20231201.9"
-  features:
-  - name: id
-    dtype: int32
-  - name: url
-    dtype: string
-  - name: title
-    dtype: string
-  - name: text
-    dtype: string
-  splits:
-  - name: train
-    num_bytes: 30601898
-    num_examples: 5803
-  download_size: 17543845
-  dataset_size: 30601898
-- config_name: "20231201.10"
-  features:
-  - name: id
-    dtype: int32
-  - name: url
-    dtype: string
-  - name: title
-    dtype: string
-  - name: text
-    dtype: string
-  splits:
-  - name: train
-    num_bytes: 58803288
-    num_examples: 5803
-  download_size: 34001242
-  dataset_size: 58803288
-- config_name: "20231201.11"
-  features:
-  - name: id
-    dtype: int32
-  - name: url
-    dtype: string
-  - name: title
-    dtype: string
-  - name: text
-    dtype: string
-  splits:
-  - name: train
-    num_bytes: 71676571
-    num_examples: 5803
-  download_size: 41788737
-  dataset_size: 71676571
-- config_name: "20231201.12"
-  features:
-  - name: id
-    dtype: int32
-  - name: url
-    dtype: string
-  - name: title
-    dtype: string
-  - name: text
-    dtype: string
-  splits:
-  - name: train
-    num_bytes: 45735268
-    num_examples: 5803
-  download_size: 27148900
-  dataset_size: 45735268
-- config_name: "20231201.13"
-  features:
-  - name: id
-    dtype: int32
-  - name: url
-    dtype: string
-  - name: title
-    dtype: string
-  - name: text
-    dtype: string
-  splits:
-  - name: train
-    num_bytes: 7126062
-    num_examples: 5803
-  download_size: 3781314
-  dataset_size: 7126062
-- config_name: "20231201.14"
-  features:
-  - name: id
-    dtype: int32
-  - name: url
-    dtype: string
-  - name: title
-    dtype: string
-  - name: text
-    dtype: string
-  splits:
-  - name: train
-    num_bytes: 75934552
-    num_examples: 5803
-  download_size: 45174223
-  dataset_size: 75934552
-- config_name: "20231201.15"
-  features:
-  - name: id
-    dtype: int32
-  - name: url
-    dtype: string
-  - name: title
-    dtype: string
-  - name: text
-    dtype: string
-  splits:
-  - name: train
-    num_bytes: 54804531
-    num_examples: 5803
-  download_size: 32015256
-  dataset_size: 54804531
-- config_name: "20231201.16"
-  features:
-  - name: id
-    dtype: int32
-  - name: url
-    dtype: string
-  - name: title
-    dtype: string
-  - name: text
-    dtype: string
-  splits:
-  - name: train
-    num_bytes: 47038257
-    num_examples: 5804
-  download_size: 27079806
-  dataset_size: 47038257
-- config_name: "20231201.17"
-  features:
-  - name: id
-    dtype: int32
-  - name: url
-    dtype: string
-  - name: title
-    dtype: string
-  - name: text
-    dtype: string
-  splits:
-  - name: train
-    num_bytes: 17238640
-    num_examples: 5803
-  download_size: 9591913
-  dataset_size: 17238640
-- config_name: "20231201.18"
-  features:
-  - name: id
-    dtype: int32
-  - name: url
-    dtype: string
-  - name: title
-    dtype: string
-  - name: text
-    dtype: string
-  splits:
-  - name: train
-    num_bytes: 21555517
-    num_examples: 5803
-  download_size: 12201505
-  dataset_size: 21555517
-- config_name: "20231201.19"
-  features:
-  - name: id
-    dtype: int32
-  - name: url
-    dtype: string
-  - name: title
-    dtype: string
-  - name: text
-    dtype: string
-  splits:
-  - name: train
-    num_bytes: 164356206
-    num_examples: 5803
-  download_size: 97744374
-  dataset_size: 164356206
-- config_name: "20231201.20"
-  features:
-  - name: id
-    dtype: int32
-  - name: url
-    dtype: string
-  - name: title
-    dtype: string
-  - name: text
-    dtype: string
-  splits:
-  - name: train
-    num_bytes: 117646153
-    num_examples: 5803
-  download_size: 69196996
-  dataset_size: 117646153
-- config_name: "20231201.21"
-  features:
-  - name: id
-    dtype: int32
-  - name: url
-    dtype: string
-  - name: title
-    dtype: string
-  - name: text
-    dtype: string
-  splits:
-  - name: train
-    num_bytes: 107979780
-    num_examples: 5803
-  download_size: 63973234
-  dataset_size: 107979780
-- config_name: "20231201.22"
-  features:
-  - name: id
-    dtype: int32
-  - name: url
-    dtype: string
-  - name: title
-    dtype: string
-  - name: text
-    dtype: string
-  splits:
-  - name: train
-    num_bytes: 93351648
-    num_examples: 5803
-  download_size: 56467747
-  dataset_size: 93351648
-- config_name: "20231201.23"
-  features:
-  - name: id
-    dtype: int32
-  - name: url
-    dtype: string
-  - name: title
-    dtype: string
-  - name: text
-    dtype: string
-  splits:
-  - name: train
-    num_bytes: 114682668
-    num_examples: 5803
-  download_size: 68014456
-  dataset_size: 114682668
-- config_name: "20231201.24"
-  features:
-  - name: id
-    dtype: int32
-  - name: url
-    dtype: string
-  - name: title
-    dtype: string
-  - name: text
-    dtype: string
-  splits:
-  - name: train
-    num_bytes: 132681023
-    num_examples: 5804
-  download_size: 78343213
-  dataset_size: 132681023
-- config_name: "20231201.25"
-  features:
-  - name: id
-    dtype: int32
-  - name: url
-    dtype: string
-  - name: title
-    dtype: string
-  - name: text
-    dtype: string
-  splits:
-  - name: train
-    num_bytes: 125230246
-    num_examples: 5803
-  download_size: 74704686
-  dataset_size: 125230246
-- config_name: "20231201.26"
-  features:
-  - name: id
-    dtype: int32
-  - name: url
-    dtype: string
-  - name: title
-    dtype: string
-  - name: text
-    dtype: string
-  splits:
-  - name: train
-    num_bytes: 161933469
-    num_examples: 5803
-  download_size: 96923641
-  dataset_size: 161933469
-- config_name: "20231201.27"
-  features:
-  - name: id
-    dtype: int32
-  - name: url
-    dtype: string
-  - name: title
-    dtype: string
-  - name: text
-    dtype: string
-  splits:
-  - name: train
-    num_bytes: 109190839
-    num_examples: 5803
-  download_size: 63826178
-  dataset_size: 109190839
-- config_name: "20231201.28"
-  features:
-  - name: id
-    dtype: int32
-  - name: url
-    dtype: string
-  - name: title
-    dtype: string
-  - name: text
-    dtype: string
-  splits:
-  - name: train
-    num_bytes: 136475044
-    num_examples: 5803
-  download_size: 80171778
-  dataset_size: 136475044
-- config_name: "20231201.29"
-  features:
-  - name: id
-    dtype: int32
-  - name: url
-    dtype: string
-  - name: title
-    dtype: string
-  - name: text
-    dtype: string
-  splits:
-  - name: train
-    num_bytes: 100890887
-    num_examples: 5803
-  download_size: 58706853
-  dataset_size: 100890887
-- config_name: "20231201.30"
-  features:
-  - name: id
-    dtype: int32
-  - name: url
-    dtype: string
-  - name: title
-    dtype: string
-  - name: text
-    dtype: string
-  splits:
-  - name: train
-    num_bytes: 117519331
-    num_examples: 5803
-  download_size: 69592253
-  dataset_size: 117519331
-- config_name: "20231201.31"
-  features:
-  - name: id
-    dtype: int32
-  - name: url
-    dtype: string
-  - name: title
-    dtype: string
-  - name: text
-    dtype: string
-  splits:
-  - name: train
-    num_bytes: 172796729
-    num_examples: 5803
-  download_size: 103593983
-  dataset_size: 172796729
-- config_name: "20231201.32"
-  features:
-  - name: id
-    dtype: int32
-  - name: url
-    dtype: string
-  - name: title
-    dtype: string
-  - name: text
-    dtype: string
-  splits:
-  - name: train
-    num_bytes: 68362929
-    num_examples: 5804
-  download_size: 40115663
-  dataset_size: 68362929
 ---
 
-# Plain text of French Wikisource
-                
-This dataset was created by [OpenLLM France](https://openllmfrance.org/) from the [Wikisource dumps](https://dumps.wikimedia.org/other/enterprise_html/runs).
-
-It is a plain text version of pages from [fr.wikisource.org/wiki](https://fr.wikisource.org/wiki)
-without HTML tags nor wiki templates.              
-The text just includes markdown syntax for headers, lists and tables.
-See [Notes on data formatting](#notes-on-data-formatting) for more details.
+# Plain text of Wikisource
                 
-* [Statistics](#statistics)
-* [Example use (python)](#example-use-python)
-* [Data fields](#data-fields)
-* [Notes on data formatting](#notes-on-data-formatting)
+* [Dataset Description](#dataset-description)
+  * [Size](#size)
+  * [Example use (python)](#example-use-python)
+  * [Data fields](#data-fields)
+  * [Notes on data formatting](#notes-on-data-formatting)
 * [License](#license)
 * [Aknowledgements](#aknowledgements)
 * [Citation](#citation)
 
+## Dataset Description
+
+This dataset is a plain text version of pages from [wikisource.org](https://wikisource.org/) in French language.
+The text is without HTML tags nor wiki templates.
+It just includes markdown syntax for headers, lists and tables.
+See [Notes on data formatting](#notes-on-data-formatting) for more details.
+
+It was created by [LINAGORA](https://labs.linagora.com/) and [OpenLLM France](https://openllmfrance.org/)
+from the [Wikimedia dumps](https://dumps.wikimedia.org/other/enterprise_html/runs),
+using code in [https://github.com/OpenLLM-France/wikiplaintext](https://github.com/OpenLLM-France/wikiplaintext).
                 
-## Statistics
+### Size
                 
 The amount of data for the latest dump (20231201) is:
-| **Unit**        | **Size** |
+|                 | **French** |
 | :---------------|--------: |
 | # documents     |   185 700 |
 | # paragraphs    |   585 700 |
@@ -731,30 +99,25 @@ Load the full dataset:
 ```python
 import datasets
 
-ds = datasets.load_dataset("OpenLLM-France/wikisource.fr")
+ds = datasets.load_dataset("OpenLLM-France/wikisource", streaming=True, split="train")
 ```
 
 Load only a small subset:
 ```python
-import datasets
-
-i = 1 # Can be a number between 1 and 32
-subset = f"20231201.{i}"
-
-ds = datasets.load_dataset("OpenLLM-France/wikisource.fr", subset)
+ds = datasets.load_dataset("OpenLLM-France/wikisource", "sample", split="train")
 ```
 
 ## Data fields
 
 The data fields are the same among all configurations:
-- `id` (int): ID of the article.
-- `url` (`str`): URL of the article.
-- `title` (`str`): Title of the article.
-- `text` (`str`): Text content of the article.
+- `id` (int): ID of the page.
+- `url` (`str`): URL of the page.
+- `title` (`str`): Title of the page.
+- `text` (`str`): Text content of the page.
 
 ## Notes on data formatting
 
-see [OpenLLM-France/wikipedia.fr](https://huggingface.co/datasets/OpenLLM-France/wikipedia.fr)
+see [OpenLLM-France/wikipedia.fr](https://huggingface.co/datasets/OpenLLM-France/wikipedia)
 
 ## License
 
@@ -762,7 +125,9 @@ This dataset is distributed under the [Creative Commons Attribution-ShareAlike 4
 
 ## Aknowledgements
 
-This dataset was created by [Jérôme Louradour](https://huggingface.co/Jeronymous) on behalf of [OpenLLM France](https://openllmfrance.org/).
+This dataset was created by [Jérôme Louradour](https://huggingface.co/Jeronymous) on behalf of
+[LINAGORA](https://labs.linagora.com/) and
+[OpenLLM France](https://openllmfrance.org/).
 
 Many thanks to the [Wikimedia Foundation](https://wikimediafoundation.org/)
 for providing the data and useful advices,
@@ -772,9 +137,9 @@ in particular Isaac Johnson, Albert Villanova and Rémy Gerbet.
 
 ```
 @online{wikisource_fr_dump,
-    author = "OpenLLM France",
-    title  = "Plain text of French Wikisource",
-    url    = "https://huggingface.co/datasets/OpenLLM-France/wikisource.fr"
+    author = "Jérôme Louradour, OpenLLM-France, LINAGORA Labs",
+    title  = "Plain text of Wikisource",
+    url    = "https://huggingface.co/datasets/OpenLLM-France/wikisource"
 }
 ```