Merge pull request #28 from CESNET/feat-notebooks-summary-update

Fixed few summary related bugs; Updated jupyter notebooks to updated summary

Author: milankures

cesnet_tszoo/benchmarks.py

@@ -1,4 +1,4 @@
-from typing import Literal
+from typing import Literal, Optional
 import os
 import logging
 
@@ -16,7 +16,7 @@
 from cesnet_tszoo.datasets.time_based_cesnet_dataset import TimeBasedCesnetDataset
 from cesnet_tszoo.datasets.series_based_cesnet_dataset import SeriesBasedCesnetDataset
 from cesnet_tszoo.datasets.disjoint_time_based_cesnet_dataset import DisjointTimeBasedCesnetDataset
-from cesnet_tszoo.utils.enums import AnnotationType, SourceType, AgreggationType
+from cesnet_tszoo.utils.enums import AnnotationType, SourceType, AgreggationType, DisplayType
 from cesnet_tszoo.utils.file_utils import yaml_load
 from cesnet_tszoo.utils.utils import ExportBenchmark
 from cesnet_tszoo.configs.config_loading import load_config
@@ -73,7 +73,7 @@ def get_config(self) -> SeriesBasedConfig | TimeBasedConfig | DisjointTimeBasedC
 
         return self.config
 
-    def get_initialized_dataset(self, display_config_details: bool = True, check_errors: bool = False, workers: Literal["config"] | int = "config") -> TimeBasedCesnetDataset | SeriesBasedCesnetDataset | DisjointTimeBasedCesnetDataset:
+    def get_initialized_dataset(self, display_config_details: Optional[Literal["text", "diagram"]] = "text", check_errors: bool = False, workers: Literal["config"] | int = "config") -> TimeBasedCesnetDataset | SeriesBasedCesnetDataset | DisjointTimeBasedCesnetDataset:
         """
         Returns dataset with intialized sets, transformers, fillers etc..
 
@@ -94,6 +94,9 @@ def get_initialized_dataset(self, display_config_details: bool = True, check_err
             Returns initialized dataset.
         """
 
+        if display_config_details is not None:
+            display_config_details = DisplayType(display_config_details)
+
         if check_errors:
             self.dataset.check_errors()
 

cesnet_tszoo/datasets/cesnet_dataset.py

@@ -866,7 +866,7 @@ def _update_dataset_config_and_initialize(self, config_editor: ConfigEditor, wor
             if config_editor.requires_init:
                 self.logger.info("Re-initialization is required.")
                 config_editor.modify_dataset_config(self._export_config_copy, self.metadata)
-                self.set_dataset_config_and_initialize(self._export_config_copy, False, workers)
+                self.set_dataset_config_and_initialize(self._export_config_copy, None, workers)
 
             else:
                 config_editor.modify_dataset_config(self.dataset_config, self.metadata)

cesnet_tszoo/datasets/disjoint_time_based_cesnet_dataset.py

@@ -104,7 +104,7 @@ def __post_init__(self):
 
         self.logger.info("Dataset is disjoint_time_based. Use cesnet_tszoo.configs.DisjointTimeBasedConfig")
 
-    def set_dataset_config_and_initialize(self, dataset_config: DisjointTimeBasedConfig, display_config_details: bool = True, workers: int | Literal["config"] = "config") -> None:
+    def set_dataset_config_and_initialize(self, dataset_config: DisjointTimeBasedConfig, display_config_details: Optional[Literal["text", "diagram"]] = "text", workers: int | Literal["config"] = "config") -> None:
         """
         Initialize training set, validation est, test set etc.. This method must be called before any data can be accessed. It is required for the final initialization of [`dataset_config`][cesnet_tszoo.configs.disjoint_time_based_config.DisjointTimeBasedConfig].
 
@@ -172,7 +172,7 @@ def update_dataset_config_and_initialize(self,
                                              test_workers: int | Literal["config"] = "config",
                                              init_workers: int | Literal["config"] = "config",
                                              workers: int | Literal["config"] = "config",
-                                             display_config_details: bool = False):
+                                             display_config_details: Optional[Literal["text", "diagram"]] = None):
         """Used for updating selected configurations set in config.
 
         Set parameter to `config` to keep it as it is config.

cesnet_tszoo/datasets/series_based_cesnet_dataset.py

@@ -110,7 +110,7 @@ def __post_init__(self):
 
         self.logger.info("Dataset is series-based. Use cesnet_tszoo.configs.SeriesBasedConfig")
 
-    def set_dataset_config_and_initialize(self, dataset_config: SeriesBasedConfig, display_config_details: bool = True, workers: int | Literal["config"] = "config") -> None:
+    def set_dataset_config_and_initialize(self, dataset_config: SeriesBasedConfig, display_config_details: Optional[Literal["text", "diagram"]] = "text", workers: int | Literal["config"] = "config") -> None:
         """
         Initialize training set, validation est, test set etc.. This method must be called before any data can be accessed. It is required for the final initialization of [`dataset_config`][cesnet_tszoo.configs.series_based_config.SeriesBasedConfig].
 
@@ -150,7 +150,7 @@ def update_dataset_config_and_initialize(self,
                                              all_workers: int | Literal["config"] = "config",
                                              init_workers: int | Literal["config"] = "config",
                                              workers: int | Literal["config"] = "config",
-                                             display_config_details: bool = False):
+                                             display_config_details: Optional[Literal["text", "diagram"]] = None):
         """Used for updating selected configurations set in config.
 
         Set parameter to `config` to keep it as it is config.

cesnet_tszoo/datasets/time_based_cesnet_dataset.py

@@ -108,7 +108,7 @@ def __post_init__(self):
 
         self.logger.info("Dataset is time-based. Use cesnet_tszoo.configs.TimeBasedConfig")
 
-    def set_dataset_config_and_initialize(self, dataset_config: TimeBasedConfig, display_config_details: bool = True, workers: int | Literal["config"] = "config") -> None:
+    def set_dataset_config_and_initialize(self, dataset_config: TimeBasedConfig, display_config_details: Optional[Literal["text", "diagram"]] = "text", workers: int | Literal["config"] = "config") -> None:
         """
         Initialize training set, validation est, test set etc.. This method must be called before any data can be accessed. It is required for the final initialization of [`dataset_config`][cesnet_tszoo.configs.time_based_config.TimeBasedConfig].
 
@@ -153,7 +153,7 @@ def update_dataset_config_and_initialize(self,
                                              all_workers: int | Literal["config"] = "config",
                                              init_workers: int | Literal["config"] = "config",
                                              workers: int | Literal["config"] = "config",
-                                             display_config_details: bool = False):
+                                             display_config_details: Optional[Literal["text", "diagram"]] = None):
         """Used for updating selected configurations set in config.
 
         Set parameter to `config` to keep it as it is config.

tutorial_notebooks/annotations.ipynb

@@ -69,7 +69,7 @@
                     "name": "stderr",
                     "output_type": "stream",
                     "text": [
-                        "[2025-11-08 21:01:13,156][cesnet_dataset][INFO] - Dataset is time-based. Use cesnet_tszoo.configs.TimeBasedConfig\n"
+                        "[2025-11-14 18:32:33,318][cesnet_dataset][INFO] - Dataset is time-based. Use cesnet_tszoo.configs.TimeBasedConfig\n"
                     ]
                 },
                 {
@@ -1462,7 +1462,7 @@
                     "name": "stderr",
                     "output_type": "stream",
                     "text": [
-                        "[2025-11-08 21:01:13,323][cesnet_dataset][INFO] - Annotations successfully saved to \\some_directory\\tszoo\\annotations\\test_name.csv\n"
+                        "[2025-11-14 18:32:33,481][cesnet_dataset][INFO] - Annotations successfully saved to \\some_directory\\tszoo\\annotations\\test_name.csv\n"
                     ]
                 }
             ],
