docs: update review-process and add backend flowcharts (#369)

Update review-process and add backend flowcharts --------- Signed-off-by: Kai Xu <xuk@ibm.com>
instructlab · Mar 13, 2024 · 400cb4c · 400cb4c
1 parent 09ee123
commit 400cb4c
Show file tree

Hide file tree

Showing 5 changed files with 68 additions and 23 deletions.
diff --git a/docs/README.md b/docs/README.md
@@ -1,5 +1,7 @@
 # Docs
 
+See the [README.md in `cli/docs`](https://github.com/instruct-lab/cli/blob/main/docs/README.md) on how to modify and render the flowcharts.
+
 ## Review Process
 The review process starts with contributor drafting the PR.
 1. At the PR stage, reviewers would manually check its contents (e.g. making sure the examples are added to the correct path, inspecting the contents of examples; full list TBD).

diff --git a/docs/backend.png b/docs/backend.png
diff --git a/docs/backend.puml b/docs/backend.puml
@@ -0,0 +1,36 @@
+@startditaa
+                     PRs with  legend           
+                     2 reviews   +------------+ 
+                         |       |backend cGRE| 
+                         v       +------------+ 
+                    +---------+  /--------\     
+/----------\ recipe |Synthetic|  |human in|     
+|maintainer+------->|Data cGRE|  |the loop|     
+\----------/        |Generator|  \--------/     
+                    +----+---++                 
+                         |                      
+                         v           +---------+
+                     synthetic --+-->|data cGRE|
+                       data      |   |publisher|
+                         |       |   +---------+
+                         v       |              
+                     +-------+   |              
+                     |trainer|   |              
+                     |   cGRE|   |              
+                     +---+---+   |              
+                         |       |              
+      +----------+       v       |              
+      |model cGRE|<-- updated    |              
+      |publisher |    model      |              
+      +----------+       |       |              
+                         v       |              
+                     +--------+  |              
+                     |PR-Bench|  |              
+                     |    cGRE|  |              
+                     +---+----+  |              
+                         |       |              
+          /-----\        v       |              
+          |merge|<-- successful -+              
+          | PRs |       PRs                     
+          \-----/                               
+@endditaa
diff --git a/docs/review-process.png b/docs/review-process.png
diff --git a/docs/review-process.puml b/docs/review-process.puml
@@ -1,25 +1,32 @@
 @startditaa
-                  begin
-                    |
-              /-----+-----\
-    +-------->|contributor| 
-    |         \-----+-----/
-    |               |
-    |               |
-    v               |
-/--------\          v
-|reviewer|<--->pull request---------+
-\--------/          |               |
-    ^               v               v
-    |             +---+ recipe /---------\
-    |             |SDG|<-------+mainainer|
-    |             +-+-+        \---------/
-    |               |
-    |               v
-    +----------data samples
-                    |
-                    v
-                +-------+
-                |trainer|
-                +-------+
+                   +---+                         legend          
+                   |CLI|                           +-------+     
+                   ++--+                           |lab CLI|     
+    change request  | ^ revise examples based on   +-------+     
+    and review      v | reviewers' feedback        /--------\    
+    discussion /------+----\                       |human in|    
+    +--------->|contributor|                       |the loop|    
+    |          \-----+-----/                       \--------/    
+    |                | create/update PR            +------------+
+    |                |                             |backend cGRE|
+    v 1. initial PR  |                             +------------+
+/--------\ review    v                                           
+|reviewer|<---->pull request                                     
+\--+-+---/           |                                           
+   |^| initial       v                                           
+   ||| checks   +---------+                                      
+   ||| pass     |Synthetic|                                      
+   ||+--------->|Data cGRE|<---simple recipe           
+   ||           |Generator|      e.g. 50 samples per PR.
+   || 2. review +----+----+      this could be merged with  
+   || generated      |           full SDG if we decide to
+   || samples        v           generate all samples upfront
+   |+-----------data samples                                     
+   |                 |                                           
+   | samples         v                                           
+   | approved  +-----------+                                     
+   |           |full SDG   |                                     
+   +---------->|and trainer|                                     
+               |       cGRE|
+               +-----------+                                     
 @endditaa