liblaf-cherries 0.2.0__tar.gz → 0.2.2__tar.gz

{liblaf_cherries-0.2.0 → liblaf_cherries-0.2.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: liblaf-cherries
-Version: 0.2.0
+Version: 0.2.2
 Summary: Add your description here
 Project-URL: Changelog, https://github.com/liblaf/cherries/blob/main/CHANGELOG.md
 Project-URL: Documentation, https://liblaf.github.io/cherries/
@@ -37,7 +37,7 @@ Requires-Dist: dvc[webdav]<4,>=3.0.0
 Requires-Dist: environs<15,>=14.0.0
 Requires-Dist: gitpython<4,>=3.0.0
 Requires-Dist: lazy-loader<0.5,>=0.4
-Requires-Dist: liblaf-grapes<0.7,>=0.6.0
+Requires-Dist: liblaf-grapes<2,>=1.0.0
 Requires-Dist: loguru<0.8,>=0.7.0
 Requires-Dist: networkx<4,>=3.0.0
 Requires-Dist: pydantic-settings<3,>=2.0.0

{liblaf_cherries-0.2.0 → liblaf_cherries-0.2.2}/pyproject.toml

@@ -64,7 +64,7 @@ dependencies = [
   "environs>=14.0.0,<15",
   "gitpython>=3.0.0,<4",
   "lazy-loader>=0.4,<0.5",
-  "liblaf-grapes>=0.6.0,<0.7",
+  "liblaf-grapes>=1.0.0,<2",
   "loguru>=0.7.0,<0.8",
   "networkx>=3.0.0,<4",
   "pydantic-settings>=2.0.0,<3",

{liblaf_cherries-0.2.0 → liblaf_cherries-0.2.2}/src/liblaf/cherries/__init__.pyi

@@ -1,7 +1,24 @@
-from . import config, core, meta, paths
+from . import config, core, meta, paths, plugins
 from ._entrypoint import end, run, start
 from .config import BaseConfig, input, output  # noqa: A004
-from .core import Plugin, Run, active_run, log_asset, log_metrics
+from .core import (
+    Plugin,
+    Run,
+    active_run,
+    log_asset,
+    log_asset_data,
+    log_asset_folder,
+    log_input,
+    log_input_folder,
+    log_metric,
+    log_metrics,
+    log_other,
+    log_others,
+    log_output,
+    log_output_folder,
+    log_parameter,
+    log_parameters,
+)
 from .paths import (
     as_os_path,
     as_path,
@@ -37,13 +54,25 @@ __all__ = [
     "input",
     "inputs",
     "log_asset",
+    "log_asset_data",
+    "log_asset_folder",
+    "log_input",
+    "log_input_folder",
+    "log_metric",
     "log_metrics",
+    "log_other",
+    "log_others",
+    "log_output",
+    "log_output_folder",
+    "log_parameter",
+    "log_parameters",
     "meta",
     "output",
     "outputs",
     "params",
     "path",
     "paths",
+    "plugins",
     "run",
     "src",
     "start",

{liblaf_cherries-0.2.0 → liblaf_cherries-0.2.2}/src/liblaf/cherries/_version.py

@@ -17,5 +17,5 @@ __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
 
-__version__ = version = '0.2.0'
-__version_tuple__ = version_tuple = (0, 2, 0)
+__version__ = version = '0.2.2'
+__version_tuple__ = version_tuple = (0, 2, 2)

liblaf_cherries-0.2.2/src/liblaf/cherries/core/__init__.pyi

@@ -0,0 +1,51 @@
+from ._impl import ImplInfo, get_impl_info, impl
+from ._plugin import Plugin
+from ._run import (
+    Run,
+    active_run,
+    end,
+    log_asset,
+    log_asset_data,
+    log_asset_folder,
+    log_input,
+    log_input_folder,
+    log_metric,
+    log_metrics,
+    log_other,
+    log_others,
+    log_output,
+    log_output_folder,
+    log_parameter,
+    log_parameters,
+    start,
+)
+from ._spec import SpecInfo, spec
+from .typed import MethodName, PluginId
+
+__all__ = [
+    "ImplInfo",
+    "MethodName",
+    "Plugin",
+    "PluginId",
+    "Run",
+    "SpecInfo",
+    "active_run",
+    "end",
+    "get_impl_info",
+    "impl",
+    "log_asset",
+    "log_asset_data",
+    "log_asset_folder",
+    "log_input",
+    "log_input_folder",
+    "log_metric",
+    "log_metrics",
+    "log_other",
+    "log_others",
+    "log_output",
+    "log_output_folder",
+    "log_parameter",
+    "log_parameters",
+    "spec",
+    "start",
+]

{liblaf_cherries-0.2.0 → liblaf_cherries-0.2.2}/src/liblaf/cherries/core/_impl.py

@@ -3,6 +3,7 @@ from collections.abc import Callable, Iterable
 from typing import Any, overload
 
 import attrs
+import wrapt
 
 from liblaf import grapes
 
@@ -41,18 +42,19 @@ def impl(
 ) -> Any:
     if func is None:
         return functools.partial(impl, priority=priority, after=after, before=before)
-    info = ImplInfo(after=after, before=before, priority=priority)
 
-    @grapes.decorator(attrs={"_self_impl": info})
+    @wrapt.decorator
     def wrapper(
         wrapped: Callable, _instance: Any, args: tuple, kwargs: dict[str, Any]
     ) -> Any:
         return wrapped(*args, **kwargs)
 
-    return wrapper(func)
+    proxy: Any = wrapper(func)  # pyright: ignore[reportCallIssue]
+    proxy._self_impl = ImplInfo(after=after, before=before, priority=priority)  # noqa: SLF001
+    return proxy
 
 
 def get_impl_info(func: Callable | None) -> ImplInfo | None:
     if func is None:
         return None
-    return getattr(func, "_self_impl", None)
+    return grapes.unbind_getattr(func, "_self_impl", None)

{liblaf_cherries-0.2.0 → liblaf_cherries-0.2.2}/src/liblaf/cherries/core/_plugin.py

@@ -1,4 +1,3 @@
-import inspect
 from collections.abc import Mapping, MutableMapping, Sequence
 from typing import Any, Self
 
@@ -6,7 +5,7 @@ import attrs
 import networkx as nx
 
 from ._impl import ImplInfo, get_impl_info
-from ._spec import SpecInfo
+from ._spec import SpecInfo, collect_specs
 from .typed import MethodName
 
 
@@ -33,15 +32,6 @@ class Plugin:
             return self
         return self._plugin_parent.plugin_root
 
-    @property
-    def specs(self) -> dict[str, SpecInfo]:
-        return {
-            name: method._self_spec  # noqa: SLF001
-            for name, method in inspect.getmembers(
-                type(self), lambda m: getattr(m, "_self_spec", None) is not None
-            )
-        }
-
     def delegate(
         self,
         method: MethodName,
@@ -65,7 +55,8 @@ class Plugin:
         self.plugins[plugin.plugin_id] = plugin
 
     def _prepare(self) -> None:
-        for method in self.specs:
+        specs: dict[str, SpecInfo] = collect_specs(self)
+        for method in specs:
             self._sort_plugins_cache[method] = self._sort_plugins(
                 method, refresh_cache=True
             )

liblaf_cherries-0.2.2/src/liblaf/cherries/core/_run.py

@@ -0,0 +1,108 @@
+from collections.abc import Mapping
+from pathlib import Path
+from typing import Any
+
+import attrs
+
+from liblaf.cherries import paths
+
+from ._plugin import Plugin
+from ._spec import spec
+
+
+@attrs.define
+class Run(Plugin):
+    """.
+
+    References:
+        1. [Experiment - Comet Docs](https://www.comet.com/docs/v2/api-and-sdk/python-sdk/reference/Experiment/)
+        2. [Logger | ClearML](https://clear.ml/docs/latest/docs/references/sdk/logger)
+        3. [MLflow Tracking APIs | MLflow](https://www.mlflow.org/docs/latest/ml/tracking/tracking-api/)
+    """
+
+    @property
+    def exp_dir(self) -> Path:
+        return paths.exp_dir(absolute=True)
+
+    @property
+    def url(self) -> str:
+        return self.get_url()
+
+    @spec
+    def end(self, *args, **kwargs) -> None: ...
+    @spec(first_result=True)
+    def get_url(self) -> str: ...
+    @spec
+    def log_asset(self, *args, **kwargs) -> None: ...
+    @spec
+    def log_asset_data(self, *args, **kwargs) -> None: ...
+    @spec
+    def log_asset_folder(self, *args, **kwargs) -> None: ...
+    @spec
+    def log_input(self, *args, **kwargs) -> None: ...
+    @spec
+    def log_input_folder(self, *args, **kwargs) -> None: ...
+    @spec
+    def log_metric(
+        self,
+        name: str,
+        value: Any,
+        /,
+        step: int | None = None,
+        epoch: int | None = None,
+        **kwargs,
+    ) -> None: ...
+    @spec
+    def log_metrics(
+        self,
+        dic: Mapping[str, Any],
+        /,
+        prefix: str | None = None,
+        step: int | None = None,
+        epoch: int | None = None,
+        **kwargs,
+    ) -> None: ...
+    @spec
+    def log_other(self, key: Any, value: Any, /, **kwargs) -> None: ...
+    @spec
+    def log_others(self, dictionary: Mapping[Any, Any], /, **kwargs) -> None: ...
+    @spec
+    def log_output(self, *args, **kwargs) -> None: ...
+    @spec
+    def log_output_folder(self, *args, **kwargs) -> None: ...
+    @spec
+    def log_parameter(
+        self, name: Any, value: Any, /, step: int | None = None, **kwargs
+    ) -> None: ...
+    @spec
+    def log_parameters(
+        self,
+        parameters: Mapping[Any, Any],
+        /,
+        prefix: str | None = None,
+        step: int | None = None,
+        **kwargs,
+    ) -> None: ...
+
+    @spec(delegate=False)
+    def start(self, *args, **kwargs) -> None:
+        self._prepare()
+        self.delegate("start", args, kwargs)
+
+
+active_run: Run = Run()
+end = active_run.end
+log_asset = active_run.log_asset
+log_asset_data = active_run.log_asset_data
+log_asset_folder = active_run.log_asset_folder
+log_input = active_run.log_input
+log_input_folder = active_run.log_input_folder
+log_metric = active_run.log_metric
+log_metrics = active_run.log_metrics
+log_other = active_run.log_other
+log_others = active_run.log_others
+log_output = active_run.log_output
+log_output_folder = active_run.log_output_folder
+log_parameter = active_run.log_parameter
+log_parameters = active_run.log_parameters
+start = active_run.start

{liblaf_cherries-0.2.0 → liblaf_cherries-0.2.2}/src/liblaf/cherries/core/_spec.py

@@ -4,6 +4,7 @@ from collections.abc import Callable, Mapping, Sequence
 from typing import Any, Protocol, overload
 
 import attrs
+import wrapt
 
 from liblaf import grapes
 
@@ -47,7 +48,7 @@ def spec(
 
     info = SpecInfo(delegate=delegate, first_result=first_result)
 
-    @grapes.decorator(attrs={"_self_spec": info})
+    @wrapt.decorator
     def wrapper(
         wrapped: Callable, instance: Plugin, args: tuple, kwargs: dict[str, Any]
     ) -> Any:
@@ -57,15 +58,17 @@ def spec(
             )
         return wrapped(*args, **kwargs)
 
-    return wrapper(func)
+    proxy: Any = wrapper(func)  # pyright: ignore[reportCallIssue]
+    proxy._self_spec = SpecInfo(delegate=delegate, first_result=first_result)  # noqa: SLF001
+    return proxy
 
 
 def collect_specs(cls: type[Plugin] | Plugin) -> dict[str, SpecInfo]:
     if isinstance(cls, type):
         cls = type(cls)
     return {
-        name: method._self_spec  # noqa: SLF001
+        name: grapes.unbind_getattr(method, "_self_spec")
         for name, method in inspect.getmembers(
-            cls, lambda m: getattr(m, "_self_spec", None) is not None
+            cls, lambda m: grapes.unbind_getattr(m, "_self_spec", None) is not None
         )
     }

liblaf_cherries-0.2.2/src/liblaf/cherries/plugins/__init__.pyi

@@ -0,0 +1,4 @@
+from .comet import Comet
+from .logging import Logging
+
+__all__ = ["Comet", "Logging"]

liblaf_cherries-0.2.2/src/liblaf/cherries/plugins/comet.py

@@ -0,0 +1,54 @@
+from typing import override
+
+import comet_ml
+
+from liblaf.cherries import core
+
+
+class Comet(core.Run):
+    exp: comet_ml.CometExperiment
+
+    @override
+    @core.impl(after=("Logging",))
+    def end(self, *args, **kwargs) -> None:
+        return self.exp.end()
+
+    @override
+    @core.impl
+    def get_url(self) -> str:
+        return self.exp.url  # pyright: ignore[reportReturnType]
+
+    @override
+    @core.impl
+    def log_metric(self, *args, **kwargs) -> None:
+        return self.exp.log_metric(*args, **kwargs)
+
+    @override
+    @core.impl
+    def log_metrics(self, *args, **kwargs) -> None:
+        return self.exp.log_metrics(*args, **kwargs)
+
+    @override
+    @core.impl
+    def log_other(self, *args, **kwargs) -> None:
+        return self.exp.log_other(*args, **kwargs)
+
+    @override
+    @core.impl
+    def log_others(self, *args, **kwargs) -> None:
+        return self.exp.log_others(*args, **kwargs)
+
+    @override
+    @core.impl
+    def log_parameter(self, *args, **kwargs) -> None:
+        return self.exp.log_parameter(*args, **kwargs)
+
+    @override
+    @core.impl
+    def log_parameters(self, *args, **kwargs) -> None:
+        return self.exp.log_parameters(*args, **kwargs)
+
+    @override
+    @core.impl(after=("Logging",))
+    def start(self, *args, **kwargs) -> None:
+        self.exp = comet_ml.start()

{liblaf_cherries-0.2.0 → liblaf_cherries-0.2.2}/src/liblaf/cherries/plugins/logging.py

@@ -10,7 +10,8 @@ class Logging(core.Run):
     def start(self, *args, **kwargs) -> None:
         profile = grapes.logging.profiles.ProfileCherries(
             handlers=[
-                grapes.logging.rich_handler(),
+                # Comet and many other services do not support links
+                grapes.logging.rich_handler(enable_link=False),
                 grapes.logging.file_handler(sink=self.plugin_root.exp_dir / "run.log"),
             ]
         )

{liblaf_cherries-0.2.0 → liblaf_cherries-0.2.2}/src/liblaf/cherries/profiles/_default.py

@@ -1,6 +1,6 @@
 from typing import override
 
-from liblaf.cherries import core
+from liblaf.cherries import core, plugins
 
 from ._playground import ProfilePlayground
 
@@ -9,4 +9,5 @@ class ProfileDefault(ProfilePlayground):
     @override  # impl Profile
     def init(self) -> core.Run:
         run: core.Run = super().init()
+        run.register(plugins.Comet())
         return run

liblaf_cherries-0.2.0/src/liblaf/cherries/core/__init__.pyi

@@ -1,20 +0,0 @@
-from ._impl import ImplInfo, get_impl_info, impl
-from ._plugin import Plugin
-from ._run import Run, active_run, log_asset, log_metrics
-from ._spec import SpecInfo, spec
-from .typed import MethodName, PluginId
-
-__all__ = [
-    "ImplInfo",
-    "MethodName",
-    "Plugin",
-    "PluginId",
-    "Run",
-    "SpecInfo",
-    "active_run",
-    "get_impl_info",
-    "impl",
-    "log_asset",
-    "log_metrics",
-    "spec",
-]

liblaf_cherries-0.2.0/src/liblaf/cherries/core/_run.py

@@ -1,42 +0,0 @@
-from pathlib import Path
-
-import attrs
-
-from liblaf.cherries import paths
-
-from ._plugin import Plugin
-from ._spec import spec
-
-
-@attrs.define
-class Run(Plugin):
-    """.
-
-    References:
-        1. [Experiment - Comet Docs](https://www.comet.com/docs/v2/api-and-sdk/python-sdk/reference/Experiment/)
-        2. [Logger | ClearML](https://clear.ml/docs/latest/docs/references/sdk/logger)
-        3. [MLflow Tracking APIs | MLflow](https://www.mlflow.org/docs/latest/ml/tracking/tracking-api/)
-    """
-
-    @property
-    def exp_dir(self) -> Path:
-        return paths.exp_dir(absolute=True)
-
-    @spec
-    def end(self, *args, **kwargs) -> None: ...
-
-    @spec
-    def log_asset(self, *args, **kwargs) -> None: ...
-
-    @spec
-    def log_metrics(self, *args, **kwargs) -> None: ...
-
-    @spec(delegate=False)
-    def start(self, *args, **kwargs) -> None:
-        self._prepare()
-        self.delegate("start", args, kwargs)
-
-
-active_run: Run = Run()
-log_asset = active_run.log_asset
-log_metrics = active_run.log_metrics

liblaf_cherries-0.2.0/src/liblaf/cherries/plugins/__init__.pyi

@@ -1,3 +0,0 @@
-from .logging import Logging
-
-__all__ = ["Logging"]