CLAUDE.md

CLAUDE.md — SIFQ Project Guide

Mục đích file này

Đây là file hướng dẫn chính cho Claude khi làm việc trong repo này. Đọc file này trước mọi thay đổi code.

---

Research Goal (KHÔNG phải NFIQ2)

SIFQ xây dựng sensor-invariant fingerprint quality score — tương quan với khả năng matching hiện đại (MDGT/DINOv2), không phụ thuộc vào sensor acquisition.

Định nghĩa quality: Utility for recognition/matching. Ảnh đẹp nhưng matcher không match được = quality thấp.

---

Trước khi sửa code — BẮT BUỘC đọc:

1. rules/HOWTO_RUN.md — lịch sử version, lệnh chạy, trạng thái hiện tại
2. rules/SIFQ_explained.md — kiến trúc đầy đủ, loss functions, training dynamics
3. rules/plan.md — active experiments, code change log, decision log, revert cookbook
4. rules/sifq_pdf.txt — paper gốc, research design, evaluation protocol (đọc khi cần verify design)

Sau khi sửa code / chạy eval: cập nhật plan.md TRƯỚC, sau đó cập nhật các file còn lại.

---

Cấu trúc repo và ý nghĩa từng file

src/models/ — Model components

File	Ý nghĩa	Input → Output
backbone.py	TinyViT-5M encoder, grayscale 224×224	[B,1,224,224] → [B,320] (pooled) hoặc [B,196,320] (spatial)
concept_head.py	Dự đoán 6 concept quality scores	Legacy: [B,320]→[B,6]; Spatial (v27+): [B,196,320]→[B,6]
aggregator.py	Tổng hợp concepts → scalar Q	[B,6] → [B,1] ∈ [0, 100]
sensor_discriminator.py	Phân biệt sensor (bị GRL đảo ngược để xóa sensor info)	[B,320] → [B,N_sensors]
grad_reverse.py	Gradient Reversal Layer (DANN)	forward: identity; backward: × −λ
sifq.py	Wrapper ghép 4 components trên	[B,1,224,224] → dict {score, concepts, sensor_logits, features}

6 Concepts (tất cả đều: cao = chất lượng tốt):

0: orientation_coherence   — ridge flow nhất quán
1: ridge_valley_clarity    — ranh giới ridge-valley sắc nét
2: continuity              — ridge line không bị đứt
3: noise_level             — ít noise (CAO = ít noise = tốt)
4: contrast_uniformity     — contrast đều trong foreground
5: minutiae_reliability    — minutiae đáng tin cậy

Lưu ý quan trọng về ConceptHead:

• ConceptHead (legacy, v16–v26): nhận pooled vector [B,320] — mất spatial info
• SpatialConceptHead (v27+, --spatial-concept-head): nhận [B,196,320] — mỗi concept có projection riêng biệt trên 14×14 token map
• SIFQ.forward() tự dispatch qua concept_head.uses_spatial — backward-compatible

---

src/losses/ — Loss functions

File	Loss	Vai trò
matcher_teacher.py	L_mat	Q phải tương quan với MDGT embedding quality (Huber, raw cosine target — NO stats normalization)
sensor_invariance.py	L_sens	Q phải giống nhau khi cùng ngón tay ở 2 sensor khác nhau (hinge pair + GRL adversarial)
degradation_ranking.py	L_deg	Q phải giảm khi ảnh bị degraded (ranking + concept monotonicity)
orthogonality.py	L_ortho	Ngăn 6 concepts hoàn toàn redundant (Frobenius² off-diagonal corr)
total_loss.py	Helper	Tổng hợp tất cả losses

DEGRADATION_CONCEPT_MAP (T39 — hiện tại):

"blur":      [1, 2]         # clarity↓, continuity↓
"noise":     [3]            # noise_level↓
"jpeg":      [2, 1]         # continuity↓, clarity↓
"occlusion": [5]            # minutiae_reliability↓ only
"dry_skin":  [4, 2, 0]      # contrast↓, continuity↓, orient_coh↓
"wet_press": [1, 5, 0]      # clarity↓, minutiae↓, orient_coh↓

KHÔNG thay đổi concept map khi chưa verify root cause. v25 collapse từ gamma=1.5, không phải từ T40 concept map.

---

src/data/ — Dataset loaders

