Minor documentation updates
[szyfrow.git] / szyfrow / language_model_files / __init__.py
1 """Descriptions of English, used for building language models.
2
3 Language models are for understanding what English looks like, for help with
4 cipher breaking.
5
6 * `count_1l.txt`: counts of single letters
7 * `count_2l.txt`: counts of pairs letters, bigrams
8 * `count_3l.txt`: counts of triples of letters, triagrams
9 * `words.txt`: a dictionary of words, used for keyword-based cipher breaking.
10 These words should only contain characters cointained in
11 `string.ascii_letters`.
12
13 See [`szyfrow/language_models`](../support/language_models.html) for how these files are used.
14 """