Hugging Face's logo

Spaces:
phucsd
/
cham-ocr-studio
Running

App Files Community
phucsd commited on
Commit
4873906
·
verified ·
1 Parent(s): e3c573d

Upload README.md with huggingface_hub

Browse files
Files changed (1) hide show
  1. README.md +41 -29
README.md CHANGED
@@ -8,47 +8,59 @@ app_port: 7860
8
  pinned: false
9
  ---
10
 
11
- # Dự án Nhận diện Chữ viết tiếng Chăm (Cham OCR)
12
 
13
- Chào mừng bạn đến với dự án **Cham-OCR**. Dự án đã được dọn dẹp và phân loại cấu trúc thư mục rõ ràng thành hai phần chính:
14
 
15
- ## 📁 Cấu trúc thư mục phân loại
16
 
17
  ```
18
  Cham-OCR/
19
- ├── ocr_training/ # 1. Dự án Huấn luyện OCR (Kaggle Pipeline)
20
- │ ├── paddleocr_cham_finetune.ipynb # Notebook chạy chính trên Kaggle
 
 
 
 
 
 
 
 
21
  │ ├── configs/ # Các file cấu hình YAML huấn luyện
22
- │ ├── scripts/ # Scripts sinh dữ liệu & tiền xử lý
23
- │ ├── data/ # Dữ liệu huấn luyện (fonts, corpus, raw images)
24
- │ ├── tests/ # Các bài kiểm thử & đánh giá mô hình
25
  │ └── README_TRAINING.md # Hướng dẫn chi tiết quy trình huấn luyện
26
  │
27
- ├── ocr_webapp/ # 2. Dự án Web App Test OCR (Diagnostic Studio)
28
- │ ├── app.py # Giao diện chẩn đoán suy luận cục bộ
29
- │ ├── PaddleOCR/ # Bản sao codebase PaddleOCR để inference
30
- │ ├── data/ # Dữ liệu suy luận (inference models, dictionaries)
31
- │ └── README_WEBAPP.md # Hướng dẫn chi tiết cách chạy Web App cục bộ
32
- │
33
- └── archive/ # 3. Lưu trữ tài nguyên cũ & Logs
34
- ├── logs/ # Các tệp nhật ký cũ (.log, .jsonl)
35
- ├── handoffs/ # Gói dữ liệu bàn giao zip cũ
36
- └── experimental/ # Thư mục và tệp thử nghiệm cũ
37
  ```
38
 
39
  ---
40
 
41
- ## 🚀 Lựa chọn Nhanh
42
 
