Skip to content

Commit

Permalink
📝 Add leaderboard page
Browse files Browse the repository at this point in the history
  • Loading branch information
astariul committed May 10, 2024
1 parent eb4d56b commit d00cafe
Showing 1 changed file with 22 additions and 0 deletions.
22 changes: 22 additions & 0 deletions docs/leaderboard.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# Leaderboard

[//]: # (A bit of explanation is required for this page)
[//]: # (There is a Mkdocs hook (defined in `docs/hooks.py`) that will read the content of this page, extract the path of result files listed here, read their content, and organize their score into a table)

| Keyboard | Score | Next-word prediction | Auto-completion | Auto-correction |
|---------:|:-----:|:--------------------:|:---------------:|:---------------:|
>>>Fleksy|results/fleksy.json
>>>iOS keyboard|results/ios.json
>>>KeyboardKit Open-source|results/keyboardkit_oss.json
>>>KeyboardKit Pro|results/keyboardkit_pro.json
!!! info
The metrics used in this leaderboard are :

* For next-word prediction : top-3 accuracy
* For auto-completion : top-3 accuracy
* For auto-correction : F-score

See [Understanding the metrics](how_testing_is_done.md#understanding-the-metrics) for more details.

The overall score is a _weighted sum_ of each task's score.

0 comments on commit d00cafe

Please sign in to comment.