liblaf-cherries 0.0.14__py3-none-any.whl → 0.1.1__py3-none-any.whl

liblaf/cherries/plugin/__init__.pyi

@@ -1,77 +0,0 @@
-from ._abc import (
-    End,
-    LogArtifact,
-    LogArtifacts,
-    LogMetric,
-    LogParam,
-    Plugin,
-    RunStatus,
-    Start,
-)
-from ._dvc import DvcEnd, DvcLogArtifact, DvcLogArtifacts
-from ._git import GitEnd, GitStart
-from ._logging import LoggingEnd, LoggingStart
-from ._mlflow import (
-    MlflowEnd,
-    MlflowLogArtifact,
-    MlflowLogArtifacts,
-    MlflowLogMetric,
-    MlflowLogParam,
-    MlflowSetTag,
-    MlflowStart,
-)
-from ._run import (
-    Run,
-    end,
-    log_artifact,
-    log_artifacts,
-    log_input,
-    log_inputs,
-    log_metric,
-    log_output,
-    log_outputs,
-    log_param,
-    log_src,
-    run,
-    set_tag,
-    start,
-)
-
-__all__ = [
-    "DvcEnd",
-    "DvcLogArtifact",
-    "DvcLogArtifacts",
-    "End",
-    "GitEnd",
-    "GitStart",
-    "LogArtifact",
-    "LogArtifacts",
-    "LogMetric",
-    "LogParam",
-    "LoggingEnd",
-    "LoggingStart",
-    "MlflowEnd",
-    "MlflowLogArtifact",
-    "MlflowLogArtifacts",
-    "MlflowLogMetric",
-    "MlflowLogParam",
-    "MlflowSetTag",
-    "MlflowStart",
-    "Plugin",
-    "Run",
-    "RunStatus",
-    "Start",
-    "end",
-    "log_artifact",
-    "log_artifacts",
-    "log_input",
-    "log_inputs",
-    "log_metric",
-    "log_output",
-    "log_outputs",
-    "log_param",
-    "log_src",
-    "run",
-    "set_tag",
-    "start",
-]

liblaf/cherries/plugin/_abc.py

