DANGDOCAO commited on
Commit
9959d98
·
verified ·
1 Parent(s): 1c66b0d

Delete README.md

Browse files
Files changed (1) hide show
  1. README.md +0 -192
README.md DELETED
@@ -1,192 +0,0 @@
1
- ---
2
- license: mit
3
- task_categories:
4
- - question-answering
5
- - text-generation
6
- - table-question-answering
7
- - sentence-similarity
8
- - feature-extraction
9
- language:
10
- - vi
11
- tags:
12
- - question-generation
13
- - nlp
14
- - faq
15
- - low-resource
16
- - code
17
- pretty_name: HVU_QA
18
- size_categories:
19
- - 10K<n<100K
20
- configs:
21
- - config_name: default
22
- data_files:
23
- - split: train
24
- path: 40k_train.json
25
- ---
26
- # HVU_QA
27
-
28
- **HVU_QA** is an open-source Vietnamese Question–Context–Answer (QCA) corpus, accompanied by supporting tools, created to facilitate the development of FAQ-style question generation and question answering systems, particularly for low-resource language settings. The dataset is developed by a research team at Hung Vuong University, Phu Tho, Vietnam, led by Dr. Ha Nguyen, Deputy Head of the Department of Engineering Technology. HVU_QA was constructed using a fully automated data-building pipeline that combines web crawling from reliable sources, semantic tag-based extraction, and AI-assisted filtering, helping ensure high factual accuracy, consistent structure, and practical usability for real-world applications.
29
-
30
- ## 📋 Dataset Description
31
-
32
- - **Language:** Vietnamese
33
- - **Format:** SQuAD-style JSON
34
- - **Total samples:** 40,000 QCA triples (full corpus released)
35
- - **Domains covered:** Social services, labor law, administrative processes, and other public service topics.
36
- - **Structure of each sample:**
37
- - **Question:** Generated or extracted question
38
- - **Context:** Supporting text passage from which the answer is derived
39
- - **Answer:** Answer span within the context
40
-
41
- ## ⚙️ Creation Pipeline
42
-
43
- The dataset was built using a 4-stage automated process:
44
- 1. **Selecting relevant QA websites** from trusted sources.
45
- 2. **Automated data crawling** to collect raw QA webpages.
46
- 3. **Extraction via semantic tags** to obtain clean Question–Context–Answer triples.
47
- 4. **AI-assisted filtering** to remove noisy or factually inconsistent samples.
48
-
49
- ## 📊 Quality Evaluation
50
- A fine-tuned `vit5-base` model trained on HVU_QA achieved:
51
-
52
- | Metric | Score |
53
- |-------------------------|----------------|
54
- | BLEU | 89.1 |
55
- | Semantic similarity | 91.5% (cos ≥ 0.8) |
56
- | Human grammar score | 4.58 / 5 |
57
- | Human usefulness score | 4.29 / 5 |
58
-
59
- These results confirm that HVU_QA is a high-quality resource for developing robust FAQ-style question generation models.
60
-
61
- ## 📁 Dataset Structure
62
- ```
63
- .HVU_QA
64
- ├── t5-viet-qg-finetuned/
65
- ├── fine_tune_qg.py
66
- ├── generate_question.py
67
- ├── 40k_train.json
68
- └── README.md
69
- ```
70
- ## 📁 Vietnamese Question Generation Tool
71
-
72
- ## 🛠️ Requirements
73
-
74
- * Python 3.8+
75
- * PyTorch >= 1.9
76
- * Transformers >= 4.30
77
- * scikit-learn
78
-
79
- ### 📦 Install Required Libraries
80
-
81
- ```bash
82
- pip install datasets transformers sentencepiece safetensors accelerate evaluate sacrebleu rouge-score nltk scikit-learn
83
- ```
84
-
85
- *(Install PyTorch separately from [pytorch.org](https://pytorch.org) if not installed yet.)*
86
-
87
- ### 📥 Load Dataset from Hugging Face Hub
88
- ```python
89
- from datasets import load_dataset
90
-
91
- ds = load_dataset("DANGDOCAO/GeneratingQuestions", split="train")
92
- print(ds[0])
93
- ```
94
- ## 📚 Usage
95
-
96
- * Train and evaluate a question generation model.
97
- * Develop Vietnamese NLP tools.
98
- * Conduct linguistic research.
99
-
100
- ### 🔹 Fine-tuning
101
-
102
- ```bash
103
- python fine_tune_qg.py
104
- ```
105
-
106
- This will:
107
-
108
- 1. Load the dataset from `40k_train.json`.
109
- 2. Fine-tune `VietAI/vit5-base`.
110
- 3. Save the trained model into `t5-viet-qg-finetuned/`.
111
-
112
- *(Or download the pre-trained model: [t5-viet-qg-finetuned](https://huggingface.co/datasets/DANGDOCAO/GeneratingQuestions/tree/main).)*
113
-
114
- ### 🔹 Generating Questions
115
- ```bash
116
- python generate_question.py
117
- ```
118
-
119
- **Example:**
120
- ```
121
- Input passage:
122
- Cà phê sữa đá là một loại đồ uống nổi tiếng ở Việt Nam
123
- (Iced milk coffee is a famous drink in Vietnam)
124
-
125
- Number of questions: 5
126
- ```
127
- **Output:**
128
- ```
129
- 1. Loại cà phê nào nổi tiếng ở Việt Nam?
130
- (What type of coffee is famous in Vietnam?)
131
- 2. Tại sao cà phê sữa đá lại phổ biến?
132
- (Why is iced milk coffee popular?)
133
- 3. Cà phê sữa đá bao gồm những nguyên liệu gì?
134
- (What ingredients are included in iced milk coffee?)
135
- 4. Cà phê sữa đá có nguồn gốc từ đâu?
136
- (Where does iced milk coffee originate from?)
137
- 5. Cà phê sữa đá Việt Nam được pha chế như thế nào?
138
- (How is Vietnamese iced milk coffee prepared?)
139
- ```
140
- **You can adjust** in `generate_question.py`:
141
-
142
- - `top_k`, `top_p`, `temperature`, `no_repeat_ngram_size`, `repetition_penalty`
143
-
144
- ## 📌 Citation
145
- If you use **HVU_QA** in your research, please cite:
146
-
147
- ```bibtex
148
- @inproceedings{nguyen2025method,
149
- author = {Ha Nguyen and Phuc Le and Dang Do and Cuong Nguyen and Chung Mai},
150
- title = {A Method for Building QA Corpora for Low-Resource Languages},
151
- booktitle = {Proceedings of the 2025 International Symposium on Information and Communication Technology (SOICT 2025)},
152
- year = {2025},
153
- publisher = {Springer},
154
- series = {Communications in Computer and Information Science (CCIS)},
155
- address = {Nha Trang, Vietnam},
156
- note = {To appear}
157
- }
158
- ```
159
- ## ❤️ Support / Funding
160
-
161
- If you find **HVU_QA** useful, please consider supporting our work.
162
- Your contributions help us maintain the dataset, improve quality, and release new versions (cleaning, expansion, benchmarks, and tools).
163
-
164
- ### 🇻🇳 Donate via VietQR (scan to support)
165
- This **VietQR / NAPAS 247** code can be scanned by Vietnamese banking apps and some international payment apps that support QR bank transfers.
166
-
167
- <img src="QRtk.jpg" alt="VietQR Support" width="320"/>
168
-
169
- **Bank:** VietinBank (Vietnam)
170
- **Account name:** NGUYEN TIEN HA
171
- **Account number:** 103004492490
172
- **Branch:** VietinBank CN PHU THO - HOI SO
173
-
174
- ### 🌍 International Support (Quick card payment)
175
- If you are outside Vietnam, you can support this project via **Buy Me a Coffee**
176
- (no PayPal account needed — pay directly with a credit/debit card):
177
- - BuyMeACoffee: https://buymeacoffee.com/hanguyen0408
178
-
179
- ### 🌍 International Support (PayPal)
180
- If you prefer PayPal, you can also support us here:
181
- - PayPal.me: https://paypal.me/HaNguyen0408
182
-
183
- ### ✨ Other ways to support
184
- - ⭐ Star this repository / dataset on Hugging Face
185
- - 📌 Cite our paper if you use it in your research
186
- - 🐛 Open issues / pull requests to improve the dataset and tools
187
- -
188
- 📬 Contact / Maintainers
189
- For questions, feedback, collaborations, or issue reports related to HVU_QA, please contact:
190
- Dr. Ha Nguyen (Project Lead)
191
- Hung Vuong University, Phu Tho, Vietnam
192
- Email: nguyentienha@hvu.edu.vn