Experiment logs (CrayLabs#37)

Add experiment logs to the dashboard.

smartdashboard/Experiment_Overview.py

@@ -36,6 +36,7 @@
 from smartdashboard.utils.ManifestReader import load_manifest
 from smartdashboard.utils.pageSetup import local_css, set_streamlit_page_config
 from smartdashboard.view_builders import error_builder, overview_builder
+from smartdashboard.views import EntityView
 
 
 def build_app(manifest_path: str) -> None:
@@ -55,9 +56,15 @@ def build_app(manifest_path: str) -> None:
         error_builder(ex)
     else:
         views = overview_builder(manifest)
+        to_update: t.Iterable[EntityView[t.Any]] = (
+            views.exp_view,
+            views.app_view,
+            views.orc_view,
+            views.ens_view,
+        )
 
         while True:
-            for v in [views.exp_view, views.app_view, views.orc_view, views.ens_view]:
+            for v in to_update:
                 v.update()
 
             time.sleep(1)

smartdashboard/schemas/base.py

@@ -42,7 +42,7 @@ class HasTelemetryMetaData(BaseModel):
     telemetry_metadata: t.Dict[str, t.Any]
 
 
-class EntitiyWithOnlyNameAndOutErrFiles(
+class EntityWithOnlyNameAndOutErrFiles(
     HasName,
     HasOutErrFiles,
     BaseModel,

smartdashboard/schemas/experiment.py

@@ -24,9 +24,9 @@
 # OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 # OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
-from smartdashboard.schemas.base import HasName
+from smartdashboard.schemas.base import EntityWithOnlyNameAndOutErrFiles
 
 
-class Experiment(HasName):
+class Experiment(EntityWithOnlyNameAndOutErrFiles):
     path: str = ""
     launcher: str = ""

smartdashboard/view_builders.py

@@ -67,7 +67,7 @@ def error_builder(error: SSDashboardError) -> ErrorView:
     )
 
     with st.expander(label="Traceback"):
-        st.code(traceback.format_exc(), language=None)
+        st.code(traceback.format_exc(), language="log")
 
     return view
 
@@ -87,6 +87,16 @@ def exp_builder(manifest: Manifest) -> ExperimentView:
     st.write("Path: " + manifest.experiment.path)
     st.write("Launcher: " + manifest.experiment.launcher)
 
+    with st.expander(label="Logs"):
+        col1, col2 = st.columns([6, 6])
+        with col1:
+            st.write("Output")
+            view.out_logs_element = st.code(view.out_logs, language="log")
+
+        with col2:
+            st.write("Error")
+            view.err_logs_element = st.code(view.err_logs, language="log")
+
     return view
 
 
@@ -196,11 +206,11 @@ def app_builder(manifest: Manifest) -> ApplicationView:
             col1, col2 = st.columns([6, 6])
             with col1:
                 st.write("Output")
-                view.out_logs_element = st.code(view.out_logs, language=None)
+                view.out_logs_element = st.code(view.out_logs, language="log")
 
             with col2:
                 st.write("Error")
-                view.err_logs_element = st.code(view.err_logs, language=None)
+                view.err_logs_element = st.code(view.err_logs, language="log")
 
     return view
 
@@ -266,12 +276,12 @@ def orc_builder(manifest: Manifest) -> OrchestratorView:
 
             st.write("")
             st.write("Output")
-            view.out_logs_element = st.code(view.out_logs, language=None)
+            view.out_logs_element = st.code(view.out_logs, language="log")
 
         with col2:
             shard_log_spacing()
             st.write("Error")
-            view.err_logs_element = st.code(view.err_logs, language=None)
+            view.err_logs_element = st.code(view.err_logs, language="log")
 
     return view
 
@@ -412,11 +422,11 @@ def ens_builder(manifest: Manifest) -> EnsembleView:
         col1, col2 = st.columns([6, 6])
         with col1:
             st.write("Output")
-            view.out_logs_element = st.code(view.out_logs, language=None)
+            view.out_logs_element = st.code(view.out_logs, language="log")
 
         with col2:
             st.write("Error")
-            view.err_logs_element = st.code(view.err_logs, language=None)
+            view.err_logs_element = st.code(view.err_logs, language="log")
 
     return view
 

smartdashboard/views.py

@@ -30,7 +30,7 @@
 from streamlit.delta_generator import DeltaGenerator
 
 from smartdashboard.schemas.application import Application
-from smartdashboard.schemas.base import EntityWithNameTelemetryMetaDataErrOut
+from smartdashboard.schemas.base import HasOutErrFiles
 from smartdashboard.schemas.ensemble import Ensemble
 from smartdashboard.schemas.experiment import Experiment
 from smartdashboard.schemas.orchestrator import Orchestrator
@@ -47,7 +47,7 @@
     get_status,
 )
 
-_T = t.TypeVar("_T", bound=EntityWithNameTelemetryMetaDataErrOut)
+_T = t.TypeVar("_T", bound=HasOutErrFiles)
 
 
 class ViewBase(ABC):
@@ -107,15 +107,15 @@ def out_logs(self) -> str:
     def update(self) -> None:
         """Update logs and status elements in the selected entity view"""
         self.update_logs()
-        self.update_status()
+        self._update_status()
 
     def update_logs(self) -> None:
         """Update error and output log elements in the selected entity view"""
-        self.out_logs_element.code(self.out_logs, language=None)
-        self.err_logs_element.code(self.err_logs, language=None)
+        self.out_logs_element.code(self.out_logs, language="log")
+        self.err_logs_element.code(self.err_logs, language="log")
 
     @abstractmethod
-    def update_status(self) -> None:
+    def _update_status(self) -> None:
         """Abstract method to update an entity's status"""
 
     def update_view_model(self, new_view_model: t.Optional[_T]) -> None:
@@ -131,7 +131,7 @@ def update_view_model(self, new_view_model: t.Optional[_T]) -> None:
             self.view_model = new_view_model
 
 
-class ExperimentView(ViewBase):
+class ExperimentView(EntityView[Experiment]):
     """View class for experiments"""
 
     def __init__(
@@ -147,8 +147,8 @@ def __init__(
         :type runs: List[Run]
         """
         self.status_element = DeltaGenerator()
-        self.experiment = experiment
         self.runs = runs
+        super().__init__(view_model=experiment)
 
     @property
     def status(self) -> str:
@@ -159,7 +159,7 @@ def status(self) -> str:
         """
         return get_experiment_status_summary(self.runs)
 
-    def update(self) -> None:
+    def _update_status(self) -> None:
         """Update status element in ExperimentView"""
         self.status_element.write(self.status)
 
@@ -200,7 +200,7 @@ def status(self) -> str:
             return format_status(status)
         return "Status: "
 
-    def update_status(self) -> None:
+    def _update_status(self) -> None:
         """Update status element in ApplicationView"""
         self.status_element.write(self.status)
 
@@ -242,7 +242,7 @@ def status(self) -> str:
         """
         return get_orchestrator_status_summary(self.orchestrator)
 
-    def update_status(self) -> None:
+    def _update_status(self) -> None:
         """Update status element in OrchestratorView"""
         self.status_element.write(self.status)
 
@@ -300,7 +300,7 @@ def member_status(self) -> str:
             return format_status(status)
         return "Status: "
 
-    def update_status(self) -> None:
+    def _update_status(self) -> None:
         """Update ensemble and member status elements in EnsembleView"""
         self.status_element.write(self.status)
         self.member_status_element.write(self.member_status)
@@ -313,7 +313,8 @@ class ErrorView(ViewBase):
     information.
     """
 
-    def update(self) -> None: ...
+    def update(self) -> None:
+        ...
 
 
 class OverviewView: