Update README.md

README.md

@@ -1,74 +1,132 @@
 ---
 license: mit
 pretty_name: SynLiDAR
+tags:
+  - lidar
+  - synthetic
+  - point-cloud
+  - autonomous-driving
+  - semantic-segmentation
+  - 3D-segmentation
 ---
+
 # SynLiDAR Dataset
 
 ## Overview
 
-SynLiDAR is a synthetic LiDAR dataset designed for autonomous driving research.
+**SynLiDAR** is a synthetic LiDAR dataset designed for autonomous driving research.  
 It contains high-quality simulated point cloud sequences and corresponding semantic annotations.
 
 The dataset provides two variants:
-- FullDataset – complete version for large-scale experiments
-- SubDataset – smaller version suitable for prototyping, debugging, and benchmarking
+
+- **FullDataset** — complete version for large-scale experiments (branch: `full`)
+- **SubDataset** — smaller version suitable for prototyping, debugging, and benchmarking (branch: `sub`)
+
+This HuggingFace repository uses **branches** to separate large data files and metadata:
+
+- `main` → metadata, scripts, annotations
+- `full` → FullDataset
+- `sub` → SubDataset
+
+---
 
 ## Dataset Structure
+
 ```
-SynLiDAR/  
-├── FullDataset/  
-│   ├── sequences/  
-│   │   ├── 00.zip  
-│   │   ├── ...  
-│   │   └── 12.zip  
-│   └── readme.txt  
-│  
-├── SubDataset/  
-│   ├── sequences/  
-│   │   ├── 00.zip  
-│   │   ├── ...  
-│   │   └── 12.zip  
-│   └── readme.txt  
-│  
-├── annotations.yaml  
-├── read_data.py  
-└── README.md  
+SynLiDAR/
+├── FullDataset/
+│   ├── sequences/
+│   │   ├── 00.zip
+│   │   ├── …
+│   │   └── 12.zip
+│   └── readme.txt
+│
+├── SubDataset/
+│   ├── sequences/
+│   │   ├── 00.zip
+│   │   ├── …
+│   │   └── 12.zip
+│   └── readme.txt
+│
+├── annotations.yaml
+├── read_data.py
+└── README.md
 ```
 
+> ⚠️ Some large sequences have been split into chunks (e.g. `06_part01.zip`, `06_part02.zip`, …) to avoid exceeding file size limits.
+> These parts are functionally equivalent to the original `06.zip`.
+
+---
+
 ## Contents
-- sequences/*.zip — Each zip contains LiDAR frames
-- annotations.yaml — Semantic categories and their mappings
-- read_data.py — Example Python loader
-- readme.txt — Additional notes from the original dataset
 
-## License
-The SynLiDAR dataset in this repository is released under the MIT License.
+- `sequences/*.zip` — Each zip contains LiDAR frames from a single drive sequence
+- `annotations.yaml` — Semantic categories and label mappings
+- `read_data.py` — Example Python loader to read `.bin` point cloud files
+- `readme.txt` — Original dataset notes
+
+---
+
+# 🔽 How to Download the Dataset
+
+## Install huggingface_hub
+
+```bash
+pip install huggingface_hub
 ```
-MIT License
-
-Copyright (c) 2025 Aoran XIAO
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+## Download Full Dataset (branch: full)
+
+```python
+from huggingface_hub import snapshot_download
+
+path = snapshot_download(
+    repo_id="AR-X/SynLiDAR",
+    revision="full",
+)
+print(path)
+```
+
+## Download Sub Dataset (branch: sub)
+
+```python
+from huggingface_hub import snapshot_download
+
+path = snapshot_download(
+    repo_id="AR-X/SynLiDAR",
+    revision="sub",
+)
+print(path)
+```
+## 🔧 Merging Split ZIP Files
+
+Some sequences in the full branch were too large (>50GB) and are stored as multiple parts:
+
+Example:
+```
+06_part01.zip
+06_part02.zip
+...
+06_part11.zip
+```
+
+These parts correspond to a single original archive. You can merge them into a single folder using Python:
+
+```python
+import zipfile
+from pathlib import Path
+
+sequence_dir = Path("SynLiDAR/FullDataset/sequences")
+parts = sorted(sequence_dir.glob("06_part*.zip"))
+
+output = Path("merged_06")
+output.mkdir(exist_ok=True)
+
+for z in parts:
+    print("Extracting", z.name)
+    with zipfile.ZipFile(z, "r") as zp:
+        zp.extractall(output)
 ```
 
-⚠️ **Disclaimer**: This dataset is intended for research and educational usage.
-Make sure to respect local regulations when training or deploying autonomous driving systems.
 
 ## Citation
 ```
@@ -81,4 +139,8 @@ Make sure to respect local regulations when training or deploying autonomous dri
   pages={2795--2803},  
   year={2022}  
 }
-```
+```
+
+
+⚠️ **Disclaimer**: This dataset is intended for research and educational usage.
+Make sure to respect local regulations when training or deploying autonomous driving systems.