nshtrainer 0.10.10__py3-none-any.whl → 0.10.11__py3-none-any.whl

nshtrainer/_checkpoint/metadata.py

@@ -1,6 +1,8 @@
 import copy
 import datetime
 import logging
+import shutil
+from collections.abc import Callable
 from pathlib import Path
 from typing import TYPE_CHECKING, Any, cast
 
@@ -100,3 +102,74 @@ def _write_checkpoint_metadata(
         log.warning(f"Failed to write hparams to {checkpoint_path}: {e}")
     else:
         log.info(f"Checkpoint metadata written to {checkpoint_path}")
+
+
+def _remove_checkpoint_metadata(checkpoint_path: Path):
+    for path in (
+        checkpoint_path.with_suffix(METADATA_PATH_SUFFIX),
+        checkpoint_path.with_suffix(HPARAMS_PATH_SUFFIX),
+    ):
+        try:
+            path.unlink(missing_ok=True)
+        except Exception as e:
+            log.warning(f"Failed to remove {path}: {e}")
+        else:
+            log.info(f"Removed {path}")
+
+
+def _link_checkpoint_metadata(checkpoint_path: Path, linked_checkpoint_path: Path):
+    # First, remove any existing metadata files
+    _remove_checkpoint_metadata(linked_checkpoint_path)
+
+    # Link the metadata files to the new checkpoint
+    for path in (
+        checkpoint_path.with_suffix(METADATA_PATH_SUFFIX),
+        checkpoint_path.with_suffix(HPARAMS_PATH_SUFFIX),
+    ):
+        linked_path = linked_checkpoint_path.with_suffix(path.suffix)
+        try:
+            try:
+                linked_path.symlink_to(path)
+            except OSError:
+                # on Windows, special permissions are required to create symbolic links as a regular user
+                # fall back to copying the file
+                shutil.copy(path, linked_path)
+        except Exception as e:
+            log.warning(f"Failed to link {path} to {linked_path}: {e}")
+        else:
+            log.info(f"Linked {path} to {linked_path}")
+
+
+def _checkpoint_sort_key_fn(key: Callable[[CheckpointMetadata, Path], Any]):
+    def sort_key_fn(checkpoint_path: Path):
+        if not (p := checkpoint_path.with_suffix(METADATA_PATH_SUFFIX)).exists():
+            raise FileNotFoundError(f"Metadata file not found: {p}")
+
+        nonlocal key
+        return key(CheckpointMetadata.from_file(p), p)
+
+    return sort_key_fn
+
+
+def _sort_ckpts_by_metadata(
+    checkpoint_paths: list[Path],
+    key: Callable[[CheckpointMetadata, Path], Any],
+    fallback_key: Callable[[Path], Any],
+):
+    # First, let's make sure all the metadata files exist.
+    # If not, use the fallback function to sort the checkpoints.
+    no_metadata_paths: list[Path] = []
+    for path in checkpoint_paths:
+        if (path.with_suffix(METADATA_PATH_SUFFIX)).exists():
+            continue
+
+        no_metadata_paths.append(path)
+
+    if no_metadata_paths:
+        log.warning(
+            f"Metadata file not found on {len(no_metadata_paths)} checkpoints: {no_metadata_paths}\n"
+            "Falling back to sorting by last modified time."
+        )
+        return sorted(checkpoint_paths, key=fallback_key)
+
+    return sorted(checkpoint_paths, key=_checkpoint_sort_key_fn(key))

nshtrainer/_checkpoint/saver.py

@@ -0,0 +1,52 @@
+import os
+import shutil
+from pathlib import Path
+
+from lightning.pytorch import Trainer
+
+from .metadata import _link_checkpoint_metadata, _remove_checkpoint_metadata
+
+
+def _link_checkpoint(
+    trainer: Trainer,
+    filepath: str | Path | os.PathLike,
+    linkpath: str | Path | os.PathLike,
+    *,
+    barrier: bool,
+    metadata: bool,
+):
+    if not isinstance(filepath, Path):
+        filepath = Path(filepath)
+    if not isinstance(linkpath, Path):
+        linkpath = Path(linkpath)
+
+    if trainer.is_global_zero:
+        if linkpath.exists():
+            if linkpath.is_symlink() or linkpath.is_file():
+                linkpath.unlink()
+            elif linkpath.is_dir():
+                shutil.rmtree(linkpath)
+            _remove_checkpoint_metadata(linkpath)
+
+        try:
+            target_path = filepath.relative_to(linkpath.parent)
+            linkpath.symlink_to(target_path)
+        except OSError:
+            # on Windows, special permissions are required to create symbolic links as a regular user
+            # fall back to copying the file
+            shutil.copy(filepath, linkpath)
+
+        _link_checkpoint_metadata(filepath, linkpath)
+    if barrier:
+        trainer.strategy.barrier()
+
+
+def _remove_checkpoint(
+    trainer: Trainer,
+    filepath: str | Path | os.PathLike,
+    remove_metadata: bool = True,
+):
+    if not isinstance(filepath, Path):
+        filepath = Path(filepath)
+    trainer.strategy.remove_checkpoint(filepath)
+    _remove_checkpoint_metadata(filepath)

nshtrainer/callbacks/latest_epoch_checkpoint.py

@@ -6,6 +6,8 @@ from lightning.pytorch import LightningModule, Trainer
 from lightning.pytorch.callbacks import Checkpoint
 from typing_extensions import override
 
+from .._checkpoint.metadata import _sort_ckpts_by_metadata
+from .._checkpoint.saver import _link_checkpoint, _remove_checkpoint
 from .base import CallbackConfigBase
 
 log = logging.getLogger(__name__)
@@ -17,15 +19,18 @@ class LatestEpochCheckpointCallbackConfig(CallbackConfigBase):
     dirpath: str | Path | None = None
     """Directory path to save the checkpoint file."""
 
-    filename: str = "latest_epoch{epoch:02d}_step{step:04d}.ckpt"
+    filename: str = "epoch{epoch:02d}_step{step:04d}"
     """Checkpoint filename. This must not include the extension."""
 
     save_weights_only: bool = False
     """Whether to save only the model's weights or the entire model object."""
 
-    latest_symlink_filename: str | None = "latest.ckpt"
+    latest_symlink_filename: str | None = "latest"
     """Filename for the latest symlink. If None, no symlink will be created."""
 
+    latest_k: int | Literal["all"] = 1
+    """Number of latest checkpoints to keep. If "all", all checkpoints are kept."""
+
     @override
     def create_callbacks(self, root_config):
         dirpath = self.dirpath or root_config.directory.resolve_subdirectory(
@@ -37,38 +42,73 @@ class LatestEpochCheckpointCallbackConfig(CallbackConfigBase):
 
 
 class LatestEpochCheckpoint(Checkpoint):
+    PREFIX = "latest_"
+    EXTENSION = ".ckpt"
+
     def __init__(self, config: LatestEpochCheckpointCallbackConfig, dirpath: Path):
         super().__init__()
 
         self.config = config
         self.dirpath = dirpath
 
+    @override
+    def on_train_epoch_end(self, trainer: Trainer, pl_module: LightningModule):
+        self._save_new_checkpoint(trainer)
+
+    def _latest_symlink_filename(self):
+        if (filename := self.config.latest_symlink_filename) is None:
+            return None
+        return f"{filename}{self.EXTENSION}"
+
     def _ckpt_path(self, trainer: Trainer):
-        return self.dirpath / self.config.filename.format(
+        filename = self.config.filename.format(
             epoch=trainer.current_epoch, step=trainer.global_step
         )
+        filename = f"{self.PREFIX}{filename}.{self.EXTENSION}"
+        return self.dirpath / filename
+
+    def _remove_checkpoints(self, trainer: Trainer, ckpt_paths: list[Path]):
+        for ckpt_path in ckpt_paths:
+            _remove_checkpoint(trainer, ckpt_path, remove_metadata=True)
+
+    def _remove_old_checkpoints(self, trainer: Trainer):
+        if (latest_k := self.config.latest_k) == "all":
+            return
+
+        # Get all configs, ignoring the latest symlink
+        ckpt_paths = list(self.dirpath.glob(f"{self.PREFIX}*{self.EXTENSION}"))
+        # Ignore the latest symlink
+        if (latest_symlink_filename := self._latest_symlink_filename()) is not None:
+            ckpt_paths = [p for p in ckpt_paths if p.name != latest_symlink_filename]
+
+        # Sort by epoch, then step, then last modified
+        ckpt_paths = _sort_ckpts_by_metadata(
+            ckpt_paths,
+            key=lambda meta, p: (meta.epoch, meta.global_step, p.stat().st_mtime),
+            fallback_key=lambda p: p.stat().st_mtime,
+            # ^ Called if metadata is not found on all checkpoints
+        )
+
+        # Remove all but the latest k checkpoints
+        ckpts_to_remove = ckpt_paths[:-latest_k]
+        self._remove_checkpoints(trainer, ckpts_to_remove)
+
+    def _save_new_checkpoint(self, trainer: Trainer):
+        # Remove old checkpoints
+        self._remove_old_checkpoints(trainer)
 
-    @override
-    def on_train_epoch_end(self, trainer: Trainer, pl_module: LightningModule):
         # Save the new checkpoint
         filepath = self._ckpt_path(trainer)
         trainer.save_checkpoint(filepath, self.config.save_weights_only)
 
         # Create the latest symlink
-        if (
-            trainer.is_global_zero
-            and (symlink_filename := self.config.latest_symlink_filename) is not None
-        ):
+        if (symlink_filename := self._latest_symlink_filename()) is not None:
             symlink_path = self.dirpath / symlink_filename
-            symlink_path.unlink(missing_ok=True)
-            symlink_path.symlink_to(filepath.name)
+            _link_checkpoint(
+                trainer,
+                filepath,
+                symlink_path,
+                barrier=True,
+                metadata=True,
+            )
             log.info(f"Created latest symlink: {symlink_path}")
-
-    def latest_checkpoint(self):
-        if (symlink_filename := self.config.latest_symlink_filename) is None:
-            return None
-
-        if not (symlink_path := self.dirpath / symlink_filename).exists():
-            return None
-
-        return symlink_path

nshtrainer/callbacks/model_checkpoint.py

@@ -4,11 +4,13 @@ from datetime import timedelta
 from pathlib import Path
 from typing import TYPE_CHECKING, Literal
 
+from lightning.pytorch import Trainer
 from lightning.pytorch.callbacks.model_checkpoint import (
     ModelCheckpoint as _ModelCheckpoint,
 )
 from typing_extensions import override
 
+from .._checkpoint.saver import _link_checkpoint, _remove_checkpoint
 from ..metrics import MetricConfig
 from .base import CallbackConfigBase
 
@@ -158,6 +160,8 @@ class ModelCheckpointCallbackConfig(CallbackConfigBase):
 
 
 class ModelCheckpoint(_ModelCheckpoint):
+    CHECKPOINT_NAME_LAST = "best"
+
     @override
     def __init__(
         self,
@@ -185,3 +189,17 @@ class ModelCheckpoint(_ModelCheckpoint):
             save_on_train_epoch_end=self.config.save_on_train_epoch_end,
             enable_version_counter=self.config.enable_version_counter,
         )
+
+    @override
+    def _link_checkpoint(self, trainer: Trainer, filepath: str, linkpath: str):  # pyright: ignore[reportIncompatibleMethodOverride]
+        return _link_checkpoint(
+            trainer,
+            filepath,
+            linkpath,
+            barrier=True,
+            metadata=True,
+        )
+
+    @override
+    def _remove_checkpoint(self, trainer: Trainer, filepath: str):
+        return _remove_checkpoint(trainer, filepath, remove_metadata=True)

{nshtrainer-0.10.10.dist-info → nshtrainer-0.10.11.dist-info}/METADATA

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

{nshtrainer-0.10.10.dist-info → nshtrainer-0.10.11.dist-info}/RECORD

@@ -1,6 +1,7 @@
 nshtrainer/__init__.py,sha256=39loiLLXbaGiozEsAn8mPHopxaPsek8JsgR9DD2gxtY,583
 nshtrainer/_checkpoint/loader.py,sha256=48flPr1XgQHOgIPaCrRqOEvRuG0SZuV3cQ1vgHLqFqI,11025
-nshtrainer/_checkpoint/metadata.py,sha256=C7je_soYyEbZjiq7p2_pSVFkgcXnz2J2H5sMy8oskx0,3051
+nshtrainer/_checkpoint/metadata.py,sha256=B6kPmWsq2TQh0gTzBx-1pLIwTVEs_Qw5v0nHEeTBdO4,5636
+nshtrainer/_checkpoint/saver.py,sha256=KZp9ITUVHwj2Ttu81zXKdlS_h-fKkHearspwuAijDpM,1501
 nshtrainer/_experimental/__init__.py,sha256=2tQIcrWT8U8no_AeBTYnozaTmxN40kuAJdGQ4b-PoWM,120
 nshtrainer/_experimental/flops/__init__.py,sha256=edo9Ez3LlrnxkNRX9W6YBhPkRPKYGLpkpnl5gx7sEX8,1550
 nshtrainer/_experimental/flops/flop_counter.py,sha256=-sL0Fy6poXa__hyzUMdZScjPULp4coQELQpPU6p6dXU,25736
@@ -14,9 +15,9 @@ nshtrainer/callbacks/ema.py,sha256=8-WHmKFP3VfnzMviJaIFmVD9xHPqIPmq9NRF5xdu3c8,1
 nshtrainer/callbacks/finite_checks.py,sha256=gJC_RUr3ais3FJI0uB6wUZnDdE3WRwCix3ppA3PwQXA,2077
 nshtrainer/callbacks/gradient_skipping.py,sha256=pqu5AELx4ctJxR2Y7YSSiGd5oGauVCTZFCEIIS6s88w,3665
 nshtrainer/callbacks/interval.py,sha256=smz5Zl8cN6X6yHKVsMRS2e3SEkzRCP3LvwE1ONvLfaw,8080
-nshtrainer/callbacks/latest_epoch_checkpoint.py,sha256=zCRAUsqW-2PaoIwVKlXOqdh2uF_B_YUUTmQO1wSomR8,2489
+nshtrainer/callbacks/latest_epoch_checkpoint.py,sha256=t4vWa4PvJDO3rKXKZbuegm7iLl7xCEd17wNif0Bp-BA,4138
 nshtrainer/callbacks/log_epoch.py,sha256=fTa_K_Y8A7g09630cG4YkDE6AzSMPkjb9bpPm4gtqos,1120
-nshtrainer/callbacks/model_checkpoint.py,sha256=wkT8sHGkIuatm4gSn4W-fqicA_HG5FBdaGA5THPFj4M,5948
+nshtrainer/callbacks/model_checkpoint.py,sha256=MaDkD8Ismcj8u6l2flCFlqJR3-k1Tc4xzhxNWNux4n0,6556
 nshtrainer/callbacks/norm_logging.py,sha256=T2psu8mYsw9iahPKT6aUPjkGrZ4TIzm6_UUUmE09GJs,6274
 nshtrainer/callbacks/on_exception_checkpoint.py,sha256=x42BYZ2ejf2rhqPLCmT5nyWKhA9qBEosiV8ZNhhZ6lI,3355
 nshtrainer/callbacks/print_table.py,sha256=_FdAHhqylWGk4Z0c2FrLFeiMA4jhfA_beZRK_BHpzmE,2837
@@ -78,6 +79,6 @@ nshtrainer/util/seed.py,sha256=Or2wMPsnQxfnZ2xfBiyMcHFIUt3tGTNeMMyOEanCkqs,280
 nshtrainer/util/slurm.py,sha256=rofIU26z3SdL79SF45tNez6juou1cyDLz07oXEZb9Hg,1566
 nshtrainer/util/typed.py,sha256=NGuDkDzFlc1fAoaXjOFZVbmj0mRFjsQi1E_hPa7Bn5U,128
 nshtrainer/util/typing_utils.py,sha256=8ptjSSLZxlmy4FY6lzzkoGoF5fGNClo8-B_c0XHQaNU,385
-nshtrainer-0.10.10.dist-info/METADATA,sha256=AQipVj-dOXT3cPwzbfvg6u3KdgLocc1BeaSLjndnL1A,696
-nshtrainer-0.10.10.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
-nshtrainer-0.10.10.dist-info/RECORD,,
+nshtrainer-0.10.11.dist-info/METADATA,sha256=9WAsp25_csjDcchr5X22g7ocQpQ-d-ewB3gS9EAZSE8,696
+nshtrainer-0.10.11.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
+nshtrainer-0.10.11.dist-info/RECORD,,