Update README.md

README.md

@@ -1,3 +1,84 @@
 ---
-license: cc-by-sa-4.0
+pretty_name: ScandiRedditFiltered
+language:
+- da
+license:
+- cc-by-4.0
+size_categories:
+- 1K<n<10K
+task_categories:
+- text-generation
+- fill-mask
+task_ids:
+- language-modeling
 ---
+
+# Dataset Card for ScandiRedditFiltered
+
+## Dataset Description
+
+- **Repository:** <https://github.com/alexandrainst/ScandiReddit>
+- **Point of Contact:** [Anders Jess Pedersen](mailto:anders.j.pedersen@alexandra.dk)
+
+
+### Dataset Summary
+
+ScandiRedditFiltered is manually filtered and post-processed corpus consisting of comments from [ScandiReddit](https://huggingface.co/datasets/alexandrainst/scandi-reddit).
+The intended use of the filtered sentences is for Text-To-Speech (TTS) models.
+
+### 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`).
+
+
+## Dataset Structure
+
+### Data Instances
+
+An example from the dataset looks as follows.
+```
+{
+    'sentence': 'Bergen er ødelagt. Det er ikke moro mer.',
+    'username': 'alexandra_0',
+    'keep': 'y',
+    'index': 2
+}
+```
+
+### Data Fields
+
+The data fields are the same among all splits.
+
+- `sentence`: a `string` feature.
+- `username`: a `string` feature.
+- `keep`: a `string` feature.
+- `index`: a `int` feature.
+
+
+## Dataset Creation
+
+### Curation Rationale
+
+The Scandinavian languages do not have any open source social media TTS datasets.
+
+### Source Data
+
+The raw Reddit data was collected through [PushShift](https://files.pushshift.io/reddit/comments/).
+
+
+## Additional Information
+
+### Dataset Curators
+
+[Anders Jess Pedersen](mailto:anders.j.pedersen@alexandra.dk) 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/).