Emmio is an experimental project focused on language learning. It provides learning and testing algorithms:
The project manages four kinds of artifacts:
Requires Python 3.12 or later.
pip install git+https://github.com/enzet/emmioTo run Emmio, simply execute
emmioYou can specify a data directory with the --data option and a username with
the --user option. If not specified, the data directory defaults to
~/.emmio and the username defaults to your current system username.
> lexicon
The algorithm randomly presents words from the target language (weighted by frequency). For each word, you need to indicate
- whether you know at least one meaning of this word (press y or Enter),
- whether you don’t know any meaning of the word (press n),
- whether the word is commonly used as a proper name or isn’t valid (press -).
Press q to finish.
After completion, the algorithm provides a non-negative number called rate, that indicates your vocabulary level. A score of 0 means you don’t know any words in the language, while infinity means you know every word in the frequency list. This rate is most useful for tracking your learning progress and comparing vocabulary levels between different users using the same frequency list.
There is no upper limit for the rate, if you know meanings of all words in a language, the rate is infinity. It’s finite though, if you don’t know meaning of at least one word.
Column “Don’t understand” means how much you don’t understand of an arbitrary text. Column “Understand” means how much you understand of an arbitrary text.
| Rate | Don’t understand | Understand | Level * |
|---|---|---|---|
| 10 | 0.10 % | 99.90 % | |
| 9 | 0.20 % | 99.80 % | |
| 8 | 0.39 % | 99.61 % | C2 |
| 7 | 0.78 % | 99.22 % | C1 |
| 6 | 1.56 % | 98.44 % | B2 |
| 5 | 3.12 % | 96.88 % | B1 |
| 4 | 6.25 % | 93.75 % | A2 |
| 3 | 12.50 % | 87.50 % | A1 |
| 2 | 25.00 % | 75.00 % | |
| 1 | 50.00 % | 50.00 % | |
| 0 | 100.00 % | 0.00 % |
* Level is a very rough approximation of a level of the Common European Framework of Reference for Languages. Please, don't take it as a strict definition.
In order to run lexicon checking, simply execute lexicon command or
lexicon <language> command, where <language> is 2-letters ISO 639-1 language
code.
frequency list idis an identifier of full frequency file. Important: for Lexicon you can use only full (not stripped) frequency list.
Emmio data directory is located by default in ~/.emmio and contains all
downloaded artifacts and their configuration files and collected user data.
dictionaries— single word translations.sentences— whole sentence translations.lists— frequency and word lists.audio— audio files with word pronunciations.users— user data.<user name>config.json— user configuration file.learn— user learning process data.lexicon— user lexicon checking data.
Dictionaries are entities that provide definitions and translations for single
words. Artifacts are controlled by configuration file
dictionaries/config.json.
Emmio supports:
- dictionaries stored in JSON files,
- English Wiktionary (through Kaikki.org website, containing dictionaries extracted from English Wiktionary using wiktextract).
Sentences are example parts of texts in one language, translated into another
language. Artifacts are controlled by configuration file
sentences/config.json.
Frequency list is a relation between unique words and the number of their
occurrences in some text or a corpus of texts. Some frequency lists are
stripped (e.g. 6,500-lemma list based on the New Corpus for Ireland). Lists
are controlled by configuration file lists/config.json.
Emmio supports:
- word lists stored in text files,
- FrequencyWords (Hermit Dave’s project, which contains full and stripped frequency lists extracted from subtitles in Opensubtitles project).
Wiktionary project contains frequency lists for different languages.
Before contributing, please follow these steps:
- Install development dependencies with
pip install -e .[dev]. - Enable Git hooks with
git config core.hooksPath .githooks.