Update README.md

README.md

@@ -19,13 +19,64 @@ dataset_info:
     dtype: string
   splits:
   - name: train
-    num_bytes: 675639455
-    num_examples: 4600
-  download_size: 272473973
-  dataset_size: 675639455
+    num_bytes: 147284033
+    num_examples: 883
+  download_size: 97380398
+  dataset_size: 147284033
 configs:
 - config_name: default
   data_files:
   - split: train
     path: data/train-*
 ---
+
+This dataset, CIRCL/vulnerability-cwe-patch, provides structured real-world vulnerabilities enriched with CWE identifiers and actual patches from platforms like GitHub and GitLab. It was built to support the development of tools for vulnerability classification, triage, and automated repair. Each entry includes metadata such as CVE/GHSA ID, a description, CWE categorization, and links to verified patch commits with associated diff content and commit messages.
+
+The dataset is automatically extracted using a robust pipeline that fetches vulnerability records from several sources, filters out entries without patches, and verifies patch links for accessibility. Extracted patches are fetched, encoded in base64, and stored alongside commit messages for training and evaluation of ML models.
+Source Data
+
+The vulnerabilities are sourced from:
+
+    - NVD CVE List — enriched with commit references
+
+    - GitHub Security Advisories (GHSA)
+
+    - GitLab advisories
+
+    - CSAF feeds from vendors including Red Hat, Cisco, and CISA
+
+### Schema
+
+Each example contains:
+
+    - id: Vulnerability identifier (e.g., CVE-2023-XXXX, GHSA-XXXX)
+
+    - title: Human-readable title of the vulnerability
+
+    - description: Detailed vulnerability description
+
+    - patches: List of patch records, each with:
+
+        url: Verified patch URL (GitHub/GitLab)
+
+        patch_text_b64: Base64-encoded unified diff
+
+        commit_message: Associated commit message
+
+    - cwe: List of CWE identifiers and names
+
+### Use Cases
+
+The dataset supports a range of security-focused machine learning tasks:
+
+    * Vulnerability classification
+    
+    * CWE prediction from descriptions
+    
+    * Patch generation from natural language
+    
+    * Commit message understanding
+
+### Associated Code
+
+The dataset is generated with the extraction pipeline from vulnerability-lookup/ML-Gateway, which includes logic for fetching, filtering, validating, and encoding patch data.