Upload README.md

README.md

@@ -34,7 +34,7 @@ This dataset combines raw source code from a variety of mature and hobbyist oper
 
 The dataset is provided in **Parquet** format for optimal compression and integration with the `datasets` library.
 
-### 1. `kernelllm_dataset_v2.parquet` (~1.8 GB, ~1.5B tokens)
+### 1. `kernelllm_dataset_v2.parquet` (~1.8 GB)
 **Unified Knowledge Base:**
 - **Files/Entries:** 367,769
 - **Size:** ~1.8 GB (Parquet), ~6.1 GB (Raw JSONL)
@@ -72,6 +72,55 @@ The dataset is provided in **Parquet** format for optimal compression and integr
 - **`git_logdiff`:** (234 entries) Pairs commit messages with filtered logic-diffs to show how code evolves.
 - **`lkml_critique`:** (~26,600 pairs) Contentious technical discussions pairing code snippets with maintainer feedback.
 
+### 3. Dataset Schema
+
+The unified dataset contains three primary data types, each with a specific schema:
+
+#### Source Code (`data_type: "source"`)
+```json
+{
+  "data_type": "source",
+  "source": "repository_name",
+  "filepath": "relative/path/to/file.c",
+  "code": "cleaned_source_code_content"
+}
+```
+
+#### Git Commit Diffs (`data_type: "git_logdiff"`)
+```json
+{
+  "data_type": "git_logdiff",
+  "commit": "commit_sha_hash",
+  "source": "repository_name",
+  "message": "commit_message",
+  "code": "git_diff_output"
+}
+```
+
+#### LKML Critiques (`data_type: "lkml_critique"`)
+```json
+{
+  "data_type": "lkml_critique",
+  "source": "mailing_list_name",
+  "subject": "[PATCH] subject_line",
+  "code": "patch_content",
+  "critique": "maintainer_feedback",
+  "metadata": {
+    "author": "reviewer_email",
+    "date": "email_date",
+    "thread_id": "thread_identifier",
+    "is_openbsd": boolean
+  }
+}
+```
+
+#### Data Processing Features
+- **Deduplication:** Content-based hashing with normalized whitespace
+- **License Header Cleaning:** Preserves SPDX identifiers and copyright lines while removing generic boilerplate
+- **Size Filtering:** Excludes files under 100 characters
+- **Git-specific:** Deduplicates by commit SHA when available
+- **Critique-specific:** Deduplicates based on code + critique content pairs
+
 ## Dataset Release Strategy 
 
 This is the **Raw** version of the dataset. It is intended for: