Started on documentation

[szyfrow.git] / szyfrow / language_model_files / __init__.py

diff --git a/szyfrow/language_model_files/__init__.py b/szyfrow/language_model_files/__init__.py
index e69de29bb2d1d6434b8b29ae775ad8c2e48c5391..1a491aea037339ecf712a80e17a6ef79daff29cf 100644 (file)
--- 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