WIP

README.md

@@ -7,8 +7,9 @@
 
 Easy Letters is a Python package that helps job seekers write application letters. A simple retrieval
 augmented generation (RAG) pipeline is used to generate the letters. The user can then edit the draft letter to suit
-their
-needs.
+their needs.
+
+See the `notebooks/README.md` file for how easy letters works.
 
 ## Installation
 

notebooks/README.md

@@ -0,0 +1,5 @@
+# Overview
+
+The diagram below shows the high-level workflow of how Easy Letters generates application letter drafts.
+
+![Easy Letters Workflow](assets/workflow.png)

notebooks/assets/workflow.dot

@@ -1,29 +1,57 @@
 digraph Elements {
     fontname = "Helvetica,Arial,sans-serif"
     layout = dot
-    node [fontname = "Helvetica,Arial,sans-serif", shape = box, style = filled, color = "lightblue", rounded = true, penwidth = 2]
-    edge [fontname = "Helvetica,Arial,sans-serif", color = "black"]
+    rankdir = LR
+    node [
+    fontname = "Helvetica,Arial,sans-serif",
+    shape = box,
+    style = "filled,rounded",
+    color = "lightblue",
+    fillcolor = "white",
+    penwidth = 2
+    ]
+    edge [
+    fontname = "Helvetica,Arial,sans-serif",
+    color = "black"
+    ]
 
+    subgraph cluster_0 {
+    label = "User Inputs"
+    style = "dashed"
+    color = "lightgrey"
     u [label = "User", fillcolor = "lightgreen"]
     q [label = "Job Description", fillcolor = "lightyellow"]
-    api [label = "Embedding Model", fillcolor = "lightpink"]
-    db [label = "Vector Database", fillcolor = "lightgrey"]
     als [label = "Existing Application Letters", fillcolor = "lightyellow"]
     ei [label = "Extra Instructions", fillcolor = "lightyellow"]
+    }
+
+    subgraph cluster_1 {
+    label = "Processing"
+    style = "dashed"
+    color = "lightgrey"
+    api [label = "Embedding Model", fillcolor = "lightpink"]
+    db [label = "Vector Database", fillcolor = "lightgrey"]
     cp [label = "Custom Prompt", fillcolor = "lightyellow"]
+    }
+
+    subgraph cluster_2 {
+    label = "Output"
+    style = "dashed"
+    color = "lightgrey"
     llm [label = "Language Model", fillcolor = "lightpink"]
     ld [label = "Letter Draft", fillcolor = "lightyellow"]
+    }
 
-    u -> q [color = "black"]
-    q -> api [color = "black"]
-    u -> als [color = "black"]
-    u -> ei [color = "black"]
-    als -> api [color = "black"]
-    als -> db [color = "black"]
-    api -> db [color = "black"]
-    db -> cp [color = "black"]
-    ei -> llm [color = "black"]
-    cp -> llm [color = "black"]
-    llm -> ld [color = "black"]
-    ld -> u [color = "black"]
+    u -> q [label = "provides"]
+    u -> als [label = "provides"]
+    u -> ei [label = "provides"]
+    q -> api [label = "processed by"]
+    als -> api [label = "processed by"]
+    api -> db [label = "stores in"]
+    als -> db [label = "stores in"]
+    db -> cp [label = "retrieves from"]
+    cp -> llm [label = "forms"]
+    ei -> llm [label = "augments"]
+    llm -> ld [label = "generates"]
+    ld -> u [label = "reviews"]
 }