Update my_model/tabs/results.py

my_model/tabs/results.py

@@ -3,9 +3,27 @@ from my_model.results.demo import ResultDemonstrator
 from my_model.config import evaluation_config as config 
 
 
-def run_demo():
+def run_demo()-> None:
     """
     Run the interactive Streamlit demo for visualizing model evaluation results and analysis.
+
+    This function initializes the ResultDemonstrator class and sets up an interactive interface
+    where users can choose to view either evaluation results & analysis or evaluation samples.
+    Based on the user's selection, different aspects of the evaluation are displayed, such as
+    main & ablation results, results per question category, or the impact of prompt length on performance.
+    
+    Interface Elements:
+        - Evaluation Results & Analysis
+            - Main & Ablation Results
+            - Results per Question Category
+            - Prompt Length (token count) Impact on Performance
+                - Select Model Size
+                - Select Score Type
+        - Evaluation Samples
+            - Generate Random Samples
+    
+    Returns:
+        None
     """
 
     demo = ResultDemonstrator()  # Instantiate the ResultDemonstrator class