@@ -1,131 +0,0 @@
-from __future__ import annotations
-
-import bisect
-import enum
-import functools
-import operator
-from collections.abc import Iterable
-from pathlib import Path
-from typing import Any, override
-
-import attrs
-import mlflow
-import mlflow.entities
-from loguru import logger
-
-from liblaf.cherries import pathutils as _path
-from liblaf.cherries.typed import PathLike
-
-
-class RunStatus(enum.StrEnum):
-    FAILED = mlflow.entities.RunStatus.to_string(mlflow.entities.RunStatus.FAILED)
-    FINISHED = mlflow.entities.RunStatus.to_string(mlflow.entities.RunStatus.FINISHED)
-    KILLED = mlflow.entities.RunStatus.to_string(mlflow.entities.RunStatus.KILLED)
-
-
-@functools.total_ordering
-@attrs.define
-class Plugin[**P, T]:
-    priority: int = attrs.field(default=0, kw_only=True, eq=True, order=True)
-    _children: list[Plugin] = attrs.field(
-        factory=list, eq=False, order=False, alias="children"
-    )
-
-    def __attrs_post_init__(self) -> None:
-        self._children.sort(key=operator.attrgetter("priority"))
-
-    def __call__(self, *args: P.args, **kwargs: P.kwargs) -> T:
-        ret: T | None = None
-        for child in self._children:
-            try:
-                ret = child(*args, **kwargs)
-            except BaseException as err:
-                if isinstance(err, (KeyboardInterrupt, SystemExit)):
-                    raise
-                logger.exception(child)
-        return ret  # pyright: ignore[reportReturnType]
-
-    def __lt__(self, other: Plugin) -> bool:
-        if not isinstance(other, Plugin):
-            return NotImplemented
-        return self.priority < other.priority
-
-    def __eq__(self, other: Plugin) -> bool:  # pyright: ignore[reportIncompatibleMethodOverride]
-        if not isinstance(other, Plugin):
-            return NotImplemented
-        return self.priority == other.priority
-
-    @property
-    def children(self) -> list[Plugin]:
-        return self._children
-
-    def add(self, *child: Plugin) -> None:
-        for c in child:
-            bisect.insort(self._children, c, key=operator.attrgetter("priority"))
-
-    def extend(self, children: Iterable[Plugin]) -> None:
-        self.add(*children)
-
-    def remove(self, child: Plugin) -> None:
-        self._children.remove(child)
-
-
-@attrs.define
-class End(Plugin):
-    @override
-    def __call__(self, status: RunStatus = RunStatus.FINISHED) -> None:
-        return super().__call__(status)
-
-
-@attrs.define
-class LogArtifact(Plugin):
-    @override
-    def __call__(
-        self, local_path: PathLike, artifact_path: PathLike | None = None, **kwargs
-    ) -> Path:
-        ret: Path | None = super().__call__(local_path, artifact_path, **kwargs)
-        if ret is None:
-            ret = _path.as_path(local_path)
-        return ret
-
-
-@attrs.define
-class LogArtifacts(Plugin):
-    @override
-    def __call__(
-        self, local_dir: PathLike, artifact_path: PathLike | None = None, **kwargs
-    ) -> Path:
-        ret: Path | None = super().__call__(local_dir, artifact_path, **kwargs)
-        if ret is None:
-            ret = _path.as_path(local_dir)
-        return ret
-
-
-@attrs.define
-class LogMetric(Plugin):
-    @override
-    def __call__(
-        self, key: str, value: float, step: int | None = None, **kwargs
-    ) -> None:
-        return super().__call__(key, value, step, **kwargs)
-
-
-@attrs.define
-class LogParam(Plugin):
-    @override
-    def __call__(self, key: str, value: Any, **kwargs) -> None:
-        return super().__call__(key, value, **kwargs)
-
-
-@attrs.define
-class SetTag(Plugin):
-    @override
-    def __call__(self, key: str, value: Any, **kwargs) -> None:
-        return super().__call__(key, value, **kwargs)
-
-
-@attrs.define
-class Start(Plugin):
-    @override
-    def __call__(self) -> None:
-        return super().__call__()

liblaf/cherries/plugin/_dvc.py

@@ -1,63 +0,0 @@
-import subprocess as sp
-from pathlib import Path
-from typing import override
-
-import attrs
-import git
-import git.exc
-
-from liblaf.cherries import pathutils as _path
-from liblaf.cherries.typed import PathLike
-
-from ._abc import End, LogArtifact, LogArtifacts, RunStatus
-
-
-@attrs.define
-class DvcEnd(End):
-    @override
-    def __call__(self, status: RunStatus = RunStatus.FINISHED) -> None:
-        sp.run(["dvc", "status"], check=True)
-        sp.run(["dvc", "push"], check=True)
-
-
-@attrs.define
-class DvcLogArtifact(LogArtifact):
-    @override
-    def __call__(
-        self, local_path: PathLike, artifact_path: PathLike | None = None, **kwargs
-    ) -> Path:
-        local_path: Path = _path.as_path(local_path)
-        if check_ignore(local_path) or tracked_by_git(local_path):
-            return local_path
-        sp.run(["dvc", "add", local_path], check=True)
-        return local_path
-
-
-@attrs.define
-class DvcLogArtifacts(LogArtifacts):
-    @override
-    def __call__(
-        self, local_dir: PathLike, artifact_path: PathLike | None = None, **kwargs
-    ) -> Path:
-        local_dir: Path = _path.as_path(local_dir)
-        if check_ignore(local_dir) or tracked_by_git(local_dir):
-            return local_dir
-        sp.run(["dvc", "add", local_dir], check=True)
-        return local_dir
-
-
-def check_ignore(local_path: PathLike) -> bool:
-    proc: sp.CompletedProcess[bytes] = sp.run(
-        ["dvc", "check-ignore", local_path], check=False
-    )
-    return proc.returncode == 0
-
-
-def tracked_by_git(local_path: PathLike) -> bool:
-    local_path: Path = _path.as_path(local_path).absolute()
-    try:
-        repo = git.Repo(search_parent_directories=True)
-        repo.git.ls_files(local_path, error_unmatch=True)
-    except git.exc.GitCommandError:
-        return False
-    return True

