Feat/experiment_manager

.gitignore

@@ -2,3 +2,7 @@
 poetry.toml
 .venv
 
+
+**/__pycache__/
+
+.DS_Store

nicemldashboard/dashboard.py

@@ -12,15 +12,15 @@
 from nicemldashboard.pages.home import home
 from nicemldashboard.utils.settings import Settings
 
-app.add_static_files("/fonts", "nicemldashboard/assets/fonts")
+app.add_static_files("/fonts", "assets/fonts")
 
 
 class Dashboard:
     """
     Main dashboard application for a NiceML Dashboard.
     """
 
-    def __init__(self, settings_path: str = ".niceml/settings.yml"):
+    def __init__(self, settings_path: str = "../.niceml/settings.yml"):
         """
         Initialize the Dashboard.
 

nicemldashboard/experiment/experiment_manager.py

@@ -0,0 +1,42 @@
+"""
+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:
+                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

@@ -15,6 +15,8 @@
 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
+from nicemldashboard.experiment.type import ExperimentType
 
 
 @ui.page("/")
@@ -25,7 +27,9 @@ def home():
     ui.add_style("nicemldashboard/assets/style.scss")
 
     experiments = get_random_experiments(experiment_count=20)
+    experiment_manager = ExperimentManager(experiments)
 
+    experiments = experiment_manager.filter_by(experiment_type=ExperimentType.OBJ_DET)
     sidebar()
     with ui.grid().classes("content"):
         with ui.card().style("width:100%"):

tests/unit/nicemldashboard/experiment/test_experiment_manager.py

@@ -0,0 +1,93 @@
+import pytest
+from nicemldashboard.experiment.experiment_manager import ExperimentManager
+from nicemldashboard.experiment.utils import get_random_experiments
+
+
+@pytest.fixture
+def experiments():
+    return get_random_experiments(50, seed=42)
+
+
+@pytest.fixture
+def experiment_manager(experiments):
+    return ExperimentManager(experiments)
+
+
+def test_filter_by_name(experiment_manager, experiments):
+    name_to_test = experiments[0].name
+    filtered = experiment_manager.filter_by(name=name_to_test)
+    assert len(filtered) == 1
+
+    non_filtered_experiments = [exp for exp in experiments if exp.name != name_to_test]
+    assert all(exp.name != name_to_test for exp in non_filtered_experiments)
+
+
+def test_filter_by_id(experiment_manager, experiments):
+    id_to_test = experiments[0].experiment_id
+    filtered = experiment_manager.filter_by(experiment_id=id_to_test)
+    assert len(filtered) == 1
+
+    non_filtered_experiments = [
+        exp for exp in experiments if exp.experiment_id != id_to_test
+    ]
+    assert all(exp.experiment_id != id_to_test for exp in non_filtered_experiments)
+
+
+def test_filter_by_experiment_type(experiment_manager, experiments):
+    experiment_type_to_test = experiments[0].experiment_type
+    filtered = experiment_manager.filter_by(experiment_type=experiment_type_to_test)
+    assert all(exp.experiment_type == experiment_type_to_test for exp in filtered)
+
+    experiments_not_filtered = [exp for exp in experiments if exp not in filtered]
+    assert all(
+        exp.experiment_type != experiment_type_to_test
+        for exp in experiments_not_filtered
+    )
+
+
+def test_filter_by_nonexistent_field(experiment_manager):
+    filtered = experiment_manager.filter_by(nonexistent_field="dummy")
+    assert len(filtered) == 0
+
+
+def test_filter_by_multiple_fields_name_and_id(experiment_manager, experiments):
+    first_experiment = experiments[0]
+    filtered = experiment_manager.filter_by(
+        name=first_experiment.name, experiment_id=first_experiment.experiment_id
+    )
+    assert len(filtered) == 1
+    experiments_not_filtered = [exp for exp in experiments if exp not in filtered]
+    assert all(
+        exp.name != first_experiment.name
+        and exp.experiment_id != first_experiment.experiment_id
+        for exp in experiments_not_filtered
+    )
+
+
+def test_filter_by_multiple_fields_experiment_type_and_git_version(
+    experiment_manager, experiments
+):
+    first_experiment = experiments[0]
+    filtered = experiment_manager.filter_by(
+        experiment_type=first_experiment.experiment_type,
+        git_version=first_experiment.git_version,
+    )
+    assert all(
+        exp.experiment_type == first_experiment.experiment_type for exp in filtered
+    )
+    assert all(exp.git_version == first_experiment.git_version for exp in filtered)
+
+    experiments_not_filtered = [exp for exp in experiments if exp not in filtered]
+    assert all(
+        not (
+            exp.experiment_type == first_experiment.experiment_type
+            and exp.git_version == first_experiment.git_version
+        )
+        for exp in experiments_not_filtered
+    )
+
+
+def test_filter_with_no_criteria(experiment_manager, experiments):
+    filtered = experiment_manager.filter_by()
+    assert len(filtered) == len(experiments)
+    assert filtered == experiments