Refactored pages to make the functions smaller and clearer

pages/003_Dissertation.py

@@ -1,15 +1,17 @@
+"""
+Page which shows the dissertation download button and the dissertation inline in a frame
+"""
+
 import streamlit as st
 import base64
 
 from src.st_helpers import st_setup
 
-if st_setup('Dissertation'):
-    st.write("# Dissertation")
-    st.write("The dissertation is delivered as a PDF dcoument.  In addition, the submission is supported by a short video giving an overview of the project for orientation.")
 
-    st.write("*NOTE - ONLY TEMP FILES RIGHT NOW - THESE WILL BE ADDED WHEN COMPLETE*")
-
-    # Provide a button to download the document
+def show_download_button() -> None:
+    """
+    Displays a button on the page which will download the dissertation PDF
+    """
     with open("img/dissertation.pdf", "rb") as f:
         pdf_bytes = f.read()
     st.download_button(label="Download dissertation",
@@ -17,8 +19,16 @@ if st_setup('Dissertation'):
                        file_name="dissertation.pdf",
                        mime='application/octet-stream')
 
-    # Also show the document inline
+
+def show_dissertation_inline() -> None:
     with open("img/dissertation.pdf", "rb") as f:
         base64_pdf = base64.b64encode(f.read()).decode('utf-8')
-    pdf_display = F'<iframe src="data:application/pdf;base64,{base64_pdf}" width="1000" height="1500" type="application/pdf"></iframe>'
+    pdf_display = f'<iframe src="data:application/pdf;base64,{base64_pdf}" width="1000" height="1500" type="application/pdf"></iframe>'
     st.markdown(pdf_display, unsafe_allow_html=True)
+
+
+if st_setup('Dissertation'):
+    st.write("# Dissertation")
+    st.write("The dissertation is delivered as a PDF document.")
+    show_download_button()
+    show_dissertation_inline()

pages/010_LLM_Architectures.py

@@ -9,6 +9,9 @@ from src.common import img_dir, escape_dollars, generate_group_tag
 from src.architectures import *
 
 
+COMPARE = "Side by side compare"  # Constant value to use for the UI to select a side by side architecture comparison
+
+
 def show_side_by_side() -> None:
     """
     Streamlit render a prompt and the boxes to show each architecture
@@ -68,18 +71,7 @@ def show_side_by_side() -> None:
                         st.write(f'#### {a}')
 
 
-def show_architecture(architecture: str) -> None:
-    """
-    Streamlit render an architecture details and the
-    ability to interact with the architecture
-    :param architecture: the name of the architecture to output
-    """
-    arch = Architecture.get_architecture(architecture)
-
-    # Segment into two containers for organisation
-    arch_container = st.container()
-    chat_container = st.container()
-
+def display_architecture_in_container(arch, arch_container) -> None:
     with arch_container:
         st.divider()
         st.write(f'### {arch.name}')
@@ -97,6 +89,8 @@ def show_architecture(architecture: str) -> None:
         st.write('#### Architecture pipeline steps')
         st.table(pd.DataFrame(table_data, columns=table_cols))
 
+
+def display_architecture_chat_in_container(arch, chat_container) -> None:
     with chat_container:
         st.write(f"### Chat with {arch.name}")
         st.write("Note this is a simple single query through the relevant architecture. This is just a sample so you can interact with it and does not manage a chat session history.")
@@ -127,27 +121,61 @@ def show_architecture(architecture: str) -> None:
                     st.markdown(request.as_markdown())
 
 
-if st_setup('LLM Arch'):
-    st.write("# LLM Architectures")
-    Architecture.load_architectures()
 
-    # Display the available architectures
+def show_architecture(architecture: str) -> None:
+    """
+    Streamlit render an architecture details and the
+    ability to interact with the architecture
+    :param architecture: the name of the architecture to output
+    """
+    arch = Architecture.get_architecture(architecture)
+
+    # Segment into two containers for organisation
+    arch_container = st.container()
+    chat_container = st.container()
+
+    display_architecture_in_container(arch, arch_container)
+    display_architecture_chat_in_container(arch, chat_container)
+
+
+def show_sub_header() -> None:
+    """
+    Write a subheader to the page depending on how many architectures are configured
+    """
     arch_count = len(Architecture.architectures)
     if arch_count == 1:
         st.write('### 1 Architecture available')
     else:
         st.write(f'### {arch_count} Architectures available')
 
+
+def show_reload_button() -> None:
+    """
+    Shows a button to reload the architectures and force them to reload if clicked
+    """
     if st.button("Force reload of architecture configs"):
         Architecture.load_architectures(force_reload=True)
 
+
+def get_user_selected_architecture() -> Optional[str]:
+    """
+    Display a picker of all the architectures plus the option to do a side by side compare
+    """
     arch_names = [a.name for a in Architecture.architectures]
-    compare = 'Side by side comparison'
-    arch_names.append(compare)
-    selected_arch = st.radio(label="Available architectures", label_visibility="hidden", options=arch_names, index=None)
+    arch_names.append(COMPARE)
+    return st.radio(label="Available architectures", label_visibility="hidden", options=arch_names, index=None)
+
+
+if st_setup('LLM Arch'):
+    st.write("# LLM Architectures")
+    Architecture.load_architectures()
+    show_sub_header()
+    show_reload_button()
+
+    selected_arch = get_user_selected_architecture()
     if selected_arch is None:
         st.info('Select an architecture from above to see details and interact with it')
-    elif selected_arch == compare:
+    elif selected_arch == COMPARE:
         show_side_by_side()
     else:
         show_architecture(selected_arch)