Merge pull request #36 from CESNET/dev

Added flair for tutorial notebooks

Author: milankures

README.md

@@ -4,6 +4,7 @@
 
 [![](https://img.shields.io/badge/license-BSD-blue.svg)](https://github.com/CESNET/cesnet-tszoo/blob/main/LICENSE)
 [![](https://img.shields.io/badge/docs-cesnet--tszoo-blue.svg)](https://cesnet.github.io/cesnet-tszoo/)
+[![](https://img.shields.io/badge/tutorials-cesnet--tszoo-blue.svg)](https://github.com/CESNET/cesnet-ts-zoo-tutorials)
 [![](https://img.shields.io/badge/python->=3.10-blue.svg)](https://pypi.org/project/cesnet-tszoo/)
 [![](https://img.shields.io/pypi/v/cesnet-tszoo)](https://pypi.org/project/cesnet-tszoo/)
 

cesnet_tszoo/configs/base_config.py

@@ -160,7 +160,7 @@ def __init__(self,
         self.test_preprocess_order: list[PreprocessNote] = []
         self.all_preprocess_order: list[PreprocessNote] = []
         self.is_initialized: bool = False
-        self.version: str = version.current_version
+        self.version: str = version.config_and_benchmarks_current_version
         self.export_update_needed: bool = False
 
         self.features_to_take: list[str] = features_to_take

cesnet_tszoo/configs/config_updater.py

@@ -30,7 +30,7 @@ def try_get_updated_config(self) -> DatasetConfig:
 
         self.__validate_whether_config_update_possible_()
 
-        if self.config_to_update.version == version.current_version:
+        if self.config_to_update.version == version.config_and_benchmarks_current_version:
             self.updated_config = self.config_to_update
             return self.updated_config
 
@@ -67,8 +67,8 @@ def try_get_updated_config(self) -> DatasetConfig:
             self.config_to_update.version = version.VERSION_2_1_0
             self.logger.debug("Updating config version to %s used cesnet-tszoo package version.", version.VERSION_2_1_0)
 
-        self.logger.debug("Updating config version to %s used cesnet-tszoo package version.", version.current_version)
-        self.config_to_update.version = version.current_version
+        self.logger.debug("Updating config version to %s, to match used cesnet-tszoo package config version.", version.config_and_benchmarks_current_version)
+        self.config_to_update.version = version.config_and_benchmarks_current_version
 
         self.updated_config = self.config_to_update
 
@@ -143,13 +143,13 @@ def __try_set_default_config_version(self):
             self.config_to_update.version = version.DEFAULT_VERSION
 
     def __validate_whether_config_update_possible_(self):
-        if Version(self.config_to_update.version) < Version(version.current_version):
-            self.logger.warning("Imported config was made for cesnet-tszoo package of version '%s', but current used cesnet-tszoo package version is '%s'!", self.config_to_update.version, version.current_version)
+        if Version(self.config_to_update.version) < Version(version.config_and_benchmarks_current_version):
+            self.logger.warning("Imported config was made for cesnet-tszoo configs of version '%s', but current supported cesnet-tszoo config version is '%s'!", self.config_to_update.version, version.config_and_benchmarks_current_version)
             self.logger.warning("Will try to update the config. It is recommended to recreate this config or at least export this config alone or through benchmark to create updated config file.")
-        elif Version(self.config_to_update.version) > Version(version.current_version):
-            self.logger.error("Imported config was made for cesnet-tszoo package of version '%s', but current used cesnet-tszoo package version is '%s'!", self.config_to_update.version, version.current_version)
+        elif Version(self.config_to_update.version) > Version(version.config_and_benchmarks_current_version):
+            self.logger.error("Imported config was made for cesnet-tszoo configs of version '%s', but current supported cesnet-tszoo config version is '%s'!", self.config_to_update.version, version.config_and_benchmarks_current_version)
             self.logger.error("Update cesnet-tszoo package to use this config.")
-            raise ValueError(f"Imported config was made for cesnet-tszoo package of version '{self.config_to_update.version}', but current used cesnet-tszoo package version is '{version.current_version}'!")
+            raise ValueError(f"Imported config was made for cesnet-tszoo configs of version '{self.config_to_update.version}', but current supported cesnet-tszoo config version is '{version.config_and_benchmarks_current_version}'!")
 
     def __scaler_to_transformer_version_update(self):
         self.logger.debug("Updating attributes from scaler variant to transformer variant.")

cesnet_tszoo/datasets/cesnet_dataset.py

@@ -1576,7 +1576,7 @@ def save_benchmark(self, identifier: str, force_write: bool = False, **kwargs) -
                                            annotations_time_name,
                                            annotations_both_name,
                                            related_results_identifier=self.related_to,
-                                           version=version.current_version)
+                                           version=version.config_and_benchmarks_current_version)
 
         # If the config was not imported, save it
         if self.dataset_config.import_identifier is None or self.dataset_config.export_update_needed:

cesnet_tszoo/utils/utils.py

@@ -119,6 +119,6 @@ def _update_for_backward_compatibility(cls, data):
             del data["is_series_based"]
             data["dataset_type"] = None
 
-        data["version"] = version.current_version
+        data["version"] = version.config_and_benchmarks_current_version
 
         return data

cesnet_tszoo/version.py

@@ -1,9 +1,10 @@
 import importlib.metadata
 
-current_version = importlib.metadata.version("cesnet-tszoo")
-
 VERSION_2_1_0 = "2.1.0"
 VERSION_2_0_1 = "2.0.1"
 VERSION_2_0_0 = "2.0.0"
 VERSION_0_1_3 = "0.1.3"
 DEFAULT_VERSION = "0.1.2"
+
+current_version = importlib.metadata.version("cesnet-tszoo")
+config_and_benchmarks_current_version = VERSION_2_1_0

pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "cesnet_tszoo"
-version = "2.1.0"
+version = "2.1.1"
 authors = [
     { name = "Milan Kureš", email = "[email protected]" },
     { name = "Josef Koumar", email = "[email protected]" },