DANGDOCAO commited on
Commit
dd8e0bc
·
verified ·
1 Parent(s): 73bb0e7

update README.md

Browse files
Files changed (1) hide show
  1. README.md +0 -146
README.md DELETED
@@ -1,146 +0,0 @@
1
- # Dataset Card for HVU_QA
2
-
3
- **HVU_QA** is an open-source Vietnamese Question–Context–Answer (QCA) corpus and supporting tools for building FAQ-style question generation systems in low-resource languages.
4
- The dataset was created using a fully automated pipeline that combines **web crawling from trustworthy sources, semantic tag-based extraction, and AI-assisted filtering** to ensure high factual accuracy.
5
-
6
- ---
7
-
8
- ## Dataset Summary
9
-
10
- - **Language:** Vietnamese
11
- - **Format:** SQuAD-style JSON
12
- - **Total samples:** 30,000 QCA triples (full corpus released)
13
- - **Domains covered:** Social services, labor law, administrative processes, and other public service topics
14
-
15
- Each entry in the dataset has the following structure:
16
- - **Question:** Generated or extracted question
17
- - **Context:** Supporting text passage from which the answer is derived
18
- - **Answer:** Answer span within the context
19
-
20
- ---
21
-
22
- ## Supported Tasks and Benchmarks
23
-
24
- - **Question Generation (QG)**
25
- - **Question Answering (QA)**
26
- - **FAQ-style dialogue systems**
27
-
28
- A fine-tuned `VietAI/vit5-base` model trained on HVU_QA achieved:
29
- - **BLEU:** 90.61
30
- - **Semantic similarity:** 97.0% (cosine similarity ≥ 0.8)
31
- - **Human evaluation:**
32
- - Grammaticality: 4.58 / 5
33
- - Usefulness: 4.29 / 5
34
-
35
- ---
36
-
37
- ## Languages
38
-
39
- - **Vietnamese** (primary)
40
-
41
- ---
42
-
43
- ## Dataset Structure
44
-
45
- ### Data Fields
46
-
47
- Each sample contains:
48
- - `question`: A natural language question
49
- - `context`: Supporting text passage
50
- - `answer`: The extracted answer span
51
-
52
- ### Data Splits
53
-
54
- | Split | Size |
55
- |-------|------|
56
- | Train | 30,000 |
57
-
58
- ---
59
-
60
- ## Dataset Creation
61
-
62
- ### Creation Pipeline
63
-
64
- The dataset was built using a 4-stage automated process:
65
- 1. **Selecting relevant QA websites** from trusted sources
66
- 2. **Automated data crawling** to collect raw QA webpages
67
- 3. **Extraction via semantic tags** to obtain clean Q–C–A triples
68
- 4. **AI-assisted filtering** to remove noisy or factually inconsistent samples
69
-
70
- ---
71
-
72
- ## Usage Example
73
-
74
- ```python
75
- from datasets import load_dataset
76
-
77
- dataset = load_dataset("DANGDOCAO/GeneratingQuestions")
78
- print(dataset["train"][0])
79
- ```
80
-
81
- Example output:
82
- ```json
83
- {
84
- "question": "What type of coffee is famous in Vietnam?",
85
- "context": "Iced milk coffee is a famous drink in Vietnam.",
86
- "answer": "Iced milk coffee"
87
- }
88
- ```
89
-
90
- ---
91
-
92
- ## Training & Fine-tuning
93
-
94
- To fine-tune a question generation model:
95
-
96
- ```bash
97
- python fine_tune_qg.py
98
- ```
99
-
100
- - Loads `30ktrain.json`
101
- - Fine-tunes `VietAI/vit5-base`
102
- - Saves model as `t5-viet-qg-finetuned/`
103
-
104
- 👉 Alternatively, you can use the pre-trained model provided here:
105
- [Pre-trained model link](https://huggingface.co/datasets/DANGDOCAO/GeneratingQuestions/tree/main)
106
-
107
- ---
108
-
109
- ## Question Generation Example
110
-
111
- ```bash
112
- python generate_question.py
113
- ```
114
-
115
- **Input passage:**
116
- ```
117
- Iced milk coffee is a famous drink in Vietnam.
118
- ```
119
-
120
- **Generated questions:**
121
- 1. What type of coffee is famous in Vietnam?
122
- 2. Why is iced milk coffee popular?
123
- 3. What ingredients are included in iced milk coffee?
124
- 4. Where does iced milk coffee originate from?
125
- 5. How is Vietnamese iced milk coffee prepared?
126
-
127
- ---
128
-
129
- ## Citation
130
-
131
- If you use **HVU_QA** in your research, please cite:
132
-
133
- ```bibtex
134
- @inproceedings{nguyen2025hvuqa,
135
- title={A Method to Build QA Corpora for Low-Resource Languages},
136
- author={Ha Nguyen-Tien and Phuc Le-Hong and Dang Do-Cao and Cuong Nguyen-Hung and Chung Mai-Van},
137
- booktitle={Proceedings of the International Conference on Knowledge and Systems Engineering (KSE)},
138
- year={2025}
139
- }
140
- ```
141
-
142
- ---
143
-
144
- ## License
145
-
146
- This dataset is released for **research purposes only** under the **CC BY-NC-SA 4.0 license**.