kostyl-toolkit 0.1.0__tar.gz → 0.1.1__tar.gz

{kostyl_toolkit-0.1.0 → kostyl_toolkit-0.1.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: kostyl-toolkit
-Version: 0.1.0
+Version: 0.1.1
 Summary: Kickass Orchestration System for Training, Yielding & Logging 
 Requires-Dist: case-converter>=1.2.0
 Requires-Dist: clearml[s3]>=2.0.2

{kostyl_toolkit-0.1.0 → kostyl_toolkit-0.1.1}/kostyl/ml_core/configs/__init__.py

@@ -1,4 +1,4 @@
-from .config_mixins import ConfigLoadingMixin
+from .config_base import ConfigLoadingMixin
 from .hyperparams import HyperparamsConfig
 from .hyperparams import Lr
 from .hyperparams import Optimizer

kostyl_toolkit-0.1.0/kostyl/ml_core/configs/config_mixins.py → kostyl_toolkit-0.1.1/kostyl/ml_core/configs/config_base.py

@@ -1,10 +1,11 @@
 from pathlib import Path
+from typing import TypeVar
 
 import clearml
 import yaml
 from caseconverter import pascalcase
 from caseconverter import snakecase
-from pydantic import BaseModel
+from pydantic import BaseModel as PydanticBaseModel
 
 from kostyl.utils import convert_to_flat_dict
 from kostyl.utils import flattened_dict_to_nested
@@ -26,18 +27,22 @@ def load_config(path: Path | str) -> dict:
     return config
 
 
-class ConfigLoadingMixin[TConfig: ConfigLoadingMixin](BaseModel):
+TConfig = TypeVar("TConfig", bound=PydanticBaseModel)
+
+
+class ConfigLoadingMixin:
     """Pydantic mixin class providing basic configuration loading functionality."""
 
     @classmethod
     def from_file(
-        cls: type[TConfig],
+        cls: type[TConfig],  # pyright: ignore[reportGeneralTypeIssues]
         path: str | Path,
     ) -> TConfig:
         """
         Create an instance of the class from a configuration file.
 
         Args:
+            cls_: The class type to instantiate.
             path (str | Path): Path to the configuration file.
 
         Returns:
@@ -50,13 +55,14 @@ class ConfigLoadingMixin[TConfig: ConfigLoadingMixin](BaseModel):
 
     @classmethod
     def from_dict(
-        cls: type[TConfig],
+        cls: type[TConfig],  # pyright: ignore[reportGeneralTypeIssues]
         state_dict: dict,
     ) -> TConfig:
         """
         Creates an instance from a dictionary.
 
         Args:
+            cls_: The class type to instantiate.
             state_dict (dict): A dictionary representing the state of the
                 class that must be validated and used for initialization.
 
@@ -69,16 +75,19 @@ class ConfigLoadingMixin[TConfig: ConfigLoadingMixin](BaseModel):
         return instance
 
 
-class ClearMLConfigMixin[TConfig: ClearMLConfigMixin](ConfigLoadingMixin[TConfig]):
+TModel = TypeVar("TModel", bound="ClearMLBaseModel")
+
+
+class ClearMLConfigMixin(ConfigLoadingMixin):
     """Pydantic mixin class providing ClearML configuration loading and syncing functionality."""
 
     @classmethod
     def connect_as_file(
-        cls: type[TConfig],
+        cls: type[TModel],  # pyright: ignore[reportGeneralTypeIssues]
         task: clearml.Task,
         path: str | Path,
         alias: str | None = None,
-    ) -> TConfig:
+    ) -> TModel:
         """
         Connects the configuration file to a ClearML task and creates an instance of the class from it.
 
@@ -113,11 +122,11 @@ class ClearMLConfigMixin[TConfig: ClearMLConfigMixin](ConfigLoadingMixin[TConfig
 
     @classmethod
     def connect_as_dict(
-        cls: type[TConfig],
+        cls: type[TModel],  # pyright: ignore[reportGeneralTypeIssues]
         task: clearml.Task,
         path: str | Path,
         alias: str | None = None,
-    ) -> TConfig:
+    ) -> TModel:
         """
         Connects configuration from a file as a dictionary to a ClearML task and creates an instance of the class.
 
@@ -142,5 +151,11 @@ class ClearMLConfigMixin[TConfig: ClearMLConfigMixin](ConfigLoadingMixin[TConfig
         task.connect(flattened_config, name=pascalcase(name))
         config = flattened_dict_to_nested(flattened_config)
 
-        model = cls.from_dict(config)
+        model = cls.from_dict(state_dict=config)
         return model
+
+
+class ClearMLBaseModel(PydanticBaseModel, ClearMLConfigMixin):
+    """A Pydantic model class with ClearML configuration loading and syncing functionality."""
+
+    pass

{kostyl_toolkit-0.1.0 → kostyl_toolkit-0.1.1}/kostyl/ml_core/configs/hyperparams.py

@@ -4,7 +4,7 @@ from pydantic import model_validator
 
 from kostyl.utils.logging import setup_logger
 
-from .config_mixins import ClearMLConfigMixin
+from .config_base import ClearMLBaseModel
 
 
 logger = setup_logger(fmt="only_message")
@@ -75,7 +75,7 @@ class WeightDecay(BaseModel):
         return self
 
 
-class HyperparamsConfig(ClearMLConfigMixin["HyperparamsConfig"]):
+class HyperparamsConfig(ClearMLBaseModel):
     """Model training hyperparameters configuration."""
 
     grad_clip_val: float | None = Field(default=None, gt=0, validate_default=False)

{kostyl_toolkit-0.1.0 → kostyl_toolkit-0.1.1}/kostyl/ml_core/configs/training_params.py

@@ -5,8 +5,8 @@ from pydantic import Field
 
 from kostyl.utils.logging import setup_logger
 
-from .config_mixins import ClearMLConfigMixin
-from .config_mixins import ConfigLoadingMixin
+from .config_base import ClearMLBaseModel
+from .config_base import ConfigLoadingMixin
 
 
 logger = setup_logger(fmt="only_message")
@@ -91,7 +91,7 @@ class DataConfig(BaseModel):
     data_columns: list[str]
 
 
-class TrainingParams(ConfigLoadingMixin["TrainingParams"]):
+class TrainingParams(ConfigLoadingMixin):
     """Training parameters configuration."""
 
     trainer: LightningTrainerParameters
@@ -102,7 +102,7 @@ class TrainingParams(ConfigLoadingMixin["TrainingParams"]):
 
 class ClearMLTrainingParameters(
     TrainingParams,
-    ClearMLConfigMixin["ClearMLTrainingParameters"],
+    ClearMLBaseModel,
 ):
     """Training parameters configuration with ClearML features support (config syncing, model identifiers tracking and etc)."""
 

{kostyl_toolkit-0.1.0 → kostyl_toolkit-0.1.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "kostyl-toolkit"
-version = "0.1.0"
+version = "0.1.1"
 description = "Kickass Orchestration System for Training, Yielding & Logging "
 readme = "README.md"
 requires-python = ">=3.12"