alfraser commited on
Commit
4f07f72
·
1 Parent(s): 5f6f1d0

Added page level comments to describe the purpose of each page

Browse files
pages/010_LLM_Architectures.py CHANGED
@@ -1,3 +1,10 @@
 
 
 
 
 
 
 
1
  import pandas as pd
2
  import streamlit as st
3
 
 
1
+ """
2
+ This page displays the architectures which have been configured in the system and lets
3
+ users interact with them. If users choose to interact with a single architecture they get
4
+ a more detailed breakdown of the architecture flow, if they choose to view side by side results
5
+ they get to see just the time taken and the response.
6
+ """
7
+
8
  import pandas as pd
9
  import streamlit as st
10
 
pages/020_Data_Browser.py CHANGED
@@ -1,3 +1,8 @@
 
 
 
 
 
1
  import streamlit as st
2
  import pandas as pd
3
  import plotly.express as px
 
1
+ """
2
+ This page allows users to browse the test data set. Mainly this is just to get a sense of the size,
3
+ content and composition of the dataset behind the project.
4
+ """
5
+
6
  import streamlit as st
7
  import pandas as pd
8
  import plotly.express as px
pages/030_Test_Runner.py CHANGED
@@ -1,3 +1,9 @@
 
 
 
 
 
 
1
  import regex as re
2
  import streamlit as st
3
 
 
1
+ """
2
+ This page allows users to run batches of tests against the architectures. It allows the asking of
3
+ general questions from the question set, and also specific pricing questions which are designed
4
+ to test and demonstrate the architectures' ability to learn exact facts.
5
+ """
6
+
7
  import regex as re
8
  import streamlit as st
9
 
pages/040_Test_Reporter.py CHANGED
@@ -1,3 +1,7 @@
 
 
 
 
1
  import pandas as pd
2
  import plotly.express as px
3
  import streamlit as st
 
1
+ """
2
+ This page allows users to select test batches and see summary statistics from them.
3
+ """
4
+
5
  import pandas as pd
6
  import plotly.express as px
7
  import streamlit as st
pages/900_System_Status.py CHANGED
@@ -1,3 +1,8 @@
 
 
 
 
 
1
  import streamlit as st
2
  from time import sleep
3
 
 
1
+ """
2
+ This page is password protected and allows admin users to perform several actions which
3
+ are not available to normal users (e.g. re-loading dynamically certain files or erasing files).
4
+ """
5
+
6
  import streamlit as st
7
  from time import sleep
8