liblaf-cherries 2.0.1

A small Python experiment runner with typed settings, artifact path helpers, plugin hooks, and Comet/Git/local logging.

Explore the docs »

Changelog · Report Bug · Request Feature

✨ Features

• Typed experiment config: use Pydantic settings models as function arguments, with CLI parsing inherited from pydantic-settings.
• Path helpers that log themselves: create asset, input, output, and temp paths once, then let Cherries flush existing files at run end.
• Composable plugins: forward params, metrics, metadata, and artifacts through ordered hooks with before and after constraints.
• Built-in run profiles: choose local debug snapshots or full Comet, Git, local, and logging integration for regular runs.
• Artifact bundle expansion: log VTK .series frames and optional mesh landmark files alongside their primary artifact.

📦 Installation

uv add liblaf-cherries

🚀 Quick Start

from pathlib import Path

from liblaf import cherries


class Config(cherries.BaseConfig):
    name: str = "world"
    output: Path = cherries.output("hello.txt", mkdir=True)


def experiment(cfg: Config) -> None:
    message = f"Hello, {cfg.name}!"
    cfg.output.write_text(f"{message}\n")
    cherries.log_params({"name": cfg.name})
    cherries.log_metric("message_length", len(message))


if __name__ == "__main__":
    cherries.main(experiment, profile="debug")

profile="debug" keeps Comet disabled and Git commits off while still copying the entrypoint, logs, and logged artifacts into .cherries/. The default profile enables Comet, writes a Git summary, commits dirty changes, and logs the final Git SHA.

🧩 Plugin Model

Plugins subclass liblaf.cherries.core.Plugin, mark hook implementations with liblaf.cherries.core.impl(), and register on a Run or PluginManager. Hooks can return first results for getters, collect all non-None results for normal delegation, and keep running later plugins when one hook raises.

⌨️ Local Development

gh repo clone liblaf/cherries
cd cherries
mise run install
uv run pytest
mise run lint
mise run docs:build

🔗 Links

• Documentation
• Source Code
• Issue Tracker
• PyPI Package

---

📝 License

Copyright © 2025 liblaf.
This project is MIT licensed.