43
- ### A. Nếu bạn muốn Huấn luyện / Fine-tune mô hình mới:
44
- 1. Di chuyển vào thư mục [ocr_training/](file:///e:/Phuc's Data/Github/Cham-OCR/ocr_training/).
45
- 2. Đọc tài liệu chi tiết tại [ocr_training/README_TRAINING.md](file:///e:/Phuc's Data/Github/Cham-OCR/ocr_training/README_TRAINING.md).
46
- 3. Sử dụng notebook [paddleocr_cham_finetune.ipynb](file:///e:/Phuc's Data/Github/Cham-OCR/ocr_training/paddleocr_cham_finetune.ipynb) để chạy trên Kaggle GPU.
47
-
48
- ### B. Nếu bạn muốn Chạy thử nghiệm nhận diện / Chẩn đoán lỗi OCR cục bộ:
49
- 1. Di chuyển vào thư mục [ocr_webapp/](file:///e:/Phuc's Data/Github/Cham-OCR/ocr_webapp/).
50
- 2. Đọc tài liệu chi tiết tại [ocr_webapp/README_WEBAPP.md](file:///e:/Phuc's Data/Github/Cham-OCR/ocr_webapp/README_WEBAPP.md).
51
- 3. Khởi chạy studio chẩn đoán thông qua tập lệnh:
 
52
  ```bash
53
- python ocr_webapp/app.py
54
  ```
 
 
 
 
 
 
 
 
8
  pinned: false
9
  ---
10
 
11
+ # Dự án Nhận diện Chữ viết tiếng Chăm (Cham-OCR Monorepo)
12
 
13
+ Dự án nghiên cứu, huấn luyện và chẩn đoán nhận diện chữ viết tiếng Chăm (Akhar Thrah & West Cham) dựa trên nền tảng PaddleOCR PP-OCRv4 Multilingual. Cấu trúc mã nguồn được phân định rõ ràng thành hai phân hệ độc lập:
14
 
15
+ ## 📁 Cấu trúc Thư mục Dự án
16
 
17
  ```
18
  Cham-OCR/
19
+ ├── ocr-studio/ # 1. Giao diện Chẩn đoán & Review OCR (Diagnostic Studio)
20
+ │ ├── app.py # Backend HTTP Server & Multi-Crop Orchestrator
21
+ │ ├── index.html # Giao diện Studio Warm Light Theme
22
+ │ ├── start_studio.py # Script chạy nhanh giao diện
23
+ │ ├── data/ # Dictionaries & Model inference (v23, v22, v21, v18)
24
+ │ ├── PaddleOCR/ # Codebase inference PaddleOCR
25
+ │ └── README_STUDIO.md # Hướng dẫn chi tiết sử dụng Studio
26
+ │
27
+ ├── ocr-training/ # 2. Pipeline Huấn luyện & Fine-tune Mô hình (Kaggle Pipeline)
28
+ │ ├── paddleocr_cham_finetune.ipynb # Notebook chính chạy trên Kaggle GPU T4x2
29
  │ ├── configs/ # Các file cấu hình YAML huấn luyện
30
+ │ ├── scripts/ # Scripts sinh dữ liệu tổng hợp & phẫu thuật trọng số
31
+ │ ├── data/ # Dữ liệu huấn luyện (fonts, corpus Chăm đã chuẩn hóa)
32
+ │ ├── tests/ # Bộ kịch bản kiểm thử & đánh giá CER/Accuracy
33
  │ └── README_TRAINING.md # Hướng dẫn chi tiết quy trình huấn luyện
34
  │
35
+ ├── Dockerfile # Dockerfile đóng gói và triển khai Web App Studio
36
+ ├── .dockerignore # Cấu hình loại trừ file khi đóng gói Docker
37
+ ├── .gitignore # Bộ lọc loại trừ file rác, file tạm và weights nặng
38
+ ├── DESIGN.md # Định nghĩa Design System Tokens cho Studio
39
+ ├── kernel-metadata.json # Kaggle Kernel Metadata (tài khoản gustavnguyen)
40
+ └── requirements.txt # Thư viện phụ thuộc cho toàn dự án
 
 
 
 
41
  ```
42
 
43
  ---
44
 
45
+ ## 🚀 Hướng dẫn Bắt đầu Nhanh
46
 
47
+ ### A. Chạy thử nghiệm nhận diện & Chẩn đoán OCR (Cham OCR Studio):
48
+ 1. Cài đặt các thư viện cần thiết:
49
+ ```bash
50
+ pip install -r requirements.txt
51
+ ```
52
+ 2. Khởi chạy studio chẩn đoán:
53
+ ```bash
54
+ python ocr-studio/app.py
55
+ ```
56
+ Hoặc chạy qua file khởi động nhanh:
57
  ```bash
58
+ python ocr-studio/start_studio.py
59
  ```
60
+ 3. Mở trình duyệt tại địa chỉ: `http://localhost:7860`
61
+ 4. Chi tiết tài liệu: xem tại [ocr-studio/README_STUDIO.md](ocr-studio/README_STUDIO.md).
62
+
63
+ ### B. Huấn luyện / Fine-tune mô hình mới trên Kaggle:
64
+ 1. Đọc hướng dẫn chi tiết tại [ocr-training/README_TRAINING.md](ocr-training/README_TRAINING.md).
65
+ 2. Sử dụng notebook [paddleocr_cham_finetune.ipynb](ocr-training/paddleocr_cham_finetune.ipynb) và đẩy lên Kaggle GPU thông qua Kaggle API hoặc giao diện web Kaggle.
66
+ 3. Dự án sử dụng tài khoản Kaggle: `gustavnguyen` với GPU T4x2 song song.