Create README.md

README.md

@@ -0,0 +1,779 @@
+---
+annotations_creators:
+- no-annotation
+language_creators:
+- crowdsourced
+pretty_name: Wikipedia
+paperswithcode_id: null
+license:
+- cc-by-sa-3.0
+- gfdl
+task_categories:
+- text-generation
+- fill-mask
+task_ids:
+- language-modeling
+- masked-language-modeling
+source_datasets:
+- original
+multilinguality:
+- multilingual
+size_categories:
+- n<1K
+- 1K<n<10K
+- 10K<n<100K
+- 100K<n<1M
+- 1M<n<10M
+language:
+- aa
+- ab
+- ace
+- af
+- ak
+- als
+- am
+- an
+- ang
+- ar
+- arc
+- arz
+- as
+- ast
+- atj
+- av
+- ay
+- az
+- azb
+- ba
+- bar
+- bcl
+- be
+- bg
+- bh
+- bi
+- bjn
+- bm
+- bn
+- bo
+- bpy
+- br
+- bs
+- bug
+- bxr
+- ca
+- cbk
+- cdo
+- ce
+- ceb
+- ch
+- cho
+- chr
+- chy
+- ckb
+- co
+- cr
+- crh
+- cs
+- csb
+- cu
+- cv
+- cy
+- da
+- de
+- din
+- diq
+- dsb
+- dty
+- dv
+- dz
+- ee
+- el
+- eml
+- en
+- eo
+- es
+- et
+- eu
+- ext
+- fa
+- ff
+- fi
+- fj
+- fo
+- fr
+- frp
+- frr
+- fur
+- fy
+- ga
+- gag
+- gan
+- gd
+- gl
+- glk
+- gn
+- gom
+- gor
+- got
+- gu
+- gv
+- ha
+- hak
+- haw
+- he
+- hi
+- hif
+- ho
+- hr
+- hsb
+- ht
+- hu
+- hy
+- ia
+- id
+- ie
+- ig
+- ii
+- ik
+- ilo
+- inh
+- io
+- is
+- it
+- iu
+- ja
+- jam
+- jbo
+- jv
+- ka
+- kaa
+- kab
+- kbd
+- kbp
+- kg
+- ki
+- kj
+- kk
+- kl
+- km
+- kn
+- ko
+- koi
+- krc
+- ks
+- ksh
+- ku
+- kv
+- kw
+- ky
+- la
+- lad
+- lb
+- lbe
+- lez
+- lfn
+- lg
+- li
+- lij
+- lmo
+- ln
+- lo
+- lrc
+- lt
+- ltg
+- lv
+- lzh
+- mai
+- mdf
+- mg
+- mh
+- mhr
+- mi
+- min
+- mk
+- ml
+- mn
+- mr
+- mrj
+- ms
+- mt
+- mus
+- mwl
+- my
+- myv
+- mzn
+- na
+- nah
+- nan
+- nap
+- nds
+- ne
+- new
+- ng
+- nl
+- nn
+- 'no'
+- nov
+- nrf
+- nso
+- nv
+- ny
+- oc
+- olo
+- om
+- or
+- os
+- pa
+- pag
+- pam
+- pap
+- pcd
+- pdc
+- pfl
+- pi
+- pih
+- pl
+- pms
+- pnb
+- pnt
+- ps
+- pt
+- qu
+- rm
+- rmy
+- rn
+- ro
+- ru
+- rue
+- rup
+- rw
+- sa
+- sah
+- sat
+- sc
+- scn
+- sco
+- sd
+- se
+- sg
+- sgs
+- sh
+- si
+- sk
+- sl
+- sm
+- sn
+- so
+- sq
+- sr
+- srn
+- ss
+- st
+- stq
+- su
+- sv
+- sw
+- szl
+- ta
+- tcy
+- tdt
+- te
+- tg
+- th
+- ti
+- tk
+- tl
+- tn
+- to
+- tpi
+- tr
+- ts
+- tt
+- tum
+- tw
+- ty
+- tyv
+- udm
+- ug
+- uk
+- ur
+- uz
+- ve
+- vec
+- vep
+- vi
+- vls
+- vo
+- vro
+- wa
+- war
+- wo
+- wuu
+- xal
+- xh
+- xmf
+- yi
+- yo
+- yue
+- za
+- zea
+- zh
+- zu
+language_bcp47:
+- nds-nl
+config_names:
+- 20240101.aa
+- 20220101.ab
+- 20240101.ace
+- 20240101.ady
+- 20240101.af
+- 20240101.ak
+- 20240101.als
+- 20240101.am
+- 20240101.an
+- 20240101.ang
+- 20240101.ar
+- 20240101.arc
+- 20240101.arz
+- 20240101.as
+- 20240101.ast
+- 20240101.atj
+- 20240101.av
+- 20240101.ay
+- 20240101.az
+- 20240101.azb
+- 20240101.ba
+- 20240101.bar
+- 20240101.bat-smg
+- 20240101.bcl
+- 20240101.be
+- 20240101.be-x-old
+- 20240101.bg
+- 20240101.bh
+- 20240101.bi
+- 20240101.bjn
+- 20240101.bm
+- 20240101.bn
+- 20240101.bo
+- 20240101.bpy
+- 20240101.br
+- 20240101.bs
+- 20240101.bug
+- 20240101.bxr
+- 20240101.ca
+- 20240101.cbk-zam
+- 20240101.cdo
+- 20240101.ce
+- 20240101.ceb
+- 20240101.ch
+- 20240101.cho
+- 20240101.chr
+- 20240101.chy
+- 20240101.ckb
+- 20240101.co
+- 20240101.cr
+- 20240101.crh
+- 20240101.cs
+- 20240101.csb
+- 20240101.cu
+- 20240101.cv
+- 20240101.cy
+- 20240101.da
+- 20240101.de
+- 20240101.din
+- 20240101.diq
+- 20240101.dsb
+- 20240101.dty
+- 20240101.dv
+- 20240101.dz
+- 20240101.ee
+- 20240101.el
+- 20240101.eml
+- 20240101.en
+- 20240101.eo
+- 20240101.es
+- 20240101.et
+- 20240101.eu
+- 20240101.ext
+- 20240101.fa
+- 20240101.ff
+- 20240101.fi
+- 20240101.fiu-vro
+- 20240101.fj
+- 20240101.fo
+- 20240101.fr
+- 20240101.frp
+- 20240101.frr
+- 20240101.fur
+- 20240101.fy
+- 20240101.ga
+- 20240101.gag
+- 20240101.gan
+- 20240101.gd
+- 20240101.gl
+- 20240101.glk
+- 20240101.gn
+- 20240101.gom
+- 20240101.gor
+- 20240101.got
+- 20240101.gu
+- 20240101.gv
+- 20240101.ha
+- 20240101.hak
+- 20240101.haw
+- 20240101.he
+- 20240101.hi
+- 20240101.hif
+- 20240101.ho
+- 20240101.hr
+- 20240101.hsb
+- 20240101.ht
+- 20240101.hu
+- 20240101.hy
+- 20240101.ia
+- 20240101.id
+- 20240101.ie
+- 20240101.ig
+- 20240101.ii
+- 20240101.ik
+- 20240101.ilo
+- 20240101.inh
+- 20240101.io
+- 20240101.is
+- 20240101.it
+- 20240101.iu
+- 20240101.ja
+- 20240101.jam
+- 20240101.jbo
+- 20240101.jv
+- 20240101.ka
+- 20240101.kaa
+- 20240101.kab
+- 20240101.kbd
+- 20240101.kbp
+- 20240101.kg
+- 20240101.ki
+- 20240101.kj
+- 20240101.kk
+- 20240101.kl
+- 20240101.km
+- 20240101.kn
+- 20240101.ko
+- 20240101.koi
+- 20240101.krc
+- 20240101.ks
+- 20240101.ksh
+- 20240101.ku
+- 20240101.kv
+- 20240101.kw
+- 20240101.ky
+- 20240101.la
+- 20240101.lad
+- 20240101.lb
+- 20240101.lbe
+- 20240101.lez
+- 20240101.lfn
+- 20240101.lg
+- 20240101.li
+- 20240101.lij
+- 20240101.lmo
+- 20240101.ln
+- 20240101.lo
+- 20240101.lrc
+- 20240101.lt
+- 20240101.ltg
+- 20240101.lv
+- 20240101.mai
+- 20240101.map-bms
+- 20240101.mdf
+- 20240101.mg
+- 20240101.mh
+- 20240101.mhr
+- 20240101.mi
+- 20240101.min
+- 20240101.mk
+- 20240101.ml
+- 20240101.mn
+- 20240101.mr
+- 20240101.mrj
+- 20240101.ms
+- 20240101.mt
+- 20240101.mus
+- 20240101.mwl
+- 20240101.my
+- 20240101.myv
+- 20240101.mzn
+- 20240101.na
+- 20240101.nah
+- 20240101.nap
+- 20240101.nds
+- 20240101.nds-nl
+- 20240101.ne
+- 20240101.new
+- 20240101.ng
+- 20240101.nl
+- 20240101.nn
+- 20240101.no
+- 20240101.nov
+- 20240101.nrm
+- 20240101.nso
+- 20240101.nv
+- 20240101.ny
+- 20240101.oc
+- 20240101.olo
+- 20240101.om
+- 20240101.or
+- 20240101.os
+- 20240101.pa
+- 20240101.pag
+- 20240101.pam
+- 20240101.pap
+- 20240101.pcd
+- 20240101.pdc
+- 20240101.pfl
+- 20240101.pi
+- 20240101.pih
+- 20240101.pl
+- 20240101.pms
+- 20240101.pnb
+- 20240101.pnt
+- 20240101.ps
+- 20240101.pt
+- 20240101.qu
+- 20240101.rm
+- 20240101.rmy
+- 20240101.rn
+- 20240101.ro
+- 20240101.roa-rup
+- 20240101.roa-tara
+- 20240101.ru
+- 20240101.rue
+- 20240101.rw
+- 20240101.sa
+- 20240101.sah
+- 20240101.sat
+- 20240101.sc
+- 20240101.scn
+- 20240101.sco
+- 20240101.sd
+- 20240101.se
+- 20240101.sg
+- 20240101.sh
+- 20240101.si
+- 20240101.simple
+- 20240101.sk
+- 20240101.sl
+- 20240101.sm
+- 20240101.sn
+- 20240101.so
+- 20240101.sq
+- 20240101.sr
+- 20240101.srn
+- 20240101.ss
+- 20240101.st
+- 20240101.stq
+- 20240101.su
+- 20240101.sv
+- 20240101.sw
+- 20240101.szl
+- 20240101.ta
+- 20240101.tcy
+- 20240101.te
+- 20240101.tet
+- 20240101.tg
+- 20240101.th
+- 20240101.ti
+- 20240101.tk
+- 20240101.tl
+- 20240101.tn
+- 20240101.to
+- 20240101.tpi
+- 20240101.tr
+- 20240101.ts
+- 20240101.tt
+- 20240101.tum
+- 20240101.tw
+- 20240101.ty
+- 20240101.tyv
+- 20240101.udm
+- 20240101.ug
+- 20240101.uk
+- 20240101.ur
+- 20240101.uz
+- 20240101.ve
+- 20240101.vec
+- 20240101.vep
+- 20240101.vi
+- 20240101.vls
+- 20240101.vo
+- 20240101.wa
+- 20240101.war
+- 20240101.wo
+- 20240101.wuu
+- 20240101.xal
+- 20240101.xh
+- 20240101.xmf
+- 20240101.yi
+- 20240101.yo
+- 20240101.za
+- 20240101.zea
+- 20240101.zh
+- 20240101.zh-classical
+- 20240101.zh-min-nan
+- 20240101.zh-yue
+- 20240101.zu
+---
+
+# Dataset Card for Wikipedia
+
+This repo is a fork of the [olm/wikipedia](https://huggingface.co/datasets/olm/wikipedia) repo which itself is a fork of the original Hugging Face Wikipedia repo [here](https://huggingface.co/datasets/wikipedia).
+
+This fork modifies `olm/wikipedia` to enable running on lower resourced machines. These changes have been proposed as a [PR with the olm/wikipedia project](https://huggingface.co/datasets/olm/wikipedia/discussions/6).
+
+## 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://dumps.wikimedia.org](https://dumps.wikimedia.org)
+- **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)
+
+### Dataset Summary
+
+Wikipedia dataset containing cleaned articles of all languages. The datasets are built from the Wikipedia dump (https://dumps.wikimedia.org/) with one split per language. Each example contains the content of one full Wikipedia article with cleaning to strip markdown and unwanted sections (references, etc.).
+
+The articles are parsed using the ``mwparserfromhell`` tool.
+
+To load this dataset you need to install the following dependencies:
+
+```
+pip install mwparserfromhell datasets
+```
+
+Then, you can load any subset of Wikipedia per language and per date this way:
+
+```python
+from datasets import load_dataset
+
+load_dataset("neuml/wikipedia", language="en", date="20240101")
+```
+
+You can find the full list of languages and dates [here](https://dumps.wikimedia.org/backup-index.html).
+
+### Supported Tasks and Leaderboards
+
+The dataset is generally used for Language Modeling.
+
+### Languages
+
+You can find the list of languages [here](https://meta.wikimedia.org/wiki/List_of_Wikipedias).
+
+## Dataset Structure
+
+### Data Instances
+
+An example looks as follows:
+
+```
+{'id': '1',
+ 'url': 'https://simple.wikipedia.org/wiki/April',
+ 'title': 'April',
+ 'text': 'April is the fourth month...'
+}
+```
+
+### Data Fields
+
+The data fields are the same among all configurations:
+
+- `id` (`str`): ID of the article.
+- `url` (`str`): URL of the article.
+- `title` (`str`): Title of the article.
+- `text` (`str`): Text content of the article.
+
+### Curation Rationale
+
+[More Information Needed](https://github.com/huggingface/datasets/blob/master/CONTRIBUTING.md#how-to-contribute-to-the-dataset-cards)
+
+### Source Data
+
+#### Initial Data Collection and Normalization
+
+[More Information Needed](https://github.com/huggingface/datasets/blob/master/CONTRIBUTING.md#how-to-contribute-to-the-dataset-cards)
+
+#### Who are the source language producers?
+
+[More Information Needed](https://github.com/huggingface/datasets/blob/master/CONTRIBUTING.md#how-to-contribute-to-the-dataset-cards)
+
+### Annotations
+
+#### Annotation process
+
+[More Information Needed](https://github.com/huggingface/datasets/blob/master/CONTRIBUTING.md#how-to-contribute-to-the-dataset-cards)
+
+#### Who are the annotators?
+
+[More Information Needed](https://github.com/huggingface/datasets/blob/master/CONTRIBUTING.md#how-to-contribute-to-the-dataset-cards)
+
+### Personal and Sensitive Information
+
+[More Information Needed](https://github.com/huggingface/datasets/blob/master/CONTRIBUTING.md#how-to-contribute-to-the-dataset-cards)
+
+## Considerations for Using the Data
+
+### Social Impact of Dataset
+
+[More Information Needed](https://github.com/huggingface/datasets/blob/master/CONTRIBUTING.md#how-to-contribute-to-the-dataset-cards)
+
+### Discussion of Biases
+
+[More Information Needed](https://github.com/huggingface/datasets/blob/master/CONTRIBUTING.md#how-to-contribute-to-the-dataset-cards)
+
+### Other Known Limitations
+
+[More Information Needed](https://github.com/huggingface/datasets/blob/master/CONTRIBUTING.md#how-to-contribute-to-the-dataset-cards)
+
+## Additional Information
+
+### Dataset Curators
+
+[More Information Needed](https://github.com/huggingface/datasets/blob/master/CONTRIBUTING.md#how-to-contribute-to-the-dataset-cards)
+
+### Licensing Information
+
+Most of Wikipedia's text and many of its images are co-licensed under the [Creative Commons Attribution-ShareAlike 3.0 Unported License](https://en.wikipedia.org/wiki/Wikipedia:Text_of_Creative_Commons_Attribution-ShareAlike_3.0_Unported_License)(CC BY-SA) and the [GNU Free Documentation License](https://en.wikipedia.org/wiki/Wikipedia:Text_of_the_GNU_Free_Documentation_License)(GFDL) (unversioned, with no invariant sections, front-cover texts, or back-cover texts). 
+
+Some text has been imported only under CC BY-SA and CC BY-SA-compatible license and cannot be reused under GFDL; such text will be identified on the page footer, in the page history, or on the discussion page of the article that utilizes the text.
+
+### Citation Information
+
+```
+@ONLINE{wikidump,
+    author = "Wikimedia Foundation",
+    title  = "Wikimedia Downloads",
+    url    = "https://dumps.wikimedia.org"
+}
+```