@@ -1578,7 +1578,7 @@
                     "name": "stderr",
                     "output_type": "stream",
                     "text": [
-                        "[2025-11-08 21:01:13,355][cesnet_dataset][INFO] - Dataset is time-based. Use cesnet_tszoo.configs.TimeBasedConfig\n"
+                        "[2025-11-14 18:32:33,516][cesnet_dataset][INFO] - Dataset is time-based. Use cesnet_tszoo.configs.TimeBasedConfig\n"
                     ]
                 },
                 {
@@ -1650,10 +1650,10 @@
                     "name": "stderr",
                     "output_type": "stream",
                     "text": [
-                        "[2025-11-08 21:01:13,366][cesnet_dataset][WARNING] - Built-in annotations test_name not found.\n",
-                        "[2025-11-08 21:01:13,367][cesnet_dataset][INFO] - Custom annotations found: test_name.\n",
-                        "[2025-11-08 21:01:13,369][cesnet_dataset][INFO] - Annotations detected as AnnotationType.BOTH (both id_ip and id_time)\n",
-                        "[2025-11-08 21:01:13,372][cesnet_dataset][INFO] - Successfully imported annotations from \\some_directory\\tszoo\\annotations\\test_name.csv\n"
+                        "[2025-11-14 18:32:33,525][cesnet_dataset][WARNING] - Built-in annotations test_name not found.\n",
+                        "[2025-11-14 18:32:33,525][cesnet_dataset][INFO] - Custom annotations found: test_name.\n",
+                        "[2025-11-14 18:32:33,526][cesnet_dataset][INFO] - Annotations detected as AnnotationType.BOTH (both id_ip and id_time)\n",
+                        "[2025-11-14 18:32:33,527][cesnet_dataset][INFO] - Successfully imported annotations from \\some_directory\\tszoo\\annotations\\test_name.csv\n"
                     ]
                 },
                 {
@@ -1757,9 +1757,9 @@
                     "name": "stderr",
                     "output_type": "stream",
                     "text": [
-                        "[2025-11-08 21:01:13,383][cesnet_dataset][INFO] - Built-in annotations found: device_type_ip_address_full.\n",
-                        "[2025-11-08 21:01:13,408][cesnet_dataset][INFO] - Annotations detected as AnnotationType.TS_ID (id_ip only)\n",
-                        "[2025-11-08 21:01:18,001][cesnet_dataset][INFO] - Successfully imported annotations from F:\\tszoo-library\\cesnet-tszoo\\cesnet_tszoo\\files\\annotation_files\\device_type_ip_address_full.csv\n"
+                        "[2025-11-14 18:32:33,539][cesnet_dataset][INFO] - Built-in annotations found: device_type_ip_address_full.\n",
+                        "[2025-11-14 18:32:33,563][cesnet_dataset][INFO] - Annotations detected as AnnotationType.TS_ID (id_ip only)\n",
+                        "[2025-11-14 18:32:37,958][cesnet_dataset][INFO] - Successfully imported annotations from F:\\tszoo-library\\cesnet-tszoo\\cesnet_tszoo\\files\\annotation_files\\device_type_ip_address_full.csv\n"
                     ]
                 },
                 {