Update README.md

README.md

@@ -1,3 +1,74 @@
----
-license: apache-2.0
----
+---
+license: apache-2.0
+---
+# CompRealVul_Bin Dataset
+
+[![Hugging Face](https://img.shields.io/badge/🤗%20View%20on-HuggingFace-blue)](https://huggingface.co/datasets/compAgent/CompRealVul_Bin)
+
+## Dataset Summary
+
+**CompRealVul_Bin** is a **binary-level dataset** derived from the [CompRealVul_C](https://huggingface.co/datasets/compAgent/CompRealVul_C) dataset, designed for training and evaluating machine learning models on **vulnerability detection in compiled binaries**. This dataset contains **cross-compiled `.exe` binaries** corresponding to each C function in the source dataset, packaged as a single `.zip` archive.
+
+The dataset bridges the gap between source-level vulnerability datasets and practical binary-level learning pipelines.
+
+## Key Features
+
+- ✅ **Cross-compiled `.exe` binaries** (Windows format) for each function  
+- ✅ Matches samples from the original `CompRealVul` dataset  
+- ✅ Labeled with **vulnerability information** (CWE ID and binary class label)  
+- ✅ Suitable for binary-focused tasks such as **vulnerability detection**, **similarity learning**, and **binary classification**  
+- ✅ Provided as a **ZIP archive** for efficient download and storage  
+
+## Dataset Structure
+
+- `CompRealVul_Bin.zip`: Contains all compiled `.exe` binary files  
+- `metadata.csv`: Metadata file with the following fields:
+
+| Column          | Description                                                                 |
+|-----------------|-----------------------------------------------------------------------------|
+| `name`          | Identifier of the function (matches CompRealVul)                            |
+| `binary_path`   | Relative path to the `.exe` file inside the ZIP archive                     |
+| `cwe`           | CWE identifier for the vulnerability (or `-1` if unknown or non-vulnerable) |
+| `target`        | Vulnerability label (`1.0` = vulnerable, `0.0` = non-vulnerable)            |
+| `split`         | Dataset split (currently only `train`)                                      |
+
+**Example:**
+```csv
+name,binary_path,cwe,target,split
+func_123,bin/func_123.exe,CWE-120,1.0,train
+```
+
+## Usage
+
+You can load the dataset directly using the `datasets` library from Hugging Face:
+
+```python
+import pandas as pd
+import zipfile
+
+# Load metadata
+df = pd.read_csv("metadata.csv")
+
+# Access the ZIP archive
+with zipfile.ZipFile("CompRealVul_Bin.zip", "r") as zip_ref:
+    # Extract a specific binary
+    binary_path = df.iloc[0]["binary_path"]
+    zip_ref.extract(binary_path, "extracted_binaries/")
+
+# Read binary data
+with open(f"extracted_binaries/{binary_path}", "rb") as f:
+    binary_data = f.read()
+```
+
+## License
+This dataset is released under the Apache 2.0 License.
+
+## Citation
+```cite
+@misc{comprealvul_bin,
+  author       = {comp agent},
+  title        = {CompRealVul_Bin: A Binary Dataset for Vulnerability Detection},
+  howpublished = {\url{https://huggingface.co/datasets/compAgent/CompRealVul_Bin}},
+  year         = {2025}
+}
+```