nshtrainer 0.37.0__tar.gz → 0.39.0__tar.gz

{nshtrainer-0.37.0 → nshtrainer-0.39.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: nshtrainer
-Version: 0.37.0
+Version: 0.39.0
 Summary: 
 Author: Nima Shoghi
 Author-email: nimashoghi@gmail.com

{nshtrainer-0.37.0 → nshtrainer-0.39.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "nshtrainer"
-version = "0.37.0"
+version = "0.39.0"
 description = ""
 authors = ["Nima Shoghi <nimashoghi@gmail.com>"]
 readme = "README.md"

{nshtrainer-0.37.0 → nshtrainer-0.39.0}/src/nshtrainer/callbacks/checkpoint/_base.py

@@ -41,7 +41,7 @@ class BaseCheckpointCallbackConfig(CallbackConfigBase, ABC):
         self,
         root_config: "BaseConfig",
         dirpath: Path,
-    ) -> "CheckpointBase": ...
+    ) -> "CheckpointBase | None": ...
 
     @override
     def create_callbacks(self, root_config):
@@ -50,7 +50,8 @@ class BaseCheckpointCallbackConfig(CallbackConfigBase, ABC):
             or root_config.directory.resolve_subdirectory(root_config.id, "checkpoint")
         )
 
-        yield self.create_checkpoint(root_config, dirpath)
+        if (callback := self.create_checkpoint(root_config, dirpath)) is not None:
+            yield callback
 
 
 TConfig = TypeVar("TConfig", bound=BaseCheckpointCallbackConfig, infer_variance=True)

{nshtrainer-0.37.0 → nshtrainer-0.39.0}/src/nshtrainer/callbacks/checkpoint/best_checkpoint.py

@@ -20,15 +20,26 @@ class BestCheckpointCallbackConfig(BaseCheckpointCallbackConfig):
     metric: MetricConfig | None = None
     """Metric to monitor, or `None` to use the default metric."""
 
+    throw_on_no_metric: bool = True
+    """
+    Whether to throw an error if no metric is provided and no primary metric is found in the root config.
+    """
+
     @override
     def create_checkpoint(self, root_config, dirpath):
         # Resolve metric
         if (metric := self.metric) is None and (
             metric := root_config.primary_metric
         ) is None:
-            raise ValueError(
-                "No metric provided and no primary metric found in the root config"
+            error_msg = (
+                "No metric provided and no primary metric found in the root config. "
+                "Cannot create BestCheckpointCallback."
             )
+            if self.throw_on_no_metric:
+                raise ValueError(error_msg)
+            else:
+                log.warning(error_msg)
+                return None
 
         return BestCheckpoint(self, dirpath, metric)
 

{nshtrainer-0.37.0 → nshtrainer-0.39.0}/src/nshtrainer/callbacks/early_stopping.py

@@ -51,7 +51,7 @@ class EarlyStoppingConfig(CallbackConfigBase):
             metric := root_config.primary_metric
         ) is None:
             raise ValueError(
-                "Either `metric` or `root_config.primary_metric` must be set."
+                "Either `metric` or `root_config.primary_metric` must be set to use EarlyStopping."
             )
 
         yield EarlyStopping(self, metric)

{nshtrainer-0.37.0 → nshtrainer-0.39.0}/src/nshtrainer/config.py

@@ -65,13 +65,13 @@ from nshtrainer.callbacks.wandb_upload_code import (
     WandbUploadCodeConfig as WandbUploadCodeConfig,
 )
 from nshtrainer.callbacks.wandb_watch import WandbWatchConfig as WandbWatchConfig
-from nshtrainer.config import LRSchedulerConfig as LRSchedulerConfig
 from nshtrainer.loggers._base import BaseLoggerConfig as BaseLoggerConfig
 from nshtrainer.loggers.csv import CSVLoggerConfig as CSVLoggerConfig
 from nshtrainer.loggers.tensorboard import (
     TensorboardLoggerConfig as TensorboardLoggerConfig,
 )
 from nshtrainer.loggers.wandb import WandbLoggerConfig as WandbLoggerConfig
+from nshtrainer.lr_scheduler import LRSchedulerConfig as LRSchedulerConfig
 from nshtrainer.lr_scheduler._base import LRSchedulerConfigBase as LRSchedulerConfigBase
 from nshtrainer.lr_scheduler.linear_warmup_cosine import (
     DurationConfig as DurationConfig,

{nshtrainer-0.37.0 → nshtrainer-0.39.0}/src/nshtrainer/trainer/_config.py

@@ -263,7 +263,7 @@ class CheckpointSavingConfig(CallbackConfigBase):
     """Enable checkpoint saving."""
 
     checkpoint_callbacks: Sequence[CheckpointCallbackConfig] = [
-        BestCheckpointCallbackConfig(),
+        BestCheckpointCallbackConfig(throw_on_no_metric=False),
         LastCheckpointCallbackConfig(),
         OnExceptionCheckpointCallbackConfig(),
     ]