Update README.md

README.md

@@ -1,25 +1,91 @@
-# Vietnamese Sign Language Dataset
-
-## Overview
-This dataset contains sequences of Vietnamese Sign Language (VSL) gestures.  
-Each sequence is stored as `.npz` file containing:
-- **sequences**: Keypoints extracted from MediaPipe (hand/body/face).
-- **labels**: Integer labels corresponding to gesture classes.
-
-The dataset is designed for training **static and dynamic sign language recognition models**.
-
-## Structure
-- `sequences`: NumPy arrays of shape `(T, N)` where:
-  - `T` = number of frames in the sequence  
-  - `N` = number of extracted keypoints  
-- `labels`: Integer class IDs
-
-## Usage
-Load the dataset directly with 🤗 Datasets:
-
-```python
-from datasets import load_dataset
-
-dataset = load_dataset("Kateht/VOYA_VSL")
-
-print(dataset)
+---
+language: vi
+license: mit
+tags:
+- sign-language
+- mediapipe
+- vietnamese
+- keypoints
+- npz
+size_categories:
+- 50GB+
+task_categories:
+- sign-language-recognition
+pretty_name: VOYA Vietnamese Sign Language (VOYA_VSL)
+---
+
+# VOYA Vietnamese Sign Language (VOYA_VSL)
+
+VOYA_VSL là bộ dữ liệu ngôn ngữ ký hiệu tiếng Việt, được thu thập và tiền xử lý để phục vụ nghiên cứu về **nhận dạng ngôn ngữ ký hiệu**.  
+Bộ dữ liệu bao gồm các chuỗi keypoints được trích xuất từ MediaPipe, mỗi chuỗi biểu diễn một video ký hiệu.
+
+## 📦 Thông tin dữ liệu
+
+- **Định dạng**: `.npz` (NumPy compressed)
+- **Số mẫu**: ~161
+- **Cấu trúc một sample**:
+  - `sequences`: ma trận có shape `(60, 1605)` (60 khung hình, 1605 keypoints/feature mỗi khung)
+  - `labels`: chỉ số lớp (int32)
+
+## 📂 Cấu trúc dataset
+
+VOYA_VSL/
+│── Merged/
+│ ├── class_0001.npz
+│ ├── class_0002.npz
+│ ├── ...
+│ └── class_0161.npz
+│── labels.json
+│── dataset.py
+└── README.md
+
+- `Merged/` : chứa dữ liệu từng lớp đã gom thành `.npz`
+- `labels.json` : ánh xạ `class_xxxx` → tên ký hiệu
+- `dataset.py` : script để load dataset qua Hugging Face Datasets
+- `README.md` : mô tả dataset
+
+## 🛠️ Cách sử dụng
+
+```python
+from datasets import load_dataset
+
+# Load dataset VOYA_VSL
+dataset = load_dataset("Kateht/VOYA_VSL")
+
+print(dataset)
+
+DatasetDict({
+    train: Dataset({
+        features: ['sequences', 'labels'],
+        num_rows: ...
+    })
+})
+
+# Truy cập 1 sample
+sample = dataset["train"][0]
+print(sample["sequences"].shape)  # (60, 1605)
+print(sample["labels"])           # int label
+
+📌 Bạn có thể tự chia train/val/test sau khi load:
+
+dataset = dataset["train"].train_test_split(test_size=0.2, seed=42)
+
+🔖 Labels
+File labels.json chứa mapping từ ID lớp → nhãn tiếng Việt. Ví dụ:
+
+{
+  "class_0001": "địa chỉ (bắc)",
+  "class_0002": "địa chỉ (nam)",
+  "class_0003": "địa chỉ (trung)"
+}
+
+📜 Trích dẫn
+Nếu bạn sử dụng dataset này trong nghiên cứu, vui lòng trích dẫn:
+
+@misc{voya_vsl_2025,
+  author       = {Kateht et al.},
+  title        = {VOYA Vietnamese Sign Language Dataset},
+  year         = {2025},
+  publisher    = {Hugging Face},
+  howpublished = {\url{https://huggingface.co/datasets/Kateht/VOYA_VSL}}
+}