liblaf/cherries/plugin/_git.py

@@ -1,46 +0,0 @@
-from typing import override
-
-import attrs
-from environs import env
-
-from liblaf.cherries import info as _info
-
-from ._abc import End, RunStatus, Start
-from ._run import run
-
-
-@attrs.define
-class GitEnd(End):
-    dry_run: bool = env.bool("LIBLAF_CHERRIES_GIT_DRY_RUN", default=False)
-
-    @override
-    def __call__(self, status: RunStatus = RunStatus.FINISHED) -> None:
-        git_auto_commit(
-            "chore(cherries): auto commit (on run end)", dry_run=self.dry_run
-        )
-
-
-@attrs.define
-class GitStart(Start):
-    dry_run: bool = env.bool("LIBLAF_CHERRIES_GIT_DRY_RUN", default=False)
-
-    @override
-    def __call__(self) -> None:
-        git_auto_commit(
-            "chore(cherries): auto commit (on run start)", dry_run=self.dry_run
-        )
-
-
-def git_auto_commit(
-    header: str = "chore(cherries): auto commit", *, dry_run: bool = False
-) -> None:
-    body: str = ""
-    if run.run_name and run.run_url:
-        body += f"🏃 View run {run.run_name} at: {run.run_url}\n"
-    if run.exp_name and run.exp_url:
-        body += f"🧪 View experiment {run.exp_name} at: {run.exp_url}\n"
-    message: str = f"{header}\n\n{body}" if body else header
-    _info.git_auto_commit(message, dry_run=dry_run)
-    run.set_tag("cherries.git.branch", _info.git_branch())
-    run.set_tag("cherries.git.sha", _info.git_commit_sha())
-    run.set_tag("cherries.git.url", _info.git_commit_url())

liblaf/cherries/plugin/_logging.py

@@ -1,31 +0,0 @@
-from typing import override
-
-import attrs
-from loguru import logger
-
-from liblaf import grapes
-
-from ._abc import End, RunStatus, Start
-from ._run import run
-
-
-@attrs.define
-class LoggingEnd(End):
-    @override
-    def __call__(self, status: RunStatus = RunStatus.FINISHED) -> None:
-        logger.complete()
-        run.log_artifact(run.exp_dir / "run.log")
-        run.log_artifact(run.exp_dir / "run.log.jsonl")
-
-
-@attrs.define
-class LoggingStart(Start):
-    @override
-    def __call__(self) -> None:
-        grapes.init_logging(
-            handlers=[
-                grapes.logging.rich_handler(),
-                grapes.logging.file_handler(sink=run.exp_dir / "run.log"),
-                grapes.logging.jsonl_handler(sink=run.exp_dir / "run.log.jsonl"),
-            ]
-        )

liblaf/cherries/plugin/_mlflow.py

