Upload README.md with huggingface_hub

README.md

@@ -1,28 +1,52 @@
 ---
-configs:
-- config_name: default
-  data_files:
-  - split: raw
-    path: data/raw-*
-  - split: filtered_heuristic
-    path: data/filtered_heuristic-*
-dataset_info:
-  features:
-  - name: id
-    dtype: string
-  - name: indonesian
-    dtype: string
-  - name: balinese
-    dtype: string
-  - name: cirebonese
-    dtype: string
-  splits:
-  - name: raw
-    num_bytes: 17007467302
-    num_examples: 2196290
-  - name: filtered_heuristic
-    num_bytes: 16011915965
-    num_examples: 2078528
-  download_size: 18472293542
-  dataset_size: 33019383267
+pretty_name: Indonesian ↔ Balinese ↔ Cirebonese Synthetic Corpus
+license: other
+task_categories:
+- text-classification
+- text-generation
+language:
+- id
+- ban
+- jav
 ---
+
+# Indonesian–Balinese–Cirebonese Synthetic Parallel Corpus
+
+## Dataset Summary
+
+This corpus is **fully synthetic** and targets two extremely low-resource languages:
+- **Balinese** (ban)
+- **Cirebonese** (often grouped under Javanese dialects)
+
+Key facts:
+- Seeded with 10k high-level topics generated by GPT-5.
+- For each topic, GPT-5 produced 30 subtopics and GPT-OSS-120B generated 30
+  question–answer pairs (≈9M Q&A pairs). All answers are authored by GPT-OSS-120B.
+- Answers were translated into Balinese and Cirebonese by GPT-OSS-120B while
+  leveraging bilingual lexicons/dictionaries through prompting and in-context
+  learning.
+- The parallel corpus contains roughly **~1B tokens per low-resource language**
+  (Balinese & Cirebonese) across all splits.
+
+## Available Subsets
+
+- `raw`: direct aggregation of every translated answer that passes structural
+  validation (IDs and all three language fields present).
+- `filtered_heuristic`: subset of `raw` that passes the same heuristics used in
+  `scripts/clean_translations.py`, including minimum length, repetition checks,
+  and GlotLID verification for Balinese and Cirebonese.
+
+## Citation
+
+If you use this dataset (or derivatives), please cite:
+
+```
+Scaling Resources for Extremely Low-Resource Language
+Faiz Ghifari Haznitrama, Najma Qalbi Dwiharani, Alice Oh
+```
+
+## Notes
+
+- Dataset is synthetic; no human-written or human-translated text is included.
+- Please verify downstream safety/quality constraints that apply to your
+  deployment scenario before production use.