kostyl-toolkit 0.1.11__py3-none-any.whl → 0.1.12__py3-none-any.whl

kostyl/ml/configs/__init__.py

@@ -4,7 +4,6 @@ from .hyperparams import Lr
 from .hyperparams import Optimizer
 from .hyperparams import WeightDecay
 from .training_settings import CheckpointConfig
-from .training_settings import ClearMLTrainingSettings
 from .training_settings import DataConfig
 from .training_settings import DDPStrategyConfig
 from .training_settings import EarlyStoppingConfig
@@ -16,7 +15,6 @@ from .training_settings import TrainingSettings
 
 __all__ = [
     "CheckpointConfig",
-    "ClearMLTrainingSettings",
     "DDPStrategyConfig",
     "DataConfig",
     "EarlyStoppingConfig",

kostyl/ml/configs/base_model.py

@@ -1,22 +1,28 @@
 from pathlib import Path
+from typing import Self
 from typing import TypeVar
 
+from caseconverter import pascalcase
+from caseconverter import snakecase
+from clearml import Task
 from pydantic import BaseModel as PydanticBaseModel
 
+from kostyl.utils.dict_manipulations import convert_to_flat_dict
+from kostyl.utils.dict_manipulations import flattened_dict_to_nested
 from kostyl.utils.fs import load_config
 
 
 TConfig = TypeVar("TConfig", bound=PydanticBaseModel)
 
 
-class ConfigLoadingMixin:
-    """Pydantic mixin class providing basic configuration loading functionality."""
+class BaseModelWithConfigLoading(PydanticBaseModel):
+    """Pydantic class providing basic configuration loading functionality."""
 
     @classmethod
     def from_file(
-        cls: type[TConfig],  # pyright: ignore
+        cls: type[Self],  # pyright: ignore
         path: str | Path,
-    ) -> TConfig:
+    ) -> Self:
         """
         Create an instance of the class from a configuration file.
 
@@ -34,9 +40,9 @@ class ConfigLoadingMixin:
 
     @classmethod
     def from_dict(
-        cls: type[TConfig],  # pyright: ignore
+        cls: type[Self],  # pyright: ignore
         state_dict: dict,
-    ) -> TConfig:
+    ) -> Self:
         """
         Creates an instance from a dictionary.
 
@@ -54,7 +60,84 @@ class ConfigLoadingMixin:
         return instance
 
 
-class KostylBaseModel(PydanticBaseModel, ConfigLoadingMixin):
+class BaseModelWithClearmlSyncing(BaseModelWithConfigLoading):
+    """Pydantic class providing ClearML configuration loading and syncing functionality."""
+
+    @classmethod
+    def connect_as_file(
+        cls: type[Self],  # pyright: ignore
+        task: Task,
+        path: str | Path,
+        alias: str | None = None,
+    ) -> Self:
+        """
+        Connects the configuration file to a ClearML task and creates an instance of the class from it.
+
+        This method connects the specified configuration file to the given ClearML task for version control and monitoring,
+        then loads and validates the configuration to the class.
+
+        Args:
+            cls: The class type to instantiate.
+            task: The ClearML Task object to connect the configuration to.
+            path: Path to the configuration file (supports YAML format).
+            alias: Optional alias for the configuration in ClearML. Defaults to PascalCase of the class name if None.
+
+        Returns:
+            An instance of the class created from the connected configuration file.
+
+        """
+        if isinstance(path, Path):
+            str_path = str(path)
+        else:
+            str_path = path
+
+        name = alias if alias is not None else pascalcase(cls.__name__)
+        connected_path = task.connect_configuration(str_path, name=pascalcase(name))
+
+        if not isinstance(connected_path, str):
+            connected_path_str = str(connected_path)
+        else:
+            connected_path_str = connected_path
+
+        model = cls.from_file(path=connected_path_str)
+        return model
+
+    @classmethod
+    def connect_as_dict(
+        cls: type[Self],  # pyright: ignore
+        task: Task,
+        path: str | Path,
+        alias: str | None = None,
+    ) -> Self:
+        """
+        Connects configuration from a file as a dictionary to a ClearML task and creates an instance of the class.
+
+        This class method loads configuration from a file as a dictionary, flattens and sync them with ClearML
+        task parameters. Then it creates an instance of the class using the synced dictionary.
+
+        Args:
+            cls: The class type of the model to be created (must be a TRetuningModel subclass).
+            task: The ClearML task to connect the configuration to.
+            path: Path to the configuration file to load parameters from.
+            alias: Optional alias name for the configuration. If None, uses snake_case of class name.
+
+        Returns:
+            An instance of the specified class created from the loaded configuration.
+
+        """
+        name = alias if alias is not None else snakecase(cls.__name__)
+
+        config = load_config(path)
+
+        flattened_config = convert_to_flat_dict(config)
+        task.connect(flattened_config, name=pascalcase(name))
+        config = flattened_dict_to_nested(flattened_config)
+
+        model = cls.from_dict(state_dict=config)
+        return model
+
+
+class KostylBaseModel(BaseModelWithClearmlSyncing):
     """A Pydantic model class with basic configuration loading functionality."""
 
     pass