@@ -1,88 +0,0 @@
-from pathlib import Path
-from typing import Any, override
-
-import attrs
-import mlflow
-
-from liblaf.cherries import info as _info
-from liblaf.cherries import pathutils as _path
-from liblaf.cherries.typed import PathLike
-
-from ._abc import (
-    End,
-    LogArtifact,
-    LogArtifacts,
-    LogMetric,
-    LogParam,
-    RunStatus,
-    SetTag,
-    Start,
-)
-
-
-@attrs.define
-class MlflowEnd(End):
-    @override
-    def __call__(self, status: RunStatus = RunStatus.FINISHED) -> None:
-        mlflow.end_run(status)
-
-
-@attrs.define
-class MlflowLogArtifact(LogArtifact):
-    @override
-    def __call__(
-        self, local_path: PathLike, artifact_path: PathLike | None = None, **kwargs
-    ) -> Path:
-        local_path: Path = _path.as_path(local_path)
-        if (dvc_file := local_path.with_name(local_path.name + ".dvc")).is_file():
-            local_path = dvc_file
-        mlflow.log_artifact(
-            _path.as_os_path(local_path), _path.as_posix(artifact_path), **kwargs
-        )
-        return _path.as_path(local_path)
-
-
-@attrs.define
-class MlflowLogArtifacts(LogArtifacts):
-    @override
-    def __call__(
-        self, local_dir: PathLike, artifact_path: PathLike | None = None, **kwargs
-    ) -> Path:
-        local_dir: Path = _path.as_path(local_dir)
-        if (dvc_file := local_dir.with_name(local_dir.name + ".dvc")).is_file():
-            local_dir = dvc_file
-        mlflow.log_artifact(
-            _path.as_os_path(local_dir), _path.as_posix(artifact_path), **kwargs
-        )
-        return _path.as_path(local_dir)
-
-
-@attrs.define
-class MlflowLogParam(LogParam):
-    @override
-    def __call__(self, key: str, value: Any, **kwargs) -> None:
-        mlflow.log_param(key, value, **kwargs)
-
-
-@attrs.define
-class MlflowLogMetric(LogMetric):
-    @override
-    def __call__(
-        self, key: str, value: float, step: int | None = None, **kwargs
-    ) -> None:
-        mlflow.log_metric(key, value, step, **kwargs)
-
-
-@attrs.define
-class MlflowSetTag(SetTag):
-    @override
-    def __call__(self, key: str, value: Any, **kwargs) -> None:
-        mlflow.set_tag(key, value, **kwargs)
-
-
-@attrs.define
-class MlflowStart(Start):
-    @override
-    def __call__(self) -> None:
-        mlflow.set_experiment(_info.exp_name())
-        mlflow.start_run(run_name=_info.run_name())

liblaf/cherries/plugin/_run.py

