Update README.md

README.md

@@ -1,21 +1,129 @@
 ---
-dataset_info:
-  features:
-  - name: doc
-    dtype: string
-  - name: subreddit
-    dtype: string
-  - name: language
-    dtype: string
-  - name: language_confidence
-    dtype: float64
-  splits:
-  - name: train
-    num_bytes: 3763131485
-    num_examples: 13481537
-  download_size: 2341424578
-  dataset_size: 3763131485
+pretty_name: ScandiReddit
+language:
+- da
+- sv
+- no
+- is
+license:
+- cc-by-4.0
+multilinguality:
+- multilingual
+size_categories:
+- 10M<n<100M
+task_categories:
+- text-generation
+- fill-mask
+task_ids:
+- language-modeling
 ---
-# Dataset Card for "scandi-reddit"
 
-[More Information needed](https://github.com/huggingface/datasets/blob/main/CONTRIBUTING.md#how-to-contribute-to-the-dataset-cards)
+# Dataset Card for ScandiReddit
+
+## Dataset Description
+
+- **Repository:** <https://github.com/alexandrainst/ScandiReddit>
+- **Point of Contact:** [Dan Saattrup Nielsen](mailto:dan.nielsen@alexandra.dk)
+- **Size of downloaded dataset files:** 2341 MB
+- **Size of the generated dataset:** 3594 MB
+- **Total amount of disk used:** 5935 MB
+
+### Dataset Summary
+
+ScandiReddit is...
+
+
+### Supported Tasks and Leaderboards
+
+Training language models is the intended task for this dataset. No leaderboard is active at this point.
+
+
+### Languages
+
+The dataset is available in Danish (`da`), Swedish (`sv`), Norwegian (`no`) and Icelandic (`is`).
+
+
+## Dataset Structure
+
+### Data Instances
+
+- **Size of downloaded dataset files:** 2341 MB
+- **Size of the generated dataset:** 3594 MB
+- **Total amount of disk used:** 5935 MB
+
+An example from the dataset looks as follows.
+```
+{
+    'doc': 'Bergen er ødelagt. Det er ikke moro mer.',
+    'subreddit': 'Norway',
+    'language': 'da',
+    'language_confidence': 0.7472341656684875}
+}
+```
+
+### Data Fields
+
+The data fields are the same among all splits.
+
+- `doc`: a `string` feature.
+- `subreddit`: a `string` feature.
+- `language`: a `string` feature.
+- `language_confidence`: a `float64` feature.
+
+### Language Distribution
+
+|   name   |  count  |
+|----------|--------:|
+| sv       | 6967420 |
+| sv       | 4965195 |
+| no       | 1340470 |
+| is       | 206689  |
+
+### Top-20 Subreddit Distribution
+
+|   name   |  count  |
+|----------|--------:|
+|sweden                |4881483|
+|Denmark               |3579178|
+|norge                 |1281655|
+|svenskpolitik         | 771960|
+|InfluencergossipDK    | 649910|
+|swedishproblems       | 339683|
+|Iceland               | 183488|
+|dkfinance             | 113860|
+|unket                 |  81077|
+|DanishEnts            |  69055|
+|dankmark              |  62928|
+|swedents              |  58576|
+|scandinavia           |  57136|
+|Allsvenskan           |  56006|
+|Gothenburg            |  54395|
+|stockholm             |  51016|
+|ISKbets               |  47944|
+|Sverige               |  39552|
+|SWARJE                |  34691|
+|GossipDK              |  29332|
+
+
+## Dataset Creation
+
+### Curation Rationale
+
+The Scandinavian languages do not have many open source social media datasets.
+
+### Source Data
+
+The raw Reddit data was collected through [PushShift](https://files.pushshift.io/reddit/comments/).
+
+
+## Additional Information
+
+### Dataset Curators
+
+[Dan Saattrup Nielsen](https://saattrupdan.github.io/) from the [The Alexandra
+Institute](https://alexandra.dk/) curated this dataset.
+
+### Licensing Information
+
+The dataset is licensed under the [CC BY 4.0
+license](https://creativecommons.org/licenses/by/4.0/).