kostyl/ml/configs/hyperparams.py

@@ -2,9 +2,10 @@ from pydantic import BaseModel
 from pydantic import Field
 from pydantic import model_validator
 
-from kostyl.ml.clearml.config_mixin import ClearMLConfigMixin
 from kostyl.utils.logging import setup_logger
 
+from .base_model import KostylBaseModel
+
 
 logger = setup_logger(fmt="only_message")
 
@@ -74,7 +75,7 @@ class WeightDecay(BaseModel):
         return self
 
 
-class HyperparamsConfig(BaseModel, ClearMLConfigMixin):
+class HyperparamsConfig(KostylBaseModel):
     """Model training hyperparameters configuration."""
 
     grad_clip_val: float | None = Field(default=None, gt=0, validate_default=False)

kostyl/ml/configs/training_settings.py

@@ -3,7 +3,6 @@ from typing import Literal
 from pydantic import BaseModel
 from pydantic import Field
 
-from kostyl.ml.clearml.config_mixin import ClearMLConfigMixin
 from kostyl.utils.logging import setup_logger
 
 from .base_model import KostylBaseModel
@@ -103,13 +102,3 @@ class TrainingSettings(KostylBaseModel):
     early_stopping: EarlyStoppingConfig | None = None
     checkpoint: CheckpointConfig
     data: DataConfig
-
-
-class ClearMLTrainingSettings(
-    TrainingSettings,
-    ClearMLConfigMixin,
-):
-    """Training parameters configuration with ClearML features support (config syncing, model identifiers tracking and etc)."""
-
-    model_id: str
-    tokenizer_id: str

