nshtrainer 0.8.7__py3-none-any.whl → 0.10.0__py3-none-any.whl

nshtrainer/ll/actsave.py

@@ -1,3 +1,4 @@
 from nshutils.actsave import *  # type: ignore # noqa: F403
 
-from nshtrainer.actsave import *  # type: ignore # noqa: F403
+from nshtrainer.callbacks.actsave import ActSaveCallback as ActSaveCallback
+from nshtrainer.callbacks.actsave import ActSaveConfig as ActSaveConfig

nshtrainer/metrics/__init__.py

@@ -0,0 +1 @@
+from ._config import MetricConfig as MetricConfig

nshtrainer/metrics/_config.py

@@ -0,0 +1,37 @@
+import builtins
+from typing import Literal
+
+import nshconfig as C
+
+
+class MetricConfig(C.Config):
+    name: str
+    """The name of the primary metric."""
+
+    mode: Literal["min", "max"]
+    """
+    The mode of the primary metric:
+    - "min" for metrics that should be minimized (e.g., loss)
+    - "max" for metrics that should be maximized (e.g., accuracy)
+    """
+
+    @property
+    def validation_monitor(self) -> str:
+        return f"val/{self.name}"
+
+    def __post_init__(self):
+        for split in ("train", "val", "test", "predict"):
+            if self.name.startswith(f"{split}/"):
+                raise ValueError(
+                    f"Primary metric name should not start with '{split}/'. "
+                    f"Just use '{self.name[len(split) + 1:]}' instead. "
+                    "The split name is automatically added depending on the context."
+                )
+
+    @classmethod
+    def loss(cls, mode: Literal["min", "max"] = "min"):
+        return cls(name="loss", mode=mode)
+
+    @property
+    def best(self):
+        return builtins.min if self.mode == "min" else builtins.max

nshtrainer/model/__init__.py

@@ -1,8 +1,18 @@
 from typing_extensions import TypeAlias
 
+from ._environment import (
+    EnvironmentClassInformationConfig as EnvironmentClassInformationConfig,
+)
+from ._environment import EnvironmentConfig as EnvironmentConfig
+from ._environment import (
+    EnvironmentLinuxEnvironmentConfig as EnvironmentLinuxEnvironmentConfig,
+)
+from ._environment import (
+    EnvironmentSLURMInformationConfig as EnvironmentSLURMInformationConfig,
+)
+from ._environment import EnvironmentSnapshotConfig as EnvironmentSnapshotConfig
 from .base import Base as Base
 from .base import LightningModuleBase as LightningModuleBase
-from .config import ActSaveConfig as ActSaveConfig
 from .config import BaseConfig as BaseConfig
 from .config import BaseLoggerConfig as BaseLoggerConfig
 from .config import BaseProfilerConfig as BaseProfilerConfig
@@ -10,16 +20,6 @@ from .config import CheckpointLoadingConfig as CheckpointLoadingConfig
 from .config import CheckpointSavingConfig as CheckpointSavingConfig
 from .config import DirectoryConfig as DirectoryConfig
 from .config import EarlyStoppingConfig as EarlyStoppingConfig
-from .config import (
-    EnvironmentClassInformationConfig as EnvironmentClassInformationConfig,
-)
-from .config import EnvironmentConfig as EnvironmentConfig
-from .config import (
-    EnvironmentLinuxEnvironmentConfig as EnvironmentLinuxEnvironmentConfig,
-)
-from .config import (
-    EnvironmentSLURMInformationConfig as EnvironmentSLURMInformationConfig,
-)
 from .config import GradientClippingConfig as GradientClippingConfig
 from .config import (
     LatestEpochCheckpointCallbackConfig as LatestEpochCheckpointCallbackConfig,