@@ -1,105 +0,0 @@
-import datetime
-import functools
-from pathlib import Path
-
-import attrs
-import mlflow
-
-from liblaf.cherries import pathutils as _path
-from liblaf.cherries.typed import PathLike
-
-from ._abc import End, LogArtifact, LogArtifacts, LogMetric, LogParam, SetTag, Start
-
-
-@attrs.define
-class Run:
-    end: End = attrs.field(factory=End, init=False)
-    log_artifact: LogArtifact = attrs.field(factory=LogArtifact, init=False)
-    log_artifacts: LogArtifacts = attrs.field(factory=LogArtifacts, init=False)
-    log_metric: LogMetric = attrs.field(factory=LogMetric, init=False)
-    log_param: LogParam = attrs.field(factory=LogParam, init=False)
-    set_tag: SetTag = attrs.field(factory=SetTag, init=False)
-    start: Start = attrs.field(factory=Start, init=False)
-
-    @property
-    def active_run(self) -> mlflow.ActiveRun:
-        return mlflow.active_run()  # pyright: ignore[reportReturnType]
-
-    @functools.cached_property
-    def exp_dir(self) -> Path:
-        return _path.run_dir(absolute=True)
-
-    @property
-    def exp_id(self) -> str:
-        return self.active_run.info.experiment_id
-
-    @property
-    def exp_name(self) -> str:
-        return self.exp_id
-
-    @property
-    def exp_url(self) -> str:
-        tracking_uri: str = self.tracking_uri.rstrip("/")
-        return f"{tracking_uri}/#/experiments/{self.exp_id}"
-
-    @property
-    def tracking_uri(self) -> str:
-        return mlflow.get_tracking_uri()
-
-    @property
-    def run_id(self) -> str:
-        return self.active_run.info.run_id
-
-    @property
-    def run_name(self) -> str:
-        return self.active_run.info.run_name  # pyright: ignore[reportReturnType]
-
-    @property
-    def run_url(self) -> str:
-        return f"{self.exp_url}/runs/{self.run_id}"
-
-    @property
-    def start_time(self) -> datetime.datetime:
-        return datetime.datetime.fromtimestamp(
-            self.active_run.info.start_time / 1000, tz=datetime.UTC
-        ).astimezone()
-
-    def log_input(
-        self, local_path: PathLike, artifact_path: PathLike | None = "inputs", **kwargs
-    ) -> Path:
-        return self.log_artifact(local_path, artifact_path, **kwargs)
-
-    def log_inputs(
-        self, local_dir: PathLike, artifact_path: PathLike | None = "inputs", **kwargs
-    ) -> Path:
-        return self.log_artifacts(local_dir, artifact_path, **kwargs)
-
-    def log_output(
-        self, local_path: PathLike, artifact_path: PathLike | None = "outputs", **kwargs
-    ) -> Path:
-        return self.log_artifact(local_path, artifact_path, **kwargs)
-
-    def log_outputs(
-        self, local_dir: PathLike, artifact_path: PathLike | None = "outputs", **kwargs
-    ) -> Path:
-        return self.log_artifacts(local_dir, artifact_path, **kwargs)
-
-    def log_src(
-        self, local_path: PathLike, artifact_path: PathLike | None = "src", **kwargs
-    ) -> Path:
-        return self.log_artifact(local_path, artifact_path, **kwargs)
-
-
-run = Run()
-end: End = run.end
-log_artifact: LogArtifact = run.log_artifact
-log_artifacts: LogArtifacts = run.log_artifacts
-log_metric: LogMetric = run.log_metric
-log_param: LogParam = run.log_param
-set_tag: SetTag = run.set_tag
-start: Start = run.start
-log_input = run.log_input
-log_inputs = run.log_inputs
-log_output = run.log_output
-log_outputs = run.log_outputs
-log_src = run.log_src

liblaf_cherries-0.0.14.dist-info/RECORD