{kostyl_toolkit-0.1.11.dist-info → kostyl_toolkit-0.1.12.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: kostyl-toolkit
-Version: 0.1.11
+Version: 0.1.12
 Summary: Kickass Orchestration System for Training, Yielding & Logging 
 Requires-Dist: case-converter>=1.2.0
 Requires-Dist: loguru>=0.7.3

{kostyl_toolkit-0.1.11.dist-info → kostyl_toolkit-0.1.12.dist-info}/RECORD

@@ -1,14 +1,13 @@
 kostyl/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 kostyl/ml/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 kostyl/ml/clearml/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-kostyl/ml/clearml/config_mixin.py,sha256=Wkz92BLL9y9aDk8qPtla6BrtZegQe7aw40G-oNkBIGs,3363
 kostyl/ml/clearml/dataset_utils.py,sha256=eij_sr2KDhm8GxEbVbK8aBjPsuVvLl9-PIGGaKVgXLA,1729
 kostyl/ml/clearml/logging_utils.py,sha256=GBjIIZbH_itd5sj7XpvxjkyZwxxGOpEcQ3BiWaJTyq8,1210
 kostyl/ml/clearml/pulling_utils.py,sha256=FOk9rtwu9PZ4tcIexiK0LvF6MfuuCwpZxtg2oDUWlTw,3526
-kostyl/ml/configs/__init__.py,sha256=pBuEhcumGBNncprqz-t_IGll2XtMmogTn9S6ZPHXCTg,997
-kostyl/ml/configs/base_model.py,sha256=nOuiBIQn5pYDRRq-F4HbfWi5cn8pfaT2kM02VGoo4TE,1622
-kostyl/ml/configs/hyperparams.py,sha256=UqMk2y1LISK7QMPbh3LyICjJ1DnUQhsYh1NDMR6YnR8,3006
-kostyl/ml/configs/training_settings.py,sha256=JznYSXpTRraFEH7dvk4gt2Ym-XpPGlN-ALzklD7kzCw,2848
+kostyl/ml/configs/__init__.py,sha256=IetcivbqYGutowLqxdKp7QR4tkXKBr4m8t4Zkk9jHZU,911
+kostyl/ml/configs/base_model.py,sha256=Eofn14J9RsjpVx_J4rp6C19pDDCANU4hr3JtX-d0FpQ,4820
+kostyl/ml/configs/hyperparams.py,sha256=CaVNEvpW4LvlHhLsbe2FockIGI1mJufCqjH298nYgKE,2971
+kostyl/ml/configs/training_settings.py,sha256=CZBwVVmkpCUtXCnfC1RFGQGUemht5xbOI43rgg7cNeg,2535
 kostyl/ml/dist_utils.py,sha256=G8atjzkRbXZZiZh9rdEYBmeXqX26rJdDDovft2n6xiU,3201
 kostyl/ml/lightning/__init__.py,sha256=-F3JAyq8KU1d-nACWryGu8d1CbvWbQ1rXFdeRwfE2X8,175
 kostyl/ml/lightning/callbacks/__init__.py,sha256=Vd-rozY4T9Prr3IMqbliXxj6sC6y9XsovHQqRwzc2HI,297
@@ -31,6 +30,6 @@ kostyl/utils/__init__.py,sha256=hkpmB6c5pr4Ti5BshOROebb7cvjDZfNCw83qZ_FFKMM,240
 kostyl/utils/dict_manipulations.py,sha256=e3vBicID74nYP8lHkVTQc4-IQwoJimrbFELy5uSF6Gk,1073
 kostyl/utils/fs.py,sha256=gAQNIU4R_2DhwjgzOS8BOMe0gZymtY1eZwmdgOdDgqo,510
 kostyl/utils/logging.py,sha256=3MvfDPArZhwakHu5nMlp_LpOsWg0E0SP26y41clsBtA,5232
-kostyl_toolkit-0.1.11.dist-info/WHEEL,sha256=3id4o64OvRm9dUknh3mMJNcfoTRK08ua5cU6DFyVy-4,79
-kostyl_toolkit-0.1.11.dist-info/METADATA,sha256=ImcjKFPWoQznLjTGCKjcvmf_Nn2F6NXNWzfQNPXPFDU,4269
-kostyl_toolkit-0.1.11.dist-info/RECORD,,
+kostyl_toolkit-0.1.12.dist-info/WHEEL,sha256=3id4o64OvRm9dUknh3mMJNcfoTRK08ua5cU6DFyVy-4,79
+kostyl_toolkit-0.1.12.dist-info/METADATA,sha256=JLx_ddPY88eK3cAhBTU5oYQ5Eo3IhJ9W8xCQ_zBnVEw,4269
+kostyl_toolkit-0.1.12.dist-info/RECORD,,

kostyl/ml/clearml/config_mixin.py

@@ -1,91 +0,0 @@
-from pathlib import Path
-from typing import TypeVar
-
-import clearml
-from caseconverter import pascalcase
-from caseconverter import snakecase
-
-from kostyl.ml.configs.base_model import KostylBaseModel
-from kostyl.utils.dict_manipulations import convert_to_flat_dict
-from kostyl.utils.dict_manipulations import flattened_dict_to_nested
-from kostyl.utils.fs import load_config
-
-
-TModel = TypeVar("TModel", bound="KostylBaseModel")
-
-
-class ClearMLConfigMixin:
-    """Pydantic mixin class providing ClearML configuration loading and syncing functionality."""
-
-    @classmethod
-    def connect_as_file(
-        cls: type[TModel],  # pyright: ignore
-        task: clearml.Task,
-        path: str | Path,
-        alias: str | None = None,
-    ) -> TModel:
-        """
-        Connects the configuration file to a ClearML task and creates an instance of the class from it.
-
-        This method connects the specified configuration file to the given ClearML task for version control and monitoring,
-        then loads and validates the configuration to the class.
-
-        Args:
-            cls: The class type to instantiate.
-            task: The ClearML Task object to connect the configuration to.
-            path: Path to the configuration file (supports YAML format).
-            alias: Optional alias for the configuration in ClearML. Defaults to PascalCase of the class name if None.
-
-        Returns:
-            An instance of the class created from the connected configuration file.
-
-        """
-        if isinstance(path, Path):
-            str_path = str(path)
-        else:
-            str_path = path
-
-        name = alias if alias is not None else pascalcase(cls.__name__)
-        connected_path = task.connect_configuration(str_path, name=pascalcase(name))
-
-        if not isinstance(connected_path, str):
-            connected_path_str = str(connected_path)
-        else:
-            connected_path_str = connected_path
-
-        model = cls.from_file(path=connected_path_str)
-        return model
-
-    @classmethod
-    def connect_as_dict(
-        cls: type[TModel],  # pyright: ignore
-        task: clearml.Task,
-        path: str | Path,
-        alias: str | None = None,
-    ) -> TModel:
-        """
-        Connects configuration from a file as a dictionary to a ClearML task and creates an instance of the class.
-
-        This class method loads configuration from a file as a dictionary, flattens and sync them with ClearML
-        task parameters. Then it creates an instance of the class using the synced dictionary.
-
-        Args:
-            cls: The class type of the model to be created (must be a TRetuningModel subclass).
-            task: The ClearML task to connect the configuration to.
-            path: Path to the configuration file to load parameters from.
-            alias: Optional alias name for the configuration. If None, uses snake_case of class name.
-
-        Returns:
-            An instance of the specified class created from the loaded configuration.
-
-        """
-        name = alias if alias is not None else snakecase(cls.__name__)
-
-        config = load_config(path)
-
-        flattened_config = convert_to_flat_dict(config)
-        task.connect(flattened_config, name=pascalcase(name))
-        config = flattened_dict_to_nested(flattened_config)
-
-        model = cls.from_dict(state_dict=config)
-        return model