Update README.md

README.md

@@ -1,5 +1,5 @@
 ---
-license: other
+license: gpl-2.0
 task_categories:
 - text-generation
 language:
@@ -21,22 +21,81 @@ size_categories:
 
 # Linux Kernel Assembly → Explanation Dataset
 
-Derived from the [Linux Commits Dataset](https://zenodo.org/records/10654193)
-(90K+ BFC/BIC pairs from the Linux kernel).
-
-Each row contains:
-- `asm`: objdump-disassembled function assembly (AT&T syntax, with source intermix via `-S`)
-- `explanation`: structured natural-language description of what the function does and
-  its role in the bug-fix or bug-introducing commit
-- `bfc_hash` / `bic_hash`: linked commit pair hashes
-- `commit_type`: `"bfc"` (bug-fix) or `"bic"` (bug-introducing)
-- `filename`: source file in the kernel tree
-- `func_name`: C function name
-- `commit_message`: first 512 chars of the commit message
-
-## Intended Use
-Training/fine-tuning LLMs for assembly understanding, decompilation,
-and compiler-output analysis.
-
-## Source
-Zenodo record 10654193 — codeurjc/LinuxCommitsDataset
+> **Upload in progress.** Additional batches are still being added. The final dataset will contain records derived from 90K+ BFC/BIC commit pairs.
+
+A dataset of disassembled Linux kernel functions paired with structured natural-language explanations, built from the [Linux Commits Dataset (Zenodo 10654193)](https://zenodo.org/records/10654193).
+
+Each row corresponds to a single compiled function extracted from a `.c` or `.h` file touched by a **Bug-Fix Commit (BFC)** or **Bug-Introducing Commit (BIC)** in the Linux kernel git history. Source files are compiled with `gcc -O2 -g -fno-inline -fno-omit-frame-pointer` and disassembled with `objdump -d -S` (AT&T syntax, source-interleaved).
+
+Intended for training or evaluating models on **assembly code understanding**, specifically, generating natural language explanations from disassembled Linux kernel functions.
+
+---
+
+## Schema
+
+| Column | Type | Description |
+|---|---|---|
+| `bfc_hash` | `string` | Hash of the bug-fix commit in the pair |
+| `bic_hash` | `string` | Hash of the bug-introducing commit in the pair |
+| `commit_hash` | `string` | The specific commit this function was extracted from |
+| `commit_type` | `string` | `"bfc"` (bug-fix commit) or `"bic"` (bug-introducing commit) |
+| `filename` | `string` | Source file path within the kernel tree (e.g. `kernel/sched/core.c`) |
+| `func_name` | `string` | Name of the disassembled function |
+| `asm` | `string` | `objdump -d -S` output for one function (AT&T syntax, source lines interleaved) |
+| `explanation` | `string` | Structured description: commit type, function name, author, date, commit message, and role |
+| `commit_message` | `string` | First 512 characters of the commit message |
+
+---
+
+## Usage
+
+```python
+from datasets import load_dataset
+
+ds = load_dataset("theelderemo/linux-asm-pairs", split="train")
+print(ds["asm"])
+print(ds["explanation"])
+```
+
+Filter to only bug-fix commits:
+```python
+bfc_only = ds.filter(lambda x: x["commit_type"] == "bfc")
+```
+
+---
+
+## Data Pipeline
+
+1. BFC/BIC pairs sourced from `bfc_bic.csv` in [Zenodo record 10654193](https://zenodo.org/records/10654193)
+2. Full diffs fetched from a local bare clone of the Linux kernel git repo (snapshot: 2023-11-12)
+3. Changed `.c` / `.h` files compiled with `gcc -O2 -g -fno-inline -fno-omit-frame-pointer`
+4. Functions extracted via `objdump -d -S --no-show-raw-insn`
+5. Explanations constructed from Perceval-parsed commit metadata
+
+---
+
+## License
+
+Source assembly is derived from the Linux kernel, which is licensed under **GPL-2.0**. This dataset inherits that license. See [kernel.org/doc/html/latest/process/license-rules.html](https://www.kernel.org/doc/html/latest/process/license-rules.html) for details.
+
+---
+
+## Citation
+
+If you use this dataset, please also cite the upstream source:
+
+```bibtex
+@dataset{linux_commits_2023,
+  title   = {Linux Commits Dataset},
+  year    = {2023},
+  url     = {https://zenodo.org/records/10654193}
+}
+
+@dataset{theelderemo_linux_asm_pairs_2026,
+  author  = {theelderemo},
+  title   = {Linux Kernel Assembly → Explanation Dataset},
+  year    = {2026},
+  url     = {https://huggingface.co/datasets/theelderemo/linux-asm-pairs},
+  note    = {Derived from the Linux Commits Dataset (Zenodo 10654193). Assembly extracted via GCC + objdump from BFC/BIC commit pairs in the Linux kernel git history.}
+}
+```