@@ -1,35 +0,0 @@
-liblaf/cherries/__init__.py,sha256=OHb6Xou2v6u42swTgjRfzej4CIlRg4OmgOIQXUiRjKA,97
-liblaf/cherries/__init__.pyi,sha256=ShYXNS05TvRjr5XTKurtBiToTR3T1JX2Ub0njjbMsuM,1370
-liblaf/cherries/_config.py,sha256=rm-Y6roi8hBvQYdH-VQh_ovWCyVsX_7R0x1jokBPCDM,741
-liblaf/cherries/_run.py,sha256=vbJ5-Fh8azNhemVf4qyNUc5RaFA8HgFHZOmzdRMPF2k,1085
-liblaf/cherries/_version.py,sha256=JAP571q66KmOqXyFj53ns1X0_trh2aTxt2bW41ljMkc,513
-liblaf/cherries/_version.pyi,sha256=Pnv4Bxw13LHeuVkPLPsTtnp4N4jOGcAfFJw05uMMgBY,108
-liblaf/cherries/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-liblaf/cherries/typed.py,sha256=mim8QVtwczTSHyw5mhEdfFcXis9o32n0CZyu8BrEorE,50
-liblaf/cherries/info/__init__.py,sha256=OHb6Xou2v6u42swTgjRfzej4CIlRg4OmgOIQXUiRjKA,97
-liblaf/cherries/info/__init__.pyi,sha256=beKfSRY1wVsTPBOkWZ7ukmMZo0NKHzp00Q51cFUArbM,274
-liblaf/cherries/info/_git.py,sha256=oy1xx23sXWA7RqQuLGc3HxcLCF7zHTSpZvZ9pukJGdI,1232
-liblaf/cherries/info/_name.py,sha256=RhB0tqygzBNTS6ZK9unLu7DeuiQaudAvIyeHj0nf2HA,752
-liblaf/cherries/pathutils/__init__.py,sha256=OHb6Xou2v6u42swTgjRfzej4CIlRg4OmgOIQXUiRjKA,97
-liblaf/cherries/pathutils/__init__.pyi,sha256=JEotcjG2QNC3LaVM7aoLd7l0Ny6m0QyQKeePefS22LM,413
-liblaf/cherries/pathutils/_convert.py,sha256=JTO9vETXvj7f4GTtIbOmAoDNEDc_4hoEHZ7ujbyTgS8,859
-liblaf/cherries/pathutils/_path.py,sha256=35WgGghvXq56mFCqT7jYaPo7mO3rnRyRdBh6--woBxE,1548
-liblaf/cherries/pathutils/_special.py,sha256=UZ9dAPj7EAqlRqzQD_b_Z-uCHjv6W_gtMs1Wfr_nDuc,1415
-liblaf/cherries/plugin/__init__.py,sha256=OHb6Xou2v6u42swTgjRfzej4CIlRg4OmgOIQXUiRjKA,97
-liblaf/cherries/plugin/__init__.pyi,sha256=2PPdTp-vfgP34sKGnjCR1oMG5ljTmkZkabr_LV74tXA,1299
-liblaf/cherries/plugin/_abc.py,sha256=H-NH6Gpv3dTJKjaekuAKSn_H0TJPxF-TLa5UU51NNjg,3748
-liblaf/cherries/plugin/_dvc.py,sha256=1cMcKJmO-9FFWjiQ_V-BqmF9XaKmOiwdE9y3aeFoodY,1800
-liblaf/cherries/plugin/_git.py,sha256=AY6AugwyqtcCAaX475zDINFHgHG1UKupWplquEPbjWU,1396
-liblaf/cherries/plugin/_logging.py,sha256=EJ-6VgY8Fyn_o2R68diqT7vwnOnuJBPQU7IjwvjKVco,784
-liblaf/cherries/plugin/_mlflow.py,sha256=JS0oGojDyPTUF-Q8ZUJrO36hUXckNFeViAIjJ6lo3ng,2287
-liblaf/cherries/plugin/_run.py,sha256=ldEzxD-PrAiHBwMGjQKiU9eyc0sriwKXPEU6JbId6kE,3287
-liblaf/cherries/presets/__init__.py,sha256=OHb6Xou2v6u42swTgjRfzej4CIlRg4OmgOIQXUiRjKA,97
-liblaf/cherries/presets/__init__.pyi,sha256=ka0zjVDb1kWn1VuDGjAzMX5S9sVKKYcxKelp4EwUBf8,53
-liblaf/cherries/presets/_default.py,sha256=hhe10JzMui8WJhvoLlOfDCHMRlPmdnzRSduFH7rCtP0,742
-liblaf/cherries/utils/__init__.py,sha256=OHb6Xou2v6u42swTgjRfzej4CIlRg4OmgOIQXUiRjKA,97
-liblaf/cherries/utils/__init__.pyi,sha256=F5aTcXpWVmUoctPbLfmQXKyuXYRspAIjaIzfL1_3Lrw,51
-liblaf/cherries/utils/_functools.py,sha256=0Puwvj1Wq4kp3S--hI-CXwUBZ56AtfkqIzFHllQtuug,181
-liblaf_cherries-0.0.14.dist-info/METADATA,sha256=_s8gjrpYQBGHkxYz_D9ibagwI478PgQujoy1AI2vnD0,1944
-liblaf_cherries-0.0.14.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-liblaf_cherries-0.0.14.dist-info/licenses/LICENSE,sha256=Ph4NzyU3lGVDeYv-mf8aRmImH8v9rVL9F362FV4G6Ow,1063
-liblaf_cherries-0.0.14.dist-info/RECORD,,