Skip to content

Commit 0d2cebc

Browse files
committed
Document Suggestion Quality column in speller tables
Add explanation of the S (Suggestion Quality) badge that shows: - First%: percentage where correct word is first suggestion - Top5%: percentage where correct word is in top 5 - Tests: number of typo test cases evaluated Include color-coded quality thresholds (green/yellow/red/black) with direct link to source code where thresholds are defined.
1 parent 0bc11fb commit 0d2cebc

1 file changed

Lines changed: 12 additions & 0 deletions

File tree

proof/spelling/SpellerOverview.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,18 @@ Being in the **Production** group means the speller has been tested and is consi
2424

2525
This objective classification ensures transparency and gives language teams clear upgrade criteria.
2626

27+
**Suggestion Quality (S):** The tables below include a "Suggestion Quality" column showing how well each spellchecker provides correct spelling suggestions. The badge displays three values: **First% | Top5% | Tests**
28+
29+
- **First%**: Percentage of typos where the correct word is the first suggestion
30+
- **Top5%**: Percentage of typos where the correct word is in the top 5 suggestions
31+
- **Tests**: Number of typo test cases evaluated (formatted as "k" for thousands)
32+
33+
Badge colors indicate overall quality based on [these thresholds](https://github.com/giellalt/giella-core/blob/main/scripts/make-spellerbadge-json.sh#L84-L97):
34+
- 🟢 **Green** (good): First ≥ 80% AND Top5 ≥ 90% AND Tests ≥ 1000
35+
- 🟡 **Yellow** (medium): First ≥ 60% AND Top5 ≥ 70% AND Tests ≥ 500
36+
- 🔴 **Red** (poor): First ≥ 40% AND Top5 ≥ 50% AND Tests ≥ 100
37+
-**Black** (very poor): Below red thresholds
38+
2739
## [![Maturity: Production](https://img.shields.io/badge/Maturity-Production-brightgreen.svg)](../../MaturityClassification.html) Production
2840

2941
<div id="prod_spellers" ></div>

0 commit comments

Comments
 (0)