X-Git-Url: https://git.njae.me.uk/?a=blobdiff_plain;ds=sidebyside;f=szyfrow%2Flanguage_model_files%2F__init__.py;h=1a491aea037339ecf712a80e17a6ef79daff29cf;hb=b535d9d75e69cc395e8de28c99e38564655e5ac9;hp=e69de29bb2d1d6434b8b29ae775ad8c2e48c5391;hpb=f19a021eabb3222709b9d513839a14c01cfdfd38;p=szyfrow.git

diff --git a/szyfrow/language_model_files/__init__.py b/szyfrow/language_model_files/__init__.py
index e69de29..1a491ae 100644
--- a/szyfrow/language_model_files/__init__.py
+++ b/szyfrow/language_model_files/__init__.py
@@ -0,0 +1,14 @@
+"""Descriptions of English, used for building language models. 
+
+Language models are for understanding what English looks like, for help with 
+cipher breaking.
+
+* `count_1l.txt`: counts of single letters
+* `count_2l.txt`: counts of pairs letters, bigrams
+* `count_3l.txt`: counts of triples of letters, triagrams
+* `words.txt`: a dictionary of words, used for keyword-based cipher breaking.
+  These words should only contain characters cointained in 
+  `string.ascii_letters`.
+
+See [`szyfrow/language_models`](../support/language_models.html) for how these files are used.
+"""
\ No newline at end of file