File	Dataset	Vai trò trong training
nist302_loader.py	SD302-A/B/D	L_sens + L_mat (cross-sensor pairs chính)
fvc_loader.py	FVC2002/2004	L_mat + L_deg (genuine quality variation)
polyu_loader.py	PolyU contact/contactless	L_sens ONLY (cross-modality hardest pairs)
degradation.py	—	DegradationPipeline: 6 types × 4 levels
pair_builder.py	—	Build cross-sensor pairs cho L_sens
cross_sensor_sampler.py	—	ĐÃ BIẾT BUG: k_cross>0 phá quality discrimination → dùng k_cross=0

Sensor exclusions (bắt buộc): R_1000_slap, R_500_slap, S_500_slap — non-segmented slap, tạo score cluster ~21 → phá KS metric.

FVC-only L_deg — không apply L_rank lên SD302: SD302 ảnh đều chất lượng cao → clean images tạo single attractor (v20 root cause). FVC có genuine quality variation → MDGT cosine actually varies → L_mat gradient có signal → transfers to SD302 at inference.

---

src/training/ — Training utilities

File	Ý nghĩa
mdgt_teacher.py	Load DINOv2+TRAM teacher frozen, compute embeddings
stage_scheduler.py	α/β/γ schedule qua 4 stages (S1→S4), GRL λ warm-up

Stage schedule hiện tại:

S1  (ep 0–9):   α=0.10, β=0.00, γ=1.00  — bootstrap từ degradation
S2  (ep 20–34): α=0.30, β=0.30, γ=0.60  — balanced, β/α = 1.0
S3+ (ep 40+):   α=0.25, β=0.35, γ=0.50  — sensor pressure > matcher

Critical: γ (concept-deg-gamma) phải = 2.0. gamma=1.5 (v25) quá yếu → spread spikes 0.003→0.028 trong S1→S2 ramp → collapse.

---

src/evaluation/ — Evaluation

File	Track	Metric
erc.py	Track 1	AUC_ERC — thấp hơn = tốt hơn
sensor_invariance.py	Track 2	KS statistic (↓) + Pearson (↑) giữa sensors
concept_grounding.py	Track 4	Spearman ρ crosstalk matrix — diagonal-heavy = tốt

Target KPIs (baseline v24):

Track 2 KS:      ≤ 0.126   (v24: 0.1263 ✅)
Track 2 Pearson: ≥ 0.80    (v24: 0.8004 ✅)
Track 4 diag:    ρ ≤ −0.40 cho target concepts
q_std inference: ≥ 15      (v24: ~22)

---

scripts/ — Training & eval scripts

File	Dùng cho
train_sifq.py	Main training entrypoint (argparse đầy đủ)
run_train_vXX.sh	Launch training version XX
run_eval_vXX.sh	Inference + Track 2 + Track 4 + milestones cho version XX
run_eval.py	Eval runner (Track 2, Track 4, ERC)
run_infer.py	Inference → sifq_scores_vXX.jsonl
run_smoke.sh	Smoke test pipeline ~2 phút

Architecture detection từ checkpoint: run_infer.py và run_eval.py đọc ckpt["config"]["spatial_concept_head"] → tự chọn ConceptHead hay SpatialConceptHead. Không cần flag thủ công khi eval.

---

rules/ — Documentation

File	Đọc khi nào
HOWTO_RUN.md	Cần chạy training/eval, xem version history
SIFQ_explained.md	Cần hiểu architecture, loss mechanics, dynamics
plan.md	Mỗi lần sửa code — xem active experiments, ghi change log, tham khảo revert cookbook
sifq_pdf.txt	Cần verify design decision với paper gốc

---

checkpoints/vXX/ — Saved models

last.pt   — checkpoint cuối epoch, dùng cho eval
best.pt   — checkpoint best metric (nếu có)

Checkpoint chứa {"epoch", "model", "optimizer", "scheduler", "metrics", "config"}. config = vars(args) → reproducible và dùng để detect architecture.

---

eval_results/ — Evaluation outputs

sifq_scores_vXX.jsonl          — inference output (image path, score, concepts, sensor_id)
vXX/results_track2_sensor.json — KS + Pearson per sensor pair
vXX/results_track4_concepts.json — Spearman ρ crosstalk matrix
vXX/plot_sensor_hist.png       — Q distribution per sensor
vXX/plot_crosstalk.png         — concept grounding heatmap
vXX/milestone_samples.png      — sample images at Q=10,20,...,90

