laco-dvc 1.0.0__tar.gz

laco_dvc-1.0.0/PKG-INFO

@@ -0,0 +1,29 @@
+Metadata-Version: 2.4
+Name: laco-dvc
+Version: 1.0.0
+Summary: DVC artifact tracking integration for laco.
+Author-email: Kurt Stolle <kurt@khws.io>
+Requires-Python: >=3.13
+Description-Content-Type: text/markdown
+Requires-Dist: laco>=1.0.0
+Requires-Dist: dvc>=3.0
+
+# Laco-DVC
+
+DVC artifact tracking for laco experiments.
+
+Part of the [laco](https://github.com/khwstolle/laco) project — see the [root README](../../README.md) for an overview.
+
+## Installation
+
+```bash
+pip install laco-dvc
+```
+
+## Features
+
+`commit_config()`, `add()`, `track()` context manager
+
+## Usage
+
+See [`docs/index.md`](docs/index.md) for the full guide.

laco_dvc-1.0.0/README.md

@@ -0,0 +1,19 @@
+# Laco-DVC
+
+DVC artifact tracking for laco experiments.
+
+Part of the [laco](https://github.com/khwstolle/laco) project — see the [root README](../../README.md) for an overview.
+
+## Installation
+
+```bash
+pip install laco-dvc
+```
+
+## Features
+
+`commit_config()`, `add()`, `track()` context manager
+
+## Usage
+
+See [`docs/index.md`](docs/index.md) for the full guide.

laco_dvc-1.0.0/pyproject.toml

@@ -0,0 +1,19 @@
+[build-system]
+requires = ["setuptools>=75", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "laco-dvc"
+version = "1.0.0"
+description = "DVC artifact tracking integration for laco."
+readme = "README.md"
+requires-python = ">=3.13"
+authors = [{ name = "Kurt Stolle", email = "kurt@khws.io" }]
+dependencies = ["laco>=1.0.0", "dvc>=3.0"]
+
+[tool.setuptools.packages.find]
+where = ["sources"]
+namespaces = true
+
+[tool.uv.sources]
+laco = { workspace = true }

laco_dvc-1.0.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

laco_dvc-1.0.0/sources/laco/integrations/dvc/__init__.py

@@ -0,0 +1,28 @@
+"""DVC artifact tracking integration for laco.
+
+Tracks laco config files and output directories as DVC artifacts, making
+experiment outputs reproducible and linkable to their exact config.
+
+Examples
+--------
+::
+
+    import laco
+    import laco.integrations.dvc as laco_dvc
+
+    cfg = laco.load("configs/train.py")
+
+    # Run training and track outputs with DVC:
+    with laco_dvc.track(cfg, output_dir="outputs/run-001") as tracker:
+        train(cfg)
+        tracker.add("outputs/run-001/checkpoint.pt")
+
+    # Or just commit the config snapshot after a run:
+    laco_dvc.commit_config(cfg, path="outputs/run-001/config.yaml")
+"""
+
+from laco.integrations.dvc._core import add as add
+from laco.integrations.dvc._core import commit_config as commit_config
+from laco.integrations.dvc._core import track as track
+
+__all__ = ["add", "commit_config", "track"]

laco_dvc-1.0.0/sources/laco/integrations/dvc/_core.py

@@ -0,0 +1,117 @@
+"""Implementation for laco-dvc."""
+
+from __future__ import annotations
+
+import contextlib
+import pathlib
+import typing
+
+
+def commit_config(
+    cfg: typing.Any,
+    *,
+    path: str | pathlib.Path = "config.yaml",
+    message: str | None = None,
+) -> pathlib.Path:
+    """Save a resolved laco DictConfig as a DVC-tracked YAML file.
+
+    Writes *cfg* to *path*, runs ``dvc add`` on it, and optionally commits
+    the resulting ``.dvc`` stub to git.
+
+    Parameters
+    ----------
+    cfg : DictConfig
+        Resolved OmegaConf DictConfig from ``laco.load()``.
+    path : str | Path
+        Destination file path. Created (with parents) if absent.
+        Default: ``"config.yaml"``.
+    message : str | None
+        If set, also runs ``git commit -m <message>`` on the generated
+        ``.dvc`` stub.
+
+    Returns
+    -------
+    Path
+        Path to the saved YAML file.
+    """
+    import subprocess
+
+    from omegaconf import OmegaConf
+
+    out = pathlib.Path(path)
+    out.parent.mkdir(parents=True, exist_ok=True)
+    out.write_text(OmegaConf.to_yaml(cfg, resolve=True))
+
+    subprocess.run(["dvc", "add", str(out)], check=True)  # noqa: S603, S607
+
+    if message:
+        dvc_stub = out.with_suffix(out.suffix + ".dvc")
+        subprocess.run(  # noqa: S603, S607
+            ["git", "commit", str(dvc_stub), "-m", message], check=True
+        )
+
+    return out
+
+
+def add(path: str | pathlib.Path) -> None:
+    """Run ``dvc add`` on *path* to start tracking it as a DVC artifact.
+
+    Parameters
+    ----------
+    path : str | Path
+        File or directory to track with DVC.
+    """
+    import subprocess
+
+    subprocess.run(["dvc", "add", str(path)], check=True)  # noqa: S603, S607
+
+
+@contextlib.contextmanager
+def track(
+    cfg: typing.Any,
+    *,
+    output_dir: str | pathlib.Path,
+    config_name: str = "config.yaml",
+) -> typing.Generator[_Tracker]:
+    """Context manager that saves the config and tracks outputs with DVC.
+
+    Saves *cfg* as ``<output_dir>/<config_name>`` on entry, then calls
+    ``dvc add`` on any paths registered via ``tracker.add()`` on exit.
+
+    Parameters
+    ----------
+    cfg : DictConfig
+        Resolved laco DictConfig.
+    output_dir : str | Path
+        Directory where run artifacts are written.
+    config_name : str
+        Filename for the config snapshot inside *output_dir*.
+        Default: ``"config.yaml"``.
+
+    Yields
+    ------
+    _Tracker
+        Object with an ``add(path)`` method for registering outputs to be
+        tracked by DVC on context exit.
+    """
+    out = pathlib.Path(output_dir)
+    out.mkdir(parents=True, exist_ok=True)
+    commit_config(cfg, path=out / config_name)
+
+    tracker = _Tracker()
+    try:
+        yield tracker
+    finally:
+        for p in tracker._paths:
+            add(p)
+
+
+class _Tracker:
+    """Collects output paths to be DVC-tracked on context exit."""
+
+    def __init__(self) -> None:
+        self._paths: list[pathlib.Path] = []
+
+    def add(self, path: str | pathlib.Path) -> None:
+        """Register *path* to be tracked by DVC when the context exits."""
+        self._paths.append(pathlib.Path(path))

laco_dvc-1.0.0/sources/laco_dvc.egg-info/PKG-INFO

@@ -0,0 +1,29 @@
+Metadata-Version: 2.4
+Name: laco-dvc
+Version: 1.0.0
+Summary: DVC artifact tracking integration for laco.
+Author-email: Kurt Stolle <kurt@khws.io>
+Requires-Python: >=3.13
+Description-Content-Type: text/markdown
+Requires-Dist: laco>=1.0.0
+Requires-Dist: dvc>=3.0
+
+# Laco-DVC
+
+DVC artifact tracking for laco experiments.
+
+Part of the [laco](https://github.com/khwstolle/laco) project — see the [root README](../../README.md) for an overview.
+
+## Installation
+
+```bash
+pip install laco-dvc
+```
+
+## Features
+
+`commit_config()`, `add()`, `track()` context manager
+
+## Usage
+
+See [`docs/index.md`](docs/index.md) for the full guide.

laco_dvc-1.0.0/sources/laco_dvc.egg-info/SOURCES.txt

@@ -0,0 +1,10 @@
+README.md
+pyproject.toml
+sources/laco/integrations/dvc/__init__.py
+sources/laco/integrations/dvc/_core.py
+sources/laco_dvc.egg-info/PKG-INFO
+sources/laco_dvc.egg-info/SOURCES.txt
+sources/laco_dvc.egg-info/dependency_links.txt
+sources/laco_dvc.egg-info/requires.txt
+sources/laco_dvc.egg-info/top_level.txt
+tests/test_laco_dvc.py

laco_dvc-1.0.0/sources/laco_dvc.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

laco_dvc-1.0.0/sources/laco_dvc.egg-info/requires.txt

@@ -0,0 +1,2 @@
+laco>=1.0.0
+dvc>=3.0

laco_dvc-1.0.0/sources/laco_dvc.egg-info/top_level.txt

@@ -0,0 +1 @@
+laco

laco_dvc-1.0.0/tests/test_laco_dvc.py

@@ -0,0 +1,91 @@
+"""Tests for laco-dvc."""
+
+from unittest.mock import patch
+
+
+def test_import():
+    import laco.integrations.dvc  # noqa: F401
+
+
+def test_public_api():
+    import laco.integrations.dvc as laco_dvc
+
+    assert set(laco_dvc.__all__) == {"add", "commit_config", "track"}
+
+
+def test_add_calls_dvc(tmp_path):
+    import laco.integrations.dvc as laco_dvc
+
+    target = tmp_path / "artifact.pt"
+    target.write_bytes(b"data")
+
+    with patch("subprocess.run") as mock_run:
+        laco_dvc.add(target)
+        mock_run.assert_called_once_with(["dvc", "add", str(target)], check=True)
+
+
+def test_commit_config_writes_yaml_and_calls_dvc(tmp_path):
+    import laco.integrations.dvc as laco_dvc
+    from omegaconf import OmegaConf
+
+    cfg = OmegaConf.create({"lr": 0.001, "epochs": 10})
+    out = tmp_path / "config.yaml"
+
+    with patch("subprocess.run") as mock_run:
+        result = laco_dvc.commit_config(cfg, path=out)
+
+    assert result == out
+    assert out.exists()
+    content = out.read_text()
+    assert "lr:" in content
+    assert "epochs:" in content
+    mock_run.assert_called_once_with(["dvc", "add", str(out)], check=True)
+
+
+def test_commit_config_with_git_message(tmp_path):
+    import laco.integrations.dvc as laco_dvc
+    from omegaconf import OmegaConf
+
+    cfg = OmegaConf.create({"lr": 0.001})
+    out = tmp_path / "config.yaml"
+    dvc_stub = out.with_suffix(".yaml.dvc")
+
+    with patch("subprocess.run") as mock_run:
+        laco_dvc.commit_config(cfg, path=out, message="track config")
+
+    assert mock_run.call_count == 2
+    mock_run.assert_any_call(["dvc", "add", str(out)], check=True)
+    mock_run.assert_any_call(
+        ["git", "commit", str(dvc_stub), "-m", "track config"], check=True
+    )
+
+
+def test_track_context_manager(tmp_path):
+    import laco.integrations.dvc as laco_dvc
+    from omegaconf import OmegaConf
+
+    cfg = OmegaConf.create({"lr": 0.001})
+    output_dir = tmp_path / "run-001"
+    artifact = output_dir / "model.pt"
+
+    with patch("subprocess.run"):
+        with laco_dvc.track(cfg, output_dir=output_dir) as tracker:
+            artifact.write_bytes(b"weights")
+            tracker.add(artifact)
+
+    assert artifact.exists()
+
+
+def test_tracker_add_registers_paths(tmp_path):
+    from laco.integrations.dvc._core import _Tracker
+
+    tracker = _Tracker()
+    path_a = tmp_path / "a.pt"
+    path_b = tmp_path / "b.pt"
+
+    tracker.add(path_a)
+    tracker.add(str(path_b))
+
+    assert len(tracker._paths) == 2
+    assert tracker._paths[0] == path_a
+    assert tracker._paths[1] == path_b