Update README.md

README.md

@@ -19,6 +19,68 @@ language:
 - en
 ---
 
+# OpenSCAD-Code-to-3D-HF
+
+## Dataset Description
+
+**OpenSCAD-Code-to-3D-HF** is a dataset built on top of [CodeCAD-HF-v2](https://huggingface.co/datasets/prithivMLmods/CodeCAD-HF-v2). It pairs natural language prompts with their corresponding OpenSCAD parametric code and references to rendered GLB (GL Transmission Format Binary) 3D model files.
+
+The dataset provides text-based descriptions, procedural 3D modeling code, and corresponding 3D assets. The GLB files are distributed separately in a ZIP archive, `glb.zip`, with **~53,172 mapped data entries** identified through file mapping between the dataset records and the archived GLB files.
+
+## Dataset Statistics
+
+| Property | Value |
+|----------|-------|
+| Dataset Repository | `prithivMLmods/OpenSCAD-Code-to-3D-HF` |
+| Number of Mapped Data Entries | ~53,172 |
+| GLB Storage | `glb.zip` |
+| Main Dataset File | `dataset.parquet` |
+| Data Format | Parquet + ZIP archive |
+| Modalities | Text, 3D |
+
+## Dataset Structure
+
+| Column | Type | Description |
+|--------|------|-------------|
+| `Prompt` | string | Natural language description of the 3D model |
+| `Code` | string | OpenSCAD parametric code that generates the model |
+| `3d_glb` | string | File path reference to the corresponding rendered `.glb` 3D model inside the ZIP archive |
+
+## GLB File Mapping
+
+The GLB assets are stored in `glb.zip` rather than as individual files directly in the dataset repository. The `3d_glb` column contains references that can be mapped to the corresponding files in the archive.
+
+The dataset mapping procedure identifies matching GLB files by filename and generates the following reports:
+
+- `mapped_data.txt`: Dataset rows successfully mapped to GLB files in the ZIP archive.
+- `unmapped_data.txt`: Dataset rows with empty GLB references or references to files that were not found in the archive.
+- `zip_only_data.txt`: GLB archive filenames that are not referenced by any dataset row.
+
+A total of **53,172 mapped data entries** were identified through this process.
+
+## Usage
+
+Install the required dependencies:
+
+```bash
+pip install -U datasets pandas pyarrow
+```
+
+Load the dataset:
+
+```python
+from datasets import load_dataset
+
+ds = load_dataset(
+    "prithivMLmods/OpenSCAD-Code-to-3D-HF",
+    data_files="dataset.parquet"
+)
+
+print(ds["train"][0])
+```
+
+To access the GLB assets, download `glb.zip` from the dataset repository and extract the archive. The `3d_glb` references can then be matched to the extracted files using the mapping procedure.
+
 ## Dataset and GLB File Mapping
 
 ```
@@ -136,4 +198,12 @@ print(f"Rows sharing a GLB file name    : {dup_rows}  (across {dup_names} file n
 print(f"\nSaved -> {MAPPED}   (row_index | 3d_glb value | path in zip folder)")
 print(f"Saved -> {UNMAPPED}   (row_index | 3d_glb value)")
 print(f"Saved -> {ZIP_ONLY}   (file names present in zip but not referenced)")
-```
+```
+
+## Source Dataset
+
+This dataset is derived from [CodeCAD-HF-v2](https://huggingface.co/datasets/prithivMLmods/CodeCAD-HF-v2).
+
+## License
+
+Please refer to the original [CodeCAD paper](https://dl.acm.org/doi/10.1145/3770855.3817592) for source data license terms.