---

Version History (tóm tắt)

Version	KS ↓	Pearson ↑	q_std	Status
v14	0.263	0.294	~15	✅ First working
v22	0.278	0.546	—	✅ Improved Pearson
v24	0.126	0.800	~22	✅ Best so far
v25	0.213	0.620	~20	❌ gamma=1.5 too weak
v26	—	—	—	🚀 Training (gamma=2.0 restored)
v27	—	—	—	⏳ Pending (SpatialConceptHead)

---

Các bẫy đã biết — KHÔNG lặp lại

1. Score collapse

Triệu chứng: q_std < 1.0 khi inference, KS thấp nhưng là false positive, Pearson ≈ 0. Root causes đã gặp:

• --proto-max-batches > 0: partial prototypes → sensor-biased L_mat → no quality gradient
• --deg-include-sd302: L_rank trên clean SD302 → single attractor ~53 satisfying L_rank
• --k-cross > 0: over-constrains L_sens → destroys quality discrimination
• --concept-deg-gamma < 2.0: spread spikes trong S1→S2 ramp → model không recover

2. Concept inversion

Triệu chứng: Spearman ρ dương (tăng) khi degradation tăng — sai chiều. Root cause: Concept head bị stuck gần 0 hoặc 1. Không còn dư địa respond. Fix: Không thay đổi concept map trước khi debug loss dynamics.

3. KS metric misleading

Khi tất cả sensors output cùng score (~53), KS giữa distributions trivially thấp. Luôn kiểm tra q_std và Pearson song song với KS.

4. sensor_leakage

Đừng để sensor_id lọt vào training signal qua: filename pattern, prototype window bias, fixed batch ordering.

5. --no-mat-stats là bắt buộc

Per-identity cosine stats (T31) gây FVC/SD302 asymmetry → v17 collapse. Luôn dùng --no-mat-stats.

---

Kết quả mong đợi của một run thành công

Training log (60 epochs) nên có dynamics:

ep 0–9  (S1):  q_std tăng từ ~0 lên ~18–22; l_deg giảm; l_sens ≈ 0 (β=0)
ep 10–19 (ramp): spread stable ≤ 0.005; q_std không giảm dưới 15
ep 20+  (S2):  l_pair → 0.003–0.008; q_std stable 18–24; l_mat converging
ep 40+  (S3):  l_deg ≈ 0.10 (margin floor); stable equilibrium

Eval sau training:

KS    ≤ 0.15        (v24 baseline: 0.126)
Pearson ≥ 0.75      (v24 baseline: 0.800)
q_std inference ≥ 15
Track 4: blur→clarity ρ < −0.30, noise→noise_level ρ < −0.30

---

Subagents

Spawn subagents để isolate context, parallelize, hoặc offload bulk mechanical tasks.

• Haiku: bulk mechanical work, no judgment
• Sonnet: scoped research, code exploration, subtasks cần planning/tradeoffs

Parent owns final output. User instructions override.

---

Coding Standards

• Không hardcode paths — dùng REPO_ROOT relative
• Hyperparameters trong argparse / yaml config — không embed trong code
• Modular: dataset logic tách khỏi training loop
• Reproducibility: set random seeds, log config, save checkpoint với config=vars(args)
• Sensor leakage: filename → không dùng làm sensor label trực tiếp

---

Sau mỗi thay đổi — BẮT BUỘC (theo thứ tự)

1. rules/plan.md — ghi vào Code Change Log: files changed, lý do thay đổi, cách revert, backward compatibility
2. rules/SIFQ_explained.md — cập nhật kiến trúc, loss mechanics, dynamics nếu có thay đổi
3. rules/HOWTO_RUN.md — cập nhật version table, lệnh chạy nếu có version mới

Quy tắc ghi plan.md:

• Mỗi lần tạo run_train_vXX.sh mới → thêm entry vào Active Experiments
• Mỗi lần sửa code (model, loss, data, training) → thêm entry vào Code Change Log với:
  • Ngày thay đổi
  • Files changed (danh sách đầy đủ)
  • Root cause / lý do
  • Cách revert (lệnh hoặc diff cụ thể)
• Mỗi lần eval xong → cập nhật status của experiment tương ứng trong Active Experiments
• Mỗi khi phát hiện decision mới → thêm vào Decision Log