Create README.md

README.md

@@ -0,0 +1,126 @@
+---
+annotations_creators:
+  - no-annotation
+language_creators:
+  - crowdsourced
+license:
+  - cc-by-sa-3.0
+task_categories:
+  - text-generation
+  - fill-mask
+task_ids:
+  - language-modeling
+  - masked-language-modeling
+source_datasets:
+  - original
+language:
+  - en
+  - es
+  - fr
+  - ja
+  - ko
+  - pt
+  - ru
+  - zho
+configs:
+  - config_name: default
+    data_files:
+    - split: conversational
+      path: data/*_convo.jsonl.gz
+    - split: QA
+      path: data/*_qa.jsonl.gz
+pretty_name: MDN
+---
+
+# Dataset Card for MDN
+
+<!-- TODO: Waifu-->
+
+*Waifu to catch your attention.*
+
+### Dataset Description
+
+*MDN* is a **~1.15 M** Tokens (llama-2-7b-chat-tokenizer) / **~999.32K** Tokens (RWKV Tokenizer) scrape of [MDN (Developer.mozilla.org)](https://developer.mozilla.org/).
+It serves as a training resource for large language models and other NLP tasks. 
+This card details the dataset's origin, content, and limitations.
+
+
+- **Curated by:** KaraKaraWitch
+- **Funded by [optional]:** Recursal.ai (I work there lol)
+- **Shared by [optional]:** KaraKaraWitch
+- **Language(s) (NLP):** English, Espanol, French, Japanese, Korean, Brazilian Portuguese, Russian, Chinese Simplified, Chinese Traditional
+- **License:** cc-by-sa-2.5
+
+MDN was created under time constraints for the release of [EagleX v1](https://huggingface.co/recursal/EagleX_1-7T_HF), and may contain biases in selection.  
+
+### Supported Tasks and Leaderboards
+
+Primarily used for language modeling.
+
+### Languages
+
+MDN lists the following languages:
+
+- English
+- Espanol
+- French
+- Japanese
+- Korean
+- Brazilian Portuguese
+- Russian
+- Chinese Simplified
+- Chinese Traditional
+
+### Processing
+
+We obtained a list of pages to download with the MDN's [sitemap.xml.](https://developer.mozilla.org/sitemap.xml) This was manually downloaded. For each sitemap, we scrape the website. saving the raw html responses for further filtering and cleaning.
+
+For the actual html processing, we recommend reading the code found in the file: `MDNClean.py`.
+
+The file itself is a typer application with the following commands:
+
+```
+- sitemap
+  - Gets a list of urls to download and downloads it to a folder.
+- clean
+  - cleans a folder. saving each the cleaned text to a final jsonl.
+```
+
+### Data Instances
+
+Refer to this sample to see all the relavant fields.
+
+```json
+{
+    "title": "Game development",
+    "text": "\n\nGame development\n================\n\nGaming is one of the most popular computer activities. New technologies are constantly arriving to make\n it possible to develop better and more powerful games that can be run in any standards-compliant web\n browser.\n\nDevelop web games\n-----------------\n\nWelcome to the MDN game development center! In this area of the site, we provide resources for web<...TRUNCATED>"
+}
+```
+
+The format has the following keys:
+
+```md
+- "title" (str) [The title of the article]
+- "text" (str) [The html content converted fro html into markdown.]
+```
+
+### Dataset Curators
+
+KaraKaraWitch. (I typically hang out in PygmalionAI discord, sometimes EleutherAI. If something is wrong, `@karakarawitch` on discord.)
+
+I'd be happy if you could spread the word and recommend this dataset.
+
+### Licensing Information
+
+MDN lists their license as [CC-BY-SA.](https://developer.mozilla.org/en-US/docs/MDN/Writing_guidelines/Attrib_copyright_license)
+
+### Citation Information
+
+```
+@misc{MDN,
+  title         = {MDN},
+  author        = {KaraKaraWitch, recursal.ai},
+  year          = {2023},
+  howpublished  = {\url{https://huggingface.co/datasets/recursal/MDN}},
+}
+```