Describe the network

README.md

@@ -1,3 +1,42 @@
 ---
 license: mit
 ---
+
+# Sumerian and Akkadian Cuneiform Language Translator
+
+This is a translation network that understands Sumerian and Akkadian languages written in cuneiform.
+
+It was trained on cuneiform transcribed in the CDLI ATF format. For example:
+
+```text
+translate Akkadian to English: 1(disz){d}szul3-ma-nu-_sag man gal?_-u2 _man_ dan-nu _man kisz_
+```
+
+The network was trained to translate between the ancient languages:
+
+* Akkadian
+* Sumerian
+
+and the modern languages:
+
+* English
+* French
+* German
+* Italian
+* Spanish
+
+The training data contains, primarily, English translations so those translations are best.
+
+The network was trained on prompts such as:
+
+* `translate Akkadian to English: `
+* `translate German to Sumerian: `
+* `translate Akkadian to Italian: `
+
+
+## Limitations
+
+It was *not* trained to translate between the ancient languages but it is capable of it
+(`translate Sumerian to Akkadian: `). Buyer beware.
+
+Its vocabulary does not include ā, ḫ, ī, ř, š, ṣ, or ū so those letters are replaced with the unadorned letter (or "sh" in the case of š and ṣ).