Added option to include a diagram of the architecture under test on the architectures page.

config/architectures.json

@@ -17,7 +17,8 @@
         {"class":  "RetrievalAugmentor", "params": {"vector_store": "products_tvs"}},
         {"class":  "HFLlamaHttpRequestor", "params":  {"model":  "meta-llama/Llama-2-7b-chat-hf", "system_prompt": "You are a helpful domestic appliance advisor. Please answer the following customer question, answering only from the facts provided. Do not make things up, and say if you cannot answer.", "max_tokens": 2000}},
         {"class":  "OutputResponseScreener"}
-      ]
+      ],
+      "img": "architecture_rag.jpg"
     }
   ]
 }

pages/010_LLM_Architectures.py

@@ -2,6 +2,7 @@ import pandas as pd
 import streamlit as st
 
 from src.st_helpers import st_setup
+from src.common import img_dir
 from src.architectures import *
 
 
@@ -22,6 +23,8 @@ def show_architecture(architecture: str) -> None:
         st.write(f'### {arch.name}')
         st.write('#### Architecture description')
         st.write(arch.description)
+        if arch.img is not None:
+            st.image(os.path.join(img_dir, arch.img), caption=f'Protypical {arch.name} Under Test', width=1000)
         table_data = []
         for j, s in enumerate(arch.steps, start=1):
             table_data.append(

src/architectures.py

@@ -11,7 +11,7 @@ import traceback
 from abc import ABC, abstractmethod
 from enum import Enum
 from time import time
-from typing import List
+from typing import List, Optional
 from better_profanity import profanity
 
 from src.common import config_dir, data_dir, hf_api_token
@@ -192,6 +192,9 @@ class Architecture:
                 for c in configs:
                     arch_name = c['name']
                     arch_description = c['description']
+                    arch_img = None
+                    if 'img' in c:
+                        arch_img = c['img']
                     arch_comps = []
                     for s in c['steps']:
                         component_class_name = s['class']
@@ -199,7 +202,8 @@ class Architecture:
                         if 'params' in s:
                             component_init_params = s['params']
                         arch_comps.append(globals()[component_class_name](**component_init_params))
-                    archs.append(Architecture(name=arch_name, description=arch_description, steps=arch_comps))
+                    arch = Architecture(name=arch_name, description=arch_description, steps=arch_comps, img=arch_img)
+                    archs.append(arch)
             cls.architectures = archs
 
     @classmethod
@@ -220,11 +224,13 @@ class Architecture:
                  name: str,
                  description: str,
                  steps: List[ArchitectureComponent],
+                 img: Optional[str] = None,
                  exception_text: str = "Sorry an internal technical error occurred.",
                  no_response_text: str = "Sorry I can't answer that."):
         self.name = name
         self.description = description
         self.steps = steps
+        self.img = img
         self.exception_text = exception_text
         self.no_response_text = no_response_text
 

src/common.py

@@ -3,6 +3,7 @@ import streamlit as st
 
 
 data_dir = os.path.join(os.path.dirname(__file__), '..', 'data')
+img_dir = os.path.join(os.path.dirname(__file__), '..', 'img')
 config_dir = os.path.join(os.path.dirname(__file__), '..', 'config')
 
 def hf_api_token() -> str: