Update README.md

README.md

@@ -1,3 +1,71 @@
----
-license: mit
----
+---
+license: mit
+---
+## The Verdict RCL LLM Dataset
+
+### Overview
+This dataset is prepared explicitly for training Large Language Models (LLMs) using Lumina AI's Random Contrast Learning (RCL) algorithm via the PrismRCL application. Unlike traditional classification datasets, LLM datasets require text to be formatted into input sequences and corresponding target tokens.
+
+### Dataset Structure
+For LLM training, the data structure differs significantly from standard classification datasets:
+
+```
+the-verdict-rcl-mm/
+    train/
+        [class_token_1]/
+            values.txt
+        [class_token_2]/
+            values.txt
+        ...
+    test/
+        [class_token_1]/
+            values.txt
+        [class_token_2]/
+            values.txt
+        ...
+```
+
+- **Class tokens:** Each folder name represents the target token for sequences.
+- **values.txt:** Each line within `values.txt` files represents an individual input sequence that maps to the target token of the folder it's contained within.
+
+### LLM Data Preparation
+PrismRCL requires LLM datasets to follow specific formatting, distinct from classification tasks:
+- Clean your raw text data (removing very long or non-printable characters).
+- Create input sequences with a sliding-window method. For example, a 4-token input sequence predicts the 5th token.
+- Each input sequence is stored as a single line in the class-specific `values.txt` files.
+
+**Example:**  
+Original text: "The Project Gutenberg eBook of Les Misérables."  
+- Input: "The Project Gutenberg eBook" → Target: "of"
+- Input: "Project Gutenberg eBook of" → Target: "Les"
+
+### Usage (LLM-specific)
+Use PrismRCL's `llm` parameter for LLM-specific training:
+
+```
+C:\PrismRCL\PrismRCL.exe llm naivebayes directional rclticks=67 readtextbyline ^
+  data=C:\path\to\the-verdict-rcl-mm\train testdata=C:\path\to\the-verdict-rcl-mm\test ^
+  savemodel=C:\path\to\models\verdict_llm.classify ^
+  log=C:\path\to\log_files stopwhendone
+```
+
+### Explanation of Command
+- **llm:** Specifies the dataset as an LLM training dataset.
+- **naivebayes:** Evaluation method suitable for LLM data.
+- **directional:** Maintains the order of tokens, critical for language modeling.
+- **rclticks:** Sets the granularity for RCL discretization.
+- **readtextbyline:** Each line in the text files is treated as a separate data sample.
+- **data & testdata:** Paths to training and testing datasets, respectively.
+- **savemodel:** Output path for the trained LLM model.
+- **log:** Directory for log file storage.
+- **stopwhendone:** Automatically ends the session after training completes.
+
+### License
+This dataset is licensed under the MIT License.
+
+### Original Source
+Prepared and structured explicitly by Lumina AI for RCL-based LLM training. Please credit Lumina AI when utilizing this dataset in research or applications.
+
+### Additional Information
+Refer to the PrismRCL Technical Documentation v2.6.2 for more detailed guidance on LLM data preparation and parameter specifications.
+