Feat/experiment_manager

.github/ISSUE_TEMPLATE/FEATURE-REQUEST.yml

@@ -45,4 +45,4 @@ body:
       description: By submitting this feature request, you agree to follow our [Code of Conduct](https://github.com/codecentric-oss/niceml-dashboard/blob/main/CODE_OF_CONDUCT.md)
       options:
         - label: I agree to follow this project's Code of Conduct
-          required: true
+          required: true

.github/pull_request_template.md

@@ -30,4 +30,4 @@ Please provide any relevant links (e.g. documentation, external resources) that
 
 If applicable, please include screenshots of the before and after effects of your changes.
 
-Thank you for your contribution! 🎉
+Thank you for your contribution! 🎉

CODE_OF_CONDUCT.md

@@ -34,4 +34,4 @@ Remember that this code of conduct applies to all project spaces, including GitH
 
 Let's work together to build a welcoming and inclusive community where everyone can contribute and grow.
 
-Note: This code of conduct was adapted from the Contributor Covenant (https://www.contributor-covenant.org/version/2/0/code_of_conduct.html).
+Note: This code of conduct was adapted from the Contributor Covenant (https://www.contributor-covenant.org/version/2/0/code_of_conduct.html).

README.md

@@ -1,3 +1,2 @@
 # niceml-dashboard
  - Welcome on board.
-

nicemldashboard/State.py → nicemldashboard/State/State.py

@@ -4,22 +4,29 @@
 Also includes helper functions to initialize and get the instance of the Event Manager.
 Enums for Dicts are defined for consistency.
 """
-from enum import Enum
+from abc import ABCMeta
+from enum import EnumMeta
 from nicegui import context
 import logging
 from nicegui.observables import ObservableDict
 
 logger = logging.getLogger(__name__)
 
-_EVENT_MNGR_ATTR_NAME = "_niceml"
+_EVENT_MNGR_ATTR_NAME = "_nicemldashboard"
+
+
+class StateKeys(ABCMeta, EnumMeta):
+    """
+    Provides an abstract class for StateKey management
+    """
 
 
 class EventManager:
     """
     Manages event dictionaries and provides methods to retrieve and manage them.
     """
 
-    _observable_dicts: dict[str, ObservableDict]
+    _observable_dicts: dict[StateKeys, ObservableDict]
 
     def __init__(self):
         """
@@ -77,9 +84,23 @@ def init_event_manager(event_manager: EventManager):
         logger.debug("Event Manager cannot be initialized in a background task")
 
 
-class Dicts(Enum):
+class StateEvent(ABCMeta, EnumMeta):
+    """
+    Manages the keys for the observable dictionaries
+    """
+
+
+class ExperimentEvents(StateEvent):
+    """
+    Manages the experimente events in the observable dictionaries
+    """
+
+    ON_EXPERIMENT_PREFIX_CHANGE = "on_experiment_prefix_change"
+
+
+class ExperimentStateKeys(StateKeys):
     """
     Manages the observable dictionaries
     """
 
-    experiment_dict = "experiment_dict"
+    EXPERIMENT_DICT = "experiment_dict"

nicemldashboard/basecomponents/sidebar.py

@@ -13,6 +13,14 @@
 from typing import Optional, List
 
 from nicegui import ui
+from nicegui.observables import ObservableDict
+
+
+from nicemldashboard.State.State import (
+    _get_event_manager,
+    ExperimentStateKeys,
+    ExperimentEvents,
+)
 from nicemldashboard.basecomponents.buttons import SidebarToggleButton
 from nicemldashboard.experiment.type import ExperimentType
 
@@ -36,14 +44,44 @@ def sidebar(experiment_types: Optional[List[ExperimentType]] = None):
         side_bar_toggle = SidebarToggleButton(left_drawer=left_drawer)
 
         for experiment_type in experiment_types:
+            button_callback = lambda e, et=experiment_type: (
+                on_stage_change(
+                    _get_event_manager().get_dict(ExperimentStateKeys.EXPERIMENT_DICT),
+                    get_enum(et),
+                )
+            )
+
             with ui.button(
-                color="transparent",
-                icon=experiment_type.icon,
-            ).props(
-                "flat"
-            ).classes("exp-type-btn").bind_text_from(
+                color="transparent", icon=experiment_type.icon, on_click=button_callback
+            ).props("flat").classes("exp-type-btn").bind_text_from(
                 experiment_type,
                 "prefix",
                 backward=lambda x: ("" if not side_bar_toggle.is_expanded() else x),
             ):
                 ui.tooltip(experiment_type.name)
+
+
+def on_stage_change(observable_dict: ObservableDict, value: str):
+    """
+    Updates the Events.on_experiment_change key with the value given.
+    :param observable_dict:
+    :param value:
+    :return:
+    """
+    observable_dict[ExperimentEvents.ON_EXPERIMENT_PREFIX_CHANGE] = value
+
+
+def get_enum(experiment_type: ExperimentType):
+    """
+    Provides a way to easily compare the experiment type with the ExperimentType Enums
+    :param experiment_type:
+    :return:
+    """
+    if experiment_type.prefix == "SEG":
+        return ExperimentType.SEM_SEG
+    elif experiment_type.prefix == "CLS":
+        return ExperimentType.CLS
+    elif experiment_type.prefix == "OBD":
+        return ExperimentType.OBJ_DET
+    else:
+        raise Exception("The event type is not available in the ExperimentType Enum")

nicemldashboard/dashboard.py

@@ -12,6 +12,7 @@
 from nicemldashboard.pages.home import home
 from nicemldashboard.utils.settings import Settings
 
+
 # TODO: Make file paths os-agnostic
 app.add_static_files("/fonts", "nicemldashboard/assets/fonts")
 

nicemldashboard/experiment/experiment_manager.py

@@ -0,0 +1,52 @@
+"""
+This module provides an experiment manager. Currently, experiment manager
+supports filtering experiments by their properties.
+"""
+import logging
+from typing import List
+
+from nicemldashboard.experiment.experiment import Experiment
+
+
+class ExperimentManager:
+    """
+    Allows filtering experiments by making the filter_by method available
+    """
+
+    def __init__(self, experiments: List[Experiment]):
+        """
+        Initializes an ExperimentManager with the provided list of experiments.
+        """
+        self.experiments = experiments
+
+    def filter_by(self, **filters) -> List[Experiment]:
+        """
+        Filters the experiment list after filtering with the provided filters
+        :param filters:
+        :return:
+        """
+        filtered_experiments = self.experiments.copy()
+        for key, value in filters.items():
+            try:
+                if isinstance(value, dict):
+                    filtered_experiments = [
+                        exp
+                        for exp in filtered_experiments
+                        if all(
+                            item in getattr(exp, key, {}).items()
+                            for item in value.items()
+                        )
+                    ]
+                else:
+                    filtered_experiments = [
+                        exp
+                        for exp in filtered_experiments
+                        if getattr(exp, key, None) == value
+                    ]
+            except TypeError as e:
+                # Log the error message with details of which experiment and filter caused it.
+                logging.error(
+                    f"Incomparable types between attribute '{key}' with value '{value}' "
+                    f"and filter value '{value}': {e}"
+                )
+        return filtered_experiments

nicemldashboard/pages/home.py

@@ -10,21 +10,36 @@
 
 """
 
+
+from nicemldashboard.State.State import EventManager, ExperimentStateKeys, ExperimentEvents, init_event_manager
+
+
 from nicegui import ui
+from nicegui.observables import ObservableDict
+
+
+from nicemldashboard.State.State import EventManager, ExperimentStateKeys, ExperimentEvents, init_event_manager
 
 from nicemldashboard.basecomponents.sidebar import sidebar
 from nicemldashboard.basecomponents.table import experiment_runs_table
 from nicemldashboard.experiment.utils import get_random_experiments
+from nicemldashboard.experiment.experiment_manager import ExperimentManager
 
 
 @ui.page("/")
 def home():
     """
     Define the layout of the home page.
     """
+
     ui.add_scss("nicemldashboard/assets/style.scss")
+    _instance = EventManager()
+    init_event_manager(_instance)
+    exp_dict = _instance.get_dict(ExperimentStateKeys.EXPERIMENT_DICT)
+    exp_dict.on_change(_experiment_runs_table.refresh)
 
     experiments = get_random_experiments(experiment_count=20)
+    experiment_manager = ExperimentManager(experiments)
 
     sidebar()
     with ui.grid().classes("content"):
@@ -33,4 +48,14 @@ def home():
                 with ui.row():
                     ui.input(label="Experiment run", placeholder="Search for run")
                 ui.separator()
-                experiment_runs_table(experiments=experiments)
+                _experiment_runs_table(experiment_manager, exp_dict)
+
+
+@ui.refreshable
+def _experiment_runs_table(
+    experiment_manager: ExperimentManager, exp_dic: ObservableDict
+):
+    experiments = experiment_manager.filter_by(
+        experiment_type=exp_dic.get(ExperimentEvents.ON_EXPERIMENT_PREFIX_CHANGE)
+    )
+    experiment_runs_table(experiments=experiments)