Update README.md

README.md

@@ -1,25 +1,25 @@
 ---
 annotations_creators:
-- no-annotation
+  - no-annotation
 language_creators:
-- crowdsourced
+  - crowdsourced
 license:
-- cc-by-sa-3.0
+  - cc-by-sa-3.0
 task_categories:
-- text-generation
-- fill-mask
+  - text-generation
+  - fill-mask
 task_ids:
-- language-modeling
-- masked-language-modeling
+  - language-modeling
+  - masked-language-modeling
 source_datasets:
-- original
+  - original
 language:
-- en
+  - en
 configs:
-- config_name: default
-  data_files:
-  - split: final
-    path: jsonl/*.jsonl
+  - config_name: default
+    data_files:
+    - split: final
+      path: jsonl/*.jsonl
 pretty_name: SCP-RECURSAL
 ---
 
@@ -27,21 +27,23 @@ pretty_name: SCP-RECURSAL
 
 ---
 
+![](SCP-Tan.png "A researcher wearing a white lab coat within recursal looking though the documents collectively known as SCP-Recursal.")
+
 **Item ID:** SCP-RECURSAL
 
 **Object Class:** Safe
 
 **Special Containment Procedures:**  
 
-SCP-Recursal is to be stored on the Huggingface (HF) Servers, with backup copies maintained on other secure servers. 
+SCP-Recursal is to be stored on the Huggingface (HF) Servers, with backup copies maintained on other secure servers.  
 Access to SCP-Recursal is unrestricted, and it may be freely used and redistributed without authorization.
 
-**Description:** SCP-Recursal is a dataset comprising **~[TBD]B** Tokens (llama-2-7b-chat-tokenizer) / **~[TBD]B** Tokens (RWKV Tokenizer)  scraped from the SCP Wiki website (scp-wiki.wikidot.com). 
-The dataset is curated by Darok (Erik), released by KaraKaraWitch and funded by Recursal.ai.
+**Description:** SCP-Recursal is a dataset comprising **~[TBD]B** Tokens (llama-2-7b-chat-tokenizer) / **~[TBD]B** Tokens (RWKV Tokenizer)  scraped from the SCP Wiki website (scp-wiki.wikidot.com).  
+The dataset is curated by Darok, released by KaraKaraWitch and funded by Recursal.ai.
 
-SCP-Recursal is a comprehensive collection of tales, series, and jokes from the SCP Wiki, spanning from 2008 to 2022. 
+SCP-Recursal is a comprehensive collection of tales, series, from the SCP Wiki, spanning from 2008 to 2022.  
 The dataset was created by scraping lists of tales for each year, fetching content from tale pages using BeautifulSoup selectors, and filtering out unnecessary information.
-The same process was applied to series `scp-series-1` to `scp-series-8`, while the joke SCPs were extracted from a single URL (`/joke-scps`).
+The same process was applied to series `scp-series-1` to `scp-series-8`.
 
 The cleaning process involved removing author credits, "More articles by" sections, "Hide list" buttons, ratings, and special characters until the next line.
 Unicode characters were also cleaned, and unnecessary text was removed. The resulting dataset is a cohesive collection of SCP-related content, ideal for language modeling tasks.
@@ -50,32 +52,75 @@ Unicode characters were also cleaned, and unnecessary text was removed. The resu
 
 **Experiment 1:** "SCP-Recursal: The Ultimate Language Model"
 
-* Researchers used SCP-Recursal to train a language model, which was then tasked with generating a new SCP article.
-* Result: The model produced [DATA EXPUNGED]. Due to it's Memetic Effect, the computer that was in use was incinerated.
-* Conclusion: [DATA EXPUNGED]
+- Researchers used SCP-Recursal to train a language model, which was then tasked with generating a new SCP article.
+- Result: The model produced [DATA EXPUNGED]. Due to it's Memetic Effect, the computer that was in use was incinerated.
+- Conclusion: [DATA EXPUNGED]
 
 ---
 
-
 ## Dataset Details
 
 ### Dataset Description
 
-It serves as a training resource for large language models and other NLP tasks. 
-This card details the dataset's origin, content, and limitations.
+SCP-Recursal as mentioned in the SCP-Article above, is a dataset of **~[TBD]B** Tokens (llama-2-7b-chat-tokenizer) / **~[TBD]B** Tokens (RWKV Tokenizer) of SCP Tales and Stories
 
-- **Curated by:** KaraKaraWitch
+- **Curated by:** Darok
 - **Funded by [optional]:** Recursal.ai (I work there lol)
 - **Shared by [optional]:** KaraKaraWitch
-- **Language(s) (NLP):** Mainly English
-- **License:** cc-by-sa-3.0
-
-SCP-RECURSAL was created under time constraints for the release of [EagleX v1](https://huggingface.co/recursal/EagleX_1-7T_HF), and may contain suboptimal selection.  
+- **Language(s) (NLP):** Multiple (see Supported Languages)
+- **License:** cc-by-sa-4.0
 
 ### Supported Tasks and Leaderboards
 
-Primarily used for language modeling
+Primarily used for language modeling.
 
 ### Languages
 
-English. Mostly.
+From cursory look, the dataset is mainly written in english.
+
+### Scrpaing
+
+Scraping by fetching each page with BeautifulSoup.
+
+### Filtering
+
+Filtering is done base on a per line basis. removing certain patterns within lines of text. The file `tools/clean.py` contains the tools used to post process the stories.
+
+### Data Instances
+
+A sample is provided below
+
+```json
+{"text": "Project Codename: Olympia\nProject#: PRJOLM-000134\nClearance and File#: NPF-00051473\nHead Researcher: Professor K.P. Crow\nExperiment Aims:\nTo test the properties, capabilities and limitations of the subject.\nSubject is the product of Olympia Integration Experiment BETA, and is the ultimate product of the Olympia Project.<...TRUNCATED>"}
+```
+
+### Data Fields
+
+There is only 1 field (`text`) which contains a string to an article. No additional metadata is included.
+
+### Dataset Curators
+
+This dataset was mainly Darok's work. I (KaraKaraWitch) only assisted them with questions and the writing of the dataset card.
+
+### Licensing Information
+
+All the tales and stories in SCP-Wiki are broadly listed under `CC-BY-SA-3.0`. With the exception of 1 Image (SCP-173). However, we do not include any images for the SCP Items. As such all the text should be compliant under the `CC-BY-SA-3.0` license.
+
+### Citation Information
+
+```
+@misc{scp-recursal,
+  title         = {SCP-Recursal},
+  author        = {Darok, KaraKaraWitch, recursal.ai},
+  year          = {2023},
+  howpublished  = {\url{https://huggingface.co/datasets/recursal/SCP-RECURSAL}},
+}
+```
+
+### Additional Notes
+
+For those within SCP-Wiki wishing to use SCP-RECURSAL in writing / stories / tales:
+
+- Either `SCP-RECURSAL` or `SCP-Recursal`.
+- Do not misuse / detract from the defintion of SCP-RECURSAL mentioned above.
+- Aside from the above, you are allowed to reuse SCP-RECURSAL to your liking.