Datasets:

DANGDOCAO
/

GeneratingQuestions

@@ -1,379 +0,0 @@
-# HVU_QA
-Ứng dụng sinh câu hỏi từ đoạn văn bản bằng mô hình T5 tiếng Việt.
-Repo này hiện hỗ trợ **2 cách sử dụng**:
-- **Full project**: tải toàn bộ source code để dùng, chỉnh sửa, kiểm thử và phát triển tiếp.
-- **Standalone tool**: chỉ cần `HVU_QA_tool.py` để launcher tự dựng runtime, tự cài dependency, tự tải model và mở app.
-## 1. Cấu trúc project
-```text
-HVU_QA/
-├── backend/
-│   ├── __init__.py
-│   └── app.py
-├── frontend/
-│   ├── app.js
-│   ├── index.html
-│   └── style.css
-├── t5-viet-qg-finetuned/
-│   ├── config.json
-│   ├── model.safetensors
-│   ├── ...
-│   └── best-model/
-├── 40k_train.json
-├── fine_tune_qg.py
-├── generate_question.py
-├── HVU.png
-├── HVU_QA_end_to_end_guide.ipynb
-├── HVU_QA_tool.py
-├── main.py
-├── readme.md
-└── requirements.txt
-```
-## 2. Thành phần chính
-- `main.py`: điểm chạy chính của web app Flask trong full project.
-- `backend/app.py`: route web và API backend của full project.
-- `frontend/index.html`, `frontend/app.js`, `frontend/style.css`: giao diện và logic frontend của full project.
-- `generate_question.py`: lõi load model và sinh câu hỏi, đồng thời hỗ trợ CLI.
-- `fine_tune_qg.py`: script fine-tune model.
-- `HVU_QA_tool.py`: launcher đa chế độ.
-  - Nếu đứng trong full project: dùng source hiện tại.
-  - Nếu chỉ có mỗi file tool: tự tạo `.hvu_qa_tool_venv/` và `HVU_QA_runtime/`.
-- `HVU_QA_end_to_end_guide.ipynb`: notebook đã tách riêng 2 luồng `Full project` và `Quick tool`.
-## 3. Yêu cầu môi trường
-Khuyến nghị:
-- Python `3.11`
-- Windows PowerShell
-- `pip`
-Nếu muốn chạy bằng GPU NVIDIA, cần cài đúng bản `torch` tương thích CUDA của máy.
-## 4. Cách dùng A - Full project
-Đây là cách phù hợp nếu bạn muốn dùng và phát triển tiếp toàn bộ mã nguồn.
-Tạo môi trường ảo:
-```powershell
-python -m venv venv
-.\venv\Scripts\Activate.ps1
-```
-Cài dependencies:
-```powershell
-.\venv\Scripts\python -m pip install --upgrade pip
-.\venv\Scripts\python -m pip install -r requirements.txt
-```
-Nếu dùng GPU NVIDIA, nên cài đúng `torch` theo CUDA của máy trước, rồi mới cài phần còn lại trong `requirements.txt`.
-Đồng bộ model:
-```powershell
-.\venv\Scripts\python HVU_QA_tool.py --skip-run
-```
-Chạy app:
-```powershell
-.\venv\Scripts\python main.py
-```
-Mặc định ứng dụng chạy tại `http://127.0.0.1:5000`.
-## 5. Cách dùng B - Standalone tool chỉ với một file
-Đây là cách phù hợp cho **người dùng cuối** chỉ muốn chạy mô hình sinh câu hỏi mà không cần tải full source code.
-Bạn chỉ cần đặt `HVU_QA_tool.py` trong một thư mục trống, rồi chạy:
-```powershell
-python HVU_QA_tool.py
-```
-Launcher sẽ tự động:
-1. kiểm tra xem thư mục hiện tại có full project hay không
-2. nếu không có full project, tự tạo `HVU_QA_runtime/`
-3. tự tạo `.hvu_qa_tool_venv/` nếu máy chưa chạy trong virtualenv
-4. tự cài dependency runtime còn thiếu
-5. tải model từ Hugging Face
-6. chạy ứng dụng web trong runtime vừa tạo
-Nguồn model mặc định:
-- Dataset repo: `DANGDOCAO/GeneratingQuestions`
-- Revision: `main`
-- Thư mục model từ repo: `HVU_QA/t5-viet-qg-finetuned/`
-Launcher tự bỏ qua các checkpoint train để tránh tải dữ liệu không cần thiết cho người dùng cuối. Trong lúc đồng bộ model, launcher hiển thị:
-- tiến độ theo từng file, ví dụ `[3/14] Đang tải ...`
-- thanh progress tổng theo phần trăm
-Lưu ý:
-- lần đầu chạy cần có Internet
-- nếu đang dùng standalone tool, launcher **không cần** `main.py`, `backend/`, `frontend/` hay `requirements.txt` có sẵn bên cạnh nó
-- `--best-model-only` chỉ dùng được khi repo trên Hugging Face thật sự có thư mục `best-model`
-Ví dụ:
-```powershell
-python HVU_QA_tool.py --device cpu
-python HVU_QA_tool.py --host 127.0.0.1 --port 5000
-python HVU_QA_tool.py --force-download
-python HVU_QA_tool.py --skip-run
-python HVU_QA_tool.py --no-browser
-python HVU_QA_tool.py --prepare-runtime-only
-python HVU_QA_tool.py --force-standalone-runtime
-python HVU_QA_tool.py --runtime-dir MyRuntime
-python HVU_QA_tool.py --no-venv
-```
-Các tuỳ chọn chính:
-- `--repo-id`: đổi repo Hugging Face nếu cần
-- `--revision`: chọn branch, tag hoặc commit hash
-- `--device auto|cpu|cuda`: ép thiết bị chạy model
-- `--force-download`: tải lại model và ghi đè file local
-- `--skip-download`: bỏ qua bước tải model từ Hugging Face
-- `--skip-install`: không tự cài dependency còn thiếu
-- `--skip-run`: chỉ chuẩn bị model và môi trường, không mở app
-- `--prepare-runtime-only`: chỉ dựng runtime, không tải model, không chạy app
-- `--force-standalone-runtime`: ép launcher dùng runtime standalone kể cả khi đang đứng trong full project
-- `--force-runtime-refresh`: ghi đè lại các file runtime nhúng trong launcher
-- `--runtime-dir`: đổi thư mục runtime standalone
-- `--no-venv`: không tự tạo virtualenv riêng cho launcher
-## 6. Notebook hướng dẫn
-Mở file:
-```text
-HVU_QA_end_to_end_guide.ipynb
-```
-Notebook hiện đã tách rõ:
-- `Phần A - Full project`
-- `Phần B - Chạy nhanh bằng tool`
-Phần `Quick tool` trong notebook mô phỏng đúng trường hợp chỉ có `HVU_QA_tool.py`.
-## 7. Biến môi trường hữu ích
-Bạn có thể cấu hình trước khi chạy:
-```powershell
-$env:HVU_HOST = "127.0.0.1"
-$env:HVU_PORT = "5000"
-$env:HVU_DEBUG = "0"
-$env:HVU_OPEN_BROWSER = "1"
-$env:HVU_MODEL_DIR = "t5-viet-qg-finetuned"
-$env:HVU_TASK_PREFIX = "sinh câu hỏi"
-$env:HVU_DEVICE = "auto"      # auto | cpu | cuda
-$env:HVU_CPU_THREADS = "8"
-$env:HVU_GPU_DTYPE = "auto"   # auto | float16 | bfloat16 | float32
-$env:HVU_MAX_SOURCE_LENGTH = "512"
-$env:HVU_MAX_NEW_TOKENS = "64"
-.\venv\Scripts\python main.py
-```
-Ý nghĩa nhanh:
-- `HVU_DEVICE=auto`: tự chọn `cuda` nếu có GPU, ngược lại dùng `cpu`
-- `HVU_OPEN_BROWSER=0`: không tự mở trình duyệt
-- `HVU_MODEL_DIR`: đổi thư mục model mặc định của backend
-- `HVU_TASK_PREFIX`: đổi tiền tố prompt đưa vào model
-- `HVU_CPU_THREADS`: giới hạn số luồng khi chạy CPU
-## 8. Cách dùng giao diện full project
-Sau khi mở web:
-1. Nhập hoặc dán đoạn văn bản vào ô nhập.
-2. Tăng `Số câu hỏi` từ `1` trở lên.
-3. Nếu cần, chọn model ở thanh bên.
-4. Nhấn `Sinh câu hỏi`.
-Giao diện full project hiện có thêm:
-- `Lịch sử`: lưu các lần sinh câu hỏi gần đây trong `localStorage`
-- `Ví dụ mẫu`: chèn nhanh văn bản luật mẫu để thử
-- `Trạng thái model`: hiển thị model đang dùng và thiết bị xử lý
-- `Tác giả`: thông tin nhóm thực hiện
-## 9. Nhập bằng giọng nói
-Mic trên giao diện full project dùng `Web Speech API` của trình duyệt, không ghi file âm thanh cục bộ.
-Lưu ý:
-- nên dùng Chrome hoặc Edge
-- chỉ hoạt động tốt trên `https://...` hoặc `http://localhost`
-- cần cấp quyền micro cho trình duyệt
-## 10. Model đang được hỗ trợ
-Backend full project tự dò model khả dụng trong thư mục project.
-Hiện logic đang hỗ trợ:
-- thư mục model gốc có `config.json`
-- model lồng bên trong `best-model/`
-- model lồng bên trong `final-model/`
-Ví dụ với project hiện tại, dropdown thường sẽ thấy:
-- `t5-viet-qg-finetuned`
-- `best-model`
-## 11. Chạy bằng dòng lệnh
-Bạn có thể sinh câu hỏi trực tiếp mà không cần mở web:
-```powershell
-.\venv\Scripts\python generate_question.py --text "Cơ sở giáo dục đại học có nhiệm vụ đào tạo, nghiên cứu khoa học và phục vụ cộng đồng." --num_questions 5 --output_format text
-```
-Đọc từ file:
-```powershell
-.\venv\Scripts\python generate_question.py --input_file input.txt --num_questions 5 --output_format json
-```
-Một số tham số thường dùng:
-- `--model_dir`
-- `--task_prefix`
-- `--num_questions`
-- `--device auto|cpu|cuda`
-- `--cpu_threads`
-- `--gpu_dtype auto|float16|bfloat16|float32`
-- `--max_source_length`
-- `--max_new_tokens`
-## 12. API backend
-### `GET /api/info`
-Trả về:
-- tiêu đề hệ thống
-- model đang chọn
-- danh sách model khả dụng
-- trạng thái thiết bị và việc model đã được load hay chưa
-### `POST /api/model`
-Dùng để đổi model đang hoạt động.
-Body mẫu:
-```json
-{
-  "model_id": "t5-viet-qg-finetuned/best-model"
-}
-```
-### `POST /api/generate`
-Dùng để sinh câu hỏi từ văn bản.
-Body mẫu:
-```json
-{
-  "model_id": "t5-viet-qg-finetuned/best-model",
-  "text": "Cơ sở giáo dục đại học có nhiệm vụ tổ chức đào tạo, nghiên cứu khoa học và phục vụ cộng đồng.",
-  "num_questions": 5
-}
-```
-Response thành công sẽ chứa:
-- `ok`
-- `text`
-- `num_questions`
-- `questions`
-- `formatted`
-- `elapsed_ms`
-- `model_name`
-- `selected_model_id`
-- `meta`
-## 13. Fine-tune model
-Nếu muốn huấn luyện lại model, dùng `fine_tune_qg.py`.
-Ví dụ:
-```powershell
-.\venv\Scripts\python fine_tune_qg.py --device cpu --output_dir t5-viet-qg-finetuned-cpu
-```
-Hoặc với GPU:
-```powershell
-.\venv\Scripts\python fine_tune_qg.py --device cuda --fp16 --gradient_checkpointing --output_dir t5-viet-qg-finetuned
-```
-Một số tham số nên biết thêm khi fine-tune:
-- `--model_name`
-- `--validation_file`
-- `--resume_from_latest` hoặc `--resume_checkpoint`
-- `--min_free_gpu_mb`
-- `--skip_gpu_preflight`
-- `--use_first_answer_only`
-- `--require_answer_in_context`
-## 14. Một số lỗi thường gặp
-Thiếu thư viện Python:
-- kích hoạt lại `venv`
-- chạy lại `python -m pip install -r requirements.txt`
-Không kích hoạt được `venv` trên PowerShell:
-- chạy `Set-ExecutionPolicy -Scope Process Bypass`
-- rồi chạy lại `.\venv\Scripts\Activate.ps1`
-Không tải được model từ Hugging Face:
-- kiểm tra lại Internet
-- kiểm tra repo `DANGDOCAO/GeneratingQuestions` còn public
-- thử chạy lại với `--force-download`
-Không thấy model trong dropdown:
-- kiểm tra thư mục `t5-viet-qg-finetuned/` có `config.json`
-- kiểm tra lại cấu trúc `best-model/` hoặc `final-model/`
-- restart server sau khi thêm model mới
-Mic không hoạt động:
-- dùng Chrome hoặc Edge
-- cấp quyền micro
-- chạy bằng `localhost` hoặc `https`
-Sinh câu hỏi chậm:
-- lần chạy đầu có thể chậm do model đang được load
-- nếu máy không có GPU, app sẽ chạy bằng CPU
-## 15. Ghi chú
-- Lịch sử full project được lưu ở trình duyệt, không dùng cơ sở dữ liệu.
-- Standalone tool dùng runtime tối thiểu để chạy nhanh cho người dùng cuối, không thay thế toàn bộ source code phát triển.