Project Files
docs / README.md
User-facing documentation lives in the top-level README. This folder is for contributors and for future-me.
| File | What it covers |
|---|---|
| DESIGN.md | Architecture, invariants, the three core decisions (validation-first, RTL replacement, normalisation-for-coreference). |
| DETECTORS.md | Per-type detection algorithms (Luhn, NIR mod-97 with Corsica, IBAN mod-97, French TEL, EMAIL) and their boundary rules. |
| EVALUATION.md | AI4Privacy FR evaluation methodology, label mapping, span matching, full results table, and what the numbers mean. |
| LICENSING.md | Provenance and licence of every external artefact under datasets/ and of the NIR fixtures embedded in tests. |
| ROADMAP.md | Known limitations and the order we plan to address them. |