Update README.md

README.md

@@ -1,37 +1,70 @@
+
 ---
-dataset_info:
-  features:
-  - name: func
-    dtype: string
-  - name: target
-    dtype: int64
-  - name: cwe
-    list: string
-  - name: project
-    dtype: string
-  - name: commit_id
-    dtype: string
-  - name: hash
-    dtype: float64
-  - name: size
-    dtype: int64
-  - name: message
-    dtype: string
-  - name: is_vulnerable
-    dtype: string
-  - name: cwe_id_extracted
-    dtype: string
-  - name: cwe_details
-    dtype: string
-  splits:
-  - name: train
-    num_bytes: 817707249
-    num_examples: 330492
-  download_size: 313045683
-  dataset_size: 817707249
-configs:
-- config_name: default
-  data_files:
-  - split: train
-    path: data/train-*
+license: mit
+tags:
+- security
+- cwe
+- vulnerability
+- code-analysis
+- software-security
+- dataset
+- machine-learning
+- llm-finetuning
 ---
+
+# 🔐 Code Vulnerability Dataset (CWE-Enriched)
+
+## 📌 Overview
+
+This dataset is built from the **bstee615/diversevul** dataset and enhanced with structured vulnerability intelligence from the **MITRE Common Weakness Enumeration (CWE)** database.
+
+It provides a rich, machine-readable representation of software vulnerabilities, mapping raw vulnerable code samples to standardized CWE classifications.
+
+The dataset is designed for research and development in:
+- Vulnerability detection models
+- Secure code generation
+- LLM fine-tuning for cybersecurity tasks
+- Static analysis and code understanding systems
+
+---
+
+## 🧠 Dataset Enrichment Process
+
+Each sample in the dataset has been augmented using the MITRE CWE API to include structured security intelligence such as:
+
+- CWE identifier (e.g., CWE-787)
+- Vulnerability type (e.g., Out-of-bounds Write)
+- Human-readable description
+- Severity / exploit likelihood
+- Impact categories (e.g., code execution, crash)
+- Applicable programming languages
+- Security classification metadata
+
+---
+
+## 📊 Data Structure
+
+Each row in the dataset contains:
+
+### 🔹 Original Fields
+- `func` → Source code snippet
+- `cwe` → Original CWE labels from DiverseVul dataset
+
+### 🔹 Enriched Field
+- `cwe_details` → JSON object containing structured CWE metadata:
+
+```json
+{
+  "cwe_id": "CWE-787",
+  "vulnerability_type": "Out-of-bounds Write",
+  "description": "The product writes data past the end, or before the beginning, of the intended buffer.",
+  "severity": "High",
+  "category": "Memory Corruption",
+  "impact": [
+    "Modify Memory",
+    "Execute Unauthorized Code",
+    "Crash (DoS)"
+  ],
+  "languages": ["C", "C++"],
+  "example": "Example not extracted"
+}